Google is committed to advancing racial equity for Black communities. See how.
Diese Seite wurde von der Cloud Translation API übersetzt.
Switch to English

Beispiel

Dieses Modul enthält Funktionen zur Steuerung der OpenThread-Instanz.

Zusammenfassung

Aufzählungen

anonymous enum {
OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0,
OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1,
OT_CHANGED_THREAD_ROLE = 1 << 2,
OT_CHANGED_THREAD_LL_ADDR = 1 << 3,
OT_CHANGED_THREAD_ML_ADDR = 1 << 4,
OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5,
OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6,
OT_CHANGED_THREAD_PARTITION_ID = 1 << 7,
OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8,
OT_CHANGED_THREAD_NETDATA = 1 << 9,
OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10,
OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11,
OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12,
OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13,
OT_CHANGED_THREAD_CHANNEL = 1 << 14,
OT_CHANGED_THREAD_PANID = 1 << 15,
OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16,
OT_CHANGED_THREAD_EXT_PANID = 1 << 17,
OT_CHANGED_MASTER_KEY = 1 << 18,
OT_CHANGED_PSKC = 1 << 19,
OT_CHANGED_SECURITY_POLICY = 1 << 20,
OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21,
OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22,
OT_CHANGED_COMMISSIONER_STATE = 1 << 23,
OT_CHANGED_THREAD_NETIF_STATE = 1 << 24,
OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25,
OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26,
OT_CHANGED_JOINER_STATE = 1 << 27,
OT_CHANGED_ACTIVE_DATASET = 1 << 28,
OT_CHANGED_PENDING_DATASET = 1 << 29
}
Aufzählung
Diese Aufzählung definiert Flags, die als Teil von otStateChangedCallback .

Typedefs

