robostep8th / Mbed OS sw_test

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

README.md@0:768dd398f2b8, 2020-12-05 (annotated)

Committer:
liyue0204
Date:
Sat Dec 05 09:47:06 2020 +0000
Revision:
0:768dd398f2b8
(1group)sw_test

Who changed what in which revision?

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