mbed_robotcar / Mbed OS LineTrace_and_Avoidance_2tires

linetrace saikyo!

README.md@2:cc4e4527ea43, 2020-09-24 (annotated)

Committer:
takuminomura
Date:
Thu Sep 24 06:58:39 2020 +0000
Revision:
2:cc4e4527ea43
Parent:
0:55ababc360bf 
miyasui;

Who changed what in which revision?

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