Router/Leader#

otCacheEntryState#

otCacheEntryState

Defines the EID cache entry state.

otPowerSupply#

otPowerSupply

Represents the power supply property on a device.

This is used as a property in otDeviceProperties to calculate the leader weight.

otNeighborTableEvent#

otNeighborTableEvent

Defines the constants used in otNeighborTableCallback to indicate changes in neighbor table.

otChildIp6AddressIterator#

typedef uint16_t otChildIp6AddressIterator

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

otCacheEntryState#

typedef enum otCacheEntryState otCacheEntryState

Defines the EID cache entry state.

otCacheEntryInfo#

typedef struct otCacheEntryInfo otCacheEntryInfo

Represents an EID cache entry.

otCacheEntryIterator#

typedef struct otCacheEntryIterator otCacheEntryIterator

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

otDeviceProperties#

typedef struct otDeviceProperties otDeviceProperties

Represents the device properties which are used for calculating the local leader weight on a device.

The parameters are set based on device's capability, whether acting as border router, its power supply config, etc.

mIsUnstable indicates operational stability of device and is determined via a vendor specific mechanism. It can include the following cases:

• Device internally detects that it loses external power supply more often than usual. What is usual is determined by the vendor.

• Device internally detects that it reboots more often than usual. What is usual is determined by the vendor.

otNeighborTableCallback#

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

Pointer is called to notify that there is a change in the neighbor table.

otThreadGetMaxAllowedChildren#

uint16_t otThreadGetMaxAllowedChildren (otInstance * aInstance)

Gets the maximum number of children currently allowed.

Returns

• The maximum number of children currently allowed.

See Also

• otThreadSetMaxAllowedChildren

otThreadSetMaxAllowedChildren#

otError otThreadSetMaxAllowedChildren (otInstance * aInstance, uint16_t aMaxChildren)

Sets the maximum number of children currently allowed.

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

See Also

• otThreadGetMaxAllowedChildren

otThreadIsRouterEligible#

bool otThreadIsRouterEligible (otInstance * aInstance)

Indicates whether or not the device is router-eligible.

otThreadSetRouterEligible#

otError otThreadSetRouterEligible (otInstance * aInstance, bool aEligible)

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.

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.

otThreadGetDeviceProperties#

const otDeviceProperties * otThreadGetDeviceProperties (otInstance * aInstance)

Get the current device properties.

Requires OPENTHREAD_CONFIG_MLE_DEVICE_PROPERTY_LEADER_WEIGHT_ENABLE.

Returns

• The device properties otDeviceProperties.

otThreadSetDeviceProperties#

void otThreadSetDeviceProperties (otInstance * aInstance, const otDeviceProperties * aDeviceProperties)

Set the device properties which are then used to determine and set the Leader Weight.

Requires OPENTHREAD_CONFIG_MLE_DEVICE_PROPERTY_LEADER_WEIGHT_ENABLE.

otThreadGetLocalLeaderWeight#

uint8_t otThreadGetLocalLeaderWeight (otInstance * aInstance)

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

Returns

• The Thread Leader Weight value.

See Also

• otThreadSetLeaderWeight

• otThreadSetDeviceProperties

otThreadSetLocalLeaderWeight#

void otThreadSetLocalLeaderWeight (otInstance * aInstance, uint8_t aWeight)

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

Directly sets the Leader Weight to the new value, replacing its previous value (which may have been determined from the current otDeviceProperties).

See Also

• otThreadGetLeaderWeight

otThreadGetPreferredLeaderPartitionId#

uint32_t otThreadGetPreferredLeaderPartitionId (otInstance * aInstance)

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

Returns

• The Thread Leader Partition Id value.

otThreadSetPreferredLeaderPartitionId#

void otThreadSetPreferredLeaderPartitionId (otInstance * aInstance, uint32_t aPartitionId)

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

otThreadGetJoinerUdpPort#

uint16_t otThreadGetJoinerUdpPort (otInstance * aInstance)

Gets the Joiner UDP Port.

Returns

• The Joiner UDP Port number.

See Also

• otThreadSetJoinerUdpPort

otThreadSetJoinerUdpPort#

otError otThreadSetJoinerUdpPort (otInstance * aInstance, uint16_t aJoinerUdpPort)

Sets the Joiner UDP Port.

See Also

• otThreadGetJoinerUdpPort

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.

otThreadGetContextIdReuseDelay#

uint32_t otThreadGetContextIdReuseDelay (otInstance * aInstance)

Get the CONTEXT_ID_REUSE_DELAY parameter used in the Leader role.

Returns

• The CONTEXT_ID_REUSE_DELAY value.

See Also

• otThreadSetContextIdReuseDelay

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.

See Also

• otThreadGetContextIdReuseDelay

otThreadGetNetworkIdTimeout#

uint8_t otThreadGetNetworkIdTimeout (otInstance * aInstance)

