Jack Hansdampf / Mbed OS Ampel

Handreichung TI3

README.md@0:7bd60de6afc1, 2020-04-28 (annotated)

Committer:
jack1930
Date:
Tue Apr 28 15:49:58 2020 +0000
Revision:
0:7bd60de6afc1
V1.0

Who changed what in which revision?

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