lu shch / Mbed OS mbed-os-example-mbed5-blinky

demo test

README.md@0:db0f02698665, 2022-11-15 (annotated)

Committer:
sunnylu
Date:
Tue Nov 15 09:09:52 2022 +0000
Revision:
0:db0f02698665
test

Who changed what in which revision?

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