Stephan Schnittger / Mbed OS mbed-os-example-serial

Serial control with STM32 Nucleo

Dependencies:   JSON

README.md@0:fde0aa5b370d, 2021-04-29 (annotated)

Committer:
lucadevito
Date:
Thu Apr 29 09:23:17 2021 +0000
Revision:
0:fde0aa5b370d
1st release

Who changed what in which revision?

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