An open source border router, designed to work with OpenThread
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github [github] add issue templates (#194) Sep 18, 2018
.script Switch to clang-format-5.0 (#152) Jun 21, 2018
.travis [travis] fix android check (#200) Sep 19, 2018
doc Improve documentation and logging messages. (#68) Jun 23, 2017
etc [docker] add docker support (#183) Sep 6, 2018
examples/platforms Add NetworkManager to make WiFi configuration easier. (#120) Dec 4, 2017
include Initial commit May 30, 2017
script [nat64] fix tayga start (#177) Sep 7, 2018
src [dtls] attach port in mbedtls debug message (#197) Sep 19, 2018
tests [commissioner] move commissioner to src (#195) Sep 18, 2018
third_party [agent] fix failing to find d-bus connection (#178) Aug 23, 2018
tools [tools] add tool to compute steering data (#184) Sep 8, 2018
.clang-format Switch to clang-format-5.0 (#152) Jun 21, 2018
.codecov.yml [code] clean up code (#182) Aug 31, 2018
.default-version Initial commit May 30, 2017
.gitignore add .gitignore file to border router (#82) Aug 2, 2017
.travis.yml [travis] fix android check (#200) Sep 19, 2018
AUTHORS Initial commit May 30, 2017
Android.mk [agent] fix failing to find d-bus connection (#178) Aug 23, 2018
CODE_OF_CONDUCT.md Initial commit May 30, 2017
CONTRIBUTING.md Initial commit May 30, 2017
LICENSE Initial commit May 30, 2017
Makefile.am Initial commit May 30, 2017
NOTICE Initial commit May 30, 2017
README.md [codecov] enable code coverage (#173) Aug 22, 2018
STYLE_GUIDE.md Initial commit May 30, 2017
bootstrap [build] patch libcoap and add missing automake files (#171) Aug 19, 2018
configure.ac [commissioner] move commissioner to src (#195) Sep 18, 2018

README.md

Build Status Coverage Status


OpenThread Border Router

Per the Thread 1.1.1 Specification, a Thread Border Router connects a Thread network to other IP-based networks, such as Wi-Fi or Ethernet. A Thread network requires a Border Router to connect to other networks.

A Thread Border Router minimally supports the following functions:

  • End-to-end IP connectivity via routing between Thread devices and other external IP networks
  • External Thread Commissioning (for example, a mobile phone) to authenticate and join a Thread device to a Thread network

OpenThread's implementation of a Border Router is called OpenThread Border Router (OTBR). OTBR includes a number of features, including:

  • Web UI for configuration and management
  • Thread Border Agent to support an External Commissioner
  • DHCPv6 Prefix Delegation to obtain IPv6 prefixes for a Thread network
  • NAT64 for connecting to IPv4 networks
  • DNS64 to allow Thread devices to initiate communications by name to an IPv4-only server
  • Thread interface driver using wpantund

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

Getting started

All end-user documentation and guides are located at openthread.io. If you're looking to do things like...

  • Learn about the OTBR architecture
  • See what platforms support OTBR
  • Build and configure OTBR

...then openthread.io is the place for you.

If you're interested in contributing to OpenThread Border Router, read on.

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.

We follow the philosophy of Scripts to Rule Them All.

Versioning

OpenThread Border Router follows the Semantic Versioning guidelines for release cycle transparency and to maintain backwards compatibility. OpenThread Border Router's versioning is independent of the Thread protocol specification version but will clearly indicate which version of the specification it currently supports.

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?

There are numerous avenues for OpenThread support:

The openthread-users Google Group is the recommended place for users to discuss OpenThread and interact directly with the OpenThread team.

OpenThread

To learn more about OpenThread, see the OpenThread repository.