General#

otRoutePreference#

otRoutePreference

Defines valid values for mPreference in otExternalRouteConfig and otBorderRouterConfig.

otNetDataPublisherEvent#

otNetDataPublisherEvent

Represents the events reported from the Publisher callbacks.

@5#

@5

otDeviceRole#

otDeviceRole

Represents a Thread device role.

otNetworkDataIterator#

typedef uint32_t otNetworkDataIterator

Used to iterate through Network Data information.

otBorderRouterConfig#

typedef struct otBorderRouterConfig otBorderRouterConfig

Represents a Border Router configuration.

otLowpanContextInfo#

typedef struct otLowpanContextInfo otLowpanContextInfo

Represents 6LoWPAN Context ID information associated with a prefix in Network Data.

otExternalRouteConfig#

typedef struct otExternalRouteConfig otExternalRouteConfig

Represents an External Route configuration.

otRoutePreference#

typedef enum otRoutePreference otRoutePreference

Defines valid values for mPreference in otExternalRouteConfig and otBorderRouterConfig.

otServerConfig#

typedef struct otServerConfig otServerConfig

Represents a Server configuration.

otServiceConfig#

typedef struct otServiceConfig otServiceConfig

Represents a Service configuration.

otNetDataPublisherEvent#

typedef enum otNetDataPublisherEvent otNetDataPublisherEvent

Represents the events reported from the Publisher callbacks.

otNetDataDnsSrpServicePublisherCallback#

typedef void(* otNetDataDnsSrpServicePublisherCallback) (otNetDataPublisherEvent aEvent, void *aContext) )(otNetDataPublisherEvent aEvent, void *aContext)

Pointer type defines the callback used to notify when a "DNS/SRP Service" entry is added to or removed from the Thread Network Data.

On remove the callback is invoked independent of whether the entry is removed by Publisher (e.g., when there are too many similar entries already present in the Network Data) or through an explicit call to unpublish the entry (i.e., a call to otNetDataUnpublishDnsSrpService()).

otNetDataPrefixPublisherCallback#

typedef void(* otNetDataPrefixPublisherCallback) (otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) )(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)

Pointer type defines the callback used to notify when a prefix (on-mesh or external route) entry is added to or removed from the Thread Network Data.

On remove the callback is invoked independent of whether the entry is removed by Publisher (e.g., when there are too many similar entries already present in the Network Data) or through an explicit call to unpublish the entry.

otNetworkDiagIterator#

typedef uint16_t otNetworkDiagIterator

Used to iterate through Network Diagnostic TLV.

otNetworkDiagConnectivity#

typedef struct otNetworkDiagConnectivity otNetworkDiagConnectivity

Represents a Network Diagnostic Connectivity value.

otNetworkDiagRouteData#

typedef struct otNetworkDiagRouteData otNetworkDiagRouteData

Represents a Network Diagnostic Route data.

otNetworkDiagRoute#

typedef struct otNetworkDiagRoute otNetworkDiagRoute

Represents a Network Diagnostic Route TLV value.

otNetworkDiagMacCounters#

typedef struct otNetworkDiagMacCounters otNetworkDiagMacCounters

Represents a Network Diagnostic Mac Counters value.

See RFC 2863 for definitions of member fields.

otNetworkDiagMleCounters#

typedef struct otNetworkDiagMleCounters otNetworkDiagMleCounters

Represents a Network Diagnostics MLE Counters value.

otNetworkDiagChildEntry#

typedef struct otNetworkDiagChildEntry otNetworkDiagChildEntry

Represents a Network Diagnostic Child Table Entry.

otNetworkDiagTlv#

typedef struct otNetworkDiagTlv otNetworkDiagTlv

Represents a Network Diagnostic TLV.

otReceiveDiagnosticGetCallback#

typedef void(* otReceiveDiagnosticGetCallback) (otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) )(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)

Pointer is called when Network Diagnostic Get response is received.

otLinkModeConfig#

typedef struct otLinkModeConfig otLinkModeConfig

Represents an MLE Link Mode configuration.

otNeighborInfoIterator#

typedef int16_t otNeighborInfoIterator

Used to iterate through neighbor table.

otLeaderData#

typedef struct otLeaderData otLeaderData

Represents the Thread Leader Data.

otIpCounters#

typedef struct otIpCounters otIpCounters

Represents the IP level counters.

otMleCounters#

typedef struct otMleCounters otMleCounters

