(DA) Internet of Things and Smart Electronics- ELE3006M2122 / Mbed OS 18689004Coursework

Coursework

README.md@0:1f799c7cce2b, 2021-12-16 (annotated)

Committer:
sesa514652
Date:
Thu Dec 16 14:03:11 2021 +0000
Revision:
0:1f799c7cce2b
Screen and US combined code

Who changed what in which revision?

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