Hayato Kikuchi / Mbed OS MonitoringTest

Dependencies:   SoftPWM

Committer:
kikuchi8810
Date:
Wed Dec 22 11:15:12 2021 +0000
Revision:
0:a33375289d79
CommunicationMonitoring Class

Who changed what in which revision?

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