TVZ Mechatronics Team / Mbed OS Star_Wars_The_imperial_March_2

Star_Wars_The_Imperial_March_Piezo_Buzzer_with_Ticker_and_Interrupts

README.md@0:8544e0d29036, 2019-11-18 (annotated)

Committer:
dfraj
Date:
Mon Nov 18 17:08:14 2019 +0000
Revision:
0:8544e0d29036
Star_Wars_The_Imperial_March_Piezo_Buzzer_with_Ticker_and_Interrupts

Who changed what in which revision?

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