Sikil / Mbed OS Sikil

Sikil

README.md@0:ca4ecd424807, 2021-01-15 (annotated)

Committer:
maetugr
Date:
Fri Jan 15 09:51:57 2021 +0000
Revision:
0:ca4ecd424807
LED brightness works asynchronously

Who changed what in which revision?

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