Router/Leader

This module includes functions for Thread Routers and Leaders.

Summary

Enumerations
otCacheEntryState	enum This enumeration defines the EID cache entry state.
otNeighborTableEvent{   OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED,   OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED,   OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED,   OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED,   OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED }	enum This enumeration defines the constants used in otNeighborTableCallback to indicate changes in neighbor table.

Typedefs
otCacheEntryInfo	typedef struct otCacheEntryInfo This structure represents an EID cache entry.
otCacheEntryIterator	typedef struct otCacheEntryIterator This type represents an iterator used for iterating through the EID cache table entries.
otCacheEntryState	typedef enum otCacheEntryState This enumeration defines the EID cache entry state.
otChildIp6AddressIterator	typedef uint16_t Used to iterate through IPv6 addresses of a Thread Child entry.
otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)	typedef void(* This function pointer is called to notify that there is a change in the neighbor table.

Functions
otThreadBecomeLeader(otInstance *aInstance)	otError Become a leader and start a new partition.
otThreadBecomeRouter(otInstance *aInstance)	otError Attempt to become a router.
otThreadGetChildInfoById(otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)	otError The function retains diagnostic information for an attached Child by its Child ID or RLOC16.
otThreadGetChildInfoByIndex(otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)	otError The function retains diagnostic information for an attached Child by the internal table index.
otThreadGetChildNextIp6Address(otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)	otError This function gets the next IPv6 address (using an iterator) for a given child.
otThreadGetContextIdReuseDelay(otInstance *aInstance)	uint32_t Get the CONTEXT_ID_REUSE_DELAY parameter used in the Leader role.
otThreadGetJoinerUdpPort(otInstance *aInstance)	uint16_t Get the Joiner UDP Port.
otThreadGetLocalLeaderWeight(otInstance *aInstance)	uint8_t Get the Thread Leader Weight used when operating in the Leader role.
otThreadGetMaxAllowedChildren(otInstance *aInstance)	uint16_t Get the maximum number of children currently allowed.
otThreadGetMaxChildIpAddresses(otInstance *aInstance)	uint8_t This function gets the maximum number of IP addresses that each MTD child may register with this device as parent.
otThreadGetMaxRouterId(otInstance *aInstance)	uint8_t The function returns the maximum allowed router ID.
otThreadGetNetworkIdTimeout(otInstance *aInstance)	uint8_t Get the NETWORK_ID_TIMEOUT parameter used in the Router role.
otThreadGetNextCacheEntry(otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)	otError This function gets the next EID cache entry (using an iterator).
otThreadGetParentPriority(otInstance *aInstance)	int8_t Get the assigned parent priority.
otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)	uint32_t Get the preferred Thread Leader Partition Id used when operating in the Leader role.
otThreadGetPskc(otInstance *aInstance, otPskc *aPskc)	void Get the Thread PSKc.
otThreadGetPskcRef(otInstance *aInstance)	otPskcRef Get Key Reference to Thread PSKc stored.
otThreadGetRouterDowngradeThreshold(otInstance *aInstance)	uint8_t Get the ROUTER_DOWNGRADE_THRESHOLD parameter used in the Router role.
otThreadGetRouterIdSequence(otInstance *aInstance)	uint8_t Get the current Router ID Sequence.
otThreadGetRouterInfo(otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)	otError The function retains diagnostic information for a given Thread Router.
otThreadGetRouterSelectionJitter(otInstance *aInstance)	uint8_t Get the ROUTER_SELECTION_JITTER parameter used in the REED/Router role.
otThreadGetRouterUpgradeThreshold(otInstance *aInstance)	uint8_t Get the ROUTER_UPGRADE_THRESHOLD parameter used in the REED role.
otThreadIsRouterEligible(otInstance *aInstance)	bool This method indicates whether or not the device is router-eligible.
otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback)	void This function registers a neighbor table callback function.
otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)	otError Release a Router ID that has been allocated by the device in the Leader role.
otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t aDelay)	void Set the CONTEXT_ID_REUSE_DELAY parameter used in the Leader role.
otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)	otError Set the Joiner UDP Port.
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)	void Set the Thread Leader Weight used when operating in the Leader role.
otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)	otError Set the maximum number of children currently allowed.
otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)	otError This function sets/restores the maximum number of IP addresses that each MTD child may register with this device as parent.
otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)	void Set the NETWORK_ID_TIMEOUT parameter used in the Leader role.
otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)	otError Set the parent priority.
otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)	void Set the preferred Thread Leader Partition Id used when operating in the Leader role.
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)	otError Set the preferred Router Id.
otThreadSetPskc(otInstance *aInstance, const otPskc *aPskc)	otError Set the Thread PSKc.
otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)	otError Set the Thread PSKc.
otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)	void Set the ROUTER_DOWNGRADE_THRESHOLD parameter used in the Leader role.
otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)	otError This function sets whether or not the device is router-eligible.
otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)	void Set the ROUTER_SELECTION_JITTER parameter used in the REED/Router role.
otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8_t aThreshold)	void Set the ROUTER_UPGRADE_THRESHOLD parameter used in the Leader role.
otThreadSetSteeringData(otInstance *aInstance, const otExtAddress *aExtAddress)	void Set Steering data out of band.

