OpenThread

https://openthread.io/
Admin
OpenThread is an open-source implementation of the Thread networking protocol, developed by Google....
Tokens:6,793,375
Snippets:56,705
Trust Score:9.5
Update:1 year ago
Show doc for...
Tokens:
Raw
### Build OpenThread Simulation Example

Source: https://openthread.io/guides/pyspinel/get-started

This command builds the OpenThread simulation example, which is required to run a simulated OpenThread NCP for Pyspinel. It uses the `cmake-build` script located in the OpenThread repository's `script` directory.

```Shell
./script/cmake-build simulation
```

--------------------------------

### Extract and Install Zephyr SDK Toolchain

Source: https://openthread.io/codelabs/telink-openthread-hardware

Extracts the downloaded Zephyr SDK archive and runs the setup script to install the toolchain. The flags specify the target architecture and additional setup options.

```Shell
$ tar xvf zephyr-sdk-0.16.1_linux-x86_64.tar.xz
$ cd zephyr-sdk-0.16.1
$ ./setup.sh -t riscv64-zephyr-elf -h -c
```

--------------------------------

### Example of Successful OpenThread Border Router (OTBR) Docker Logs

Source: https://openthread.io/guides/border-router/build-docker

This snippet shows an example of what successful 'otbr' Docker container logs look like. It indicates that services like mDNS, OpenThread firewall, NAT64, and otbr-agent are starting and running correctly, along with detailed spinel frame interactions and radio configurations.

