Tijl Goens / Mbed OS EpaperdisplayII

tempcommit 13/05

README.md@2:048e163245b7, 2019-05-15 (annotated)

Committer:
tijl
Date:
Wed May 15 13:39:22 2019 +0000
Revision:
2:048e163245b7
Parent:
0:73f2160fef5a 
blub 15/05;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Ruben_Heintjens 0:73f2160fef5a 1 # Getting started example for Mbed OS
Ruben_Heintjens 0:73f2160fef5a 2
Ruben_Heintjens 0:73f2160fef5a 3 This guide reviews the steps required to get Blinky with the addition of dynamic OS statistics working on an Mbed OS platform. (Note: To see a rendered example you can import into the Arm Online Compiler, please see our [quick start](https://os.mbed.com/docs/mbed-os/latest/quick-start/online-with-the-online-compiler.html#importing-the-code).)
Ruben_Heintjens 0:73f2160fef5a 4
Ruben_Heintjens 0:73f2160fef5a 5 Please install [Mbed CLI](https://github.com/ARMmbed/mbed-cli#installing-mbed-cli).
Ruben_Heintjens 0:73f2160fef5a 6
Ruben_Heintjens 0:73f2160fef5a 7 ## Import the example application
Ruben_Heintjens 0:73f2160fef5a 8
Ruben_Heintjens 0:73f2160fef5a 9 From the command-line, import the example:
Ruben_Heintjens 0:73f2160fef5a 10
Ruben_Heintjens 0:73f2160fef5a 11 ```
Ruben_Heintjens 0:73f2160fef5a 12 mbed import mbed-os-example-blinky
Ruben_Heintjens 0:73f2160fef5a 13 cd mbed-os-example-blinky
Ruben_Heintjens 0:73f2160fef5a 14 ```
Ruben_Heintjens 0:73f2160fef5a 15
Ruben_Heintjens 0:73f2160fef5a 16 ### Now compile
Ruben_Heintjens 0:73f2160fef5a 17
Ruben_Heintjens 0:73f2160fef5a 18 Invoke `mbed compile`, and specify the name of your platform and your favorite toolchain (`GCC_ARM`, `ARM`, `IAR`). For example, for the Arm Compiler:
Ruben_Heintjens 0:73f2160fef5a 19
Ruben_Heintjens 0:73f2160fef5a 20 ```
Ruben_Heintjens 0:73f2160fef5a 21 mbed compile -m K64F -t ARM
Ruben_Heintjens 0:73f2160fef5a 22 ```
Ruben_Heintjens 0:73f2160fef5a 23
Ruben_Heintjens 0:73f2160fef5a 24 Your PC may take a few minutes to compile your code. At the end, you see the following result:
Ruben_Heintjens 0:73f2160fef5a 25
Ruben_Heintjens 0:73f2160fef5a 26 ```
Ruben_Heintjens 0:73f2160fef5a 27 [snip]
Ruben_Heintjens 0:73f2160fef5a 28
Ruben_Heintjens 0:73f2160fef5a 29 Image: ./BUILD/K64F/GCC_ARM/mbed-os-example-blinky.bin
Ruben_Heintjens 0:73f2160fef5a 30 ```
Ruben_Heintjens 0:73f2160fef5a 31
Ruben_Heintjens 0:73f2160fef5a 32 ### Program your board
Ruben_Heintjens 0:73f2160fef5a 33
Ruben_Heintjens 0:73f2160fef5a 34 1. Connect your Mbed device to the computer over USB.
Ruben_Heintjens 0:73f2160fef5a 35 1. Copy the binary file to the Mbed device.
Ruben_Heintjens 0:73f2160fef5a 36 1. Press the reset button to start the program.
Ruben_Heintjens 0:73f2160fef5a 37
Ruben_Heintjens 0:73f2160fef5a 38 The LED on your platform turns on and off. The main thread will additionally take a snapshot of the device's runtime statistics and display it over serial to your PC. The snapshot includes:
Ruben_Heintjens 0:73f2160fef5a 39
Ruben_Heintjens 0:73f2160fef5a 40 * System Information:
Ruben_Heintjens 0:73f2160fef5a 41 * Mbed OS Version: Will currently default to 999999
Ruben_Heintjens 0:73f2160fef5a 42 * Compiler ID
Ruben_Heintjens 0:73f2160fef5a 43 * ARM = 1
Ruben_Heintjens 0:73f2160fef5a 44 * GCC_ARM = 2
Ruben_Heintjens 0:73f2160fef5a 45 * IAR = 3
Ruben_Heintjens 0:73f2160fef5a 46 * [CPUID Register Information](#cpuid-register-information)
Ruben_Heintjens 0:73f2160fef5a 47 * [Compiler Version](#compiler-version)
Ruben_Heintjens 0:73f2160fef5a 48 * CPU Statistics
Ruben_Heintjens 0:73f2160fef5a 49 * Percentage of runtime that the device has spent awake versus in sleep
Ruben_Heintjens 0:73f2160fef5a 50 * Heap Statistics
Ruben_Heintjens 0:73f2160fef5a 51 * Current heap size
Ruben_Heintjens 0:73f2160fef5a 52 * Max heap size which refers to the largest the heap has grown to
Ruben_Heintjens 0:73f2160fef5a 53 * Thread Statistics
Ruben_Heintjens 0:73f2160fef5a 54 * Provides information on all running threads in the OS including
Ruben_Heintjens 0:73f2160fef5a 55 * Thread ID
Ruben_Heintjens 0:73f2160fef5a 56 * Thread Name
Ruben_Heintjens 0:73f2160fef5a 57 * Thread State
Ruben_Heintjens 0:73f2160fef5a 58 * Thread Priority
Ruben_Heintjens 0:73f2160fef5a 59 * Thread Stack Size
Ruben_Heintjens 0:73f2160fef5a 60 * Thread Stack Space
Ruben_Heintjens 0:73f2160fef5a 61
Ruben_Heintjens 0:73f2160fef5a 62 #### Compiler Version
Ruben_Heintjens 0:73f2160fef5a 63
Ruben_Heintjens 0:73f2160fef5a 64 | Compiler | Version Layout |
Ruben_Heintjens 0:73f2160fef5a 65 | -------- | -------------- |
Ruben_Heintjens 0:73f2160fef5a 66 | ARM | PVVbbbb (P = Major; VV = Minor; bbbb = build number) |
Ruben_Heintjens 0:73f2160fef5a 67 | GCC | VVRRPP (VV = Version; RR = Revision; PP = Patch) |
Ruben_Heintjens 0:73f2160fef5a 68 | IAR | VRRRPPP (V = Version; RRR = Revision; PPP = Patch) |
Ruben_Heintjens 0:73f2160fef5a 69
Ruben_Heintjens 0:73f2160fef5a 70 #### CPUID Register Information
Ruben_Heintjens 0:73f2160fef5a 71
Ruben_Heintjens 0:73f2160fef5a 72 | Bit Field | Field Description | Values |
Ruben_Heintjens 0:73f2160fef5a 73 | --------- | ----------------- | ------ |
Ruben_Heintjens 0:73f2160fef5a 74 |[31:24] | Implementer | 0x41 = ARM |
Ruben_Heintjens 0:73f2160fef5a 75 |[23:20] | Variant | Major revision 0x0 = Revision 0 |
Ruben_Heintjens 0:73f2160fef5a 76 |[19:16] | Architecture | 0xC = Baseline Architecture |
Ruben_Heintjens 0:73f2160fef5a 77 | | | 0xF = Constant (Mainline Architecture) |
Ruben_Heintjens 0:73f2160fef5a 78 |[15:4] | Part Number | 0xC20 = Cortex-M0 |
Ruben_Heintjens 0:73f2160fef5a 79 | | | 0xC60 = Cortex-M0+ |
Ruben_Heintjens 0:73f2160fef5a 80 | | | 0xC23 = Cortex-M3 |
Ruben_Heintjens 0:73f2160fef5a 81 | | | 0xC24 = Cortex-M4 |
Ruben_Heintjens 0:73f2160fef5a 82 | | | 0xC27 = Cortex-M7 |
Ruben_Heintjens 0:73f2160fef5a 83 | | | 0xD20 = Cortex-M23 |
Ruben_Heintjens 0:73f2160fef5a 84 | | | 0xD21 = Cortex-M33 |
Ruben_Heintjens 0:73f2160fef5a 85 |[3:0] | Revision | Minor revision: 0x1 = Patch 1 |
Ruben_Heintjens 0:73f2160fef5a 86
Ruben_Heintjens 0:73f2160fef5a 87
Ruben_Heintjens 0:73f2160fef5a 88
Ruben_Heintjens 0:73f2160fef5a 89 You can view individual examples and additional API information of the statistics collection tools at the bottom of the page in the [related links section](#related-links).
Ruben_Heintjens 0:73f2160fef5a 90
Ruben_Heintjens 0:73f2160fef5a 91
Ruben_Heintjens 0:73f2160fef5a 92 ### Output
Ruben_Heintjens 0:73f2160fef5a 93
Ruben_Heintjens 0:73f2160fef5a 94 To view the serial output you can use any terminal client of your choosing such as [PuTTY](http://www.putty.org/) or [CoolTerm](http://freeware.the-meiers.org/). Unless otherwise specified, printf defaults to a baud rate of 9600 on Mbed OS.
Ruben_Heintjens 0:73f2160fef5a 95
Ruben_Heintjens 0:73f2160fef5a 96 You can find more information on the Mbed OS configuration tools and serial communication in Mbed OS in the related [related links section](#related-links).
Ruben_Heintjens 0:73f2160fef5a 97
Ruben_Heintjens 0:73f2160fef5a 98 The output should contain the following block transmitted at the blinking LED frequency (actual values may vary depending on your target, build profile, and toolchain):
Ruben_Heintjens 0:73f2160fef5a 99
Ruben_Heintjens 0:73f2160fef5a 100 ```
Ruben_Heintjens 0:73f2160fef5a 101 =============================== SYSTEM INFO ================================
Ruben_Heintjens 0:73f2160fef5a 102 Mbed OS Version: 999999
Ruben_Heintjens 0:73f2160fef5a 103 CPU ID: 0x410fc241
Ruben_Heintjens 0:73f2160fef5a 104 Compiler ID: 2
Ruben_Heintjens 0:73f2160fef5a 105 Compiler Version: 60300
Ruben_Heintjens 0:73f2160fef5a 106 RAM0: Start 0x20000000 Size: 0x30000
Ruben_Heintjens 0:73f2160fef5a 107 RAM1: Start 0x1fff0000 Size: 0x10000
Ruben_Heintjens 0:73f2160fef5a 108 ROM0: Start 0x0 Size: 0x100000
Ruben_Heintjens 0:73f2160fef5a 109 ================= CPU STATS =================
Ruben_Heintjens 0:73f2160fef5a 110 Idle: 98% Usage: 2%
Ruben_Heintjens 0:73f2160fef5a 111 ================ HEAP STATS =================
Ruben_Heintjens 0:73f2160fef5a 112 Current heap: 1096
Ruben_Heintjens 0:73f2160fef5a 113 Max heap size: 1096
Ruben_Heintjens 0:73f2160fef5a 114 ================ THREAD STATS ===============
Ruben_Heintjens 0:73f2160fef5a 115 ID: 0x20001eac
Ruben_Heintjens 0:73f2160fef5a 116 Name: main_thread
Ruben_Heintjens 0:73f2160fef5a 117 State: 2
Ruben_Heintjens 0:73f2160fef5a 118 Priority: 24
Ruben_Heintjens 0:73f2160fef5a 119 Stack Size: 4096
Ruben_Heintjens 0:73f2160fef5a 120 Stack Space: 3296
Ruben_Heintjens 0:73f2160fef5a 121
Ruben_Heintjens 0:73f2160fef5a 122 ID: 0x20000f5c
Ruben_Heintjens 0:73f2160fef5a 123 Name: idle_thread
Ruben_Heintjens 0:73f2160fef5a 124 State: 1
Ruben_Heintjens 0:73f2160fef5a 125 Priority: 1
Ruben_Heintjens 0:73f2160fef5a 126 Stack Size: 512
Ruben_Heintjens 0:73f2160fef5a 127 Stack Space: 352
Ruben_Heintjens 0:73f2160fef5a 128
Ruben_Heintjens 0:73f2160fef5a 129 ID: 0x20000f18
Ruben_Heintjens 0:73f2160fef5a 130 Name: timer_thread
Ruben_Heintjens 0:73f2160fef5a 131 State: 3
Ruben_Heintjens 0:73f2160fef5a 132 Priority: 40
Ruben_Heintjens 0:73f2160fef5a 133 Stack Size: 768
Ruben_Heintjens 0:73f2160fef5a 134 Stack Space: 664
Ruben_Heintjens 0:73f2160fef5a 135
Ruben_Heintjens 0:73f2160fef5a 136 ```
Ruben_Heintjens 0:73f2160fef5a 137
Ruben_Heintjens 0:73f2160fef5a 138 ## Troubleshooting
Ruben_Heintjens 0:73f2160fef5a 139
Ruben_Heintjens 0:73f2160fef5a 140 If you have problems, you can review the [documentation](https://os.mbed.com/docs/latest/tutorials/debugging.html) for suggestions on what could be wrong and how to fix it.
Ruben_Heintjens 0:73f2160fef5a 141
Ruben_Heintjens 0:73f2160fef5a 142 ## Related Links
Ruben_Heintjens 0:73f2160fef5a 143
Ruben_Heintjens 0:73f2160fef5a 144 * [Mbed OS Stats API](https://os.mbed.com/docs/latest/apis/mbed-statistics.html)
Ruben_Heintjens 0:73f2160fef5a 145 * [Mbed OS Configuration](https://os.mbed.com/docs/latest/reference/configuration.html)
Ruben_Heintjens 0:73f2160fef5a 146 * [Mbed OS Serial Communication](https://os.mbed.com/docs/latest/tutorials/serial-communication.html)
Ruben_Heintjens 0:73f2160fef5a 147
Ruben_Heintjens 0:73f2160fef5a 148 ### License and contributions
Ruben_Heintjens 0:73f2160fef5a 149
Ruben_Heintjens 0:73f2160fef5a 150 The software is provided under Apache-2.0 license. Contributions to this project are accepted under the same license. Please see contributing.md for more info.
Ruben_Heintjens 0:73f2160fef5a 151
Ruben_Heintjens 0:73f2160fef5a 152 This project contains code from other projects. The original license text is included in those source files. They must comply with our license guide.