Operatives Dataset

Enthält Funktionen für die Operational Dataset API.

Zusammenfassung

Nur für FTD-Builds enthält der Dataset-Updater Funktionen zum Verwalten von Dataset-Aktualisierungen.

Bei FTD- und MTD-Builds enthält die Operational Dataset API Funktionen zum Verwalten aktiver und ausstehender Datasets sowie der Dataset-TLVs.

Aufzählungen
otMeshcopTlvType{
  OT_MESHCOP_TLV_CHANNEL = 0,
  OT_MESHCOP_TLV_PANID = 1,
  OT_MESHCOP_TLV_EXTPANID = 2,
  OT_MESHCOP_TLV_NETWORKNAME = 3,
  OT_MESHCOP_TLV_PSKC = 4,
  OT_MESHCOP_TLV_NETWORKKEY = 5,
  OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE = 6,
  OT_MESHCOP_TLV_MESHLOCALPREFIX = 7,
  OT_MESHCOP_TLV_STEERING_DATA = 8,
  OT_MESHCOP_TLV_BORDER_AGENT_RLOC = 9,
  OT_MESHCOP_TLV_COMMISSIONER_ID = 10,
  OT_MESHCOP_TLV_COMM_SESSION_ID = 11,
  OT_MESHCOP_TLV_SECURITYPOLICY = 12,
  OT_MESHCOP_TLV_GET = 13,
  OT_MESHCOP_TLV_ACTIVETIMESTAMP = 14,
  OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT = 15,
  OT_MESHCOP_TLV_STATE = 16,
  OT_MESHCOP_TLV_JOINER_DTLS = 17,
  OT_MESHCOP_TLV_JOINER_UDP_PORT = 18,
  OT_MESHCOP_TLV_JOINER_IID = 19,
  OT_MESHCOP_TLV_JOINER_RLOC = 20,
  OT_MESHCOP_TLV_JOINER_ROUTER_KEK = 21,
  OT_MESHCOP_TLV_PROVISIONING_URL = 32,
  OT_MESHCOP_TLV_VENDOR_NAME_TLV = 33,
  OT_MESHCOP_TLV_VENDOR_MODEL_TLV = 34,
  OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV = 35,
  OT_MESHCOP_TLV_VENDOR_DATA_TLV = 36,
  OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV = 37,
  OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV = 48,
  OT_MESHCOP_TLV_IPV6_ADDRESS_TLV = 49,
  OT_MESHCOP_TLV_PENDINGTIMESTAMP = 51,
  OT_MESHCOP_TLV_DELAYTIMER = 52,
  OT_MESHCOP_TLV_CHANNELMASK = 53,
  OT_MESHCOP_TLV_COUNT = 54,
  OT_MESHCOP_TLV_PERIOD = 55,
  OT_MESHCOP_TLV_SCAN_DURATION = 56,
  OT_MESHCOP_TLV_ENERGY_LIST = 57,
  OT_MESHCOP_TLV_DISCOVERYREQUEST = 128,
  OT_MESHCOP_TLV_DISCOVERYRESPONSE = 129,
  OT_MESHCOP_TLV_JOINERADVERTISEMENT = 241
} 		enum
Stellt Meshcop-TLV-Typen dar.