Represents the Thread MLE counters.

otThreadParentResponseInfo#

typedef struct otThreadParentResponseInfo otThreadParentResponseInfo

Represents the MLE Parent Response data.

otDetachGracefullyCallback#

typedef void(* otDetachGracefullyCallback) (void *aContext) )(void *aContext)

This callback informs the application that the detaching process has finished.

otThreadParentResponseCallback#

typedef void(* otThreadParentResponseCallback) (otThreadParentResponseInfo *aInfo, void *aContext) )(otThreadParentResponseInfo *aInfo, void *aContext)

Pointer is called every time an MLE Parent Response message is received.

This is used in otThreadRegisterParentResponseCallback().

otThreadDiscoveryRequestInfo#

typedef struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Represents the Thread Discovery Request data.

otThreadDiscoveryRequestCallback#

typedef void(* otThreadDiscoveryRequestCallback) (const otThreadDiscoveryRequestInfo *aInfo, void *aContext) )(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)

Pointer is called every time an MLE Discovery Request message is received.

otThreadAnycastLocatorCallback#

typedef void(* otThreadAnycastLocatorCallback) (void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) )(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)

Pointer type defines the callback to notify the outcome of a otThreadLocateAnycastDestination() request.

otNetDataGet#

otError otNetDataGet (otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)

Provide full or stable copy of the Partition's Thread Network Data.

otNetDataGetLength#

uint8_t otNetDataGetLength (otInstance *aInstance)

Get the current length (number of bytes) of Partition's Thread Network Data.

Returns

• The length of the Network Data.

otNetDataGetMaxLength#

uint8_t otNetDataGetMaxLength (otInstance *aInstance)

Get the maximum observed length of the Thread Network Data since OT stack initialization or since the last call to otNetDataResetMaxLength().

Returns

• The maximum length of the Network Data (high water mark for Network Data length).

otNetDataResetMaxLength#

void otNetDataResetMaxLength (otInstance *aInstance)

Reset the tracked maximum length of the Thread Network Data.

See Also

• otNetDataGetMaxLength

otNetDataGetNextOnMeshPrefix#

otError otNetDataGetNextOnMeshPrefix (otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)

Get the next On Mesh Prefix in the partition's Network Data.

otNetDataGetNextRoute#

otError otNetDataGetNextRoute (otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)

Get the next external route in the partition's Network Data.

otNetDataGetNextService#

otError otNetDataGetNextService (otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)

Get the next service in the partition's Network Data.

otNetDataGetNextLowpanContextInfo#

otError otNetDataGetNextLowpanContextInfo (otInstance *aInstance, otNetworkDataIterator *aIterator, otLowpanContextInfo *aContextInfo)

Get the next 6LoWPAN Context ID info in the partition's Network Data.

otNetDataGetCommissioningDataset#

void otNetDataGetCommissioningDataset (otInstance *aInstance, otCommissioningDataset *aDataset)

Gets the Commissioning Dataset from the partition's Network Data.

otNetDataGetVersion#

uint8_t otNetDataGetVersion (otInstance *aInstance)

Get the Network Data Version.

Returns

• The Network Data Version.

otNetDataGetStableVersion#

uint8_t otNetDataGetStableVersion (otInstance *aInstance)

Get the Stable Network Data Version.

Returns

• The Stable Network Data Version.

otNetDataSteeringDataCheckJoiner#

otError otNetDataSteeringDataCheckJoiner (otInstance *aInstance, const otExtAddress *aEui64)

Check if the steering data includes a Joiner.

otNetDataSteeringDataCheckJoinerWithDiscerner#

otError otNetDataSteeringDataCheckJoinerWithDiscerner (otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)

Check if the steering data includes a Joiner with a given discerner value.

otNetDataContainsOmrPrefix#

bool otNetDataContainsOmrPrefix (otInstance *aInstance, const otIp6Prefix *aPrefix)

Check whether a given Prefix can act as a valid OMR prefix and also the Leader's Network Data contains this prefix.

Returns

• Whether aPrefix is a valid OMR prefix and Leader's Network Data contains the OMR prefix aPrefix.

Note

• This API is only available when OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE is used.

otNetDataPublishDnsSrpServiceAnycast#

void otNetDataPublishDnsSrpServiceAnycast (otInstance *aInstance, uint8_t aSequenceNUmber)

Requests "DNS/SRP Service Anycast Address" to be published in the Thread Network Data.

