kefil Tonouewa / Mbed OS ECE533_FINAL_PROJECT

ok

Dependencies:   ESP8266

README.md@0:e1c22ca27f03, 2021-11-12 (annotated)

Committer:
kefil_tonouewa
Date:
Fri Nov 12 04:07:52 2021 +0000
Revision:
0:e1c22ca27f03
ok

Who changed what in which revision?

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