Get the NETWORK_ID_TIMEOUT parameter.

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.

Returns

• The NETWORK_ID_TIMEOUT value.

See Also

• otThreadSetNetworkIdTimeout

otThreadSetNetworkIdTimeout#

void otThreadSetNetworkIdTimeout (otInstance * aInstance, uint8_t aTimeout)

Set the NETWORK_ID_TIMEOUT parameter.

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.

See Also

• otThreadGetNetworkIdTimeout

otThreadGetRouterUpgradeThreshold#

uint8_t otThreadGetRouterUpgradeThreshold (otInstance * aInstance)

Get the ROUTER_UPGRADE_THRESHOLD parameter used in the REED role.

Returns

• The ROUTER_UPGRADE_THRESHOLD value.

See Also

• otThreadSetRouterUpgradeThreshold

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.

See Also

• otThreadGetRouterUpgradeThreshold

otThreadGetChildRouterLinks#

uint8_t otThreadGetChildRouterLinks (otInstance * aInstance)

Get the MLE_CHILD_ROUTER_LINKS parameter used in the REED role.

This parameter specifies the max number of neighboring routers with which the device (as an FED) will try to establish link.

Returns

• The MLE_CHILD_ROUTER_LINKS value.

See Also

• otThreadSetChildRouterLinks

otThreadSetChildRouterLinks#

otError otThreadSetChildRouterLinks (otInstance * aInstance, uint8_t aChildRouterLinks)

Set the MLE_CHILD_ROUTER_LINKS parameter used in the REED role.

See Also

• otThreadGetChildRouterLinks

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.

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.

otThreadBecomeLeader#

otError otThreadBecomeLeader (otInstance * aInstance)

Become a leader and start a new partition.

If the device is not attached, this API will force the device to start as the leader of the network. This use case is only intended for testing and demo purposes, and using the API while the device is detached can make a production application non-compliant with the Thread Specification.

If the device is already attached, this API can be used to try to take over as the leader, creating a new partition. For this to work, the local leader weight (otThreadGetLocalLeaderWeight()) must be larger than the weight of the current leader (otThreadGetLeaderWeight()). If it is not, OT_ERROR_NOT_CAPABLE is returned to indicate to the caller that they need to adjust the weight.

Taking over the leader role in this way is only allowed when triggered by an explicit user action. Using this API without such user action can make a production application non-compliant with the Thread Specification.

otThreadGetRouterDowngradeThreshold#

uint8_t otThreadGetRouterDowngradeThreshold (otInstance * aInstance)

Get the ROUTER_DOWNGRADE_THRESHOLD parameter used in the Router role.

Returns

• The ROUTER_DOWNGRADE_THRESHOLD value.

See Also

• otThreadSetRouterDowngradeThreshold

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.

See Also

• otThreadGetRouterDowngradeThreshold

otThreadGetRouterSelectionJitter#

uint8_t otThreadGetRouterSelectionJitter (otInstance * aInstance)

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

Returns

• The ROUTER_SELECTION_JITTER value.

See Also

• otThreadSetRouterSelectionJitter

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.

See Also

• otThreadGetRouterSelectionJitter

otThreadGetChildInfoById#

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

Gets diagnostic information for an attached Child by its Child ID or RLOC16.

otThreadGetChildInfoByIndex#

otError otThreadGetChildInfoByIndex (otInstance * aInstance, uint16_t aChildIndex, otChildInfo * aChildInfo)

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

See Also

• otGetMaxAllowedChildren

otThreadGetChildNextIp6Address#

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

Gets the next IPv6 address (using an iterator) for a given child.

See Also

• otThreadGetChildInfoByIndex

otThreadGetRouterIdSequence#

uint8_t otThreadGetRouterIdSequence (otInstance * aInstance)

Get the current Router ID Sequence.

Returns

• The Router ID Sequence.

otThreadGetMaxRouterId#

uint8_t otThreadGetMaxRouterId (otInstance * aInstance)

The function returns the maximum allowed router ID.

Returns

• The maximum allowed router ID.

otThreadGetRouterInfo#

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

The function retains diagnostic information for a given Thread Router.

otThreadGetNextCacheEntry#

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

Gets the next EID cache entry (using an iterator).

otThreadGetPskc#

void otThreadGetPskc (otInstance * aInstance, otPskc * aPskc)

Get the Thread PSKc.

See Also

• otThreadSetPskc

otThreadGetPskcRef#

otPskcRef otThreadGetPskcRef (otInstance * aInstance)

Get Key Reference to Thread PSKc stored.

Requires the build-time feature OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE to be enabled.

Returns

• Key Reference to PSKc

See Also

• otThreadSetPskcRef

otThreadSetPskc#

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

Set the Thread PSKc.

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.

See Also

• otThreadGetPskc

otThreadSetPskcRef#

otError otThreadSetPskcRef (otInstance * aInstance, otPskcRef aKeyRef)