Requires the feature OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE to be enabled.

A call to this function will remove and replace any previous "DNS/SRP Service" entry that was being published (from earlier call to any of otNetDataPublishDnsSrpService{Type}() functions).

otNetDataPublishDnsSrpServiceUnicast#

void otNetDataPublishDnsSrpServiceUnicast (otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)

Requests "DNS/SRP Service Unicast Address" to be published in the Thread Network Data.

Requires the feature OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE to be enabled.

A call to this function will remove and replace any previous "DNS/SRP Service" entry that was being published (from earlier call to any of otNetDataPublishDnsSrpService{Type}() functions).

Publishes the "DNS/SRP Service Unicast Address" by including the address and port info in the Service TLV data.

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid#

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid (otInstance *aInstance, uint16_t aPort)

Requests "DNS/SRP Service Unicast Address" to be published in the Thread Network Data.

Requires the feature OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE to be enabled.

A call to this function will remove and replace any previous "DNS/SRP Service" entry that was being published (from earlier call to any of otNetDataPublishDnsSrpService{Type}() functions).

Unlike otNetDataPublishDnsSrpServiceUnicast() which requires the published address to be given and includes the info in the Service TLV data, this function uses the device's mesh-local EID and includes the info in the Server TLV data.

otNetDataIsDnsSrpServiceAdded#

bool otNetDataIsDnsSrpServiceAdded (otInstance *aInstance)

Indicates whether or not currently the "DNS/SRP Service" entry is added to the Thread Network Data.

Requires the feature OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE to be enabled.

otNetDataSetDnsSrpServicePublisherCallback#

void otNetDataSetDnsSrpServicePublisherCallback (otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)

Sets a callback for notifying when a published "DNS/SRP Service" is actually added to or removed from the Thread Network Data.

A subsequent call to this function replaces any previously set callback function.

Requires the feature OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE to be enabled.

otNetDataUnpublishDnsSrpService#

void otNetDataUnpublishDnsSrpService (otInstance *aInstance)

Unpublishes any previously added DNS/SRP (Anycast or Unicast) Service entry from the Thread Network Data.

OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE must be enabled.

otNetDataPublishOnMeshPrefix#

otError otNetDataPublishOnMeshPrefix (otInstance *aInstance, const otBorderRouterConfig *aConfig)

Requests an on-mesh prefix to be published in the Thread Network Data.

Requires the feature OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE to be enabled.

Only stable entries can be published (i.e.,aConfig.mStable MUST be TRUE).

A subsequent call to this method will replace a previous request for the same prefix. In particular, if the new call only changes the flags (e.g., preference level) and the prefix is already added in the Network Data, the change to flags is immediately reflected in the Network Data. This ensures that existing entries in the Network Data are not abruptly removed. Note that a change in the preference level can potentially later cause the entry to be removed from the Network Data after determining there are other nodes that are publishing the same prefix with the same or higher preference.

otNetDataPublishExternalRoute#

otError otNetDataPublishExternalRoute (otInstance *aInstance, const otExternalRouteConfig *aConfig)

Requests an external route prefix to be published in the Thread Network Data.

Requires the feature OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE to be enabled.

Only stable entries can be published (i.e.,aConfig.mStable MUST be TRUE).

A subsequent call to this method will replace a previous request for the same prefix. In particular, if the new call only changes the flags (e.g., preference level) and the prefix is already added in the Network Data, the change to flags is immediately reflected in the Network Data. This ensures that existing entries in the Network Data are not abruptly removed. Note that a change in the preference level can potentially later cause the entry to be removed from the Network Data after determining there are other nodes that are publishing the same prefix with the same or higher preference.

otNetDataReplacePublishedExternalRoute#

otError otNetDataReplacePublishedExternalRoute (otInstance *aInstance, const otIp6Prefix *aPrefix, const otExternalRouteConfig *aConfig)

Replaces a previously published external route in the Thread Network Data.

Requires the feature OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE to be enabled.

If there is no previously published external route matching aPrefix, this function behaves similarly to otNetDataPublishExternalRoute(), i.e., it will start the process of publishing aConfig as an external route in the Thread Network Data.

If there is a previously published route entry matching aPrefix, it will be replaced with the new prefix from aConfig.

• If the aPrefix was already added in the Network Data, the change to the new prefix in aConfig is immediately reflected in the Network Data. This ensures that route entries in the Network Data are not abruptly removed and the transition from aPrefix to the new prefix is smooth.

