Danny Nichols / Mbed OS ENGR6002_P001unk

stilldk

Dependencies:   vl53l0x_api SRF05

README.md@0:041c1089b6e5, 2022-03-10 (annotated)

Committer:
dnikolz
Date:
Thu Mar 10 08:40:14 2022 +0000
Revision:
0:041c1089b6e5
idk

Who changed what in which revision?

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