https://github.com/openthread/ot-reference-release
https://github.com/openthread/ot-reference-release
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/openthread/ot-reference-release
- Owner: openthread
- License: bsd-3-clause
- Created: 2021-05-10T15:43:39.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-04-23T23:42:36.000Z (about 1 year ago)
- Last Synced: 2025-04-24T00:29:36.022Z (about 1 year ago)
- Language: Python
- Size: 2.62 MB
- Stars: 11
- Watchers: 26
- Forks: 27
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.txt
- License: LICENSE
Awesome Lists containing this project
README
# ot-reference-release
## Usage
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'] [OPENTHREAD_COMMIT_HASH=c9c19aa9fa5877cf1532c35a584618900e5c99c7] ./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.
`OPENTHREAD_COMMIT_HASH` sets custom openthread commit SHA for NCS builds.
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.
# Contributing
We would love for you to contribute to OpenThread and help make it even better than it is today! See our [Contributing Guidelines](https://github.com/openthread/openthread/blob/main/CONTRIBUTING.md) for more information.
Contributors are required to abide by our [Code of Conduct](https://github.com/openthread/openthread/blob/main/CODE_OF_CONDUCT.md) and [Coding Conventions and Style Guide](https://github.com/openthread/openthread/blob/main/STYLE_GUIDE.md).
# License
OpenThread is released under the [BSD 3-Clause license](https://github.com/openthread/ot-reference-release/blob/main/LICENSE). See the [`LICENSE`](https://github.com/openthread/ot-reference-release/blob/main/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.
# Need help?
OpenThread support is available on GitHub:
- Bugs and feature requests pertaining to the Reference Release — [submit to the openthread/ot-reference-release Issue Tracker](https://github.com/openthread/ot-reference-release/issues)
- OpenThread bugs and feature requests — [submit to the OpenThread Issue Tracker](https://github.com/openthread/openthread/issues)
- Community Discussion - [ask questions, share ideas, and engage with other community members](https://github.com/openthread/openthread/discussions)