Hannes Morre / Mbed OS explore-peripherals

RGB-pots

Dependencies:   C12832 LM75B MMA7660

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

Committer:
pertora
Date:
Fri Feb 12 10:13:24 2021 +0000
Revision:
0:a425900441f2
RGB-pots;

Who changed what in which revision?

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