```Log
s6-rc: info: service mdns: starting
s6-rc: info: service s6rc-oneshot-runner: starting
Starting mDNSResponder...
Default: mDNSResponder (Engineering Build) (Mar 26 2025 19:39:09) starting
s6-rc: info: service mdns successfully started
s6-rc: info: service s6rc-oneshot-runner successfully started
s6-rc: info: service fix-attrs: starting
s6-rc: info: service fix-attrs successfully started
s6-rc: info: service legacy-cont-init: starting
s6-rc: info: service legacy-cont-init successfully started
s6-rc: info: service otbr-agent: starting
Configuring OpenThread firewall...
Configuring OpenThread NAT64...
Starting otbr-agent...
[NOTE]-AGENT---: Running 0.3.0-da4b5cf
[NOTE]-AGENT---: Thread version: 1.4.0
[NOTE]-AGENT---: Thread interface: wpan0
[NOTE]-AGENT---: Radio URL: spinel+hdlc+uart:///dev/ttyACM0?uart-baudrate=1000000
[NOTE]-AGENT---: Radio URL: trel://wlan0
[NOTE]-ILS-----: Infra link selected: wlan0
[INFO]-RCP_HOS-: OpenThread log level changed to 5
49d.18:38:43.301 [D] P-SpinelDrive-: Sent spinel frame, flg:0x2, iid:0, tid:0, cmd:RESET
49d.18:38:43.301 [D] P-SpinelDrive-: Waiting response: key=0
49d.18:38:43.311 [D] P-SpinelDrive-: Received spinel frame, flg:0x2, iid:0, tid:0, cmd:PROP_VALUE_IS, key:LAST_STATUS, status:RESET_POWER_ON
49d.18:38:43.311 [I] P-SpinelDrive-: co-processor reset: RESET_POWER_ON
49d.18:38:43.311 [C] P-SpinelDrive-: Software reset co-processor successfully
49d.18:38:43.311 [D] P-SpinelDrive-: Sent spinel frame, flg:0x2, iid:0, tid:1, cmd:PROP_VALUE_GET, key:PROTOCOL_VERSION
49d.18:38:43.311 [D] P-SpinelDrive-: Waiting response: key=1
49d.18:38:43.312 [D] P-SpinelDrive-: Received spinel frame, flg:0x2, iid:0, tid:1, cmd:PROP_VALUE_IS, key:PROTOCOL_VERSION, major:4, minor:3
49d.18:38:43.312 [D] P-SpinelDrive-: Sent spinel frame, flg:0x2, iid:0, tid:1, cmd:PROP_VALUE_GET, key:NCP_VERSION
49d.18:38:43.312 [D] P-SpinelDrive-: Waiting response: key=2
49d.18:38:43.313 [D] P-SpinelDrive-: Received spinel frame, flg:0x2, iid:0, tid:1, cmd:PROP_VALUE_IS, key:NCP_VERSION, version:OPENTHREAD/7a25828-dirty; NRF52840; Mar 25 2025 15:51:02
49d.18:38:43.313 [D] P-SpinelDrive-: Sent spinel frame, flg:0x2, iid:0, tid:1, cmd:PROP_VALUE_GET, key:CAPS
49d.18:38:43.313 [D] P-SpinelDrive-: Waiting response: key=5
49d.18:38:43.314 [D] P-SpinelDrive-: Received spinel frame, flg:0x2, iid:0, tid:1, cmd:PROP_VALUE_IS, key:CAPS, caps:COUNTERS UNSOL_UPDATE_FILTER 802_15_4_2450MHZ_OQPSK CONFIG_RADIO MAC_RAW RCP_API_VERSION RCP_MIN_HOST_API_VERSION OPENTHREAD_LOG_METADATA
49d.18:38:43.376 [D] P-SpinelDrive-: Sent spinel frame, flg:0x2, iid:0, tid:1, cmd:PROP_VALUE_GET, key:HWADDR
49d.18:38:43.376 [D] P-RadioSpinel-: Wait response: tid=1 key=8
49d.18:38:43.376 [D] P-SpinelDrive-: Received spinel frame, flg:0x2, iid:0, tid:1, cmd:PROP_VALUE_IS, key:HWADDR, eui64:f4ce3693ab886040
49d.18:38:43.376 [D] P-SpinelDrive-: Sent spinel frame, flg:0x2, iid:0, tid:2, cmd:PROP_VALUE_GET, key:RCP_API_VERSION
49d.18:38:43.376 [D] P-RadioSpinel-: Wait response: tid=2 key=176
49d.18:38:43.377 [D] P-SpinelDrive-: Received spinel frame, flg:0x2, iid:0, tid:2, cmd:PROP_VALUE_IS, key:RCP_API_VERSION, version:11
49d.18:38:43.377 [D] P-SpinelDrive-: Sent spinel frame, flg:0x2, iid:0, tid:3, cmd:PROP_VALUE_GET, key:RCP_MIN_HOST_API_VERSION
49d.18:38:43.377 [D] P-RadioSpinel-: Wait response: tid=3 key=177
49d.18:38:43.378 [D] P-SpinelDrive-: Received spinel frame, flg:0x2, iid:0, tid:3, cmd:PROP_VALUE_IS, key:RCP_MIN_HOST_API_VERSION, min-host-version:4
49d.18:38:43.378 [D] P-SpinelDrive-: Sent spinel frame, flg:0x2, iid:0, tid:4, cmd:PROP_VALUE_GET, key:RADIO_CAPS
49d.18:38:43.378 [D] P-RadioSpinel-: Wait response: tid=4 key=4619
49d.18:38:43.379 [D] P-SpinelDrive-: Received spinel frame, flg:0x2, iid:0, tid:4, cmd:PROP_VALUE_IS, key:RADIO_CAPS, caps:255
49d.18:38:43.410 [D] P-Trel--------: platformTrelInit(aTrelUrl:"trel://wlan0")
49d.18:38:43.410 [D] P-Trel--------: otSysTrelInit(aInterfaceName:"wlan0")
[DEBG]-TrelDns-: Initialized on netif "wlan0"
[DEBG]-TrelDns-: Netif wlan0 is ready: index = 3
49d.18:38:43.411 [I] P-Netif-------: Sent request#1 to set addr_gen_mode to 1
00:00:00.000 [D] P-SpinelDrive-: Sent spinel frame, flg:0x2, iid:0, tid:5, cmd:PROP_VALUE_GET, key:PHY_CHAN_SUPPORTED
00:00:00.000 [D] P-RadioSpinel-: Wait response: tid=5 key=34
00:00:00.001 [D] P-SpinelDrive-: Received spinel frame, flg:0x2, iid:0, tid:5, cmd:PROP_VALUE_IS, key:PHY_CHAN_SUPPORTED, channelMask:0x07fff800
00:00:00.001 [D] P-SpinelDrive-: Sent spinel frame, flg:0x2, iid:0, tid:6, cmd:PROP_VALUE_SET, key:PHY_ENABLED, enabled:1
00:00:00.001 [D] P-RadioSpinel-: Wait response: tid=6 key=32
00:00:00.003 [D] P-SpinelDrive-: Received spinel frame, flg:0x2, iid:0, tid:6, cmd:PROP_VALUE_IS, key:PHY_ENABLED, enabled:1
```

--------------------------------

### Install Python Requirements for Harness Automation

Source: https://openthread.io/certification/automation-setup

Navigate into the `tools/harness-automation` directory and install the necessary Python packages listed in `requirements.txt`. These packages are dependencies for the OpenThread Harness Automation Tool.

```bash
cd tools/harness-automation
pip install -r requirements.txt
```

--------------------------------

### Build and Install OpenThread Border Router (Default Wi-Fi)

