Emily Kamienski / Mbed OS swing_jump_win

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:   ExperimentServer MotorShield QEI_pmw

README.md@0:f7e7848048d5, 2022-11-28 (annotated)

Committer:
kaymies
Date:
Mon Nov 28 22:18:47 2022 +0000
Revision:
0:f7e7848048d5
swing jump win code;

Who changed what in which revision?

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