Chris Arndt / Mbed OS STM32F411_mbed5-blinky

Blinky test program for Black Pill board with STM32F411CEU6

README.md@0:ec03923ace26, 2020-06-27 (annotated)

Committer:
SpotlightKid
Date:
Sat Jun 27 20:04:44 2020 +0000
Revision:
0:ec03923ace26
Blinky test program for Black Pill board withl STM32F411CEU6

Who changed what in which revision?

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