IOGS_France / Mbed OS IeTI_nRF24

Program to test nrF24 module / RF transmission

Dependencies:   MOD24_NRF nRF24

README.md@2:68d03c147aff, 2022-03-19 (annotated)

Committer:
villemejane
Date:
Sat Mar 19 19:01:34 2022 +0000
Revision:
2:68d03c147aff
Parent:
0:4762540bcced 
Program to test nrF24 module / RF transmission

Who changed what in which revision?

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