Alexander Leshukov / Mbed OS Exam_TK

[PH]

Dependencies:   IRremouteAndButton QuadDisplayMy LIS3MDL_my sMotor

README.md@1:b24bac622a37, 2021-05-17 (annotated)

Committer:
allesh
Date:
Mon May 17 07:17:06 2021 +0000
Revision:
1:b24bac622a37
Parent:
0:eb99909151eb 
placeholder;

Who changed what in which revision?

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