Source: https://openthread.io/guides/border-router/build-native

These commands navigate into the cloned "ot-br-posix" directory and execute the bootstrap and setup scripts. The "bootstrap" script prepares the build environment, and the "setup" script configures the Border Router, using "wlan0" as the default infrastructure interface for network connectivity.

```bash
cd ot-br-posix
./script/bootstrap
INFRA_IF_NAME=wlan0 ./script/setup
```

--------------------------------

### Start Docker daemon

Source: https://openthread.io/guides/border-router/build

Starts the Docker daemon if it is not already running. This ensures that the Docker service is active and available for managing containers and images.

```Shell
sudo dockerd
```

--------------------------------

### Start Docker daemon

Source: https://openthread.io/guides/border-router/docker

Starts the Docker daemon if it is not already running. This ensures that Docker services are active and available for use.

```bash
sudo dockerd
```

--------------------------------

### Configure and Start Thread Network in Pyspinel CLI

Source: https://openthread.io/guides/pyspinel/get-started

These commands configure the PAN ID, bring up the network interface, and initiate the Thread protocol on the simulated NCP. The `state` command is then used to verify that the device has successfully become the leader of a Thread network.

```Shell
panid 1234
ifconfig up
thread start
state
```

--------------------------------

### Clone OpenThread nRF528xx Examples Repository

Source: https://openthread.io/codelabs/openthread-apis

This snippet provides the shell commands to clone the OpenThread nRF528xx examples repository, navigate into the directory, and run the bootstrap script. This repository serves as the starting point for the Codelab, containing example application code for OpenThread development on Nordic nRF528xx boards.

```Shell
git clone --recursive https://github.com/openthread/ot-nrf528xx
cd ot-nrf528xx
./script/bootstrap
```

--------------------------------

### Build OpenThread Simulation Example Application

Source: https://openthread.io/codelabs/openthread-simulation-posix/index

Navigates to the OpenThread source directory and compiles the OpenThread simulation example application. This build target is specifically designed for simulating Thread networks.

```bash
$ cd ~/src/openthread
$ ./script/cmake-build simulation
```

--------------------------------

### Start Docker Daemon Manually

Source: https://openthread.io/guides/border-router/build-docker

This command starts the Docker daemon in the foreground. It is typically used to manually ensure the Docker service is running, especially after system reconfigurations or if it didn't start automatically.

```bash
sudo dockerd
```

--------------------------------

### Setup Silk Environment

Source: https://openthread.io/codelabs/openthread-testing-visualization

This snippet provides the commands to clone the Silk repository from GitHub, navigate into its directory, execute the bootstrap script, and install the cluster components, preparing the environment for Silk operations.

```Shell
git clone https://github.com/openthread/silk.git
cd silk
./bootstrap.sh
sudo make install-cluster
```

--------------------------------

### Display Pyspinel CLI Help Menu

Source: https://openthread.io/guides/pyspinel/get-started

This command shows a list of all available commands and their basic usage within the Pyspinel command-line interface. It's useful for discovering functionality and understanding command syntax.

```Shell
help
```

--------------------------------

### Install Docker on Raspberry Pi

Source: https://openthread.io/codelabs/telink-openthread-hardware

This command downloads and executes the official Docker installation script, setting up Docker on the system. It's typically used for initial Docker setup on Linux distributions.

```Shell
curl -sSL https://get.docker.com | sh
```

--------------------------------

### wpantund Configuration Example

Source: https://openthread.io/certification/border-router/test-harness-setup

Example configuration snippet from `/etc/wpantund.conf` showing the default `SocketPath` for the NCP device, used to validate serial port settings.

```config
Config:NCP:SocketPath "/dev/ttyACM0"
```

--------------------------------

### Run Pyspinel CLI with Simulated OpenThread NCP

Source: https://openthread.io/guides/pyspinel/get-started

This command launches the Pyspinel command-line interface, connecting it to the previously built simulated OpenThread NCP. It requires navigating to the Pyspinel directory and providing the full path to the NCP executable.

```Shell
cd path-to-pyspinel
spinel-cli.py -p path-to-openthread/build/simulation/examples/apps/ncp/ot-ncp-ftd -n 1
```

--------------------------------

### Start OpenThread Simulation Docker Container

Source: https://openthread.io/codelabs/openthread-simulation

Starts a Docker container named 'codelab_otsim_ctnr' with necessary network configurations for OpenThread simulation, then connects to its bash shell.

```bash
docker run --name codelab_otsim_ctnr -it --rm \
   --sysctl net.ipv6.conf.all.disable_ipv6=0 \
   --cap-add=net_admin openthread/environment bash
```

