Oberfräsen

Dieses Modul enthält Funktionen für Thread-Router und -Leader.

Fazit

Aufzählungen

otCacheEntryState enum
Diese Aufzählung definiert den EID-Cache-Eingabestatus.
otNeighborTableEvent{
  OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED,
  OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED,
  OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED,
  OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED,
  OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED
}
enum
Diese Aufzählung definiert die Konstanten, die in otNeighborTableCallback verwendet werden, um Änderungen in der Nachbartabelle anzuzeigen.

Typdef.

otCacheEntryInfo Typdef
Diese Struktur stellt einen EID-Cache-Eintrag dar.
otCacheEntryIterator Typdef
Dieser Typ stellt einen Hyperparameter dar, der über die Einträge in der EID-Cache-Tabelle iteriert wird.
otCacheEntryState Typdef
Diese Aufzählung definiert den EID-Cache-Eingabestatus.
otChildIp6AddressIterator Typdef
uint16_t
Wird zur Iteration von IPv6-Adressen eines untergeordneten Thread-Eintrags verwendet.
otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo) Typdef
void(*
Dieser Funktionszeiger wird aufgerufen, um zu benachrichtigen, dass die Nachbartabelle geändert wurde.

Funktionen

otThreadBecomeLeader(otInstance *aInstance)
Führen Sie die Führungsrolle ein und starten Sie eine neue Partition.
otThreadBecomeRouter(otInstance *aInstance)
Versuchen Sie, Router zu werden.
otThreadGetChildInfoById(otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
Die Funktion speichert Diagnoseinformationen für ein angehängtes untergeordnetes Element anhand seiner untergeordneten ID oder RLOC16.
otThreadGetChildInfoByIndex(otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
Die Funktion speichert Diagnoseinformationen für einen verknüpften untergeordneten Bereich vom internen Tabellenindex.
otThreadGetChildNextIp6Address(otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
Diese Funktion ruft die nächste IPv6-Adresse (mit einem chromeos) für ein bestimmtes untergeordnetes Element auf.
otThreadGetContextIdReuseDelay(otInstance *aInstance)
uint32_t
Rufen Sie den Parameter CONTEXT_ID_REUSE_DELAY ab, der in der Leader-Rolle verwendet wird.
otThreadGetJoinerUdpPort(otInstance *aInstance)
uint16_t
Rufen Sie den Joiner-UDP-Port ab.
otThreadGetLocalLeaderWeight(otInstance *aInstance)
uint8_t
Ermittle die Threads-Gewichtung, die bei deiner Tätigkeit in der Führungsrolle verwendet werden.
otThreadGetMaxAllowedChildren(otInstance *aInstance)
uint16_t
Ermitteln Sie die maximal zulässige Anzahl von Kindern.
otThreadGetMaxChildIpAddresses(otInstance *aInstance)
uint8_t
Diese Funktion erhält die maximale Anzahl von IP-Adressen, die jedes MTD-Kind mit diesem Gerät als übergeordnetes Element registrieren kann.
otThreadGetMaxRouterId(otInstance *aInstance)
uint8_t
Die Funktion gibt die maximal zulässige Router-ID zurück.
otThreadGetNetworkIdTimeout(otInstance *aInstance)
uint8_t
Rufen Sie den Parameter NETWORK_ID_TIMEOUT ab, der in der Rolle des Routers verwendet wird.
otThreadGetNextCacheEntry(otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
Diese Funktion ruft den nächsten EID-Cache-Eintrag ab (mithilfe eines Recommenders).
otThreadGetParentPriority(otInstance *aInstance)
int8_t
Rufen Sie die zugewiesene übergeordnete Priorität ab.
otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)
uint32_t
Ermitteln Sie die bevorzugte ID für die Thread-Lead-Partition, die bei Ausführung der Führungsrolle verwendet wird.
otThreadGetPskc(otInstance *aInstance, otPskc *aPskc)
void
Den Thread PSKc abrufen.
otThreadGetPskcRef(otInstance *aInstance)
Schlüsselreferenz für Thread PSKc speichern.
otThreadGetRouterDowngradeThreshold(otInstance *aInstance)
uint8_t
Rufen Sie den Parameter ROUTER_DOWNGRADE_THRESHOLD ab, der in der Routerrolle verwendet wird.
otThreadGetRouterIdRange(otInstance *aInstance, uint8_t *aMinRouterId, uint8_t *aMaxRouterId)
void
Diese Funktion ruft den Bereich der Router-IDs ab, die Knoten im Thread-Netzwerk zugewiesen werden dürfen.
otThreadGetRouterIdSequence(otInstance *aInstance)
uint8_t
Rufen Sie die aktuelle Router-ID-Sequenz ab.
otThreadGetRouterInfo(otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)
Die Funktion speichert Diagnoseinformationen für einen bestimmten Thread-Router.
otThreadGetRouterSelectionJitter(otInstance *aInstance)
uint8_t
Rufen Sie den Parameter ROUTER_SELECTION_JITTER in der Rolle REED/Router ab.
otThreadGetRouterUpgradeThreshold(otInstance *aInstance)
uint8_t
Parameter ROUTER_UPGRADE_THRESHOLD abrufen, die in der Rolle REED verwendet wird.
otThreadIsRouterEligible(otInstance *aInstance)
bool
Diese Methode gibt an, ob das Gerät für den Router geeignet ist.
otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback)
void
Mit dieser Funktion wird eine Callback-Funktion für eine benachbarte Tabelle registriert.
otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)
Geben Sie eine Router-ID kostenlos, die vom Gerät in der Rolle „Lead“ zugewiesen wurde.
otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled)
void
Mit dieser Funktion wird festgelegt, ob das Gerät mithilfe von CCM in Betrieb genommen wurde.
otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t aDelay)
void
Legen Sie den Parameter CONTEXT_ID_REUSE_DELAY fest, der in der Leader-Rolle verwendet wird.
otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)
Legen Sie den Join-UDP-Port fest.
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)
void
Legen Sie die Priorität der Thread-Lead fest, die beim Ausführen der Leader-Rolle verwendet wird.
otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)
Damit legen Sie die maximal zulässige Anzahl von Kindern fest.
otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)
Mit dieser Funktion wird die maximale Anzahl von IP-Adressen festgelegt/wiederhergestellt, die jedes MTD-Untergeordnetes Gerät bei diesem Gerät als übergeordnetes Element registrieren kann.
otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)
void
Legen Sie den Parameter NETWORK_ID_TIMEOUT fest, der in der Leader-Rolle verwendet wird.
otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)
Legen Sie die übergeordnete Priorität fest.
otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)
void
Legen Sie die bevorzugte Partitions-ID für Thread-Lead fest, die beim Ausführen der Leader-Rolle verwendet wird.
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)
Stellen Sie die bevorzugte Router-ID ein.
otThreadSetPskc(otInstance *aInstance, const otPskc *aPskc)
Den Thread PSKc festlegen.
otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)
Den Thread PSKc festlegen.
otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
Legen Sie den Parameter ROUTER_DOWNGRADE_THRESHOLD fest, der in der Rolle "Lead" verwendet wird.
otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)
Mit dieser Funktion wird festgelegt, ob das Gerät Router-fähig ist.
otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)
Mit dieser Funktion wird der Bereich der Router-IDs festgelegt, die Knoten im Thread-Netzwerk zugewiesen werden dürfen.
otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)
void
Legen Sie den Parameter ROUTER_SELECTION_JITTER in der Rolle REED/Router fest.
otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
Legen Sie den Parameter ROUTER_UPGRADE_THRESHOLD fest, der in der Leader-Rolle verwendet wird.
otThreadSetSteeringData(otInstance *aInstance, const otExtAddress *aExtAddress)
void
Lenkungsdaten außerhalb des Armbands festlegen.
otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)
void
Mit dieser Funktion wird festgelegt, ob der TLV-Versionsgrenzwert für das Routing (VR-Feld) aktiviert ist.