Typedefs
otChannelMask typedef
uint32_t
Stellt die Kanalmaske dar.
otDatasetMgmtSetCallback)(otError aResult, void *aContext) typedef
void(*
Zeiger wird aufgerufen, wenn eine Antwort auf eine MGMT_SET-Anfrage empfangen wird oder das Zeitlimit überschritten wird.
otDatasetUpdaterCallback)(otError aError, void *aContext) typedef
void(*
Dieser Callback-Funktionszeiger wird aufgerufen, wenn eine Anfrage zur Dataset-Aktualisierung abgeschlossen ist und der Erfolgs- oder Fehlerstatus der Anfrage zum Aktualisieren des Datasets gemeldet wird.
otExtendedPanId typedef
Stellt eine erweiterte PAN-ID dar.
otMeshLocalPrefix typedef
Stellt ein lokales Mesh-Präfix dar.
otMeshcopTlvType typedef
Stellt Meshcop-TLV-Typen dar.
otNetworkKey typedef
struct otNetworkKey
Stellt einen Thread-Netzwerkschlüssel dar.
otNetworkKeyRef typedef
Dieser Datentyp stellt „KeyRef“ für „NetworkKey“ dar.
otNetworkName typedef
struct otNetworkName
Stellt einen Netzwerknamen dar.
otOperationalDataset typedef
Stellt ein aktives oder ausstehendes operatives Dataset dar.
otOperationalDatasetComponents typedef
Stellt das Vorhandensein verschiedener Komponenten im aktiven oder ausstehenden operativen Dataset dar.
otOperationalDatasetTlvs typedef
Stellt ein aktives oder ausstehendes operatives Dataset dar.
otPskc typedef
struct otPskc
Stellt einen PSKc dar.
otPskcRef typedef
Dieser Datentyp stellt KeyRef für PSKc dar.
otSecurityPolicy typedef
Sicherheitsrichtlinie darstellen.
otTimestamp typedef
struct otTimestamp
Stellt eine Zeitstempelkomponente für Thread-Datasets dar.

Variablen
OT_TOOL_PACKED_END

Funktionen
otDatasetConvertToTlvs(const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)
Wandelt ein bestimmtes operatives Dataset in otOperationalDatasetTlvs um.
otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)
Nur für FTD erstellt ein neues operatives Dataset zum Erstellen eines neuen Netzwerks.
otDatasetGeneratePskc(const char *aPassPhrase, const otNetworkName *aNetworkName, const otExtendedPanId *aExtPanId, otPskc *aPskc)
Generiert den PSKc aus einer bestimmten Passphrase, einem Netzwerknamen und einer erweiterten PAN-ID.
otDatasetGetActive(otInstance *aInstance, otOperationalDataset *aDataset)
Ruft das aktive operative Dataset ab.
otDatasetGetActiveTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Ruft das aktive operative Dataset ab.
otDatasetGetDelayTimerMinimal(otInstance *aInstance)
uint32_t
Nur für FTD erhält einen Timer mit minimaler Verzögerung.
otDatasetGetPending(otInstance *aInstance, otOperationalDataset *aDataset)
Ruft das ausstehende operative Dataset ab.
otDatasetGetPendingTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Ruft das ausstehende operative Dataset ab.
otDatasetIsCommissioned(otInstance *aInstance)
bool
Gibt an, ob im aktiven operativen Dataset ein gültiges Netzwerk vorhanden ist.
otDatasetParseTlvs(const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)
Parst ein operatives Dataset aus einem bestimmten otOperationalDatasetTlvs.
otDatasetSendMgmtActiveGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Sendet MGMT_ACTIVE_GET.
otDatasetSendMgmtActiveSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Sendet MGMT_ACTIVE_SET.
otDatasetSendMgmtPendingGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Sendet MGMT_PENDING_GET.
otDatasetSendMgmtPendingSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Sendet MGMT_PENDING_SET.
otDatasetSetActive(otInstance *aInstance, const otOperationalDataset *aDataset)
Legt das aktive operative Dataset fest.
otDatasetSetActiveTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Legt das aktive operative Dataset fest.
otDatasetSetDelayTimerMinimal(otInstance *aInstance, uint32_t aDelayTimerMinimal)
Nur für FTD legt einen Timer für minimale Verzögerung fest.
otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset)
Legt das ausstehende operative Dataset fest.
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Legt das ausstehende operative Dataset fest.
otDatasetUpdateTlvs(const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)
Aktualisiert ein bestimmtes operatives Dataset.
otDatasetUpdaterCancelUpdate(otInstance *aInstance)
void
Bricht eine laufende (falls vorhanden) Anfrage zur Aktualisierung des operativen Datensatzes ab.
otDatasetUpdaterIsUpdateOngoing(otInstance *aInstance)
bool
Gibt an, ob eine laufende Anfrage zur Aktualisierung des Vorgangs-Datasets vorliegt.
otDatasetUpdaterRequestUpdate(otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext)
Fordert eine Aktualisierung des operativen Datasets an.
otNetworkNameFromString(otNetworkName *aNetworkName, const char *aNameString)
Legt eine otNetworkName-Instanz aus einem angegebenen null beendeten C-String fest.

Strukturen
otExtendedPanId

Stellt eine erweiterte PAN-ID dar.

otNetworkKey

Stellt einen Thread-Netzwerkschlüssel dar.

otNetworkName

Stellt einen Netzwerknamen dar.

otOperationalDataset

Stellt ein aktives oder ausstehendes operatives Dataset dar.

otOperationalDatasetComponents

Stellt das Vorhandensein verschiedener Komponenten im aktiven oder ausstehenden operativen Dataset dar.

otOperationalDatasetTlvs

Stellt ein aktives oder ausstehendes operatives Dataset dar.

otPskc

Steht für PSKc.

otSecurityPolicy

Sicherheitsrichtlinie darstellen.

otTimestamp

Stellt eine Zeitstempelkomponente für Thread-Datasets dar.

Aufzählungen

otMeshcopTlvType

 otMeshcopTlvType

