Qingyuan Zheng / Mbed OS ZhengQingyuanSSD1306

SSD1306+SRF05

Dependencies:   SSD1306_128x64_I2C

README.md@0:3c2d19c8d57f, 2021-06-10 (annotated)

Committer:
karajan
Date:
Thu Jun 10 14:55:08 2021 +0000
Revision:
0:3c2d19c8d57f
SSD1306+SRF05

Who changed what in which revision?

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