Joiner

Dieses Modul enthält Funktionen für die Rolle „Thread Joiner“.

Zusammenfassung

Aufzählungen
otJoinerState enum
Definiert den Joiner-Status.

Typedefs
otJoinerCallback)(otError aError, void *aContext) typedef
void(*
Der Pointer wird aufgerufen, um den Abschluss eines Join-Vorgangs zu benachrichtigen.
otJoinerDiscerner typedef
Steht für einen Verbindungsmesser.
otJoinerState typedef
Definiert den Joiner-Status.

Funktionen
otJoinerGetDiscerner(otInstance *aInstance)
Ruft die Joiner Discerner ab.
otJoinerGetId(otInstance *aInstance)
const otExtAddress *
Ruft die Joiner-ID ab.
otJoinerGetState(otInstance *aInstance)
Ruft den Joiner-Status ab.
otJoinerSetDiscerner(otInstance *aInstance, otJoinerDiscerner *aDiscerner)
Legt die Joiner Discerner 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)
Aktiviert die Rolle "Thread Joiner".
otJoinerStateToString(otJoinerState aState)
const char *
Wandelt einen bestimmten Aufzählungswert des Joiner-Status in einen menschenlesbaren String um.
otJoinerStop(otInstance *aInstance)
void
Deaktiviert die Rolle „Thread Joiner“.

Strukturen
otJoinerDiscerner

Steht für einen Verbindungsmesser.

Aufzählungen

otJoinerState

 otJoinerState

Definiert den Joiner-Status.

Typedefs

otJoinerCallback

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

Der Pointer wird aufgerufen, um den Abschluss eines Join-Vorgangs zu benachrichtigen.

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

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

Steht für einen Verbindungsmesser.

otJoinerState

enum otJoinerState otJoinerState

Definiert den Joiner-Status.

Funktionen

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

Ruft die Joiner Discerner ab.

Weitere Informationen finden Sie unter otJoinerSetDiscerner.

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
)

Ruft die Joiner-ID ab.

Wenn kein Joiner Discerner festgelegt ist, entspricht die Joiner-ID den ersten 64 Bit des Ergebnisses der Berechnung von SHA-256 über den werkseitig zugewiesenen IEEE EUI-64. Andernfalls wird die Joiner-ID aus dem Joiner Discerner-Wert berechnet.

Die Joiner-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
)

Ruft den Joiner-Status ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Der Joiner-Status.

otJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

Legt die Joiner Discerner fest.

Mit der Joiner Discerner wird die Joiner-ID während der Fadeninbetriebnahme berechnet. Weitere Informationen finden Sie unter otJoinerGetId.

Details
Parameter
[in] aInstance
Ein Zeiger auf die OpenThread-Instanz.
[in] aDiscerner
Ein Zeiger auf einen Joiner Discerner. Bei NULL wird ein zuvor festgelegter Discerner gelöscht.
Rückgabewerte
OT_ERROR_NONE
Die Joiner Discerner wurde aktualisiert.
OT_ERROR_INVALID_ARGS
aDiscerner ist ungültig (angegebene Länge liegt nicht innerhalb des gültigen Bereichs).
OT_ERROR_INVALID_STATE
Es läuft einen laufenden Join-Prozess, daher konnte die Joiner Discerner nicht geändert werden.

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
)

Aktiviert die Rolle "Thread Joiner".

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aPskd
Ein Zeiger auf den PSKd.
[in] aProvisioningUrl
Ein Zeiger auf die Nutzerverwaltungs-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 einen anwendungsspezifischen Kontext.
Rückgabewerte
OT_ERROR_NONE
Rolle „Joiner“ wurde gestartet.
OT_ERROR_BUSY
Der vorherige Versuch läuft noch.
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
)

Wandelt einen bestimmten Aufzählungswert des Joiner-Status in einen menschenlesbaren String um.

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

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

Deaktiviert die Rolle „Thread Joiner“.

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 einer Joiner-Dicke in Bit.

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.