Mauricio Donatti / Mbed OS mbed-os-6-FlashIAP

Testing FlashIAP library with MBED OS 6 and sleep functions

README.md@2:d43334a39b02, 2020-08-11 (annotated)

Committer:
mmdonatti
Date:
Tue Aug 11 17:07:42 2020 +0000
Revision:
2:d43334a39b02
Parent:
0:48a28b2443d1 
circular buffer implemented, using Flash pages and sectors

Who changed what in which revision?

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