Clone this repository:
$ git clone https://github.com/openthread/ot-reference-release
Initialize the submodules:
$ git submodule update --init --recursive
At the root of the repository:
$ REFERENCE_PLATFORM=(nrf52840|efr32mg12|ncs|none) REFERENCE_RELEASE_TYPE=(1.2|1.3|1.3.1) [SD_CARD=/dev/...] [OTBR_RCP_BUS=(UART|SPI)] [IN_CHINA=(0|1)] [OTBR_RADIO_URL='spinel+hdlc+uart:///dev/ttyUSB0'] ./script/make-reference-release.bash
This will produce a reference release folder in ./build/. The folder will be
named after the release type, date and the OpenThread commit id.
SD_CARD is expected to be the device file path of an SD card inserted to
the host. If this variable is specified, the script will flash the Raspberry Pi
image containing OpenThread border router service to the SD card.
If IN_CHINA is set to 1, the script will prefer to use apt sources based in
China so that you can save time while installing software dependencies.
OTBR_RCP_BUS sets the RCP hardware interface type of Spinel on otbr-agent.
If this variable is not specified, the interface type is set to UART by default.
OTBR_RADIO_URL sets the otbr-agent's radio URL. If this variable is not specified,
the otbr-agent's argument is set to spinel+hdlc+uart:///dev/ttyACM0 by default.
For example, if you are in China and want to flash the built image to an SD card:
$ REFERENCE_PLATFORM=nrf52840 REFERENCE_RELEASE_TYPE=1.2 IN_CHINA=1 SD_CARD=/dev/sda ./script/make-reference-release.bash
When REFERENCE_RELEASE_TYPE is 1.2, reference release contains following components:
- Raspberry Pi image containing OTBR service and OT Commissioner
- Firmware
- THCI
- Change log
- Quick start guide
When REFERENCE_RELEASE_TYPE is 1.3 or 1.3.1, reference release contains following components:
- Raspberry Pi image containing OTBR service with border routing feature, service registry feature and OT Commissioner
- Firmware
- Change log
- Quick start guide
Note: Currently, only the following boards are supported for CLI/RCP firmwares:
- nRF52840 dongles
- EFR32MG12 BRD4166A boards
If the REFERENCE_PLATFORM is set to none, the firmware won't be generated.
We would love for you to contribute to OpenThread and help make it even better than it is today! See our Contributing Guidelines for more information.
Contributors are required to abide by our Code of Conduct and Coding Conventions and Style Guide.
OpenThread is released under the BSD 3-Clause license. See the LICENSE file for more information.
Please only use the OpenThread name and marks when accurately referencing this software distribution. Do not use the marks in a way that suggests you are endorsed by or otherwise affiliated with Nest, Google, or The Thread Group.
OpenThread support is available on GitHub:
- Bugs and feature requests pertaining to the Reference Release — submit to the openthread/ot-reference-release Issue Tracker
- OpenThread bugs and feature requests — submit to the OpenThread Issue Tracker
- Community Discussion - ask questions, share ideas, and engage with other community members