OITRP_2022 / Mbed OS encoder_motor

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   QEI

README.md@0:ca2a77886231, 2021-06-23 (annotated)

Committer:
okadaya
Date:
Wed Jun 23 08:34:39 2021 +0000
Revision:
0:ca2a77886231
encoder

Who changed what in which revision?

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