Initial release

Dependencies:   DHT11

Committer:
vikshin
Date:
Thu Feb 13 00:24:36 2020 +0000
Revision:
1:0a30ef7e2613
Parent:
0:3e84b0310c96
Minor updates

Who changed what in which revision?

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