Niko Birolini / Mbed OS flash

memoire flash

README.md@0:e32119dfd2fe, 2020-12-07 (annotated)

Committer:
nikobirolini
Date:
Mon Dec 07 09:06:35 2020 +0000
Revision:
0:e32119dfd2fe
memoire morte

Who changed what in which revision?

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