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.

Aufzählungen

anonymous enum{
  OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS = 0,
  OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS = 1,
  OT_NETWORK_DIAGNOSTIC_TLV_MODE = 2,
  OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT = 3,
  OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY = 4,
  OT_NETWORK_DIAGNOSTIC_TLV_ROUTE = 5,
  OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA = 6,
  OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA = 7,
  OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST = 8,
  OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS = 9,
  OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL = 14,
  OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE = 15,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE = 16,
  OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES = 17,
  OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST = 18,
  OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT = 19,
  OT_NETWORK_DIAGNOSTIC_TLV_VERSION = 24,
  OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME = 25,
  OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL = 26,
  OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION = 27,
  OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION = 28,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD = 29,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST = 30,
  OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR = 31,
  OT_NETWORK_DIAGNOSTIC_TLV_ANSWER = 32,
  OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID = 33,
  OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS = 34
}
enum
otDeviceRole{
  OT_DEVICE_ROLE_DISABLED = 0,
  OT_DEVICE_ROLE_DETACHED = 1,
  OT_DEVICE_ROLE_CHILD = 2,
  OT_DEVICE_ROLE_ROUTER = 3,
  OT_DEVICE_ROLE_LEADER = 4
}
enum
Stellt eine Thread-Geräterolle dar.
otNetDataPublisherEvent{
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
}
enum
Stellt die Ereignisse dar, die von den Publisher-Callbacks erfasst werden.
otRoutePreference{
  OT_ROUTE_PREFERENCE_LOW = -1,
  OT_ROUTE_PREFERENCE_MED = 0,
  OT_ROUTE_PREFERENCE_HIGH = 1
}
enum
Definiert gültige Werte für mPreference in otExternalRouteConfig und otBorderRouterConfig.

Typedefs

otBorderRouterConfig typedef
Stellt eine Border-Router-Konfiguration dar.
otDetachGracefullyCallback)(void *aContext) typedef
void(*
Dieser Callback informiert die Anwendung darüber, dass der Trennvorgang abgeschlossen wurde.
otExternalRouteConfig typedef
Stellt eine Konfiguration externer Routen dar.
otIpCounters typedef
struct otIpCounters
Stellt die Zähler auf IP-Ebene dar.
otLeaderData typedef
struct otLeaderData
Stellt die Thread-Leader-Daten dar.
otLinkModeConfig typedef
Stellt eine MLE-Linkmoduskonfiguration dar.
otLowpanContextInfo typedef
Stellt 6LoWPAN-Kontext-ID-Informationen dar, die mit einem Präfix in Netzwerkdaten verknüpft sind.
otMleCounters typedef
struct otMleCounters
Stellt die Thread-MLE-Zähler dar.
otNeighborInfoIterator typedef
int16_t
Wird verwendet, um durch die benachbarte Tabelle zu iterieren.
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext) typedef
void(*
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) typedef
void(*
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 typedef
uint32_t
Wird verwendet, um über Netzwerkdateninformationen zu iterieren.
otNetworkDiagChildEntry typedef
Stellt einen untergeordneten Tabelleneintrag für die Netzwerkdiagnose dar.
otNetworkDiagConnectivity typedef
Stellt einen Wert für die Netzwerkdiagnoseverbindung dar.
otNetworkDiagIterator typedef
uint16_t
Wird für die Iteration über Netzwerkdiagnose TLV verwendet.
otNetworkDiagMacCounters typedef
Stellt einen Wert für Mac-Zähler für die Netzwerkdiagnose dar.
otNetworkDiagMleCounters typedef
Stellt einen Wert für Netzwerkdiagnose-MLE-Zähler dar.
otNetworkDiagRoute typedef
Stellt einen TLV-Wert der Netzwerkdiagnoseroute dar.
otNetworkDiagRouteData typedef
Stellt Daten für Netzwerkdiagnoserouten dar.
otNetworkDiagTlv typedef
Stellt einen Netzwerkdiagnose-TLV dar.
otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) typedef
void(*
Der Zeiger wird aufgerufen, wenn die Netzwerkdiagnose-Get-Antwort empfangen wird.
otRoutePreference typedef
Definiert gültige Werte für mPreference in otExternalRouteConfig und otBorderRouterConfig.
otServerConfig typedef
Stellt eine Serverkonfiguration dar.
otServiceConfig typedef
Stellt eine Dienstkonfiguration dar.
otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) typedef
void(*
Der Zeigertyp definiert den Callback, mit dem über das Ergebnis einer otThreadLocateAnycastDestination()-Anfrage informiert wird.
otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) typedef
void(*
Der Pointer wird jedes Mal aufgerufen, wenn eine MLE-Erkennungsanfragenachricht empfangen wird.
otThreadDiscoveryRequestInfo typedef
Stellt die Daten der Thread-Erkennungsanfrage dar.
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext) typedef
void(*
Pointer wird jedes Mal aufgerufen, wenn eine MLE-Antwortnachricht für übergeordnete Inhalte empfangen wird.
otThreadParentResponseInfo typedef
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)
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)
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
Attribute
OT_NETWORK_DIAGNOSTIC_TLV_ANSWER

