Ask DeepWiki

OpenThread Border Router

A Thread Border Router connects a Thread network to other IP-based networks, such as Wi-Fi or Ethernet.

A Thread Border Router supports the following functions:

OpenThread's implementation of a Border Router is called OpenThread Border Router (OTBR).

More information about Thread can be found at threadgroup.org. Thread is a registered trademark of the Thread Group, Inc.

Getting started

The quickest way to set up a Thread-compliant Border Router is to follow the Raspberry Pi Setup guide.

Note: For users in China, end-user documentation is available at openthread.google.cn.

On macOS, ./script/bootstrap installs the build dependencies with Homebrew and

INFRA_IF_NAME=en0 RADIO_URL='spinel+hdlc+uart:///dev/cu.usbserial-XXXX?uart-baudrate=460800' ./script/setup

builds the border router, installs it under /usr/local, adds its pf anchors and IP forwarding, and loads it as the launchd job io.openthread.otbr-agent, which starts at boot. The agent's options live in /usr/local/etc/default/otbr-agent. Its log is in the unified log (log show --predicate 'process == "otbr-agent"' --last 10m); /var/log/otbr-agent.log receives what it writes to stderr. The Thread interface is a utun, named by the agent's socket (ls /var/run/openthread-utun*.sock; under /tmp with an OpenThread from before openthread#13746), and sudo /usr/local/sbin/ot-ctl -I utunN state talks to it. The web GUI (WEB_GUI=1, the default here as on Raspbian) is the launchd job io.openthread.otbr-web at http://127.0.0.1/; its options live in /usr/local/etc/default/otbr-web, and /var/log/otbr-web.log receives its output. Until the agent takes the utun the service asks for (openthread#13742), put the utun it got in that file's -I and sudo launchctl kickstart -k system/io.openthread.otbr-web.

Contributing

We would love for you to contribute to OpenThread Border Router 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.

License

OpenThread Border Router 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.

Need help?

OpenThread support is available on GitHub:

OpenThread

To learn more about OpenThread, see the OpenThread repository.