--------------------------------

### Compile and Install OTBR and Wpantund for Certification

Source: https://openthread.io/certification/border-router/device-setup

This command compiles and installs both the OpenThread Border Router (OTBR) and `wpantund`. It specifies a particular `wpantund` commit to ensure compatibility and adherence to the certified OTBR version requirements.

```bash
WPANTUND_COMMIT=8c189c6 ./script/setup
```

--------------------------------

### Install Avahi Daemon and Utilities

Source: https://openthread.io/codelabs/openthread-border-router

Installs the Avahi daemon and utility packages on a Linux host, which are required for mDNS/DNS-SD service discovery.

```Shell
sudo apt-get install -y avahi-daemon avahi-utils
```

--------------------------------

### Install XCode Command Line Tools on macOS

Source: https://openthread.io/codelabs/openthread-simulation-posix/index

Installs the necessary command line tools for XCode on macOS, a prerequisite for building OpenThread applications on Apple systems.

```bash
$ xcode-select --install
```

--------------------------------

### Bring Up Interface and Start Joiner on Node 2

Source: https://openthread.io/codelabs/openthread-simulation

Brings up the IPv6 interface on Node 2 and starts its Joiner role using the specified Joiner PSKc ('J01NME'). This initiates the process for Node 2 to join the Thread network.

```OpenThread CLI
> ifconfig up
Done
> joiner start J01NME
Done
```

--------------------------------

### Start Docker daemon

Source: https://openthread.io/guides/border-router/build/index

Starts the Docker daemon process. This command ensures that the Docker service is running and ready to manage containers and images.

```Shell
sudo dockerd
```

--------------------------------

### Install OpenThread Build Dependencies

Source: https://openthread.io/certification/border-router/device-setup

This command executes the bootstrap script within the OpenThread repository. This script is responsible for installing the necessary GNU toolchain and other build dependencies required to compile OpenThread.

```Bash
./script/bootstrap
```

--------------------------------

### Start OpenThread Control Tool (ot-ctl)

Source: https://openthread.io/codelabs/openthread-simulation

Starts the `ot-ctl` utility, which allows controlling `ot-daemon` nodes (like Node 2) using the OpenThread CLI commands.

```bash
root@c0f3912a74ff:/# /openthread/build/posix/src/posix/ot-ctl
>
```

--------------------------------

### Verify OpenThread Version in Pyspinel CLI

Source: https://openthread.io/guides/pyspinel/get-started

Executes the `version` command within the Pyspinel CLI to display the OpenThread version, build information, and compilation date. This helps confirm that the connected NCP is running as expected.

```Shell
version
```

--------------------------------

### Install OpenThread Border Router Build Dependencies

Source: https://openthread.io/certification/border-router/device-setup

This command executes the `bootstrap` script within the OpenThread Border Router repository. It automatically installs all necessary system dependencies required to compile and build the OTBR software components.

```bash
./script/bootstrap
```

--------------------------------

### Example OpenThread Border Router Configuration File

Source: https://openthread.io/guides/border-router/build-docker

This snippet illustrates an example 'otbr-env.list' file, which is used to configure the OpenThread Border Router Docker container. It defines essential parameters such as the Thread Radio Co-Processor (RCP) device, the adjacent infrastructure network interface, the Thread network interface, and the desired log verbosity level.

```text
OT_RCP_DEVICE=spinel+hdlc+uart:///dev/ttyACM0?uart-baudrate=1000000
OT_INFRA_IF=wlan0
OT_THREAD_IF=wpan0
OT_LOG_LEVEL=7
```

--------------------------------

### Enable Thread Network Interface and Start Thread

Source: https://openthread.io/guides/border-router/form-network

Bring up the Thread network interface and start the Thread protocol stack. This allows the device to participate in a Thread network.

```shell
ifconfig up
Done
thread start
```

--------------------------------

### Manage Firewall Rules with ipset Commands

Source: https://openthread.io/guides/border-router/docker

Provides examples of `ipset` commands used to manage firewall rules on the system, specifically flushing existing sets and swapping new configurations for ingress traffic.

```Shell
ipset flush otbr-ingress-allow-dst-swap
```

```Shell
ipset flush otbr-ingress-deny-src-swap
```

```Shell
ipset add otbr-ingress-deny-src-swap fdde:ad00:beef:0::/64 -exist
```

```Shell
ipset swap otbr-ingress-deny-src-swap otbr-ingress-deny-src
```

```Shell
ipset swap otbr-ingress-allow-dst-swap otbr-ingress-allow-dst
```

--------------------------------

