Beispiel

Dieses Modul umfasst Funktionen, die die Openthread Instanz steuern.

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 }	enum Diese Aufzählung definiert Flags, die als Teil übergeben werden `otStateChangedCallback` .

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 
 }

enum

Diese Aufzählung definiert Flags, die als Teil übergeben werden otStateChangedCallback .

typedefs
`otChangedFlags`	typedef `uint32_t` Diese Art stellt ein Bit-Feld, das anzeigt spezifischen Zustand / Konfiguration, die sich geändert hat.
`otInstance`	typedef `struct otInstance` Diese Struktur stellt die Openthread Instanz Struktur.
`otStateChangedCallback )(otChangedFlags aFlags, void *aContext)`	typedef `void(*` Dieser Funktionszeiger aufgerufen bestimmte Konfiguration oder Zustandsänderungen innerhalb Openthread zu benachrichtigen.

Funktionen
`otGetRadioVersionString ( otInstance *aInstance)`	`const char *` Diese Funktion ruft die Openthread Radio Version String.
`otGetVersionString (void)`	`const char *` Diese Funktion ruft die Openthread-Version String.
`otInstanceErasePersistentInfo ( otInstance *aInstance)`	`otError` Diese Funktion löscht alle Openthread persistent info (Netzwerkeinstellungen) gespeichert auf einem nichtflüchtigen Speicher.
`otInstanceFactoryReset ( otInstance *aInstance)`	`void` Dieses Verfahren löscht alle auf einem nichtflüchtigen Speicher gespeicherten Einstellungen, und löst dann Plattform zurückgesetzt.
`otInstanceFinalize ( otInstance *aInstance)`	`void` Diese Funktion deaktiviert die Openthread-Bibliothek.
`otInstanceInit (void aInstanceBuffer, size_t aInstanceBufferSize)`	`otInstance *` Diese Funktion initialisiert die Openthread-Bibliothek.
`otInstanceInitSingle (void)`	`otInstance *` Diese Funktion initialisiert die statische Instanz der Openthread-Bibliothek.
`otInstanceIsInitialized ( otInstance *aInstance)`	`bool` Diese Funktion zeigt an, ob die Instanz gültig / initialisiert.
`otInstanceReset ( otInstance *aInstance)`	`void` Dieses Verfahren löst eine Plattform zurückgesetzt.
`otRemoveStateChangeCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`void` Diese Funktion entfernt einen Rückruf, wenn bestimmte Konfiguration oder Zustandsänderungen innerhalb Openthread anzuzeigen.
`otSetStateChangedCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`otError` Diese Funktion registriert einen Rückruf, wenn bestimmte Konfiguration oder Zustandsänderungen innerhalb Openthread anzuzeigen.

Aufzählungen

anonym enum

 anonymous enum

Diese Aufzählung definiert Flags, die als Teil übergeben werden otStateChangedCallback .

