Schreiner

Dieses Modul enthält Funktionen für die Rolle "Thread-Join".

Zusammenfassung

Aufzählungen

otJoinerState enum
Diese Aufzählung definiert den Joiner-Status.

Typdefekt

otJoinerCallback)(otError aError, void *aContext) typedef
void(*
Dieser Funktionszeiger wird aufgerufen, um den Abschluss eines Join-Vorgangs zu bestätigen.
otJoinerDiscerner typedef
Diese Struktur stellt einen Joiner-Disenter dar.
otJoinerState typedef
Diese Aufzählung definiert den Joiner-Status.

Funktionen

otJoinerGetDiscerner(otInstance *aInstance)
Diese Funktion ruft den Joiner-Disenter ab.
otJoinerGetId(otInstance *aInstance)
const otExtAddress *
Diese Funktion ruft die Joiner-ID ab.
otJoinerGetState(otInstance *aInstance)
Diese Funktion gibt den Joiner-Status zurück.
otJoinerSetDiscerner(otInstance *aInstance, otJoinerDiscerner *aDiscerner)
Diese Funktion legt den Joiner-Disenter fest.
otJoinerStart(otInstance *aInstance, const char *aPskd, const char *aProvisioningUrl, const char *aVendorName, const char *aVendorModel, const char *aVendorSwVersion, const char *aVendorData, otJoinerCallback aCallback, void *aContext)
Diese Funktion aktiviert die Rolle "Thread-Join".
otJoinerStateToString(otJoinerState aState)
const char *
Diese Funktion konvertiert einen bestimmten Aufzählungswert des Joiner-Status in einen für Menschen lesbaren String.
otJoinerStop(otInstance *aInstance)
void
Diese Funktion deaktiviert die Rolle ThreadThread-Join“.

Bauwerke

otJoinerDiscerner

Diese Struktur stellt einen Joiner-Disenter dar.

Aufzählungen

otJoinerState

 otJoinerState

Diese Aufzählung definiert den Joiner-Status.

Typdefekt

otJoinerCallback

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

Dieser Funktionszeiger wird aufgerufen, um den Abschluss eines Join-Vorgangs zu bestätigen.

Details
Parameter
[in] aError
OT_ERROR_NONE, wenn der Join-Prozess erfolgreich war. OT_ERROR_SECURITY, wenn der Beitrittsprozess aufgrund von Sicherheitsanmeldedaten fehlgeschlagen ist. OT_ERROR_NOT_FOUND, wenn kein Join-Netzwerk gefunden wurde. OT_ERROR_RESPONSE_TIMEOUT, wenn eine Antwort das Zeitlimit überschritten hat.
[in] aContext
Ein Zeiger auf anwendungsspezifischen Kontext.

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

Diese Struktur stellt einen Joiner-Disenter dar.

otJoinerState

enum otJoinerState otJoinerState

Diese Aufzählung definiert den Joiner-Status.

Funktionen

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

Diese Funktion ruft den Joiner-Disenter ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf die OpenThread-Instanz.
Rückgabe
Ein Zeiger auf Joiner Discerner oder NULL, wenn keiner festgelegt ist.

otJoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

Diese Funktion ruft die Joiner-ID ab.

Wenn kein Joiner-Datenträger festgelegt ist, sind die Joiner-ID die ersten 64 Bit des Ergebnisses der Berechnung von SHA-256 über den vom Firmen zugewiesenen IEEE EUI-64. Andernfalls wird die Joiner-ID aus dem Wert des Joiner-Distriverers berechnet.

Die Join-ID wird während der Inbetriebnahme auch als erweiterte IEEE 802.15.4-Adresse des Geräts verwendet.

Details
Parameter
[in] aInstance
Ein Zeiger auf die OpenThread-Instanz.
Rückgabe
Ein Zeiger auf die Joiner-ID.

otJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

Diese Funktion gibt den Joiner-Status zurück.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabewerte
OT_JOINER_STATE_IDLE
OT_JOINER_STATE_DISCOVER
OT_JOINER_STATE_CONNECT
OT_JOINER_STATE_CONNECTED
OT_JOINER_STATE_ENTRUST
OT_JOINER_STATE_JOINED

otJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

Diese Funktion legt den Joiner-Disenter fest.

Der Joiner Discerner wird verwendet, um die Join-ID zu berechnen, die während des Inbetriebnahme-/Teilnahmevorgangs verwendet wird.

Standardmäßig wird eine Joiner-ID als erste 64 Bit des Ergebnisses der Berechnung von SHA-256 über einen werkseitig zugewiesenen IEEE EUI-64-Wert abgeleitet, wenn kein Erkennungswert angegeben oder auf NULL gesetzt wird. Beachten Sie, dass dies das Hauptverhalten ist, das von der Thread-Spezifikation erwartet wird.

Details
Parameter
[in] aInstance
Ein Zeiger auf die OpenThread-Instanz.
[in] aDiscerner
Ein Zeiger auf einen Joiner-Schlüssel. Wenn NULL löscht eine zuvor festgelegte Erkennung.
Rückgabewerte
OT_ERROR_NONE
Der Joiner-Datenanbieter wurde aktualisiert.
OT_ERROR_INVALID_ARGS
aDiscerner ist ungültig (angegebene Länge liegt außerhalb des gültigen Bereichs).
OT_ERROR_INVALID_STATE
Es wird ein Join-Prozess ausgeführt, sodass der Joiner Discerner nicht geändert werden kann.

otJoinerStart

otError otJoinerStart(
  otInstance *aInstance,
  const char *aPskd,
  const char *aProvisioningUrl,
  const char *aVendorName,
  const char *aVendorModel,
  const char *aVendorSwVersion,
  const char *aVendorData,
  otJoinerCallback aCallback,
  void *aContext
)

Diese Funktion aktiviert die Rolle "Thread-Join".

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aPskd
Ein Zeiger auf das PSKd.
[in] aProvisioningUrl
Ein Zeiger auf die Bereitstellungs-URL (kann NULL sein).
[in] aVendorName
Ein Zeiger auf den Anbieternamen (kann NULL sein).
[in] aVendorModel
Ein Zeiger auf das Anbietermodell (kann NULL sein).
[in] aVendorSwVersion
Ein Zeiger auf die SW-Version des Anbieters (kann NULL sein).
[in] aVendorData
Ein Zeiger auf die Anbieterdaten (kann NULL sein).
[in] aCallback
Ein Zeiger auf eine Funktion, die nach Abschluss des Join-Vorgangs aufgerufen wird.
[in] aContext
Ein Zeiger auf anwendungsspezifischen Kontext.
Rückgabewerte
OT_ERROR_NONE
Joiner-Rolle gestartet.
OT_ERROR_BUSY
Der vorherige Versuch ist noch nicht abgeschlossen.
OT_ERROR_INVALID_ARGS
aPskd oder aProvisioningUrl ist ungültig.
OT_ERROR_INVALID_STATE
Der IPv6-Stack ist nicht aktiviert oder der Thread-Stack ist vollständig aktiviert.

otJoinerStateToString

const char * otJoinerStateToString(
  otJoinerState aState
)

Diese Funktion konvertiert einen bestimmten Aufzählungswert des Joiner-Status in einen für Menschen lesbaren String.

Details
Parameter
[in] aState
Der Joiner-Status.
Rückgabe
Eine für Menschen lesbare Stringdarstellung von aState.

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

Diese Funktion deaktiviert die Rolle ThreadThread-Join“.

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

Makros

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

Maximale Länge eines Joiner-Datenträgers in Bit.

Ressourcen

Die OpenThread API-Referenzthemen stammen aus dem Quellcode, der auf GitHub verfügbar ist. Weitere Informationen und einen Beitrag zu unserer Dokumentation finden Sie unter Ressourcen.