mbed_robotcar / Mbed OS team_remote_interruptin

remote interrupt

Dependencies:   RemoteIR

README.md@0:a1d28d3f6f62, 2020-07-13 (annotated)

Committer:
faker_71
Date:
Mon Jul 13 04:49:33 2020 +0000
Revision:
0:a1d28d3f6f62
remote

Who changed what in which revision?

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