Craig Evans / Mbed OS ELEC2645_UpDown_Counter_Transition_Table_2021

Up Down counter using a transition table

README.md@1:1e34d5c96ecf, 2020-12-10 (annotated)

Committer:
eencae
Date:
Thu Dec 10 14:22:22 2020 +0000
Revision:
1:1e34d5c96ecf
Parent:
0:7c0953072ecb 
Initial Commit

Who changed what in which revision?

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