Antworte TLV.

OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

TLV-Akkustand.

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD

Untergeordnetes TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST

Untergeordnete IPv6-Adressenliste – TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

Untergeordnete Tabelle TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

TLV-Konnektivität.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

TLV für erweiterte MAC-Adresse.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

IPv6-Adressenliste TLV.

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

Leader-Data-TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

MAC-Zähler – TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

Maximale Zeitüberschreitung für untergeordnetes Element (TLV).

OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS

MLE-Zähler TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MODE

Modus TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

Netzwerkdaten-TLV.

OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID

Abfrage-ID TLV.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

Route64 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR

Router Neighbor TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

Adresse16 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

Versorgungsspannung TLV.

OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION

Thread-Stack-Version TLV.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

Zeitlimit TLV (der maximale Abfragezeitraum für SEDs)

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

Geben Sie „Liste TLV“ ein.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL

Anbietermodell – TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME

Name des Anbieters TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION

SW-Version TLV des Anbieters.

OT_NETWORK_DIAGNOSTIC_TLV_VERSION

Version TLV.

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
[in] aContext
Ein Zeiger auf einen anwendungsspezifischen Kontext.

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

Stellt eine Konfiguration externer Routen dar.

otIpCounters

struct otIpCounters otIpCounters

Stellt die Zähler auf IP-Ebene dar.

otLeaderData

struct otLeaderData otLeaderData

Stellt die Thread-Leader-Daten 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.

otMleCounters

struct otMleCounters otMleCounters

Stellt die Thread-MLE-Zähler dar.

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
[in] aEvent
Gibt das Ereignis an (ob der Eintrag hinzugefügt oder entfernt wurde).
[in] aContext
Ein Zeiger auf einen anwendungsspezifischen Kontext.

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
[in] aEvent
Gibt das Ereignis an (ob der Eintrag hinzugefügt oder entfernt wurde).
[in] aPrefix
Ein Zeiger auf den Präfixeintrag.
[in] aContext
Ein Zeiger auf einen anwendungsspezifischen Kontext.

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.

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

Stellt einen Netzwerkdiagnose-TLV 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
[in] aError
Der Fehler, wenn die Antwort nicht abgerufen werden konnte.
[in] aMessage
Ein Zeiger auf den Nachrichtenpuffer, der die empfangene Nutzlast der Netzwerkdiagnose-Get-Antwort enthält. Nur verfügbar, wenn aError den Wert OT_ERROR_NONE hat.
[in] aMessageInfo
Ein Zeiger auf die Nachrichteninformationen für aMessage. Nur verfügbar, wenn aError den Wert OT_ERROR_NONE hat.
[in] aContext
Ein Zeiger auf einen anwendungsspezifischen Kontext.

otRoutePreference

enum otRoutePreference otRoutePreference

Definiert gültige Werte für mPreference in otExternalRouteConfig und otBorderRouterConfig.

otServerConfig

struct otServerConfig otServerConfig

Stellt eine Serverkonfiguration dar.

otServiceConfig

struct otServiceConfig otServiceConfig

Stellt eine Dienstkonfiguration dar.

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
[in] aContext
Ein Zeiger auf einen beliebigen Kontext, der bereitgestellt wird, wenn ein Callback registriert wird.
[in] aError
Der Fehler bei der Verarbeitung der Anfrage. OT_ERROR_NONE bedeutet, dass der Vorgang erfolgreich war. OT_ERROR_RESPONSE_TIMEOUT gibt an, dass ein Ziel nicht gefunden wurde. OT_ERROR_ABORT gibt an, dass die Anfrage abgebrochen wurde.
[in] aMeshLocalAddress
Ein Zeiger auf die Mesh-Local-EID des nächstgelegenen Ziels der Anycast-Adresse, wenn aError OT_ERROR_NONE ist, ansonsten NULL.
[in] aRloc16
Der RLOC16 des Ziels, falls gefunden, andernfalls ungültiges RLOC16 (0xfffe).

otThreadDiscoveryRequestCallback

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

Der Pointer wird jedes Mal aufgerufen, wenn eine MLE-Erkennungsanfragenachricht empfangen wird.

Details
Parameter
[in] aInfo
Ein Zeiger auf die Daten der Discovery-Anfrage.
[in] aContext
Ein Zeiger zum Callback von anwendungsspezifischen Kontexten.

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
[in] aInfo
Ein Zeiger auf eine Position auf dem Stapel, der die Statistikdaten enthält.
[in] aContext
Ein Zeiger zum Callback des clientspezifischen Kontextes.

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 „::“ für Stunden, Minuten, Sekunden (wenn die Dauer kürzer als ein Tag ist) oder „

