Jozef Staník / Mbed OS Cvicenie_4_02
Committer:
_lukas_formanek
Date:
Tue Oct 06 07:21:25 2020 +0000
Revision:
0:99c19dff3a25
ver 1

Who changed what in which revision?

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