### Initialize TREL Interface and DNS Service Discovery

Source: https://openthread.io/guides/border-router/build-docker

Shows the initialization process for the Thread Radio Encapsulation Link (TREL) interface, including socket preparation, local port assignment, and the setup of mDNS-based DNS Service Discovery for TREL services.

```System Log
00:00:00.013 [D] P-Trel--------: PrepareSocket()
[DEBG]-TrelDns-: Start browsing _trel._udp services ...
00:00:00.013 [I] TrelInterface-: Enabled interface, local port:52346
[DEBG]-TrelDns-: mDNS Publisher is Ready
[INFO]-TrelDns-: TREL DNS-SD Is Now Ready: Netif=wlan0(3), SubscriberId=1, Register=!
[INFO]-MDNS----: Subscribe service ._trel._udp (total 1)
[INFO]-MDNS----: DNSServiceBrowse _trel._udp
```

--------------------------------

### Start Commissioner and Add Joiner on Node 1

Source: https://openthread.io/codelabs/openthread-simulation

Starts the Commissioner role on Node 1 and adds Node 2's EUI-64 to the list of allowed joiners, along with a Joiner PSKc ('J01NME'). This prepares Node 1 to accept Node 2 into the network.

```OpenThread CLI
> commissioner start
Done
> commissioner joiner add 18b4300000000001 J01NME
Done
```

--------------------------------

### Start OpenThread Border Agent and Proxy Services

Source: https://openthread.io/guides/border-router/build-docker

Logs the startup of core OpenThread Border Router services, including the Border Agent, Advertisement Proxy, and DHCPv6 Proxy, along with reporting the co-processor version.

```System Log
[INFO]-BA------: Start Thread Border Agent
[INFO]-ADPROXY-: Started
[INFO]-DPROXY--: Started
[INFO]-APP-----: Co-processor version: OPENTHREAD/7a25828-dirty; NRF52840; Mar 25 2025 15:51:02
00:00:00.039 [I] Notifier------: StateChanged (0x40038210) [MLAddr NetData PanId NetName ExtPanId Nat64]
```

--------------------------------

### Example OTBR Docker configuration file

Source: https://openthread.io/guides/border-router/build/index

Provides an example of the 'otbr-env.list' file, which defines environment variables for the OpenThread Border Router Docker container. It specifies the RCP device path, network interfaces for infrastructure and Thread, and the logging verbosity level.

```INI
OT_RCP_DEVICE=spinel+hdlc+uart:///dev/ttyACM0?uart-baudrate=1000000
OT_INFRA_IF=wlan0
OT_THREAD_IF=wpan0
OT_LOG_LEVEL=7
```

--------------------------------

### Initialize and Clone a New Git Repository

Source: https://openthread.io/guides/porting/set-up-the-build-environment

This snippet demonstrates how to create a local directory, navigate into it, clone a new Git repository from GitHub, and then check its status. It shows the output of a successful cloning operation and a clean working tree, preparing the local environment for development.

```bash
mkdir -p ~/repos
cd ~/repos
git clone git@github.com:SiliconLabs/ot-efr32.git
Cloning into 'ot-efr32'...
remote: Enumerating objects: 99, done.
remote: Counting objects: 100% (99/99), done.
remote: Compressing objects: 100% (60/60), done.
remote: Total 333 (delta 65), reused 39 (delta 39), pack-reused 234
Receiving objects: 100% (333/333), 170.78 KiB | 5.69 MiB/s, done.
Resolving deltas: 100% (194/194), done.
git status
On branch main
Your branch is up to date with 'origin/main'.

nothing to commit, working tree clean
```

--------------------------------

### Start ot-ctl Session on Native Host

Source: https://openthread.io/guides/border-router/form-network

Initiate an OpenThread CLI session on a native host where OpenThread Border Router (OTBR) is installed. This command typically requires superuser privileges.

```shell
sudo ot-ctl
```

--------------------------------

### Start OpenThread CLI Process for Node 2

Source: https://openthread.io/codelabs/openthread-simulation-posix/index

Navigates to the OpenThread source directory and starts the CLI process for a simulated Full Thread Device (FTD) as Node 2. This command initiates the device's simulation environment.

```Shell
cd ~/src/openthread
./build/simulation/examples/apps/cli/ot-cli-ftd 2
```

--------------------------------

### Enable Thread Interface and Start Thread on Second Node

Source: https://openthread.io/guides/border-router/form-network

Bring up the Thread network interface and start the Thread protocol on a second node. This prepares the node to join the existing Thread network.

```shell
ifconfig up
Done
thread start
```

--------------------------------

### Manually Start Docker Daemon

