bosko lekovic / Mbed OS EthTCPclient_05_03

p1

README.md@7:be56cf51685d, 2020-06-18 (annotated)

Committer:
bosko001
Date:
Thu Jun 18 15:23:39 2020 +0000
Revision:
7:be56cf51685d
Parent:
0:b01306ccbbe1 
p1

Who changed what in which revision?

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