Authentication / Mbed OS Attendant

adding member

Dependencies:   TextLCD

README.md@3:be0b871f3ff9, 2020-03-20 (annotated)

Committer:
raynard
Date:
Fri Mar 20 11:07:29 2020 +0000
Revision:
3:be0b871f3ff9
Parent:
0:9802675a1b15 
adding TextLCD.h

Who changed what in which revision?

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