Simon De Neve / Mbed OS mbed-os-rgb

rgb through potentiometer

README.md@0:b4c55dd82abb, 2020-02-10 (annotated)

Committer:
tweagle
Date:
Mon Feb 10 10:36:52 2020 +0000
Revision:
0:b4c55dd82abb
rgb through analog potentiometers

Who changed what in which revision?

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