Structs
otCacheEntryInfo	This structure represents an EID cache entry.
otCacheEntryIterator	This type represents an iterator used for iterating through the EID cache table entries.
otChildInfo	This structure holds diagnostic information for a Thread Child.
otNeighborTableEntryInfo	This type represent a neighbor table entry info (child or router) and is used as a parameter in the neighbor table callback otNeighborTableCallback.

Enumerations

otCacheEntryState

 otCacheEntryState

This enumeration defines the EID cache entry state.

otNeighborTableEvent

 otNeighborTableEvent

This enumeration defines the constants used in otNeighborTableCallback to indicate changes in neighbor table.

Properties
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED	A child is being added.
OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED	An existing child's mode is changed.
OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED	A child is being removed.
OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED	A router is being added.
OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED	A router is being removed.

Typedefs

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

This structure represents an EID cache entry.

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

This type represents an iterator used for iterating through the EID cache table entries.

To initialize the iterator and start from the first entry in the cache table, set all its fields in the structure to zero (e.g., memset the iterator to zero).

otCacheEntryState

enum otCacheEntryState otCacheEntryState

This enumeration defines the EID cache entry state.

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

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

otNeighborTableCallback

void(* otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)

This function pointer is called to notify that there is a change in the neighbor table.

Details
Parameters	[in] aEvent A event flag. [in] aEntryInfo A pointer to table entry info.

Functions

otThreadBecomeLeader

otError 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

otError 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

otError 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

