Commissario

Questo modulo include funzioni per il ruolo di Thread Commissioner.

Riepilogo

Enumerazioni

otCommissionerJoinerEvent enum
Questa enumerazione definisce un evento Joiner sul Commissioner.
otCommissionerState{
  OT_COMMISSIONER_STATE_DISABLED = 0,
  OT_COMMISSIONER_STATE_PETITION = 1,
  OT_COMMISSIONER_STATE_ACTIVE = 2
}
enum
Questa enumerazione definisce lo stato della commissione.
otJoinerInfoType{
  OT_JOINER_INFO_TYPE_ANY = 0,
  OT_JOINER_INFO_TYPE_EUI64 = 1,
  OT_JOINER_INFO_TYPE_DISCERNER = 2
}
enum
Questa enumerazione definisce un tipo di informazioni Joiner.

Defdef

otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) tipodef
void(*
Il puntatore di questa funzione viene chiamato quando il Commissioner riceve un Report sull'energia.
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) tipodef
void(*
Il puntatore di questa funzione viene chiamato ogni volta che lo stato del joiner cambia.
otCommissionerJoinerEvent tipodef
Questa enumerazione definisce un evento Joiner sul Commissioner.
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext) tipodef
void(*
Il puntatore di questa funzione viene chiamato quando il Commissioner riceve un messaggio PAN ID in conflitto.
otCommissionerState tipodef
Questa enumerazione definisce lo stato della commissione.
otCommissionerStateCallback)(otCommissionerState aState, void *aContext) tipodef
void(*
Il puntatore di questa funzione viene richiamato ogni volta che lo stato del commissionere cambia.
otCommissioningDataset tipodef
Questa struttura rappresenta un set di dati Commissioning.
otJoinerInfo tipodef
struct otJoinerInfo
Questa struttura rappresenta un'informazione Joiner.
otJoinerInfoType tipodef
Questa enumerazione definisce un tipo di informazioni Joiner.
otJoinerPskd tipodef
struct otJoinerPskd
Questa struttura rappresenta una Joiner PSKd.
otSteeringData tipodef
Questa struttura rappresenta i dati di guida.

Functions

otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
Questa funzione aggiunge una voce Joiner.
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
Questa funzione aggiunge una voce Joiner con un determinato valore Discerner.
otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
Questa funzione invia un messaggio di annuncio inizio.
otCommissionerEnergyScan(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
Questa funzione invia un messaggio Query sull'energia.
otCommissionerGetId(otInstance *aInstance)
const char *
Questa funzione restituisce l'ID Commissioner.
otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
Questo metodo consente di ottenere informazioni sul joiner dalla posizione di un attestatore.
otCommissionerGetProvisioningUrl(otInstance *aInstance)
const char *
Questa funzione riceve l'URL di provisioning.
otCommissionerGetSessionId(otInstance *aInstance)
uint16_t
Questa funzione restituisce l'ID sessione Commissioner.
otCommissionerGetState(otInstance *aInstance)
Questa funzione restituisce lo stato del commissario.
otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
Questa funzione invia un messaggio Query ID PAN.
otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64)
Questa funzione rimuove una voce Joiner.
otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
Questa funzione rimuove una voce Joiner.
otCommissionerSendMgmtGet(otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
Questa funzione invia MGMT_COMMISSIONER_GET.
otCommissionerSendMgmtSet(otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
Questa funzione invia MGMT_COMMISSIONER_SET.
otCommissionerSetId(otInstance *aInstance, const char *aId)
Questa funzione imposta l'ID Commissioner.
otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl)
Questa funzione imposta l'URL di provisioning.
otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
Questa funzione abilita il ruolo di Thread Commissioner.
otCommissionerStop(otInstance *aInstance)
Questa funzione disabilita il ruolo di Thread Commissioner.

Strutture

Set di dati commissioni Commissione

Questa struttura rappresenta un set di dati Commissioning.

Informazioni otjoiner

Questa struttura rappresenta un'informazione Joiner.

otjoinerPskd

Questa struttura rappresenta una Joiner PSKd.

Dati otSteering

Questa struttura rappresenta i dati di guida.

Enumerazioni

OtCommissionerjoinerEvent

 otCommissionerJoinerEvent

Questa enumerazione definisce un evento Joiner sul Commissioner.

OtCommissionerState

 otCommissionerState

Questa enumerazione definisce lo stato della commissione.

Proprietà
OT_COMMISSIONER_STATE_ACTIVE

Il ruolo di commissario è attivo.

OT_COMMISSIONER_STATE_DISABLED

Il ruolo di commissionere è disattivato.

OT_COMMISSIONER_STATE_PETITION

Al momento petizioni per diventare commissario.

OtjoinerInfoType

 otJoinerInfoType

Questa enumerazione definisce un tipo di informazioni Joiner.

Proprietà
OT_JOINER_INFO_TYPE_ANY

Accetta qualsiasi falegname (non è specificato alcun codice EUI64 o Discerner).

OT_JOINER_INFO_TYPE_DISCERNER

L'autore della joiner è specificato (mSharedId.mDiscerner in otJoinerInfo).

OT_JOINER_INFO_TYPE_EUI64

La joiner EUI-64 è specificata (mSharedId.mEui64 in otJoinerInfo).

Defdef

otCommissionerEnergyReportCallback

void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)

Il puntatore di questa funzione viene chiamato quando il Commissioner riceve un Report sull'energia.

Dettagli
Parametri
[in] aChannelMask
Il valore della maschera del canale.
[in] aEnergyList
Un puntatore sull'elenco della misurazione dell'energia.
[in] aEnergyListLength
Numero di voci in aEnergyListLength.
[in] aContext
Un puntatore sul contesto specifico dell'applicazione.

otCommissionerjoinerCallback

void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)

