Modules#
General#
This module includes functions for all Thread roles.
The Network Data Publisher provides mechanisms to limit the number of similar Service and/or Prefix (on-mesh prefix or external route) entries in the Thread Network Data by monitoring the Network Data and managing if or when to add or remove entries.
All the functions in this module require OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE
to be enabled.
Note
The functions in this module require
OPENTHREAD_FTD=1
orOPENTHREAD_MTD=1
.
Enumerations#
Defines valid values for mPreference
in otExternalRouteConfig
and otBorderRouterConfig
.
This enumeration represents the events reported from the Publisher callbacks.
Represents a Thread device role.
Typedefs#
Used to iterate through Network Data information.
This structure represents a Border Router configuration.
This structure represents 6LoWPAN Context ID information associated with a prefix in Network Data.
This structure represents an External Route configuration.
Defines valid values for mPreference
in otExternalRouteConfig
and otBorderRouterConfig
.
This structure represents a Server configuration.
This structure represents a Service configuration.
This enumeration represents the events reported from the Publisher callbacks.
This function pointer type defines the callback used to notify when a "DNS/SRP Service" entry is added to or removed from the Thread Network Data.
This function 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.
Used to iterate through Network Diagnostic TLV.
This structure represents a Network Diagnostic Connectivity value.
This structure represents a Network Diagnostic Route data.
This structure represents a Network Diagnostic Route TLV value.
This structure represents a Network Diagnostic Mac Counters value.
This structure represents a Network Diagnostic Child Table Entry.
This structure represents a Network Diagnostic TLV.
This function pointer is called when Network Diagnostic Get response is received.
This structure represents an MLE Link Mode configuration.
Used to iterate through neighbor table.
This structure represents the Thread Leader Data.
This structure represents the IP level counters.
This structure represents the Thread MLE counters.
This structure represents the MLE Parent Response data.
This callback informs the application that the detaching process has finished.
This function pointer is called every time an MLE Parent Response message is received.
This structure represents the Thread Discovery Request data.
This function pointer is called every time an MLE Discovery Request message is received.
This function pointer type defines the callback to notify the outcome of a otThreadLocateAnycastDestination()
request.
Functions#
Provide full or stable copy of the Partition's Thread Network Data.
Get the current length (number of bytes) of Partition's Thread Network Data.
Get the maximum observed length of the Thread Network Data since OT stack initialization or since the last call to otNetDataResetMaxLength()
.
Reset the tracked maximum length of the Thread Network Data.
Get the next On Mesh Prefix in the partition's Network Data.
Get the next external route in the partition's Network Data.
Get the next service in the partition's Network Data.
Get the next 6LoWPAN Context ID info in the partition's Network Data.
Get the Network Data Version.
Get the Stable Network Data Version.
Check if the steering data includes a Joiner.
Check if the steering data includes a Joiner with a given discerner value.
Check whether a given Prefix can act as a valid OMR prefix and also the Leader's Network Data contains this prefix.
This function requests "DNS/SRP Service Anycast Address" to be published in the Thread Network Data.
This function requests "DNS/SRP Service Unicast Address" to be published in the Thread Network Data.
This function requests "DNS/SRP Service Unicast Address" to be published in the Thread Network Data.
This function indicates whether or not currently the "DNS/SRP Service" entry is added to the Thread Network Data.
This function sets a callback for notifying when a published "DNS/SRP Service" is actually added to or removed from the Thread Network Data.
Unpublishes any previously added DNS/SRP (Anycast or Unicast) Service entry from the Thread Network Data.
This function requests an on-mesh prefix to be published in the Thread Network Data.
This function requests an external route prefix to be published in the Thread Network Data.
This function replaces a previously published external route in the Thread Network Data.
This function indicates whether or not currently a published prefix entry (on-mesh or external route) is added to the Thread Network Data.
This function sets a callback for notifying when a published prefix entry is actually added to or removed from the Thread Network Data.
Unpublishes a previously published On-Mesh or External Route Prefix.
This function gets the next Network Diagnostic TLV in the message.
Send a Network Diagnostic Get request.
Send a Network Diagnostic Reset request.
Get the vendor name string.
Get the vendor model string.
Get the vendor sw version string.
Set the vendor name string.
Set the vendor model string.
Set the vendor software version string.
This function starts Thread protocol operation.
This function gets the Thread protocol version.
This function indicates whether a node is the only router on the network.
This function starts a Thread Discovery scan.
This function determines if an MLE Thread Discovery is currently in progress.
This method sets the Thread Joiner Advertisement when discovering Thread network.
Gets the Thread Child Timeout (in seconds) used when operating in the Child role.
Sets the Thread Child Timeout (in seconds) used when operating in the Child role.
Gets the IEEE 802.15.4 Extended PAN ID.
Sets the IEEE 802.15.4 Extended PAN ID.
This function returns a pointer to the Leader's RLOC.
Get the MLE Link Mode configuration.
Set the MLE Link Mode configuration.
Get the Thread Network Key.
Get the otNetworkKeyRef
for Thread Network Key.
Set the Thread Network Key.
Set the Thread Network Key as a otNetworkKeyRef
.
Gets the Thread Routing Locator (RLOC) address.
Gets the Mesh Local EID address.
This function returns a pointer to the Mesh Local Prefix.
This function sets the Mesh Local Prefix.
Gets the Thread link-local IPv6 address.
Gets the Thread Link-Local All Thread Nodes multicast address.
Gets the Thread Realm-Local All Thread Nodes multicast address.
This function retrieves the Service ALOC for given Service ID.
Get the Thread Network Name.
Set the Thread Network Name.
Gets the Thread Domain Name.
Sets the Thread Domain Name.
Sets or clears the Interface Identifier manually specified for the Thread Domain Unicast Address.
Gets the Interface Identifier manually specified for the Thread Domain Unicast Address.
Gets the thrKeySequenceCounter.
Sets the thrKeySequenceCounter.
Gets the thrKeySwitchGuardTime (in hours).
Sets the thrKeySwitchGuardTime (in hours).
Detach from the Thread network.
Attempt to reattach as a child.
This function gets the next neighbor information.
Get the device role.
Convert the device role to human-readable string.
This function get the Thread Leader Data.
Get the Leader's Router ID.
Get the Leader's Weight.
Get the Partition ID.
Get the RLOC16.
The function retrieves diagnostic information for a Thread Router as parent.
The function retrieves the average RSSI for the Thread Parent.
The function retrieves the RSSI of the last packet from the Thread Parent.
Starts the process for child to search for a better parent while staying attached to its current parent.
Gets the IPv6 counters.
Resets the IPv6 counters.
Gets the Thread MLE counters.
Resets the Thread MLE counters.
This function registers a callback to receive MLE Parent Response data.
This function sets a callback to receive MLE Discovery Request data.
This function requests the closest destination of a given anycast address to be located.
This function indicates whether an anycast locate request is currently in progress.
This function sends a Proactive Address Notification (ADDR_NTF.ntf) message.
This function sends a Proactive Backbone Notification (PRO_BB.ntf) message on the Backbone link.
This function notifies other nodes in the network (if any) and then stops Thread protocol operation.
This function converts an uint32_t
duration (in seconds) to a human-readable string.
Macros#
Value to initialize otNetworkDataIterator
.
Max size of Service Data in bytes.
Max size of Server Data in bytes. Theoretical limit, practically much lower.
Maximum Number of Network Diagnostic TLV Types to Request or Reset.
Size of Network Diagnostic Child Table entry.
Initializer for otNetworkDiagIterator.
Max length of Vendor Name TLV.
Max length of Vendor Model TLV.
Max length of Vendor SW Version TLV.
Max length of Thread Stack Version TLV.
Maximum value length of Thread Base TLV.
Maximum Router ID.
Initializer for otNeighborInfoIterator.
Maximum AdvData Length of Joiner Advertisement.
Recommended size for string representation of uint32_t
duration in seconds.
Enumeration Documentation#
otRoutePreference#
otRoutePreference
Defines valid values for mPreference
in otExternalRouteConfig
and otBorderRouterConfig
.
Enumerator | |
---|---|
OT_ROUTE_PREFERENCE_LOW | Low route preference. |
OT_ROUTE_PREFERENCE_MED | Medium route preference. |
OT_ROUTE_PREFERENCE_HIGH | High route preference. |
103
of file include/openthread/netdata.h
otNetDataPublisherEvent#
otNetDataPublisherEvent
This enumeration represents the events reported from the Publisher callbacks.
Enumerator | |
---|---|
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED | Published entry is added to the Thread Network Data. |
OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED | Published entry is removed from the Thread Network Data. |
61
of file include/openthread/netdata_publisher.h
@6#
@6
Enumerator | |
---|---|
OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS | MAC Extended Address TLV. |
OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS | Address16 TLV. |
OT_NETWORK_DIAGNOSTIC_TLV_MODE | Mode TLV. |
OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT | Timeout TLV (the maximum polling time period for SEDs) |
OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY | Connectivity TLV. |
OT_NETWORK_DIAGNOSTIC_TLV_ROUTE | Route64 TLV. |
OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA | Leader Data TLV. |
OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA | Network Data TLV. |
OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST | IPv6 Address List TLV. |
OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS | MAC Counters TLV. |
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL | Battery Level TLV. |
OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE | Supply Voltage TLV. |
OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE | Child Table TLV. |
OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES | Channel Pages TLV. |
OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST | Type List TLV. |
OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT | Max Child Timeout TLV. |
OT_NETWORK_DIAGNOSTIC_TLV_VERSION | Version TLV. |
OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME | Vendor Name TLV. |
OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL | Vendor Model TLV. |
OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION | Vendor SW Version TLV. |
OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION | Thread Stack Version TLV. |
67
of file include/openthread/netdiag.h
otDeviceRole#
otDeviceRole
Represents a Thread device role.
Enumerator | |
---|---|
OT_DEVICE_ROLE_DISABLED | The Thread stack is disabled. |
OT_DEVICE_ROLE_DETACHED | Not currently participating in a Thread network/partition. |
OT_DEVICE_ROLE_CHILD | The Thread Child role. |
OT_DEVICE_ROLE_ROUTER | The Thread Router role. |
OT_DEVICE_ROLE_LEADER | The Thread Leader role. |
67
of file include/openthread/thread.h
Typedef Documentation#
otNetworkDataIterator#
typedef uint32_t otNetworkDataIterator
Used to iterate through Network Data information.
53
of file include/openthread/netdata.h
otBorderRouterConfig#
typedef struct otBorderRouterConfig otBorderRouterConfig
This structure represents a Border Router configuration.
72
of file include/openthread/netdata.h
otLowpanContextInfo#
typedef struct otLowpanContextInfo otLowpanContextInfo
This structure represents 6LoWPAN Context ID information associated with a prefix in Network Data.
83
of file include/openthread/netdata.h
otExternalRouteConfig#
typedef struct otExternalRouteConfig otExternalRouteConfig
This structure represents an External Route configuration.
97
of file include/openthread/netdata.h
otRoutePreference#
typedef enum otRoutePreference otRoutePreference
Defines valid values for mPreference
in otExternalRouteConfig
and otBorderRouterConfig
.
108
of file include/openthread/netdata.h
otServerConfig#
typedef struct otServerConfig otServerConfig
This structure represents a Server configuration.
123
of file include/openthread/netdata.h
otServiceConfig#
typedef struct otServiceConfig otServiceConfig
This structure represents a Service configuration.
136
of file include/openthread/netdata.h
otNetDataPublisherEvent#
typedef enum otNetDataPublisherEvent otNetDataPublisherEvent
This enumeration represents the events reported from the Publisher callbacks.
65
of file include/openthread/netdata_publisher.h
otNetDataDnsSrpServicePublisherCallback#
typedef void(* otNetDataDnsSrpServicePublisherCallback) (otNetDataPublisherEvent aEvent, void *aContext) )(otNetDataPublisherEvent aEvent, void *aContext)
This function pointer type defines the callback used to notify when a "DNS/SRP Service" entry is added to or removed from the Thread Network Data.
[in] | aEvent | Indicates the event (whether the entry was added or removed). |
[in] | aContext | A pointer to application-specific context. |
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()
).
79
of file include/openthread/netdata_publisher.h
otNetDataPrefixPublisherCallback#
typedef void(* otNetDataPrefixPublisherCallback) (otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) )(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)
This function 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.
[in] | aEvent | Indicates the event (whether the entry was added or removed). |
[in] | aPrefix | A pointer to the prefix entry. |
[in] | aContext | A pointer to application-specific context. |
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.
93
of file include/openthread/netdata_publisher.h
otNetworkDiagIterator#
typedef uint16_t otNetworkDiagIterator
Used to iterate through Network Diagnostic TLV.
97
of file include/openthread/netdiag.h
otNetworkDiagConnectivity#
typedef struct otNetworkDiagConnectivity otNetworkDiagConnectivity
This structure represents a Network Diagnostic Connectivity value.
149
of file include/openthread/netdiag.h
otNetworkDiagRouteData#
typedef struct otNetworkDiagRouteData otNetworkDiagRouteData
This structure represents a Network Diagnostic Route data.
161
of file include/openthread/netdiag.h
otNetworkDiagRoute#
typedef struct otNetworkDiagRoute otNetworkDiagRoute
This structure represents a Network Diagnostic Route TLV value.
183
of file include/openthread/netdiag.h
otNetworkDiagMacCounters#
typedef struct otNetworkDiagMacCounters otNetworkDiagMacCounters
This structure represents a Network Diagnostic Mac Counters value.
See RFC 2863 for definitions of member fields.
202
of file include/openthread/netdiag.h
otNetworkDiagChildEntry#
typedef struct otNetworkDiagChildEntry otNetworkDiagChildEntry
This structure represents a Network Diagnostic Child Table Entry.
232
of file include/openthread/netdiag.h
otNetworkDiagTlv#
typedef struct otNetworkDiagTlv otNetworkDiagTlv
This structure represents a Network Diagnostic TLV.
285
of file include/openthread/netdiag.h
otReceiveDiagnosticGetCallback#
typedef void(* otReceiveDiagnosticGetCallback) (otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) )(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)
This function pointer is called when Network Diagnostic Get response is received.
[in] | aError | The error when failed to get the response. |
[in] | aMessage | A pointer to the message buffer containing the received Network Diagnostic Get response payload. Available only when |
[in] | aMessageInfo | A pointer to the message info for |
[in] | aContext | A pointer to application-specific context. |
319
of file include/openthread/netdiag.h
otLinkModeConfig#
typedef struct otLinkModeConfig otLinkModeConfig
This structure represents an MLE Link Mode configuration.
84
of file include/openthread/thread.h
otNeighborInfoIterator#
typedef int16_t otNeighborInfoIterator
Used to iterate through neighbor table.
113
of file include/openthread/thread.h
otLeaderData#
typedef struct otLeaderData otLeaderData
This structure represents the Thread Leader Data.
126
of file include/openthread/thread.h
otIpCounters#
typedef struct otIpCounters otIpCounters
This structure represents the IP level counters.
164
of file include/openthread/thread.h
otMleCounters#
typedef struct otMleCounters otMleCounters
This structure represents the Thread MLE counters.
203
of file include/openthread/thread.h
otThreadParentResponseInfo#
typedef struct otThreadParentResponseInfo otThreadParentResponseInfo
This structure represents the MLE Parent Response data.
219
of file include/openthread/thread.h
otDetachGracefullyCallback#
typedef void(* otDetachGracefullyCallback) (void *aContext) )(void *aContext)
This callback informs the application that the detaching process has finished.
[in] | aContext | A pointer to application-specific context. |
227
of file include/openthread/thread.h
otThreadParentResponseCallback#
typedef void(* otThreadParentResponseCallback) (otThreadParentResponseInfo *aInfo, void *aContext) )(otThreadParentResponseInfo *aInfo, void *aContext)
This function pointer is called every time an MLE Parent Response message is received.
[in] | aInfo | A pointer to a location on stack holding the stats data. |
[in] | aContext | A pointer to callback client-specific context. |
This is used in otThreadRegisterParentResponseCallback()
.
932
of file include/openthread/thread.h
otThreadDiscoveryRequestInfo#
typedef struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo
This structure represents the Thread Discovery Request data.
957
of file include/openthread/thread.h
otThreadDiscoveryRequestCallback#
typedef void(* otThreadDiscoveryRequestCallback) (const otThreadDiscoveryRequestInfo *aInfo, void *aContext) )(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)
This function pointer is called every time an MLE Discovery Request message is received.
[in] | aInfo | A pointer to the Discovery Request info data. |
[in] | aContext | A pointer to callback application-specific context. |
966
of file include/openthread/thread.h
otThreadAnycastLocatorCallback#
typedef void(* otThreadAnycastLocatorCallback) (void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) )(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)
This function pointer type defines the callback to notify the outcome of a otThreadLocateAnycastDestination()
request.
[in] | aContext | A pointer to an arbitrary context (provided when callback is registered). |
[in] | aError | The error when handling the request. OT_ERROR_NONE indicates success. OT_ERROR_RESPONSE_TIMEOUT indicates a destination could not be found. OT_ERROR_ABORT indicates the request was aborted. |
[in] | aMeshLocalAddress | A pointer to the mesh-local EID of the closest destination of the anycast address when |
[in] | aRloc16 | The RLOC16 of the destination if found, otherwise invalid RLOC16 (0xfffe). |
993
of file include/openthread/thread.h
Function Documentation#
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.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aStable | TRUE when copying the stable version, FALSE when copying the full version. |
[out] | aData | A pointer to the data buffer. |
[inout] | aDataLength | On entry, size of the data buffer pointed to by |
151
of file include/openthread/netdata.h
otNetDataGetLength#
uint8_t otNetDataGetLength (otInstance * aInstance)
Get the current length (number of bytes) of Partition's Thread Network Data.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
The length of the Network Data.
161
of file include/openthread/netdata.h
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()
.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
The maximum length of the Network Data (high water mark for Network Data length).
172
of file include/openthread/netdata.h
otNetDataResetMaxLength#
void otNetDataResetMaxLength (otInstance * aInstance)
Reset the tracked maximum length of the Thread Network Data.
[in] | aInstance | A pointer to an OpenThread instance. |
See Also
182
of file include/openthread/netdata.h
otNetDataGetNextOnMeshPrefix#
otError otNetDataGetNextOnMeshPrefix (otInstance * aInstance, otNetworkDataIterator * aIterator, otBorderRouterConfig * aConfig)
Get the next On Mesh Prefix in the partition's Network Data.
[in] | aInstance | A pointer to an OpenThread instance. |
[inout] | aIterator | A pointer to the Network Data iterator context. To get the first on-mesh entry it should be set to OT_NETWORK_DATA_ITERATOR_INIT. |
[out] | aConfig | A pointer to where the On Mesh Prefix information will be placed. |
196
of file include/openthread/netdata.h
otNetDataGetNextRoute#
otError otNetDataGetNextRoute (otInstance * aInstance, otNetworkDataIterator * aIterator, otExternalRouteConfig * aConfig)
Get the next external route in the partition's Network Data.
[in] | aInstance | A pointer to an OpenThread instance. |
[inout] | aIterator | A pointer to the Network Data iterator context. To get the first external route entry it should be set to OT_NETWORK_DATA_ITERATOR_INIT. |
[out] | aConfig | A pointer to where the External Route information will be placed. |
212
of file include/openthread/netdata.h
otNetDataGetNextService#
otError otNetDataGetNextService (otInstance * aInstance, otNetworkDataIterator * aIterator, otServiceConfig * aConfig)
Get the next service in the partition's Network Data.
[in] | aInstance | A pointer to an OpenThread instance. |
[inout] | aIterator | A pointer to the Network Data iterator context. To get the first service entry it should be set to OT_NETWORK_DATA_ITERATOR_INIT. |
[out] | aConfig | A pointer to where the service information will be placed. |
226
of file include/openthread/netdata.h
otNetDataGetNextLowpanContextInfo#
otError otNetDataGetNextLowpanContextInfo (otInstance * aInstance, otNetworkDataIterator * aIterator, otLowpanContextInfo * aContextInfo)
Get the next 6LoWPAN Context ID info in the partition's Network Data.
[in] | aInstance | A pointer to an OpenThread instance. |
[inout] | aIterator | A pointer to the Network Data iterator. To get the first service entry it should be set to OT_NETWORK_DATA_ITERATOR_INIT. |
[out] | aContextInfo | A pointer to where the retrieved 6LoWPAN Context ID information will be placed. |
240
of file include/openthread/netdata.h
otNetDataGetVersion#
uint8_t otNetDataGetVersion (otInstance * aInstance)
Get the Network Data Version.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
The Network Data Version.
252
of file include/openthread/netdata.h
otNetDataGetStableVersion#
uint8_t otNetDataGetStableVersion (otInstance * aInstance)
Get the Stable Network Data Version.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
The Stable Network Data Version.
262
of file include/openthread/netdata.h
otNetDataSteeringDataCheckJoiner#
otError otNetDataSteeringDataCheckJoiner (otInstance * aInstance, const otExtAddress * aEui64)
Check if the steering data includes a Joiner.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aEui64 | A pointer to the Joiner's IEEE EUI-64. |
275
of file include/openthread/netdata.h
otNetDataSteeringDataCheckJoinerWithDiscerner#
otError otNetDataSteeringDataCheckJoinerWithDiscerner (otInstance * aInstance, const struct otJoinerDiscerner * aDiscerner)
Check if the steering data includes a Joiner with a given discerner value.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aDiscerner | A pointer to the Joiner Discerner. |
291
of file include/openthread/netdata.h
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.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aPrefix | A pointer to the IPv6 prefix. |
Returns
Whether
aPrefix
is a valid OMR prefix and Leader's Network Data contains the OMR prefixaPrefix
.
Note
This API is only available when
OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE
is used.
305
of file include/openthread/netdata.h
otNetDataPublishDnsSrpServiceAnycast#
void otNetDataPublishDnsSrpServiceAnycast (otInstance * aInstance, uint8_t aSequenceNUmber)
This function requests "DNS/SRP Service Anycast Address" to be published in the Thread Network Data.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aSequenceNUmber | The sequence number of DNS/SRP Anycast Service. |
This function 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).
109
of file include/openthread/netdata_publisher.h
otNetDataPublishDnsSrpServiceUnicast#
void otNetDataPublishDnsSrpServiceUnicast (otInstance * aInstance, const otIp6Address * aAddress, uint16_t aPort)
This function requests "DNS/SRP Service Unicast Address" to be published in the Thread Network Data.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aAddress | The DNS/SRP server address to publish (MUST NOT be NULL). |
[in] | aPort | The SRP server port number to publish. |
This function 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).
This function publishes the "DNS/SRP Service Unicast Address" by including the address and port info in the Service TLV data.
127
of file include/openthread/netdata_publisher.h
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid#
void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid (otInstance * aInstance, uint16_t aPort)
This function requests "DNS/SRP Service Unicast Address" to be published in the Thread Network Data.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aPort | The SRP server port number to publish. |
This function 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.
145
of file include/openthread/netdata_publisher.h
otNetDataIsDnsSrpServiceAdded#
bool otNetDataIsDnsSrpServiceAdded (otInstance * aInstance)
This function indicates whether or not currently the "DNS/SRP Service" entry is added to the Thread Network Data.
[in] | aInstance | A pointer to an OpenThread instance. |
This function requires the feature OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
to be enabled.
158
of file include/openthread/netdata_publisher.h
otNetDataSetDnsSrpServicePublisherCallback#
void otNetDataSetDnsSrpServicePublisherCallback (otInstance * aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void * aContext)
This function sets a callback for notifying when a published "DNS/SRP Service" is actually added to or removed from the Thread Network Data.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aCallback | The callback function pointer (can be NULL if not needed). |
[in] | aContext | A pointer to application-specific context (used when |
A subsequent call to this function replaces any previously set callback function.
This function requires the feature OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
to be enabled.
173
of file include/openthread/netdata_publisher.h
otNetDataUnpublishDnsSrpService#
void otNetDataUnpublishDnsSrpService (otInstance * aInstance)
Unpublishes any previously added DNS/SRP (Anycast or Unicast) Service entry from the Thread Network Data.
[in] | aInstance | A pointer to an OpenThread instance. |
OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
must be enabled.
186
of file include/openthread/netdata_publisher.h
otNetDataPublishOnMeshPrefix#
otError otNetDataPublishOnMeshPrefix (otInstance * aInstance, const otBorderRouterConfig * aConfig)
This function requests an on-mesh prefix to be published in the Thread Network Data.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aConfig | The on-mesh prefix config to publish (MUST NOT be NULL). |
This function 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.
213
of file include/openthread/netdata_publisher.h
otNetDataPublishExternalRoute#
otError otNetDataPublishExternalRoute (otInstance * aInstance, const otExternalRouteConfig * aConfig)
This function requests an external route prefix to be published in the Thread Network Data.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aConfig | The external route config to publish (MUST NOT be NULL). |
This function 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.
238
of file include/openthread/netdata_publisher.h
otNetDataReplacePublishedExternalRoute#
otError otNetDataReplacePublishedExternalRoute (otInstance * aInstance, const otIp6Prefix * aPrefix, const otExternalRouteConfig * aConfig)
This function replaces a previously published external route in the Thread Network Data.
[in] | aInstance | The previously published external route prefix to replace. |
[in] | aPrefix | The external route config to publish. |
[in] | aConfig | The requester ( |
This function 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 inaConfig
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 newaConfig
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).
272
of file include/openthread/netdata_publisher.h
otNetDataIsPrefixAdded#
bool otNetDataIsPrefixAdded (otInstance * aInstance, const otIp6Prefix * aPrefix)
This function indicates whether or not currently a published prefix entry (on-mesh or external route) is added to the Thread Network Data.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aPrefix | A pointer to the prefix (MUST NOT be NULL). |
This function requires the feature OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
to be enabled.
289
of file include/openthread/netdata_publisher.h
otNetDataSetPrefixPublisherCallback#
void otNetDataSetPrefixPublisherCallback (otInstance * aInstance, otNetDataPrefixPublisherCallback aCallback, void * aContext)
This function sets a callback for notifying when a published prefix entry is actually added to or removed from the Thread Network Data.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aCallback | The callback function pointer (can be NULL if not needed). |
[in] | aContext | A pointer to application-specific context (used when |
A subsequent call to this function replaces any previously set callback function.
This function requires the feature OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
to be enabled.
304
of file include/openthread/netdata_publisher.h
otNetDataUnpublishPrefix#
otError otNetDataUnpublishPrefix (otInstance * aInstance, const otIp6Prefix * aPrefix)
Unpublishes a previously published On-Mesh or External Route Prefix.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aPrefix | The prefix to unpublish (MUST NOT be NULL). |
OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
must be enabled.
320
of file include/openthread/netdata_publisher.h
otThreadGetNextDiagnosticTlv#
otError otThreadGetNextDiagnosticTlv (const otMessage * aMessage, otNetworkDiagIterator * aIterator, otNetworkDiagTlv * aNetworkDiagTlv)
This function gets the next Network Diagnostic TLV in the message.
[in] | aMessage | A pointer to a message. |
[inout] | aIterator | A pointer to the Network Diagnostic iterator context. To get the first Network Diagnostic TLV it should be set to OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT. |
[out] | aNetworkDiagTlv | A pointer to where the Network Diagnostic TLV information will be placed. |
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.
304
of file include/openthread/netdiag.h
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.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aDestination | A pointer to destination address. |
[in] | aTlvTypes | An array of Network Diagnostic TLV types. |
[in] | aCount | Number of types in aTlvTypes. |
[in] | aCallback | A pointer to a function that is called when Network Diagnostic Get response is received or NULL to disable the callback. |
[in] | aCallbackContext | A pointer to application-specific context. |
Requires OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE
.
341
of file include/openthread/netdiag.h
otThreadSendDiagnosticReset#
otError otThreadSendDiagnosticReset (otInstance * aInstance, const otIp6Address * aDestination, const uint8_t aTlvTypes, uint8_t aCount)
Send a Network Diagnostic Reset request.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aDestination | A pointer to destination address. |
[in] | aTlvTypes | An array of Network Diagnostic TLV types. Currently only Type 9 is allowed. |
[in] | aCount | Number of types in aTlvTypes |
Requires OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE
.
362
of file include/openthread/netdiag.h
otThreadGetVendorName#
const char * otThreadGetVendorName (otInstance * aInstance)
Get the vendor name string.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
The vendor name string.
375
of file include/openthread/netdiag.h
otThreadGetVendorModel#
const char * otThreadGetVendorModel (otInstance * aInstance)
Get the vendor model string.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
The vendor model string.
385
of file include/openthread/netdiag.h
otThreadGetVendorSwVersion#
const char * otThreadGetVendorSwVersion (otInstance * aInstance)
Get the vendor sw version string.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
The vendor sw version string.
395
of file include/openthread/netdiag.h
otThreadSetVendorName#
otError otThreadSetVendorName (otInstance * aInstance, const char * aVendorName)
Set the vendor name string.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aVendorName | 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.
412
of file include/openthread/netdiag.h
otThreadSetVendorModel#
otError otThreadSetVendorModel (otInstance * aInstance, const char * aVendorModel)
Set the vendor model string.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aVendorModel | 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.
429
of file include/openthread/netdiag.h
otThreadSetVendorSwVersion#
otError otThreadSetVendorSwVersion (otInstance * aInstance, const char * aVendorSwVersion)
Set the vendor software version string.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aVendorSwVersion | 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.
446
of file include/openthread/netdiag.h
otThreadSetEnabled#
otError otThreadSetEnabled (otInstance * aInstance, bool aEnabled)
This function starts Thread protocol operation.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aEnabled | TRUE if Thread is enabled, FALSE otherwise. |
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.
244
of file include/openthread/thread.h
otThreadGetVersion#
uint16_t otThreadGetVersion (void )
This function gets the Thread protocol version.
N/A |
Returns
the Thread protocol version.
252
of file include/openthread/thread.h
otThreadIsSingleton#
bool otThreadIsSingleton (otInstance * aInstance)
This function indicates whether a node is the only router on the network.
[in] | aInstance | A pointer to an OpenThread instance. |
263
of file include/openthread/thread.h
otThreadDiscover#
otError otThreadDiscover (otInstance * aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void * aCallbackContext)
This function starts a Thread Discovery scan.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aScanChannels | A bit vector indicating which channels to scan (e.g. OT_CHANNEL_11_MASK). |
[in] | aPanId | The PAN ID filter (set to Broadcast PAN to disable filter). |
[in] | aJoiner | Value of the Joiner Flag in the Discovery Request TLV. |
[in] | aEnableEui64Filtering | TRUE to filter responses on EUI-64, FALSE otherwise. |
[in] | aCallback | A pointer to a function called on receiving an MLE Discovery Response or scan completes. |
[in] | aCallbackContext | A pointer to application-specific context. |
Note
A successful call to this function enables the rx-on-when-idle mode for the entire scan procedure.
285
of file include/openthread/thread.h
otThreadIsDiscoverInProgress#
bool otThreadIsDiscoverInProgress (otInstance * aInstance)
This function determines if an MLE Thread Discovery is currently in progress.
[in] | aInstance | A pointer to an OpenThread instance. |
299
of file include/openthread/thread.h
otThreadSetJoinerAdvertisement#
otError otThreadSetJoinerAdvertisement (otInstance * aInstance, uint32_t aOui, const uint8_t * aAdvData, uint8_t aAdvDataLength)
This method sets the Thread Joiner Advertisement when discovering Thread network.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aOui | The Vendor IEEE OUI value that will be included in the Joiner Advertisement. Only the least significant 3 bytes will be used, and the most significant byte will be ignored. |
[in] | aAdvData | A pointer to the AdvData that will be included in the Joiner Advertisement. |
[in] | aAdvDataLength | The length of AdvData in bytes. |
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.
318
of file include/openthread/thread.h
otThreadGetChildTimeout#
uint32_t otThreadGetChildTimeout (otInstance * aInstance)
Gets the Thread Child Timeout (in seconds) used when operating in the Child role.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
The Thread Child Timeout value in seconds.
See Also
335
of file include/openthread/thread.h
otThreadSetChildTimeout#
void otThreadSetChildTimeout (otInstance * aInstance, uint32_t aTimeout)
Sets the Thread Child Timeout (in seconds) used when operating in the Child role.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aTimeout | The timeout value in seconds. |
See Also
346
of file include/openthread/thread.h
otThreadGetExtendedPanId#
const otExtendedPanId * otThreadGetExtendedPanId (otInstance * aInstance)
Gets the IEEE 802.15.4 Extended PAN ID.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
A pointer to the IEEE 802.15.4 Extended PAN ID.
See Also
358
of file include/openthread/thread.h
otThreadSetExtendedPanId#
otError otThreadSetExtendedPanId (otInstance * aInstance, const otExtendedPanId * aExtendedPanId)
Sets the IEEE 802.15.4 Extended PAN ID.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aExtendedPanId | A pointer to 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
376
of file include/openthread/thread.h
otThreadGetLeaderRloc#
otError otThreadGetLeaderRloc (otInstance * aInstance, otIp6Address * aLeaderRloc)
This function returns a pointer to the Leader's RLOC.
[in] | aInstance | A pointer to an OpenThread instance. |
[out] | aLeaderRloc | A pointer to the Leader's RLOC. |
389
of file include/openthread/thread.h
otThreadGetLinkMode#
otLinkModeConfig otThreadGetLinkMode (otInstance * aInstance)
Get the MLE Link Mode configuration.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
The MLE Link Mode configuration.
See Also
401
of file include/openthread/thread.h
otThreadSetLinkMode#
otError otThreadSetLinkMode (otInstance * aInstance, otLinkModeConfig aConfig)
Set the MLE Link Mode configuration.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aConfig | A pointer to the Link Mode configuration. |
See Also
414
of file include/openthread/thread.h
otThreadGetNetworkKey#
void otThreadGetNetworkKey (otInstance * aInstance, otNetworkKey * aNetworkKey)
Get the Thread Network Key.
[in] | aInstance | A pointer to an OpenThread instance. |
[out] | aNetworkKey | A pointer to an |
See Also
425
of file include/openthread/thread.h
otThreadGetNetworkKeyRef#
otNetworkKeyRef otThreadGetNetworkKeyRef (otInstance * aInstance)
Get the otNetworkKeyRef
for Thread Network Key.
[in] | aInstance | A pointer to an OpenThread instance. |
This function 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
439
of file include/openthread/thread.h
otThreadSetNetworkKey#
otError otThreadSetNetworkKey (otInstance * aInstance, const otNetworkKey * aKey)
Set the Thread Network Key.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aKey | A pointer to a buffer containing the Thread Network Key. |
This function 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
457
of file include/openthread/thread.h
otThreadSetNetworkKeyRef#
otError otThreadSetNetworkKeyRef (otInstance * aInstance, otNetworkKeyRef aKeyRef)
Set the Thread Network Key as a otNetworkKeyRef
.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aKeyRef | Reference to the Thread Network Key. |
This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.
This function requires the build-time feature OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
to be enabled.
See Also
477
of file include/openthread/thread.h
otThreadGetRloc#
const otIp6Address * otThreadGetRloc (otInstance * aInstance)
Gets the Thread Routing Locator (RLOC) address.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
A pointer to the Thread Routing Locator (RLOC) address.
487
of file include/openthread/thread.h
otThreadGetMeshLocalEid#
const otIp6Address * otThreadGetMeshLocalEid (otInstance * aInstance)
Gets the Mesh Local EID address.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
A pointer to the Mesh Local EID address.
497
of file include/openthread/thread.h
otThreadGetMeshLocalPrefix#
const otMeshLocalPrefix * otThreadGetMeshLocalPrefix (otInstance * aInstance)
This function returns a pointer to the Mesh Local Prefix.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
A pointer to the Mesh Local Prefix.
507
of file include/openthread/thread.h
otThreadSetMeshLocalPrefix#
otError otThreadSetMeshLocalPrefix (otInstance * aInstance, const otMeshLocalPrefix * aMeshLocalPrefix)
This function sets the Mesh Local Prefix.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aMeshLocalPrefix | A pointer to the Mesh Local Prefix. |
This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.
523
of file include/openthread/thread.h
otThreadGetLinkLocalIp6Address#
const otIp6Address * otThreadGetLinkLocalIp6Address (otInstance * aInstance)
Gets the Thread link-local IPv6 address.
[in] | aInstance | A pointer to an OpenThread instance. |
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.
535
of file include/openthread/thread.h
otThreadGetLinkLocalAllThreadNodesMulticastAddress#
const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress (otInstance * aInstance)
Gets the Thread Link-Local All Thread Nodes multicast address.
[in] | aInstance | A pointer to an OpenThread instance. |
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.
552
of file include/openthread/thread.h
otThreadGetRealmLocalAllThreadNodesMulticastAddress#
const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress (otInstance * aInstance)
Gets the Thread Realm-Local All Thread Nodes multicast address.
[in] | aInstance | A pointer to an OpenThread instance. |
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.
569
of file include/openthread/thread.h
otThreadGetServiceAloc#
otError otThreadGetServiceAloc (otInstance * aInstance, uint8_t aServiceId, otIp6Address * aServiceAloc)
This function retrieves the Service ALOC for given Service ID.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aServiceId | Service ID to get ALOC for. |
[out] | aServiceAloc | A pointer to output the Service ALOC. MUST NOT BE NULL. |
581
of file include/openthread/thread.h
otThreadGetNetworkName#
const char * otThreadGetNetworkName (otInstance * aInstance)
Get the Thread Network Name.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
A pointer to the Thread Network Name.
See Also
593
of file include/openthread/thread.h
otThreadSetNetworkName#
otError otThreadSetNetworkName (otInstance * aInstance, const char * aNetworkName)
Set the Thread Network Name.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aNetworkName | A pointer to the Thread Network Name. |
This function 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
611
of file include/openthread/thread.h
otThreadGetDomainName#
const char * otThreadGetDomainName (otInstance * aInstance)
Gets the Thread Domain Name.
[in] | aInstance | A pointer to an OpenThread instance. |
Note
Available since Thread 1.2.
Returns
A pointer to the Thread Domain Name.
See Also
625
of file include/openthread/thread.h
otThreadSetDomainName#
otError otThreadSetDomainName (otInstance * aInstance, const char * aDomainName)
Sets the Thread Domain Name.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aDomainName | A pointer to the Thread Domain Name. |
Only succeeds when Thread protocols are disabled.
Note
Available since Thread 1.2.
See Also
641
of file include/openthread/thread.h
otThreadSetFixedDuaInterfaceIdentifier#
otError otThreadSetFixedDuaInterfaceIdentifier (otInstance * aInstance, const otIp6InterfaceIdentifier * aIid)
Sets or clears the Interface Identifier manually specified for the Thread Domain Unicast Address.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aIid | A pointer to the Interface Identifier to set or NULL to clear. |
Available when OPENTHREAD_CONFIG_DUA_ENABLE
is enabled.
Note
Only available since Thread 1.2.
See Also
658
of file include/openthread/thread.h
otThreadGetFixedDuaInterfaceIdentifier#
const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier (otInstance * aInstance)
Gets the Interface Identifier manually specified for the Thread Domain Unicast Address.
[in] | aInstance | A pointer to an OpenThread instance. |
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
674
of file include/openthread/thread.h
otThreadGetKeySequenceCounter#
uint32_t otThreadGetKeySequenceCounter (otInstance * aInstance)
Gets the thrKeySequenceCounter.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
The thrKeySequenceCounter value.
See Also
686
of file include/openthread/thread.h
otThreadSetKeySequenceCounter#
void otThreadSetKeySequenceCounter (otInstance * aInstance, uint32_t aKeySequenceCounter)
Sets the thrKeySequenceCounter.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aKeySequenceCounter | The thrKeySequenceCounter value. |
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
700
of file include/openthread/thread.h
otThreadGetKeySwitchGuardTime#
uint32_t otThreadGetKeySwitchGuardTime (otInstance * aInstance)
Gets the thrKeySwitchGuardTime (in hours).
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
The thrKeySwitchGuardTime value (in hours).
See Also
712
of file include/openthread/thread.h
otThreadSetKeySwitchGuardTime#
void otThreadSetKeySwitchGuardTime (otInstance * aInstance, uint32_t aKeySwitchGuardTime)
Sets the thrKeySwitchGuardTime (in hours).
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aKeySwitchGuardTime | The thrKeySwitchGuardTime value (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
726
of file include/openthread/thread.h
otThreadBecomeDetached#
otError otThreadBecomeDetached (otInstance * aInstance)
Detach from the Thread network.
[in] | aInstance | A pointer to an OpenThread instance. |
737
of file include/openthread/thread.h
otThreadBecomeChild#
otError otThreadBecomeChild (otInstance * aInstance)
Attempt to reattach as a child.
[in] | aInstance | A pointer to an OpenThread instance. |
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.
751
of file include/openthread/thread.h
otThreadGetNextNeighborInfo#
otError otThreadGetNextNeighborInfo (otInstance * aInstance, otNeighborInfoIterator * aIterator, otNeighborInfo * aInfo)
This function gets the next neighbor information.
[in] | aInstance | A pointer to an OpenThread instance. |
[inout] | aIterator | A pointer to the iterator context. To get the first neighbor entry it should be set to OT_NEIGHBOR_INFO_ITERATOR_INIT. |
[out] | aInfo | A pointer to the neighbor information. |
It is used to go through the entries of the neighbor table.
767
of file include/openthread/thread.h
otThreadGetDeviceRole#
otDeviceRole otThreadGetDeviceRole (otInstance * aInstance)
Get the device role.
[in] | aInstance | A pointer to an OpenThread instance. |
781
of file include/openthread/thread.h
otThreadDeviceRoleToString#
const char * otThreadDeviceRoleToString (otDeviceRole aRole)
Convert the device role to human-readable string.
[in] | aRole | The device role to convert. |
Returns
A string representing
aRole
.
791
of file include/openthread/thread.h
otThreadGetLeaderData#
otError otThreadGetLeaderData (otInstance * aInstance, otLeaderData * aLeaderData)
This function get the Thread Leader Data.
[in] | aInstance | A pointer to an OpenThread instance. |
[out] | aLeaderData | A pointer to where the leader data is placed. |
803
of file include/openthread/thread.h
otThreadGetLeaderRouterId#
uint8_t otThreadGetLeaderRouterId (otInstance * aInstance)
Get the Leader's Router ID.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
The Leader's Router ID.
813
of file include/openthread/thread.h
otThreadGetLeaderWeight#
uint8_t otThreadGetLeaderWeight (otInstance * aInstance)
Get the Leader's Weight.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
The Leader's Weight.
823
of file include/openthread/thread.h
otThreadGetPartitionId#
uint32_t otThreadGetPartitionId (otInstance * aInstance)
Get the Partition ID.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
The Partition ID.
833
of file include/openthread/thread.h
otThreadGetRloc16#
uint16_t otThreadGetRloc16 (otInstance * aInstance)
Get the RLOC16.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
The RLOC16.
843
of file include/openthread/thread.h
otThreadGetParentInfo#
otError otThreadGetParentInfo (otInstance * aInstance, otRouterInfo * aParentInfo)
The function retrieves diagnostic information for a Thread Router as parent.
[in] | aInstance | A pointer to an OpenThread instance. |
[out] | aParentInfo | A pointer to where the parent router information is placed. |
852
of file include/openthread/thread.h
otThreadGetParentAverageRssi#
otError otThreadGetParentAverageRssi (otInstance * aInstance, int8_t * aParentRssi)
The function retrieves the average RSSI for the Thread Parent.
[in] | aInstance | A pointer to an OpenThread instance. |
[out] | aParentRssi | A pointer to where the parent RSSI should be placed. |
861
of file include/openthread/thread.h
otThreadGetParentLastRssi#
otError otThreadGetParentLastRssi (otInstance * aInstance, int8_t * aLastRssi)
The function retrieves the RSSI of the last packet from the Thread Parent.
[in] | aInstance | A pointer to an OpenThread instance. |
[out] | aLastRssi | A pointer to where the last RSSI should be placed. |
874
of file include/openthread/thread.h
otThreadSearchForBetterParent#
otError otThreadSearchForBetterParent (otInstance * aInstance)
Starts the process for child to search for a better parent while staying attached to its current parent.
N/A | aInstance |
Must be used when device is attached as a child.
885
of file include/openthread/thread.h
otThreadGetIp6Counters#
const otIpCounters * otThreadGetIp6Counters (otInstance * aInstance)
Gets the IPv6 counters.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
A pointer to the IPv6 counters.
895
of file include/openthread/thread.h
otThreadResetIp6Counters#
void otThreadResetIp6Counters (otInstance * aInstance)
Resets the IPv6 counters.
[in] | aInstance | A pointer to an OpenThread instance. |
903
of file include/openthread/thread.h
otThreadGetMleCounters#
const otMleCounters * otThreadGetMleCounters (otInstance * aInstance)
Gets the Thread MLE counters.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
A pointer to the Thread MLE counters.
913
of file include/openthread/thread.h
otThreadResetMleCounters#
void otThreadResetMleCounters (otInstance * aInstance)
Resets the Thread MLE counters.
[in] | aInstance | A pointer to an OpenThread instance. |
921
of file include/openthread/thread.h
otThreadRegisterParentResponseCallback#
void otThreadRegisterParentResponseCallback (otInstance * aInstance, otThreadParentResponseCallback aCallback, void * aContext)
This function registers a callback to receive MLE Parent Response data.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aCallback | A pointer to a function that is called upon receiving an MLE Parent Response message. |
[in] | aContext | A pointer to callback client-specific context. |
This function requires OPENTHREAD_CONFIG_MLE_PARENT_RESPONSE_CALLBACK_API_ENABLE
.
944
of file include/openthread/thread.h
otThreadSetDiscoveryRequestCallback#
void otThreadSetDiscoveryRequestCallback (otInstance * aInstance, otThreadDiscoveryRequestCallback aCallback, void * aContext)
This function sets a callback to receive MLE Discovery Request data.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aCallback | A pointer to a function that is called upon receiving an MLE Discovery Request message. |
[in] | aContext | A pointer to callback application-specific context. |
976
of file include/openthread/thread.h
otThreadLocateAnycastDestination#
otError otThreadLocateAnycastDestination (otInstance * aInstance, const otIp6Address * aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void * aContext)
This function requests the closest destination of a given anycast address to be located.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aAnycastAddress | The anycast address to locate. MUST NOT be NULL. |
[in] | aCallback | The callback function to report the result. |
[in] | aContext | An arbitrary context used with |
This function 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.
1015
of file include/openthread/thread.h
otThreadIsAnycastLocateInProgress#
bool otThreadIsAnycastLocateInProgress (otInstance * aInstance)
This function indicates whether an anycast locate request is currently in progress.
[in] | aInstance | A pointer to an OpenThread instance. |
This function 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.
1030
of file include/openthread/thread.h
otThreadSendAddressNotification#
void otThreadSendAddressNotification (otInstance * aInstance, otIp6Address * aDestination, otIp6Address * aTarget, otIp6InterfaceIdentifier * aMlIid)
This function sends a Proactive Address Notification (ADDR_NTF.ntf) message.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aDestination | The destination to send the ADDR_NTF.ntf message. |
[in] | aTarget | The target address of the ADDR_NTF.ntf message. |
[in] | aMlIid | The ML-IID of the ADDR_NTF.ntf message. |
This function is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
is enabled.
1043
of file include/openthread/thread.h
otThreadSendProactiveBackboneNotification#
otError otThreadSendProactiveBackboneNotification (otInstance * aInstance, otIp6Address * aTarget, otIp6InterfaceIdentifier * aMlIid, uint32_t aTimeSinceLastTransaction)
This function sends a Proactive Backbone Notification (PRO_BB.ntf) message on the Backbone link.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aTarget | The target address of the PRO_BB.ntf message. |
[in] | aMlIid | The ML-IID of the PRO_BB.ntf message. |
[in] | aTimeSinceLastTransaction | Time since last transaction (in seconds). |
This function is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
is enabled.
1062
of file include/openthread/thread.h
otThreadDetachGracefully#
otError otThreadDetachGracefully (otInstance * aInstance, otDetachGracefullyCallback aCallback, void * aContext)
This function notifies other nodes in the network (if any) and then stops Thread protocol operation.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aCallback | A pointer to a function that is called upon finishing detaching. |
[in] | aContext | A pointer to callback application-specific context. |
It sends an Address Release if it's a router, or sets its child timeout to 0 if it's a child.
1080
of file include/openthread/thread.h
otConvertDurationInSecondsToString#
void otConvertDurationInSecondsToString (uint32_t aDuration, char * aBuffer, uint16_t aSize)
This function converts an uint32_t
duration (in seconds) to a human-readable string.
[in] | aDuration | A duration interval in seconds. |
[out] | aBuffer | A pointer to a char array to output the string. |
[in] | aSize | The size of |
This function 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.
This function is intended for use with mAge
or mConnectionTime
in otNeighborInfo
or otChildInfo
structures.
1102
of file include/openthread/thread.h
Macro Definition Documentation#
OT_NETWORK_DATA_ITERATOR_INIT#
#define OT_NETWORK_DATA_ITERATOR_INITValue:
0
Value to initialize otNetworkDataIterator
.
51
of file include/openthread/netdata.h
OT_SERVICE_DATA_MAX_SIZE#
#define OT_SERVICE_DATA_MAX_SIZEValue:
252
Max size of Service Data in bytes.
110
of file include/openthread/netdata.h
OT_SERVER_DATA_MAX_SIZE#
#define OT_SERVER_DATA_MAX_SIZEValue:
248
Max size of Server Data in bytes. Theoretical limit, practically much lower.
111
of file include/openthread/netdata.h
OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES#
#define OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIESValue:
19
Maximum Number of Network Diagnostic TLV Types to Request or Reset.
55
of file include/openthread/netdiag.h
OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE#
#define OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZEValue:
3
Size of Network Diagnostic Child Table entry.
60
of file include/openthread/netdiag.h
OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT#
#define OT_NETWORK_DIAGNOSTIC_ITERATOR_INITValue:
0
Initializer for otNetworkDiagIterator.
65
of file include/openthread/netdiag.h
OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH#
#define OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTHValue:
32
Max length of Vendor Name TLV.
92
of file include/openthread/netdiag.h
OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH#
#define OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTHValue:
32
Max length of Vendor Model TLV.
93
of file include/openthread/netdiag.h
OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH#
#define OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTHValue:
16
Max length of Vendor SW Version TLV.
94
of file include/openthread/netdiag.h
OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH#
#define OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTHValue:
64
Max length of Thread Stack Version TLV.
95
of file include/openthread/netdiag.h
OT_NETWORK_BASE_TLV_MAX_LENGTH#
#define OT_NETWORK_BASE_TLV_MAX_LENGTHValue:
254
Maximum value length of Thread Base TLV.
59
of file include/openthread/thread.h
OT_NETWORK_MAX_ROUTER_ID#
#define OT_NETWORK_MAX_ROUTER_IDValue:
62
Maximum Router ID.
61
of file include/openthread/thread.h
OT_NEIGHBOR_INFO_ITERATOR_INIT#
#define OT_NEIGHBOR_INFO_ITERATOR_INITValue:
0
Initializer for otNeighborInfoIterator.
111
of file include/openthread/thread.h
OT_JOINER_ADVDATA_MAX_LENGTH#
#define OT_JOINER_ADVDATA_MAX_LENGTHValue:
64
Maximum AdvData Length of Joiner Advertisement.
323
of file include/openthread/thread.h
OT_DURATION_STRING_SIZE#
#define OT_DURATION_STRING_SIZEValue:
21
Recommended size for string representation of uint32_t
duration in seconds.
1082
of file include/openthread/thread.h