Jovana Trajkovic / Mbed 2 deprecated 19E042PIM_T1_2019_0408

2019/0408 Jovana Trajkovic

Dependencies:   mbed

README.md@0:f52720c66789, 2021-11-06 (annotated)

Committer:
jovanat
Date:
Sat Nov 06 08:15:17 2021 +0000
Revision:
0:f52720c66789
2019/0408 Jovana Trajkovic

Who changed what in which revision?

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