Jens Vanhove / Mbed OS mbed-os-example-helloworld

Hello world program

README.md@0:e30516181c1e, 2021-02-06 (annotated)

Committer:
jensva
Date:
Sat Feb 06 13:09:22 2021 +0000
Revision:
0:e30516181c1e
commit1

Who changed what in which revision?

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