Ruxin Qi / Mbed OS OLED_Screen

sss

Dependencies:   Adafruit_GFX

README.md@0:50a743a837d8, 2021-05-24 (annotated)

Committer:
atalkingdog
Date:
Mon May 24 09:02:15 2021 +0000
Revision:
0:50a743a837d8
sss

Who changed what in which revision?

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