Set the Key Reference to the Thread PSKc.

Requires the build-time feature OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE to be enabled.

Will only succeed when Thread protocols are disabled. Upon success, this will also invalidate the Active and Pending Operational Datasets in non-volatile memory.

See Also

• otThreadGetPskcRef

otThreadGetParentPriority#

int8_t otThreadGetParentPriority (otInstance * aInstance)

Get the assigned parent priority.

Returns

• The assigned parent priority value, -2 means not assigned.

See Also

• otThreadSetParentPriority

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.

See Also

• otThreadGetParentPriority

otThreadGetMaxChildIpAddresses#

uint8_t otThreadGetMaxChildIpAddresses (otInstance * aInstance)

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

Returns

• The maximum number of IP addresses that each MTD child may register with this device as parent.

See Also

• otThreadSetMaxChildIpAddresses

otThreadSetMaxChildIpAddresses#

otError otThreadSetMaxChildIpAddresses (otInstance * aInstance, uint8_t aMaxIpAddresses)

Sets or restores the maximum number of IP addresses that each MTD child may register with this device as parent.

Pass 0 to clear the setting and restore the default.

Available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

Note

• Only used by Thread Test Harness to limit the address registrations of the reference parent in order to test the MTD DUT reaction.

See Also

• otThreadGetMaxChildIpAddresses

otThreadRegisterNeighborTableCallback#

void otThreadRegisterNeighborTableCallback (otInstance * aInstance, otNeighborTableCallback aCallback)

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.

otThreadSetCcmEnabled#

void otThreadSetCcmEnabled (otInstance * aInstance, bool aEnabled)

Sets whether the device was commissioned using CCM.

Note

• This API requires OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE, and is only used by Thread Test Harness to indicate whether this device was commissioned using CCM.

otThreadSetThreadVersionCheckEnabled#

void otThreadSetThreadVersionCheckEnabled (otInstance * aInstance, bool aEnabled)

Sets whether the Security Policy TLV version-threshold for routing (VR field) is enabled.

Note

• This API requires OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE, and is only used by Thread Test Harness to indicate that thread protocol version check VR should be skipped.

otThreadSetTmfOriginFilterEnabled#

void otThreadSetTmfOriginFilterEnabled (otInstance * aInstance, bool aEnabled)

Enables or disables the filter to drop TMF UDP messages from untrusted origin.

TMF messages are only trusted when they originate from a trusted source, such as the Thread interface. In special cases, such as when a device uses platform UDP socket to send TMF messages, they will be dropped due to untrusted origin. This filter is enabled by default.

When this filter is disabled, UDP messages sent to the TMF port that originate from untrusted origin (such as host, CLI or an external IPv6 node) will be allowed.

Note

• This API requires OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE and is only used by Thread Test Harness to test network behavior by sending special TMF messages from the CLI on a POSIX host.

otThreadIsTmfOriginFilterEnabled#

bool otThreadIsTmfOriginFilterEnabled (otInstance * aInstance)

Indicates whether the filter that drops TMF UDP messages from untrusted origin is enabled or not.

This is intended for testing only and available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE config is enabled.

otThreadGetRouterIdRange#

void otThreadGetRouterIdRange (otInstance * aInstance, uint8_t * aMinRouterId, uint8_t * aMaxRouterId)

Gets the range of router IDs that are allowed to assign to nodes within the thread network.

Note

• This API requires OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE, and is only used for test purpose. All the router IDs in the range [aMinRouterId, aMaxRouterId] are allowed.

See Also

• otThreadSetRouterIdRange

otThreadSetRouterIdRange#

otError otThreadSetRouterIdRange (otInstance * aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)

Sets the range of router IDs that are allowed to assign to nodes within the thread network.

Note

• This API requires OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE, and is only used for test purpose. All the router IDs in the range [aMinRouterId, aMaxRouterId] are allowed.

See Also

• otThreadGetRouterIdRange

otThreadGetAdvertisementTrickleIntervalMax#

uint32_t otThreadGetAdvertisementTrickleIntervalMax (otInstance * aInstance)

Gets the current Interval Max value used by Advertisement trickle timer.

This API requires OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE, and is intended for testing only.

Returns

• The Interval Max of Advertisement trickle timer in milliseconds.

otThreadIsRouterIdAllocated#

bool otThreadIsRouterIdAllocated (otInstance * aInstance, uint8_t aRouterId)

Indicates whether or not a Router ID is currently allocated.

otThreadGetNextHopAndPathCost#

void otThreadGetNextHopAndPathCost (otInstance * aInstance, uint16_t aDestRloc16, uint16_t * aNextHopRloc16, uint8_t * aPathCost)

Gets the next hop and path cost towards a given RLOC16 destination.

Can be used with either aNextHopRloc16 or aPathCost being NULL indicating caller does not want to get the value.

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT#

#define OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

0

Initializer for otChildIP6AddressIterator.