Andrew Reed / Mbed OS mbed-os-example-switch_counter

Switch bounce demonstration

README.md@0:2b3584252caf, 2019-11-12 (annotated)

Committer:
reedas
Date:
Tue Nov 12 10:03:21 2019 +0000
Revision:
0:2b3584252caf
CITY1082 example code

Who changed what in which revision?

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