• If the old published aPrefix was not added in the Network Data, it will be replaced with the new aConfig prefix but it will not be immediately added. Instead, it will start the process of publishing it in the Network Data (monitoring the Network Data to determine when/if to add the prefix, depending on the number of similar prefixes present in the Network Data).

otNetDataIsPrefixAdded#

bool otNetDataIsPrefixAdded (otInstance *aInstance, const otIp6Prefix *aPrefix)

Indicates whether or not currently a published prefix entry (on-mesh or external route) is added to the Thread Network Data.

Requires the feature OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE to be enabled.

otNetDataSetPrefixPublisherCallback#

void otNetDataSetPrefixPublisherCallback (otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)

Sets a callback for notifying when a published prefix entry is actually added to or removed from the Thread Network Data.

A subsequent call to this function replaces any previously set callback function.

Requires the feature OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE to be enabled.

otNetDataUnpublishPrefix#

otError otNetDataUnpublishPrefix (otInstance *aInstance, const otIp6Prefix *aPrefix)

Unpublishes a previously published On-Mesh or External Route Prefix.

OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE must be enabled.

otThreadGetNextDiagnosticTlv#

otError otThreadGetNextDiagnosticTlv (const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)

Gets the next Network Diagnostic TLV in the message.

Requires OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

@Note A subsequent call to this function is allowed only when current return value is OT_ERROR_NONE.

otThreadSendDiagnosticGet#

otError otThreadSendDiagnosticGet (otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)

Send a Network Diagnostic Get request.

Requires OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

otThreadSendDiagnosticReset#

otError otThreadSendDiagnosticReset (otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)

Send a Network Diagnostic Reset request.

Requires OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

otThreadGetVendorName#

const char * otThreadGetVendorName (otInstance *aInstance)

Get the vendor name string.

Returns

• The vendor name string.

otThreadGetVendorModel#

const char * otThreadGetVendorModel (otInstance *aInstance)

Get the vendor model string.

Returns

• The vendor model string.

otThreadGetVendorSwVersion#

const char * otThreadGetVendorSwVersion (otInstance *aInstance)

Get the vendor sw version string.

Returns

• The vendor sw version string.

otThreadSetVendorName#

otError otThreadSetVendorName (otInstance *aInstance, const char *aVendorName)

Set the vendor name string.

Requires OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorName should be UTF8 with max length of 32 chars (MAX_VENDOR_NAME_TLV_LENGTH). Maximum length does not include the null \0 character.

otThreadSetVendorModel#

otError otThreadSetVendorModel (otInstance *aInstance, const char *aVendorModel)

Set the vendor model string.

Requires OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorModel should be UTF8 with max length of 32 chars (MAX_VENDOR_MODEL_TLV_LENGTH). Maximum length does not include the null \0 character.

otThreadSetVendorSwVersion#

otError otThreadSetVendorSwVersion (otInstance *aInstance, const char *aVendorSwVersion)

Set the vendor software version string.

Requires OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorSwVersion should be UTF8 with max length of 16 chars(MAX_VENDOR_SW_VERSION_TLV_LENGTH). Maximum length does not include the null \0 character.

otThreadSetEnabled#

otError otThreadSetEnabled (otInstance *aInstance, bool aEnabled)

Starts Thread protocol operation.

The interface must be up when calling this function.

Calling this function with aEnabled set to FALSE stops any ongoing processes of detaching started by otThreadDetachGracefully(). Its callback will be called.

otThreadGetVersion#

uint16_t otThreadGetVersion (void)

Gets the Thread protocol version.

Returns

• the Thread protocol version.

otThreadIsSingleton#

bool otThreadIsSingleton (otInstance *aInstance)

Indicates whether a node is the only router on the network.

otThreadDiscover#

otError otThreadDiscover (otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)

Starts a Thread Discovery scan.

Note

• A successful call to this function enables the rx-on-when-idle mode for the entire scan procedure.

otThreadIsDiscoverInProgress#

bool otThreadIsDiscoverInProgress (otInstance *aInstance)

Determines if an MLE Thread Discovery is currently in progress.

otThreadSetJoinerAdvertisement#

otError otThreadSetJoinerAdvertisement (otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)

Sets the Thread Joiner Advertisement when discovering Thread network.

