Jack Hansdampf / Mbed OS Alarmanlage

Alarmanlage mit Sensorkit

README.md@0:e4bc630928ec, 2020-04-28 (annotated)

Committer:
jack1930
Date:
Tue Apr 28 15:49:00 2020 +0000
Revision:
0:e4bc630928ec
V1.0

Who changed what in which revision?

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