Strebenklemmen

otCacheEntryInfo

Diese Struktur stellt einen EID-Cache-Eintrag dar.

otCacheEntryOverride

Dieser Typ stellt einen Hyperparameter dar, der über die Einträge in der EID-Cache-Tabelle iteriert wird.

otChildInfo

Diese Struktur enthält Diagnoseinformationen für einen untergeordneten Thread.

otNeighborTableEntryInfo

Dieser Typ stellt Informationen zu einem Nachbartabelleneintrag (untergeordnet oder Router) dar und wird als Parameter im Nachbartabellen-Callback otNeighborTableCallback verwendet.

Aufzählungen

otCacheEntryState

 otCacheEntryState

Diese Aufzählung definiert den EID-Cache-Eingabestatus.

otNeighborTableEvent

 otNeighborTableEvent

Diese Aufzählung definiert die Konstanten, die in otNeighborTableCallback verwendet werden, um Änderungen in der Nachbartabelle anzuzeigen.

Attribute
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED

Ein Kind wird hinzugefügt.

OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED

Ein vorhandener untergeordneter Modus wird geändert.

OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED

Ein Kind wird entfernt.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED

Ein Router wird hinzugefügt.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED

Ein Router wird entfernt.

Typdef.

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

Diese Struktur stellt einen EID-Cache-Eintrag dar.

