Lukas Adlboller / Mbed OS 4CHEL_FSST_Test

FSST Test

README.md@0:90f7dbc52b88, 2020-01-28 (annotated)

Committer:
Lukas_Adlboller
Date:
Tue Jan 28 09:23:17 2020 +0000
Revision:
0:90f7dbc52b88
FSST Test: Duty Cycle

Who changed what in which revision?

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