Jimmy NSENGA / Mbed OS cohort4-hello-world

Hello World App for Cohort 4

README.md@0:66a527592d26, 2022-03-21 (annotated)

Committer:
nsejim
Date:
Mon Mar 21 15:02:43 2022 +0000
Revision:
0:66a527592d26
Changed sleep time from 500 ms to 5000ms

Who changed what in which revision?

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