d.::" (falls länger als ein Tag ist).

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
[in] aDuration
Ein Dauerintervall in Sekunden.
[out] aBuffer
Ein Zeiger auf ein char-Array, um den String auszugeben.
[in] aSize
Die Größe von aBuffer (in Byte). Die Verwendung von OT_DURATION_STRING_SIZE wird empfohlen.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aPrefix
Ein Zeiger auf das IPv6-Präfix.
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aStable
TRUE beim Kopieren der stabilen Version, FALSE beim Kopieren der Vollversion.
[out] aData
Ein Zeiger auf den Datenpuffer.
[in,out] aDataLength
Beim Eintrag die Größe des Datenpuffers, auf den aData zeigt. Beim Beenden die Anzahl der kopierten Byte.
Rückgabewerte
OT_ERROR_NONE
Die Thread-Netzwerkdaten wurden in aData kopiert und aDataLength wurde aktualisiert.
OT_ERROR_NO_BUFS
Nicht genügend Speicherplatz in aData, um die Thread-Netzwerkdaten vollständig zu kopieren.

otNetDataGetCommissioningDataset

void otNetDataGetCommissioningDataset(
  otInstance *aInstance,
  otCommissioningDataset *aDataset
)

Ruft das Inbetriebnahme-Dataset aus den Netzwerkdaten der Partition ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf die OpenThread-Instanz.
[out] aDataset
Ein Zeiger auf ein otCommissioningDataset, das ausgefüllt werden soll.

otNetDataGetLength

uint8_t otNetDataGetLength(
  otInstance *aInstance
)

Ruft die aktuelle Länge (Anzahl der Byte) der Thread-Netzwerkdaten der Partition ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in,out] aIterator
Ein Zeiger auf den Netzwerkdaten-iterator. Für den ersten Diensteintrag sollte er auf OT_NETWORK_DATA_ITERATOR_INIT festgelegt werden.
[out] aContextInfo
Ein Zeiger auf die Stelle, an der die abgerufenen 6LoWPAN-Kontext-ID-Informationen platziert werden.
Rückgabewerte
OT_ERROR_NONE
Die nächsten 6LoWPAN-Kontext-ID-Informationen wurden gefunden.
OT_ERROR_NOT_FOUND
In den Netzwerkdaten der Partition sind keine nachfolgenden 6LoWPAN-Kontextinformationen vorhanden.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in,out] aIterator
Ein Zeiger auf den Kontext des Netzwerkdaten-iterators. Für den ersten Eintrag im Mesh-Netzwerk sollte er auf OT_NETWORK_DATA_ITERATOR_INIT festgelegt werden.
[out] aConfig
Ein Zeiger auf die Stelle, an der die Informationen zum On-Mesh-Präfix platziert werden.
Rückgabewerte
OT_ERROR_NONE
Das nächste „On Mesh“-Präfix wurde gefunden.
OT_ERROR_NOT_FOUND
In den Thread-Netzwerkdaten ist kein nachfolgendes „On Mesh“-Präfix vorhanden.

otNetDataGetNextRoute

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

Rufen Sie die nächste externe Route in den Netzwerkdaten der Partition ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in,out] aIterator
Ein Zeiger auf den Kontext des Netzwerkdaten-iterators. Zum Abrufen des ersten externen Routeneintrags sollte dieser auf OT_NETWORK_DATA_ITERATOR_INIT festgelegt werden.
[out] aConfig
Ein Zeiger auf die Stelle, an der die Informationen zur externen Route platziert werden sollen.
Rückgabewerte
OT_ERROR_NONE
Nächste externe Route wurde gefunden.
OT_ERROR_NOT_FOUND
In den Thread-Netzwerkdaten gibt es keinen nachfolgenden Eintrag für eine externe Route.

otNetDataGetNextService

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

Rufen Sie den nächsten Dienst aus den Netzwerkdaten der Partition ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in,out] aIterator
Ein Zeiger auf den Kontext des Netzwerkdaten-iterators. Für den ersten Diensteintrag sollte er auf OT_NETWORK_DATA_ITERATOR_INIT festgelegt werden.
[out] aConfig
Ein Verweis auf die Stelle, an der die Dienstinformationen platziert werden.
Rückgabewerte
OT_ERROR_NONE
Der nächste Dienst wurde gefunden.
OT_ERROR_NOT_FOUND
In den Netzwerkdaten der Partition ist kein nachfolgender Dienst vorhanden.

otNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

Rufen Sie die stabile Netzwerkdatenversion ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Die stabile Netzwerkdatenversion.

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