Source: https://openthread.io/codelabs/telink-openthread-hardware

Starts the Docker daemon process. This command is used if Docker has not automatically started after installation or a system reboot.

```Shell
sudo dockerd
```

--------------------------------

### OpenThread Development Guides

Source: https://openthread.io/reference/config/group/config-dns-client

Essential guides for building, porting, and interacting with OpenThread, including specific components like the Border Router and Pyspinel.

```APIDOC
Get Started: /guides
Build OpenThread: /guides/build
Port OpenThread: /guides/porting
OpenThread Border Router: /guides/border-router
OpenThread Commissioner: /guides/commissioner
Pyspinel: /guides/pyspinel
```

--------------------------------

### Get SRP Server Service Sub-Type Label

Source: https://openthread.io/releases/thread-reference-20230706/group/api-srp

Gets the sub-type label from service name.

```APIDOC
otSrpServerServiceGetServiceSubTypeLabel(const otSrpServerService *aService, char *aLabel, uint8_t aMaxSize) -> otError
```

--------------------------------

### Create Configuration File for Automation Tool

Source: https://openthread.io/certification/automation-setup

This command copies the sample settings file to create a new configuration file for the automation tool. The new `settings.py` file should then be updated according to specific instructions.

```bash
cp autothreadharness/settings_sample.py autothreadharness/settings.py
```

--------------------------------

### Get Service Entry TXT Buffer

Source: https://openthread.io/releases/thread-reference-20230706/group/api-srp

Gets the buffer for TXT record from a service entry.

```C
uint8_t * otSrpClientBuffersGetServiceEntryTxtBuffer(otSrpClientBuffersServiceEntry *aEntry, uint16_t *aSize)
```

--------------------------------

### Display Repository Directory Structure

Source: https://openthread.io/guides/porting/set-up-the-build-environment

This snippet shows the recommended top-level directory structure for an OpenThread hardware platform repository using the 'tree' command. It illustrates a consistent organization for examples, the OpenThread submodule, scripts, source code, and third-party dependencies, aiding in project maintainability.

```bash
tree -F -L 1 --dirsfirst
.
├── examples/
├── openthread/
├── script/
├── src/
├── third_party/
├── CMakeLists.txt
├── LICENSE
└── README.md
```

--------------------------------

### Install Essential Utilities on Raspberry Pi

Source: https://openthread.io/certification/border-router/device-setup

This command installs `git`, `screen`, and `tcpdump` on the Raspberry Pi. These utilities are crucial for managing the OpenThread Border Router setup, including repository cloning, terminal session management, and network debugging.

```bash
sudo apt-get install git screen tcpdump
```

--------------------------------

### Install Paramiko for GRL Python Environment

Source: https://openthread.io/certification/border-router/test-harness-setup

Commands to navigate to the GRL Python directory and install/upgrade pip and the Paramiko library, required for SSH communication with the Test Harness.

```bash
cd C:\GRL\Python2.7
```

```bash
python -m pip install --upgrade pip
```

```bash
python -m pip install paramiko
```

--------------------------------

### CMake: Adding Startup Code to OpenThread Library

Source: https://openthread.io/guides/porting/set-up-the-build-environment

This CMake snippet demonstrates how to include the `startup-gcc.c` file, which contains the toolchain startup code, into the `openthread-cc2538` library. This inclusion is crucial for ensuring that key variables used in the linker script are correctly referenced and the application can initialize properly.

```CMake
add_library(openthread-cc2538
    alarm.c
...
    startup-gcc.c
...
    system.c
    logging.c
    uart.c
    $
)
```

--------------------------------

### Get Service Subtype Labels Array

Source: https://openthread.io/releases/thread-reference-20230706/group/api-srp

Gets the array for service subtype labels from the service entry.

```C
const char ** otSrpClientBuffersGetSubTypeLabelsArray(otSrpClientBuffersServiceEntry *aEntry, uint16_t *aArrayLength)
```

--------------------------------

### Start OpenThread CLI Process for Node 1

Source: https://openthread.io/codelabs/openthread-simulation-posix/index

Navigates to the OpenThread source directory and starts the CLI process for a simulated Full Thread Device (FTD) as Node 1. This command initializes the primary Thread device.

```Shell
cd ~/src/openthread
./build/simulation/examples/apps/cli/ot-cli-ftd 1
```

--------------------------------

### Build Zephyr Hello World Example

Source: https://openthread.io/codelabs/telink-openthread-hardware

Navigates to the Zephyr source directory and uses West to build the `hello_world` sample application for the `tlsr9518adk80d` board. This verifies the Zephyr environment is correctly set up for compilation.

