John Alexander / Mbed OS mbed-os-example-mbed6-blinky

Initial trial for integration with mbed studio.

README.md@0:0d3532080d4f, 2020-10-08 (annotated)

Committer:
johnAlexander
Date:
Thu Oct 08 15:25:12 2020 +0000
Revision:
0:0d3532080d4f
initial release, for trial with mbed studio

Who changed what in which revision?

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