denki / Mbed OS l1

1

Dependencies:   RemoteIR TextLCD

README.md@0:4c4775017e8a, 2020-09-23 (annotated)

Committer:
jiang111
Date:
Wed Sep 23 01:45:03 2020 +0000
Revision:
0:4c4775017e8a
1

Who changed what in which revision?

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