S Morita / Mbed OS mbed-os-example-mros2

mros2 on MBed example reported at ROS Japan UG #44 LT. [Event] https://rosjp.connpass.com/event/222141/ [Slide] https://www.slideshare.net/smorita1/mros2-on-mbed

Dependencies:   mbed-mros2

Please refer to the getting started.

https://github.com/mROS-base/mros2-mbed

README.md@0:8630970819e4, 2021-10-09 (annotated)

Committer:
smoritaemb
Date:
Sat Oct 09 05:40:59 2021 +0000
Revision:
0:8630970819e4
Child:
1:c01b621ed377
mros2 on Mbed sample

Who changed what in which revision?

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