Router/Leader

This module includes functions for Thread Routers and Leaders.

Summary

Enumerations
otThreadChildTableEvent{   OT_THREAD_CHILD_TABLE_EVENT_CHILD_ADDED,   OT_THREAD_CHILD_TABLE_EVENT_CHILD_REMOVED }	enum This enumeration defines the constants used in otThreadChildTableCallback to indicate whether a child is added or removed.

Typedefs
otChildIp6AddressIterator	typedef uint16_t Used to iterate through IPv6 addresses of a Thread Child entry.
otEidCacheEntry	typedef struct otEidCacheEntry This structure represents an EID cache entry.
otThreadChildTableCallback)(otThreadChildTableEvent aEvent, const otChildInfo *aChildInfo)	typedef void(* This function pointer is called to notify that a child is being added to or removed from child table.
otThreadChildTableEvent	typedef enum otThreadChildTableEvent This enumeration defines the constants used in otThreadChildTableCallback to indicate whether a child is added or removed.

Functions
otThreadBecomeLeader(otInstance *aInstance)	OTAPI otError OTCALL Become a leader and start a new partition.
otThreadBecomeRouter(otInstance *aInstance)	OTAPI otError OTCALL Attempt to become a router.
otThreadGetChildInfoById(otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)	OTAPI otError OTCALL The function retains diagnostic information for an attached Child by its Child ID or RLOC16.
otThreadGetChildInfoByIndex(otInstance *aInstance, uint8_t aChildIndex, otChildInfo *aChildInfo)	OTAPI otError OTCALL The function retains diagnostic information for an attached Child by the internal table index.
otThreadGetChildNextIp6Address(otInstance *aInstance, uint8_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)	otError This function gets the next IPv6 address (using an iterator) for a given child.
otThreadGetChildTableCallback(otInstance *aInstance)	otThreadChildTableCallback This function gets the child table callback function.
otThreadGetContextIdReuseDelay(otInstance *aInstance)	OTAPI uint32_t OTCALL Get the CONTEXT_ID_REUSE_DELAY parameter used in the Leader role.
otThreadGetEidCacheEntry(otInstance *aInstance, uint8_t aIndex, otEidCacheEntry *aEntry)	OTAPI otError OTCALL This function gets an EID cache entry.
otThreadGetJoinerUdpPort(otInstance *aInstance)	OTAPI uint16_t OTCALL Get the Joiner UDP Port.
otThreadGetLocalLeaderPartitionId(otInstance *aInstance)	OTAPI uint32_t OTCALL Get the Thread Leader Partition Id used when operating in the Leader role.
otThreadGetLocalLeaderWeight(otInstance *aInstance)	OTAPI uint8_t OTCALL Get the Thread Leader Weight used when operating in the Leader role.
otThreadGetMaxAllowedChildren(otInstance *aInstance)	OTAPI uint8_t OTCALL Get the maximum number of children currently allowed.
otThreadGetMaxRouterId(otInstance *aInstance)	OTAPI uint8_t OTCALL The function returns the maximum allowed router ID.
otThreadGetNetworkIdTimeout(otInstance *aInstance)	OTAPI uint8_t OTCALL Get the NETWORK_ID_TIMEOUT parameter used in the Router role.
otThreadGetPSKc(otInstance *aInstance)	OTAPI const uint8_t *OTCALL Get the thrPSKc.
otThreadGetParentPriority(otInstance *aInstance)	OTAPI int8_t OTCALL Get the assigned parent priority.
otThreadGetRouterDowngradeThreshold(otInstance *aInstance)	OTAPI uint8_t OTCALL Get the ROUTER_DOWNGRADE_THRESHOLD parameter used in the Router role.
otThreadGetRouterIdSequence(otInstance *aInstance)	OTAPI uint8_t OTCALL Get the current Router ID Sequence.
otThreadGetRouterInfo(otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)	OTAPI otError OTCALL The function retains diagnostic information for a given Thread Router.
otThreadGetRouterSelectionJitter(otInstance *aInstance)	OTAPI uint8_t OTCALL Get the ROUTER_SELECTION_JITTER parameter used in the REED/Router role.
otThreadGetRouterUpgradeThreshold(otInstance *aInstance)	OTAPI uint8_t OTCALL Get the ROUTER_UPGRADE_THRESHOLD parameter used in the REED role.
otThreadIsRouterRoleEnabled(otInstance *aInstance)	OTAPI bool OTCALL This function indicates whether or not the Router Role is enabled.
otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)	OTAPI otError OTCALL Release a Router ID that has been allocated by the device in the Leader role.
otThreadSetChildTableCallback(otInstance *aInstance, otThreadChildTableCallback aCallback)	void This function sets the child table callback function.
otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t aDelay)	OTAPI void OTCALL Set the CONTEXT_ID_REUSE_DELAY parameter used in the Leader role.
otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)	OTAPI otError OTCALL Set the Joiner UDP Port.
otThreadSetLocalLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)	OTAPI void OTCALL Set the Thread Leader Partition Id used when operating in the Leader role.
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)	OTAPI void OTCALL Set the Thread Leader Weight used when operating in the Leader role.
otThreadSetMaxAllowedChildren(otInstance *aInstance, uint8_t aMaxChildren)	OTAPI otError OTCALL Set the maximum number of children currently allowed.
otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)	OTAPI void OTCALL Set the NETWORK_ID_TIMEOUT parameter used in the Leader role.
otThreadSetPSKc(otInstance *aInstance, const uint8_t *aPSKc)	OTAPI otError OTCALL Set the thrPSKc.
otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)	OTAPI otError OTCALL Set the parent priority.
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)	OTAPI otError OTCALL Set the preferred Router Id.
otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)	OTAPI void OTCALL Set the ROUTER_DOWNGRADE_THRESHOLD parameter used in the Leader role.
otThreadSetRouterRoleEnabled(otInstance *aInstance, bool aEnabled)	OTAPI void OTCALL This function sets whether or not the Router Role is enabled.
otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)	OTAPI void OTCALL Set the ROUTER_SELECTION_JITTER parameter used in the REED/Router role.
otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8_t aThreshold)	OTAPI void OTCALL Set the ROUTER_UPGRADE_THRESHOLD parameter used in the Leader role.
otThreadSetSteeringData(otInstance *aInstance, const otExtAddress *aExtAddress)	otError Set Steering data out of band.

