k k / Mbed OS dhtcode

...

Dependencies:   DHT TextLCD

README.md@0:74ce8bfddd4a, 2021-06-09 (annotated)

Committer:
katachi
Date:
Wed Jun 09 06:25:36 2021 +0000
Revision:
0:74ce8bfddd4a
...

Who changed what in which revision?

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