mbed_robotcar / Mbed OS mbed_signal

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:c8547914b033, 2020-07-09 (annotated)

Committer:
tomotsugu
Date:
Thu Jul 09 07:10:52 2020 +0000
Revision:
0:c8547914b033
signal_LED8

Who changed what in which revision?

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