Structs
otChildInfo	This structure holds diagnostic information for a Thread Child.
otEidCacheEntry	This structure represents an EID cache entry.

Enumerations

otThreadChildTableEvent

 otThreadChildTableEvent

This enumeration defines the constants used in otThreadChildTableCallback to indicate whether a child is added or removed.

Properties
OT_THREAD_CHILD_TABLE_EVENT_CHILD_ADDED	A child is being added.
OT_THREAD_CHILD_TABLE_EVENT_CHILD_REMOVED	A child is being removed.

Typedefs

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

Used to iterate through IPv6 addresses of a Thread Child entry.

otEidCacheEntry

struct otEidCacheEntry otEidCacheEntry

This structure represents an EID cache entry.

otThreadChildTableCallback

void(* otThreadChildTableCallback)(otThreadChildTableEvent aEvent, const otChildInfo *aChildInfo)

This function pointer is called to notify that a child is being added to or removed from child table.

Details
Parameters	[in] aEvent A event flag indicating whether a child is being added or removed. [in] aChildInfo A pointer to child information structure.

otThreadChildTableEvent

enum otThreadChildTableEvent otThreadChildTableEvent

This enumeration defines the constants used in otThreadChildTableCallback to indicate whether a child is added or removed.

Functions

otThreadBecomeLeader

OTAPI otError OTCALL otThreadBecomeLeader(
  otInstance *aInstance
)

Become a leader and start a new partition.

Note: This API is reserved for testing and demo purposes only. Changing settings with this API will render a production application non-compliant with the Thread Specification.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Return Values	OT_ERROR_NONE Successfully became a leader and started a new partition. OT_ERROR_INVALID_STATE Thread is disabled.

otThreadBecomeRouter

OTAPI otError OTCALL otThreadBecomeRouter(
  otInstance *aInstance
)

Attempt to become a router.

Note: This API is reserved for testing and demo purposes only. Changing settings with this API will render a production application non-compliant with the Thread Specification.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Return Values	OT_ERROR_NONE Successfully begin attempt to become a router. OT_ERROR_INVALID_STATE Thread is disabled.

otThreadGetChildInfoById

OTAPI otError OTCALL otThreadGetChildInfoById(
  otInstance *aInstance,
  uint16_t aChildId,
  otChildInfo *aChildInfo
)

The function retains diagnostic information for an attached Child by its Child ID or RLOC16.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aChildId The Child ID or RLOC16 for the attached child. [out] aChildInfo A pointer to where the child information is placed.
Return Values	OT_ERROR_NONE aChildInfo was successfully updated with the info for the given ID. OT_ERROR_NOT_FOUND No valid child with this Child ID. OT_ERROR_INVALID_ARGS If aChildInfo is NULL.

