Thybris Vandenbroucke / Mbed OS client

Dependencies:   LM75B

README.md@0:71de036422e3, 2020-11-07 (annotated)

Committer:
thybris
Date:
Sat Nov 07 13:37:34 2020 +0000
Revision:
0:71de036422e3
client side;

Who changed what in which revision?

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