Thread Joiner Advertisement is used to allow a Joiner to advertise its own application-specific information (such as Vendor ID, Product ID, Discriminator, etc.) via a newly-proposed Joiner Advertisement TLV, and to make this information available to Commissioners or Commissioner Candidates without human interaction.

otThreadGetChildTimeout#

uint32_t otThreadGetChildTimeout (otInstance *aInstance)

Gets the Thread Child Timeout (in seconds) used when operating in the Child role.

Returns

• The Thread Child Timeout value in seconds.

See Also

• otThreadSetChildTimeout

otThreadSetChildTimeout#

void otThreadSetChildTimeout (otInstance *aInstance, uint32_t aTimeout)

Sets the Thread Child Timeout (in seconds) used when operating in the Child role.

See Also

• otThreadGetChildTimeout

otThreadGetExtendedPanId#

const otExtendedPanId * otThreadGetExtendedPanId (otInstance *aInstance)

Gets the IEEE 802.15.4 Extended PAN ID.

Returns

• A pointer to the IEEE 802.15.4 Extended PAN ID.

See Also

• otThreadSetExtendedPanId

otThreadSetExtendedPanId#

otError otThreadSetExtendedPanId (otInstance *aInstance, const otExtendedPanId *aExtendedPanId)

Sets the IEEE 802.15.4 Extended PAN ID.

Note

• Can only be called while Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

See Also

• otThreadGetExtendedPanId

otThreadGetLeaderRloc#

otError otThreadGetLeaderRloc (otInstance *aInstance, otIp6Address *aLeaderRloc)

Returns a pointer to the Leader's RLOC.

otThreadGetLinkMode#

otLinkModeConfig otThreadGetLinkMode (otInstance *aInstance)

Get the MLE Link Mode configuration.

Returns

• The MLE Link Mode configuration.

See Also

• otThreadSetLinkMode

otThreadSetLinkMode#

otError otThreadSetLinkMode (otInstance *aInstance, otLinkModeConfig aConfig)

Set the MLE Link Mode configuration.

See Also

• otThreadGetLinkMode

otThreadGetNetworkKey#

void otThreadGetNetworkKey (otInstance *aInstance, otNetworkKey *aNetworkKey)

Get the Thread Network Key.

See Also

• otThreadSetNetworkKey

otThreadGetNetworkKeyRef#

otNetworkKeyRef otThreadGetNetworkKeyRef (otInstance *aInstance)

Get the otNetworkKeyRef for Thread Network Key.

Requires the build-time feature OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE to be enabled.

Returns

• Reference to the Thread Network Key stored in memory.

See Also

• otThreadSetNetworkKeyRef

otThreadSetNetworkKey#

otError otThreadSetNetworkKey (otInstance *aInstance, const otNetworkKey *aKey)

Set the Thread Network Key.

Succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

See Also

• otThreadGetNetworkKey

otThreadSetNetworkKeyRef#

otError otThreadSetNetworkKeyRef (otInstance *aInstance, otNetworkKeyRef aKeyRef)

Set the Thread Network Key as a otNetworkKeyRef.

Succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Requires the build-time feature OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE to be enabled.

See Also

• otThreadGetNetworkKeyRef

otThreadGetRloc#

const otIp6Address * otThreadGetRloc (otInstance *aInstance)

Gets the Thread Routing Locator (RLOC) address.

Returns

• A pointer to the Thread Routing Locator (RLOC) address.

otThreadGetMeshLocalEid#

const otIp6Address * otThreadGetMeshLocalEid (otInstance *aInstance)

Gets the Mesh Local EID address.

Returns

• A pointer to the Mesh Local EID address.

otThreadGetMeshLocalPrefix#

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix (otInstance *aInstance)

Returns a pointer to the Mesh Local Prefix.

Returns

• A pointer to the Mesh Local Prefix.

otThreadSetMeshLocalPrefix#

otError otThreadSetMeshLocalPrefix (otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)

Sets the Mesh Local Prefix.

Succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

otThreadGetLinkLocalIp6Address#

const otIp6Address * otThreadGetLinkLocalIp6Address (otInstance *aInstance)

Gets the Thread link-local IPv6 address.

The Thread link local address is derived using IEEE802.15.4 Extended Address as Interface Identifier.

Returns

• A pointer to Thread link-local IPv6 address.

otThreadGetLinkLocalAllThreadNodesMulticastAddress#

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress (otInstance *aInstance)

Gets the Thread Link-Local All Thread Nodes multicast address.