Stellt Meshcop-TLV-Typen dar.

Attribute
OT_MESHCOP_TLV_ACTIVETIMESTAMP

Meshcop: aktiver Zeitstempel – TLV

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

Meshcop-Border-Agent-Locator – TLV

OT_MESHCOP_TLV_CHANNEL

Meshcop-Kanal TLV

OT_MESHCOP_TLV_CHANNELMASK

Meshcop-Kanalmaske – TLV

OT_MESHCOP_TLV_COMMISSIONER_ID

Meshcop-Beauftragter-ID – TLV

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

Meshcop Commissioner UDP-Port TLV

OT_MESHCOP_TLV_COMM_SESSION_ID

Sitzungs-ID des Meshcop-Beauftragten (TLV)

OT_MESHCOP_TLV_COUNT

Meshcop-Anzahl TLV

OT_MESHCOP_TLV_DELAYTIMER

Meshcop-Verzögerungs-Timer – TLV

OT_MESHCOP_TLV_DISCOVERYREQUEST

Meshcop-Erkennungsanfrage – TLV

OT_MESHCOP_TLV_DISCOVERYRESPONSE

Meshcop Discovery Response – TLV

OT_MESHCOP_TLV_ENERGY_LIST

Meshcop-Energieliste TLV

OT_MESHCOP_TLV_EXTPANID

Meshcop-Erweiterte Pan-ID – TLV

OT_MESHCOP_TLV_GET

Meshcop-Get TLV

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

Meshcop-IPv6-Adresse – TLV

OT_MESHCOP_TLV_JOINERADVERTISEMENT

Meshcop-Joiner-Anzeige – TLV

OT_MESHCOP_TLV_JOINER_DTLS

Meshcop-Joiner-DTLS-Kapselung – TLV

OT_MESHCOP_TLV_JOINER_IID

Meshcop Joiner IID TLV

OT_MESHCOP_TLV_JOINER_RLOC

Sucher für Meshcop-Steckverbinder – TLV

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

Meshcop-Verbindungsfräser KEK TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

Meshcop-Joiner-UDP-Port – TLV

OT_MESHCOP_TLV_MESHLOCALPREFIX

Meshcop-Mesh-Netzwerk-Präfix (TLV)

OT_MESHCOP_TLV_NETWORKKEY

Meshcop-Netzwerkschlüssel – TLV

OT_MESHCOP_TLV_NETWORKNAME

Meshcop-Netzwerkname – TLV

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE

Meshcop-Netzwerkschlüsselsequenz – TLV

OT_MESHCOP_TLV_PANID

Meshcop-Pan-ID – TLV

OT_MESHCOP_TLV_PENDINGTIMESTAMP

TLV für Meshcop-Zeitstempel ausstehend

OT_MESHCOP_TLV_PERIOD

Meshcop-Zeitraum TLV

OT_MESHCOP_TLV_PROVISIONING_URL

Meshcop-Bereitstellungs-URL – TLV

OT_MESHCOP_TLV_PSKC

Meshcop PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

Meshcop-Scandauer TLV

OT_MESHCOP_TLV_SECURITYPOLICY

Meshcop-Sicherheitsrichtlinie – TLV

OT_MESHCOP_TLV_STATE

Meshcop State TLV

OT_MESHCOP_TLV_STEERING_DATA

Meshcop-Steuerungsdaten – TLV

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

Meshcop-UDP-Kapselung – TLV

OT_MESHCOP_TLV_VENDOR_DATA_TLV

Meshcop-Anbieterdaten – TLV

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

Meshcop-Anbietermodell – TLV

OT_MESHCOP_TLV_VENDOR_NAME_TLV

Name des Meshcop-Anbieters – TLV

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

TLV-Version des Meshcop-Anbieter-Stacks

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

SW-Version TLV des Meshcop-Anbieters

Typedefs

otChannelMask

uint32_t otChannelMask

Stellt die Kanalmaske dar.

otDatasetMgmtSetCallback

void(* otDatasetMgmtSetCallback)(otError aResult, void *aContext)

Zeiger wird aufgerufen, wenn eine Antwort auf eine MGMT_SET-Anfrage empfangen wird oder das Zeitlimit überschritten wird.

Details
Parameter
[in] aResult
Ergebnis des Vorgangs.
[in] aContext
Ein Zeiger auf einen anwendungsspezifischen Kontext.
Rückgabewerte
OT_ERROR_NONE
Die Anfrage wurde vom Leader angenommen.
OT_ERROR_REJECTED
Die Anfrage wurde vom Leader abgelehnt.
OT_ERROR_PARSE
Beim Parsen der Antwort ist ein Fehler aufgetreten.
OT_ERROR_ABORT
Die Anfrage wurde durch einen Peer zurückgesetzt.
OT_ERROR_RESPONSE_TIMEOUT
Während des Zeitlimits wurde keine Antwort oder Bestätigung empfangen.

