Bingshuo Chen / Mbed OS Monster_copy_copy

27

Dependencies:   N5110

README.md@0:ef959ad27a16, 2021-04-08 (annotated)

Committer:
cbs27
Date:
Thu Apr 08 02:09:25 2021 +0000
Revision:
0:ef959ad27a16
Monster

Who changed what in which revision?

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