otError otThreadGetChildInfoByIndex(
  otInstance *aInstance,
  uint16_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,
  uint16_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

otThreadGetContextIdReuseDelay

uint32_t 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

otThreadGetJoinerUdpPort

uint16_t 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

otThreadGetLocalLeaderWeight

uint8_t 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

uint16_t 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

otThreadGetMaxChildIpAddresses

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

This function gets the maximum number of IP addresses that each MTD child may register with this device as parent.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The maximum number of IP addresses that each MTD child may register with this device as parent.

See also:
otThreadSetMaxChildIpAddresses

otThreadGetMaxRouterId

uint8_t 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

uint8_t 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

otThreadGetNextCacheEntry

otError otThreadGetNextCacheEntry(
  otInstance *aInstance,
  otCacheEntryInfo *aEntryInfo,
  otCacheEntryIterator *aIterator
)

This function gets the next EID cache entry (using an iterator).

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [out] aEntryInfo A pointer to where the EID cache entry information is placed. [in,out] aIterator A pointer to an iterator. It will be updated to point to next entry on success. To get the first entry, initialize the iterator by setting all its fields to zero (e.g., memset the the iterator structure to zero).
Return Values	OT_ERROR_NONE Successfully populated aEntryInfo for next EID cache entry. OT_ERROR_NOT_FOUND No more entries in the address cache table.

otThreadGetParentPriority

int8_t 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

otThreadGetPreferredLeaderPartitionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

Get the preferred 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.

otThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

Get the Thread PSKc.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [out] aPskc A pointer to an otPskc to return the retrieved Thread PSKc.

See also:
otThreadSetPskc

otThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

Get Key Reference to Thread PSKc stored.

This function requires the build-time feature OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE to be enabled.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	Key Reference to PSKc

See also:
otThreadSetPskcRef

otThreadGetRouterDowngradeThreshold

uint8_t 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

uint8_t 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

otError 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

uint8_t 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

uint8_t 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

otThreadIsRouterEligible

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

This method indicates whether or not the device is router-eligible.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Return Values	TRUE If device is router-eligible. FALSE If device is not router-eligible.

otThreadRegisterNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

This function registers a neighbor table callback function.

The provided callback (if non-NULL) will be invoked when there is a change in the neighbor table (e.g., a child or a router neighbor entry is being added/removed or an existing child's mode is changed).

Subsequent calls to this method will overwrite the previous callback. Note that this callback in invoked while the neighbor/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.

otThreadReleaseRouterId

otError 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.

otThreadSetContextIdReuseDelay

void 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

otError 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

otThreadSetLocalLeaderWeight

void 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

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_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_MLE_MAX_CHILDREN]. OT_ERROR_INVALID_STATE If Thread isn't stopped.

See also:
otThreadGetMaxAllowedChildren

otThreadSetMaxChildIpAddresses

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

This function sets/restores the maximum number of IP addresses that each MTD child may register with this device as parent.

Note: This API requires OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE, and is only used by Thread Test Harness to limit the address registrations of the reference parent in order to test the MTD DUT reaction.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aMaxIpAddresses The maximum number of IP addresses that each MTD child may register with this device as parent. 0 to clear the setting and restore the default.
Return Values	OT_ERROR_NONE Successfully set/cleared the number. OT_ERROR_INVALID_ARGS If exceeds the allowed maximum number.

See also:
otThreadGetMaxChildIpAddresses

otThreadSetNetworkIdTimeout

void 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

otThreadSetParentPriority

otError 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

otThreadSetPreferredLeaderPartitionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

Set the preferred 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.

otThreadSetPreferredRouterId

otError 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)

otThreadSetPskc

otError otThreadSetPskc(
  otInstance *aInstance,
  const otPskc *aPskc
)

Set the Thread PSKc.

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 the new Thread PSKc.
Return Values	OT_ERROR_NONE Successfully set the Thread PSKc. OT_ERROR_INVALID_STATE Thread protocols are enabled.

See also:
otThreadGetPskc

otThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

Set the Thread PSKc.

This function requires the build-time feature OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE to be enabled.

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] aPskcRef Key Reference to the new Thread PSKc.
Return Values	OT_ERROR_NONE Successfully set the Thread PSKc. OT_ERROR_INVALID_STATE Thread protocols are enabled.

See also:
otThreadGetPskcRef

otThreadSetRouterDowngradeThreshold

void 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

otThreadSetRouterEligible

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

This function sets whether or not the device is router-eligible.

If aEligible is false and the device is currently operating as a router, this call will cause the device to detach and attempt to reattach as a child.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aEligible TRUE to configure the device as router-eligible, FALSE otherwise.
Return Values	OT_ERROR_NONE Successfully set the router-eligible configuration. OT_ERROR_NOT_CAPABLE The device is not capable of becoming a router.

otThreadSetRouterSelectionJitter

void 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

void 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

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

Set Steering data out of band.

Configuration option OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE should be set to enable setting of steering data out of band.

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.

Macros

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Initializer for otChildIP6AddressIterator.