Rufen Sie die Netzwerkdatenversion ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabewerte
TRUE
Der veröffentlichte DNS/SRP-Diensteintrag wird den Thread-Netzwerkdaten hinzugefügt.
FALSE
Der Eintrag wird den Thread-Netzwerkdaten nicht hinzugefügt oder es gibt keinen Eintrag zum Veröffentlichen.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aPrefix
Ein Zeiger auf das Präfix (DARF NICHT NULL sein).
Rückgabewerte
TRUE
Der veröffentlichte Präfixeintrag wird den Thread-Netzwerkdaten hinzugefügt.
FALSE
Der Eintrag wird den Thread-Netzwerkdaten nicht hinzugefügt oder es gibt keinen Eintrag zum Veröffentlichen.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aSequenceNUmber
Die Sequenznummer des Anycast-Dienstes von DNS/SRP.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aAddress
Die zu veröffentlichende DNS-/SRP-Serveradresse (DARF NICHT NULL sein).
[in] aPort
Die Portnummer des SRP-Servers, die veröffentlicht werden soll.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aPort
Die Portnummer des SRP-Servers, die veröffentlicht werden soll.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aConfig
Die Konfiguration der externen Route, die veröffentlicht werden soll (DARF NICHT NULL sein).
Rückgabewerte
OT_ERROR_NONE
Die externe Route wurde veröffentlicht.
OT_ERROR_INVALID_ARGS
aConfig ist ungültig (ungültiges Präfix, ungültige Flag-Kombinationen oder nicht stabil).
OT_ERROR_NO_BUFS
Der neuen Anfrage konnte kein Eintrag zugeordnet werden. Der Publisher unterstützt eine begrenzte Anzahl von Einträgen, die durch die Konfiguration OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES bestimmt wird und die zwischen dem On-Mesh-Präfix und der externen Route geteilt wird.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aConfig
Die zu veröffentlichende On-Mesh-Präfixkonfiguration (DARF NICHT NULL sein).
Rückgabewerte
OT_ERROR_NONE
Das On-Mesh-Präfix wurde veröffentlicht.
OT_ERROR_INVALID_ARGS
aConfig ist ungültig (ungültiges Präfix, ungültige Flag-Kombinationen oder nicht stabil).
OT_ERROR_NO_BUFS
Der neuen Anfrage konnte kein Eintrag zugeordnet werden. Der Publisher unterstützt eine begrenzte Anzahl von Einträgen, die durch die Konfiguration OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES bestimmt wird und die zwischen dem On-Mesh-Präfix und der externen Route geteilt wird.

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 in aConfig 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 neue aConfig-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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aPrefix
Das zuvor veröffentlichte externe Routenpräfix, das ersetzt werden soll.
[in] aConfig
Die externe Routenkonfiguration, die veröffentlicht werden soll.
Rückgabewerte
OT_ERROR_NONE
Die externe Route wurde veröffentlicht.
OT_ERROR_INVALID_ARGS
aConfig ist ungültig (ungültiges Präfix, ungültige Flag-Kombinationen oder nicht stabil).
OT_ERROR_NO_BUFS
Der neuen Anfrage konnte kein Eintrag zugeordnet werden. Der Publisher unterstützt eine begrenzte Anzahl von Einträgen, die durch die Konfiguration OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES bestimmt wird und die zwischen dem On-Mesh-Präfix und der externen Route geteilt wird.

otNetDataResetMaxLength

void otNetDataResetMaxLength(
  otInstance *aInstance
)

Setzt die aufgezeichnete maximale Länge der Thread-Netzwerkdaten zurück.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Weitere Informationen:
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aCallback
Den Callback-Funktionszeiger (kann NULL sein, wenn nicht erforderlich)
[in] aContext
Ein Zeiger auf den anwendungsspezifischen Kontext, der beim Aufrufen von aCallback verwendet wird.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aCallback
Den Callback-Funktionszeiger (kann NULL sein, wenn nicht erforderlich)
[in] aContext
Ein Zeiger auf den anwendungsspezifischen Kontext, der beim Aufrufen von aCallback verwendet wird.

otNetDataSteeringDataCheckJoiner

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

Prüfen Sie, ob die Lenkungsdaten einen Joiner enthalten.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aEui64
Ein Zeiger auf den IEEE EUI-64 des Joiners.
Rückgabewerte
OT_ERROR_NONE
aEui64 ist in den Lenkungsdaten enthalten.
OT_ERROR_INVALID_STATE
Keine Lenkdaten vorhanden.
OT_ERROR_NOT_FOUND
aEui64 ist nicht in den Lenkungsdaten enthalten.

otNetDataSteeringDataCheckJoinerWithDiscerner

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