otCacheEntryHyperparameter

struct otCacheEntryIterator otCacheEntryIterator

Dieser Typ stellt einen Hyperparameter dar, der über die Einträge in der EID-Cache-Tabelle iteriert wird.

Zum Initialisieren des Compilers und zum Starten des ersten Eintrags in der Cache-Tabelle setzen Sie alle Felder in der Struktur auf null (z.B. memset für den Enabler auf null.

otCacheEntryState

enum otCacheEntryState otCacheEntryState

Diese Aufzählung definiert den EID-Cache-Eingabestatus.

otChildIp6AddressCIDR

uint16_t otChildIp6AddressIterator

Wird zur Iteration von IPv6-Adressen eines untergeordneten Thread-Eintrags verwendet.

otNeighborTableCallback

void(* otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)

Dieser Funktionszeiger wird aufgerufen, um zu benachrichtigen, dass die Nachbartabelle geändert wurde.

Details
Parameter
[in] aEvent
Eine Ereignismarkierung.
[in] aEntryInfo
Ein Hinweis auf Tabelleneintragsinformationen.

Funktionen

otThreadForLeader

otError otThreadBecomeLeader(
  otInstance *aInstance
)

Führen Sie die Führungsrolle ein und starten Sie eine neue Partition.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabewerte
OT_ERROR_NONE
Er ist ein Leader und hat eine neue Partition gestartet.
OT_ERROR_INVALID_STATE
Thread ist deaktiviert.

otThreadWillRouter

otError otThreadBecomeRouter(
  otInstance *aInstance
)

Versuchen Sie, Router zu werden.

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

otThreadGetChildInfoById

otError otThreadGetChildInfoById(
  otInstance *aInstance,
  uint16_t aChildId,
  otChildInfo *aChildInfo
)

Die Funktion speichert Diagnoseinformationen für ein angehängtes untergeordnetes Element anhand seiner untergeordneten ID oder RLOC16.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aChildId
Die untergeordnete ID oder RLOC16 für das angehängte untergeordnete Element.
[out] aChildInfo
Ein Hinweis, wo die untergeordneten Informationen platziert werden.
Rückgabewerte
OT_ERROR_NONE
aChildInfo wurde erfolgreich mit den Informationen für die angegebene ID aktualisiert.
OT_ERROR_NOT_FOUND
Kein gültiges untergeordnetes Element mit dieser untergeordneten ID.
OT_ERROR_INVALID_ARGS
Wenn aChildInfo NULL ist.

otThreadGetChildInfoByIndex

otError otThreadGetChildInfoByIndex(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildInfo *aChildInfo
)

Die Funktion speichert Diagnoseinformationen für einen verknüpften untergeordneten Bereich vom internen Tabellenindex.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aChildIndex
Der Tabellenindex.
[out] aChildInfo
Ein Hinweis, wo die untergeordneten Informationen platziert werden.
Rückgabewerte
OT_ERROR_NONE
aChildInfo wurde erfolgreich mit den Informationen für den angegebenen Index aktualisiert.
OT_ERROR_NOT_FOUND
Kein gültiges untergeordnetes Element in diesem Index.
OT_ERROR_INVALID_ARGS
Entweder ist aChildInfo NULL oder aChildIndex liegt außerhalb des zulässigen Bereichs (höher als der maximale Tabellenindex).
Weitere Informationen:
otGetMaxAllowedChild

otThreadGetChildNextIp6Address:

otError otThreadGetChildNextIp6Address(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildIp6AddressIterator *aIterator,
  otIp6Address *aAddress
)

Diese Funktion ruft die nächste IPv6-Adresse (mit einem chromeos) für ein bestimmtes untergeordnetes Element auf.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aChildIndex
Der untergeordnete Index.
[in,out] aIterator
Ein Zeiger auf den Recommender. Wenn der Vorgang abgeschlossen ist, wird der Recommender aktualisiert und auf den nächsten Eintrag in der Liste verweisen. Für die erste IPv6-Adresse sollte der Recommender auf OT_CHILD_IP6_ADDRESS_ITERATOR_INIT festgelegt sein.
[out] aAddress
Ein Hinweis auf eine IPv6-Adresse, bei der die nächste Adresse des Kindes platziert wird (bei Erfolg).
Rückgabewerte
OT_ERROR_NONE
Die nächste IPv6-Adresse wurde erfolgreich gefunden (aAddress wurde aktualisiert).
OT_ERROR_NOT_FOUND
Das untergeordnete Element hat keinen nachfolgenden IPv6-Adresseintrag.
OT_ERROR_INVALID_ARGS
aIterator oder aAddress sind NULL oder das untergeordnete Element aChildIndex ist ungültig.
Weitere Informationen:
otThreadGetChildInfoByIndex

otThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

Rufen Sie den Parameter CONTEXT_ID_REUSE_DELAY ab, der in der Leader-Rolle verwendet wird.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Der CONTEXT_ID_REUSE_DELAY-Wert.
Weitere Informationen:
otThreadSetContextIdReuseDelay

otThreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Rufen Sie den Joiner-UDP-Port ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Die Join-UDP-Portnummer.
Weitere Informationen:
otThreadSetjoinerUdpPort

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

Ermittle die Threads-Gewichtung, die bei deiner Tätigkeit in der Führungsrolle verwendet werden.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Der Wert der Thread-Lead-Gewichtung.
Weitere Informationen:
otThreadSetLeaderWeight

otThreadGetMaxAllowedChild

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

Ermitteln Sie die maximal zulässige Anzahl von Kindern.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Die maximal zulässige Anzahl von Kindern, die derzeit zulässig sind.
Weitere Informationen:
otThreadSetMaxAllowedChild

otThreadGetMaxChildIpAddresses

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

Diese Funktion erhält die maximale Anzahl von IP-Adressen, die jedes MTD-Kind mit diesem Gerät als übergeordnetes Element registrieren kann.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Die maximale Anzahl von IP-Adressen, die jedes MTD-Kind mit diesem Gerät als übergeordnetes Element registrieren kann.
Weitere Informationen:
otThreadSetMaxChildIpAddresses

otThreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

Die Funktion gibt die maximal zulässige Router-ID zurück.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Die maximal zulässige Router-ID.

otThreadGetNetworkIdTimeout (OTThreadGetNetworkIdTimeout)

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

Rufen Sie den Parameter NETWORK_ID_TIMEOUT ab, der in der Rolle des Routers verwendet wird.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Der Wert für NETWORK_ID_TIMEOUT.
Weitere Informationen:
otThreadSetNetworkIdTimeout

otThreadGetNextCacheEntry

otError otThreadGetNextCacheEntry(
  otInstance *aInstance,
  otCacheEntryInfo *aEntryInfo,
  otCacheEntryIterator *aIterator
)

Diese Funktion ruft den nächsten EID-Cache-Eintrag ab (mithilfe eines Recommenders).

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[out] aEntryInfo
Ein Zeiger, in dem die Informationen zum EID-Cache-Eintrag platziert werden.
[in,out] aIterator
Ein Mauszeiger auf einen Recommender. Er wird so aktualisiert, dass er auf den nächsten Eintrag verweist. Für den ersten Eintrag initialisieren Sie den Recommender, indem Sie alle Felder auf null setzen (z.B. memset die Recommender-Struktur auf null zu setzen.
Rückgabewerte
OT_ERROR_NONE
aEntryInfo wurde für den nächsten EID-Cache-Eintrag ausgefüllt.
OT_ERROR_NOT_FOUND
Keine weiteren Einträge in der Tabelle „Adresse Cache“.

otThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

Rufen Sie die zugewiesene übergeordnete Priorität ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Der zugewiesene übergeordnete Prioritätswert, -2 bedeutet, dass nicht zugewiesen wurde.
Weitere Informationen:
otThreadSetParentPriority

otThreadGetPreferredLeaderPartitionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

Ermitteln Sie die bevorzugte ID für die Thread-Lead-Partition, die bei Ausführung der Führungsrolle verwendet wird.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Die ID des Thread Leader-IDs.

otThreadGetPsk

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

Den Thread PSKc abrufen.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[out] aPskc
Ein Zeiger auf einen otPskc, um den abgerufenen Thread-PSKc zurückzugeben.
Weitere Informationen:
otThreadSetPskc

otThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

Schlüsselreferenz für Thread PSKc speichern.

Für diese Funktion muss die Build-Funktion OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE aktiviert sein.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Wichtige Informationen zu PSKc
Weitere Informationen:
otThreadSetPskcRef

otThreadGetRouterDowngradeDowngradeSchwellenwert

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

Rufen Sie den Parameter ROUTER_DOWNGRADE_THRESHOLD ab, der in der Routerrolle verwendet wird.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Der Wert ROUTER_DOWNGRADE_THRESHOLD
Weitere Informationen:
otThreadSetRouterDowngradeThreshold

otThreadGetRouterIdRange

void otThreadGetRouterIdRange(
  otInstance *aInstance,
  uint8_t *aMinRouterId,
  uint8_t *aMaxRouterId
)

Diese Funktion ruft den Bereich der Router-IDs ab, die Knoten im Thread-Netzwerk zugewiesen werden dürfen.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[out] aMinRouterId
Die minimale Router-ID.
[out] aMaxRouterId
Die maximale Router-ID.
Weitere Informationen:
otThreadSetRouterIdRange

otThreadGetRouterIdSequenz

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

Rufen Sie die aktuelle Router-ID-Sequenz ab.

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

otThreadGetRouterInfo

otError otThreadGetRouterInfo(
  otInstance *aInstance,
  uint16_t aRouterId,
  otRouterInfo *aRouterInfo
)

Die Funktion speichert Diagnoseinformationen für einen bestimmten Thread-Router.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aRouterId
Die Router-ID oder RLOC16 für den jeweiligen Router.
[out] aRouterInfo
Ein Zeiger, an dem sich die Routerinformationen befinden.
Rückgabewerte
OT_ERROR_NONE
Die Routerinformationen für die angegebene ID wurden abgerufen.
OT_ERROR_NOT_FOUND
Kein Routereintrag mit der angegebenen ID.
OT_ERROR_INVALID_ARGS
aRouterInfo ist NULL.

otThreadGetRouterSelectionJitter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

Rufen Sie den Parameter ROUTER_SELECTION_JITTER in der Rolle REED/Router ab.

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

otThreadGetRouterUpgradeThreshold

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

Parameter ROUTER_UPGRADE_THRESHOLD abrufen, die in der Rolle REED verwendet wird.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Der Wert ROUTER_UPGRADE_THRESHOLD
Weitere Informationen:
otThreadSetRouterUpgradeThreshold

otThreadIsRouterAktiv

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

Diese Methode gibt an, ob das Gerät für den Router geeignet ist.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabewerte
TRUE
Wenn das Gerät für den Router geeignet ist.
FALSE
Wenn das Gerät nicht für den Router geeignet ist.

otThreadRegisterNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

Mit dieser Funktion wird eine Callback-Funktion für eine benachbarte Tabelle registriert.

Der angegebene Callback ist aktiviert, wenn in der Nachbartabelle eine Änderung vorgenommen wird, z.B. wenn ein untergeordneter oder ein Router-Nachbareintrag hinzugefügt oder entfernt wird oder ein vorhandener untergeordneter Modus geändert wird.

Nachfolgende Aufrufe dieser Methode überschreiben den vorherigen Callback. Beachten Sie, dass dieser Callback beim Aufruf der Nachbar-/Untergeordneten Tabelle und immer vor dem otStateChangedCallback aufgerufen wird.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aCallback
Ein Zeiger auf die Callback-Handler-Funktion.

otThreadReleaseRouterId

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Geben Sie eine Router-ID kostenlos, die vom Gerät in der Rolle „Lead“ zugewiesen wurde.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aRouterId
Die freizugebende Router-ID. Gültiger Bereich ist [0, 62].
Rückgabewerte
OT_ERROR_NONE
Die Router-ID wurde freigegeben.
OT_ERROR_INVALID_ARGS
aRouterId liegt nicht im Bereich [0, 62].
OT_ERROR_INVALID_STATE
Das Gerät ist zurzeit nicht als Leader zu sehen.
OT_ERROR_NOT_FOUND
Die Router-ID ist derzeit nicht zugewiesen.

otThreadSetCcmEnabled

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Mit dieser Funktion wird festgelegt, ob das Gerät mithilfe von CCM in Betrieb genommen wurde.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aEnabled
WAHR, wenn das Gerät mit CCM in Betrieb genommen wurde, sonst FALSCH.

otThreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

Legen Sie den Parameter CONTEXT_ID_REUSE_DELAY fest, der in der Leader-Rolle verwendet wird.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aDelay
Der CONTEXT_ID_REUSE_DELAY-Wert.
Weitere Informationen:
otThreadGetContextIdReuseDelay

otThreadSetJoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

Legen Sie den Join-UDP-Port fest.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aJoinerUdpPort
Die Join-UDP-Portnummer.
Rückgabewerte
OT_ERROR_NONE
Es wurde der Joiner-UDP-Port festgelegt.
Weitere Informationen:
otThreadGetjoinerUdpPort

otThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

Legen Sie die Priorität der Thread-Lead fest, die beim Ausführen der Leader-Rolle verwendet wird.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aWeight
Der Wert der Thread-Lead-Gewichtung.
Weitere Informationen:
otThreadGetLeaderWeight

otThreadSetMaxAllowedChild

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

Damit legen Sie die maximal zulässige Anzahl von Kindern fest.

Dieser Parameter kann nur festgelegt werden, wenn der Thread-Protokollvorgang gestoppt wurde.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aMaxChildren
Die maximal zulässige Anzahl von Kindern
Rückgabewerte
OT_ERROR_NONE
Maximaler
OT_ERROR_INVALID_ARGS
Wenn aMaxChildren nicht im Bereich [1, OPENWEEK_CONFIG_MLE_MAX_CHILDREN] liegt.
OT_ERROR_INVALID_STATE
Thread ist nicht beendet.
Weitere Informationen:
otThreadGetMaxAllowedChild

otThreadSetMaxChildIpAddresses

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

Mit dieser Funktion wird die maximale Anzahl von IP-Adressen festgelegt/wiederhergestellt, die jedes MTD-Untergeordnetes Gerät bei diesem Gerät als übergeordnetes Element registrieren kann.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aMaxIpAddresses
Die maximale Anzahl von IP-Adressen, die jedes MTD-Kind mit diesem Gerät als übergeordnetes Element registrieren kann. 0, um die Einstellung zu löschen und die Standardeinstellung wiederherzustellen.
Rückgabewerte
OT_ERROR_NONE
Die Nummer wurde gelöscht/gelöscht.
OT_ERROR_INVALID_ARGS
Überschreitet die zulässige Höchstzahl.
Weitere Informationen:
otThreadGetMaxChildIpAddresses

otThreadSetNetworkIdTimeout (OTThreadSetNetworkIdTimeout)

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

Legen Sie den Parameter NETWORK_ID_TIMEOUT fest, der in der Leader-Rolle verwendet wird.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aTimeout
Der Wert für NETWORK_ID_TIMEOUT.
Weitere Informationen:
otThreadGetNetworkIdTimeout

otThreadSetParentPriority

otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

Legen Sie die übergeordnete Priorität fest.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aParentPriority
Der Wert der übergeordneten Priorität.
Rückgabewerte
OT_ERROR_NONE
Die übergeordnete Priorität wurde festgelegt.
OT_ERROR_INVALID_ARGS
Wenn der übergeordnete Prioritätswert nicht zwischen 1, 0, -1 und -2 liegt.
Weitere Informationen:
otThreadGetParentPriority

otThreadSetPreferredLeaderPartitionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

Legen Sie die bevorzugte Partitions-ID für Thread-Lead fest, die beim Ausführen der Leader-Rolle verwendet wird.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aPartitionId
Die ID des Thread Leader-IDs.

otThreadSetPreferredRouterId

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Stellen Sie die bevorzugte Router-ID ein.

Wenn der Knoten ein Router/Leader wird, versucht der Knoten, diese Router-ID zu verwenden. Wenn die bevorzugte Router-ID nicht festgelegt ist oder nicht verwendet werden kann, wird eine zufällig generierte Router-ID ausgewählt. Diese Eigenschaft kann nur festgelegt werden, wenn die Geräterolle getrennt oder deaktiviert ist.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aRouterId
Die bevorzugte Router-ID.
Rückgabewerte
OT_ERROR_NONE
Die gewünschte Router-ID wurde festgelegt.
OT_ERROR_INVALID_STATE
Kann nicht festgelegt werden (Rolle wurde nicht getrennt oder deaktiviert)

otThreadSetPskc

otError otThreadSetPskc(
  otInstance *aInstance,
  const otPskc *aPskc
)

Den Thread PSKc festlegen.

Diese Funktion ist nur erfolgreich, wenn Thread-Protokolle deaktiviert sind. Bei einem erfolgreichen Aufruf dieser Funktion werden die aktiven und ausstehenden operativen Datasets im nichtflüchtigen Speicher ungültig.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aPskc
Verweis auf den neuen Thread-PSKc.
Rückgabewerte
OT_ERROR_NONE
Der Thread-PSKc wurde festgelegt.
OT_ERROR_INVALID_STATE
Thread-Protokolle sind aktiviert.
Weitere Informationen:
otThreadGetPskc

otThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

Den Thread PSKc festlegen.

Für diese Funktion muss die Build-Funktion OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE aktiviert sein.

Diese Funktion ist nur erfolgreich, wenn Thread-Protokolle deaktiviert sind. Bei einem erfolgreichen Aufruf dieser Funktion werden die aktiven und ausstehenden operativen Datasets im nichtflüchtigen Speicher ungültig.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aKeyRef
Schlüsselreferenz auf den neuen Thread-PSKc.
Rückgabewerte
OT_ERROR_NONE
Der Thread-PSKc wurde festgelegt.
OT_ERROR_INVALID_STATE
Thread-Protokolle sind aktiviert.
Weitere Informationen:
otThreadGetPskcRef

otThreadSetRouterDowngradeThreshold

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Legen Sie den Parameter ROUTER_DOWNGRADE_THRESHOLD fest, der in der Rolle "Lead" verwendet wird.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aThreshold
Der Wert ROUTER_DOWNGRADE_THRESHOLD
Weitere Informationen:
otThreadGetRouterDowngradeThreshold

otThreadSetRouterEnabled

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

Mit dieser Funktion wird festgelegt, ob das Gerät Router-fähig ist.

Wenn aEligible auf „falsch“ gesetzt ist und das Gerät momentan als Router verwendet wird, wird bei diesem Aufruf das Gerät getrennt und als untergeordnetes Gerät noch einmal versucht.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aEligible
WAHR, um das Gerät als Router-fähig zu konfigurieren, sonst FALSCH.
Rückgabewerte
OT_ERROR_NONE
Die für den Router zulässige Konfiguration wurde festgelegt.
OT_ERROR_NOT_CAPABLE
Das Gerät kann nicht zum Router werden.

otThreadSetRouterIdRange

otError otThreadSetRouterIdRange(
  otInstance *aInstance,
  uint8_t aMinRouterId,
  uint8_t aMaxRouterId
)

Mit dieser Funktion wird der Bereich der Router-IDs festgelegt, die Knoten im Thread-Netzwerk zugewiesen werden dürfen.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aMinRouterId
Die minimale Router-ID.
[in] aMaxRouterId
Die maximale Router-ID.
Rückgabewerte
OT_ERROR_NONE
Der Bereich wurde festgelegt.
OT_ERROR_INVALID_ARGS
aMinRouterId &aMaxMaxId oder der Bereich ist nicht durch [0, 62] abgedeckt.
Weitere Informationen:
otThreadGetRouterIdRange

otThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

Legen Sie den Parameter ROUTER_SELECTION_JITTER in der Rolle REED/Router fest.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aRouterJitter
Der Wert ROUTER_SELECTION_JITTER.
Weitere Informationen:
otThreadGetRouterSelectionJitter

otThreadSetRouterUpgradeSchwellenwert

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Legen Sie den Parameter ROUTER_UPGRADE_THRESHOLD fest, der in der Leader-Rolle verwendet wird.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aThreshold
Der Wert ROUTER_UPGRADE_THRESHOLD
Weitere Informationen:
otThreadGetRouterUpgradeThreshold

otThreadSetSteeringData

void otThreadSetSteeringData(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

Lenkungsdaten außerhalb des Armbands festlegen.

Die Konfigurationsoption OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE sollte festgelegt sein, damit die Lenkung von Daten außerhalb des Bands aktiviert werden kann.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aExtAddress
Adresse zum Aktualisieren der Lenkungsdaten. Alle Nullen zum Löschen der Lenkungsdaten (keine Lenkdaten). Alle 0 x FFs, um den Lenkungs-/Blütenfilter zu akzeptieren oder zuzulassen, Spezifische EUI64, die dann dem aktuellen Lenkungs-/Blütenfilter hinzugefügt wird

otThreadSetThreadVersionCheckEnabled

void otThreadSetThreadVersionCheckEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Mit dieser Funktion wird festgelegt, ob der TLV-Versionsgrenzwert für das Routing (VR-Feld) aktiviert ist.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aEnabled
TRUE, um den TLV-Versionsgrenzwert für die Sicherheitsrichtlinie für das Routing zu aktivieren, ansonsten FALSE.

Makros

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Initialisierer für otChildIP6AddressEnabler.

Ressourcen

Die Themen der Referenzthread API basieren auf dem Quellcode, der auf GitHub verfügbar ist. Weitere Informationen sowie die Möglichkeit, in unserer Dokumentation mitzuwirken, finden Sie unter Ressourcen.