Commissario
Questo modulo include funzioni per il ruolo di Thread Commissioner.
Sommario
Enumerazioni | |
---|---|
otCommissionerJoinerEvent | enum Questa enumerazione definisce un Joiner Event sul Commissario. |
otCommissionerState { | enum Questa enumerazione definisce lo Stato commissario. |
otJoinerInfoType { | enum Questa enumerazione definisce un Joiner Info Typer. |
Typedef | |
---|---|
otCommissionerEnergyReportCallback )(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) | typedefvoid(* Questo puntatore a funzione viene richiamato quando il Commissario riceve un rapporto energetico. |
otCommissionerJoinerCallback )(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) | typedefvoid(* Questo puntatore a funzione viene chiamato ogni volta che cambia lo stato del joiner. |
otCommissionerJoinerEvent | typedef Questa enumerazione definisce un Joiner Event sul Commissario. |
otCommissionerPanIdConflictCallback )(uint16_t aPanId, uint32_t aChannelMask, void *aContext) | typedefvoid(* Questo puntatore a funzione viene chiamato quando il Commissario riceve un messaggio di conflitto ID PAN. |
otCommissionerState | typedefenum otCommissionerState Questa enumerazione definisce lo Stato commissario. |
otCommissionerStateCallback )(otCommissionerState aState, void *aContext) | typedefvoid(* Questo puntatore a funzione viene chiamato ogni volta che cambia lo stato del commissario. |
otCommissioningDataset | typedefstruct otCommissioningDataset Questa struttura rappresenta un set di dati di messa in servizio. |
otJoinerInfo | typedefstruct otJoinerInfo Questa struttura rappresenta una Joiner Info. |
otJoinerInfoType | typedefenum otJoinerInfoType Questa enumerazione definisce un Joiner Info Typer. |
otJoinerPskd | typedefstruct otJoinerPskd Questa struttura rappresenta un Joiner PSKd. |
otSteeringData | typedefstruct otSteeringData Questa struttura rappresenta i dati di governo. |
Funzioni | |
---|---|
otCommissionerAddJoiner ( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout) | Questa funzione aggiunge una voce di falegname. |
otCommissionerAddJoinerWithDiscerner ( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout) | Questa funzione aggiunge una voce Joiner con un dato valore Joiner Discerner. |
otCommissionerAnnounceBegin ( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress) | Questa funzione invia un messaggio Announce Begin. |
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 di query di scansione energetica. |
otCommissionerGetNextJoinerInfo ( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner) | Questo metodo ottiene le informazioni del falegname nella posizione di aIterator. |
otCommissionerGetProvisioningUrl ( otInstance *aInstance) | const char * Questa funzione ottiene l'URL di provisioning. |
otCommissionerGetSessionId ( otInstance *aInstance) | uint16_t Questa funzione restituisce l'ID della sessione del Commissario. |
otCommissionerGetState ( otInstance *aInstance) | Questa funzione restituisce il Commissario di Stato. |
otCommissionerPanIdQuery ( otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext) | Questa funzione invia un messaggio di query ID PAN. |
otCommissionerRemoveJoiner ( otInstance *aInstance, const otExtAddress *aEui64) | Questa funzione rimuove una voce di Joiner. |
otCommissionerRemoveJoinerWithDiscerner ( otInstance *aInstance, const otJoinerDiscerner *aDiscerner) | Questa funzione rimuove una voce di 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. |
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. |
Structs | |
---|---|
otCommissioningDataset | Questa struttura rappresenta un set di dati di messa in servizio. |
otJoinerInfo | Questa struttura rappresenta una Joiner Info. |
otJoinerPskd | Questa struttura rappresenta un Joiner PSKd. |
otSteeringData | Questa struttura rappresenta i dati di governo. |
Enumerazioni
otCommissionerJoinerEvent
otCommissionerJoinerEvent
Questa enumerazione definisce un Joiner Event sul Commissario.
otCommissionerState
otCommissionerState
otJoinerInfoType
otJoinerInfoType
Questa enumerazione definisce un Joiner Info Typer.
Proprietà | |
---|---|
OT_JOINER_INFO_TYPE_ANY | Accetta qualsiasi Joiner (non è specificato alcun EUI64 o Discerner). |
OT_JOINER_INFO_TYPE_DISCERNER | Joiner Discerner è specificato ( |
OT_JOINER_INFO_TYPE_EUI64 | Joiner EUI-64 è specificato ( |
Typedef
otCommissionerEnergyReportCallback
void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
Questo puntatore a funzione viene richiamato quando il Commissario riceve un Rapporto Energetico.
Dettagli | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametri |
|
otCommissionerJoinerCallback
void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
Questo puntatore a funzione viene chiamato ogni volta che cambia lo stato del joiner.
Dettagli | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametri |
|
otCommissionerJoinerEvent
enum otCommissionerJoinerEvent otCommissionerJoinerEvent
Questa enumerazione definisce un Joiner Event sul Commissario.
otCommissionerPanIdConflictCallback
void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
Questo puntatore a funzione viene chiamato quando il Commissario riceve un messaggio di conflitto ID PAN.
Dettagli | |||||||
---|---|---|---|---|---|---|---|
Parametri |
|
otCommissionerState
enum otCommissionerState otCommissionerState
Questa enumerazione definisce lo Stato commissario.
otCommissionerStateCallback
void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
Questo puntatore a funzione viene chiamato ogni volta che cambia lo stato del commissario.
Dettagli | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametri |
|
otCommissioningDataset
struct otCommissioningDataset otCommissioningDataset
Questa struttura rappresenta un set di dati di messa in servizio.
otJoinerInfoType
enum otJoinerInfoType otJoinerInfoType
Questa enumerazione definisce un Joiner Info Typer.
Funzioni
otCommissionerAddJoiner
otError otCommissionerAddJoiner( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout )
Questa funzione aggiunge una voce di falegname.
Dettagli | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametri |
| ||||||||
Valori restituiti |
|
otCommissionerAddJoinerWithDiscerner
otError otCommissionerAddJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout )
Questa funzione aggiunge una voce Joiner con un dato valore Joiner Discerner.
Dettagli | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametri |
| ||||||||
Valori restituiti |
|
otCommissionerAnnounceBegin
otError otCommissionerAnnounceBegin( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress )
Questa funzione invia un messaggio Announce Begin.
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 )
Questa funzione invia un messaggio di query di scansione energetica.
Dettagli | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parametri |
| ||||||||||||||||
Valori restituiti |
|
otCommissionerGetNextJoinerInfo
otError otCommissionerGetNextJoinerInfo( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner )
Questo metodo ottiene informazioni sul falegname alla posizione di aIterator.
Dettagli | |||||||
---|---|---|---|---|---|---|---|
Parametri |
| ||||||
Valori restituiti |
|
otCommissionerGetProvisioningUrl
const char * otCommissionerGetProvisioningUrl( otInstance *aInstance )
Questa funzione ottiene l'URL di provisioning.
Dettagli | |||
---|---|---|---|
Parametri |
| ||
ritorna | Un puntatore alla stringa dell'URL. |
otCommissionerGetSessionId
uint16_t otCommissionerGetSessionId( otInstance *aInstance )
Questa funzione restituisce l'ID della sessione del Commissario.
Dettagli | |||
---|---|---|---|
Parametri |
| ||
ritorna | L'ID della sessione del commissario corrente. |
otCommissionerGetState
otCommissionerState otCommissionerGetState( otInstance *aInstance )
Questa funzione restituisce il Commissario di Stato.
Dettagli | |||||||
---|---|---|---|---|---|---|---|
Parametri |
| ||||||
Valori restituiti |
|
otCommissionerPanIdQuery
otError otCommissionerPanIdQuery( otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext )
Questa funzione invia un messaggio di query ID PAN.
Dettagli | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parametri |
| ||||||||||||
Valori restituiti |
|
otCommissionerRemoveJoiner
otError otCommissionerRemoveJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
Questa funzione rimuove una voce di Joiner.
Dettagli | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametri |
| ||||||||
Valori restituiti |
|
otCommissionerRemoveJoinerWithDiscerner
otError otCommissionerRemoveJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner )
Questa funzione rimuove una voce di Joiner.
Dettagli | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametri |
| ||||||||
Valori restituiti |
|
otCommissionerSendMgmtGet
otError otCommissionerSendMgmtGet( otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength )
Questa funzione invia MGMT_COMMISSIONER_GET.
Dettagli | |||||||
---|---|---|---|---|---|---|---|
Parametri |
| ||||||
Valori restituiti |
|
otCommissionerSendMgmtSet
otError otCommissionerSendMgmtSet( otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength )
Questa funzione invia MGMT_COMMISSIONER_SET.
Dettagli | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametri |
| ||||||||
Valori restituiti |
|
otCommissionerSetProvisioningUrl
otError otCommissionerSetProvisioningUrl( otInstance *aInstance, const char *aProvisioningUrl )
Questa funzione imposta l'URL di provisioning.
Dettagli | |||||
---|---|---|---|---|---|
Parametri |
| ||||
Valori restituiti |
|
otCommissionerStart
otError otCommissionerStart( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext )
Questa funzione abilita il ruolo di Thread Commissioner.
Dettagli | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametri |
| ||||||||
Valori restituiti |
|
otCommissionerStop
otError otCommissionerStop( otInstance *aInstance )
Questa funzione disabilita il ruolo di Thread Commissioner.
Dettagli | |||||
---|---|---|---|---|---|
Parametri |
| ||||
Valori restituiti |
|
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 di un Joiner PSKd (non include il carattere nullo).
OT_PROVISIONING_URL_MAX_SIZE
OT_PROVISIONING_URL_MAX_SIZE 64
Dimensione massima (numero di caratteri) nella stringa URL di provisioning (esclude carattere nullo).
OT_STEERING_DATA_MAX_LENGTH
OT_STEERING_DATA_MAX_LENGTH 16
Lunghezza massima dei dati di governo (byte)