SAMI NAQVI / Mbed OS TALab3C_ADC

ECE595 - Lab 3 Part 3 - Analog2Digital - TA

README.md@0:f61eba51d14a, 2022-02-06 (annotated)

Committer:
naqvis
Date:
Sun Feb 06 02:01:18 2022 +0000
Revision:
0:f61eba51d14a
ECE 595;

Who changed what in which revision?

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