Mark R / Mbed OS F303RE

test

README.md@0:6500e4c5ebd3, 2020-01-15 (annotated)

Committer:
MarkRaveHome
Date:
Wed Jan 15 21:51:41 2020 +0000
Revision:
0:6500e4c5ebd3
Test for studio

Who changed what in which revision?

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