Il puntatore di questa funzione viene chiamato ogni volta che lo stato del joiner cambia.

Dettagli
Parametri
[in] aEvent
Il tipo di evento di joiner.
[in] aJoinerInfo
Un puntatore su Informazioni per Joiner.
[in] aJoinerId
Un puntatore sull'ID Joiner (se non noto, sarà NULL).
[in] aContext
Un puntatore sul contesto specifico dell'applicazione.

OtCommissionerjoinerEvent

enum otCommissionerJoinerEvent otCommissionerJoinerEvent

Questa enumerazione definisce un evento Joiner sul Commissioner.

otCommissionerPanId conflittoCallback

void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)

Il puntatore di questa funzione viene chiamato quando il Commissioner riceve un messaggio PAN ID in conflitto.

Dettagli
Parametri
[in] aPanId
Il valore ID PAN.
[in] aChannelMask
Il valore della maschera del canale.
[in] aContext
Un puntatore sul contesto specifico dell'applicazione.

OtCommissionerState

enum otCommissionerState otCommissionerState

Questa enumerazione definisce lo stato della commissione.

OtCommissionerStateCallback

void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)

Il puntatore di questa funzione viene richiamato ogni volta che lo stato del commissionere cambia.

Dettagli
Parametri
[in] aState
Lo stato del commissario.
[in] aContext
Un puntatore sul contesto specifico dell'applicazione.

DataSet otCommissioning

struct otCommissioningDataset otCommissioningDataset

Questa struttura rappresenta un set di dati Commissioning.

Informazioni otjoiner

struct otJoinerInfo otJoinerInfo

Questa struttura rappresenta un'informazione Joiner.

OtjoinerInfoType

enum otJoinerInfoType otJoinerInfoType

Questa enumerazione definisce un tipo di informazioni Joiner.

OtjoinerPskd

struct otJoinerPskd otJoinerPskd

Questa struttura rappresenta una Joiner PSKd.

Dati OtSteering

struct otSteeringData otSteeringData

Questa struttura rappresenta i dati di guida.

Functions

otCommissionerAddjoiner

otError otCommissionerAddJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64,
  const char *aPskd,
  uint32_t aTimeout
)

