BRANDON GARCIA / Mbed OS LCD_HelloMicroWorld_Test

Easiest Hello World example!

Dependencies:   TextLCD

README.md@1:48d03321546d, 2020-12-22 (annotated)

Committer:
brandongarcia
Date:
Tue Dec 22 04:41:54 2020 +0000
Revision:
1:48d03321546d
Parent:
0:86dc1c78a40c 
BGR

Who changed what in which revision?

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