Valentin Bruchet / Mbed OS TP08_Communication_ZIGBEE

test

README.md@0:9985114fbde9, 2020-12-09 (annotated)

Committer:
valentinbruchet
Date:
Wed Dec 09 13:09:35 2020 +0000
Revision:
0:9985114fbde9
chrono_trame;

Who changed what in which revision?

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