otChangedFlags typedef
uint32_t
Dieser Typ stellt ein Bitfeld dar, das einen bestimmten Status / eine bestimmte Konfiguration angibt, die sich geändert hat.
otInstance typedef
struct otInstance
Diese Struktur repräsentiert die OpenThread-Instanzstruktur.
otStateChangedCallback )(otChangedFlags aFlags, void *aContext) typedef
void(*
Dieser Funktionszeiger wird aufgerufen, um bestimmte Konfigurations- oder Statusänderungen in OpenThread zu benachrichtigen.

Funktionen

otGetRadioVersionString ( otInstance *aInstance)
const char *
Diese Funktion ruft die OpenThread-Radio-Versionszeichenfolge ab.
otGetVersionString (void)
const char *
Diese Funktion ruft die OpenThread-Versionszeichenfolge ab.
otInstanceErasePersistentInfo ( otInstance *aInstance)
Diese Funktion löscht alle persistenten OpenThread-Informationen (Netzwerkeinstellungen), die im nichtflüchtigen Speicher gespeichert sind.
otInstanceFactoryReset ( otInstance *aInstance)
void
Diese Methode löscht alle im nichtflüchtigen Speicher gespeicherten Einstellungen und löst dann das Zurücksetzen der Plattform aus.
otInstanceFinalize ( otInstance *aInstance)
void
Diese Funktion deaktiviert die OpenThread-Bibliothek.
otInstanceInit (void *aInstanceBuffer, size_t *aInstanceBufferSize)
Diese Funktion initialisiert die OpenThread-Bibliothek.
otInstanceInitSingle (void)
Diese Funktion initialisiert die statische Einzelinstanz der OpenThread-Bibliothek.
otInstanceIsInitialized ( otInstance *aInstance)
bool
Diese Funktion gibt an, ob die Instanz gültig / initialisiert ist oder nicht.
otInstanceReset ( otInstance *aInstance)
void
Diese Methode löst einen Plattform-Reset aus.
otRemoveStateChangeCallback ( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
void
Diese Funktion entfernt einen Rückruf, um anzuzeigen, wann sich bestimmte Konfigurations- oder Statusänderungen in OpenThread ändern.
otSetStateChangedCallback ( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
Diese Funktion registriert einen Rückruf, um anzuzeigen, wann sich bestimmte Konfigurations- oder Statusänderungen in OpenThread ändern.

Aufzählungen

anonyme Aufzählung

 anonymous enum

Diese Aufzählung definiert Flags, die als Teil von otStateChangedCallback .

Eigenschaften
OT_CHANGED_ACTIVE_DATASET

Aktiver Betriebsdatensatz geändert.

OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL

Channel Manager neuer ausstehender Thread-Kanal geändert.

OT_CHANGED_COMMISSIONER_STATE

Kommissarstaat geändert.

OT_CHANGED_IP6_ADDRESS_ADDED

IPv6-Adresse wurde hinzugefügt.

OT_CHANGED_IP6_ADDRESS_REMOVED

IPv6-Adresse wurde entfernt.

OT_CHANGED_IP6_MULTICAST_SUBSCRIBED

Abonniert eine IPv6-Multicast-Adresse.

OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED

Von einer IPv6-Multicast-Adresse abgemeldet.

OT_CHANGED_JOINER_STATE

Tischlerstatus geändert.

OT_CHANGED_MASTER_KEY

Hauptschlüssel geändert.

OT_CHANGED_PENDING_DATASET

Ausstehender Betriebsdatensatz geändert.

OT_CHANGED_PSKC

PSKc geändert.

OT_CHANGED_SECURITY_POLICY

Sicherheitsrichtlinie geändert.

OT_CHANGED_SUPPORTED_CHANNEL_MASK

Unterstützte Kanalmaske geändert.

OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL

Die Konfiguration des lokalen Backbone-Routers wurde geändert.

OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE

Der Status des Backbone-Routers wurde geändert.

OT_CHANGED_THREAD_CHANNEL

Thread-Netzwerkkanal geändert.

OT_CHANGED_THREAD_CHILD_ADDED

Kind wurde hinzugefügt.

OT_CHANGED_THREAD_CHILD_REMOVED

Kind wurde entfernt.

OT_CHANGED_THREAD_EXT_PANID

Erweiterte PAN-ID des Thread-Netzwerks geändert.

OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER

Thread Key Sequence geändert.

OT_CHANGED_THREAD_LL_ADDR

Die linklokale Adresse wurde geändert.

OT_CHANGED_THREAD_ML_ADDR

Die netzlokale Adresse wurde geändert.

OT_CHANGED_THREAD_NETDATA

Thread-Netzwerkdaten geändert.

OT_CHANGED_THREAD_NETIF_STATE

Status der Thread-Netzwerkschnittstelle geändert.

OT_CHANGED_THREAD_NETWORK_NAME

Thread-Netzwerkname geändert.

OT_CHANGED_THREAD_PANID

Thread-Netzwerk-PAN-ID geändert.

OT_CHANGED_THREAD_PARTITION_ID

Partitions-ID geändert.

OT_CHANGED_THREAD_RLOC_ADDED

RLOC wurde hinzugefügt.

OT_CHANGED_THREAD_RLOC_REMOVED

RLOC wurde entfernt.

OT_CHANGED_THREAD_ROLE

Die Rolle (deaktiviert, getrennt, untergeordnet, Router, Anführer) wurde geändert.

Typedefs

otChangedFlags

uint32_t otChangedFlags

Dieser Typ stellt ein Bitfeld dar, das einen bestimmten Status / eine bestimmte Konfiguration angibt, die sich geändert hat.

Siehe OT_CHANGED_* -Definitionen.

otInstance

struct otInstance otInstance

Diese Struktur repräsentiert die OpenThread-Instanzstruktur.

otStateChangedCallback

void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)

Dieser Funktionszeiger wird aufgerufen, um bestimmte Konfigurations- oder Statusänderungen in OpenThread zu benachrichtigen.

Einzelheiten
Parameter
[in] aFlags
Ein Bitfeld, das einen bestimmten Status angibt, der sich geändert hat. Siehe OT_CHANGED_* -Definitionen.
[in] aContext
Ein Zeiger auf einen anwendungsspezifischen Kontext.

Funktionen

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

Diese Funktion ruft die OpenThread-Radio-Versionszeichenfolge ab.

Einzelheiten
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Kehrt zurück
Ein Zeiger auf die OpenThread-Radioversion.

otGetVersionString

const char * otGetVersionString(
  void
)

Diese Funktion ruft die OpenThread-Versionszeichenfolge ab.

Einzelheiten
Kehrt zurück
Ein Zeiger auf die OpenThread-Version.

otInstanceErasePersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

Diese Funktion löscht alle persistenten OpenThread-Informationen (Netzwerkeinstellungen), die im nichtflüchtigen Speicher gespeichert sind.

Das Löschen ist nur erfolgreich, wenn sich das Gerät im disabled Zustand / in der disabled Rolle befindet.

Einzelheiten
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabewerte
OT_ERROR_NONE
Alle persistenten Informationen / Status wurden erfolgreich gelöscht.
OT_ERROR_INVALID_STATE
Gerät ist nicht in disabled Zustand / Rolle.

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Diese Methode löscht alle im nichtflüchtigen Speicher gespeicherten Einstellungen und löst dann das Zurücksetzen der Plattform aus.

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

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

Diese Funktion deaktiviert die OpenThread-Bibliothek.

Rufen Sie diese Funktion auf, wenn OpenThread nicht mehr verwendet wird.

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

otInstanceInit

otInstance * otInstanceInit(
  void *aInstanceBuffer,
  size_t *aInstanceBufferSize
)

Diese Funktion initialisiert die OpenThread-Bibliothek.

Diese Funktion initialisiert OpenThread und bereitet es für nachfolgende OpenThread-API-Aufrufe vor. Diese Funktion muss vor allen anderen Aufrufen von OpenThread aufgerufen werden.

Diese Funktion ist verfügbar und kann nur verwendet werden, wenn die Unterstützung für mehrere OpenThread-Instanzen aktiviert ist.

Einzelheiten
Parameter
[in] aInstanceBuffer
Der Puffer, den OpenThread zum Zuweisen der otInstance-Struktur verwendet.
[in,out] aInstanceBufferSize
Bei der Eingabe die Größe von aInstanceBuffer. Bei der Ausgabe, wenn nicht genügend Speicherplatz für otInstance vorhanden ist, die Anzahl der für otInstance erforderlichen Bytes.
Kehrt zurück
Ein Zeiger auf die neue OpenThread-Instanz.
Siehe auch:
otInstanceFinalize

otInstanceInitSingle

otInstance * otInstanceInitSingle(
  void
)

Diese Funktion initialisiert die statische Einzelinstanz der OpenThread-Bibliothek.

Diese Funktion initialisiert OpenThread und bereitet es für nachfolgende OpenThread-API-Aufrufe vor. Diese Funktion muss vor allen anderen Aufrufen von OpenThread aufgerufen werden.

Diese Funktion ist verfügbar und kann nur verwendet werden, wenn die Unterstützung für mehrere OpenThread-Instanzen deaktiviert ist.

Einzelheiten
Kehrt zurück
Ein Zeiger auf die einzelne OpenThread-Instanz.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

Diese Funktion gibt an, ob die Instanz gültig / initialisiert ist oder nicht.

Die Instanz gilt als gültig, wenn sie entweder mit otInstanceInitSingle() (im Einzelfall) oder otInstanceInit() (im Fall mit mehreren Instanzen) otInstanceInit() und initialisiert wird. Ein nachfolgender Aufruf von otInstanceFinalize() dass die Instanz als nicht initialisiert betrachtet wird.

Einzelheiten
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Kehrt zurück
TRUE, wenn die angegebene Instanz gültig / initialisiert ist, andernfalls FALSE.

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

Diese Methode löst einen Plattform-Reset aus.

Der Rücksetzvorgang stellt sicher, dass alle OpenThread-Status / Informationen (im flüchtigen Speicher gespeichert) gelöscht werden. Beachten Sie, dass otPlatformReset keine dauerhaften Status / Informationen otPlatformReset die im nichtflüchtigen Speicher gespeichert sind.

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

otRemoveStateChangeCallback

void otRemoveStateChangeCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

Diese Funktion entfernt einen Rückruf, um anzuzeigen, wann sich bestimmte Konfigurations- oder Statusänderungen in OpenThread ändern.

Einzelheiten
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aCallback
Ein Zeiger auf eine Funktion, die bei bestimmten Konfigurations- oder Statusänderungen aufgerufen wird.
[in] aContext
Ein Zeiger auf einen anwendungsspezifischen Kontext.

otSetStateChangedCallback

otError otSetStateChangedCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

Diese Funktion registriert einen Rückruf, um anzuzeigen, wann sich bestimmte Konfigurations- oder Statusänderungen in OpenThread ändern.

Einzelheiten
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aCallback
Ein Zeiger auf eine Funktion, die bei bestimmten Konfigurations- oder Statusänderungen aufgerufen wird.
[in] aContext
Ein Zeiger auf einen anwendungsspezifischen Kontext.
Rückgabewerte
OT_ERROR_NONE
Der Rückruf wurde zur Liste der Rückrufe hinzugefügt.
OT_ERROR_ALREADY
Der Rückruf wurde bereits registriert.
OT_ERROR_NO_BUFS
Der Rückruf konnte aufgrund von Ressourcenbeschränkungen nicht hinzugefügt werden.