Program for Nucleo Board / DMX and MIDI protocols

Dependencies:   DMX_MIDI

Committer:
villemejane
Date:
Tue Mar 01 08:33:38 2022 +0000
Revision:
1:a4b894352be1
Parent:
0:32bfc984f2f7
Program for Nucleo Board / DMX and MIDI protocols

Who changed what in which revision?

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