mbed_robotcar / Mbed OS batteryReamid

bChange

Dependencies:   TextLCD

README.md@8:0719ca2421b4, 2020-07-29 (annotated)

Committer:
nishimura_taku_pet
Date:
Wed Jul 29 02:32:43 2020 +0000
Revision:
8:0719ca2421b4
Parent:
0:18811ba92e94 
commit

Who changed what in which revision?

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