```Shell
$ cd ~/zephyrproject/zephyr
$ west build -p auto -b tlsr9518adk80d samples/hello_world
```

--------------------------------

### Get BLE Secure Install Code Verification Status

Source: https://openthread.io/reference/group/api-ble-secure

Retrieves the Install Code Verify Status for the current session. This function indicates whether the install code was successfully verified.

```APIDOC
Function: otBleSecureGetInstallCodeVerifyStatus
Signature: bool otBleSecureGetInstallCodeVerifyStatus(
  otInstance *aInstance
)

Parameters:
  aInstance: [in] otInstance * - A pointer to an OpenThread instance.

Return Values:
  TRUE: The install code was correctly verified.
  FALSE: The install code was not verified.
```

--------------------------------

### Start Avahi Daemon and Discover Service

Source: https://openthread.io/codelabs/openthread-border-router

Ensures the Avahi daemon is running and then uses `avahi-browse` to discover services of a specific type (`_ipps._tcp`) on the local network, displaying their details.

```Shell
sudo service avahi-daemon start # Ensure the avahi daemon is started.
avahi-browse -r _ipps._tcp
```

--------------------------------

### Clone and Initialize OpenThread Repository

Source: https://openthread.io/certification/border-router/test-harness-setup

These commands guide users through cloning the OpenThread repository from GitHub, navigating into the project directory, and switching to the 'main' branch. This ensures the correct version of the OpenThread source code is available for THCI support files.

```Git
git clone https://github.com/openthread/openthread
cd openthread
git checkout main
```

--------------------------------

### Add Third-Party SDK as Git Submodule

Source: https://openthread.io/guides/porting/set-up-the-build-environment

This snippet shows how to navigate into the 'third_party' directory and add a specific third-party SDK (Silicon Labs Gecko SDK lite version) as a Git submodule. It includes the commands and the output confirming the successful cloning of the SDK, ensuring all external dependencies are managed.

```bash
cd third_party
git submodule add git@github.com:SiliconLabs/sdk_support.git
Cloning into '/home/user/repos/ot-efr32/third_party/sdk_support'...
remote: Enumerating objects: 32867, done.
remote: Counting objects: 100% (8181/8181), done.
remote: Compressing objects: 100% (3098/3098), done.
remote: Total 32867 (delta 4945), reused 7469 (delta 4732), pack-reused 24686
Receiving objects: 100% (32867/32867), 128.83 MiB | 30.91 MiB/s, done.
Resolving deltas: 100% (19797/19797), done.
```

--------------------------------

### Get Service Entry Service Name String Buffer

Source: https://openthread.io/releases/thread-reference-20230706/group/api-srp

Gets the string buffer for service name from a service entry.

```C
char * otSrpClientBuffersGetServiceEntryServiceNameString(otSrpClientBuffersServiceEntry *aEntry, uint16_t *aSize)
```

--------------------------------

### Start OpenThread Protocol Operation

Source: https://openthread.io/codelabs/openthread-simulation

This command initiates the Thread protocol operation on the device, allowing it to join or form a Thread network and begin its role within the mesh.

```OpenThread CLI
> thread start
Done
```

--------------------------------

### Get Next Registered Host on OpenThread SRP Server

Source: https://openthread.io/releases/thread-reference-20230706/group/api-srp

Iterates through registered hosts on the SRP server. Pass NULL to get the first host, then the previously returned host to get the next.

```C
const otSrpServerHost * otSrpServerGetNextHost(
  otInstance *aInstance,
  const otSrpServerHost *aHost
)
```

```APIDOC
otSrpServerGetNextHost(
  aInstance: otInstance* - A pointer to an OpenThread instance.
  aHost: const otSrpServerHost* - A pointer to current host; use NULL to get the first host.
)
Returns:
  A pointer to the registered host. NULL, if no more hosts can be found.
```

--------------------------------

### Get Service Entry Instance Name String Buffer

Source: https://openthread.io/releases/thread-reference-20230706/group/api-srp

Gets the string buffer for service instance name from a service entry.

```C
char * otSrpClientBuffersGetServiceEntryInstanceNameString(otSrpClientBuffersServiceEntry *aEntry, uint16_t *aSize)
```

--------------------------------

### Thread Test Harness Topology Configuration File Format Example

Source: https://openthread.io/certification/automation-setup

This snippet illustrates the required format for entries in the `TopologyConfig.txt` file, which defines device roles for each test case in a mixed testbed. Each line specifies `role:device` pairs, separated by commas, for a specific test case. Valid device values include `ARM`, `NXP`, `OpenThread`, and `SiLabs`.

