Tedd OKANO / Mbed OS SC18IS606_OS6_Hello

operation test on Mbed OS6

Dependencies:   SC18IS606

README.md@0:e6cd94d6b17a, 2021-07-29 (annotated)

Committer:
okano
Date:
Thu Jul 29 18:54:47 2021 +0000
Revision:
0:e6cd94d6b17a
operation test on OS6

Who changed what in which revision?

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