Lee Nam Cheol / Mbed OS lab01-switch-d1-input

lab01-switch-d1-input

README.md@0:6adae120f4eb, 2020-04-12 (annotated)

Committer:
namcheol
Date:
Sun Apr 12 09:26:20 2020 +0000
Revision:
0:6adae120f4eb
lab01-switch-d1-input

Who changed what in which revision?

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