```APIDOC
5.3.10-Leader:NXP,Router_1:OpenThread,BorderRouter:OpenThread,MED_1:ARM
```

--------------------------------

### Get SRP Client Host Name String Buffer

Source: https://openthread.io/releases/thread-reference-20230706/group/api-srp

Gets the string buffer to use for SRP client host name.

```C
char * otSrpClientBuffersGetHostNameString(otInstance *aInstance, uint16_t *aSize)
```

--------------------------------

### Pyspinel Command-Line Arguments for Sniffing

Source: https://openthread.io/guides/pyspinel/install-pyspinel

Example command-line flags used to configure Pyspinel for Thread packet sniffing, specifying the channel and the UART device path. This method provides more control than using the Extcap plugin.

```bash
--channel 15 --uart /dev/ttyACM0
```

--------------------------------

### Install OpenThread Build Toolchain

Source: https://openthread.io/guides/build/index

Executes the bootstrap script to install necessary toolchains and dependencies required for building OpenThread from the cloned repository. This prepares the environment for compilation.

```bash
./script/bootstrap
```

--------------------------------

### Get SRP Client Host Addresses Array

Source: https://openthread.io/releases/thread-reference-20230706/group/api-srp

Gets the array of IPv6 address entries to use as SRP client host address list.

```C
otIp6Address * otSrpClientBuffersGetHostAddressesArray(otInstance *aInstance, uint8_t *aArrayLength)
```

--------------------------------

### Enable SRP Client Autostart

Source: https://openthread.io/codelabs/openthread-border-router

Configures the SRP (Service Registration Protocol) client to automatically start, ensuring that services are registered with the Border Router upon device boot.

```Shell
srp client autostart enable
```

--------------------------------

### Get OMR Prefix in OpenThread Border Routing API

Source: https://openthread.io/releases/thread-reference-20230119/group/api-border-routing

Gets the local Off-Mesh-Routable (OMR) Prefix, for example `fdfc:1ff5:1512:5622::/64`.

```APIDOC
otError otBorderRoutingGetOmrPrefix(otInstance *aInstance, otIp6Prefix *aPrefix)
```

--------------------------------

### Simulate Thread Network with Build Toolchain

Source: https://openthread.io/guides

An alternative to the Docker simulation, this codelab guides users through setting up the OpenThread build toolchain and building OpenThread directly on a Mac or Linux machine for network simulation.

```Shell
- Set up the OpenThread build toolchain
- Build OpenThread directly on Mac or Linux
- Simulate a Thread network
```

--------------------------------

### Start OpenThread Node 2 Protocol Operation

Source: https://openthread.io/codelabs/openthread-simulation

Initiates the Thread protocol stack on Node 2, allowing it to discover and join the existing Thread network.

```OpenThread CLI
> thread start
Done
```

--------------------------------

### Set up OpenThread build environment using Docker

Source: https://openthread.io/guides/build

Pull the latest OpenThread environment Docker image and run it in an interactive, ephemeral container to get a pre-configured build environment.

```bash
docker pull openthread/environment:latest
docker run -it --rm openthread/environment bash
```

--------------------------------

### Enable SSH Service on Raspberry Pi

Source: https://openthread.io/certification/border-router/test-harness-setup

Commands to enable and start the SSH service on a Raspberry Pi 3B, ensuring it starts automatically on boot.

```bash
sudo systemctl enable ssh
```

```bash
sudo systemctl start ssh
```

--------------------------------

### Install Docker using curl

Source: https://openthread.io/guides/border-router/docker

Installs Docker on a Raspberry Pi by executing a script from get.docker.com. This is the initial step in setting up the Docker environment.

```bash
curl -sSL https://get.docker.com | sh
```

--------------------------------

### C: otInstanceInit Function

Source: https://openthread.io/releases/thread-reference-20230119/group/api-instance

This function initializes the OpenThread library for a new instance, preparing it for subsequent API calls. It must be invoked before any other OpenThread functions. This specific initialization method is available only when support for multiple OpenThread instances is enabled.

```C
otInstance * otInstanceInit(
  void *aInstanceBuffer,
  size_t *aInstanceBufferSize
)
```

```APIDOC
otInstanceInit:
  aInstanceBuffer:
    type: void *
    description: The buffer for OpenThread to use for allocating the otInstance structure.
    direction: in
  aInstanceBufferSize:
    type: size_t *
    description: On input, the size of aInstanceBuffer. On output, if not enough space for otInstance, the number of bytes required for otInstance.
    direction: in,out
  returns:
    type: otInstance *
    description: A pointer to the new OpenThread instance.
```
Tokens:
Raw