otThreadGetChildInfoByIndex

OTAPI otError OTCALL otThreadGetChildInfoByIndex(
  otInstance *aInstance,
  uint8_t aChildIndex,
  otChildInfo *aChildInfo
)

The function retains diagnostic information for an attached Child by the internal table index.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aChildIndex The table index. [out] aChildInfo A pointer to where the child information is placed.
Return Values	OT_ERROR_NONE aChildInfo was successfully updated with the info for the given index. OT_ERROR_NOT_FOUND No valid child at this index. OT_ERROR_INVALID_ARGS Either aChildInfo is NULL, or aChildIndex is out of range (higher than max table index).

See also:
otGetMaxAllowedChildren

otThreadGetChildNextIp6Address

otError otThreadGetChildNextIp6Address(
  otInstance *aInstance,
  uint8_t aChildIndex,
  otChildIp6AddressIterator *aIterator,
  otIp6Address *aAddress
)

This function gets the next IPv6 address (using an iterator) for a given child.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aChildIndex The child index. [in,out] aIterator A pointer to the iterator. On success the iterator will be updated to point to next entry in the list. To get the first IPv6 address the iterator should be set to OT_CHILD_IP6_ADDRESS_ITERATOR_INIT. [out] aAddress A pointer to an IPv6 address where the child's next address is placed (on success).
Return Values	OT_ERROR_NONE Successfully found the next IPv6 address (aAddress was successfully updated). OT_ERROR_NOT_FOUND The child has no subsequent IPv6 address entry. OT_ERROR_INVALID_ARGS aIterator or aAddress are NULL, or child at aChildIndex is not valid.

See also:
otThreadGetChildInfoByIndex

otThreadGetChildTableCallback

otThreadChildTableCallback otThreadGetChildTableCallback(
  otInstance *aInstance
)

This function gets the child table callback function.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The callback function pointer.

otThreadGetContextIdReuseDelay

OTAPI uint32_t OTCALL otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

Get the CONTEXT_ID_REUSE_DELAY parameter used in the Leader role.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The CONTEXT_ID_REUSE_DELAY value.

See also:
otThreadSetContextIdReuseDelay

otThreadGetEidCacheEntry

OTAPI otError OTCALL otThreadGetEidCacheEntry(
  otInstance *aInstance,
  uint8_t aIndex,
  otEidCacheEntry *aEntry
)

This function gets an EID cache entry.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aIndex An index into the EID cache table. [out] aEntry A pointer to where the EID information is placed.
Return Values	OT_ERROR_NONE Successfully retrieved the EID cache entry. OT_ERROR_INVALID_ARGS aIndex was out of bounds or aEntry was NULL.

otThreadGetJoinerUdpPort

OTAPI uint16_t OTCALL otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Get the Joiner UDP Port.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The Joiner UDP Port number.

See also:
otThreadSetJoinerUdpPort

otThreadGetLocalLeaderPartitionId

OTAPI uint32_t OTCALL otThreadGetLocalLeaderPartitionId(
  otInstance *aInstance
)

Get the Thread Leader Partition Id used when operating in the Leader role.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The Thread Leader Partition Id value.

otThreadGetLocalLeaderWeight

OTAPI uint8_t OTCALL otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

Get the Thread Leader Weight used when operating in the Leader role.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The Thread Leader Weight value.

See also:
otThreadSetLeaderWeight

otThreadGetMaxAllowedChildren

OTAPI uint8_t OTCALL otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

Get the maximum number of children currently allowed.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The maximum number of children currently allowed.

See also:
otThreadSetMaxAllowedChildren

otThreadGetMaxRouterId

OTAPI uint8_t OTCALL otThreadGetMaxRouterId(
  otInstance *aInstance
)

The function returns the maximum allowed router ID.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The maximum allowed router ID.

otThreadGetNetworkIdTimeout

OTAPI uint8_t OTCALL otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

Get the NETWORK_ID_TIMEOUT parameter used in the Router role.

Note: This API is reserved for testing and demo purposes only. Changing settings with this API will render a production application non-compliant with the Thread Specification.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The NETWORK_ID_TIMEOUT value.

See also:
otThreadSetNetworkIdTimeout

otThreadGetPSKc

OTAPI const uint8_t *OTCALL otThreadGetPSKc(
  otInstance *aInstance
)

Get the thrPSKc.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	A pointer to a buffer containing the thrPSKc.

See also:
otThreadSetPSKc

otThreadGetParentPriority

OTAPI int8_t OTCALL otThreadGetParentPriority(
  otInstance *aInstance
)

