Rob Moran
czxc
README.md
- Committer:
- thegecko
- Date:
- 2017-10-11
- Revision:
- 0:103bac868627
File content as of revision 0:103bac868627:
# example-mbedos-blinky
Blinky is a simple example program that blinks an LED on an mbed-enabled board with mbed OS.
[](http://yotta.mbed.com/#/target/arch-ble-gcc)
[](http://yotta.mbed.com/#/target/arch-link-gcc)
[](http://yotta.mbed.com/#/target/atmel-samd21g18a-gcc)
[](http://yotta.mbed.com/#/target/atmel-samg55j19-gcc)
[](http://yotta.mbed.com/#/target/atmel-samr21g18a-gcc)
[](http://yotta.mbed.com/#/target/bbc-microbit-classic-gcc-nosd)
[](http://yotta.mbed.com/#/target/bbc-microbit-classic-gcc-s130)
[](http://yotta.mbed.com/#/target/bbc-microbit-classic-gcc)
[](http://yotta.mbed.com/#/target/bbc-microbit-gcc)
[](http://yotta.mbed.com/#/target/blenano-gcc)
[](http://yotta.mbed.com/#/target/efm32gg-stk-gcc)
[](http://yotta.mbed.com/#/target/efm32hg-stk-gcc)
[](http://yotta.mbed.com/#/target/efm32lg-stk-gcc)
[](http://yotta.mbed.com/#/target/efm32wg-stk-gcc)
[](http://yotta.mbed.com/#/target/frdm-k22f-gcc)
[](http://yotta.mbed.com/#/target/frdm-k64f-gcc)
[](http://yotta.mbed.com/#/target/frdm-k64f-st-ble-gcc)
[](http://yotta.mbed.com/#/target/k64f-gcc)
[](http://yotta.mbed.com/#/target/kinetis-k22f-gcc)
[](http://yotta.mbed.com/#/target/kinetis-k64-gcc)
[](http://yotta.mbed.com/#/target/lex-test-gcc)
[](http://yotta.mbed.com/#/target/mbed-gcc)
[](http://yotta.mbed.com/#/target/mkit-gcc)
[](http://yotta.mbed.com/#/target/nordic-nrf51822-16k-gcc)
[](http://yotta.mbed.com/#/target/nordic-nrf51822-32k-gcc)
[](http://yotta.mbed.com/#/target/nordic-nrf51822-gcc-unofficial-fota)
[](http://yotta.mbed.com/#/target/nordic-nrf51822-gcc-unofficial-no-softdevice)
[](http://yotta.mbed.com/#/target/nordic-nrf51822-gcc-unofficial)
[](http://yotta.mbed.com/#/target/nordic-nrf51822-gcc)
[](http://yotta.mbed.com/#/target/nrf51dk-gcc)
[](http://yotta.mbed.com/#/target/nxp-lpc111x-gcc)
[](http://yotta.mbed.com/#/target/nxp-lpc1768-gcc)
[](http://yotta.mbed.com/#/target/nxpdk5-jn517x-gcc)
[](http://yotta.mbed.com/#/target/redbearlab-nrf51822-gcc)
[](http://yotta.mbed.com/#/target/seeedtinyble-gcc)
[](http://yotta.mbed.com/#/target/st-nucleo-f091rc-gcc)
[](http://yotta.mbed.com/#/target/st-nucleo-f401re-gcc)
[](http://yotta.mbed.com/#/target/st-nucleo-f401re-st-ble-gcc)
[](http://yotta.mbed.com/#/target/st-stm32f439zi-gcc)
[](http://yotta.mbed.com/#/target/stk3700-gcc)
[](http://yotta.mbed.com/#/target/stm32f4-disco-gcc)
[](http://yotta.mbed.com/#/target/stm32f411e-disco-gcc)
[](http://yotta.mbed.com/#/target/stm32f411re-nucleo-gcc)
[](http://yotta.mbed.com/#/target/stm32f429i-disco-gcc)
[](http://yotta.mbed.com/#/target/target-onsemi-ncs36510-gcc)
[](http://yotta.mbed.com/#/target/tinyble-gcc)
[](http://yotta.mbed.com/#/target/ublox-c029-gcc)
[](http://yotta.mbed.com/#/target/ublox-odin-w2-evk-gcc)
[](http://yotta.mbed.com/#/target/ublox-odin-w2-gcc)
[](http://yotta.mbed.com/#/target/xdk110-gcc)
## What Blinky does
This is a short review of the Blinky code. More information is available on the user guide, where we explain [how to write mbed OS applications](https://docs.mbed.com/docs/getting-started-mbed-os/en/latest/Full_Guide/app_on_mbed_os/) and how to [work with yotta](https://docs.mbed.com/docs/getting-started-mbed-os/en/latest/Full_Guide/app_on_yotta/).
1. The code begins with ``include``. The included header is ``mbed.h``, from the ``mbed-drivers`` library. It is a key library for mbed OS, and includes most of the functionality standard applications need. yotta, our build system, includes ``mbed-drivers`` during compilation because that library is listed as a dependency in Blinky's ``module.json`` file.
1. mbed OS applications start with ``app_start``, replacing ``main``.
1. MINAR is the mbed OS scheduler; we use it here to create a callback that will run every 500 milliseconds. The function we're running is ``blinky``.
1. ``blinky`` creates a DigitalOut using the LED1 on our board. It then turns the LED on and off and prints its status to the terminal using ``printf``.
**Tip:** To learn more about writing applications for mbed OS, see the [mbed OS user guide's review of Blinky](https://docs.mbed.com/docs/getting-started-mbed-os/en/latest/Full_Guide/app_on_mbed_os/).
## Building the example
### If you're using yotta as a command-line tool
**Tip:** If you need help setting up yotta or building a project, see our [quick guide](https://docs.mbed.com/docs/getting-started-mbed-os/en/latest/FirstProjectmbedOS/), which uses the same example.
To build Blinky with yotta as a command-line tool:
1. Clone the repository from GitHub:
```
$ git clone https://github.com/ARMmbed/example-mbedos-blinky.git
$ cd example-mbedos-blinky
```
2. Select a target platform:
```
$ yotta target frdm-k64f-gcc
```
3. Build it:
```
$ yotta build
... bunch of build messages ...
[135/135] Linking CXX executable source/example-mbedos-blinky
```
yotta will put the compiled binary in the project's `/build` folder. Copy the binary `/build/frdm-k64f-gcc/source/example-mbedos-blinky.bin` to your mbed board over USB.
### If you're on the online IDE
**Tip:** If you need help getting started with the IDE, see our [quick guide](https://docs.mbed.com/docs/getting-started-mbed-os/en/latest/FirstProjectmbedOS/), which uses the same example.
To build Blinky in your IDE workspace:
1. The IDE needs to know which target to build for. Click *Target*:
1. The list displays your recently used targets. If the target you need is listed, click it.
1. If your target isn't in the drop-down list, click *Search in Registry*. A list of targets opens. Select your target and click *Set*.
1. Click *Build Project*.
The IDE will build the project as a binary file and ask you to download it. When the download finishes, copy the file to your mbed board over USB.