Zoltan Hudak / Mbed OS USBKeyboard_Test

USBKeyboard test.

README.md@2:59bd031a5687, 2020-05-01 (annotated)

Committer:
hudakz
Date:
Fri May 01 20:26:42 2020 +0000
Revision:
2:59bd031a5687
Parent:
0:be4449b9ccca 
USBKeyboard test.

Who changed what in which revision?

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