Eric Leal / Mbed OS GPS_sample_os6

Sample code to show the outputs of my GPS library for mbed6 using serial interrupt

Dependencies:   GPS

README.md@0:932beb312ff9, 2021-09-15 (annotated)

Committer:
ericleal
Date:
Wed Sep 15 23:21:46 2021 +0000
Revision:
0:932beb312ff9
initial commit

Who changed what in which revision?

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