Questa funzione aggiunge una voce Joiner.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aEui64
Un puntatore allo IEEE EUI-64 o NULL di Joiner.
[in] aPskd
Un puntatore sulla PSKd.
[in] aTimeout
Il periodo di tempo trascorso il quale, automaticamente, un utente viene rimosso automaticamente, in secondi.
Valori di ritorno
OT_ERROR_NONE
Aggiunta di Joiner riuscita.
OT_ERROR_NO_BUFS
Nessun buffer disponibile per aggiungere la joiner.
OT_ERROR_INVALID_ARGS
Il campo aEui64 o aPskd non è valido.
OT_ERROR_INVALID_STATE
Il commissario non è attivo.

otCommissionerAddjoinerWithDiscerner

otError otCommissionerAddJoinerWithDiscerner(
  otInstance *aInstance,
  const otJoinerDiscerner *aDiscerner,
  const char *aPskd,
  uint32_t aTimeout
)

Questa funzione aggiunge una voce Joiner con un determinato valore Discerner.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aDiscerner
Un puntatore su Joiner Discerner.
[in] aPskd
Un puntatore sulla PSKd.
[in] aTimeout
Il periodo di tempo trascorso il quale, automaticamente, un utente viene rimosso automaticamente, in secondi.
Valori di ritorno
OT_ERROR_NONE
Aggiunta di Joiner riuscita.
OT_ERROR_NO_BUFS
Nessun buffer disponibile per aggiungere la joiner.
OT_ERROR_INVALID_ARGS
Il campo aDiscerner o aPskd non è valido.
OT_ERROR_INVALID_STATE
Il commissario non è attivo.

otCommissionerAnnounceStart

otError otCommissionerAnnounceBegin(
  otInstance *aInstance,
  uint32_t aChannelMask,
  uint8_t aCount,
  uint16_t aPeriod,
  const otIp6Address *aAddress
)

Questa funzione invia un messaggio di annuncio inizio.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aChannelMask
Il valore della maschera del canale.
[in] aCount
Il numero di messaggi di annuncio per canale.
[in] aPeriod
Il tempo che intercorre tra due trasmissioni MLE Announce successive (in millisecondi).
[in] aAddress
Un puntatore sulla destinazione IPv6.
Valori di ritorno
OT_ERROR_NONE
La coda dell'annuncio inizia ad accordarsi.
OT_ERROR_NO_BUFS
Buffer insufficienti per generare un messaggio Announce Begin.
OT_ERROR_INVALID_STATE
Il commissario non è attivo.

OtCommissionerEnergyScan

otError otCommissionerEnergyScan(
  otInstance *aInstance,
  uint32_t aChannelMask,
  uint8_t aCount,
  uint16_t aPeriod,
  uint16_t aScanDuration,
  const otIp6Address *aAddress,
  otCommissionerEnergyReportCallback aCallback,
  void *aContext
)

Questa funzione invia un messaggio Query sull'energia.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aChannelMask
Il valore della maschera del canale.
[in] aCount
Il numero di misurazioni dell'energia per canale.
[in] aPeriod
Tempo tra le misurazioni dell'energia (millisecondi).
[in] aScanDuration
La durata della scansione di ogni misurazione dell'energia (millisecondi).
[in] aAddress
Un puntatore sulla destinazione IPv6.
[in] aCallback
Un puntatore su una funzione chiamata in seguito alla ricezione di un messaggio del report sull'energia.
[in] aContext
Un puntatore sul contesto specifico dell'applicazione.
Valori di ritorno
OT_ERROR_NONE
Il messaggio Query sulla scansione energetica è stato accodato.
OT_ERROR_NO_BUFS
Buffer insufficienti per generare un messaggio Query sull'energia.
OT_ERROR_INVALID_STATE
Il commissario non è attivo.

OtCommissionerGetId

const char * otCommissionerGetId(
  otInstance *aInstance
)

Questa funzione restituisce l'ID Commissioner.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
L'ID del commissario.

otCommissionerGetNextjoinerInfo

