matignon martin / Mbed OS MbedStateMachine

This library is designed to create and run state graphs. It supports hierarchical states and the parallel execution

README.md@0:f4fdca2c4c67, 2017-10-03 (annotated)

Committer:
martin13
Date:
Tue Oct 03 08:29:22 2017 +0000
Revision:
0:f4fdca2c4c67
Child:
1:0f11d9338d89
First version

Who changed what in which revision?

UserRevisionLine numberNew contents of line
martin13 0:f4fdca2c4c67 1 # Getting started with Blinky on mbed OS
martin13 0:f4fdca2c4c67 2
martin13 0:f4fdca2c4c67 3 This guide reviews the steps required to get Blinky working on an mbed OS platform.
martin13 0:f4fdca2c4c67 4
martin13 0:f4fdca2c4c67 5 Please install [mbed CLI](https://github.com/ARMmbed/mbed-cli#installing-mbed-cli).
martin13 0:f4fdca2c4c67 6
martin13 0:f4fdca2c4c67 7 ## Import the example application
martin13 0:f4fdca2c4c67 8
martin13 0:f4fdca2c4c67 9 From the command-line, import the example:
martin13 0:f4fdca2c4c67 10
martin13 0:f4fdca2c4c67 11 ```
martin13 0:f4fdca2c4c67 12 mbed import mbed-os-example-blinky
martin13 0:f4fdca2c4c67 13 cd mbed-os-example-blinky
martin13 0:f4fdca2c4c67 14 ```
martin13 0:f4fdca2c4c67 15
martin13 0:f4fdca2c4c67 16 ### Now compile
martin13 0:f4fdca2c4c67 17
martin13 0:f4fdca2c4c67 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 5:
martin13 0:f4fdca2c4c67 19
martin13 0:f4fdca2c4c67 20 ```
martin13 0:f4fdca2c4c67 21 mbed compile -m K64F -t ARM
martin13 0:f4fdca2c4c67 22 ```
martin13 0:f4fdca2c4c67 23
martin13 0:f4fdca2c4c67 24 Your PC may take a few minutes to compile your code. At the end, you see the following result:
martin13 0:f4fdca2c4c67 25
martin13 0:f4fdca2c4c67 26 ```
martin13 0:f4fdca2c4c67 27 [snip]
martin13 0:f4fdca2c4c67 28 +----------------------------+-------+-------+------+
martin13 0:f4fdca2c4c67 29 | Module | .text | .data | .bss |
martin13 0:f4fdca2c4c67 30 +----------------------------+-------+-------+------+
martin13 0:f4fdca2c4c67 31 | Misc | 13939 | 24 | 1372 |
martin13 0:f4fdca2c4c67 32 | core/hal | 16993 | 96 | 296 |
martin13 0:f4fdca2c4c67 33 | core/rtos | 7384 | 92 | 4204 |
martin13 0:f4fdca2c4c67 34 | features/FEATURE_IPV4 | 80 | 0 | 176 |
martin13 0:f4fdca2c4c67 35 | frameworks/greentea-client | 1830 | 60 | 44 |
martin13 0:f4fdca2c4c67 36 | frameworks/utest | 2392 | 512 | 292 |
martin13 0:f4fdca2c4c67 37 | Subtotals | 42618 | 784 | 6384 |
martin13 0:f4fdca2c4c67 38 +----------------------------+-------+-------+------+
martin13 0:f4fdca2c4c67 39 Allocated Heap: unknown
martin13 0:f4fdca2c4c67 40 Allocated Stack: unknown
martin13 0:f4fdca2c4c67 41 Total Static RAM memory (data + bss): 7168 bytes
martin13 0:f4fdca2c4c67 42 Total RAM memory (data + bss + heap + stack): 7168 bytes
martin13 0:f4fdca2c4c67 43 Total Flash memory (text + data + misc): 43402 bytes
martin13 0:f4fdca2c4c67 44 Image: .\.build\K64F\ARM\mbed-os-example-blinky.bin
martin13 0:f4fdca2c4c67 45 ```
martin13 0:f4fdca2c4c67 46
martin13 0:f4fdca2c4c67 47 ### Program your board
martin13 0:f4fdca2c4c67 48
martin13 0:f4fdca2c4c67 49 1. Connect your mbed device to the computer over USB.
martin13 0:f4fdca2c4c67 50 1. Copy the binary file to the mbed device.
martin13 0:f4fdca2c4c67 51 1. Press the reset button to start the program.
martin13 0:f4fdca2c4c67 52
martin13 0:f4fdca2c4c67 53 The LED on your platform turns on and off.
martin13 0:f4fdca2c4c67 54
martin13 0:f4fdca2c4c67 55 ## Export the project to Keil MDK, and debug your application
martin13 0:f4fdca2c4c67 56
martin13 0:f4fdca2c4c67 57 From the command-line, run the following command:
martin13 0:f4fdca2c4c67 58
martin13 0:f4fdca2c4c67 59 ```
martin13 0:f4fdca2c4c67 60 mbed export -m K64F -i uvision
martin13 0:f4fdca2c4c67 61 ```
martin13 0:f4fdca2c4c67 62
martin13 0:f4fdca2c4c67 63 To debug the application:
martin13 0:f4fdca2c4c67 64
martin13 0:f4fdca2c4c67 65 1. Start uVision.
martin13 0:f4fdca2c4c67 66 1. Import the uVision project generated earlier.
martin13 0:f4fdca2c4c67 67 1. Compile your application, and generate an `.axf` file.
martin13 0:f4fdca2c4c67 68 1. Make sure uVision is configured to debug over CMSIS-DAP (From the Project menu > Options for Target '...' > Debug tab > Use CMSIS-DAP Debugger).
martin13 0:f4fdca2c4c67 69 1. Set breakpoints, and start a debug session.
martin13 0:f4fdca2c4c67 70
martin13 0:f4fdca2c4c67 71 ![Image of uVision](img/uvision.png)
martin13 0:f4fdca2c4c67 72
martin13 0:f4fdca2c4c67 73 ## Troubleshooting
martin13 0:f4fdca2c4c67 74
martin13 0:f4fdca2c4c67 75 1. Make sure `mbed-cli` is working correctly and its version is `>1.0.0`
martin13 0:f4fdca2c4c67 76
martin13 0:f4fdca2c4c67 77 ```
martin13 0:f4fdca2c4c67 78 mbed --version
martin13 0:f4fdca2c4c67 79 ```
martin13 0:f4fdca2c4c67 80
martin13 0:f4fdca2c4c67 81 If not, you can update it:
martin13 0:f4fdca2c4c67 82
martin13 0:f4fdca2c4c67 83 ```
martin13 0:f4fdca2c4c67 84 pip install mbed-cli --upgrade
martin13 0:f4fdca2c4c67 85 ```
martin13 0:f4fdca2c4c67 86
martin13 0:f4fdca2c4c67 87 2. If using Keil MDK, make sure you have a license installed. [MDK-Lite](http://www.keil.com/arm/mdk.asp) has a 32 KB restriction on code size.