Get the assigned parent priority.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The assigned parent priority value, -2 means not assigned.

See also:
otThreadSetParentPriority

otThreadGetRouterDowngradeThreshold

OTAPI uint8_t OTCALL otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

Get the ROUTER_DOWNGRADE_THRESHOLD parameter used in the Router role.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The ROUTER_DOWNGRADE_THRESHOLD value.

See also:
otThreadSetRouterDowngradeThreshold

otThreadGetRouterIdSequence

OTAPI uint8_t OTCALL otThreadGetRouterIdSequence(
  otInstance *aInstance
)

Get the current Router ID Sequence.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The Router ID Sequence.

otThreadGetRouterInfo

OTAPI otError OTCALL otThreadGetRouterInfo(
  otInstance *aInstance,
  uint16_t aRouterId,
  otRouterInfo *aRouterInfo
)

The function retains diagnostic information for a given Thread Router.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aRouterId The router ID or RLOC16 for a given router. [out] aRouterInfo A pointer to where the router information is placed.
Return Values	OT_ERROR_NONE Successfully retrieved the router info for given id. OT_ERROR_NOT_FOUND No router entry with the given id. OT_ERROR_INVALID_ARGS aRouterInfo is NULL.

otThreadGetRouterSelectionJitter

OTAPI uint8_t OTCALL otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

Get the ROUTER_SELECTION_JITTER parameter used in the REED/Router role.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The ROUTER_SELECTION_JITTER value.

See also:
otThreadSetRouterSelectionJitter

otThreadGetRouterUpgradeThreshold

OTAPI uint8_t OTCALL otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

Get the ROUTER_UPGRADE_THRESHOLD parameter used in the REED role.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The ROUTER_UPGRADE_THRESHOLD value.

See also:
otThreadSetRouterUpgradeThreshold

otThreadIsRouterRoleEnabled

OTAPI bool OTCALL otThreadIsRouterRoleEnabled(
  otInstance *aInstance
)

This function indicates whether or not the Router Role is enabled.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Return Values	TRUE If the Router Role is enabled. FALSE If the Router Role is not enabled.

otThreadReleaseRouterId

OTAPI otError OTCALL otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Release a Router ID that has been allocated by the device in the Leader role.

Note: This API is reserved for testing and demo purposes only. Changing settings with this API will render a production application non-compliant with the Thread Specification.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aRouterId The Router ID to release. Valid range is [0, 62].
Return Values	OT_ERROR_NONE Successfully released the router id. OT_ERROR_INVALID_ARGS aRouterId is not in the range [0, 62]. OT_ERROR_INVALID_STATE The device is not currently operating as a leader. OT_ERROR_NOT_FOUND The router id is not currently allocated.

otThreadSetChildTableCallback

void otThreadSetChildTableCallback(
  otInstance *aInstance,
  otThreadChildTableCallback aCallback
)

This function sets the child table callback function.

The provided callback (if non-NULL) will be invoked when a child entry is being added/removed to/from the child table. Subsequent calls to this method will overwrite the previous callback. Note that this callback in invoked while the child table is being updated and always before the otStateChangedCallback.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aCallback A pointer to callback handler function.

otThreadSetContextIdReuseDelay

OTAPI void OTCALL otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

Set the CONTEXT_ID_REUSE_DELAY parameter used in the Leader role.

Note: This API is reserved for testing and demo purposes only. Changing settings with this API will render a production application non-compliant with the Thread Specification.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aDelay The CONTEXT_ID_REUSE_DELAY value.

See also:
otThreadGetContextIdReuseDelay

otThreadSetJoinerUdpPort

OTAPI otError OTCALL otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

Set the Joiner UDP Port.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aJoinerUdpPort The Joiner UDP Port number.
Return Values	OT_ERROR_NONE Successfully set the Joiner UDP Port.

See also:
otThreadGetJoinerUdpPort

otThreadSetLocalLeaderPartitionId

OTAPI void OTCALL otThreadSetLocalLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

Set the Thread Leader Partition Id used when operating in the Leader role.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aPartitionId The Thread Leader Partition Id value.

otThreadSetLocalLeaderWeight

OTAPI void OTCALL otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

Set the Thread Leader Weight used when operating in the Leader role.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aWeight The Thread Leader Weight value.

See also:
otThreadGetLeaderWeight

otThreadSetMaxAllowedChildren

OTAPI otError OTCALL otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint8_t aMaxChildren
)

Set the maximum number of children currently allowed.

