Allgemein
Dieses Modul enthält Funktionen für alle Thread-Rollen.
Zusammenfassung
Der Network Data Publisher bietet Mechanismen zur Begrenzung der Anzahl ähnlicher Dienst- und/oder Präfixeinträge (On-Mesh-Präfix oder externe Route) in den Thread-Netzwerkdaten, indem er die Netzwerkdaten überwacht und festlegt, ob oder wann Einträge hinzugefügt oder entfernt werden.
Für alle Funktionen in diesem Modul muss OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE
aktiviert sein.
Typedefs |
|
---|---|
otBorderRouterConfig
|
typedefstruct otBorderRouterConfig
Stellt eine Border-Router-Konfiguration dar. |
otDetachGracefullyCallback)(void *aContext)
|
typedefvoid(*
Dieser Callback informiert die Anwendung darüber, dass der Trennvorgang abgeschlossen wurde. |
otExternalRouteConfig
|
typedefstruct otExternalRouteConfig
Stellt eine Konfiguration externer Routen dar. |
otIpCounters
|
typedefstruct otIpCounters
Stellt die Zähler auf IP-Ebene dar. |
otLeaderData
|
typedefstruct otLeaderData
Stellt die Thread-Leader-Daten dar. |
otLinkModeConfig
|
typedefstruct otLinkModeConfig
Stellt eine MLE-Linkmoduskonfiguration dar. |
otLowpanContextInfo
|
typedefstruct otLowpanContextInfo
Stellt 6LoWPAN-Kontext-ID-Informationen dar, die mit einem Präfix in Netzwerkdaten verknüpft sind. |
otMleCounters
|
typedefstruct otMleCounters
Stellt die Thread-MLE-Zähler dar. |
otNeighborInfoIterator
|
typedefint16_t
Wird verwendet, um durch die benachbarte Tabelle zu iterieren. |
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)
|
typedefvoid(*
Der Zeigertyp definiert den Callback, der verwendet wird, um benachrichtigt zu werden, wenn ein „DNS/SRP-Service“-Eintrag zu den Thread-Netzwerkdaten hinzugefügt oder aus den Thread-Netzwerkdaten entfernt wird. |
otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)
|
typedefvoid(*
Der Zeigertyp definiert den Callback, der verwendet wird, um benachrichtigt zu werden, wenn ein Präfixeintrag (On-Mesh oder externe Route) zu den Thread-Netzwerkdaten hinzugefügt oder aus ihnen entfernt wird. |
otNetDataPublisherEvent
|
typedef Stellt die Ereignisse dar, die von den Publisher-Callbacks erfasst werden. |
otNetworkDataIterator
|
typedefuint32_t
Wird verwendet, um über Netzwerkdateninformationen zu iterieren. |
otNetworkDiagChildEntry
|
typedefstruct otNetworkDiagChildEntry
Stellt einen untergeordneten Tabelleneintrag für die Netzwerkdiagnose dar. |
otNetworkDiagConnectivity
|
typedefstruct otNetworkDiagConnectivity
Stellt einen Wert für die Netzwerkdiagnoseverbindung dar. |
otNetworkDiagIterator
|
typedefuint16_t
Wird für die Iteration über Netzwerkdiagnose TLV verwendet. |
otNetworkDiagMacCounters
|
typedefstruct otNetworkDiagMacCounters
Stellt einen Wert für Mac-Zähler für die Netzwerkdiagnose dar. |
otNetworkDiagMleCounters
|
typedefstruct otNetworkDiagMleCounters
Stellt einen Wert für Netzwerkdiagnose-MLE-Zähler dar. |
otNetworkDiagRoute
|
typedefstruct otNetworkDiagRoute
Stellt einen TLV-Wert der Netzwerkdiagnoseroute dar. |
otNetworkDiagRouteData
|
typedefstruct otNetworkDiagRouteData
Stellt Daten für Netzwerkdiagnoserouten dar. |
otNetworkDiagTlv
|
typedefstruct otNetworkDiagTlv
Stellt einen Netzwerkdiagnose-TLV dar. |
otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)
|
typedefvoid(*
Der Zeiger wird aufgerufen, wenn die Netzwerkdiagnose-Get-Antwort empfangen wird. |
otRoutePreference
|
typedefenum otRoutePreference
|
otServerConfig
|
typedefstruct otServerConfig
Stellt eine Serverkonfiguration dar. |
otServiceConfig
|
typedefstruct otServiceConfig
Stellt eine Dienstkonfiguration dar. |
otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)
|
typedefvoid(*
Der Zeigertyp definiert den Callback, mit dem über das Ergebnis einer otThreadLocateAnycastDestination() -Anfrage informiert wird. |
otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)
|
typedefvoid(*
Der Pointer wird jedes Mal aufgerufen, wenn eine MLE-Erkennungsanfragenachricht empfangen wird. |
otThreadDiscoveryRequestInfo
|
typedefstruct otThreadDiscoveryRequestInfo
Stellt die Daten der Thread-Erkennungsanfrage dar. |
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)
|
typedefvoid(*
Pointer wird jedes Mal aufgerufen, wenn eine MLE-Antwortnachricht für übergeordnete Inhalte empfangen wird. |
otThreadParentResponseInfo
|
typedefstruct otThreadParentResponseInfo
Stellt die übergeordneten MLE-Antwortdaten dar. |
Funktionen |
|
---|---|
otConvertDurationInSecondsToString(uint32_t aDuration, char *aBuffer, uint16_t aSize)
|
void
Wandelt eine
uint32_t -Dauer (in Sekunden) in einen menschenlesbaren String um. |
otNetDataContainsOmrPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
|
bool
Überprüft, ob ein bestimmtes Präfix als gültiges OMR-Präfix fungieren kann und auch die Netzwerkdaten des Leaders dieses Präfix enthalten.
|
otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
|
Stellen Sie eine vollständige oder stabile Kopie der Thread-Netzwerkdaten der Partition bereit.
|
otNetDataGetCommissioningDataset(otInstance *aInstance, otCommissioningDataset *aDataset)
|
void
Ruft das Inbetriebnahme-Dataset aus den Netzwerkdaten der Partition ab.
|
otNetDataGetLength(otInstance *aInstance)
|
uint8_t
Ruft die aktuelle Länge (Anzahl der Byte) der Thread-Netzwerkdaten der Partition ab.
|
otNetDataGetMaxLength(otInstance *aInstance)
|
uint8_t
Ruft die maximal beobachtete Länge der Thread-Netzwerkdaten seit der Initialisierung des OT-Stacks oder seit dem letzten Aufruf von
otNetDataResetMaxLength() ab. |
otNetDataGetNextLowpanContextInfo(otInstance *aInstance, otNetworkDataIterator *aIterator, otLowpanContextInfo *aContextInfo)
|
Rufen Sie die nächsten 6LoWPAN-Kontext-ID-Informationen in den Netzwerkdaten der Partition ab.
|
otNetDataGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
|
Rufen Sie das nächste On Mesh-Präfix in den Netzwerkdaten der Partition ab.
|
otNetDataGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
|
Rufen Sie die nächste externe Route in den Netzwerkdaten der Partition ab.
|
otNetDataGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
|
Rufen Sie den nächsten Dienst aus den Netzwerkdaten der Partition ab.
|
otNetDataGetStableVersion(otInstance *aInstance)
|
uint8_t
Rufen Sie die stabile Netzwerkdatenversion ab.
|
otNetDataGetVersion(otInstance *aInstance)
|
uint8_t
Rufen Sie die Netzwerkdatenversion ab.
|
otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)
|
bool
Gibt an, ob der Eintrag „DNS/SRP Service“ den Thread-Netzwerkdaten derzeit hinzugefügt wurde.
|
otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix)
|
bool
Gibt an, ob ein aktuell veröffentlichter Präfixeintrag (On-Mesh- oder externe Route) zu den Thread-Netzwerkdaten hinzugefügt wird.
|
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
|
void
Fordert die Veröffentlichung der „DNS/SRP-Dienst-Anycast-Adresse“ in den Thread-Netzwerkdaten an.
|
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
|
void
Fordert an, dass die „DNS/SRP-Dienst-Unicast-Adresse“ in den Thread-Netzwerkdaten veröffentlicht wird.
|
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
|
void
Fordert an, dass die „DNS/SRP-Dienst-Unicast-Adresse“ in den Thread-Netzwerkdaten veröffentlicht wird.
|
otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
|
Fordert an, dass ein externes Routenpräfix in den Thread-Netzwerkdaten veröffentlicht wird.
|
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
|
Fordert ein On-Mesh-Präfix an, das in den Thread-Netzwerkdaten veröffentlicht wird.
|
otNetDataReplacePublishedExternalRoute(otInstance *aInstance, const otIp6Prefix *aPrefix, const otExternalRouteConfig *aConfig)
|
Ersetzt eine zuvor veröffentlichte externe Route in den Thread-Netzwerkdaten.
|
otNetDataResetMaxLength(otInstance *aInstance)
|
void
Setzt die aufgezeichnete maximale Länge der Thread-Netzwerkdaten zurück.
|
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
|
void
Legt einen Callback fest, über den eine Benachrichtigung gesendet wird, wenn ein veröffentlichter „DNS/SRP-Dienst“ den Thread-Netzwerkdaten hinzugefügt oder daraus entfernt wird.
|
otNetDataSetPrefixPublisherCallback(otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
|
void
Legt einen Callback fest, mit dem Sie benachrichtigt werden, wenn ein veröffentlichter Präfixeintrag tatsächlich den Thread-Netzwerkdaten hinzugefügt oder daraus entfernt wird.
|
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
|
Prüfen Sie, ob die Lenkungsdaten einen Joiner enthalten.
|
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
|
Prüfen Sie, ob die Lenkungsdaten einen Joiner mit einem bestimmten Discernerwert enthalten.
|
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
|
void
Hebt die Veröffentlichung aller zuvor hinzugefügten DNS-/SRP-Diensteinträge (Anycast oder Unicast) aus den Thread-Netzwerkdaten auf.
|
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
|
Hebt die Veröffentlichung eines zuvor veröffentlichten On-Mesh- oder externen Routenpräfixes auf.
|
otThreadBecomeChild(otInstance *aInstance)
|
Versuchen Sie, die Datei noch einmal als Kind anzuhängen.
|
otThreadBecomeDetached(otInstance *aInstance)
|
Trennen Sie die Verbindung zum Thread-Netzwerk.
|
otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
|
Benachrichtigt andere Knoten im Netzwerk (falls vorhanden) und beendet dann den Vorgang des Thread-Protokolls.
|
otThreadDeviceRoleToString(otDeviceRole aRole)
|
const char *
Konvertieren Sie die Geräterolle in einen für Menschen lesbaren String.
|
otThreadDiscover(otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
|
Startet einen Thread Discovery-Scan.
|
otThreadGetChildTimeout(otInstance *aInstance)
|
uint32_t
Ruft das Zeitlimit für untergeordnete Threads (in Sekunden) ab, das bei einem Betrieb in der untergeordneten Rolle verwendet wird.
|
otThreadGetDeviceRole(otInstance *aInstance)
|
Beanspruche die Geräterolle.
|
otThreadGetDomainName(otInstance *aInstance)
|
const char *
Ruft den Thread-Domainnamen ab.
|
otThreadGetExtendedPanId(otInstance *aInstance)
|
const otExtendedPanId *
Ruft die erweiterte IEEE 802.15.4-PAN-ID ab.
|
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
|
const otIp6InterfaceIdentifier *
Ruft die Schnittstellen-ID ab, die manuell für die Unicast-Adresse der Thread-Domain angegeben wurde.
|
otThreadGetIp6Counters(otInstance *aInstance)
|
const otIpCounters *
Ruft die IPv6-Zähler ab.
|
otThreadGetKeySequenceCounter(otInstance *aInstance)
|
uint32_t
Ruft den thrKeySequenceCounter ab.
|
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
|
uint32_t
Ruft die thrKeySwitchGuardTime (in Stunden) ab.
|
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
|
Die Thread-Leader-Daten abrufen.
|
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
|
Gibt einen Zeiger auf die RLOC des Leaders zurück.
|
otThreadGetLeaderRouterId(otInstance *aInstance)
|
uint8_t
Rufen Sie die Router-ID des Leaders ab.
|
otThreadGetLeaderWeight(otInstance *aInstance)
|
uint8_t
Erfahre mehr über das Gewicht der Spitzenreiter.
|
otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
|
const otIp6Address *
Ruft die Multicast-Adresse der lokalen Thread-Link-Alle Thread-Knoten ab.
|
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
|
const otIp6Address *
Ruft die Link-Local-IPv6-Adresse von Thread ab.
|
otThreadGetLinkMode(otInstance *aInstance)
|
Rufen Sie die Konfiguration des MLE-Linkmodus ab.
|
otThreadGetMaxTimeInQueue(otInstance *aInstance)
|
uint32_t
Ruft die maximale Zeit in der Warteschlange für Nachrichten in der TX-Warteschlange ab.
|
otThreadGetMeshLocalEid(otInstance *aInstance)
|
const otIp6Address *
Ruft die lokale EID-Adresse des Mesh-Netzwerks ab.
|
otThreadGetMeshLocalPrefix(otInstance *aInstance)
|
const otMeshLocalPrefix *
Gibt einen Zeiger auf das lokale Mesh-Präfix zurück.
|
otThreadGetMleCounters(otInstance *aInstance)
|
const otMleCounters *
Ruft die Thread MLE-Zähler ab.
|
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
|
void
Rufen Sie den Thread-Netzwerkschlüssel ab.
|
otThreadGetNetworkKeyRef(otInstance *aInstance)
|
Rufen Sie den
otNetworkKeyRef für den Thread-Netzwerkschlüssel ab. |
otThreadGetNetworkName(otInstance *aInstance)
|
const char *
Rufen Sie den Thread-Netzwerknamen ab.
|
otThreadGetNextDiagnosticTlv(const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
|
Ruft die nächste Netzwerkdiagnose-TLV in der Nachricht ab.
|
otThreadGetNextNeighborInfo(otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
|
Ruft die Informationen zum nächsten Nachbarn ab.
|
otThreadGetParentAverageRssi(otInstance *aInstance, int8_t *aParentRssi)
|
Die Funktion ruft den durchschnittlichen RSSI für das übergeordnete Thread-Element ab.
|
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
|
Die Funktion ruft Diagnoseinformationen für einen Thread Router als übergeordnetes Element ab.
|
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
|
Die Funktion ruft den RSSI des letzten Pakets aus dem übergeordneten Thread ab.
|
otThreadGetPartitionId(otInstance *aInstance)
|
uint32_t
Rufen Sie die Partitions-ID ab.
|
otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
|
const otIp6Address *
Ruft die Multicast-Adresse für alle Thread-Bereichs-Alle Thread-Knoten ab.
|
otThreadGetRloc(otInstance *aInstance)
|
const otIp6Address *
Ruft die RLOC-Adresse (Thread Routing Locator) ab.
|
otThreadGetRloc16(otInstance *aInstance)
|
uint16_t
Hol dir den RLOC16.
|
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
|
Ruft das Dienst-ALOC für die angegebene Dienst-ID ab.
|
otThreadGetTimeInQueueHistogram(otInstance *aInstance, uint16_t *aNumBins, uint32_t *aBinInterval)
|
const uint32_t *
Ruft das Zeit-in-Warteschlangen-Histogramm für Nachrichten in der TX-Warteschlange ab.
|
otThreadGetVendorModel(otInstance *aInstance)
|
const char *
Rufen Sie den Modellstring des Anbieters ab.
|
otThreadGetVendorName(otInstance *aInstance)
|
const char *
Rufen Sie den String des Anbieternamens ab.
|
otThreadGetVendorSwVersion(otInstance *aInstance)
|
const char *
Rufen Sie den String der SW-Version des Anbieters ab.
|
otThreadGetVersion(void)
|
uint16_t
Ruft die Thread-Protokollversion ab.
|
otThreadIsAnycastLocateInProgress(otInstance *aInstance)
|
bool
Gibt an, ob gerade eine Anycast-Standortanfrage in Bearbeitung ist.
|
otThreadIsDiscoverInProgress(otInstance *aInstance)
|
bool
Ermittelt, ob gerade eine MLE-Thread-Erkennung läuft.
|
otThreadIsSingleton(otInstance *aInstance)
|
bool
Gibt an, ob ein Knoten der einzige Router im Netzwerk ist.
|
otThreadLocateAnycastDestination(otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
|
Fordert an, dass das nächstgelegene Ziel einer bestimmten Anycast-Adresse ermittelt werden soll.
|
otThreadRegisterParentResponseCallback(otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
|
void
Registriert einen Callback für den Empfang von MLE Parent Response-Daten.
|
otThreadResetIp6Counters(otInstance *aInstance)
|
void
Setzt die IPv6-Zähler zurück.
|
otThreadResetMleCounters(otInstance *aInstance)
|
void
Setzt die Thread MLE-Zähler zurück.
|
otThreadResetTimeInQueueStat(otInstance *aInstance)
|
void
Setzt die Statistiken für die Zeit in der TX-Warteschlange zurück.
|
otThreadSearchForBetterParent(otInstance *aInstance)
|
Startet den Prozess für das Kind, nach einem besseren Elternteil zu suchen, ohne mit seinem aktuellen Elternteil verbunden zu bleiben
|
otThreadSendAddressNotification(otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
|
void
Sendet eine Nachricht zur proaktiven Adressbenachrichtigung (ADDR_NTF.ntf).
|
otThreadSendDiagnosticGet(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
|
Sende eine Anfrage zum Abrufen der Netzwerkdiagnose.
|
otThreadSendDiagnosticReset(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
|
Anfrage zum Zurücksetzen der Netzwerkdiagnose senden.
|
otThreadSendProactiveBackboneNotification(otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
|
Sendet eine proaktive Backbone-Benachrichtigung (PRO_BB.ntf) für den Backbone-Link.
|
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
|
void
Legt das Zeitlimit für untergeordnete Threads (in Sekunden) fest, das beim Betrieb in der untergeordneten Rolle verwendet wird.
|
otThreadSetDiscoveryRequestCallback(otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
|
void
Legt einen Callback zum Empfang von MLE-Discovery-Anfragedaten fest.
|
otThreadSetDomainName(otInstance *aInstance, const char *aDomainName)
|
Legt den Thread-Domainnamen fest.
|
otThreadSetEnabled(otInstance *aInstance, bool aEnabled)
|
Startet den Thread-Protokollvorgang.
|
otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
|
Legt die erweiterte IEEE 802.15.4-PAN-ID fest.
|
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
|
Legt die Schnittstellenkennung fest oder löscht sie, die manuell für die Unicast-Adresse der Thread-Domain angegeben wurde.
|
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
|
Legt die Thread Joiner-Anzeige beim Erkennen des Thread-Netzwerks fest.
|
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
|
void
Legt den thrKeySequenceCounter fest.
|
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
|
void
Legt die thrKeySwitchGuardTime (in Stunden) fest.
|
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
|
Legen Sie die Konfiguration des MLE-Linkmodus fest.
|
otThreadSetMeshLocalPrefix(otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
|
Legt das lokale Mesh-Präfix fest.
|
otThreadSetNetworkKey(otInstance *aInstance, const otNetworkKey *aKey)
|
Legen Sie den Thread-Netzwerkschlüssel fest.
|
otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)
|
Legen Sie den Thread-Netzwerkschlüssel als
otNetworkKeyRef fest. |
otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName)
|
Legen Sie den Thread-Netzwerknamen fest.
|
otThreadSetVendorModel(otInstance *aInstance, const char *aVendorModel)
|
Legt den String für das Anbietermodell fest.
|
otThreadSetVendorName(otInstance *aInstance, const char *aVendorName)
|
Legen Sie den String für den Anbieternamen fest.
|
otThreadSetVendorSwVersion(otInstance *aInstance, const char *aVendorSwVersion)
|
Legt den String für die Softwareversion des Anbieters fest.
|
Strukturen |
|
---|---|
otBorderRouterConfig |
Stellt eine Border-Router-Konfiguration dar. |
otExternalRouteConfig |
Stellt eine Konfiguration externer Routen dar. |
otIpCounters |
Stellt die Zähler auf IP-Ebene dar. |
otLeaderData |
Stellt die Thread-Leader-Daten dar. |
otLinkModeConfig |
Stellt eine MLE-Linkmoduskonfiguration dar. |
otLowpanContextInfo |
Stellt 6LoWPAN-Kontext-ID-Informationen dar, die mit einem Präfix in Netzwerkdaten verknüpft sind. |
otMleCounters |
Stellt die Thread-MLE-Zähler dar. |
otNeighborInfo |
Enthält Diagnoseinformationen für einen benachbarten Thread-Knoten. |
otNetworkDiagChildEntry |
Stellt einen untergeordneten Tabelleneintrag für die Netzwerkdiagnose dar. |
otNetworkDiagConnectivity |
Stellt einen Wert für die Netzwerkdiagnoseverbindung dar. |
otNetworkDiagMacCounters |
Stellt einen Wert für Mac-Zähler für die Netzwerkdiagnose dar. |
otNetworkDiagMleCounters |
Stellt einen Wert für Netzwerkdiagnose-MLE-Zähler dar. |
otNetworkDiagRoute |
Stellt einen TLV-Wert der Netzwerkdiagnoseroute dar. |
otNetworkDiagRouteData |
Stellt Daten für Netzwerkdiagnoserouten dar. |
otNetworkDiagTlv |
Stellt einen Netzwerkdiagnose-TLV dar. |
otRouterInfo |
Enthält Diagnoseinformationen für einen Thread-Router. |
otServerConfig |
Stellt eine Serverkonfiguration dar. |
otServiceConfig |
Stellt eine Dienstkonfiguration dar. |
otThreadDiscoveryRequestInfo |
Stellt die Daten der Thread-Erkennungsanfrage dar. |
otThreadParentResponseInfo |
Stellt die übergeordneten MLE-Antwortdaten dar. |
Aufzählungen
Anonyme Aufzählung
anonymous enum
otDeviceRole
otDeviceRole
Stellt eine Thread-Geräterolle dar.
Attribute | |
---|---|
OT_DEVICE_ROLE_CHILD
|
Die untergeordnete Thread-Rolle. |
OT_DEVICE_ROLE_DETACHED
|
Derzeit nicht Teil eines Thread-Netzwerks/-Partition. |
OT_DEVICE_ROLE_DISABLED
|
Der Thread-Stack ist deaktiviert. |
OT_DEVICE_ROLE_LEADER
|
Die Rolle „Thread-Leader“. |
OT_DEVICE_ROLE_ROUTER
|
Die Rolle „Thread Router“. |
otNetDataPublisherEvent
otNetDataPublisherEvent
Stellt die Ereignisse dar, die von den Publisher-Callbacks erfasst werden.
Attribute | |
---|---|
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED
|
Der veröffentlichte Eintrag wird den Thread-Netzwerkdaten hinzugefügt. |
OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED
|
Der veröffentlichte Eintrag wird aus den Thread-Netzwerkdaten entfernt. |
otRoutePreference
otRoutePreference
Definiert gültige Werte für mPreference
in otExternalRouteConfig
und otBorderRouterConfig
.
Attribute | |
---|---|
OT_ROUTE_PREFERENCE_HIGH
|
Hohe Routenpräferenz. |
OT_ROUTE_PREFERENCE_LOW
|
Niedrige Routenpräferenz. |
OT_ROUTE_PREFERENCE_MED
|
Mittlere Routeneinstellung. |
Typedefs
otBorderRouterConfig
struct otBorderRouterConfig otBorderRouterConfig
Stellt eine Border-Router-Konfiguration dar.
otDetachGracefullyCallback
void(* otDetachGracefullyCallback)(void *aContext)
Dieser Callback informiert die Anwendung darüber, dass der Trennvorgang abgeschlossen wurde.
Details | |||
---|---|---|---|
Parameter |
|
otExternalRouteConfig
struct otExternalRouteConfig otExternalRouteConfig
Stellt eine Konfiguration externer Routen dar.
otLinkModeConfig
struct otLinkModeConfig otLinkModeConfig
Stellt eine MLE-Linkmoduskonfiguration dar.
otLowpanContextInfo
struct otLowpanContextInfo otLowpanContextInfo
Stellt 6LoWPAN-Kontext-ID-Informationen dar, die mit einem Präfix in Netzwerkdaten verknüpft sind.
otNeighborInfoIterator
int16_t otNeighborInfoIterator
Wird verwendet, um durch die benachbarte Tabelle zu iterieren.
otNetDataDnsSrpServicePublisherCallback
void(* otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)
Der Zeigertyp definiert den Callback, der verwendet wird, um benachrichtigt zu werden, wenn ein „DNS/SRP-Service“-Eintrag zu den Thread-Netzwerkdaten hinzugefügt oder aus den Thread-Netzwerkdaten entfernt wird.
Beim Entfernen wird der Callback unabhängig davon aufgerufen, ob der Eintrag von Publisher
entfernt wurde (z.B. wenn bereits zu viele ähnliche Einträge in den Netzwerkdaten vorhanden sind) oder durch einen expliziten Aufruf zum Aufheben der Veröffentlichung des Eintrags (z.B. durch einen Aufruf von otNetDataUnpublishDnsSrpService()
).
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otNetDataPrefixPublisherCallback
void(* otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)
Der Zeigertyp definiert den Callback, der verwendet wird, um benachrichtigt zu werden, wenn ein Präfixeintrag (On-Mesh oder externe Route) zu den Thread-Netzwerkdaten hinzugefügt oder aus ihnen entfernt wird.
Beim Entfernen wird der Callback unabhängig davon aufgerufen, ob der Eintrag von Publisher
entfernt wurde (z.B. wenn bereits zu viele ähnliche Einträge in den Netzwerkdaten vorhanden sind) oder durch einen expliziten Aufruf zum Aufheben der Veröffentlichung des Eintrags.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
otNetDataPublisherEvent
enum otNetDataPublisherEvent otNetDataPublisherEvent
Stellt die Ereignisse dar, die von den Publisher-Callbacks erfasst werden.
otNetworkDataIterator
uint32_t otNetworkDataIterator
Wird verwendet, um über Netzwerkdateninformationen zu iterieren.
otNetworkDiagChildEntry
struct otNetworkDiagChildEntry otNetworkDiagChildEntry
Stellt einen untergeordneten Tabelleneintrag für die Netzwerkdiagnose dar.
otNetworkDiagConnectivity
struct otNetworkDiagConnectivity otNetworkDiagConnectivity
Stellt einen Wert für die Netzwerkdiagnoseverbindung dar.
otNetworkDiagIterator
uint16_t otNetworkDiagIterator
Wird für die Iteration über Netzwerkdiagnose TLV verwendet.
otNetworkDiagMacCounters
struct otNetworkDiagMacCounters otNetworkDiagMacCounters
Stellt einen Wert für Mac-Zähler für die Netzwerkdiagnose dar.
Definitionen für Mitgliederfelder finden Sie unter RFC 2863.
otNetworkDiagMleCounters
struct otNetworkDiagMleCounters otNetworkDiagMleCounters
Stellt einen Wert für Netzwerkdiagnose-MLE-Zähler dar.
otNetworkDiagRoute
struct otNetworkDiagRoute otNetworkDiagRoute
Stellt einen TLV-Wert der Netzwerkdiagnoseroute dar.
otNetworkDiagRouteData
struct otNetworkDiagRouteData otNetworkDiagRouteData
Stellt Daten für Netzwerkdiagnoserouten dar.
otReceiveDiagnosticGetCallback
void(* otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)
Der Zeiger wird aufgerufen, wenn die Netzwerkdiagnose-Get-Antwort empfangen wird.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
otRoutePreference
enum otRoutePreference otRoutePreference
Definiert gültige Werte für mPreference
in otExternalRouteConfig
und otBorderRouterConfig
.
otThreadAnycastLocatorCallback
void(* otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)
Der Zeigertyp definiert den Callback, mit dem über das Ergebnis einer otThreadLocateAnycastDestination()
-Anfrage informiert wird.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
otThreadDiscoveryRequestCallback
void(* otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)
Der Pointer wird jedes Mal aufgerufen, wenn eine MLE-Erkennungsanfragenachricht empfangen wird.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otThreadDiscoveryRequestInfo
struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo
Stellt die Daten der Thread-Erkennungsanfrage dar.
otThreadParentResponseCallback
void(* otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)
Pointer wird jedes Mal aufgerufen, wenn eine MLE-Antwortnachricht für übergeordnete Inhalte empfangen wird.
Wird in otThreadRegisterParentResponseCallback()
verwendet.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otThreadParentResponseInfo
struct otThreadParentResponseInfo otThreadParentResponseInfo
Stellt die übergeordneten MLE-Antwortdaten dar.
Funktionen
otConvertDurationInSecondsToString
void otConvertDurationInSecondsToString( uint32_t aDuration, char *aBuffer, uint16_t aSize )
Wandelt eine uint32_t
-Dauer (in Sekunden) in einen menschenlesbaren String um.
Hierfür muss OPENTHREAD_CONFIG_UPTIME_ENABLE
aktiviert sein.
Der String hat das Format „
Wenn der resultierende String nicht in aBuffer
(innerhalb seiner aSize
-Zeichen) passt, wird der String abgeschnitten, aber der ausgegebene String wird immer mit Null beendet.
Ist zur Verwendung mit mAge
oder mConnectionTime
in otNeighborInfo
- oder otChildInfo
-Gebäuden vorgesehen.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
otNetDataContainsOmrPrefix
bool otNetDataContainsOmrPrefix( otInstance *aInstance, const otIp6Prefix *aPrefix )
Überprüft, ob ein bestimmtes Präfix als gültiges OMR-Präfix fungieren kann und auch die Netzwerkdaten des Leaders dieses Präfix enthalten.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabe |
Gibt an, ob
aPrefix ein gültiges OMR-Präfix ist und die Netzwerkdaten des Leaders das OMR-Präfix aPrefix enthalten. |
otNetDataGet
otError otNetDataGet( otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength )
Stellen Sie eine vollständige oder stabile Kopie der Thread-Netzwerkdaten der Partition bereit.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||
Rückgabewerte |
|
otNetDataGetCommissioningDataset
void otNetDataGetCommissioningDataset( otInstance *aInstance, otCommissioningDataset *aDataset )
Ruft das Inbetriebnahme-Dataset aus den Netzwerkdaten der Partition ab.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otNetDataGetLength
uint8_t otNetDataGetLength( otInstance *aInstance )
Ruft die aktuelle Länge (Anzahl der Byte) der Thread-Netzwerkdaten der Partition ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Die Länge der Netzwerkdaten.
|
otNetDataGetMaxLength
uint8_t otNetDataGetMaxLength( otInstance *aInstance )
Ruft die maximal beobachtete Länge der Thread-Netzwerkdaten seit der Initialisierung des OT-Stacks oder seit dem letzten Aufruf von otNetDataResetMaxLength()
ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Die maximale Länge der Netzwerkdaten (High Watermark für die Länge der Netzwerkdaten).
|
otNetDataGetNextLowpanContextInfo
otError otNetDataGetNextLowpanContextInfo( otInstance *aInstance, otNetworkDataIterator *aIterator, otLowpanContextInfo *aContextInfo )
Rufen Sie die nächsten 6LoWPAN-Kontext-ID-Informationen in den Netzwerkdaten der Partition ab.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otNetDataGetNextOnMeshPrefix
otError otNetDataGetNextOnMeshPrefix( otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig )
Rufen Sie das nächste On Mesh-Präfix in den Netzwerkdaten der Partition ab.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otNetDataGetNextRoute
otError otNetDataGetNextRoute( otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig )
Rufen Sie die nächste externe Route in den Netzwerkdaten der Partition ab.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otNetDataGetNextService
otError otNetDataGetNextService( otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig )
Rufen Sie den nächsten Dienst aus den Netzwerkdaten der Partition ab.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otNetDataGetStableVersion
uint8_t otNetDataGetStableVersion( otInstance *aInstance )
Rufen Sie die stabile Netzwerkdatenversion ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Die stabile Netzwerkdatenversion.
|
otNetDataGetVersion
uint8_t otNetDataGetVersion( otInstance *aInstance )
Rufen Sie die Netzwerkdatenversion ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Die Netzwerkdatenversion.
|
otNetDataIsDnsSrpServiceAdded
bool otNetDataIsDnsSrpServiceAdded( otInstance *aInstance )
Gibt an, ob der Eintrag „DNS/SRP Service“ den Thread-Netzwerkdaten derzeit hinzugefügt wurde.
Hierfür muss die Funktion OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
aktiviert sein.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otNetDataIsPrefixAdded
bool otNetDataIsPrefixAdded( otInstance *aInstance, const otIp6Prefix *aPrefix )
Gibt an, ob ein aktuell veröffentlichter Präfixeintrag (On-Mesh- oder externe Route) zu den Thread-Netzwerkdaten hinzugefügt wird.
Hierfür muss die Funktion OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
aktiviert sein.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otNetDataPublishDnsSrpServiceAnycast
void otNetDataPublishDnsSrpServiceAnycast( otInstance *aInstance, uint8_t aSequenceNUmber )
Fordert die Veröffentlichung der „DNS/SRP-Dienst-Anycast-Adresse“ in den Thread-Netzwerkdaten an.
Hierfür muss die Funktion OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
aktiviert sein.
Durch den Aufruf dieser Funktion werden alle vorherigen „DNS/SRP-Dienst“-Einträge, die veröffentlicht wurden (aus früheren Aufrufen einer der otNetDataPublishDnsSrpService{Type}()
-Funktionen), entfernt und ersetzt.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otNetDataPublishDnsSrpServiceUnicast
void otNetDataPublishDnsSrpServiceUnicast( otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort )
Fordert an, dass die „DNS/SRP-Dienst-Unicast-Adresse“ in den Thread-Netzwerkdaten veröffentlicht wird.
Hierfür muss die Funktion OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
aktiviert sein.
Durch den Aufruf dieser Funktion werden alle vorherigen „DNS/SRP-Dienst“-Einträge, die veröffentlicht wurden (aus früheren Aufrufen einer der otNetDataPublishDnsSrpService{Type}()
-Funktionen), entfernt und ersetzt.
Veröffentlicht die „Unicast-Adresse des DNS/SRP-Dienstes“ durch Angabe der Adresse und Portinformationen in den TLV-Daten des Dienstes.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid
void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid( otInstance *aInstance, uint16_t aPort )
Fordert an, dass die „DNS/SRP-Dienst-Unicast-Adresse“ in den Thread-Netzwerkdaten veröffentlicht wird.
Hierfür muss die Funktion OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
aktiviert sein.
Durch den Aufruf dieser Funktion werden alle vorherigen „DNS/SRP-Dienst“-Einträge, die veröffentlicht wurden (aus früheren Aufrufen einer der otNetDataPublishDnsSrpService{Type}()
-Funktionen), entfernt und ersetzt.
Im Gegensatz zu otNetDataPublishDnsSrpServiceUnicast()
, bei dem die veröffentlichte Adresse angegeben werden muss und die Informationen in den TLV-Dienstdaten enthalten sind, verwendet diese Funktion die lokale Mesh-EID des Geräts und schließt die Informationen in die Server-TLV-Daten ein.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otNetDataPublishExternalRoute
otError otNetDataPublishExternalRoute( otInstance *aInstance, const otExternalRouteConfig *aConfig )
Fordert an, dass ein externes Routenpräfix in den Thread-Netzwerkdaten veröffentlicht wird.
Hierfür muss die Funktion OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
aktiviert sein.
Es können nur stabile Einträge veröffentlicht werden (z.B.aConfig.mStable
MUSS WAHR sein.
Durch einen nachfolgenden Aufruf dieser Methode wird eine vorherige Anfrage für dasselbe Präfix ersetzt. Wenn durch den neuen Aufruf nur die Flags (z.B. die Präferenzebene) geändert werden und das Präfix bereits in den Netzwerkdaten hinzugefügt wurde, wird die Änderung an den Flags sofort in den Netzwerkdaten widergespiegelt. Dadurch wird sichergestellt, dass vorhandene Einträge in den Netzwerkdaten nicht abrupt entfernt werden. Beachten Sie, dass eine Änderung der Einstellungsebene möglicherweise später dazu führen kann, dass der Eintrag aus den Netzwerkdaten entfernt wird, nachdem festgestellt wurde, dass andere Knoten dasselbe Präfix mit derselben oder einer höheren Präferenz veröffentlichen.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otNetDataPublishOnMeshPrefix
otError otNetDataPublishOnMeshPrefix( otInstance *aInstance, const otBorderRouterConfig *aConfig )
Fordert ein On-Mesh-Präfix an, das in den Thread-Netzwerkdaten veröffentlicht wird.
Hierfür muss die Funktion OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
aktiviert sein.
Es können nur stabile Einträge veröffentlicht werden (z.B.aConfig.mStable
MUSS WAHR sein.
Durch einen nachfolgenden Aufruf dieser Methode wird eine vorherige Anfrage für dasselbe Präfix ersetzt. Wenn durch den neuen Aufruf nur die Flags (z.B. die Präferenzebene) geändert werden und das Präfix bereits in den Netzwerkdaten hinzugefügt wurde, wird die Änderung an den Flags sofort in den Netzwerkdaten widergespiegelt. Dadurch wird sichergestellt, dass vorhandene Einträge in den Netzwerkdaten nicht abrupt entfernt werden. Beachten Sie, dass eine Änderung der Einstellungsebene möglicherweise später dazu führen kann, dass der Eintrag aus den Netzwerkdaten entfernt wird, nachdem festgestellt wurde, dass andere Knoten dasselbe Präfix mit derselben oder einer höheren Präferenz veröffentlichen.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otNetDataReplacePublishedExternalRoute
otError otNetDataReplacePublishedExternalRoute( otInstance *aInstance, const otIp6Prefix *aPrefix, const otExternalRouteConfig *aConfig )
Ersetzt eine zuvor veröffentlichte externe Route in den Thread-Netzwerkdaten.
Hierfür muss die Funktion OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
aktiviert sein.
Wenn es keine zuvor veröffentlichte externe Route gibt, die mit aPrefix
übereinstimmt, verhält sich diese Funktion ähnlich wie otNetDataPublishExternalRoute()
. Das heißt, sie startet den Prozess der Veröffentlichung von aConfig als externe Route in den Thread-Netzwerkdaten.
Wenn es einen bereits veröffentlichten Routeneintrag gibt, der mit aPrefix
übereinstimmt, wird er durch das neue Präfix aus aConfig
ersetzt.
- Wenn das
aPrefix
bereits in den Netzwerkdaten hinzugefügt wurde, wird die Änderung am neuen Präfix inaConfig
sofort in den Netzwerkdaten übernommen. Dadurch wird sichergestellt, dass Routeneinträge in den Netzwerkdaten nicht abrupt entfernt werden und der Übergang von einem Präfix zu dem neuen Präfix reibungslos verläuft. - Wenn die alte veröffentlichte
aPrefix
nicht in den Netzwerkdaten hinzugefügt wurde, wird sie durch das neueaConfig
-Präfix ersetzt, aber nicht sofort hinzugefügt. Stattdessen startet er den Prozess der Veröffentlichung in den Netzwerkdaten (überwachen der Netzwerkdaten, um festzustellen, wann/ob das Präfix hinzugefügt werden muss, abhängig von der Anzahl ähnlicher Präfixe in den Netzwerkdaten).
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otNetDataResetMaxLength
void otNetDataResetMaxLength( otInstance *aInstance )
Setzt die aufgezeichnete maximale Länge der Thread-Netzwerkdaten zurück.
Details | |||
---|---|---|---|
Parameter |
|
otNetDataGetMaxLength
otNetDataSetDnsSrpServicePublisherCallback
void otNetDataSetDnsSrpServicePublisherCallback( otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext )
Legt einen Callback fest, über den eine Benachrichtigung gesendet wird, wenn ein veröffentlichter „DNS/SRP-Dienst“ den Thread-Netzwerkdaten hinzugefügt oder daraus entfernt wird.
Durch den nachfolgenden Aufruf dieser Funktion wird eine zuvor festgelegte Callback-Funktion ersetzt.
Hierfür muss die Funktion OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
aktiviert sein.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
otNetDataSetPrefixPublisherCallback
void otNetDataSetPrefixPublisherCallback( otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext )
Legt einen Callback fest, mit dem Sie benachrichtigt werden, wenn ein veröffentlichter Präfixeintrag tatsächlich den Thread-Netzwerkdaten hinzugefügt oder daraus entfernt wird.
Durch den nachfolgenden Aufruf dieser Funktion wird eine zuvor festgelegte Callback-Funktion ersetzt.
Hierfür muss die Funktion OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
aktiviert sein.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
otNetDataSteeringDataCheckJoiner
otError otNetDataSteeringDataCheckJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
Prüfen Sie, ob die Lenkungsdaten einen Joiner enthalten.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otNetDataSteeringDataCheckJoinerWithDiscerner
otError otNetDataSteeringDataCheckJoinerWithDiscerner( otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner )
Prüfen Sie, ob die Lenkungsdaten einen Joiner mit einem bestimmten Discernerwert enthalten.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otNetDataUnpublishDnsSrpService
void otNetDataUnpublishDnsSrpService( otInstance *aInstance )
Hebt die Veröffentlichung aller zuvor hinzugefügten DNS-/SRP-Diensteinträge (Anycast oder Unicast) aus den Thread-Netzwerkdaten auf.
OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
muss aktiviert sein.
Details | |||
---|---|---|---|
Parameter |
|
otNetDataUnpublishPrefix
otError otNetDataUnpublishPrefix( otInstance *aInstance, const otIp6Prefix *aPrefix )
Hebt die Veröffentlichung eines zuvor veröffentlichten On-Mesh- oder externen Routenpräfixes auf.
OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
muss aktiviert sein.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadBecomeChild
otError otThreadBecomeChild( otInstance *aInstance )
Versuchen Sie, die Datei noch einmal als Kind anzuhängen.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadBecomeDetached
otError otThreadBecomeDetached( otInstance *aInstance )
Trennen Sie die Verbindung zum Thread-Netzwerk.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadDetachGracefully
otError otThreadDetachGracefully( otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext )
Benachrichtigt andere Knoten im Netzwerk (falls vorhanden) und beendet dann den Vorgang des Thread-Protokolls.
Er sendet eine Adressfreigabe, wenn er ein Router ist, oder legt sein untergeordnetes Zeitlimit auf 0 fest, wenn es sich um ein untergeordnetes Element handelt.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otThreadDeviceRoleToString
const char * otThreadDeviceRoleToString( otDeviceRole aRole )
Konvertieren Sie die Geräterolle in einen für Menschen lesbaren String.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Ein String, der
aRole darstellt. |
otThreadDiscover
otError otThreadDiscover( otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext )
Startet einen Thread Discovery-Scan.
Details | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||||||||
Rückgabewerte |
|
otThreadGetChildTimeout
uint32_t otThreadGetChildTimeout( otInstance *aInstance )
Ruft das Zeitlimit für untergeordnete Threads (in Sekunden) ab, das bei einem Betrieb in der untergeordneten Rolle verwendet wird.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Der Wert für das Zeitlimit für untergeordnete Threads in Sekunden.
|
otThreadSetChildTimeout
otThreadGetDeviceRole
otDeviceRole otThreadGetDeviceRole( otInstance *aInstance )
Beanspruche die Geräterolle.
Details | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||||
Rückgabewerte |
|
otThreadGetDomainName
const char * otThreadGetDomainName( otInstance *aInstance )
Ruft den Thread-Domainnamen ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Ein Zeiger auf den Thread-Domainnamen.
|
otThreadSetDomainName
otThreadGetExtendedPanId
const otExtendedPanId * otThreadGetExtendedPanId( otInstance *aInstance )
Ruft die erweiterte IEEE 802.15.4-PAN-ID ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Ein Verweis auf die erweiterte IEEE 802.15.4-PAN-ID.
|
otThreadSetExtendedPanId
otThreadGetFixedDuaInterfaceIdentifier
const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier( otInstance *aInstance )
Ruft die Schnittstellen-ID ab, die manuell für die Unicast-Adresse der Thread-Domain angegeben wurde.
Verfügbar, wenn OPENTHREAD_CONFIG_DUA_ENABLE
aktiviert ist.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Ein Zeiger auf den Schnittstellen-Identifikator, der manuell festgelegt wurde, oder NULL, wenn keiner festgelegt wurde.
|
otThreadSetFixedDuaInterfaceIdentifier
otThreadGetIp6Counters
const otIpCounters * otThreadGetIp6Counters( otInstance *aInstance )
Ruft die IPv6-Zähler ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Ein Zeiger auf die IPv6-Zähler.
|
otThreadGetKeySequenceCounter
uint32_t otThreadGetKeySequenceCounter( otInstance *aInstance )
Ruft den thrKeySequenceCounter ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Der Wert thrKeySequenceCounter.
|
otThreadSetKeySequenceCounter
otThreadGetKeySwitchGuardTime
uint32_t otThreadGetKeySwitchGuardTime( otInstance *aInstance )
Ruft die thrKeySwitchGuardTime (in Stunden) ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Der thrKeySwitchGuardTime-Wert (in Stunden).
|
otThreadSetKeySwitchGuardTime
otThreadGetLeaderData
otError otThreadGetLeaderData( otInstance *aInstance, otLeaderData *aLeaderData )
Die Thread-Leader-Daten abrufen.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadGetLeaderRloc
otError otThreadGetLeaderRloc( otInstance *aInstance, otIp6Address *aLeaderRloc )
Gibt einen Zeiger auf die RLOC des Leaders zurück.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otThreadGetLeaderRouterId
uint8_t otThreadGetLeaderRouterId( otInstance *aInstance )
Rufen Sie die Router-ID des Leaders ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Router-ID des Leaders.
|
otThreadGetLeaderWeight
uint8_t otThreadGetLeaderWeight( otInstance *aInstance )
Erfahre mehr über das Gewicht der Spitzenreiter.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Das Gewicht des Anführers.
|
otThreadGetLinkLocalAllThreadNodesMulticastAddress
const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress( otInstance *aInstance )
Ruft die Multicast-Adresse der lokalen Thread-Link-Alle Thread-Knoten ab.
Die Adresse ist eine Link-Local-Unicast-Präfix-basierte Multicast-Adresse [RFC 3306] mit:
- flgs auf 3 festgelegt (P = 1 und T = 1)
- Skop auf 2 festgelegt
- Plen auf 64 eingestellt
- Netzwerkpräfix auf das lokale Mesh-Präfix festgelegt
- Gruppen-ID auf 1 festgelegt
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Ein Zeiger auf die Multicast-Adresse von Thread-Link-Local-Alle Thread-Knoten.
|
otThreadGetLinkLocalIp6Address
const otIp6Address * otThreadGetLinkLocalIp6Address( otInstance *aInstance )
Ruft die Link-Local-IPv6-Adresse von Thread ab.
Die lokale Adresse des Thread-Links wird mithilfe der erweiterten IEEE802.15.4-Adresse als Schnittstellen-ID abgeleitet.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Ein Zeiger auf die Link-Local-IPv6-Adresse von Thread.
|
otThreadGetLinkMode
otLinkModeConfig otThreadGetLinkMode( otInstance *aInstance )
Rufen Sie die Konfiguration des MLE-Linkmodus ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Konfiguration des MLE-Linkmodus.
|
otThreadSetLinkMode
otThreadGetMaxTimeInQueue
uint32_t otThreadGetMaxTimeInQueue( otInstance *aInstance )
Ruft die maximale Zeit in der Warteschlange für Nachrichten in der TX-Warteschlange ab.
Erfordert OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE
.
Die Zeit in der Warteschlange wird nur für direkte Übertragungen verfolgt und als Dauer von dem Hinzufügen einer Nachricht zur Übertragungswarteschlange bis zu ihrer Übergabe an die MAC-Ebene zur Übertragung oder zum Löschen gemessen.
Die erfassten Statistiken können durch Aufrufen von otThreadResetTimeInQueueStat()
zurückgesetzt werden.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Die maximale Zeit in der Warteschlange für alle Nachrichten in der TX-Warteschlange (bisher) in Millisekunden.
|
otThreadGetMeshLocalEid
const otIp6Address * otThreadGetMeshLocalEid( otInstance *aInstance )
Ruft die lokale EID-Adresse des Mesh-Netzwerks ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Ein Verweis auf die Mesh-EID-Adresse.
|
otThreadGetMeshLocalPrefix
const otMeshLocalPrefix * otThreadGetMeshLocalPrefix( otInstance *aInstance )
Gibt einen Zeiger auf das lokale Mesh-Präfix zurück.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Ein Zeiger auf das lokale Mesh-Präfix.
|
otThreadGetMleCounters
const otMleCounters * otThreadGetMleCounters( otInstance *aInstance )
Ruft die Thread MLE-Zähler ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Ein Zeiger auf die Thread MLE-Zähler.
|
otThreadGetNetworkKey
void otThreadGetNetworkKey( otInstance *aInstance, otNetworkKey *aNetworkKey )
Rufen Sie den Thread-Netzwerkschlüssel ab.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otThreadSetNetworkKey
otThreadGetNetworkKeyRef
otNetworkKeyRef otThreadGetNetworkKeyRef( otInstance *aInstance )
Rufen Sie den otNetworkKeyRef
für den Thread-Netzwerkschlüssel ab.
Erfordert, dass das Build-Zeitfeature OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
aktiviert ist.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Verweis auf den im Arbeitsspeicher gespeicherten Thread-Netzwerkschlüssel.
|
otThreadSetNetworkKeyRef
otThreadGetNetworkName
const char * otThreadGetNetworkName( otInstance *aInstance )
Rufen Sie den Thread-Netzwerknamen ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Ein Zeiger auf den Thread-Netzwerknamen.
|
otThreadSetNetworkName
otThreadGetNextDiagnosticTlv
otError otThreadGetNextDiagnosticTlv( const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv )
Ruft die nächste Netzwerkdiagnose-TLV in der Nachricht ab.
Erfordert OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE
.
Ein nachfolgender Aufruf dieser Funktion ist nur zulässig, wenn der aktuelle Rückgabewert OT_ERROR_NONE ist.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otThreadGetNextNeighborInfo
otError otThreadGetNextNeighborInfo( otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo )
Ruft die Informationen zum nächsten Nachbarn ab.
Sie wird verwendet, um die Einträge der benachbarten Tabelle zu durchlaufen.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otThreadGetParentAverageRssi
otError otThreadGetParentAverageRssi( otInstance *aInstance, int8_t *aParentRssi )
Die Funktion ruft den durchschnittlichen RSSI für das übergeordnete Thread-Element ab.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otThreadGetParentInfo
otError otThreadGetParentInfo( otInstance *aInstance, otRouterInfo *aParentInfo )
Die Funktion ruft Diagnoseinformationen für einen Thread Router als übergeordnetes Element ab.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otThreadGetParentLastRssi
otError otThreadGetParentLastRssi( otInstance *aInstance, int8_t *aLastRssi )
Die Funktion ruft den RSSI des letzten Pakets aus dem übergeordneten Thread ab.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otThreadGetPartitionId
uint32_t otThreadGetPartitionId( otInstance *aInstance )
Rufen Sie die Partitions-ID ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Die Partitions-ID.
|
otThreadGetRealmLocalAllThreadNodesMulticastAddress
const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress( otInstance *aInstance )
Ruft die Multicast-Adresse für alle Thread-Bereichs-Alle Thread-Knoten ab.
Die Adresse ist eine bereichsspezifische, präfixbasierte Unicast-Multicast-Adresse [RFC 3306] mit:
- flgs auf 3 festgelegt (P = 1 und T = 1)
- SOP auf 3 festgelegt
- Plen auf 64 eingestellt
- Netzwerkpräfix auf das lokale Mesh-Präfix festgelegt
- Gruppen-ID auf 1 festgelegt
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Ein Zeiger auf die Multicast-Adresse „Thread-Bereich – Lokale Alle Thread-Knoten“.
|
otThreadGetRloc
const otIp6Address * otThreadGetRloc( otInstance *aInstance )
Ruft die RLOC-Adresse (Thread Routing Locator) ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Ein Zeiger auf die RLOC-Adresse (Thread Routing Locator).
|
otThreadGetRloc16
uint16_t otThreadGetRloc16( otInstance *aInstance )
Hol dir den RLOC16.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Das RLOC16.
|
otThreadGetServiceAloc
otError otThreadGetServiceAloc( otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc )
Ruft das Dienst-ALOC für die angegebene Dienst-ID ab.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otThreadGetTimeInQueueHistogram
const uint32_t * otThreadGetTimeInQueueHistogram( otInstance *aInstance, uint16_t *aNumBins, uint32_t *aBinInterval )
Ruft das Zeit-in-Warteschlangen-Histogramm für Nachrichten in der TX-Warteschlange ab.
Erfordert OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE
.
Ein Histogramm der Zeit in der Warteschlange für Nachrichten in der Übertragungswarteschlange wird erfasst. Die Zeit in der Warteschlange wird nur für direkte Übertragungen verfolgt und als Dauer von dem Hinzufügen einer Nachricht zur Übertragungswarteschlange bis zu ihrer Übergabe an die MAC-Ebene zur Übertragung oder zum Löschen gemessen.
Das Histogramm wird als Array von uint32_t
-Werten mit aNumBins
-Einträgen zurückgegeben. Der erste Eintrag im Array (bei Index 0) stellt die Anzahl der Nachrichten dar, deren Zeit in der Warteschlange kleiner als aBinInterval
ist. Der zweite Eintrag stellt die Anzahl der Nachrichten dar, deren Zeit in der Warteschlange größer oder gleich aBinInterval
, aber kleiner als 2 * aBinInterval
ist. Dies sind nur einige Beispiele für die Bedeutung von Data Governance. Der letzte Eintrag stellt die Anzahl der Nachrichten dar, bei denen die Zeit in der Warteschlange größer oder gleich (aNumBins - 1) * aBinInterval
ist.
Die erfassten Statistiken können durch Aufrufen von otThreadResetTimeInQueueStat()
zurückgesetzt werden. Die Histogramminformationen werden seit der Initialisierung der OpenThread-Instanz oder seit dem letzten Zurücksetzen der Statistikerfassung durch Aufrufen von otThreadResetTimeInQueueStat()
erfasst.
Die Mauszeiger aNumBins
und aBinInterval
DÜRFEN NICHT NULL sein.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabe |
Ein Zeiger auf ein Array mit
aNumBins -Einträgen, die die erfassten Histogramminformationen darstellen. |
otThreadGetVendorModel
const char * otThreadGetVendorModel( otInstance *aInstance )
Rufen Sie den Modellstring des Anbieters ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Der Modellstring des Anbieters.
|
otThreadGetVendorName
const char * otThreadGetVendorName( otInstance *aInstance )
Rufen Sie den String des Anbieternamens ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Der String des Anbieternamens.
|
otThreadGetVendorSwVersion
const char * otThreadGetVendorSwVersion( otInstance *aInstance )
Rufen Sie den String der SW-Version des Anbieters ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Der SW-Versionsstring des Anbieters.
|
otThreadGetVersion
uint16_t otThreadGetVersion( void )
Ruft die Thread-Protokollversion ab.
Details | |
---|---|
Rückgabe |
die Thread-Protokollversion.
|
otThreadIsAnycastLocateInProgress
bool otThreadIsAnycastLocateInProgress( otInstance *aInstance )
Gibt an, ob gerade eine Anycast-Standortanfrage in Bearbeitung ist.
Ist nur verfügbar, wenn OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE
aktiviert ist.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
TRUE, wenn gerade eine Anycast-Ortungsanforderung in Bearbeitung ist, andernfalls FALSE.
|
otThreadIsDiscoverInProgress
bool otThreadIsDiscoverInProgress( otInstance *aInstance )
Ermittelt, ob gerade eine MLE-Thread-Erkennung läuft.
Details | |||
---|---|---|---|
Parameter |
|
otThreadIsSingleton
bool otThreadIsSingleton( otInstance *aInstance )
Gibt an, ob ein Knoten der einzige Router im Netzwerk ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadLocateAnycastDestination
otError otThreadLocateAnycastDestination( otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext )
Fordert an, dass das nächstgelegene Ziel einer bestimmten Anycast-Adresse ermittelt werden soll.
Ist nur verfügbar, wenn OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE
aktiviert ist.
Wenn eine vorherige Anfrage aktiv ist, wird durch einen nachfolgenden Aufruf dieser Funktion die vorherige Anfrage abgebrochen und ersetzt.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||
Rückgabewerte |
|
otThreadRegisterParentResponseCallback
void otThreadRegisterParentResponseCallback( otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext )
Registriert einen Callback für den Empfang von MLE Parent Response-Daten.
Erfordert OPENTHREAD_CONFIG_MLE_PARENT_RESPONSE_CALLBACK_API_ENABLE
.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
otThreadResetIp6Counters
void otThreadResetIp6Counters( otInstance *aInstance )
Setzt die IPv6-Zähler zurück.
Details | |||
---|---|---|---|
Parameter |
|
otThreadResetMleCounters
void otThreadResetMleCounters( otInstance *aInstance )
Setzt die Thread MLE-Zähler zurück.
Details | |||
---|---|---|---|
Parameter |
|
otThreadResetTimeInQueueStat
void otThreadResetTimeInQueueStat( otInstance *aInstance )
Setzt die Statistiken für die Zeit in der TX-Warteschlange zurück.
Erfordert OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE
.
Details | |||
---|---|---|---|
Parameter |
|
otThreadSearchForBetterParent
otError otThreadSearchForBetterParent( otInstance *aInstance )
Startet den Prozess für das Kind, nach einem besseren Elternteil zu suchen, ohne mit seinem aktuellen Elternteil verbunden zu bleiben
Muss verwendet werden, wenn das Gerät als Kind angeschlossen ist.
Details | |||||
---|---|---|---|---|---|
Rückgabewerte |
|
otThreadSendAddressNotification
void otThreadSendAddressNotification( otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid )
Sendet eine Nachricht zur proaktiven Adressbenachrichtigung (ADDR_NTF.ntf).
Ist nur verfügbar, wenn OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
aktiviert ist.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
otThreadSendDiagnosticGet
otError otThreadSendDiagnosticGet( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext )
Sende eine Anfrage zum Abrufen der Netzwerkdiagnose.
Erfordert OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE
.
Details | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||||||
Rückgabewerte |
|
otThreadSendDiagnosticReset
otError otThreadSendDiagnosticReset( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount )
Anfrage zum Zurücksetzen der Netzwerkdiagnose senden.
Erfordert OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE
.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||
Rückgabewerte |
|
otThreadSendProactiveBackboneNotification
otError otThreadSendProactiveBackboneNotification( otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction )
Sendet eine proaktive Backbone-Benachrichtigung (PRO_BB.ntf) für den Backbone-Link.
Ist nur verfügbar, wenn OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
aktiviert ist.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||
Rückgabewerte |
|
otThreadSetChildTimeout
void otThreadSetChildTimeout( otInstance *aInstance, uint32_t aTimeout )
Legt das Zeitlimit für untergeordnete Threads (in Sekunden) fest, das beim Betrieb in der untergeordneten Rolle verwendet wird.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otThreadGetChildTimeout
otThreadSetDiscoveryRequestCallback
void otThreadSetDiscoveryRequestCallback( otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext )
Legt einen Callback zum Empfang von MLE-Discovery-Anfragedaten fest.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
otThreadSetDomainName
otError otThreadSetDomainName( otInstance *aInstance, const char *aDomainName )
Legt den Thread-Domainnamen fest.
Funktioniert nur, wenn Thread-Protokolle deaktiviert sind.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadGetDomainName
otThreadSetEnabled
otError otThreadSetEnabled( otInstance *aInstance, bool aEnabled )
Startet den Thread-Protokollvorgang.
Die Schnittstelle muss aktiv sein, wenn Sie diese Funktion aufrufen.
Wenn Sie diese Funktion aufrufen, während aEnabled
auf FALSE gesetzt ist, werden alle laufenden Trennungsprozesse beendet, die durch otThreadDetachGracefully() gestartet wurden. Der zugehörige Callback wird aufgerufen.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadSetExtendedPanId
otError otThreadSetExtendedPanId( otInstance *aInstance, const otExtendedPanId *aExtendedPanId )
Legt die erweiterte IEEE 802.15.4-PAN-ID fest.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadGetExtendedPanId
otThreadSetFixedDuaInterfaceIdentifier
otError otThreadSetFixedDuaInterfaceIdentifier( otInstance *aInstance, const otIp6InterfaceIdentifier *aIid )
Legt die Schnittstellenkennung fest oder löscht sie, die manuell für die Unicast-Adresse der Thread-Domain angegeben wurde.
Verfügbar, wenn OPENTHREAD_CONFIG_DUA_ENABLE
aktiviert ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadGetFixedDuaInterfaceIdentifier
otThreadSetJoinerAdvertisement
otError otThreadSetJoinerAdvertisement( otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength )
Legt die Thread Joiner-Anzeige beim Erkennen des Thread-Netzwerks fest.
Thread Joiner-Werbung wird verwendet, um einem Joiner die Möglichkeit zu geben, seine eigenen anwendungsspezifischen Informationen (z. B. Anbieter-ID, Produkt-ID, Diskriminator usw.) über ein neu vorgeschlagenes Joiner Advertisement TLV zu bewerben und diese Informationen den Kommissarn oder Kandidaten ohne menschliche Interaktion zur Verfügung zu stellen.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||
Rückgabewerte |
|
otThreadSetKeySequenceCounter
void otThreadSetKeySequenceCounter( otInstance *aInstance, uint32_t aKeySequenceCounter )
Legt den thrKeySequenceCounter fest.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otThreadGetKeySequenceCounter
otThreadSetKeySwitchGuardTime
void otThreadSetKeySwitchGuardTime( otInstance *aInstance, uint32_t aKeySwitchGuardTime )
Legt die thrKeySwitchGuardTime (in Stunden) fest.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otThreadGetKeySwitchGuardTime
otThreadSetLinkMode
otError otThreadSetLinkMode( otInstance *aInstance, otLinkModeConfig aConfig )
Legen Sie die Konfiguration des MLE-Linkmodus fest.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadGetLinkMode
otThreadSetMeshLocalPrefix
otError otThreadSetMeshLocalPrefix( otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix )
Legt das lokale Mesh-Präfix fest.
Nur erfolgreich, wenn Thread-Protokolle deaktiviert sind. Ein erfolgreicher Aufruf dieser Funktion macht die aktiven und ausstehenden operativen Datasets im nichtflüchtigen Speicher ungültig.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadSetNetworkKey
otError otThreadSetNetworkKey( otInstance *aInstance, const otNetworkKey *aKey )
Legen Sie den Thread-Netzwerkschlüssel fest.
Nur erfolgreich, wenn Thread-Protokolle deaktiviert sind. Ein erfolgreicher Aufruf dieser Funktion macht die aktiven und ausstehenden operativen Datasets im nichtflüchtigen Speicher ungültig.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadGetNetworkKey
otThreadSetNetworkKeyRef
otError otThreadSetNetworkKeyRef( otInstance *aInstance, otNetworkKeyRef aKeyRef )
Legen Sie den Thread-Netzwerkschlüssel als otNetworkKeyRef
fest.
Nur erfolgreich, wenn Thread-Protokolle deaktiviert sind. Ein erfolgreicher Aufruf dieser Funktion macht die aktiven und ausstehenden operativen Datasets im nichtflüchtigen Speicher ungültig.
Erfordert, dass das Build-Zeitfeature OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
aktiviert ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadGetNetworkKeyRef
otThreadSetNetworkName
otError otThreadSetNetworkName( otInstance *aInstance, const char *aNetworkName )
Legen Sie den Thread-Netzwerknamen fest.
Nur erfolgreich, wenn Thread-Protokolle deaktiviert sind. Ein erfolgreicher Aufruf dieser Funktion macht die aktiven und ausstehenden operativen Datasets im nichtflüchtigen Speicher ungültig.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadGetNetworkName
otThreadSetVendorModel
otError otThreadSetVendorModel( otInstance *aInstance, const char *aVendorModel )
Legt den String für das Anbietermodell fest.
Erfordert OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE
.
aVendorModel
muss im UTF-8-Format vorliegen und darf maximal 32 Zeichen lang sein (MAX_VENDOR_MODEL_TLV_LENGTH
). Die maximale Länge darf nicht das Nullzeichen \0
enthalten.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadSetVendorName
otError otThreadSetVendorName( otInstance *aInstance, const char *aVendorName )
Legen Sie den String für den Anbieternamen fest.
Erfordert OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE
.
aVendorName
muss im UTF-8-Format vorliegen und darf maximal 32 Zeichen lang sein (MAX_VENDOR_NAME_TLV_LENGTH
). Die maximale Länge darf nicht das Nullzeichen \0
enthalten.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadSetVendorSwVersion
otError otThreadSetVendorSwVersion( otInstance *aInstance, const char *aVendorSwVersion )
Legt den String für die Softwareversion des Anbieters fest.
Erfordert OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE
.
aVendorSwVersion
sollte UTF8-Zeichen mit einer maximalen Länge von 16 Zeichen(MAX_VENDOR_SW_VERSION_TLV_LENGTH
) sein. Die maximale Länge darf nicht das Null-\0
-Zeichen enthalten.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
Makros
OT_DURATION_STRING_SIZE
OT_DURATION_STRING_SIZE 21
Empfohlene Größe für die Stringdarstellung der uint32_t
-Dauer in Sekunden.
OT_JOINER_ADVDATA_MAX_LENGTH
OT_JOINER_ADVDATA_MAX_LENGTH 64
Maximale AdvData-Länge von Joiner-Werbung.
OT_NEIGHBOR_INFO_ITERATOR_INIT
OT_NEIGHBOR_INFO_ITERATOR_INIT 0
Initialisierer für otNeighborInfoIterator.
OT_NETWORK_BASE_TLV_MAX_LENGTH
OT_NETWORK_BASE_TLV_MAX_LENGTH 254
Maximale Wertlänge des Thread-Base-TLV.
OT_NETWORK_DATA_ITERATOR_INIT
OT_NETWORK_DATA_ITERATOR_INIT 0
Wert zum Initialisieren von otNetworkDataIterator
.
OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE
OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3
Größe des Eintrags in der untergeordneten Netzwerkdiagnose-Tabelle.
OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT
OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0
Initialisierer für otNetworkDiagIterator.
OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH
OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH 64
Maximale Länge der Thread-Stack-Version TLV.
OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH
OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH 32
Maximale Länge des Anbietermodells TLV.
OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH
OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH 32
Maximale Länge des Lieferantennamens TLV.
OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH
OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH 16
Maximale Länge der SW-Version TLV des Anbieters.
OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES
OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19
Maximale Anzahl von Netzwerkdiagnose-TLV-Typen, die angefordert oder zurückgesetzt werden können.
OT_NETWORK_MAX_ROUTER_ID
OT_NETWORK_MAX_ROUTER_ID 62
Maximale Router-ID.
OT_SERVER_DATA_MAX_SIZE
OT_SERVER_DATA_MAX_SIZE 248
Maximale Größe von Serverdaten in Byte. Theoretische Grenze, praktisch viel niedriger.
OT_SERVICE_DATA_MAX_SIZE
OT_SERVICE_DATA_MAX_SIZE 252
Maximale Größe von Dienstdaten in Byte.
Ressourcen
OpenThread API-Referenzthemen stammen aus dem Quellcode, der auf GitHub verfügbar ist. Weitere Informationen finden Sie unter Ressourcen. Dort können Sie auch einen Beitrag zu unserer Dokumentation leisten.