Georg Lerm / Mbed OS mbed-os-example-mbed5-blinky

os5

Dependencies:   m3pi

README.md@0:ca77b05e6a8e, 2020-09-14 (annotated)

Committer:
Georg
Date:
Mon Sep 14 10:19:50 2020 +0000
Revision:
0:ca77b05e6a8e
os5

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Georg 0:ca77b05e6a8e 1 ![](./resources/official_armmbed_example_badge.png)
Georg 0:ca77b05e6a8e 2 # Blinky Mbed OS example
Georg 0:ca77b05e6a8e 3
Georg 0:ca77b05e6a8e 4 The example project is part of the [Arm Mbed OS Official Examples](https://os.mbed.com/code/) and is the [getting started example for Mbed OS](https://os.mbed.com/docs/mbed-os/v5.14/quick-start/index.html). It contains an application that repeatedly blinks an LED on supported [Mbed boards](https://os.mbed.com/platforms/).
Georg 0:ca77b05e6a8e 5
Georg 0:ca77b05e6a8e 6 You can build the project with all supported [Mbed OS build tools](https://os.mbed.com/docs/mbed-os/latest/tools/index.html). However, this example project specifically refers to the command-line interface tool [Arm Mbed CLI](https://github.com/ARMmbed/mbed-cli#installing-mbed-cli).
Georg 0:ca77b05e6a8e 7 (Note: To see a rendered example you can import into the Arm Online Compiler, please see our [import quick start](https://os.mbed.com/docs/mbed-os/latest/quick-start/online-with-the-online-compiler.html#importing-the-code).)
Georg 0:ca77b05e6a8e 8
Georg 0:ca77b05e6a8e 9 1. [Install Mbed CLI](https://os.mbed.com/docs/mbed-os/latest/quick-start/offline-with-mbed-cli.html).
Georg 0:ca77b05e6a8e 10
Georg 0:ca77b05e6a8e 11 1. Clone this repository on your system, and change the current directory to where the project was cloned:
Georg 0:ca77b05e6a8e 12
Georg 0:ca77b05e6a8e 13 ```bash
Georg 0:ca77b05e6a8e 14 $ git clone git@github.com:armmbed/mbed-os-example-blinky && cd mbed-os-example-blinky
Georg 0:ca77b05e6a8e 15 ```
Georg 0:ca77b05e6a8e 16
Georg 0:ca77b05e6a8e 17 Alternatively, you can download the example project with Arm Mbed CLI using the `import` subcommand:
Georg 0:ca77b05e6a8e 18
Georg 0:ca77b05e6a8e 19 ```bash
Georg 0:ca77b05e6a8e 20 $ mbed import mbed-os-example-blinky && cd mbed-os-example-blinky
Georg 0:ca77b05e6a8e 21 ```
Georg 0:ca77b05e6a8e 22
Georg 0:ca77b05e6a8e 23
Georg 0:ca77b05e6a8e 24 ## Application functionality
Georg 0:ca77b05e6a8e 25
Georg 0:ca77b05e6a8e 26 The `main()` function is the single thread in the application. It toggles the state of a digital output connected to an LED on the board.
Georg 0:ca77b05e6a8e 27
Georg 0:ca77b05e6a8e 28 ## Building and running
Georg 0:ca77b05e6a8e 29
Georg 0:ca77b05e6a8e 30 1. Connect a USB cable between the USB port on the board and the host computer.
Georg 0:ca77b05e6a8e 31 2. <a name="build_cmd"></a> Run the following command to build the example project and program the microcontroller flash memory:
Georg 0:ca77b05e6a8e 32 ```bash
Georg 0:ca77b05e6a8e 33 $ mbed compile -m <TARGET> -t <TOOLCHAIN> --flash
Georg 0:ca77b05e6a8e 34 ```
Georg 0:ca77b05e6a8e 35 The binary is located at `./BUILD/<TARGET>/<TOOLCHAIN>/mbed-os-example-blinky.bin`.
Georg 0:ca77b05e6a8e 36
Georg 0:ca77b05e6a8e 37 Alternatively, you can manually copy the binary to the board, which you mount on the host computer over USB.
Georg 0:ca77b05e6a8e 38
Georg 0:ca77b05e6a8e 39 Depending on the target, you can build the example project with the `GCC_ARM`, `ARM` or `IAR` toolchain. After installing Arm Mbed CLI, run the command below to determine which toolchain supports your target:
Georg 0:ca77b05e6a8e 40
Georg 0:ca77b05e6a8e 41 ```bash
Georg 0:ca77b05e6a8e 42 $ mbed compile -S
Georg 0:ca77b05e6a8e 43 ```
Georg 0:ca77b05e6a8e 44
Georg 0:ca77b05e6a8e 45 ## Expected output
Georg 0:ca77b05e6a8e 46 The LED on your target turns on and off every 500 milliseconds.
Georg 0:ca77b05e6a8e 47
Georg 0:ca77b05e6a8e 48
Georg 0:ca77b05e6a8e 49 ## Troubleshooting
Georg 0:ca77b05e6a8e 50 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.
Georg 0:ca77b05e6a8e 51
Georg 0:ca77b05e6a8e 52 ## Related Links
Georg 0:ca77b05e6a8e 53
Georg 0:ca77b05e6a8e 54 * [Mbed OS Stats API](https://os.mbed.com/docs/latest/apis/mbed-statistics.html).
Georg 0:ca77b05e6a8e 55 * [Mbed OS Configuration](https://os.mbed.com/docs/latest/reference/configuration.html).
Georg 0:ca77b05e6a8e 56 * [Mbed OS Serial Communication](https://os.mbed.com/docs/latest/tutorials/serial-communication.html).
Georg 0:ca77b05e6a8e 57 * [Mbed OS bare metal](https://os.mbed.com/docs/mbed-os/latest/reference/mbed-os-bare-metal.html).
Georg 0:ca77b05e6a8e 58 * [Mbed boards](https://os.mbed.com/platforms/).
Georg 0:ca77b05e6a8e 59
Georg 0:ca77b05e6a8e 60 ### License and contributions
Georg 0:ca77b05e6a8e 61
Georg 0:ca77b05e6a8e 62 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.
Georg 0:ca77b05e6a8e 63
Georg 0:ca77b05e6a8e 64 This project contains code from other projects. The original license text is included in those source files. They must comply with our license guide.