AkashiRobo / Mbed OS mbed-tcp-example

tcp example

README.md@0:4e0f31b64b24, 2022-01-19 (annotated)

Committer:
minamikawa
Date:
Wed Jan 19 08:31:23 2022 +0000
Revision:
0:4e0f31b64b24
first_commit

Who changed what in which revision?

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