Michiel Depraetere / Mbed OS mbed-os-example-mbed5-blinky

RGB with pot

Dependencies:   C12832

README.md@0:b1098da81497, 2021-02-12 (annotated)

Committer:
depraeterem
Date:
Fri Feb 12 09:41:25 2021 +0000
Revision:
0:b1098da81497
RGB with pot

Who changed what in which revision?

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