Zbigniew Druzbacki / Mbed OS mbed-os-example-mbed5-blinky

Test for export to desktop ide

README.md@0:43f8d14fb617, 2020-08-03 (annotated)

Committer:
Zbyszek
Date:
Mon Aug 03 12:42:21 2020 +0000
Revision:
0:43f8d14fb617
Test

Who changed what in which revision?

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