Prüfen Sie, ob die Lenkungsdaten einen Joiner mit einem bestimmten Discernerwert enthalten.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aDiscerner
Ein Zeiger auf den Joiner Discerner.
Rückgabewerte
OT_ERROR_NONE
aDiscerner ist in den Lenkungsdaten enthalten.
OT_ERROR_INVALID_STATE
Keine Lenkdaten vorhanden.
OT_ERROR_NOT_FOUND
aDiscerner ist nicht in den Lenkungsdaten enthalten.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aPrefix
Das Präfix, dessen Veröffentlichung aufgehoben werden soll (DARF NICHT NULL sein).
Rückgabewerte
OT_ERROR_NONE
Die Veröffentlichung des Präfixes wurde aufgehoben.
OT_ERROR_NOT_FOUND
Das Präfix wurde in der veröffentlichten Liste nicht gefunden.

otThreadBecomeChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

Versuchen Sie, die Datei noch einmal als Kind anzuhängen.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabewerte
OT_ERROR_NONE
Versuch erfolgreich, Kind zu werden.
OT_ERROR_INVALID_STATE
Unterhaltung ist deaktiviert.

otThreadBecomeDetached

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Trennen Sie die Verbindung zum Thread-Netzwerk.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabewerte
OT_ERROR_NONE
Verbindung zum Thread-Netzwerk getrennt.
OT_ERROR_INVALID_STATE
Unterhaltung ist deaktiviert.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aCallback
Ein Zeiger auf eine Funktion, die nach dem Beenden des Trennvorgangs aufgerufen wird.
[in] aContext
Ein Zeiger zum Callback von anwendungsspezifischen Kontexten.
Rückgabewerte
OT_ERROR_NONE
Trennen erfolgreich gestartet.
OT_ERROR_BUSY
Trennung läuft bereits.

otThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

Konvertieren Sie die Geräterolle in einen für Menschen lesbaren String.

Details
Parameter
[in] aRole
Die Geräterolle, die konvertiert werden soll.
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aScanChannels
Ein Bitvektor, der angibt, nach welchen Kanälen gesucht werden soll (z.B. OT_CHANNEL_11_MASK).
[in] aPanId
Der PAN-ID-Filter. Setzen Sie die Option auf Broadcast-PAN , um den Filter zu deaktivieren.
[in] aJoiner
Wert des Joiner-Flags in der Discovery Request TLV.
[in] aEnableEui64Filtering
TRUE, um Antworten auf EUI-64 zu filtern, andernfalls FALSE.
[in] aCallback
Ein Zeiger auf eine Funktion, die nach dem Empfang einer MLE-Erkennungsantwort oder nach Abschluss eines Scans aufgerufen wird.
[in] aCallbackContext
Ein Zeiger auf einen anwendungsspezifischen Kontext.
Rückgabewerte
OT_ERROR_NONE
Thread Discovery-Scan wurde gestartet.
OT_ERROR_INVALID_STATE
Die IPv6-Schnittstelle ist nicht aktiviert (netif nicht aktiv).
OT_ERROR_NO_BUFS
Nachricht für Discovery-Anfrage konnte nicht zugewiesen werden.
OT_ERROR_BUSY
Thread Discovery-Scan wird bereits ausgeführt.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Der Wert für das Zeitlimit für untergeordnete Threads in Sekunden.
Weitere Informationen:
otThreadSetChildTimeout

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Beanspruche die Geräterolle.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabewerte
OT_DEVICE_ROLE_DISABLED
Der Thread-Stack ist deaktiviert.
OT_DEVICE_ROLE_DETACHED
Das Gerät ist derzeit nicht Teil eines Thread-Netzwerks bzw. einer Thread-Partition.
OT_DEVICE_ROLE_CHILD
Das Gerät wird derzeit als untergeordnetes Thread-Element betrieben.
OT_DEVICE_ROLE_ROUTER
Das Gerät wird derzeit als Thread-Router betrieben.
OT_DEVICE_ROLE_LEADER
Das Gerät wird derzeit als Thread-Leader ausgeführt.

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Ruft den Thread-Domainnamen ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Ein Zeiger auf den Thread-Domainnamen.
Weitere Informationen:
otThreadSetDomainName

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Ruft die erweiterte IEEE 802.15.4-PAN-ID ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Ein Verweis auf die erweiterte IEEE 802.15.4-PAN-ID.
Siehe auch:
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Ein Zeiger auf den Schnittstellen-Identifikator, der manuell festgelegt wurde, oder NULL, wenn keiner festgelegt wurde.
Siehe auch:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Ruft die IPv6-Zähler ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Ein Zeiger auf die IPv6-Zähler.

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Ruft den thrKeySequenceCounter ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Der Wert thrKeySequenceCounter.
Siehe auch:
otThreadSetKeySequenceCounter

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Ruft die thrKeySwitchGuardTime (in Stunden) ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Der thrKeySwitchGuardTime-Wert (in Stunden).
Weitere Informationen:
otThreadSetKeySwitchGuardTime

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Die Thread-Leader-Daten abrufen.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[out] aLeaderData
Ein Zeiger an die Stelle, an der die Leader-Daten platziert werden.
Rückgabewerte
OT_ERROR_NONE
Die Leader-Daten wurden abgerufen.
OT_ERROR_DETACHED
Derzeit nicht angehängt.

otThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

Gibt einen Zeiger auf die RLOC des Leaders zurück.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[out] aLeaderRloc
Ein Hinweis auf die RLOC des Leaders.
Rückgabewerte
OT_ERROR_NONE
Die RLOC des Leaders wurde an aLeaderRloc geschrieben.
OT_ERROR_INVALID_ARGS
aLeaderRloc war NULL.
OT_ERROR_DETACHED
Derzeit nicht an eine Thread-Partition angehängt.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Rufen Sie die Router-ID des Leaders ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Router-ID des Leaders.

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

Erfahre mehr über das Gewicht der Spitzenreiter.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Konfiguration des MLE-Linkmodus.
Weitere Informationen:
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[out] aNetworkKey
Ein Zeiger auf einen otNetworkKey, um den Thread-Netzwerkschlüssel zurückzugeben.
Siehe auch:
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Verweis auf den im Arbeitsspeicher gespeicherten Thread-Netzwerkschlüssel.
Siehe auch:
otThreadSetNetworkKeyRef

otThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

Rufen Sie den Thread-Netzwerknamen ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Ein Zeiger auf den Thread-Netzwerknamen.
Weitere Informationen:
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
[in] aMessage
Ein Zeiger auf eine Nachricht.
[in,out] aIterator
Ein Zeiger auf den Kontext des Netzwerkdiagnose-Iterators. Um den ersten Netzwerkdiagnose-TLV zu erhalten, sollte dieser auf OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT gesetzt werden.
[out] aNetworkDiagTlv
Ein Zeiger auf die Stelle, an der die TLV-Daten der Netzwerkdiagnose platziert werden sollen.
Rückgabewerte
OT_ERROR_NONE
Nächster Netzwerkdiagnose-TLV wurde gefunden.
OT_ERROR_NOT_FOUND
Die Nachricht enthält keine nachfolgende Netzwerkdiagnose-TLV.
OT_ERROR_PARSE
Beim Parsen der nächsten Netzwerkdiagnose ist ein Fehler aufgetreten.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in,out] aIterator
Ein Zeiger auf den Iterationskontext. Um den ersten Nachbareintrag zu erhalten, sollte er auf OT_NEIGHBOR_INFO_ITERATOR_INIT gesetzt werden.
[out] aInfo
Ein Zeiger auf die Nachbarinformationen.
Rückgabewerte
OT_ERROR_NONE
Der nächste Nachbareintrag wurde in der Tabelle gefunden.
OT_ERROR_NOT_FOUND
In der Tabelle ist kein nachfolgender Nachbareintrag vorhanden.
OT_ERROR_INVALID_ARGS
aIterator oder aInfo war NULL.

otThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

Die Funktion ruft den durchschnittlichen RSSI für das übergeordnete Thread-Element ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[out] aParentRssi
Ein Zeiger an die Stelle, an der das übergeordnete RSSI platziert werden soll.

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

Die Funktion ruft Diagnoseinformationen für einen Thread Router als übergeordnetes Element ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[out] aParentInfo
Ein Zeiger auf die Stelle, an der die Informationen zum übergeordneten Router platziert werden.

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

Die Funktion ruft den RSSI des letzten Pakets aus dem übergeordneten Thread ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[out] aLastRssi
Ein Zeiger auf die Stelle, an der das letzte RSSI platziert werden soll.
Rückgabewerte
OT_ERROR_NONE
RSSI-Daten wurden abgerufen.
OT_ERROR_FAILED
RSSI-Daten konnten nicht abgerufen werden.
OT_ERROR_INVALID_ARGS
aLastRssi ist NULL.

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Rufen Sie die Partitions-ID ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Ein Zeiger auf die RLOC-Adresse (Thread Routing Locator).

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Hol dir den RLOC16.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aServiceId
Dienst-ID, für die ALOC abgerufen werden soll.
[out] aServiceAloc
Ein Zeiger zur Ausgabe des Dienst-ALOC. DARF NICHT NULL sein.
Rückgabewerte
OT_ERROR_NONE
Dienst-ALOC wurde abgerufen.
OT_ERROR_DETACHED
Die Thread-Schnittstelle ist derzeit nicht an eine Thread-Partition angehängt.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[out] aNumBins
Zeiger zum Zurückgeben der Anzahl der Klassen im Histogramm (Array-Länge).
[out] aBinInterval
Zeiger zum Zurückgeben der Bin-Intervalllänge in Millisekunden für das Histogramm.
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Der Modellstring des Anbieters.

