General
This module includes functions for all Thread roles.
Summary
Typedefs |
|
---|---|
otBorderRouterConfig
|
typedefstruct otBorderRouterConfig
This structure represents a Border Router configuration. |
otExternalRouteConfig
|
typedefstruct otExternalRouteConfig
This structure represents an External Route configuration. |
otIpCounters
|
typedefstruct otIpCounters
This structure represents the IP level counters. |
otLeaderData
|
typedefstruct otLeaderData
This structure represents the Thread Leader Data. |
otLinkModeConfig
|
typedefstruct otLinkModeConfig
This structure represents an MLE Link Mode configuration. |
otMleCounters
|
typedefstruct otMleCounters
This structure represents the Thread MLE counters. |
otNeighborInfoIterator
|
typedefint16_t
Used to iterate through neighbor table. |
otNetworkDataIterator
|
typedefuint32_t
Used to iterate through Network Data information. |
otNetworkDiagChildEntry
|
typedefstruct otNetworkDiagChildEntry
This structure represents a Network Diagnostic Child Table Entry. |
otNetworkDiagConnectivity
|
typedefstruct otNetworkDiagConnectivity
This structure represents a Network Diagnostic Connectivity value. |
otNetworkDiagIterator
|
typedefuint16_t
Used to iterate through Network Diagnostic TLV. |
otNetworkDiagMacCounters
|
typedefstruct otNetworkDiagMacCounters
This structure represents a Network Diagnostic Mac Counters value. |
otNetworkDiagRoute
|
typedefstruct otNetworkDiagRoute
This structure represents a Network Diagnostic Route TLV value. |
otNetworkDiagRouteData
|
typedefstruct otNetworkDiagRouteData
This structure represents a Network Diagnostic Route data. |
otNetworkDiagTlv
|
typedefstruct otNetworkDiagTlv
This structure represents a Network Diagnostic TLV. |
otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)
|
typedefvoid(*
This function pointer is called when Network Diagnostic Get response is received. |
otRoutePreference
|
typedefenum otRoutePreference
Defines valid values for member mPreference in otExternalRouteConfig and otBorderRouterConfig. |
otServerConfig
|
typedefstruct otServerConfig
This structure represents a Server configuration. |
otServiceConfig
|
typedefstruct otServiceConfig
This structure represents a Service configuration. |
otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)
|
typedefvoid(*
This function pointer is called every time an MLE Discovery Request message is received. |
otThreadDiscoveryRequestInfo
|
typedefstruct otThreadDiscoveryRequestInfo
This structure represents the Thread Discovery Request data. |
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)
|
typedefvoid(*
This function pointer is called every time an MLE Parent Response message is received. |
otThreadParentResponseInfo
|
typedefstruct otThreadParentResponseInfo
This structure represents the MLE Parent Response data. |
Functions |
|
---|---|
otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
|
This method provides a full or stable copy of the Partition's Thread Network Data.
|
otNetDataGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
|
This function gets the next On Mesh Prefix in the partition's Network Data.
|
otNetDataGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
|
This function gets the next external route in the partition's Network Data.
|
otNetDataGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
|
This function gets the next service in the partition's Network Data.
|
otNetDataGetStableVersion(otInstance *aInstance)
|
uint8_t
Get the Stable Network Data Version.
|
otNetDataGetVersion(otInstance *aInstance)
|
uint8_t
Get the Network Data Version.
|
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
|
Check if the steering data includes a Joiner.
|
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
|
Check if the steering data includes a Joiner with a given discerner value.
|
otThreadBecomeChild(otInstance *aInstance)
|
Attempt to reattach as a child.
|
otThreadBecomeDetached(otInstance *aInstance)
|
Detach from the Thread network.
|
otThreadDiscover(otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
|
This function starts a Thread Discovery scan.
|
otThreadGetChildTimeout(otInstance *aInstance)
|
uint32_t
Get the Thread Child Timeout used when operating in the Child role.
|
otThreadGetDeviceRole(otInstance *aInstance)
|
Get the device role.
|
otThreadGetDomainName(otInstance *aInstance)
|
const char *
Get the Thread Domain Name.
|
otThreadGetExtendedPanId(otInstance *aInstance)
|
const otExtendedPanId *
Get the IEEE 802.15.4 Extended PAN ID.
|
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
|
const otIp6InterfaceIdentifier *
Get the Interface Identifier manually specified for the Thread Domain Unicast Address.
|
otThreadGetIp6Counters(otInstance *aInstance)
|
const otIpCounters *
Get the IPv6 counters.
|
otThreadGetKeySequenceCounter(otInstance *aInstance)
|
uint32_t
Get the thrKeySequenceCounter.
|
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
|
uint32_t
Get the thrKeySwitchGuardTime.
|
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
|
This function get the Thread Leader Data.
|
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
|
This function returns a pointer to the Leader's RLOC.
|
otThreadGetLeaderRouterId(otInstance *aInstance)
|
uint8_t
Get the Leader's Router ID.
|
otThreadGetLeaderWeight(otInstance *aInstance)
|
uint8_t
Get the Leader's Weight.
|
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
|
const otIp6Address *
This function returns the Thread link-local IPv6 address.
|
otThreadGetLinkMode(otInstance *aInstance)
|
Get the MLE Link Mode configuration.
|
otThreadGetMasterKey(otInstance *aInstance)
|
const otMasterKey *
Get the thrMasterKey.
|
otThreadGetMeshLocalEid(otInstance *aInstance)
|
const otIp6Address *
This function returns a pointer to the Mesh Local EID address.
|
otThreadGetMeshLocalPrefix(otInstance *aInstance)
|
const otMeshLocalPrefix *
This function returns a pointer to the Mesh Local Prefix.
|
otThreadGetMleCounters(otInstance *aInstance)
|
const otMleCounters *
Get the Thread MLE counters.
|
otThreadGetNetworkName(otInstance *aInstance)
|
const char *
Get the Thread Network Name.
|
otThreadGetNextDiagnosticTlv(const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
|
This function gets the next Network Diagnostic TLV in the message.
|
otThreadGetNextNeighborInfo(otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
|
This function gets the next neighbor information.
|
otThreadGetParentAverageRssi(otInstance *aInstance, int8_t *aParentRssi)
|
The function retrieves the average RSSI for the Thread Parent.
|
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
|
The function retrieves diagnostic information for a Thread Router as parent.
|
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
|
The function retrieves the RSSI of the last packet from the Thread Parent.
|
otThreadGetPartitionId(otInstance *aInstance)
|
uint32_t
Get the Partition ID.
|
otThreadGetRloc(otInstance *aInstance)
|
const otIp6Address *
This function returns a pointer to the Thread Routing Locator (RLOC) address.
|
otThreadGetRloc16(otInstance *aInstance)
|
uint16_t
Get the RLOC16.
|
otThreadGetVersion(void)
|
uint16_t
This function gets the Thread protocol version.
|
otThreadIsDiscoverInProgress(otInstance *aInstance)
|
bool
This function determines if an MLE Thread Discovery is currently in progress.
|
otThreadIsSingleton(otInstance *aInstance)
|
bool
This function indicates whether a node is the only router on the network.
|
otThreadRegisterParentResponseCallback(otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
|
void
This function registers a callback to receive MLE Parent Response data.
|
otThreadResetIp6Counters(otInstance *aInstance)
|
void
Reset the IPv6 counters.
|
otThreadResetMleCounters(otInstance *aInstance)
|
void
Reset the Thread MLE counters.
|
otThreadSendAddressNotification(otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
|
void
This function sends a Proactive Address Notification (ADDR_NTF.ntf) message.
|
otThreadSendDiagnosticGet(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
|
Send a Network Diagnostic Get request.
|
otThreadSendDiagnosticReset(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
|
Send a Network Diagnostic Reset request.
|
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.
|
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
|
void
Set the Thread Child Timeout used when operating in the Child role.
|
otThreadSetDiscoveryRequestCallback(otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
|
void
This function sets a callback to receive MLE Discovery Request data.
|
otThreadSetDomainName(otInstance *aInstance, const char *aDomainName)
|
Set the Thread Domain Name.
|
otThreadSetEnabled(otInstance *aInstance, bool aEnabled)
|
This function starts Thread protocol operation.
|
otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
|
Set the IEEE 802.15.4 Extended PAN ID.
|
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
|
Set/Clear the Interface Identifier manually specified for the Thread Domain Unicast Address.
|
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
|
This method sets the Thread Joiner Advertisement when discovering Thread network.
|
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
|
void
Set the thrKeySequenceCounter.
|
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
|
void
Set the thrKeySwitchGuardTime.
|
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
|
Set the MLE Link Mode configuration.
|
otThreadSetMasterKey(otInstance *aInstance, const otMasterKey *aKey)
|
Set the thrMasterKey.
|
otThreadSetMeshLocalPrefix(otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
|
This function sets the Mesh Local Prefix.
|
otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName)
|
Set the Thread Network Name.
|
otThreadSetReceiveDiagnosticGetCallback(otInstance *aInstance, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
|
void
This function registers a callback to provide received raw Network Diagnostic Get response payload.
|
Structs |
|
---|---|
otBorderRouterConfig |
This structure represents a Border Router configuration. |
otExternalRouteConfig |
This structure represents an External Route configuration. |
otIpCounters |
This structure represents the IP level counters. |
otLeaderData |
This structure represents the Thread Leader Data. |
otLinkModeConfig |
This structure represents an MLE Link Mode configuration. |
otMleCounters |
This structure represents the Thread MLE counters. |
otNeighborInfo |
This structure holds diagnostic information for a neighboring Thread node. |
otNetworkDiagChildEntry |
This structure represents a Network Diagnostic Child Table Entry. |
otNetworkDiagConnectivity |
This structure represents a Network Diagnostic Connectivity value. |
otNetworkDiagMacCounters |
This structure represents a Network Diagnostic Mac Counters value. |
otNetworkDiagRoute |
This structure represents a Network Diagnostic Route TLV value. |
otNetworkDiagRouteData |
This structure represents a Network Diagnostic Route data. |
otNetworkDiagTlv |
This structure represents a Network Diagnostic TLV. |
otRouterInfo |
This structure holds diagnostic information for a Thread Router. |
otServerConfig |
This structure represents a Server configuration. |
otServiceConfig |
This structure represents a Service configuration. |
otThreadDiscoveryRequestInfo |
This structure represents the Thread Discovery Request data. |
otThreadParentResponseInfo |
This structure represents the MLE Parent Response data. |
Enumerations
anonymous enum
anonymous enum
otDeviceRole
otDeviceRole
Represents a Thread device role.
otRoutePreference
otRoutePreference
Defines valid values for member mPreference in otExternalRouteConfig and otBorderRouterConfig.
Properties | |
---|---|
OT_ROUTE_PREFERENCE_HIGH
|
High route preference. |
OT_ROUTE_PREFERENCE_LOW
|
Low route preference. |
OT_ROUTE_PREFERENCE_MED
|
Medium route preference. |
Typedefs
otBorderRouterConfig
struct otBorderRouterConfig otBorderRouterConfig
This structure represents a Border Router configuration.
otExternalRouteConfig
struct otExternalRouteConfig otExternalRouteConfig
This structure represents an External Route configuration.
otLinkModeConfig
struct otLinkModeConfig otLinkModeConfig
This structure represents an MLE Link Mode configuration.
otNeighborInfoIterator
int16_t otNeighborInfoIterator
Used to iterate through neighbor table.
otNetworkDataIterator
uint32_t otNetworkDataIterator
Used to iterate through Network Data information.
otNetworkDiagChildEntry
struct otNetworkDiagChildEntry otNetworkDiagChildEntry
This structure represents a Network Diagnostic Child Table Entry.
otNetworkDiagConnectivity
struct otNetworkDiagConnectivity otNetworkDiagConnectivity
This structure represents a Network Diagnostic Connectivity value.
otNetworkDiagIterator
uint16_t otNetworkDiagIterator
Used to iterate through Network Diagnostic TLV.
otNetworkDiagMacCounters
struct otNetworkDiagMacCounters otNetworkDiagMacCounters
This structure represents a Network Diagnostic Mac Counters value.
See RFC 2863 for definitions of member fields.
otNetworkDiagRoute
struct otNetworkDiagRoute otNetworkDiagRoute
This structure represents a Network Diagnostic Route TLV value.
otNetworkDiagRouteData
struct otNetworkDiagRouteData otNetworkDiagRouteData
This structure represents a Network Diagnostic Route data.
otNetworkDiagTlv
struct otNetworkDiagTlv otNetworkDiagTlv
This structure represents a Network Diagnostic TLV.
otReceiveDiagnosticGetCallback
void(* otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)
This function pointer is called when Network Diagnostic Get response is received.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
|
otRoutePreference
enum otRoutePreference otRoutePreference
Defines valid values for member mPreference in otExternalRouteConfig and otBorderRouterConfig.
otServerConfig
struct otServerConfig otServerConfig
This structure represents a Server configuration.
otServiceConfig
struct otServiceConfig otServiceConfig
This structure represents a Service configuration.
otThreadDiscoveryRequestCallback
void(* otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)
This function pointer is called every time an MLE Discovery Request message is received.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otThreadDiscoveryRequestInfo
struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo
This structure represents the Thread Discovery Request data.
otThreadParentResponseCallback
void(* otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)
This function pointer is called every time an MLE Parent Response message is received.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otThreadParentResponseInfo
struct otThreadParentResponseInfo otThreadParentResponseInfo
This structure represents the MLE Parent Response data.
Functions
otNetDataGet
otError otNetDataGet( otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength )
This method provides a full or stable copy of the Partition's Thread Network Data.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
|
otNetDataGetNextOnMeshPrefix
otError otNetDataGetNextOnMeshPrefix( otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig )
This function gets the next On Mesh Prefix in the partition's Network Data.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Return Values |
|
otNetDataGetNextRoute
otError otNetDataGetNextRoute( otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig )
This function gets the next external route in the partition's Network Data.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Return Values |
|
otNetDataGetNextService
otError otNetDataGetNextService( otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig )
This function gets the next service in the partition's Network Data.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Return Values |
|
otNetDataGetStableVersion
uint8_t otNetDataGetStableVersion( otInstance *aInstance )
Get the Stable Network Data Version.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
The Stable Network Data Version.
|
otNetDataGetVersion
uint8_t otNetDataGetVersion( otInstance *aInstance )
Get the Network Data Version.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
The Network Data Version.
|
otNetDataSteeringDataCheckJoiner
otError otNetDataSteeringDataCheckJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
Check if the steering data includes a Joiner.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Return Values |
|
otNetDataSteeringDataCheckJoinerWithDiscerner
otError otNetDataSteeringDataCheckJoinerWithDiscerner( otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner )
Check if the steering data includes a Joiner with a given discerner value.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Return Values |
|
otThreadBecomeChild
otError otThreadBecomeChild( otInstance *aInstance )
Attempt to reattach as a child.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
||||
Return Values |
|
otThreadBecomeDetached
otError otThreadBecomeDetached( otInstance *aInstance )
Detach from the Thread network.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
||||
Return Values |
|
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.
Details | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameters |
|
||||||||||||||
Return Values |
|
otThreadGetChildTimeout
uint32_t otThreadGetChildTimeout( otInstance *aInstance )
Get the Thread Child Timeout used when operating in the Child role.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
The Thread Child Timeout value in seconds.
|
otThreadSetChildTimeout
otThreadGetDeviceRole
otDeviceRole otThreadGetDeviceRole( otInstance *aInstance )
Get the device role.
Details | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parameters |
|
||||||||||
Return Values |
|
otThreadGetDomainName
const char * otThreadGetDomainName( otInstance *aInstance )
Get the Thread Domain Name.
This function is only available since Thread 1.2.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
A pointer to the Thread Domain Name.
|
otThreadSetDomainName
otThreadGetExtendedPanId
const otExtendedPanId * otThreadGetExtendedPanId( otInstance *aInstance )
Get the IEEE 802.15.4 Extended PAN ID.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
A pointer to the IEEE 802.15.4 Extended PAN ID.
|
otThreadSetExtendedPanId
otThreadGetFixedDuaInterfaceIdentifier
const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier( otInstance *aInstance )
Get the Interface Identifier manually specified for the Thread Domain Unicast Address.
This function is only available since Thread 1.2 when OPENTHREAD_CONFIG_DUA_ENABLE
is enabled.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
A pointer to the Interface Identifier which was set manually, or NULL if none was set.
|
otThreadSetFixedDuaInterfaceIdentifier
otThreadGetIp6Counters
const otIpCounters * otThreadGetIp6Counters( otInstance *aInstance )
Get the IPv6 counters.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
A pointer to the IPv6 counters.
|
otThreadGetKeySequenceCounter
uint32_t otThreadGetKeySequenceCounter( otInstance *aInstance )
Get the thrKeySequenceCounter.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
The thrKeySequenceCounter value.
|
otThreadSetKeySequenceCounter
otThreadGetKeySwitchGuardTime
uint32_t otThreadGetKeySwitchGuardTime( otInstance *aInstance )
Get the thrKeySwitchGuardTime.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
The thrKeySwitchGuardTime value (in hours).
|
otThreadSetKeySwitchGuardTime
otThreadGetLeaderData
otError otThreadGetLeaderData( otInstance *aInstance, otLeaderData *aLeaderData )
This function get the Thread Leader Data.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
||||
Return Values |
|
otThreadGetLeaderRloc
otError otThreadGetLeaderRloc( otInstance *aInstance, otIp6Address *aLeaderRloc )
This function returns a pointer to the Leader's RLOC.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Return Values |
|
otThreadGetLeaderRouterId
uint8_t otThreadGetLeaderRouterId( otInstance *aInstance )
Get the Leader's Router ID.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
The Leader's Router ID.
|
otThreadGetLeaderWeight
uint8_t otThreadGetLeaderWeight( otInstance *aInstance )
Get the Leader's Weight.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
The Leader's Weight.
|
otThreadGetLinkLocalIp6Address
const otIp6Address * otThreadGetLinkLocalIp6Address( otInstance *aInstance )
This function returns the Thread link-local IPv6 address.
The Thread link local address is derived using IEEE802.15.4 Extended Address as Interface Identifier.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
A pointer to Thread link-local IPv6 address.
|
otThreadGetLinkMode
otLinkModeConfig otThreadGetLinkMode( otInstance *aInstance )
Get the MLE Link Mode configuration.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
The MLE Link Mode configuration.
|
otThreadSetLinkMode
otThreadGetMasterKey
const otMasterKey * otThreadGetMasterKey( otInstance *aInstance )
Get the thrMasterKey.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
A pointer to a buffer containing the thrMasterKey.
|
otThreadSetMasterKey
otThreadGetMeshLocalEid
const otIp6Address * otThreadGetMeshLocalEid( otInstance *aInstance )
This function returns a pointer to the Mesh Local EID address.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
A pointer to the Mesh Local EID address.
|
otThreadGetMeshLocalPrefix
const otMeshLocalPrefix * otThreadGetMeshLocalPrefix( otInstance *aInstance )
This function returns a pointer to the Mesh Local Prefix.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
A pointer to the Mesh Local Prefix.
|
otThreadGetMleCounters
const otMleCounters * otThreadGetMleCounters( otInstance *aInstance )
Get the Thread MLE counters.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
A pointer to the Thread MLE counters.
|
otThreadGetNetworkName
const char * otThreadGetNetworkName( otInstance *aInstance )
Get the Thread Network Name.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
A pointer to the Thread Network Name.
|
otThreadSetNetworkName
otThreadGetNextDiagnosticTlv
otError otThreadGetNextDiagnosticTlv( const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv )
This function gets the next Network Diagnostic TLV in the message.
A subsequent call to this function is allowed only when current return value is OT_ERROR_NONE.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Return Values |
|
otThreadGetNextNeighborInfo
otError otThreadGetNextNeighborInfo( otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo )
This function gets the next neighbor information.
It is used to go through the entries of the neighbor table.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Return Values |
|
otThreadGetParentAverageRssi
otError otThreadGetParentAverageRssi( otInstance *aInstance, int8_t *aParentRssi )
The function retrieves the average RSSI for the Thread Parent.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otThreadGetParentInfo
otError otThreadGetParentInfo( otInstance *aInstance, otRouterInfo *aParentInfo )
The function retrieves diagnostic information for a Thread Router as parent.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otThreadGetParentLastRssi
otError otThreadGetParentLastRssi( otInstance *aInstance, int8_t *aLastRssi )
The function retrieves the RSSI of the last packet from the Thread Parent.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Return Values |
|
otThreadGetPartitionId
uint32_t otThreadGetPartitionId( otInstance *aInstance )
Get the Partition ID.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
The Partition ID.
|
otThreadGetRloc
const otIp6Address * otThreadGetRloc( otInstance *aInstance )
This function returns a pointer to the Thread Routing Locator (RLOC) address.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
A pointer to the Thread Routing Locator (RLOC) address.
|
otThreadGetRloc16
uint16_t otThreadGetRloc16( otInstance *aInstance )
Get the RLOC16.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
The RLOC16.
|
otThreadGetVersion
uint16_t otThreadGetVersion( void )
This function gets the Thread protocol version.
Details | |
---|---|
Returns |
the Thread protocol version.
|
otThreadIsDiscoverInProgress
bool otThreadIsDiscoverInProgress( otInstance *aInstance )
This function determines if an MLE Thread Discovery is currently in progress.
Details | |||
---|---|---|---|
Parameters |
|
otThreadIsSingleton
bool otThreadIsSingleton( otInstance *aInstance )
This function indicates whether a node is the only router on the network.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
||||
Return Values |
|
otThreadRegisterParentResponseCallback
void otThreadRegisterParentResponseCallback( otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext )
This function registers a callback to receive MLE Parent Response data.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
otThreadResetIp6Counters
void otThreadResetIp6Counters( otInstance *aInstance )
Reset the IPv6 counters.
Details | |||
---|---|---|---|
Parameters |
|
otThreadResetMleCounters
void otThreadResetMleCounters( otInstance *aInstance )
Reset the Thread MLE counters.
Details | |||
---|---|---|---|
Parameters |
|
otThreadSendAddressNotification
void otThreadSendAddressNotification( otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid )
This function sends a Proactive Address Notification (ADDR_NTF.ntf) message.
This function is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
is enabled.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
|
otThreadSendDiagnosticGet
otError otThreadSendDiagnosticGet( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount )
Send a Network Diagnostic Get request.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
|
||||||||
Return Values |
|
otThreadSendDiagnosticReset
otError otThreadSendDiagnosticReset( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount )
Send a Network Diagnostic Reset request.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
|
||||||||
Return Values |
|
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.
This function is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
is enabled.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
|
||||||||
Return Values |
|
otThreadSetChildTimeout
void otThreadSetChildTimeout( otInstance *aInstance, uint32_t aTimeout )
Set the Thread Child Timeout used when operating in the Child role.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otThreadGetChildTimeout
otThreadSetDiscoveryRequestCallback
void otThreadSetDiscoveryRequestCallback( otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext )
This function sets a callback to receive MLE Discovery Request data.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
otThreadSetDomainName
otError otThreadSetDomainName( otInstance *aInstance, const char *aDomainName )
Set the Thread Domain Name.
This function is only available since Thread 1.2. This function succeeds only when Thread protocols are disabled.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
||||
Return Values |
|
otThreadGetDomainName
otThreadSetEnabled
otError otThreadSetEnabled( otInstance *aInstance, bool aEnabled )
This function starts Thread protocol operation.
The interface must be up when calling this function.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
||||
Return Values |
|
otThreadSetExtendedPanId
otError otThreadSetExtendedPanId( otInstance *aInstance, const otExtendedPanId *aExtendedPanId )
Set the IEEE 802.15.4 Extended PAN ID.
This function 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.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
||||
Return Values |
|
otThreadGetExtendedPanId
otThreadSetFixedDuaInterfaceIdentifier
otError otThreadSetFixedDuaInterfaceIdentifier( otInstance *aInstance, const otIp6InterfaceIdentifier *aIid )
Set/Clear the Interface Identifier manually specified for the Thread Domain Unicast Address.
This function is only available since Thread 1.2 when OPENTHREAD_CONFIG_DUA_ENABLE
is enabled.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
||||
Return Values |
|
otThreadGetFixedDuaInterfaceIdentifier
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.
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.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
|
||||||||
Return Values |
|
otThreadSetKeySequenceCounter
void otThreadSetKeySequenceCounter( otInstance *aInstance, uint32_t aKeySequenceCounter )
Set the thrKeySequenceCounter.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otThreadGetKeySequenceCounter
otThreadSetKeySwitchGuardTime
void otThreadSetKeySwitchGuardTime( otInstance *aInstance, uint32_t aKeySwitchGuardTime )
Set the thrKeySwitchGuardTime.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otThreadGetKeySwitchGuardTime
otThreadSetLinkMode
otError otThreadSetLinkMode( otInstance *aInstance, otLinkModeConfig aConfig )
Set the MLE Link Mode configuration.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
||||
Return Values |
|
otThreadGetLinkMode
otThreadSetMasterKey
otError otThreadSetMasterKey( otInstance *aInstance, const otMasterKey *aKey )
Set the thrMasterKey.
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.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Return Values |
|
otThreadGetMasterKey
otThreadSetMeshLocalPrefix
otError otThreadSetMeshLocalPrefix( otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix )
This function sets 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.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
||||
Return Values |
|
otThreadSetNetworkName
otError otThreadSetNetworkName( otInstance *aInstance, const char *aNetworkName )
Set 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.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
||||
Return Values |
|
otThreadGetNetworkName
otThreadSetReceiveDiagnosticGetCallback
void otThreadSetReceiveDiagnosticGetCallback( otInstance *aInstance, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext )
This function registers a callback to provide received raw Network Diagnostic Get response payload.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
Macros
OT_JOINER_ADVDATA_MAX_LENGTH
OT_JOINER_ADVDATA_MAX_LENGTH 64
Maximum AdvData Length of Joiner Advertisement.
OT_NEIGHBOR_INFO_ITERATOR_INIT
OT_NEIGHBOR_INFO_ITERATOR_INIT 0
Initializer for otNeighborInfoIterator.
OT_NETWORK_BASE_TLV_MAX_LENGTH
OT_NETWORK_BASE_TLV_MAX_LENGTH 254
Maximum value length of Thread Base TLV.
OT_NETWORK_DATA_ITERATOR_INIT
OT_NETWORK_DATA_ITERATOR_INIT 0
Initializer for otNetworkDataIterator.
OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE
OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3
Size of Network Diagnostic Child Table entry.
OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT
OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0
Initializer for otNetworkDiagIterator.
OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES
OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19
Maximum Number of Network Diagnostic TLV Types to Request or Reset.
OT_NETWORK_MAX_ROUTER_ID
OT_NETWORK_MAX_ROUTER_ID 62
Maximum Router ID.
OT_SERVER_DATA_MAX_SIZE
OT_SERVER_DATA_MAX_SIZE 248
Maximum size of Server Data in bytes. This is theoretical limit, practical one is much lower.
OT_SERVICE_DATA_MAX_SIZE
OT_SERVICE_DATA_MAX_SIZE 252
Maximum size of Service Data in bytes.