Алексей Лебедев / Mbed OS mbed-os-example-mbed5-blinky

added

README.md@0:dcb769be307b, 2021-10-06 (annotated)

Committer:
aleksey136
Date:
Wed Oct 06 16:26:51 2021 +0000
Revision:
0:dcb769be307b
Practice1

Who changed what in which revision?

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