Shingo FUKUYA / Mbed OS Airio-Base_Grove_6Axis_OS5

Airio-Base test program using Mbed OS 5 .

Dependencies:   SDFileSystem

README.md@0:be8ed55bdf37, 2019-07-16 (annotated)

Committer:
mbed_crane_elec
Date:
Tue Jul 16 21:24:32 2019 +0000
Revision:
0:be8ed55bdf37
for OS 5

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_crane_elec 0:be8ed55bdf37 1 # Getting started example for Mbed OS
mbed_crane_elec 0:be8ed55bdf37 2
mbed_crane_elec 0:be8ed55bdf37 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).)
mbed_crane_elec 0:be8ed55bdf37 4
mbed_crane_elec 0:be8ed55bdf37 5 Please install [Mbed CLI](https://github.com/ARMmbed/mbed-cli#installing-mbed-cli).
mbed_crane_elec 0:be8ed55bdf37 6
mbed_crane_elec 0:be8ed55bdf37 7 ## Import the example application
mbed_crane_elec 0:be8ed55bdf37 8
mbed_crane_elec 0:be8ed55bdf37 9 From the command-line, import the example:
mbed_crane_elec 0:be8ed55bdf37 10
mbed_crane_elec 0:be8ed55bdf37 11 ```
mbed_crane_elec 0:be8ed55bdf37 12 mbed import mbed-os-example-blinky
mbed_crane_elec 0:be8ed55bdf37 13 cd mbed-os-example-blinky
mbed_crane_elec 0:be8ed55bdf37 14 ```
mbed_crane_elec 0:be8ed55bdf37 15
mbed_crane_elec 0:be8ed55bdf37 16 ### Now compile
mbed_crane_elec 0:be8ed55bdf37 17
mbed_crane_elec 0:be8ed55bdf37 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:
mbed_crane_elec 0:be8ed55bdf37 19
mbed_crane_elec 0:be8ed55bdf37 20 ```
mbed_crane_elec 0:be8ed55bdf37 21 mbed compile -m K64F -t ARM
mbed_crane_elec 0:be8ed55bdf37 22 ```
mbed_crane_elec 0:be8ed55bdf37 23
mbed_crane_elec 0:be8ed55bdf37 24 Your PC may take a few minutes to compile your code. At the end, you see the following result:
mbed_crane_elec 0:be8ed55bdf37 25
mbed_crane_elec 0:be8ed55bdf37 26 ```
mbed_crane_elec 0:be8ed55bdf37 27 [snip]
mbed_crane_elec 0:be8ed55bdf37 28
mbed_crane_elec 0:be8ed55bdf37 29 Image: ./BUILD/K64F/GCC_ARM/mbed-os-example-blinky.bin
mbed_crane_elec 0:be8ed55bdf37 30 ```
mbed_crane_elec 0:be8ed55bdf37 31
mbed_crane_elec 0:be8ed55bdf37 32 ### Program your board
mbed_crane_elec 0:be8ed55bdf37 33
mbed_crane_elec 0:be8ed55bdf37 34 1. Connect your Mbed device to the computer over USB.
mbed_crane_elec 0:be8ed55bdf37 35 1. Copy the binary file to the Mbed device.
mbed_crane_elec 0:be8ed55bdf37 36 1. Press the reset button to start the program.
mbed_crane_elec 0:be8ed55bdf37 37
mbed_crane_elec 0:be8ed55bdf37 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:
mbed_crane_elec 0:be8ed55bdf37 39
mbed_crane_elec 0:be8ed55bdf37 40 * System Information:
mbed_crane_elec 0:be8ed55bdf37 41 * Mbed OS Version: Will currently default to 999999
mbed_crane_elec 0:be8ed55bdf37 42 * Compiler ID
mbed_crane_elec 0:be8ed55bdf37 43 * ARM = 1
mbed_crane_elec 0:be8ed55bdf37 44 * GCC_ARM = 2
mbed_crane_elec 0:be8ed55bdf37 45 * IAR = 3
mbed_crane_elec 0:be8ed55bdf37 46 * [CPUID Register Information](#cpuid-register-information)
mbed_crane_elec 0:be8ed55bdf37 47 * [Compiler Version](#compiler-version)
mbed_crane_elec 0:be8ed55bdf37 48 * CPU Statistics
mbed_crane_elec 0:be8ed55bdf37 49 * Percentage of runtime that the device has spent awake versus in sleep
mbed_crane_elec 0:be8ed55bdf37 50 * Heap Statistics
mbed_crane_elec 0:be8ed55bdf37 51 * Current heap size
mbed_crane_elec 0:be8ed55bdf37 52 * Max heap size which refers to the largest the heap has grown to
mbed_crane_elec 0:be8ed55bdf37 53 * Thread Statistics
mbed_crane_elec 0:be8ed55bdf37 54 * Provides information on all running threads in the OS including
mbed_crane_elec 0:be8ed55bdf37 55 * Thread ID
mbed_crane_elec 0:be8ed55bdf37 56 * Thread Name
mbed_crane_elec 0:be8ed55bdf37 57 * Thread State
mbed_crane_elec 0:be8ed55bdf37 58 * Thread Priority
mbed_crane_elec 0:be8ed55bdf37 59 * Thread Stack Size
mbed_crane_elec 0:be8ed55bdf37 60 * Thread Stack Space
mbed_crane_elec 0:be8ed55bdf37 61
mbed_crane_elec 0:be8ed55bdf37 62 #### Compiler Version
mbed_crane_elec 0:be8ed55bdf37 63
mbed_crane_elec 0:be8ed55bdf37 64 | Compiler | Version Layout |
mbed_crane_elec 0:be8ed55bdf37 65 | -------- | -------------- |
mbed_crane_elec 0:be8ed55bdf37 66 | ARM | PVVbbbb (P = Major; VV = Minor; bbbb = build number) |
mbed_crane_elec 0:be8ed55bdf37 67 | GCC | VVRRPP (VV = Version; RR = Revision; PP = Patch) |
mbed_crane_elec 0:be8ed55bdf37 68 | IAR | VRRRPPP (V = Version; RRR = Revision; PPP = Patch) |
mbed_crane_elec 0:be8ed55bdf37 69
mbed_crane_elec 0:be8ed55bdf37 70 #### CPUID Register Information
mbed_crane_elec 0:be8ed55bdf37 71
mbed_crane_elec 0:be8ed55bdf37 72 | Bit Field | Field Description | Values |
mbed_crane_elec 0:be8ed55bdf37 73 | --------- | ----------------- | ------ |
mbed_crane_elec 0:be8ed55bdf37 74 |[31:24] | Implementer | 0x41 = ARM |
mbed_crane_elec 0:be8ed55bdf37 75 |[23:20] | Variant | Major revision 0x0 = Revision 0 |
mbed_crane_elec 0:be8ed55bdf37 76 |[19:16] | Architecture | 0xC = Baseline Architecture |
mbed_crane_elec 0:be8ed55bdf37 77 | | | 0xF = Constant (Mainline Architecture) |
mbed_crane_elec 0:be8ed55bdf37 78 |[15:4] | Part Number | 0xC20 = Cortex-M0 |
mbed_crane_elec 0:be8ed55bdf37 79 | | | 0xC60 = Cortex-M0+ |
mbed_crane_elec 0:be8ed55bdf37 80 | | | 0xC23 = Cortex-M3 |
mbed_crane_elec 0:be8ed55bdf37 81 | | | 0xC24 = Cortex-M4 |
mbed_crane_elec 0:be8ed55bdf37 82 | | | 0xC27 = Cortex-M7 |
mbed_crane_elec 0:be8ed55bdf37 83 | | | 0xD20 = Cortex-M23 |
mbed_crane_elec 0:be8ed55bdf37 84 | | | 0xD21 = Cortex-M33 |
mbed_crane_elec 0:be8ed55bdf37 85 |[3:0] | Revision | Minor revision: 0x1 = Patch 1 |
mbed_crane_elec 0:be8ed55bdf37 86
mbed_crane_elec 0:be8ed55bdf37 87
mbed_crane_elec 0:be8ed55bdf37 88
mbed_crane_elec 0:be8ed55bdf37 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).
mbed_crane_elec 0:be8ed55bdf37 90
mbed_crane_elec 0:be8ed55bdf37 91
mbed_crane_elec 0:be8ed55bdf37 92 ### Output
mbed_crane_elec 0:be8ed55bdf37 93
mbed_crane_elec 0:be8ed55bdf37 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.
mbed_crane_elec 0:be8ed55bdf37 95
mbed_crane_elec 0:be8ed55bdf37 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).
mbed_crane_elec 0:be8ed55bdf37 97
mbed_crane_elec 0:be8ed55bdf37 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):
mbed_crane_elec 0:be8ed55bdf37 99
mbed_crane_elec 0:be8ed55bdf37 100 ```
mbed_crane_elec 0:be8ed55bdf37 101 =============================== SYSTEM INFO ================================
mbed_crane_elec 0:be8ed55bdf37 102 Mbed OS Version: 999999
mbed_crane_elec 0:be8ed55bdf37 103 CPU ID: 0x410fc241
mbed_crane_elec 0:be8ed55bdf37 104 Compiler ID: 2
mbed_crane_elec 0:be8ed55bdf37 105 Compiler Version: 60300
mbed_crane_elec 0:be8ed55bdf37 106 RAM0: Start 0x20000000 Size: 0x30000
mbed_crane_elec 0:be8ed55bdf37 107 RAM1: Start 0x1fff0000 Size: 0x10000
mbed_crane_elec 0:be8ed55bdf37 108 ROM0: Start 0x0 Size: 0x100000
mbed_crane_elec 0:be8ed55bdf37 109 ================= CPU STATS =================
mbed_crane_elec 0:be8ed55bdf37 110 Idle: 98% Usage: 2%
mbed_crane_elec 0:be8ed55bdf37 111 ================ HEAP STATS =================
mbed_crane_elec 0:be8ed55bdf37 112 Current heap: 1096
mbed_crane_elec 0:be8ed55bdf37 113 Max heap size: 1096
mbed_crane_elec 0:be8ed55bdf37 114 ================ THREAD STATS ===============
mbed_crane_elec 0:be8ed55bdf37 115 ID: 0x20001eac
mbed_crane_elec 0:be8ed55bdf37 116 Name: main_thread
mbed_crane_elec 0:be8ed55bdf37 117 State: 2
mbed_crane_elec 0:be8ed55bdf37 118 Priority: 24
mbed_crane_elec 0:be8ed55bdf37 119 Stack Size: 4096
mbed_crane_elec 0:be8ed55bdf37 120 Stack Space: 3296
mbed_crane_elec 0:be8ed55bdf37 121
mbed_crane_elec 0:be8ed55bdf37 122 ID: 0x20000f5c
mbed_crane_elec 0:be8ed55bdf37 123 Name: idle_thread
mbed_crane_elec 0:be8ed55bdf37 124 State: 1
mbed_crane_elec 0:be8ed55bdf37 125 Priority: 1
mbed_crane_elec 0:be8ed55bdf37 126 Stack Size: 512
mbed_crane_elec 0:be8ed55bdf37 127 Stack Space: 352
mbed_crane_elec 0:be8ed55bdf37 128
mbed_crane_elec 0:be8ed55bdf37 129 ID: 0x20000f18
mbed_crane_elec 0:be8ed55bdf37 130 Name: timer_thread
mbed_crane_elec 0:be8ed55bdf37 131 State: 3
mbed_crane_elec 0:be8ed55bdf37 132 Priority: 40
mbed_crane_elec 0:be8ed55bdf37 133 Stack Size: 768
mbed_crane_elec 0:be8ed55bdf37 134 Stack Space: 664
mbed_crane_elec 0:be8ed55bdf37 135
mbed_crane_elec 0:be8ed55bdf37 136 ```
mbed_crane_elec 0:be8ed55bdf37 137
mbed_crane_elec 0:be8ed55bdf37 138 ## Troubleshooting
mbed_crane_elec 0:be8ed55bdf37 139
mbed_crane_elec 0:be8ed55bdf37 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.
mbed_crane_elec 0:be8ed55bdf37 141
mbed_crane_elec 0:be8ed55bdf37 142 ## Related Links
mbed_crane_elec 0:be8ed55bdf37 143
mbed_crane_elec 0:be8ed55bdf37 144 * [Mbed OS Stats API](https://os.mbed.com/docs/latest/apis/mbed-statistics.html)
mbed_crane_elec 0:be8ed55bdf37 145 * [Mbed OS Configuration](https://os.mbed.com/docs/latest/reference/configuration.html)
mbed_crane_elec 0:be8ed55bdf37 146 * [Mbed OS Serial Communication](https://os.mbed.com/docs/latest/tutorials/serial-communication.html)
mbed_crane_elec 0:be8ed55bdf37 147
mbed_crane_elec 0:be8ed55bdf37 148 ### License and contributions
mbed_crane_elec 0:be8ed55bdf37 149
mbed_crane_elec 0:be8ed55bdf37 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.
mbed_crane_elec 0:be8ed55bdf37 151
mbed_crane_elec 0:be8ed55bdf37 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.