James Jaramillo Huaman / Mbed OS mbed-os

mbed-os-Base

README.md@0:5c730320c39f, 2021-09-25 (annotated)

Committer:
jamesjh98
Date:
Sat Sep 25 09:42:41 2021 +0000
Revision:
0:5c730320c39f
sa

Who changed what in which revision?

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