cli export test

Committer:
aie
Date:
Wed Feb 12 14:31:42 2020 +0000
Revision:
0:51881795922e
exprot test;

Who changed what in which revision?

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