Andrew Reed / Mbed OS CITY1082-i2c_master

Initial

Dependencies:   TextLCD2

README.md@1:f9ef03b6aab8, 2020-01-14 (annotated)

Committer:
reedas
Date:
Tue Jan 14 11:30:06 2020 +0000
Revision:
1:f9ef03b6aab8
Parent:
0:e9613d017b5e 
Initial Commit;

Who changed what in which revision?

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