otError otCommissionerGetNextJoinerInfo(
  otInstance *aInstance,
  uint16_t *aIterator,
  otJoinerInfo *aJoiner
)

Questo metodo consente di ottenere informazioni sul joiner dalla posizione di un attestatore.

Dettagli
Parametri
[in] aInstance
Un puntatore sull'istanza.
[in,out] aIterator
Un puntatore sul contesto dell'iteratore delle informazioni su Joiner.
[out] aJoiner
Un riferimento alle informazioni per Joiner.
Valori di ritorno
OT_ERROR_NONE
Recupero delle informazioni su Joiner riuscito.
OT_ERROR_NOT_FOUND
Brano non trovato.

OtCommissionerGetProvisioningUrl

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

Questa funzione riceve l'URL di provisioning.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Un puntatore sulla stringa dell'URL.

ID OtCommissionerGetSession

uint16_t otCommissionerGetSessionId(
  otInstance *aInstance
)

Questa funzione restituisce l'ID sessione Commissioner.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
ID sessione della commissione corrente.

OtCommissionerGetState

otCommissionerState otCommissionerGetState(
  otInstance *aInstance
)

Questa funzione restituisce lo stato del commissario.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Valori di ritorno
OT_COMMISSIONER_STATE_DISABLED
Commissioner disabilitato.
OT_COMMISSIONER_STATE_PETITION
Diventare il commissario.
OT_COMMISSIONER_STATE_ACTIVE
Commissioner attivato.

otCommissionerPanIdQuery

otError otCommissionerPanIdQuery(
  otInstance *aInstance,
  uint16_t aPanId,
  uint32_t aChannelMask,
  const otIp6Address *aAddress,
  otCommissionerPanIdConflictCallback aCallback,
  void *aContext
)

Questa funzione invia un messaggio Query ID PAN.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aPanId
L'ID PAN su cui eseguire la query.
[in] aChannelMask
Il valore della maschera del canale.
[in] aAddress
Un puntatore sulla destinazione IPv6.
[in] aCallback
Un puntatore a una funzione chiamata in seguito alla ricezione di un messaggio Conflitto ID PAN.
[in] aContext
Un puntatore sul contesto specifico dell'applicazione.
Valori di ritorno
OT_ERROR_NONE
Il messaggio Query ID PAN è stato accodato correttamente.
OT_ERROR_NO_BUFS
Buffer insufficienti per generare un messaggio Query ID PAN.
OT_ERROR_INVALID_STATE
Il commissario non è attivo.

OtCommissionerRemovejoiner

otError otCommissionerRemoveJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64
)

Questa funzione rimuove una voce Joiner.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aEui64
Un puntatore allo IEEE EUI-64 o NULL di Joiner.
Valori di ritorno
OT_ERROR_NONE
Rimozione del join.
OT_ERROR_NOT_FOUND
Impossibile trovare il joiner specificato da aEui64.
OT_ERROR_INVALID_ARGS
Il campo aEui64 non è valido.
OT_ERROR_INVALID_STATE
Il commissario non è attivo.

otCommissionerRimuoviRemoveerWithDiscerner

otError otCommissionerRemoveJoinerWithDiscerner(
  otInstance *aInstance,
  const otJoinerDiscerner *aDiscerner
)

Questa funzione rimuove una voce Joiner.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aDiscerner
Un puntatore su Joiner Discerner.
Valori di ritorno
OT_ERROR_NONE
Rimozione del join.
OT_ERROR_NOT_FOUND
Impossibile trovare il joiner specificato da aEui64.
OT_ERROR_INVALID_ARGS
Il campo aDiscerner non è valido.
OT_ERROR_INVALID_STATE
Il commissario non è attivo.

OtCommissionerSendMgmtGet

otError otCommissionerSendMgmtGet(
  otInstance *aInstance,
  const uint8_t *aTlvs,
  uint8_t aLength
)

Questa funzione invia MGMT_COMMISSIONER_GET.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aTlvs
Un puntatore sui TLV.
[in] aLength
La lunghezza dei TLV.
Valori di ritorno
OT_ERROR_NONE
Il comando del set di dati meshcop è stato inviato.
OT_ERROR_NO_BUFS
Spazio di buffer insufficiente da inviare.
OT_ERROR_INVALID_STATE
Il commissario non è attivo.

