Commissario
Questo modulo include funzioni per il ruolo Thread Commissioner.
Riepilogo
Enumerazioni |
|
---|---|
otCommissionerJoinerEvent
|
enum Definisce un evento Joiner sul commissionatore. |
otCommissionerState{
|
enum Definisce lo stato del commissario. |
otJoinerInfoType{
|
enum Definisce un tipo di informazioni per falegname. |
Definizione di tipo |
|
---|---|
otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
|
typedefvoid(*
Il puntatore viene chiamato quando il Commissario riceve un Report sull'energia. |
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
|
typedefvoid(*
Il puntatore viene chiamato ogni volta che lo stato del joiner cambia. |
otCommissionerJoinerEvent
|
typedef Definisce un evento Joiner sul commissionatore. |
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
|
typedefvoid(*
Il puntatore viene chiamato quando il Commissario riceve un messaggio PAN ID in conflitto. |
otCommissionerState
|
typedefenum otCommissionerState
Definisce lo stato del commissario. |
otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
|
typedefvoid(*
Il puntatore viene chiamato ogni volta che lo stato del commissario cambia. |
otCommissioningDataset
|
typedefstruct otCommissioningDataset
Rappresenta un set di dati per la commissione. |
otJoinerInfo
|
typedefstruct otJoinerInfo
Rappresenta un'informazione Joiner. |
otJoinerInfoType
|
typedefenum otJoinerInfoType
Definisce un tipo di informazioni per falegname. |
otJoinerPskd
|
typedefstruct otJoinerPskd
Rappresenta un file di join PSKd. |
otSteeringData
|
typedefstruct otSteeringData
Rappresentano i dati dello sterzo. |
Funzioni |
|
---|---|
otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
|
Aggiunge una voce Joiner.
|
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
|
Aggiunge una voce Joiner con un determinato valore Joiner Discerner.
|
otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
|
Invia un messaggio di annuncio dell'inizio.
|
otCommissionerEnergyScan(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
|
Invia un messaggio Query sull'energia.
|
otCommissionerGetId(otInstance *aInstance)
|
const char *
Restituisce l'ID commissario.
|
otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
|
Ottieni informazioni su Joiner in una posizione dell'terzatore.
|
otCommissionerGetProvisioningUrl(otInstance *aInstance)
|
const char *
Visualizza l'URL di provisioning.
|
otCommissionerGetSessionId(otInstance *aInstance)
|
uint16_t
Restituisce l'ID sessione del commissario.
|
otCommissionerGetState(otInstance *aInstance)
|
Restituisce lo stato del commissario.
|
otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
|
Invia un messaggio di query ID PAN.
|
otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64)
|
Rimuove una voce Joiner.
|
otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
|
Rimuove una voce Joiner.
|
otCommissionerSendMgmtGet(otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
|
Invia MGMT_COMMISSIONER_GET.
|
otCommissionerSendMgmtSet(otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
|
Invia MGMT_COMMISSIONER_SET.
|
otCommissionerSetId(otInstance *aInstance, const char *aId)
|
Imposta l'ID Commissioner.
|
otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl)
|
Imposta l'URL di provisioning.
|
otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
|
Attiva il ruolo Thread Commissioner.
|
otCommissionerStop(otInstance *aInstance)
|
Consente di disattivare il ruolo Thread Commissioner.
|
Strutture |
|
---|---|
otCommissioningDataset |
Rappresenta un set di dati per la commissione. |
Informazioni su otjoiner |
Rappresenta un'informazione Joiner. |
otjoinerPskd |
Rappresenta un file di join PSKd. |
otSteeringData |
Rappresentano i dati dello sterzo. |
Enumerazioni
OtCommissionerjoinerEvent
otCommissionerJoinerEvent
Definisce un evento Joiner sul commissionatore.
OtCommissionerState
otCommissionerState
Definisce lo stato del commissario.
Proprietà | |
---|---|
OT_COMMISSIONER_STATE_ACTIVE
|
Il ruolo di commissario è attivo. |
OT_COMMISSIONER_STATE_DISABLED
|
Il ruolo di commissario è disattivato. |
OT_COMMISSIONER_STATE_PETITION
|
Attualmente invii una gara per diventare Commissario. |
InfoType otjoiner
otJoinerInfoType
Definisce un tipo di informazioni per falegname.
Proprietà | |
---|---|
OT_JOINER_INFO_TYPE_ANY
|
Accetta qualsiasi falegname (non è specificato alcun EUI64 o Discerner). |
OT_JOINER_INFO_TYPE_DISCERNER
|
La fresatrice con giunto è specificata ( |
OT_JOINER_INFO_TYPE_EUI64
|
Il joiner EUI-64 è specificato ( |
Definizione di tipo
OtCommissionerEnergyReportCallback
void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
Il puntatore viene chiamato quando il Commissario riceve un Report sull'energia.
Dettagli | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametri |
|
OtCommissionerjoinerCallback
void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
Il puntatore viene chiamato ogni volta che lo stato del joiner cambia.
Dettagli | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametri |
|
OtCommissionerjoinerEvent
enum otCommissionerJoinerEvent otCommissionerJoinerEvent
Definisce un evento Joiner sul commissionatore.
OtCommissionerPanIdConflittoChiamata
void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
Il puntatore viene chiamato quando il Commissario riceve un messaggio PAN ID in conflitto.
Dettagli | |||||||
---|---|---|---|---|---|---|---|
Parametri |
|
OtCommissionerState
enum otCommissionerState otCommissionerState
Definisce lo stato del commissario.
OtCommissionerStateCallback
void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
Il puntatore viene chiamato ogni volta che lo stato del commissario cambia.
Dettagli | |||||
---|---|---|---|---|---|
Parametri |
|
Set di dati commissioni
struct otCommissioningDataset otCommissioningDataset
Rappresenta un set di dati per la commissione.
InfoType otjoiner
enum otJoinerInfoType otJoinerInfoType
Definisce un tipo di informazioni per falegname.
Funzioni
OtCommissioner Aggiungi Joiner
otError otCommissionerAddJoiner( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout )
Aggiunge una voce Joiner.
Dettagli | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametri |
|
||||||||
Valori restituiti |
|
OtCommissionerAddjoinerWithDiscerner
otError otCommissionerAddJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout )
Aggiunge una voce Joiner con un determinato valore Joiner Discerner.
Dettagli | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametri |
|
||||||||
Valori restituiti |
|
OtCommissionerAnnounceStart
otError otCommissionerAnnounceBegin( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress )
Invia un messaggio di annuncio dell'inizio.
Dettagli | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parametri |
|
||||||||||
Valori restituiti |
|
OtCommissionerEnergyScan
otError otCommissionerEnergyScan( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext )
Invia un messaggio Query sull'energia.
Dettagli | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parametri |
|
||||||||||||||||
Valori restituiti |
|
ID OtCommissioner
const char * otCommissionerGetId( otInstance *aInstance )
Restituisce l'ID commissario.
Dettagli | |||
---|---|---|---|
Parametri |
|
||
Restituisce |
ID Commissioner.
|
otCommissionerGetNextjoinerInfo
otError otCommissionerGetNextJoinerInfo( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner )
Ottieni informazioni su Joiner in una posizione dell'terzatore.
Dettagli | |||||||
---|---|---|---|---|---|---|---|
Parametri |
|
||||||
Valori restituiti |
|
OtCommissionerGetProvisionUrl
const char * otCommissionerGetProvisioningUrl( otInstance *aInstance )
Visualizza l'URL di provisioning.
Dettagli | |||
---|---|---|---|
Parametri |
|
||
Restituisce |
Un puntatore alla stringa dell'URL.
|
ID sessione otCommissioner
uint16_t otCommissionerGetSessionId( otInstance *aInstance )
Restituisce l'ID sessione del commissario.
Dettagli | |||
---|---|---|---|
Parametri |
|
||
Restituisce |
L'ID sessione della commissione attuale.
|
OtCommissionerGetState
otCommissionerState otCommissionerGetState( otInstance *aInstance )
Restituisce lo stato del commissario.
Dettagli | |||||||
---|---|---|---|---|---|---|---|
Parametri |
|
||||||
Valori restituiti |
|
Query Query oT Commissioner
otError otCommissionerPanIdQuery( otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext )
Invia un messaggio di query ID PAN.
Dettagli | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parametri |
|
||||||||||||
Valori restituiti |
|
OtCommissionerRimuovi Joiner
otError otCommissionerRemoveJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
Rimuove una voce Joiner.
Dettagli | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametri |
|
||||||||
Valori restituiti |
|
OtCommissionerRemovejoinerWithDiscerner
otError otCommissionerRemoveJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner )
Rimuove una voce Joiner.
Dettagli | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametri |
|
||||||||
Valori restituiti |
|
OtCommissionerSendMgmtGet
otError otCommissionerSendMgmtGet( otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength )
Invia MGMT_COMMISSIONER_GET.
Dettagli | |||||||
---|---|---|---|---|---|---|---|
Parametri |
|
||||||
Valori restituiti |
|
OtCommissionerSendMgmtSet
otError otCommissionerSendMgmtSet( otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength )
Invia MGMT_COMMISSIONER_SET.
Dettagli | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametri |
|
||||||||
Valori restituiti |
|
ID commissione OtCommissioner
otError otCommissionerSetId( otInstance *aInstance, const char *aId )
Imposta l'ID Commissioner.
Dettagli | |||||||
---|---|---|---|---|---|---|---|
Parametri |
|
||||||
Valori restituiti |
|
OtCommissionerSetProvisioningUrl
otError otCommissionerSetProvisioningUrl( otInstance *aInstance, const char *aProvisioningUrl )
Imposta l'URL di provisioning.
Dettagli | |||||
---|---|---|---|---|---|
Parametri |
|
||||
Valori restituiti |
|
OtCommissionerStart
otError otCommissionerStart( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext )
Attiva il ruolo Thread Commissioner.
Dettagli | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametri |
|
||||||||
Valori restituiti |
|
OtCommissionerStop
otError otCommissionerStop( otInstance *aInstance )
Consente di disattivare il ruolo Thread Commissioner.
Dettagli | |||||
---|---|---|---|---|---|
Parametri |
|
||||
Valori restituiti |
|
Macro
OT_COMMISSIONING_PASSPHRASE_MAX_SIZE
OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255
Dimensione massima della passphrase di commissione.
OT_COMMISSIONING_PASSPHRASE_MIN_SIZE
OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6
Dimensione minima della passphrase di commissione.
OT_JOINER_MAX_PSKD_LENGTH
OT_JOINER_MAX_PSKD_LENGTH 32
Lunghezza massima della stringa di un joiner PSKd (non include char null).
OT_PROVISIONING_URL_MAX_SIZE
OT_PROVISIONING_URL_MAX_SIZE 64
Dimensione massima (numero di caratteri) nella stringa dell'URL di provisioning (escluso il carattere null).
DATI_MAX_STEERING_MAX_LENGTH
OT_STEERING_DATA_MAX_LENGTH 16
Lunghezza massima dei dati di guida (byte)
Risorse
Gli argomenti di riferimento per l'API OpenThread provengono dal codice sorgente, disponibile su GitHub. Per maggiori informazioni o per contribuire alla nostra documentazione, consulta Risorse.