Becky Page / Mbed OS Blinkcopy

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

README.md@0:cd8526d38aea, 2020-11-20 (annotated)

Committer:
rebecca_page
Date:
Fri Nov 20 15:14:39 2020 +0000
Revision:
0:cd8526d38aea
My first commitment

Who changed what in which revision?

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