The address is a link-local Unicast Prefix-Based Multicast Address [RFC 3306], with:

• flgs set to 3 (P = 1 and T = 1)

• scop set to 2

• plen set to 64

• network prefix set to the Mesh Local Prefix

• group ID set to 1

Returns

• A pointer to Thread Link-Local All Thread Nodes multicast address.

otThreadGetRealmLocalAllThreadNodesMulticastAddress#

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress (otInstance *aInstance)

Gets the Thread Realm-Local All Thread Nodes multicast address.

The address is a realm-local Unicast Prefix-Based Multicast Address [RFC 3306], with:

• flgs set to 3 (P = 1 and T = 1)

• scop set to 3

• plen set to 64

• network prefix set to the Mesh Local Prefix

• group ID set to 1

Returns

• A pointer to Thread Realm-Local All Thread Nodes multicast address.

otThreadGetServiceAloc#

otError otThreadGetServiceAloc (otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)

Retrieves the Service ALOC for given Service ID.

otThreadGetNetworkName#

const char * otThreadGetNetworkName (otInstance *aInstance)

Get the Thread Network Name.

Returns

• A pointer to the Thread Network Name.

See Also

• otThreadSetNetworkName

otThreadSetNetworkName#

otError otThreadSetNetworkName (otInstance *aInstance, const char *aNetworkName)

Set the Thread Network Name.

Succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

See Also

• otThreadGetNetworkName

otThreadGetDomainName#

const char * otThreadGetDomainName (otInstance *aInstance)

Gets the Thread Domain Name.

Note

• Available since Thread 1.2.

Returns

• A pointer to the Thread Domain Name.

See Also

• otThreadSetDomainName

otThreadSetDomainName#

otError otThreadSetDomainName (otInstance *aInstance, const char *aDomainName)

Sets the Thread Domain Name.

Only succeeds when Thread protocols are disabled.

Note

• Available since Thread 1.2.

See Also

• otThreadGetDomainName

otThreadSetFixedDuaInterfaceIdentifier#

otError otThreadSetFixedDuaInterfaceIdentifier (otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)

Sets or clears the Interface Identifier manually specified for the Thread Domain Unicast Address.

Available when OPENTHREAD_CONFIG_DUA_ENABLE is enabled.

Note

• Only available since Thread 1.2.

See Also

• otThreadGetFixedDuaInterfaceIdentifier

otThreadGetFixedDuaInterfaceIdentifier#

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier (otInstance *aInstance)

Gets the Interface Identifier manually specified for the Thread Domain Unicast Address.

Available when OPENTHREAD_CONFIG_DUA_ENABLE is enabled.

Note

• Only available since Thread 1.2.

Returns

• A pointer to the Interface Identifier which was set manually, or NULL if none was set.

See Also

• otThreadSetFixedDuaInterfaceIdentifier

otThreadGetKeySequenceCounter#

uint32_t otThreadGetKeySequenceCounter (otInstance *aInstance)

Gets the thrKeySequenceCounter.

Returns

• The thrKeySequenceCounter value.

See Also

• otThreadSetKeySequenceCounter

otThreadSetKeySequenceCounter#

void otThreadSetKeySequenceCounter (otInstance *aInstance, uint32_t aKeySequenceCounter)

Sets the thrKeySequenceCounter.

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

• otThreadGetKeySequenceCounter

otThreadGetKeySwitchGuardTime#

uint32_t otThreadGetKeySwitchGuardTime (otInstance *aInstance)

Gets the thrKeySwitchGuardTime (in hours).

Returns

• The thrKeySwitchGuardTime value (in hours).

See Also

• otThreadSetKeySwitchGuardTime

otThreadSetKeySwitchGuardTime#

void otThreadSetKeySwitchGuardTime (otInstance *aInstance, uint32_t aKeySwitchGuardTime)

Sets the thrKeySwitchGuardTime (in hours).

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

• otThreadGetKeySwitchGuardTime

otThreadBecomeDetached#

otError otThreadBecomeDetached (otInstance *aInstance)

Detach from the Thread network.

otThreadBecomeChild#

otError otThreadBecomeChild (otInstance *aInstance)

Attempt to reattach as a child.

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.

otThreadGetNextNeighborInfo#

otError otThreadGetNextNeighborInfo (otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)

Gets the next neighbor information.

It is used to go through the entries of the neighbor table.

otThreadGetDeviceRole#

