Pavle Popovic / Mbed OS 19E042PIM_TJAN_2020_0494

Pavle Popovic 2020/0494

Dependencies:   Adafruit_GFX 19E042PIM_MB_PINS

README.md@0:4b068ef5ed41, 2022-01-17 (annotated)

Committer:
pavle1
Date:
Mon Jan 17 16:05:55 2022 +0000
Revision:
0:4b068ef5ed41
Pavle Popovic 2020/0494

Who changed what in which revision?

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