Mario Vargas / Mbed OS CANTX

canok

README.md@0:0e8e4d659972, 2022-10-12 (annotated)

Committer:
mvargas_dtk
Date:
Wed Oct 12 14:44:25 2022 +0000
Revision:
0:0e8e4d659972
canok

Who changed what in which revision?

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