otDeviceRole otThreadGetDeviceRole (otInstance *aInstance)

Get the device role.

otThreadDeviceRoleToString#

const char * otThreadDeviceRoleToString (otDeviceRole aRole)

Convert the device role to human-readable string.

Returns

• A string representing aRole.

otThreadGetLeaderData#

otError otThreadGetLeaderData (otInstance *aInstance, otLeaderData *aLeaderData)

Get the Thread Leader Data.

otThreadGetLeaderRouterId#

uint8_t otThreadGetLeaderRouterId (otInstance *aInstance)

Get the Leader's Router ID.

Returns

• The Leader's Router ID.

otThreadGetLeaderWeight#

uint8_t otThreadGetLeaderWeight (otInstance *aInstance)

Get the Leader's Weight.

Returns

• The Leader's Weight.

otThreadGetPartitionId#

uint32_t otThreadGetPartitionId (otInstance *aInstance)

Get the Partition ID.

Returns

• The Partition ID.

otThreadGetRloc16#

uint16_t otThreadGetRloc16 (otInstance *aInstance)

Get the RLOC16.

Returns

• The RLOC16.

otThreadGetParentInfo#

otError otThreadGetParentInfo (otInstance *aInstance, otRouterInfo *aParentInfo)

The function retrieves diagnostic information for a Thread Router as parent.

otThreadGetParentAverageRssi#

otError otThreadGetParentAverageRssi (otInstance *aInstance, int8_t *aParentRssi)

The function retrieves the average RSSI for the Thread Parent.

otThreadGetParentLastRssi#

otError otThreadGetParentLastRssi (otInstance *aInstance, int8_t *aLastRssi)

The function retrieves the RSSI of the last packet from the Thread Parent.

otThreadSearchForBetterParent#

otError otThreadSearchForBetterParent (otInstance *aInstance)

Starts the process for child to search for a better parent while staying attached to its current parent.

Must be used when device is attached as a child.

otThreadGetIp6Counters#

const otIpCounters * otThreadGetIp6Counters (otInstance *aInstance)

Gets the IPv6 counters.

Returns

• A pointer to the IPv6 counters.

otThreadResetIp6Counters#

void otThreadResetIp6Counters (otInstance *aInstance)

Resets the IPv6 counters.

otThreadGetTimeInQueueHistogram#

const uint32_t * otThreadGetTimeInQueueHistogram (otInstance *aInstance, uint16_t *aNumBins, uint32_t *aBinInterval)

Gets the time-in-queue histogram for messages in the TX queue.

Requires OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

Histogram of the time-in-queue of messages in the transmit queue is collected. The time-in-queue is tracked for direct transmissions only and is measured as the duration from when a message is added to the transmit queue until it is passed to the MAC layer for transmission or dropped.

The histogram is returned as an array of uint32_t values with aNumBins entries. The first entry in the array (at index 0) represents the number of messages with a time-in-queue less than aBinInterval. The second entry represents the number of messages with a time-in-queue greater than or equal to aBinInterval, but less than 2 * aBinInterval. And so on. The last entry represents the number of messages with time-in-queue greater than or equal to (aNumBins - 1) * aBinInterval.

The collected statistics can be reset by calling otThreadResetTimeInQueueStat(). The histogram information is collected since the OpenThread instance was initialized or since the last time statistics collection was reset by calling the otThreadResetTimeInQueueStat().

Pointers aNumBins and aBinInterval MUST NOT be NULL.

Returns

• A pointer to an array of aNumBins entries representing the collected histogram info.

otThreadGetMaxTimeInQueue#

uint32_t otThreadGetMaxTimeInQueue (otInstance *aInstance)

Gets the maximum time-in-queue for messages in the TX queue.

Requires OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

The time-in-queue is tracked for direct transmissions only and is measured as the duration from when a message is added to the transmit queue until it is passed to the MAC layer for transmission or dropped.

The collected statistics can be reset by calling otThreadResetTimeInQueueStat().

Returns

• The maximum time-in-queue in milliseconds for all messages in the TX queue (so far).

otThreadResetTimeInQueueStat#

void otThreadResetTimeInQueueStat (otInstance *aInstance)

Resets the TX queue time-in-queue statistics.

Requires OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

otThreadGetMleCounters#

const otMleCounters * otThreadGetMleCounters (otInstance *aInstance)

Gets the Thread MLE counters.

Returns

• A pointer to the Thread MLE counters.