OtCommissionerSendMgmtSet

otError otCommissionerSendMgmtSet(
  otInstance *aInstance,
  const otCommissioningDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength
)

Questa funzione invia MGMT_COMMISSIONER_SET.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aDataset
Un puntatore sulla messa in servizio del set di dati.
[in] aTlvs
Un puntatore sui TLV.
[in] aLength
La lunghezza dei TLV.
Valori di ritorno
OT_ERROR_NONE
Il comando del set di dati meshcop è stato inviato.
OT_ERROR_NO_BUFS
Spazio di buffer insufficiente da inviare.
OT_ERROR_INVALID_STATE
Il commissario non è attivo.

ID OtCommissionerSet

otError otCommissionerSetId(
  otInstance *aInstance,
  const char *aId
)

Questa funzione imposta l'ID Commissioner.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aId
Un puntatore su un array di caratteri della stringa. Deve essere null e chiuso.
Valori di ritorno
OT_ERROR_NONE
L'ID Commissioner è stato impostato correttamente.
OT_ERROR_INVALID_ARGS
Il nome specificato è troppo lungo.
OT_ERROR_INVALID_STATE
Il Commissioner è attivo e l'ID non può essere modificato.

OtCommissionerSetProvisioningUrl

otError otCommissionerSetProvisioningUrl(
  otInstance *aInstance,
  const char *aProvisioningUrl
)

Questa funzione imposta l'URL di provisioning.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aProvisioningUrl
Un puntatore all'URL di provisioning (potrebbe essere NULL da impostare come stringa vuota).
Valori di ritorno
OT_ERROR_NONE
Impostazione dell'URL di provisioning riuscita.
OT_ERROR_INVALID_ARGS
aProvisioningUrl non è un valore valido (troppo lungo).

OtCommissionerStart

otError otCommissionerStart(
  otInstance *aInstance,
  otCommissionerStateCallback aStateCallback,
  otCommissionerJoinerCallback aJoinerCallback,
  void *aCallbackContext
)

Questa funzione abilita il ruolo di Thread Commissioner.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aStateCallback
Un puntatore a una funzione che viene chiamata quando cambia lo stato del commissionere.
[in] aJoinerCallback
Si verifica un puntatore a una funzione che viene chiamata con un evento joiner.
[in] aCallbackContext
Un puntatore sul contesto specifico dell'applicazione.
Valori di ritorno
OT_ERROR_NONE
Avvio del servizio Commissioner riuscito.
OT_ERROR_ALREADY
Il commissario è già iniziato.
OT_ERROR_INVALID_STATE
Il dispositivo non è attualmente collegato a una rete.

OtCommissionerStop

otError otCommissionerStop(
  otInstance *aInstance
)

Questa funzione disabilita il ruolo di Thread Commissioner.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Valori di ritorno
OT_ERROR_NONE
Interruzione del servizio Commissioner.
OT_ERROR_ALREADY
Il commissario è già stato interrotto.

Macro

OT_COMMISSIONING_PASSPHRASE_MAX_SIZE

 OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255

Dimensione massima della passphrase di messa in servizio.

OT_COMMISSIONING_PASSPHRASE_MIN_SIZE

 OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6

Dimensione minima della passphrase di messa in servizio.

OT_JOINER_MAX_PSKD_LENGTH

 OT_JOINER_MAX_PSKD_LENGTH 32

Lunghezza massima della stringa in PSKd di joiner (non include il carattere null).

OT_PROVISIONING_URL_MAX_SIZE

 OT_PROVISIONING_URL_MAX_SIZE 64

Dimensioni massime (numero di caratteri) nella stringa URL di provisioning (escluso il carattere null).

OT_STEERING_DATA_MAX_LENGTH

 OT_STEERING_DATA_MAX_LENGTH 16

Durata massima dei dati di sterzo (byte)

Risorse

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