Tools and Scripts

Stay organized with collections Save and categorize content based on your preferences.

View source on GitHub

OpenThread Border Router (OTBR) includes a variety of tools and scripts that can be used for testing purposes.

PSKc generator

pskc, available in ot-br-posix/tools, generates a Pre-Shared Key for the Commissioner (PSKc). The PSKc is used to authenticate an external Thread Commissioner to a Thread network. Build and install OTBR to use this tool.

After building, pskc is located at ot-br-posix/build/otbr/tools.

Parameters

The PSKc is generated from the following parameters:

  • Commissioner Credential
  • Thread Network Extended PAN ID
  • Thread Network Name

Usage

Syntax:

pskc commissioner-credential extpanid network-name

Example:

cd ~/ot-br-posix/build/otbr/tools
./pskc J01NME 1234AAAA1234BBBB MyOTBRNetwork
ee4fb64e9341e13846bbe7e1c52b6785

To use this tool with ot-ctl, refer to External Commissioning.

Steering data generator

steering-data, available in ot-br-posix/tools, uses a Bloom filter to generate a hash of the set of Joiners intended for commissioning. During commissioning, the Joiner only looks for networks advertising steering data that includes the Joiner itself. Build and install OTBR to use this tool.

After building, steering-data is located at ot-br-posix/build/otbr/tools.

Parameters

The steering data is generated from the following parameters:

  • Byte length of steering data (optional, default is 16)
  • Joiner ID (EUI-64)

Usage

Syntax:

steering-data [length] joiner-id

Example:

cd ~/ot-br-posix/build/otbr/tools
./steering-data 0000b57fffe15d68
00000000000000000020000000000100

Use multiple Joiner IDs to include them all in the steering data:

./steering-data 0000b57fffe15d68 0000c57fffe15d68
00000000000080000020000000000500

Use the length parameter to change the byte length of the resulting steering data:

./steering-data 8 0000b57fffe15d68
0020000000000100

OTBR Commissioner

By default, the Commissioner role is enabled on OTBR, similar to enabling the Commissioner role on a device with the -DOT_COMMISSIONER=ON flag. On the platform running OTBR, use ot-ctl commissioner to commission Joiners from the command line.

Parameters

Type help for a list of commands.

sudo ot-ctl commissioner help

Usage

Syntax:

sudo ot-ctl commissioner parameters

Example:

sudo ot-ctl commissioner start
Done
sudo ot-ctl commissioner joiner add 2f57d222545271f1 J01NME
Done

MeshCoP Script

OTBR provides a MeshCoP (Mesh Commissioning Protocol) test script that uses OT Commissioner to test External Commissioning. For usage information, refer to the meshcop test script on GitHub.

standalone_ipv6 script

Use the standalone_ipv6 script to test IPv6 functionality if your test or development environment does not have a full IPv6 infrastructure available (for example, if your network is not connected to an upstream IPv6 provider).

This script installs extra features on the platform running OTBR to enable the device to serve IPv6 addresses.

This script is located at /ot-br-posix/script/standalone_ipv6.