Router/Führender Anbieter
Dieses Modul enthält Funktionen für Thread-Router und -Leiter.
Zusammenfassung
Aufzählungen |
|
---|---|
otCacheEntryState
|
enum Definiert den Status des EID-Cache-Eintrags. |
otNeighborTableEvent{
|
enum Definiert die in otNeighborTableCallback verwendeten Konstanten, um Änderungen in der benachbarten Tabelle anzuzeigen. |
otPowerSupply{
|
enum Stellt die Eigenschaft des Netzteils auf einem Gerät dar. |
Typedefs |
|
---|---|
otCacheEntryInfo
|
typedefstruct otCacheEntryInfo
Stellt einen EID-Cache-Eintrag dar. |
otCacheEntryIterator
|
typedefstruct otCacheEntryIterator
Stellt einen Iterator dar, der für die Iteration durch die Tabelleneinträge des EID-Cache verwendet wird. |
otCacheEntryState
|
typedefenum otCacheEntryState
Definiert den Status des EID-Cache-Eintrags. |
otChildIp6AddressIterator
|
typedefuint16_t
Wird verwendet, um über IPv6-Adressen eines untergeordneten Thread-Eintrags zu iterieren. |
otDeviceProperties
|
typedefstruct otDeviceProperties
Stellt die Geräteeigenschaften dar, die zur Berechnung der Gewichtung der lokalen Leader auf einem Gerät verwendet werden. |
otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)
|
typedefvoid(*
Der Pointer wird aufgerufen, um über eine Änderung in der benachbarten Tabelle zu informieren. |
Funktionen |
|
---|---|
otThreadBecomeLeader(otInstance *aInstance)
|
Werden Sie ein Leader und starten Sie eine neue Partition.
|
otThreadBecomeRouter(otInstance *aInstance)
|
Versuchen Sie, ein Router zu werden.
|
otThreadGetAdvertisementTrickleIntervalMax(otInstance *aInstance)
|
uint32_t
Ruft den aktuellen Wert für das maximale Intervall ab, der vom Anzeigen-Tricks-Timer verwendet wird.
|
otThreadGetChildInfoById(otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
|
Ruft Diagnoseinformationen für ein angehängtes untergeordnetes Element anhand seiner untergeordneten ID oder RLOC16 ab.
|
otThreadGetChildInfoByIndex(otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
|
Die Funktion speichert Diagnoseinformationen für ein untergeordnetes Element, das gemäß dem internen Tabellenindex angehängt wurde.
|
otThreadGetChildNextIp6Address(otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
|
Ruft die nächste IPv6-Adresse für ein bestimmtes untergeordnetes Element (mithilfe eines Iterators) ab.
|
otThreadGetChildRouterLinks(otInstance *aInstance)
|
uint8_t
Rufen Sie den MLE_CHILD_ROUTER_LINKS-Parameter ab, der in der REED-Rolle verwendet wird.
|
otThreadGetContextIdReuseDelay(otInstance *aInstance)
|
uint32_t
Rufen Sie den Parameter CONTEXT_ID_REUSE_DELAY ab, der in der Leader-Rolle verwendet wird.
|
otThreadGetDeviceProperties(otInstance *aInstance)
|
const otDeviceProperties *
Aktuelle Geräteeigenschaften abrufen.
|
otThreadGetJoinerUdpPort(otInstance *aInstance)
|
uint16_t
Ruft den Joiner-UDP-Port ab.
|
otThreadGetLocalLeaderWeight(otInstance *aInstance)
|
uint8_t
Ruft die Thread Leader-Gewichtung ab, die bei einem Betrieb in der Leader-Rolle verwendet wird.
|
otThreadGetMaxAllowedChildren(otInstance *aInstance)
|
uint16_t
Ruft die derzeit maximal zulässige Anzahl von untergeordneten Elementen ab.
|
otThreadGetMaxChildIpAddresses(otInstance *aInstance)
|
uint8_t
Ruft die maximale Anzahl von IP-Adressen ab, die jedes untergeordnete MTD-Gerät auf 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. |
otThreadGetNextCacheEntry(otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
|
Ruft den nächsten EID-Cache-Eintrag mithilfe eines Iterators ab.
|
otThreadGetNextHopAndPathCost(otInstance *aInstance, uint16_t aDestRloc16, uint16_t *aNextHopRloc16, uint8_t *aPathCost)
|
void
Ruft den nächsten Hop und die Pfadkosten für ein bestimmtes RLOC16-Ziel ab.
|
otThreadGetParentPriority(otInstance *aInstance)
|
int8_t
Rufen Sie die zugewiesene übergeordnete Priorität ab.
|
otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)
|
uint32_t
Ruft die bevorzugte Thread-Lead-Partitions-ID ab, die bei einem Betrieb in der Leader-Rolle verwendet wird.
|
otThreadGetPskc(otInstance *aInstance, otPskc *aPskc)
|
void
Holen Sie sich den Thread PSKc.
|
otThreadGetPskcRef(otInstance *aInstance)
|
Schlüsselreferenz zum gespeicherten Thread-PSKc abrufen.
|
otThreadGetRouterDowngradeThreshold(otInstance *aInstance)
|
uint8_t
Rufen Sie den Parameter ROUTER_DOWNGRADE_GRENZWERT ab, der in der Rolle des Routers verwendet wird.
|
otThreadGetRouterIdRange(otInstance *aInstance, uint8_t *aMinRouterId, uint8_t *aMaxRouterId)
|
void
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 ab, der in der Rolle REED/Router verwendet wird.
|
otThreadGetRouterUpgradeThreshold(otInstance *aInstance)
|
uint8_t
Hiermit wird der Parameter ROUTER_UPGRADE_THRESHOLD in der REED-Rolle verwendet.
|
otThreadIsRouterEligible(otInstance *aInstance)
|
bool
Gibt an, ob das Gerät Router geeignet ist.
|
otThreadIsRouterIdAllocated(otInstance *aInstance, uint8_t aRouterId)
|
bool
Gibt an, ob derzeit eine Router-ID zugewiesen ist.
|
otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback)
|
void
Registriert die Callback-Funktion einer Nachbartabelle.
|
otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)
|
Geben Sie eine Router-ID frei, die vom Gerät mit der Rolle „Leader“ zugewiesen wurde.
|
otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled)
|
void
Legt fest, ob das Gerät mit CCM in Betrieb genommen wurde.
|
otThreadSetChildRouterLinks(otInstance *aInstance, uint8_t aChildRouterLinks)
|
Legen Sie den MLE_CHILD_ROUTER_LINKS-Parameter fest, der in der REED-Rolle verwendet wird.
|
otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t aDelay)
|
void
Legt den Parameter CONTEXT_ID_REUSE_DELAY fest, der in der Leader-Rolle verwendet wird.
|
otThreadSetDeviceProperties(otInstance *aInstance, const otDeviceProperties *aDeviceProperties)
|
void
Legen Sie die Geräteeigenschaften fest, anhand derer die Leader-Gewichtung ermittelt und festgelegt wird.
|
otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)
|
Legt den Joiner-UDP-Port fest.
|
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)
|
void
Legt die Gewichtung der Thread-Leader fest, die bei einem Betrieb in der Leader-Rolle verwendet wird.
|
otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)
|
Legt die maximal zulässige Anzahl von untergeordneten Elementen fest.
|
otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)
|
Legt die maximale Anzahl von IP-Adressen fest, die jedes untergeordnete MTD-Gerät auf diesem Gerät als übergeordnetes Element registrieren kann, oder stellt diese wieder her.
|
otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)
|
void
Legen Sie den Parameter
NETWORK_ID_TIMEOUT fest. |
otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)
|
Legen Sie die übergeordnete Priorität fest.
|
otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)
|
void
Legt die bevorzugte Thread-Lead-Partitions-ID fest, die bei einem Betrieb in der Leader-Rolle verwendet wird.
|
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)
|
Legen Sie die bevorzugte Router-ID fest.
|
otThreadSetPskc(otInstance *aInstance, const otPskc *aPskc)
|
Legen Sie den Thread-PSKc fest.
|
otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)
|
Legen Sie die Schlüsselreferenz auf den Thread-PSKc fest.
|
otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)
|
void
Legen Sie den Parameter ROUTER_DOWNGRADE_GRENZWERT fest, der für die Rolle des Leaders verwendet wird.
|
otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)
|
Legt fest, ob das Gerät Router nutzen kann.
|
otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)
|
Legt den Bereich der Router-IDs fest, die Knoten im Thread-Netzwerk zugewiesen werden dürfen.
|
otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)
|
void
Legen Sie den Parameter ROUTER_SELECTION_JITTER fest, der in der Rolle REED/Router verwendet wird.
|
otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8_t aThreshold)
|
void
Legen Sie den Parameter ROUTER_UPGRADE_GRENZWERT fest, der für die Rolle des Leaders verwendet wird.
|
otThreadSetSteeringData(otInstance *aInstance, const otExtAddress *aExtAddress)
|
void
Aktiviere Daten für die Steuerung außerhalb des Bandes.
|
otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)
|
void
Legt fest, ob der TLV-Versionsschwellenwert für das Routing (VR-Feld) der Sicherheitsrichtlinie aktiviert ist.
|
Strukturen |
|
---|---|
otCacheEntryInfo |
Stellt einen EID-Cache-Eintrag dar. |
otCacheEntryIterator |
Stellt einen Iterator dar, der für die Iteration durch die Tabelleneinträge des EID-Cache verwendet wird. |
otChildInfo |
Enthält Diagnoseinformationen zu einem untergeordneten Thread. |
otDeviceProperties |
Stellt die Geräteeigenschaften dar, die zur Berechnung der Gewichtung der lokalen Leader auf einem Gerät verwendet werden. |
otNeighborTableEntryInfo |
Informationen zu einem benachbarten Tabelleneintrag (untergeordnet oder Router) und werden als Parameter im Callback |
Aufzählungen
otCacheEntryState
otCacheEntryState
Definiert den Status des EID-Cache-Eintrags.
otNeighborTableEvent
otNeighborTableEvent
Definiert die in otNeighborTableCallback
verwendeten Konstanten, um Änderungen in der benachbarten Tabelle anzuzeigen.
Attribute | |
---|---|
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED
|
Ein Kind wird hinzugefügt. |
OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED
|
Der Modus eines vorhandenen untergeordneten Elements 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. |
otPowerSupply
otPowerSupply
Stellt die Eigenschaft des Netzteils auf einem Gerät dar.
Wird in otDeviceProperties
als Attribut verwendet, um die führende Gewichtung zu berechnen.
Attribute | |
---|---|
OT_POWER_SUPPLY_BATTERY
|
Batteriebetrieben. |
OT_POWER_SUPPLY_EXTERNAL
|
Externe Stromversorgung (mit Netzbetrieb). |
OT_POWER_SUPPLY_EXTERNAL_STABLE
|
Stabile externe Stromversorgung mit Notstrom- oder USV-Batterie. |
OT_POWER_SUPPLY_EXTERNAL_UNSTABLE
|
Potenziell instabile externe Stromversorgung (z.B. Glühbirne über Schalter). |
Typedefs
otCacheEntryIterator
struct otCacheEntryIterator otCacheEntryIterator
Stellt einen Iterator dar, der für die Iteration durch die Tabelleneinträge des EID-Cache verwendet wird.
Um den Iterator zu initialisieren und mit dem ersten Eintrag in der Cache-Tabelle zu beginnen, setzen Sie alle Felder in der Struktur auf null (z.B. memset
den Iterator auf null).
otCacheEntryState
enum otCacheEntryState otCacheEntryState
Definiert den Status des EID-Cache-Eintrags.
otChildIp6AddressIterator
uint16_t otChildIp6AddressIterator
Wird verwendet, um über IPv6-Adressen eines untergeordneten Thread-Eintrags zu iterieren.
otDeviceProperties
struct otDeviceProperties otDeviceProperties
Stellt die Geräteeigenschaften dar, die zur Berechnung der Gewichtung der lokalen Leader auf einem Gerät verwendet werden.
Die Parameter werden entsprechend den Fähigkeiten des Geräts festgelegt, z. B. der Funktion des Border-Routers, der Konfiguration des Netzteils usw.
mIsUnstable
gibt die Betriebsstabilität des Geräts an und wird über einen anbieterspezifischen Mechanismus bestimmt. Folgende Fälle sind möglich:
- Das Gerät erkennt intern häufiger als üblich, dass die externe Stromversorgung unterbrochen wird. Was üblich ist, wird vom Anbieter festgelegt.
- Das Gerät erkennt intern, dass es häufiger als gewöhnlich neu startet. Was üblich ist, wird vom Anbieter festgelegt.
otNeighborTableCallback
void(* otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)
Der Pointer wird aufgerufen, um über eine Änderung in der benachbarten Tabelle zu informieren.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
Funktionen
otThreadBecomeLeader
otError otThreadBecomeLeader( otInstance *aInstance )
Werden Sie ein Leader und starten Sie eine neue Partition.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadBecomeRouter
otError otThreadBecomeRouter( otInstance *aInstance )
Versuchen Sie, ein Router zu werden.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadGetAdvertisementTrickleIntervalMax
uint32_t otThreadGetAdvertisementTrickleIntervalMax( otInstance *aInstance )
Ruft den aktuellen Wert für das maximale Intervall ab, der vom Anzeigen-Tricks-Timer verwendet wird.
Diese API erfordert OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
und ist nur für Testzwecke vorgesehen.
Details | |
---|---|
Rückgabe |
Das maximale Intervall des Werbe-Trickle-Timers in Millisekunden.
|
otThreadGetChildInfoById
otError otThreadGetChildInfoById( otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo )
Ruft Diagnoseinformationen für ein angehängtes untergeordnetes Element anhand seiner untergeordneten ID oder RLOC16 ab.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otThreadGetChildInfoByIndex
otError otThreadGetChildInfoByIndex( otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo )
Die Funktion speichert Diagnoseinformationen für ein untergeordnetes Element, das gemäß dem internen Tabellenindex angehängt wurde.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otGetMaxAllowedChildren
otThreadGetChildNextIp6Address
otError otThreadGetChildNextIp6Address( otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress )
Ruft die nächste IPv6-Adresse für ein bestimmtes untergeordnetes Element (mithilfe eines Iterators) ab.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||
Rückgabewerte |
|
otThreadGetChildInfoByIndex
otThreadGetChildRouterLinks
uint8_t otThreadGetChildRouterLinks( otInstance *aInstance )
Rufen Sie den MLE_CHILD_ROUTER_LINKS-Parameter ab, der in der REED-Rolle verwendet wird.
Dieser Parameter gibt die maximale Anzahl benachbarter Router an, mit denen das Gerät (als FED) versucht, eine Verbindung herzustellen.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Der Wert MLE_CHILD_ROUTER_LINKS.
|
otThreadSetChildRouterLinks
otThreadGetContextIdReuseDelay
uint32_t otThreadGetContextIdReuseDelay( otInstance *aInstance )
Rufen Sie den Parameter CONTEXT_ID_REUSE_DELAY ab, der in der Leader-Rolle verwendet wird.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Der Wert CONTEXT_ID_REUSE_DELAY.
|
otThreadSetContextIdReuseDelay
otThreadGetDeviceProperties
const otDeviceProperties * otThreadGetDeviceProperties( otInstance *aInstance )
Aktuelle Geräteeigenschaften abrufen.
Erfordert OPENTHREAD_CONFIG_MLE_DEVICE_PROPERTY_LEADER_WEIGHT_ENABLE
.
Details | |
---|---|
Rückgabe |
Die Geräteeigenschaften
otDeviceProperties . |
otThreadGetJoinerUdpPort
uint16_t otThreadGetJoinerUdpPort( otInstance *aInstance )
Ruft den Joiner-UDP-Port ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Die Joiner-UDP-Portnummer.
|
otThreadSetJoinerUdpPort
otThreadGetLocalLeaderWeight
uint8_t otThreadGetLocalLeaderWeight( otInstance *aInstance )
Ruft die Thread Leader-Gewichtung ab, die bei einem Betrieb in der Leader-Rolle verwendet wird.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Der Wert für die Gewichtung des Thread-Leaders.
|
otThreadSetLeaderWeight
otThreadSetDeviceProperties
otThreadGetMaxAllowedChildren
uint16_t otThreadGetMaxAllowedChildren( otInstance *aInstance )
Ruft die derzeit maximal zulässige Anzahl von untergeordneten Elementen ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Die derzeit maximal zulässige Anzahl von Kindern.
|
otThreadSetMaxAllowedChildren
otThreadGetMaxChildIpAddresses
uint8_t otThreadGetMaxChildIpAddresses( otInstance *aInstance )
Ruft die maximale Anzahl von IP-Adressen ab, die jedes untergeordnete MTD-Gerät auf diesem Gerät als übergeordnetes Element registrieren kann.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Die maximale Anzahl von IP-Adressen, die jedes untergeordnete MTD-Gerät auf diesem Gerät als übergeordnetes Element registrieren kann.
|
otThreadSetMaxChildIpAddresses
otThreadGetMaxRouterId
uint8_t otThreadGetMaxRouterId( otInstance *aInstance )
Die Funktion gibt die maximal zulässige Router-ID zurück.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Die maximal zulässige Router-ID.
|
otThreadGetNetworkIdTimeout
uint8_t otThreadGetNetworkIdTimeout( otInstance *aInstance )
Rufen Sie den Parameter NETWORK_ID_TIMEOUT
ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Der Wert
NETWORK_ID_TIMEOUT . |
otThreadSetNetworkIdTimeout
otThreadGetNextCacheEntry
otError otThreadGetNextCacheEntry( otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator )
Ruft den nächsten EID-Cache-Eintrag mithilfe eines Iterators ab.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otThreadGetNextHopAndPathCost
void otThreadGetNextHopAndPathCost( otInstance *aInstance, uint16_t aDestRloc16, uint16_t *aNextHopRloc16, uint8_t *aPathCost )
Ruft den nächsten Hop und die Pfadkosten für ein bestimmtes RLOC16-Ziel ab.
Kann verwendet werden, wenn entweder aNextHopRloc16
oder aPathCost
NULL ist, was bedeutet, dass der Aufrufer den Wert nicht abrufen möchte.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
otThreadGetParentPriority
int8_t otThreadGetParentPriority( otInstance *aInstance )
Rufen Sie die zugewiesene übergeordnete Priorität ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Der zugewiesene übergeordnete Prioritätswert -2 bedeutet nicht zugewiesen.
|
otThreadSetParentPriority
otThreadGetPreferredLeaderPartitionId
uint32_t otThreadGetPreferredLeaderPartitionId( otInstance *aInstance )
Ruft die bevorzugte Thread-Lead-Partitions-ID ab, die bei einem Betrieb in der Leader-Rolle verwendet wird.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Der Wert der Thread-Lead-Partitions-ID.
|
otThreadGetPskc
void otThreadGetPskc( otInstance *aInstance, otPskc *aPskc )
Holen Sie sich den Thread PSKc.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otThreadSetPskc
otThreadGetPskcRef
otPskcRef otThreadGetPskcRef( otInstance *aInstance )
Schlüsselreferenz zum gespeicherten Thread-PSKc abrufen.
Erfordert, dass das Build-Zeitfeature OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
aktiviert ist.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Schlüsselreferenz zu PSKc
|
otThreadSetPskcRef
otThreadGetRouterDowngradeThreshold
uint8_t otThreadGetRouterDowngradeThreshold( otInstance *aInstance )
Rufen Sie den Parameter ROUTER_DOWNGRADE_GRENZWERT ab, der in der Rolle des Routers verwendet wird.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Der Wert ROUTER_DOWNGRADE_GRENZWERT.
|
otThreadSetRouterDowngradeThreshold
otThreadGetRouterIdRange
void otThreadGetRouterIdRange( otInstance *aInstance, uint8_t *aMinRouterId, uint8_t *aMaxRouterId )
Ruft den Bereich der Router-IDs ab, die Knoten im Thread-Netzwerk zugewiesen werden dürfen.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
otThreadSetRouterIdRange
otThreadGetRouterIdSequence
uint8_t otThreadGetRouterIdSequence( otInstance *aInstance )
Rufen Sie die aktuelle Router-ID-Sequenz ab.
Details | |||
---|---|---|---|
Parameter |
|
||
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 |
|
||||||
Rückgabewerte |
|
otThreadGetRouterSelectionJitter
uint8_t otThreadGetRouterSelectionJitter( otInstance *aInstance )
Rufen Sie den Parameter ROUTER_SELECTION_JITTER ab, der in der Rolle REED/Router verwendet wird.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Der Wert ROUTER_SELECTION_JITTER
|
otThreadSetRouterSelectionJitter
otThreadGetRouterUpgradeThreshold
uint8_t otThreadGetRouterUpgradeThreshold( otInstance *aInstance )
Hiermit wird der Parameter ROUTER_UPGRADE_THRESHOLD in der REED-Rolle verwendet.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Der Wert ROUTER_UPGRADE_GRENZWERT.
|
otThreadSetRouterUpgradeThreshold
otThreadIsRouterEligible
bool otThreadIsRouterEligible( otInstance *aInstance )
Gibt an, ob das Gerät Router geeignet ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadIsRouterIdAllocated
bool otThreadIsRouterIdAllocated( otInstance *aInstance, uint8_t aRouterId )
Gibt an, ob derzeit eine Router-ID zugewiesen ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadRegisterNeighborTableCallback
void otThreadRegisterNeighborTableCallback( otInstance *aInstance, otNeighborTableCallback aCallback )
Registriert die Callback-Funktion einer Nachbartabelle.
Der bereitgestellte Callback (falls nicht NULL) wird aufgerufen, wenn sich eine Änderung in der benachbarten Tabelle ergibt (z.B., wenn ein untergeordneter oder ein Router benachbarter Eintrag hinzugefügt/entfernt wird oder der Modus eines vorhandenen untergeordneten Elements geändert wird).
Nachfolgende Aufrufe dieser Methode überschreiben den vorherigen Callback. Beachten Sie, dass dieser Callback immer vor otStateChangedCallback
aufgerufen wird, während die Nachbar-/Untertabelle aktualisiert wird.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otThreadReleaseRouterId
otError otThreadReleaseRouterId( otInstance *aInstance, uint8_t aRouterId )
Geben Sie eine Router-ID frei, die vom Gerät mit der Rolle „Leader“ zugewiesen wurde.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||
Rückgabewerte |
|
otThreadSetCcmEnabled
void otThreadSetCcmEnabled( otInstance *aInstance, bool aEnabled )
Legt fest, ob das Gerät mit CCM in Betrieb genommen wurde.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otThreadSetChildRouterLinks
otError otThreadSetChildRouterLinks( otInstance *aInstance, uint8_t aChildRouterLinks )
Legen Sie den MLE_CHILD_ROUTER_LINKS-Parameter fest, der in der REED-Rolle verwendet wird.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadGetChildRouterLinks
otThreadSetContextIdReuseDelay
void otThreadSetContextIdReuseDelay( otInstance *aInstance, uint32_t aDelay )
Legt den Parameter CONTEXT_ID_REUSE_DELAY fest, der in der Leader-Rolle verwendet wird.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otThreadGetContextIdReuseDelay
otThreadSetDeviceProperties
void otThreadSetDeviceProperties( otInstance *aInstance, const otDeviceProperties *aDeviceProperties )
Legen Sie die Geräteeigenschaften fest, anhand derer die Leader-Gewichtung ermittelt und festgelegt wird.
Erfordert OPENTHREAD_CONFIG_MLE_DEVICE_PROPERTY_LEADER_WEIGHT_ENABLE
.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otThreadSetJoinerUdpPort
otError otThreadSetJoinerUdpPort( otInstance *aInstance, uint16_t aJoinerUdpPort )
Legt den Joiner-UDP-Port fest.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadGetJoinerUdpPort
otThreadSetLocalLeaderWeight
void otThreadSetLocalLeaderWeight( otInstance *aInstance, uint8_t aWeight )
Legt die Gewichtung der Thread-Leader fest, die bei einem Betrieb in der Leader-Rolle verwendet wird.
Setzt die Leader-Gewichtung direkt auf den neuen Wert und ersetzt den vorherigen Wert, der möglicherweise aus dem aktuellen otDeviceProperties
ermittelt wurde.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otThreadGetLeaderWeight
otThreadSetMaxAllowedChildren
otError otThreadSetMaxAllowedChildren( otInstance *aInstance, uint16_t aMaxChildren )
Legt die maximal zulässige Anzahl von untergeordneten Elementen fest.
Dieser Parameter kann nur festgelegt werden, wenn der Vorgang für das Thread-Protokoll beendet wurde.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otThreadGetMaxAllowedChildren
otThreadSetMaxChildIpAddresses
otError otThreadSetMaxChildIpAddresses( otInstance *aInstance, uint8_t aMaxIpAddresses )
Legt die maximale Anzahl von IP-Adressen fest, die jedes untergeordnete MTD-Gerät auf diesem Gerät als übergeordnetes Element registrieren kann, oder stellt diese wieder her.
Übergeben Sie 0
, um die Einstellung zu löschen und die Standardeinstellung wiederherzustellen.
Verfügbar, wenn OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
aktiviert ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadGetMaxChildIpAddresses
otThreadSetNetworkIdTimeout
void otThreadSetNetworkIdTimeout( otInstance *aInstance, uint8_t aTimeout )
Legen Sie den Parameter NETWORK_ID_TIMEOUT
fest.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otThreadGetNetworkIdTimeout
otThreadSetParentPriority
otError otThreadSetParentPriority( otInstance *aInstance, int8_t aParentPriority )
Legen Sie die übergeordnete Priorität fest.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadGetParentPriority
otThreadSetPreferredLeaderPartitionId
void otThreadSetPreferredLeaderPartitionId( otInstance *aInstance, uint32_t aPartitionId )
Legt die bevorzugte Thread-Lead-Partitions-ID fest, die bei einem Betrieb in der Leader-Rolle verwendet wird.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otThreadSetPreferredRouterId
otError otThreadSetPreferredRouterId( otInstance *aInstance, uint8_t aRouterId )
Legen Sie die bevorzugte Router-ID fest.
Wenn er ein Router/Leader wird, versucht er, 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 entweder getrennt oder deaktiviert ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadSetPskc
otError otThreadSetPskc( otInstance *aInstance, const otPskc *aPskc )
Legen Sie den Thread-PSKc fest.
Funktioniert nur, wenn Thread-Protokolle deaktiviert sind. Ein erfolgreicher Aufruf dieser Funktion führt außerdem dazu, dass die aktiven und ausstehenden operativen Datasets im nichtflüchtigen Speicher ungültig werden.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadGetPskc
otThreadSetPskcRef
otError otThreadSetPskcRef( otInstance *aInstance, otPskcRef aKeyRef )
Legen Sie die Schlüsselreferenz auf den Thread-PSKc fest.
Erfordert, dass das Build-Zeitfeature OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
aktiviert ist.
Funktioniert nur, wenn Thread-Protokolle deaktiviert sind. Bei Erfolg werden auch die aktiven und ausstehenden operativen Datasets im nichtflüchtigen Speicher ungültig.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadGetPskcRef
otThreadSetRouterDowngradeThreshold
void otThreadSetRouterDowngradeThreshold( otInstance *aInstance, uint8_t aThreshold )
Legen Sie den Parameter ROUTER_DOWNGRADE_GRENZWERT fest, der für die Rolle des Leaders verwendet wird.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otThreadGetRouterDowngradeThreshold
otThreadSetRouterEligible
otError otThreadSetRouterEligible( otInstance *aInstance, bool aEligible )
Legt fest, ob das Gerät Router nutzen kann.
Wenn „aEligible
“ auf „false“ gesetzt ist und das Gerät derzeit als Router verwendet wird, wird das Gerät bei diesem Aufruf getrennt und als Kind wieder verbunden.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otThreadSetRouterIdRange
otError otThreadSetRouterIdRange( otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId )
Legt den Bereich der Router-IDs fest, die Knoten im Thread-Netzwerk zugewiesen werden dürfen.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otThreadGetRouterIdRange
otThreadSetRouterSelectionJitter
void otThreadSetRouterSelectionJitter( otInstance *aInstance, uint8_t aRouterJitter )
Legen Sie den Parameter ROUTER_SELECTION_JITTER fest, der in der Rolle REED/Router verwendet wird.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otThreadGetRouterSelectionJitter
otThreadSetRouterUpgradeThreshold
void otThreadSetRouterUpgradeThreshold( otInstance *aInstance, uint8_t aThreshold )
Legen Sie den Parameter ROUTER_UPGRADE_GRENZWERT fest, der für die Rolle des Leaders verwendet wird.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otThreadGetRouterUpgradeThreshold
otThreadSetSteeringData
void otThreadSetSteeringData( otInstance *aInstance, const otExtAddress *aExtAddress )
Aktiviere Daten für die Steuerung außerhalb des Bandes.
Die Konfigurationsoption „OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE
“ muss so festgelegt sein, dass die Einstellung zur Steuerung der Daten außerhalb des Bandes aktiviert wird.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otThreadSetThreadVersionCheckEnabled
void otThreadSetThreadVersionCheckEnabled( otInstance *aInstance, bool aEnabled )
Legt fest, ob der TLV-Versionsschwellenwert für das Routing (VR-Feld) der Sicherheitsrichtlinie aktiviert ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
Makros
OT_CHILD_IP6_ADDRESS_ITERATOR_INIT
OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0
Initialisierer für otChildIP6AddressIterator.
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.