otDatasetUpdaterCallback

void(* otDatasetUpdaterCallback)(otError aError, void *aContext)

Dieser Callback-Funktionszeiger wird aufgerufen, wenn eine Anfrage zur Dataset-Aktualisierung abgeschlossen ist und der Erfolgs- oder Fehlerstatus der Anfrage zum Aktualisieren des Datasets gemeldet wird.

Verfügbar, wenn OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE aktiviert ist.

Details
Parameter
[in] aError
Der Fehlerstatus. OT_ERROR_NONE gibt an, dass das Dataset erfolgreich aktualisiert wurde. OT_ERROR_INVALID_STATE gibt einen Fehler aufgrund eines ungültigen Status an (MLE wird deaktiviert). OT_ERROR_ALREADY gibt an, dass ein Fehler aufgetreten ist, weil ein anderes Gerät im Netzwerk eine in Konflikt stehende Aktualisierung des Datasets angefordert hat.
[in] aContext
Ein Zeiger auf den willkürlichen Kontext, der vom Nutzer in otDatasetUpdaterRequestUpdate() bereitgestellt wird.

otExtendedPanId

struct otExtendedPanId otExtendedPanId

Stellt eine erweiterte PAN-ID dar.

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

Stellt ein lokales Mesh-Präfix dar.

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

Stellt Meshcop-TLV-Typen dar.

otNetworkKey

struct otNetworkKey otNetworkKey

Stellt einen Thread-Netzwerkschlüssel dar.

otNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

Dieser Datentyp stellt „KeyRef“ für „NetworkKey“ dar.

Verweis auf Schlüssel

otNetworkName

struct otNetworkName otNetworkName

Stellt einen Netzwerknamen dar.

