Thomas Van Aken / Mbed OS bartho

test

README.md@4:40d23f4295f9, 2021-02-10 (annotated)

Committer:
TVA
Date:
Wed Feb 10 19:45:43 2021 +0000
Revision:
4:40d23f4295f9
Parent:
0:8491d8911089 
Working test

Who changed what in which revision?

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