victor gomez / Mbed OS 5-Buzzer

Buzzer

README.md@0:ed488385c247, 2021-07-21 (annotated)

Committer:
thevic16
Date:
Wed Jul 21 19:17:50 2021 +0000
Revision:
0:ed488385c247
Buzzer;

Who changed what in which revision?

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