Zoltan Hudak / Mbed OS blinky-os_bare-metal

Comparing bare-metal Flash/RAM against RTOS.

README.md@0:95f65fd1b69a, 2020-04-30 (annotated)

Committer:
hudakz
Date:
Thu Apr 30 05:49:32 2020 +0000
Revision:
0:95f65fd1b69a
Comparing bare-metal Flash/RAM against RTOS.

Who changed what in which revision?

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