Joiner

Questo modulo include le funzioni per il ruolo Joiner Thread.

Riepilogo

Enumerazioni
otJoinerState enum
Definisce lo stato del joiner.

Typedef
otJoinerCallback)(otError aError, void *aContext) typedef
void(*
Il puntatore viene chiamato per notificare il completamento di un'operazione di join.
otJoinerDiscerner typedef
Rappresenta un Joiner Discerner.
otJoinerState typedef
Definisce lo stato del joiner.

Funzioni
otJoinerGetDiscerner(otInstance *aInstance)
Si aggiudica il joiner con discerner.
otJoinerGetId(otInstance *aInstance)
const otExtAddress *
Recupera l'ID joiner.
otJoinerGetState(otInstance *aInstance)
Ottieni lo stato del joiner.
otJoinerSetDiscerner(otInstance *aInstance, otJoinerDiscerner *aDiscerner)
Imposta il Discerner del joiner.
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)
Abilita il ruolo Joiner thread.
otJoinerStateToString(otJoinerState aState)
const char *
Converte un determinato valore di enumerazione dello stato del joiner in una stringa leggibile.
otJoinerStop(otInstance *aInstance)
void
Disabilita il ruolo Joiner thread.

Strutture
otJoinerDiscerner

Rappresenta un Joiner Discerner.

Enumerazioni

otJoinerState

 otJoinerState

Definisce lo stato del joiner.

Typedef

otJoinerCallback

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

Il puntatore viene chiamato per notificare il completamento di un'operazione di join.

Dettagli
Parametri
[in] aError
OT_ERROR_NONE se il processo di unione è riuscito. OT_ERROR_WARNING se il processo di partecipazione non è riuscito a causa di credenziali di sicurezza. OT_ERROR_NOT_FOUND se non è stata rilevata alcuna rete unibile. OT_ERROR_ANSWER_TIMEOUT se una risposta è scaduta.
[in] aContext
Un puntatore al contesto specifico dell'applicazione.

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

Rappresenta un Joiner Discerner.

otJoinerState

enum otJoinerState otJoinerState

Definisce lo stato del joiner.

Funzioni

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

Si aggiudica il joiner con discerner.

Per ulteriori informazioni, consulta otJoinerSetDiscerner.

Dettagli
Parametri
[in] aInstance
Un puntatore all'istanza OpenThread.
Restituisce
Un puntatore a Joiner Discerner o NULL se non è impostato alcun valore.

otJoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

Recupera l'ID joiner.

Se non è impostato un Discerner Joiner, l'ID Joiner rappresenta i primi 64 bit del risultato del calcolo di SHA-256 su IEEE EUI-64 assegnato in fabbrica. In caso contrario, l'ID Joiner viene calcolato dal valore di Joiner Discerner.

L'ID joiner viene utilizzato anche come indirizzo esteso IEEE 802.15.4 del dispositivo durante il processo di messa in servizio.

Dettagli
Parametri
[in] aInstance
Un puntatore all'istanza OpenThread.
Restituisce
Un puntatore all'ID joiner.

otJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

Ottieni lo stato del joiner.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
Lo stato del joiner.

otJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

Imposta il Discerner del joiner.

L'ID Joiner viene utilizzato per calcolare l'ID joiner durante il processo di Thread Commissioning. Per ulteriori informazioni, consulta otJoinerGetId.

Dettagli
Parametri
[in] aInstance
Un puntatore all'istanza OpenThread.
[in] aDiscerner
Un puntatore a un Joiner Discerner. Se NULL cancella qualsiasi discerner impostato in precedenza.
Valori restituiti
OT_ERROR_NONE
Joiner Discerner aggiornato.
OT_ERROR_INVALID_ARGS
aDiscerner non è valido (la lunghezza specificata non è compresa nell'intervallo valido).
OT_ERROR_INVALID_STATE
È in corso un processo di adesione, pertanto non è stato possibile modificare Joiner Discerner.

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
)

Abilita il ruolo Joiner thread.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aPskd
Un puntatore al PSKd.
[in] aProvisioningUrl
Un puntatore all'URL di provisioning (può essere NULL).
[in] aVendorName
Un puntatore al nome del fornitore (può essere NULL).
[in] aVendorModel
Un puntatore al modello del fornitore (può essere NULL).
[in] aVendorSwVersion
Un puntatore alla versione software del fornitore (può essere NULL).
[in] aVendorData
Un puntatore ai dati del fornitore (può essere NULL).
[in] aCallback
Un puntatore a una funzione che viene richiamata al completamento dell'operazione di join.
[in] aContext
Un puntatore al contesto specifico dell'applicazione.
Valori restituiti
OT_ERROR_NONE
Avvio del ruolo Joiner riuscito.
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 o lo stack Thread è completamente abilitato.

otJoinerStateToString

const char * otJoinerStateToString(
  otJoinerState aState
)

Converte un determinato valore di enumerazione dello stato del joiner in una stringa leggibile.

Dettagli
Parametri
[in] aState
Lo stato del joiner.
Restituisce
Una rappresentazione stringa leggibile di aState.

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

Disabilita il ruolo Joiner thread.

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

Macro

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

Lunghezza massima in bit di un Joiner Discerner.

Risorse

Gli argomenti di riferimento dell'API OpenThread provengono dal codice sorgente, disponibile su GitHub. Per saperne di più o per contribuire alla nostra documentazione, consulta la sezione Risorse.