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