詹 博任 / Mbed OS mbed-os-example-mbed5-blinky

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:767ec68705c4, 2020-12-02 (annotated)

Committer:
stonegarden
Date:
Wed Dec 02 07:44:50 2020 +0000
Revision:
0:767ec68705c4
OS6

Who changed what in which revision?

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