otThreadGetVendorName

const char * otThreadGetVendorName(
  otInstance *aInstance
)

Rufen Sie den String des Anbieternamens ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Der String des Anbieternamens.

otThreadGetVendorSwVersion

const char * otThreadGetVendorSwVersion(
  otInstance *aInstance
)

Rufen Sie den String der SW-Version des Anbieters ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

Gibt an, ob ein Knoten der einzige Router im Netzwerk ist.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabewerte
TRUE
Er ist der einzige Router im Netzwerk.
FALSE
Er ist ein untergeordneter Router oder kein einzelner Router im Netzwerk.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aAnycastAddress
Die zu suchende Anycast-Adresse. DARF NICHT NULL sein.
[in] aCallback
Die Callback-Funktion, mit der das Ergebnis gemeldet wird.
[in] aContext
Ein beliebiger Kontext, der mit aCallback verwendet wird.
Rückgabewerte
OT_ERROR_NONE
Die Anfrage wurde gestartet. aCallback wird aufgerufen, um das Ergebnis zu melden.
OT_ERROR_INVALID_ARGS
aAnycastAddress ist keine gültige Anycast-Adresse oder aCallback ist NULL.
OT_ERROR_NO_BUFS
Der Puffer für die Vorbereitung und das Senden der Anfragenachricht ist abgelaufen.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aCallback
Ein Zeiger auf eine Funktion, die beim Empfang einer übergeordneten MLE-Antwortnachricht aufgerufen wird.
[in] aContext
Ein Zeiger zum Callback des clientspezifischen Kontextes.

otThreadResetIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Setzt die IPv6-Zähler zurück.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Setzt die Thread MLE-Zähler zurück.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.

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
OT_ERROR_NONE
Suche nach einem besseren Elternteil wurde gestartet.
OT_ERROR_INVALID_STATE
Die Geräterolle hat kein untergeordnetes Gerät.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aDestination
Das Ziel, an das die Nachricht ADDR_NTF.ntf gesendet werden soll.
[in] aTarget
Die Zieladresse der ADDR_NTF.ntf-Nachricht.
[in] aMlIid
Die ML-IID der ADDR_NTF.ntf-Nachricht.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aDestination
Ein Zeiger auf die Zieladresse.
[in] aTlvTypes
Ein Array von Netzwerkdiagnose-TLV-Typen.
[in] aCount
Anzahl der Typen in aTlvTypes.
[in] aCallback
Ein Zeiger auf eine Funktion, die beim Empfang einer Netzwerkdiagnose-Get-Antwort aufgerufen wird, oder auf NULL, um den Rückruf zu deaktivieren.
[in] aCallbackContext
Ein Zeiger auf einen anwendungsspezifischen Kontext.
Rückgabewerte
OT_ERROR_NONE
DIAG_GET.req.
OT_ERROR_NO_BUFS
Nicht genügend Nachrichtenpuffer zum Senden von DIAG_GET.req.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aDestination
Ein Zeiger auf die Zieladresse.
[in] aTlvTypes
Ein Array von Netzwerkdiagnose-TLV-Typen. Derzeit ist nur Typ 9 zulässig.
[in] aCount
Anzahl der Typen in aTlvTypes
Rückgabewerte
OT_ERROR_NONE
DIAG_RST.ntf wurde erfolgreich in Warteschlange gestellt.
OT_ERROR_NO_BUFS
Nicht genügend Nachrichtenpuffer zum Senden von DIAG_RST.ntf verfügbar.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aTarget
Die Zieladresse der PRO_BB.ntf-Nachricht.
[in] aMlIid
Die ML-IID der PRO_BB.ntf-Nachricht.
[in] aTimeSinceLastTransaction
Zeit seit der letzten Transaktion (in Sekunden).
Rückgabewerte
OT_ERROR_NONE
PRO_BB.ntf wurde über Backbone-Link gesendet.
OT_ERROR_NO_BUFS
Wenn nicht genügend Nachrichtenpuffer verfügbar sind.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aTimeout
Der Wert für das Zeitlimit in Sekunden.
Weitere Informationen:
otThreadGetChildTimeout

otThreadSetDiscoveryRequestCallback

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

Legt einen Callback zum Empfang von MLE-Discovery-Anfragedaten fest.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aCallback
Ein Zeiger auf eine Funktion, die nach dem Empfang einer MLE-Erkennungsanfragenachricht aufgerufen wird.
[in] aContext
Ein Zeiger zum Callback von anwendungsspezifischen Kontexten.

otThreadSetDomainName

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

Legt den Thread-Domainnamen fest.

