Kirill Vanin / Mbed OS 2-3-5-Vanin

Case 2.5 for Samsung IoT.

Dependencies:   Sht31

README.md@103:681967d62a72, 2019-11-05 (annotated)

Committer:
mbed_official
Date:
Tue Nov 05 10:00:04 2019 +0000
Revision:
103:681967d62a72
Parent:
102:6979ad8bc0bc 
Corrected code snippet rendering on README. (#197)





.

Commit copied from https://github.com/ARMmbed/mbed-os-example-blinky

Who changed what in which revision?

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