Eigenschaften
`OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL`	Channel Manager neu anstehenden Themen-Kanal geändert.
`OT_CHANGED_COMMISSIONER_STATE`	Kommissar Zustand 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 zu einer IPv6-Multicast-Adresse.
`OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED`	Unsubscribed von einer IPv6-Multicast-Adresse.
`OT_CHANGED_JOINER_STATE`	Joiner Zustand geändert.
`OT_CHANGED_MASTER_KEY`	Hauptschlüssel geändert.
`OT_CHANGED_PSKC`	PSKc geändert.
`OT_CHANGED_SECURITY_POLICY`	Sicherheitspolitik geändert.
`OT_CHANGED_SUPPORTED_CHANNEL_MASK`	Unterstützter Kanalmaske verändert.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL`	Lokale Backbone-Router-Konfiguration geändert.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE`	Backbone-Router Zustand geändert.
`OT_CHANGED_THREAD_CHANNEL`	Thread Netzwerkkanal verändert.
`OT_CHANGED_THREAD_CHILD_ADDED`	Kind wurde hinzugefügt.
`OT_CHANGED_THREAD_CHILD_REMOVED`	Kind wurde entfernt.
`OT_CHANGED_THREAD_EXT_PANID`	Themen-Netzwerk erweitert PAN-ID geändert.
`OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER`	Fädeln Tastenfolge geändert.
`OT_CHANGED_THREAD_LL_ADDR`	Die Link-Local-Adresse geändert.
`OT_CHANGED_THREAD_ML_ADDR`	Die Netz-local-Adresse geändert.
`OT_CHANGED_THREAD_NETDATA`	Fädeln Network Data geändert.
`OT_CHANGED_THREAD_NETIF_STATE`	Thema Netzwerk-Interface-Zustand geändert.
`OT_CHANGED_THREAD_NETWORK_NAME`	Themen-Netzwerknamen geändert.
`OT_CHANGED_THREAD_PANID`	Themen-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`	Rolle (disabled, freistehend, Kind, Router, leader) geändert.

typedefs

otChangedFlags

uint32_t otChangedFlags

Diese Art stellt ein Bit-Feld, das anzeigt spezifischen Zustand / Konfiguration, die sich geändert hat.

Siehe OT_CHANGED_* Definitionen.

otInstance

struct otInstance otInstance

Diese Struktur stellt die Openthread Instanz Struktur.

otStateChangedCallback

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

Dieser Funktionszeiger aufgerufen bestimmte Konfiguration oder Zustandsänderungen innerhalb Openthread zu benachrichtigen.

Einzelheiten

Parameter

`[in] aFlags`	Ein Bit-Feld, das anzeigt spezifischen Zustand, der sich geändert hat. Siehe `OT_CHANGED_*` Definitionen.
`[in] aContext`	Ein Zeiger auf anwendungsspezifischen Kontext.

Funktionen

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

Diese Funktion ruft die Openthread Radio Version String.

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-Version String.

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

otInstanceErasePersistentInfo

 otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

Diese Funktion löscht alle Openthread persistent info (Netzwerkeinstellungen) gespeichert auf einem nichtflüchtigen Speicher.

Löschen ist nur erfolgreich , wenn das Gerät in ist disabled Zustand / Rolle.

Einzelheiten

Parameter

[in] aInstance

Ein Zeiger auf eine Openthread-Instanz.

Rückgabewerte

`OT_ERROR_NONE`	All persistent Info / Zustand wurde erfolgreich gelöscht.
`OT_ERROR_INVALID_STATE`	Das Gerät ist nicht in `disabled` Zustand / Rolle.

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Dieses Verfahren löscht alle auf einem nichtflüchtigen Speicher gespeicherten Einstellungen, und löst dann Plattform zurückgesetzt.

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, wenn Openthread ist nicht mehr in Gebrauch.

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 sie für die nachfolgenden Openthread-API-Aufrufe. Diese Funktion muss vor allen anderen Anrufen Openthread aufgerufen werden.

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

Einzelheiten

Parameter

`[in] aInstanceBuffer`	Der Puffer für Openthread zu verwenden, um die Struktur zum Zuteilen otInstance.
`[in,out] aInstanceBufferSize`	Bei der Eingabe der Größe aInstanceBuffer. Bei der Ausgabe erforderlich, wenn nicht genügend Platz für otInstance, die Anzahl von Bytes für otInstance.

Kehrt zurück

Ein Zeiger auf die neue Openthread-Instanz.

Siehe auch:
otInstanceFinalize

otInstanceInitSingle

 otInstance * otInstanceInitSingle(
  void
)

Diese Funktion initialisiert die statische Instanz der Openthread-Bibliothek.

Diese Funktion initialisiert Openthread und bereitet sie für die nachfolgenden Openthread-API-Aufrufe. Diese Funktion muss vor allen anderen Anrufen Openthread aufgerufen werden.

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

Einzelheiten
Kehrt zurück	Ein Zeiger auf die einzelnen Openthread-Instanz.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

Diese Funktion zeigt an, ob die Instanz gültig / initialisiert.

Die Instanz wird als gültig betrachtet , wenn sie erworben wurden und entweder initialisiert otInstanceInitSingle() (in einzelnen Instanz Fall) oder otInstanceInit() (in Multi - Instanz - Fall). Ein nachfolgender Aufruf an otInstanceFinalize() bewirkt , dass die Instanz als nicht initialisierten berücksichtigt werden.

Einzelheiten

Parameter

[in] aInstance

Ein Zeiger auf eine Openthread-Instanz.

Kehrt zurück

TRUE, wenn die angegebene Instanz gültig ist / initialisiert, andernfalls FALSE.

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

Dieses Verfahren löst eine Plattform zurückgesetzt.

Die Reset-Prozess stellt sicher, dass alle Openthread Zustands- / info (im flüchtigen Speicher gespeichert ist) wird gelöscht. Beachten Sie, dass die otPlatformReset keine persistenten Zustand / Infos in einem nichtflüchtigen Speicher gespeichert werden gelöscht.

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, wenn bestimmte Konfiguration oder Zustandsänderungen innerhalb Openthread anzuzeigen.

Einzelheiten

Parameter

`[in] aInstance`	Ein Zeiger auf eine Openthread-Instanz.
`[in] aCallback`	Ein Zeiger auf eine Funktion, die mit bestimmten Konfiguration oder Zustandsänderungen genannt wird.
`[in] aContext`	Ein Zeiger auf anwendungsspezifischen Kontext.

otSetStateChangedCallback

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

Diese Funktion registriert einen Rückruf, wenn bestimmte Konfiguration oder Zustandsänderungen innerhalb Openthread anzuzeigen.

Einzelheiten

Parameter

`[in] aInstance`	Ein Zeiger auf eine Openthread-Instanz.
`[in] aCallback`	Ein Zeiger auf eine Funktion, die mit bestimmten Konfiguration oder Zustandsänderungen genannt wird.
`[in] aContext`	Ein Zeiger auf anwendungsspezifischen Kontext.

Rückgabewerte

`OT_ERROR_NONE`	den Rückruf in die Liste der Rückrufe hinzugefügt.
`OT_ERROR_ALREADY`	Der Rückruf wurde bereits registriert.
`OT_ERROR_NO_BUFS`	Konnte den Rückruf aufgrund mangelnder Ressourcen hinzuzufügen.