Kittitouch Lelapiyamit / Mbed OS ir_robot

Dependencies:   RemoteIR

README.md@0:ea9bd7bea668, 2021-07-26 (annotated)

Committer:
famesy
Date:
Mon Jul 26 07:54:50 2021 +0000
Revision:
0:ea9bd7bea668
sent ping;

Who changed what in which revision?

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