Lukas Hoste / Mbed OS mbed_Peripherals

peripherals

Dependencies:   C12832 LM75B

README.md@0:ca9a8a50b85b, 2021-02-05 (annotated)

Committer:
lhoste
Date:
Fri Feb 05 15:21:45 2021 +0000
Revision:
0:ca9a8a50b85b
mbed-peripherals;

Who changed what in which revision?

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