Erick Rodriguez / Mbed OS USNA-UMBC-KF-01

USNA-UMBC Project Data (Yaw) Generator / Transmitter

Dependencies:   ServoOut mcp2515 BNO055

README.md@1:269a9d669b48, 23 months ago (annotated)

Committer:
professorrodriguezse
Date:
Fri May 20 18:38:44 2022 +0000
Revision:
1:269a9d669b48
Parent:
0:ee3eb98ec375 
Data Generator

Who changed what in which revision?

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