mohamed trabelsi / Mbed OS UJA1023_LIN_LED

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

README.md@0:0af5ede0c252, 2022-04-27 (annotated)

Committer:
metronix
Date:
Wed Apr 27 07:15:24 2022 +0000
Revision:
0:0af5ede0c252
LINSMSG;

Who changed what in which revision?

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