Giung Kim / Mbed OS WIZnet-IoTShield-WM01-Ping

Init Project for Ping

README.md@0:7a10bb221e55, 2019-09-11 (annotated)

Committer:
AustinKim
Date:
Wed Sep 11 07:34:25 2019 +0000
Revision:
0:7a10bb221e55
Init Project for Ping

Who changed what in which revision?

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