AKRAM OMAR / Mbed OS EMBEDDED_SYSTEM_PROJECT_GROUP_9

Embedded System Project for Group 9 Wearable Infant Growth Monitoring

Dependencies:   SX1276 Sht31 C12832

README.md@0:bcf3192451ab, 2021-07-12 (annotated)

Committer:
akramaliomar
Date:
Mon Jul 12 12:42:29 2021 +0000
Revision:
0:bcf3192451ab
import libraries

Who changed what in which revision?

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