This parameter can only be set when Thread protocol operation has been stopped.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aMaxChildren The maximum allowed children.
Return Values	OT_ERROR_NONE Successfully set the max. OT_ERROR_INVALID_ARGS If aMaxChildren is not in the range [1, OPENTHREAD_CONFIG_MAX_CHILDREN]. OT_ERROR_INVALID_STATE If Thread isn't stopped.

See also:
otThreadGetMaxAllowedChildren, otThreadStop

otThreadSetNetworkIdTimeout

OTAPI void OTCALL otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

Set the NETWORK_ID_TIMEOUT parameter used in the Leader role.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aTimeout The NETWORK_ID_TIMEOUT value.

See also:
otThreadGetNetworkIdTimeout

otThreadSetPSKc

OTAPI otError OTCALL otThreadSetPSKc(
  otInstance *aInstance,
  const uint8_t *aPSKc
)

Set the thrPSKc.

This function will only succeed when Thread protocols are disabled. A successful call to this function will also invalidate the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aPSKc A pointer to a buffer containing the thrPSKc.
Return Values	OT_ERROR_NONE Successfully set the thrPSKc. OT_ERROR_INVALID_STATE Thread protocols are enabled.

See also:
otThreadGetPSKc

otThreadSetParentPriority

OTAPI otError OTCALL otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

Set the parent priority.

Note: This API is reserved for testing and demo purposes only. Changing settings with this API will render a production application non-compliant with the Thread Specification.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aParentPriority The parent priority value.
Return Values	OT_ERROR_NONE Successfully set the parent priority. OT_ERROR_INVALID_ARGS If the parent priority value is not among 1, 0, -1 and -2.

See also:
otThreadGetParentPriority

otThreadSetPreferredRouterId

OTAPI otError OTCALL otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Set the preferred Router Id.

Upon becoming a router/leader the node attempts to use this Router Id. If the preferred Router Id is not set or if it can not be used, a randomly generated router id is picked. This property can be set only when the device role is either detached or disabled.

Note: This API is reserved for testing and demo purposes only. Changing settings with this API will render a production application non-compliant with the Thread Specification.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aRouterId The preferred Router Id.
Return Values	OT_ERROR_NONE Successfully set the preferred Router Id. OT_ERROR_INVALID_STATE Could not set (role is not detached or disabled)

otThreadSetRouterDowngradeThreshold

OTAPI void OTCALL otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Set the ROUTER_DOWNGRADE_THRESHOLD parameter used in the Leader role.

Note: This API is reserved for testing and demo purposes only. Changing settings with this API will render a production application non-compliant with the Thread Specification.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aThreshold The ROUTER_DOWNGRADE_THRESHOLD value.

See also:
otThreadGetRouterDowngradeThreshold

otThreadSetRouterRoleEnabled

OTAPI void OTCALL otThreadSetRouterRoleEnabled(
  otInstance *aInstance,
  bool aEnabled
)

This function sets whether or not the Router Role is enabled.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aEnabled TRUE if the Router Role is enabled, FALSE otherwise.

otThreadSetRouterSelectionJitter

OTAPI void OTCALL otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

Set the ROUTER_SELECTION_JITTER parameter used in the REED/Router role.

Note: This API is reserved for testing and demo purposes only. Changing settings with this API will render a production application non-compliant with the Thread Specification.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aRouterJitter The ROUTER_SELECTION_JITTER value.

See also:
otThreadGetRouterSelectionJitter

otThreadSetRouterUpgradeThreshold

OTAPI void OTCALL otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Set the ROUTER_UPGRADE_THRESHOLD parameter used in the Leader role.

Note: This API is reserved for testing and demo purposes only. Changing settings with this API will render a production application non-compliant with the Thread Specification.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aThreshold The ROUTER_UPGRADE_THRESHOLD value.

See also:
otThreadGetRouterUpgradeThreshold

otThreadSetSteeringData

otError otThreadSetSteeringData(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

Set Steering data out of band.

Configuration option OPENTHREAD_CONFIG_ENABLE_STEERING_DATA_SET_OOB should be set to enable setting of steering data out of band. Otherwise calling this function does nothing and it returns OT_ERROR_DISABLED_FEATURE error.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aExtAddress Address used to update the steering data. All zeros to clear the steering data (no steering data). All 0xFFs to set steering data/bloom filter to accept/allow all. A specific EUI64 which is then added to current steering data/bloom filter.
Return Values	OT_ERROR_NONE Successfully set/updated the steering data. OT_ERROR_DISABLED_FEATURE Feature is disabled, not capable of setting steering data out of band.

Macros

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Initializer for otChildIP6AddressIterator.