Craig Evans / Mbed OS ELEC2645_Pong2021

Pong game for ELEC1620 board.

README.md@0:be41a15e7a86, 2020-12-11 (annotated)

Committer:
eencae
Date:
Fri Dec 11 12:25:25 2020 +0000
Revision:
0:be41a15e7a86
Initial Commit

Who changed what in which revision?

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