Funktioniert nur, wenn Thread-Protokolle deaktiviert sind.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aDomainName
Ein Zeiger auf den Thread-Domainnamen.
Rückgabewerte
OT_ERROR_NONE
Thread-Domainname erfolgreich festgelegt.
OT_ERROR_INVALID_STATE
Thread-Protokolle sind aktiviert.
Weitere Informationen:
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aEnabled
TRUE, wenn Thread aktiviert ist, andernfalls FALSE.
Rückgabewerte
OT_ERROR_NONE
Thread-Protokollvorgang wurde gestartet.
OT_ERROR_INVALID_STATE
Die Netzwerkschnittstelle war nicht aktiv.

otThreadSetExtendedPanId

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

Legt die erweiterte IEEE 802.15.4-PAN-ID fest.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aExtendedPanId
Ein Verweis auf die erweiterte IEEE 802.15.4-PAN-ID.
Rückgabewerte
OT_ERROR_NONE
Die erweiterte PAN-ID wurde festgelegt.
OT_ERROR_INVALID_STATE
Thread-Protokolle sind aktiviert.
Siehe auch:
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aIid
Ein Zeiger auf den Schnittstellen-Identifikator, der festgelegt werden soll, oder auf NULL, um ihn zu löschen.
Rückgabewerte
OT_ERROR_NONE
Schnittstellen-ID erfolgreich festgelegt/gelöscht
OT_ERROR_INVALID_ARGS
Die angegebene Schnittstellen-ID ist reserviert.
Siehe auch:
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aOui
Der IEEE-OUI-Wert des Anbieters, der in die Joiner-Anzeige aufgenommen wird. Nur die niedrigstwertigen Byte werden verwendet und das höchstwertige Byte wird ignoriert.
[in] aAdvData
Ein Zeiger auf die AdvData, die in der Joiner-Anzeige enthalten sein werden.
[in] aAdvDataLength
Die Länge von AdvData in Byte.
Rückgabewerte
OT_ERROR_NONE
Joiner-Anzeige wurde festgelegt.
OT_ERROR_INVALID_ARGS
Ungültige AdvData.

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Legt den thrKeySequenceCounter fest.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aKeySequenceCounter
Der Wert thrKeySequenceCounter.
Siehe auch:
otThreadGetKeySequenceCounter

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Legt die thrKeySwitchGuardTime (in Stunden) fest.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aKeySwitchGuardTime
Der thrKeySwitchGuardTime-Wert (in Stunden).
Weitere Informationen:
otThreadGetKeySwitchGuardTime

otThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Legen Sie die Konfiguration des MLE-Linkmodus fest.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aConfig
Ein Zeiger auf die Konfiguration des Linkmodus.
Rückgabewerte
OT_ERROR_NONE
Die Konfiguration des MLE-Linkmodus wurde festgelegt.
Weitere Informationen:
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aMeshLocalPrefix
Ein Zeiger auf das lokale Mesh-Präfix.
Rückgabewerte
OT_ERROR_NONE
Das lokale Mesh-Präfix wurde festgelegt.
OT_ERROR_INVALID_STATE
Thread-Protokolle sind aktiviert.

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aKey
Ein Zeiger auf einen Puffer, der den Thread-Netzwerkschlüssel enthält.
Rückgabewerte
OT_ERROR_NONE
Thread-Netzwerkschlüssel festgelegt.
OT_ERROR_INVALID_STATE
Thread-Protokolle sind aktiviert.
Weitere Informationen:
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aKeyRef
Verweis auf den Thread-Netzwerkschlüssel.
Rückgabewerte
OT_ERROR_NONE
Thread-Netzwerkschlüssel festgelegt.
OT_ERROR_INVALID_STATE
Thread-Protokolle sind aktiviert.
Weitere Informationen:
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aNetworkName
Ein Zeiger auf den Thread-Netzwerknamen.
Rückgabewerte
OT_ERROR_NONE
Thread-Netzwerkname erfolgreich festgelegt.
OT_ERROR_INVALID_STATE
Thread-Protokolle sind aktiviert.
Weitere Informationen:
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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aVendorModel
Der Modellstring des Anbieters.
Rückgabewerte
OT_ERROR_NONE
Das Anbietermodell wurde festgelegt.
OT_ERROR_INVALID_ARGS
aVendorModel ist ungültig (zu lang oder nicht in UTF8).

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aVendorName
Der String des Anbieternamens.
Rückgabewerte
OT_ERROR_NONE
Der Anbietername wurde festgelegt.
OT_ERROR_INVALID_ARGS
aVendorName ist ungültig (zu lang oder nicht in UTF8).

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
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aVendorSwVersion
Der String der Anbietersoftwareversion.
Rückgabewerte
OT_ERROR_NONE
Die Softwareversion des Anbieters wurde festgelegt.
OT_ERROR_INVALID_ARGS
aVendorSwVersion ist ungültig (zu lang oder nicht in UTF8).

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.