Aditya Mehrotra / Mbed OS Sensor_Training_BoardV2

README.md@6:12ff056ab2c1, 2022-01-19 (annotated)

Committer:
saloutos
Date:
Wed Jan 19 19:32:40 2022 +0000
Revision:
6:12ff056ab2c1
Parent:
0:63fac75e5afc 
added rezeroing of the ATI sensor ;

Who changed what in which revision?

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