federico.bozzini@arm.com / Mbed OS blinky-public

Blinky is cool isn't it?

README.md@2:0388a1daa4b0, 18 months ago (annotated)

Committer:
federicobozzini
Date:
Tue Nov 01 11:36:10 2022 +0000
Revision:
2:0388a1daa4b0
Parent:
0:40618b777147 
hgignore

Who changed what in which revision?

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