Ruan du Preez / Mbed OS mbed-os-example-mbed5-blinky

LED blink

README.md@0:7041cd1856c2, 2022-08-31 (annotated)

Committer:
ruan555
Date:
Wed Aug 31 14:23:24 2022 +0000
Revision:
0:7041cd1856c2
first

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ruan555 0:7041cd1856c2 1 ![](./resources/official_armmbed_example_badge.png)
ruan555 0:7041cd1856c2 2 # Blinky Mbed OS example
ruan555 0:7041cd1856c2 3
ruan555 0:7041cd1856c2 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/).
ruan555 0:7041cd1856c2 5
ruan555 0:7041cd1856c2 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).
ruan555 0:7041cd1856c2 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).)
ruan555 0:7041cd1856c2 8
ruan555 0:7041cd1856c2 9 1. [Install Mbed CLI](https://os.mbed.com/docs/mbed-os/latest/quick-start/offline-with-mbed-cli.html).
ruan555 0:7041cd1856c2 10
ruan555 0:7041cd1856c2 11 1. Clone this repository on your system, and change the current directory to where the project was cloned:
ruan555 0:7041cd1856c2 12
ruan555 0:7041cd1856c2 13 ```bash
ruan555 0:7041cd1856c2 14 $ git clone git@github.com:armmbed/mbed-os-example-blinky && cd mbed-os-example-blinky
ruan555 0:7041cd1856c2 15 ```
ruan555 0:7041cd1856c2 16
ruan555 0:7041cd1856c2 17 Alternatively, you can download the example project with Arm Mbed CLI using the `import` subcommand:
ruan555 0:7041cd1856c2 18
ruan555 0:7041cd1856c2 19 ```bash
ruan555 0:7041cd1856c2 20 $ mbed import mbed-os-example-blinky && cd mbed-os-example-blinky
ruan555 0:7041cd1856c2 21 ```
ruan555 0:7041cd1856c2 22
ruan555 0:7041cd1856c2 23
ruan555 0:7041cd1856c2 24 ## Application functionality
ruan555 0:7041cd1856c2 25
ruan555 0:7041cd1856c2 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.
ruan555 0:7041cd1856c2 27
ruan555 0:7041cd1856c2 28 ## Building and running
ruan555 0:7041cd1856c2 29
ruan555 0:7041cd1856c2 30 1. Connect a USB cable between the USB port on the board and the host computer.
ruan555 0:7041cd1856c2 31 2. <a name="build_cmd"></a> Run the following command to build the example project and program the microcontroller flash memory:
ruan555 0:7041cd1856c2 32 ```bash
ruan555 0:7041cd1856c2 33 $ mbed compile -m <TARGET> -t <TOOLCHAIN> --flash
ruan555 0:7041cd1856c2 34 ```
ruan555 0:7041cd1856c2 35 The binary is located at `./BUILD/<TARGET>/<TOOLCHAIN>/mbed-os-example-blinky.bin`.
ruan555 0:7041cd1856c2 36
ruan555 0:7041cd1856c2 37 Alternatively, you can manually copy the binary to the board, which you mount on the host computer over USB.
ruan555 0:7041cd1856c2 38
ruan555 0:7041cd1856c2 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:
ruan555 0:7041cd1856c2 40
ruan555 0:7041cd1856c2 41 ```bash
ruan555 0:7041cd1856c2 42 $ mbed compile -S
ruan555 0:7041cd1856c2 43 ```
ruan555 0:7041cd1856c2 44
ruan555 0:7041cd1856c2 45 ## Expected output
ruan555 0:7041cd1856c2 46 The LED on your target turns on and off every 500 milliseconds.
ruan555 0:7041cd1856c2 47
ruan555 0:7041cd1856c2 48
ruan555 0:7041cd1856c2 49 ## Troubleshooting
ruan555 0:7041cd1856c2 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.
ruan555 0:7041cd1856c2 51
ruan555 0:7041cd1856c2 52 ## Related Links
ruan555 0:7041cd1856c2 53
ruan555 0:7041cd1856c2 54 * [Mbed OS Stats API](https://os.mbed.com/docs/latest/apis/mbed-statistics.html).
ruan555 0:7041cd1856c2 55 * [Mbed OS Configuration](https://os.mbed.com/docs/latest/reference/configuration.html).
ruan555 0:7041cd1856c2 56 * [Mbed OS Serial Communication](https://os.mbed.com/docs/latest/tutorials/serial-communication.html).
ruan555 0:7041cd1856c2 57 * [Mbed OS bare metal](https://os.mbed.com/docs/mbed-os/latest/reference/mbed-os-bare-metal.html).
ruan555 0:7041cd1856c2 58 * [Mbed boards](https://os.mbed.com/platforms/).
ruan555 0:7041cd1856c2 59
ruan555 0:7041cd1856c2 60 ### License and contributions
ruan555 0:7041cd1856c2 61
ruan555 0:7041cd1856c2 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.
ruan555 0:7041cd1856c2 63
ruan555 0:7041cd1856c2 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.