Boris Takam / Mbed OS mbed-os-example-blinky

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

README.md@27:e64a31d541da, 2017-02-28 (annotated)

Committer:
mbed_official
Date:
Tue Feb 28 11:15:03 2017 +0000
Revision:
27:e64a31d541da
Parent:
24:a0164b11ed6f
Child:
54:64a293b4da54
Merge pull request #44 from AnotherButler/master



Update README.md

.

Commit copied from https://github.com/ARMmbed/mbed-os-example-blinky

Who changed what in which revision?

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