Stipettaio

Questo modulo include le funzioni per il ruolo di Thread Joiner.

Riepilogo

Enumerazioni

otJoinerState enum
Questa enumerazione definisce lo stato di unione.

Typedef

otJoinerCallback)(otError aError, void *aContext) typedef
void(*
Questo puntatore di funzione viene chiamato per notificare il completamento di un'operazione di partecipazione.
otJoinerDiscerner typedef
Questa struttura rappresenta un falegname esperto.
otJoinerState typedef
Questa enumerazione definisce lo stato di unione.

Functions

otJoinerGetDiscerner(otInstance *aInstance)
Questa funzione ottiene il divisore di unione.
otJoinerGetId(otInstance *aInstance)
const otExtAddress *
Questa funzione ottiene l'ID Joiner.
otJoinerGetState(otInstance *aInstance)
Questa funzione restituisce lo stato di unione.
otJoinerSetDiscerner(otInstance *aInstance, otJoinerDiscerner *aDiscerner)
Questa funzione imposta il divisore di unione.
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)
Questa funzione attiva il ruolo Thread Joiner.
otJoinerStateToString(otJoinerState aState)
const char *
Questa funzione converte un valore di enumerazione dello stato di unione in una stringa leggibile dall'uomo.
otJoinerStop(otInstance *aInstance)
void
Questa funzione disabilita il ruolo di Thread Joiner.

Punti ristoro

otJoinerDiscerner

Questa struttura rappresenta un falegname esperto.

Enumerazioni

otJoinerState

 otJoinerState

Questa enumerazione definisce lo stato di unione.

Typedef

otJoinerCallback

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

Questo puntatore di funzione viene chiamato per notificare il completamento di un'operazione di partecipazione.

Dettagli
Parametri
[in] aError
OT_ERROR_NONE se la procedura di iscrizione è riuscita. OT_ERROR_Sicurezza se la procedura di iscrizione non è riuscita a causa di credenziali di sicurezza. OT_ERROR_NOT_FOUND se non è stata trovata una rete da aggiungere. OT_ERROR_Response_TIMEOUT se una risposta è scaduta.
[in] aContext
Un puntatore al contesto specifico dell'applicazione.

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

Questa struttura rappresenta un falegname esperto.

otJoinerState

enum otJoinerState otJoinerState

Questa enumerazione definisce lo stato di unione.

Functions

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

Questa funzione ottiene il divisore di unione.

Dettagli
Parametri
[in] aInstance
Un puntatore all'istanza OpenThread.
Resi
Un puntatore a Joiner Discerner o NULL se nessuno è impostato.

otJoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

Questa funzione ottiene l'ID Joiner.

Se un fascicolo di falegname non è impostato, l'ID partecipante è i primi 64 bit del risultato dell'elaborazione di SHA-256 su IEEE EUI-64 assegnato in fabbrica. In caso contrario, l'ID Joiner viene calcolato in base al valore del Joiner Discerner.

L'ID Joiner viene utilizzato anche come indirizzo esteso IEEE 802.15.4 durante la procedura di messa in servizio.

Dettagli
Parametri
[in] aInstance
Un puntatore all'istanza OpenThread.
Resi
Un puntatore all'ID Joiner.

otJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

Questa funzione restituisce lo stato di unione.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Valori restituiti
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
)

Questa funzione imposta il divisore di unione.

Il divisore di unione è usato per calcolare l'ID di unione utilizzato durante il processo di messa in servizio/unione.

Per impostazione predefinita (quando non viene fornito o impostato un NULL su NULL), l'ID Joiner viene derivato come primi 64 bit del risultato del calcolo di SHA-256 su IEEE EUI-64 assegnato in fabbrica. Tieni presente che questo è il comportamento principale previsto dalla specifica dei thread.

Dettagli
Parametri
[in] aInstance
Un puntatore all'istanza OpenThread.
[in] aDiscerner
Un suggerimento per un falegname esperto. Se NULL cancella qualsiasi discensore impostato in precedenza,
Valori restituiti
OT_ERROR_NONE
Il partecipante ha effettuato l'aggiornamento.
OT_ERROR_INVALID_ARGS
aDiscerner non valido (la lunghezza specificata non rientra nell'intervallo valido).
OT_ERROR_INVALID_STATE
Esiste una procedura di partecipazione in corso che non può essere modificata.

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
)

Questa funzione attiva il ruolo Thread Joiner.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aPskd
Un puntatore al PSKd.
[in] aProvisioningUrl
Un puntatore all'URL di provisioning (potrebbe essere NULL).
[in] aVendorName
Un puntatore al nome del fornitore (potrebbe essere NULL).
[in] aVendorModel
Un puntatore al modello fornitore (potrebbe essere NULL).
[in] aVendorSwVersion
Un puntatore alla versione SW fornitore (potrebbe essere NULL).
[in] aVendorData
Un puntatore ai dati del fornitore (potrebbe essere NULL).
[in] aCallback
Puntatore a una funzione che viene richiamata al completamento dell'operazione di unione.
[in] aContext
Un puntatore al contesto specifico dell'applicazione.
Valori restituiti
OT_ERROR_NONE
Avviato il ruolo di joiner.
OT_ERROR_BUSY
Il tentativo precedente è ancora in corso.
OT_ERROR_INVALID_ARGS
aPskd o aProvisioningUrl non sono validi.
OT_ERROR_INVALID_STATE
Lo stack IPv6 non è abilitato oppure lo stack di thread è completamente abilitato.

otJoinerStateToString

const char * otJoinerStateToString(
  otJoinerState aState
)

Questa funzione converte un valore di enumerazione dello stato di unione in una stringa leggibile dall'uomo.

Dettagli
Parametri
[in] aState
Lo stato di unione.
Resi
Una rappresentazione stringa leggibile di aState.

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

Questa funzione disabilita il ruolo di Thread Joiner.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.

Macro

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

La lunghezza massima in bit di un divisore di unione.

Risorse

Gli argomenti di riferimento dell'API OpenThread provengono dal codice sorgente, disponibile su GitHub. Per ulteriori informazioni, o per contribuire alla nostra documentazione, consulta la pagina Risorse.