Pavle Popovic / Mbed 2 deprecated 19E042PIM_T2_2020_0494

Pavle Popovic 0494

Dependencies:   mbed

README.md@0:2cc3ed89daea, 2021-11-13 (annotated)

Committer:
pavle1
Date:
Sat Nov 13 09:11:59 2021 +0000
Revision:
0:2cc3ed89daea
Pavle Popovic 2020/0494;

Who changed what in which revision?

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