Vali Abdrakhmanov / Mbed OS mbed-os-example_2threads_RAK811

mbed-os-example_2threads_RAK811

Dependencies:   Sht31

README.md@0:3b743e0d0126, 2022-03-03 (annotated)

Committer:
awali
Date:
Thu Mar 03 12:23:47 2022 +0000
Revision:
0:3b743e0d0126
1

Who changed what in which revision?

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