Contents

Configuring a Border Router

Set up or add a Border Router on a Thread network.

Overview

The Border Router acts as a bridge between the Thread and Wi-Fi or Ethernet networks in a home. Multiple Border Routers on the preferred network strengthen communication between devices and improve the network’s resiliency.

Set up a new Border Router on the preferred network

To begin setup, first check for a configured preferred network using isPreferredNetworkAvailable(completion:). If one is already configured, use retrievePreferredCredentials(_:) to read the credentials.

If a preferred network isn’t available, you must create a new Thread network and configure the Thread Border Router with this information.

After you configure the Border Router, store the credentials to iCloud Keychain using storeCredentials(forBorderAgent:activeOperationalDataSet:completion:).

Storing credentials marks the newly created Thread network as the preferred network in iCloud Keychain. This process makes the Thread network immediately available for devices to join.

Add a Border Router to the preferred network

If you’re setting up another Thread Border Router on the preferred network, ensure that the previously cached preferred network credentials match using checkPreferredNetwork(forActiveOperationalDataset:completion:). If they don’t match, re-read the preferred network credentials from iCloud Keychain using retrievePreferredCredentials(_:) and configure the Border Router with those credentials.

After you’ve configured the Border Router, use storeCredentials(forBorderAgent:activeOperationalDataSet:completion:) to store the Border Router’s Thread network credentials to iCloud Keychain. You can set up any number of Border Routers this way.

See Also

Setting up Thread Border Routers