Die otNetworkName ist ein mit Null beendeter C-String (d.h. Das m8-Zeichen-Array MUSS mit einem Null-Zeichen (\0) enden.

otOperationalDataset

struct otOperationalDataset otOperationalDataset

Stellt ein aktives oder ausstehendes operatives Dataset dar.

Komponenten im Dataset sind optional. Die mComponents-Struktur gibt an, welche Komponenten im Dataset vorhanden sind.

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

Stellt das Vorhandensein verschiedener Komponenten im aktiven oder ausstehenden operativen Dataset dar.

otOperationalDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

Stellt ein aktives oder ausstehendes operatives Dataset dar.

Das operative Dataset ist wie von Thread angegeben TLV-codiert.

otPskc

struct otPskc otPskc

Stellt einen PSKc dar.

otPskcRef

otCryptoKeyRef otPskcRef

Dieser Datentyp stellt KeyRef für PSKc dar.

Verweis auf Schlüssel

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

Sicherheitsrichtlinie darstellen.

otTimestamp

struct otTimestamp otTimestamp

Stellt eine Zeitstempelkomponente für Thread-Datasets dar.

Variablen

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

Funktionen

otDatasetConvertToTlvs

otError otDatasetConvertToTlvs(
  const otOperationalDataset *aDataset,
  otOperationalDatasetTlvs *aDatasetTlvs
)

Wandelt ein bestimmtes operatives Dataset in otOperationalDatasetTlvs um.

Details
Parameter
[in] aDataset
Ein operatives Dataset, das in TLVs konvertiert werden soll.
[out] aDatasetTlvs
Ein Zeiger auf Dataset-TLVs, um das Ergebnis zurückzugeben.
Rückgabewerte
OT_ERROR_NONE
aDataset wurde konvertiert und aDatasetTlvs wurde aktualisiert.
OT_ERROR_INVALID_ARGS
aDataset ist ungültig und enthält keine aktiven oder ausstehenden Zeitstempel.

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Nur für FTD erstellt ein neues operatives Dataset zum Erstellen eines neuen Netzwerks.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[out] aDataset
Das operative Dataset.
Rückgabewerte
OT_ERROR_NONE
Neues operatives Dataset wurde erstellt.
OT_ERROR_FAILED
Zufallswerte für neue Parameter konnten nicht generiert werden.

otDatasetGeneratePskc

otError otDatasetGeneratePskc(
  const char *aPassPhrase,
  const otNetworkName *aNetworkName,
  const otExtendedPanId *aExtPanId,
  otPskc *aPskc
)

Generiert den PSKc aus einer bestimmten Passphrase, einem Netzwerknamen und einer erweiterten PAN-ID.

Der PSKc wird verwendet, um die Sitzung des Kommissars einzurichten.

Details
Parameter
[in] aPassPhrase
Passphrase für die Inbetriebnahme
[in] aNetworkName
Der Netzwerkname für die PSKc-Berechnung.
[in] aExtPanId
Die erweiterte PAN-ID für die PSKc-Berechnung.
[out] aPskc
Ein Zeiger auf eine Variable zur Ausgabe des generierten PSKc.
Rückgabewerte
OT_ERROR_NONE
PSKc wurde generiert.
OT_ERROR_INVALID_ARGS
Wenn eines der Eingabeargumente ungültig ist.

otDatasetGetActive

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Ruft das aktive operative Dataset ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[out] aDataset
Ein Zeiger auf die Stelle, an der das aktive operative Dataset platziert wird.
Rückgabewerte
OT_ERROR_NONE
Das aktive operative Dataset wurde abgerufen.
OT_ERROR_NOT_FOUND
Kein entsprechender Wert im Einstellungsspeicher.

otDatasetGetActiveTlvs

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Ruft das aktive operative Dataset ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[out] aDataset
Ein Zeiger auf die Stelle, an der das aktive operative Dataset platziert wird.
Rückgabewerte
OT_ERROR_NONE
Das aktive operative Dataset wurde abgerufen.
OT_ERROR_NOT_FOUND
Kein entsprechender Wert im Einstellungsspeicher.

otDatasetGetDelayTimerMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

Nur für FTD erhält einen Timer mit minimaler Verzögerung.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabewerte
the
Wert des Timers für die minimale Verzögerung (in ms)

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Ruft das ausstehende operative Dataset ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[out] aDataset
Ein Zeiger auf die Stelle, an der das ausstehende operative Dataset platziert wird.
Rückgabewerte
OT_ERROR_NONE
Das ausstehende operative Dataset wurde abgerufen.
OT_ERROR_NOT_FOUND
Kein entsprechender Wert im Einstellungsspeicher.

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Ruft das ausstehende operative Dataset ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[out] aDataset
Ein Zeiger auf die Stelle, an der das ausstehende operative Dataset platziert wird.
Rückgabewerte
OT_ERROR_NONE
Das ausstehende operative Dataset wurde abgerufen.
OT_ERROR_NOT_FOUND
Kein entsprechender Wert im Einstellungsspeicher.

otDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

Gibt an, ob im aktiven operativen Dataset ein gültiges Netzwerk vorhanden ist.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
TRUE, wenn im aktiven operativen Dataset ein gültiges Netzwerk vorhanden ist, andernfalls FALSE.

otDatasetParseTlvs

otError otDatasetParseTlvs(
  const otOperationalDatasetTlvs *aDatasetTlvs,
  otOperationalDataset *aDataset
)

Parst ein operatives Dataset aus einem bestimmten otOperationalDatasetTlvs.

Details
Parameter
[in] aDatasetTlvs
Ein Zeiger auf Dataset-TLVs.
[out] aDataset
Ein Zeiger auf die Stelle, an der das Dataset platziert wird.
Rückgabewerte
OT_ERROR_NONE
aDataset wurde von aDatasetTlvs festgelegt.
OT_ERROR_INVALID_ARGS
„aDatasetTlvs“ ist ungültig.

otDatasetSendMgmtActiveGet

otError otDatasetSendMgmtActiveGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

Sendet MGMT_ACTIVE_GET.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aDatasetComponents
Ein Zeiger auf eine Dataset-Komponentenstruktur, die angibt, welche Komponenten angefordert werden sollen.
[in] aTlvTypes
Ein Zeiger auf ein Array, das zusätzliche TLV-Rohtypen enthält, die angefordert werden sollen.
[in] aLength
Die Länge von aTlvTypes.
[in] aAddress
Ein Zeiger auf das IPv6-Ziel verwendet, wenn dieser NULL ist, standardmäßig Leader-ALOC.
Rückgabewerte
OT_ERROR_NONE
Senden Sie den Meshcop-Dataset-Befehl erfolgreich.
OT_ERROR_NO_BUFS
Nicht genügend Pufferspeicher zum Senden.

otDatasetSendMgmtActiveSet

otError otDatasetSendMgmtActiveSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

Sendet MGMT_ACTIVE_SET.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aDataset
Ein Zeiger auf ein operatives Dataset.
[in] aTlvs
Ein Zeiger auf TLVs.
[in] aLength
Die Länge von TLVs.
[in] aCallback
Ein Zeiger auf eine Funktion, die bei einem Antwortempfang oder bei einer Zeitüberschreitung aufgerufen wird.
[in] aContext
Ein Verweis auf den anwendungsspezifischen Kontext für aCallback.
Rückgabewerte
OT_ERROR_NONE
Senden Sie den Meshcop-Dataset-Befehl erfolgreich.
OT_ERROR_NO_BUFS
Nicht genügend Pufferspeicher zum Senden.
OT_ERROR_BUSY
Eine vorherige Anfrage ist noch in Bearbeitung.

otDatasetSendMgmtPendingGet

otError otDatasetSendMgmtPendingGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

Sendet MGMT_PENDING_GET.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aDatasetComponents
Ein Zeiger auf eine Dataset-Komponentenstruktur, die angibt, welche Komponenten angefordert werden sollen.
[in] aTlvTypes
Ein Zeiger auf ein Array, das zusätzliche TLV-Rohtypen enthält, die angefordert werden sollen.
[in] aLength
Die Länge von aTlvTypes.
[in] aAddress
Ein Zeiger auf das IPv6-Ziel verwendet, wenn dieser NULL ist, standardmäßig Leader-ALOC.
Rückgabewerte
OT_ERROR_NONE
Senden Sie den Meshcop-Dataset-Befehl erfolgreich.
OT_ERROR_NO_BUFS
Nicht genügend Pufferspeicher zum Senden.

otDatasetSendMgmtPendingSet

otError otDatasetSendMgmtPendingSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

Sendet MGMT_PENDING_SET.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aDataset
Ein Zeiger auf ein operatives Dataset.
[in] aTlvs
Ein Zeiger auf TLVs.
[in] aLength
Die Länge von TLVs.
[in] aCallback
Ein Zeiger auf eine Funktion, die bei einem Antwortempfang oder bei einer Zeitüberschreitung aufgerufen wird.
[in] aContext
Ein Verweis auf den anwendungsspezifischen Kontext für aCallback.
Rückgabewerte
OT_ERROR_NONE
Senden Sie den Meshcop-Dataset-Befehl erfolgreich.
OT_ERROR_NO_BUFS
Nicht genügend Pufferspeicher zum Senden.
OT_ERROR_BUSY
Eine vorherige Anfrage ist noch in Bearbeitung.

otDatasetSetActive

otError otDatasetSetActive(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

Legt das aktive operative Dataset fest.

Wenn das Dataset keinen aktiven Zeitstempel enthält, ist es nur teilweise vollständig.

Wenn Thread auf einem Gerät mit einem teilweise aktiven Dataset aktiviert ist, versucht das Gerät, sich mit einem vorhandenen Thread-Netzwerk zu verbinden. Dazu werden alle im Dataset vorhandenen Informationen verwendet. Zum Anhängen an ein Netzwerk wird nur der Thread-Netzwerkschlüssel benötigt.

Wenn der Kanal nicht im Dataset enthalten ist, sendet das Gerät eine MLE-Nachricht über verschiedene Kanäle an, um Nachbarn auf anderen Kanälen zu finden.

Wenn das Gerät mit einem Thread-Netzwerk verbunden ist, ruft es das vollständige aktive Dataset vom übergeordneten Netzwerk ab. Hinweis: Ein Router-fähiges Gerät wechselt erst dann in die Router- oder Leader-Rolle, wenn es ein vollständiges aktives Dataset hat.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aDataset
Ein Zeiger auf das aktive operative Dataset.
Rückgabewerte
OT_ERROR_NONE
Aktives operatives Dataset wurde festgelegt.
OT_ERROR_NO_BUFS
Nicht genügend Pufferspeicher zum Festlegen des aktiven operativen Datasets.
OT_ERROR_NOT_IMPLEMENTED
Auf der Plattform sind keine Einstellungen implementiert.

otDatasetSetActiveTlvs

otError otDatasetSetActiveTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

Legt das aktive operative Dataset fest.

Wenn das Dataset keinen aktiven Zeitstempel enthält, ist es nur teilweise vollständig.

Wenn Thread auf einem Gerät mit einem teilweise aktiven Dataset aktiviert ist, versucht das Gerät, sich mit einem vorhandenen Thread-Netzwerk zu verbinden. Dazu werden alle im Dataset vorhandenen Informationen verwendet. Zum Anhängen an ein Netzwerk wird nur der Thread-Netzwerkschlüssel benötigt.

Wenn der Kanal nicht im Dataset enthalten ist, sendet das Gerät eine MLE-Nachricht über verschiedene Kanäle an, um Nachbarn auf anderen Kanälen zu finden.

Wenn das Gerät mit einem Thread-Netzwerk verbunden ist, ruft es das vollständige aktive Dataset vom übergeordneten Netzwerk ab. Hinweis: Ein Router-fähiges Gerät wechselt erst dann in die Router- oder Leader-Rolle, wenn es ein vollständiges aktives Dataset hat.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aDataset
Ein Zeiger auf das aktive operative Dataset.
Rückgabewerte
OT_ERROR_NONE
Aktives operatives Dataset wurde festgelegt.
OT_ERROR_NO_BUFS
Nicht genügend Pufferspeicher zum Festlegen des aktiven operativen Datasets.
OT_ERROR_NOT_IMPLEMENTED
Auf der Plattform sind keine Einstellungen implementiert.

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

Nur für FTD legt einen Timer für minimale Verzögerung fest.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aDelayTimerMinimal
Wert des Timers für die minimale Verzögerung (in ms).
Rückgabewerte
OT_ERROR_NONE
Timer für minimale Verzögerung wurde eingestellt.
OT_ERROR_INVALID_ARGS
Wenn aDelayTimerMinimal ungültig ist.

otDatasetSetPending

otError otDatasetSetPending(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

Legt das ausstehende operative Dataset fest.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aDataset
Ein Zeiger auf das ausstehende operative Dataset.
Rückgabewerte
OT_ERROR_NONE
Ausstehendes operatives Dataset wurde festgelegt.
OT_ERROR_NO_BUFS
Nicht genügend Pufferspeicher zum Festlegen des ausstehenden operativen Datasets.
OT_ERROR_NOT_IMPLEMENTED
Auf der Plattform sind keine Einstellungen implementiert.

otDatasetSetPendingTlvs

otError otDatasetSetPendingTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

Legt das ausstehende operative Dataset fest.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aDataset
Ein Zeiger auf das ausstehende operative Dataset.
Rückgabewerte
OT_ERROR_NONE
Ausstehendes operatives Dataset wurde festgelegt.
OT_ERROR_NO_BUFS
Nicht genügend Pufferspeicher zum Festlegen des ausstehenden operativen Datasets.
OT_ERROR_NOT_IMPLEMENTED
Auf der Plattform sind keine Einstellungen implementiert.

otDatasetUpdateTlvs

otError otDatasetUpdateTlvs(
  const otOperationalDataset *aDataset,
  otOperationalDatasetTlvs *aDatasetTlvs
)

Aktualisiert ein bestimmtes operatives Dataset.

aDataset enthält die zu aktualisierenden Felder und ihren neuen Wert.

Details
Parameter
[in] aDataset
Gibt die Typen und Werte an, die aktualisiert werden sollen.
[in,out] aDatasetTlvs
Ein Zeiger auf Dataset-TLVs, die aktualisiert werden sollen.
Rückgabewerte
OT_ERROR_NONE
aDatasetTlvs wurde aktualisiert.
OT_ERROR_INVALID_ARGS
aDataset enthält ungültige Werte.
OT_ERROR_NO_BUFS
Nicht genügend Speicherplatz in aDatasetTlvs, um das Update anzuwenden.

otDatasetUpdaterCancelUpdate

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

Bricht eine laufende (falls vorhanden) Anfrage zur Aktualisierung des operativen Datensatzes ab.

Verfügbar, wenn OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE aktiviert ist.

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

otDatasetUpdaterIsUpdateOngoing

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

Gibt an, ob eine laufende Anfrage zur Aktualisierung des Vorgangs-Datasets vorliegt.

Verfügbar, wenn OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE aktiviert ist.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabewerte
TRUE
Es gibt ein fortlaufendes Update.
FALSE
Es gibt keine fortlaufenden Updates.

otDatasetUpdaterRequestUpdate

otError otDatasetUpdaterRequestUpdate(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  otDatasetUpdaterCallback aCallback,
  void *aContext
)

Fordert eine Aktualisierung des operativen Datasets an.

Verfügbar, wenn OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE aktiviert ist.

aDataset muss die zu aktualisierenden Felder und ihren neuen Wert enthalten. Es darf keine Felder für aktiven oder ausstehenden Zeitstempel enthalten. Das Feld „Verzögerung“ ist optional. Wenn es nicht angegeben wird, wird ein Standardwert (1.000 ms) verwendet.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aDataset
Ein Zeiger auf das Dataset, das die zu ändernden Felder enthält.
[in] aCallback
Ein Callback, der angibt, wenn die Anfrage zur Dataset-Aktualisierung abgeschlossen ist.
[in] aContext
Ein beliebiger Kontext, der an den Callback übergeben wird.
Rückgabewerte
OT_ERROR_NONE
Dataset-Aktualisierung wurde gestartet (aCallback wird nach Abschluss aufgerufen).
OT_ERROR_INVALID_STATE
Gerät ist deaktiviert (MLE ist deaktiviert).
OT_ERROR_INVALID_ARGS
aDataset ist ungültig (enthält aktiven oder ausstehenden Zeitstempel).
OT_ERROR_BUSY
Update kann nicht gestartet werden, da ein vorheriges noch läuft.
OT_ERROR_NO_BUFS
Puffer zum Speichern des Datasets konnte nicht zugewiesen werden.

otNetworkNameFromString

otError otNetworkNameFromString(
  otNetworkName *aNetworkName,
  const char *aNameString
)

Legt eine otNetworkName-Instanz aus einem angegebenen null beendeten C-String fest.

aNameString muss der UTF-8-Codierung entsprechen und der Netzwerkname darf nicht länger als OT_NETWORK_NAME_MAX_SIZE sein.

Details
Parameter
[out] aNetworkName
Ein Zeiger auf die festzulegende otNetworkName.
[in] aNameString
Ein Name-C-String.
Rückgabewerte
OT_ERROR_NONE
aNetworkName wurde von aNameString festgelegt.
OT_ERROR_INVALID_ARGS
aNameStrng ist ungültig (zu lang oder entspricht nicht der UTF-8-Codierung).

Makros

OT_CHANNEL_10_MASK

 OT_CHANNEL_10_MASK (1 << 10)

Kanal 10.

OT_CHANNEL_11_MASK

 OT_CHANNEL_11_MASK (1 << 11)

Kanal 11.

OT_CHANNEL_12_MASK

 OT_CHANNEL_12_MASK (1 << 12)

Kanal 12.

OT_CHANNEL_13_MASK

 OT_CHANNEL_13_MASK (1 << 13)

Kanal 13.

OT_CHANNEL_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

Kanal 14.

OT_CHANNEL_15_MASK

 OT_CHANNEL_15_MASK (1 << 15)

Kanal 15.

OT_CHANNEL_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

Kanal 16.

OT_CHANNEL_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

Kanal 17.

OT_CHANNEL_18_MASK

 OT_CHANNEL_18_MASK (1 << 18)

Kanal 18.

OT_CHANNEL_19_MASK

 OT_CHANNEL_19_MASK (1 << 19)

Kanal 19.

OT_CHANNEL_1_MASK

 OT_CHANNEL_1_MASK (1 << 1)

Kanal 1.

OT_CHANNEL_20_MASK

 OT_CHANNEL_20_MASK (1 << 20)

Kanal 20.

OT_CHANNEL_21_MASK

 OT_CHANNEL_21_MASK (1 << 21)

Kanal 21.

OT_CHANNEL_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

Kanal 22.

OT_CHANNEL_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

Kanal 23.

OT_CHANNEL_24_MASK

 OT_CHANNEL_24_MASK (1 << 24)

Kanal 24.

OT_CHANNEL_25_MASK

 OT_CHANNEL_25_MASK (1 << 25)

Kanal 25.

OT_CHANNEL_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

Kanal 26.

OT_CHANNEL_2_MASK

 OT_CHANNEL_2_MASK (1 << 2)

Kanal 2.

OT_CHANNEL_3_MASK

 OT_CHANNEL_3_MASK (1 << 3)

Kanal 3.

OT_CHANNEL_4_MASK

 OT_CHANNEL_4_MASK (1 << 4)

Kanal 4.

OT_CHANNEL_5_MASK

 OT_CHANNEL_5_MASK (1 << 5)

Kanal 5.

OT_CHANNEL_6_MASK

 OT_CHANNEL_6_MASK (1 << 6)

Kanal 6.

OT_CHANNEL_7_MASK

 OT_CHANNEL_7_MASK (1 << 7)

Kanal 7.

OT_CHANNEL_8_MASK

 OT_CHANNEL_8_MASK (1 << 8)

Kanal 8.

OT_CHANNEL_9_MASK

 OT_CHANNEL_9_MASK (1 << 9)

Kanal 9.

OT_EXT_PAN_ID_SIZE

 OT_EXT_PAN_ID_SIZE 8

Größe einer Thread-PAN-ID (Byte)

OT_MESH_LOCAL_PREFIX_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

Größe des lokalen Mesh-Präfixes (Byte)

OT_NETWORK_KEY_SIZE

 OT_NETWORK_KEY_SIZE 16

Größe des Thread-Netzwerkschlüssels (Byte)

OT_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

Maximale Größe des Felds für den Thread-Netzwerknamen (Byte)

OT_OPERATIONAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

Maximale Länge des operativen Datasets in Byte.

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

Maximale Größe des PSKc (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.