dasd

Committer:
pavledjo
Date:
Thu Jul 01 15:45:56 2021 +0000
Revision:
0:3a4451afe1ae
afddsf;

Who changed what in which revision?

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