Toshiaki Kurokawa / Mbed OS Kairo3-Practice2_run3_0

a

README.md@0:b124081ccd07, 2022-05-13 (annotated)

Committer:
momidi
Date:
Fri May 13 08:17:17 2022 +0000
Revision:
0:b124081ccd07
a

Who changed what in which revision?

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