otThreadResetMleCounters#

void otThreadResetMleCounters (otInstance *aInstance)

Resets the Thread MLE counters.

otThreadRegisterParentResponseCallback#

void otThreadRegisterParentResponseCallback (otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)

Registers a callback to receive MLE Parent Response data.

Requires OPENTHREAD_CONFIG_MLE_PARENT_RESPONSE_CALLBACK_API_ENABLE.

otThreadSetDiscoveryRequestCallback#

void otThreadSetDiscoveryRequestCallback (otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)

Sets a callback to receive MLE Discovery Request data.

otThreadLocateAnycastDestination#

otError otThreadLocateAnycastDestination (otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)

Requests the closest destination of a given anycast address to be located.

Is only available when OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE is enabled.

If a previous request is ongoing, a subsequent call to this function will cancel and replace the earlier request.

otThreadIsAnycastLocateInProgress#

bool otThreadIsAnycastLocateInProgress (otInstance *aInstance)

Indicates whether an anycast locate request is currently in progress.

Is only available when OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE is enabled.

Returns

• TRUE if an anycast locate request is currently in progress, FALSE otherwise.

otThreadSendAddressNotification#

void otThreadSendAddressNotification (otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)

Sends a Proactive Address Notification (ADDR_NTF.ntf) message.

Is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

otThreadSendProactiveBackboneNotification#

otError otThreadSendProactiveBackboneNotification (otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)

Sends a Proactive Backbone Notification (PRO_BB.ntf) message on the Backbone link.

Is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

otThreadDetachGracefully#

otError otThreadDetachGracefully (otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)

Notifies other nodes in the network (if any) and then stops Thread protocol operation.

It sends an Address Release if it's a router, or sets its child timeout to 0 if it's a child.

otConvertDurationInSecondsToString#

void otConvertDurationInSecondsToString (uint32_t aDuration, char *aBuffer, uint16_t aSize)

Converts an uint32_t duration (in seconds) to a human-readable string.

Requires OPENTHREAD_CONFIG_UPTIME_ENABLE to be enabled.

The string follows the format "<hh>:<mm>:<ss>" for hours, minutes, seconds (if duration is shorter than one day) or "<dd>d.<hh>:<mm>:<ss>" (if longer than a day).

If the resulting string does not fit in aBuffer (within its aSize characters), the string will be truncated but the outputted string is always null-terminated.

Is intended for use with mAge or mConnectionTime in otNeighborInfo or otChildInfo structures.

OT_NETWORK_DATA_ITERATOR_INIT#

#define OT_NETWORK_DATA_ITERATOR_INIT

0

Value to initialize otNetworkDataIterator.

OT_SERVICE_DATA_MAX_SIZE#

#define OT_SERVICE_DATA_MAX_SIZE

252

Max size of Service Data in bytes.

OT_SERVER_DATA_MAX_SIZE#

#define OT_SERVER_DATA_MAX_SIZE

248

Max size of Server Data in bytes. Theoretical limit, practically much lower.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES#

#define OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

19

Maximum Number of Network Diagnostic TLV Types to Request or Reset.

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE#

#define OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

3

Size of Network Diagnostic Child Table entry.

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT#

#define OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

0

Initializer for otNetworkDiagIterator.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH#

#define OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH

32

Max length of Vendor Name TLV.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH#

#define OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH

32

Max length of Vendor Model TLV.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH#

#define OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH

16

Max length of Vendor SW Version TLV.

OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH#

#define OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH

64

Max length of Thread Stack Version TLV.

OT_NETWORK_BASE_TLV_MAX_LENGTH#

#define OT_NETWORK_BASE_TLV_MAX_LENGTH

254

Maximum value length of Thread Base TLV.

OT_NETWORK_MAX_ROUTER_ID#

#define OT_NETWORK_MAX_ROUTER_ID

62

Maximum Router ID.

OT_NEIGHBOR_INFO_ITERATOR_INIT#

#define OT_NEIGHBOR_INFO_ITERATOR_INIT

0

Initializer for otNeighborInfoIterator.

OT_JOINER_ADVDATA_MAX_LENGTH#

#define OT_JOINER_ADVDATA_MAX_LENGTH

64

Maximum AdvData Length of Joiner Advertisement.

OT_DURATION_STRING_SIZE#

#define OT_DURATION_STRING_SIZE

21

Recommended size for string representation of uint32_t duration in seconds.