Digiti II / Mbed OS Final_Seg_Cort

Ghk

Dependencies:   HCSR04

README.md@0:9b19dc46ec16, 2021-03-02 (annotated)

Committer:
michaelrodriguezg
Date:
Tue Mar 02 00:17:32 2021 +0000
Revision:
0:9b19dc46ec16
Web

Who changed what in which revision?

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