Google is committed to advancing racial equity for Black communities. See how.
Questa pagina è stata tradotta dall'API Cloud Translation.
Switch to English

Commissario

Questo modulo include funzioni per il ruolo di Thread Commissioner.

Sommario

Enumerazioni

otCommissionerJoinerEvent enum
Questa enumerazione definisce un Joiner Event sul Commissario.
otCommissionerState {
OT_COMMISSIONER_STATE_DISABLED = 0,
OT_COMMISSIONER_STATE_PETITION = 1,
OT_COMMISSIONER_STATE_ACTIVE = 2
}
enum
Questa enumerazione definisce lo Stato commissario.
otJoinerInfoType {
OT_JOINER_INFO_TYPE_ANY = 0,
OT_JOINER_INFO_TYPE_EUI64 = 1,
OT_JOINER_INFO_TYPE_DISCERNER = 2
}
enum
Questa enumerazione definisce un Joiner Info Typer.

Typedef

otCommissionerEnergyReportCallback )(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) typedef
void(*
Questo puntatore a funzione viene richiamato quando il Commissario riceve un rapporto energetico.
otCommissionerJoinerCallback )(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) typedef
void(*
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) typedef
void(*
Questo puntatore a funzione viene chiamato quando il Commissario riceve un messaggio di conflitto ID PAN.
otCommissionerState typedef
Questa enumerazione definisce lo Stato commissario.
otCommissionerStateCallback )(otCommissionerState aState, void *aContext) typedef
void(*
Questo puntatore a funzione viene chiamato ogni volta che cambia lo stato del commissario.
otCommissioningDataset typedef
Questa struttura rappresenta un set di dati di messa in servizio.
otJoinerInfo typedef
struct otJoinerInfo
Questa struttura rappresenta una Joiner Info.
otJoinerInfoType typedef
Questa enumerazione definisce un Joiner Info Typer.
otJoinerPskd typedef
struct otJoinerPskd
Questa struttura rappresenta un Joiner PSKd.
otSteeringData typedef
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

Questa enumerazione definisce lo Stato commissario.

Proprietà
OT_COMMISSIONER_STATE_ACTIVE

Il ruolo di Commissario è attivo.

OT_COMMISSIONER_STATE_DISABLED

Il ruolo di commissario è disabilitato.

OT_COMMISSIONER_STATE_PETITION

Attualmente presenta una petizione per diventare Commissario.

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 ( mSharedId.mDiscerner in otJoinerInfo ).

OT_JOINER_INFO_TYPE_EUI64

Joiner EUI-64 è specificato ( mSharedId.mEui64 in otJoinerInfo ).

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
[in] aChannelMask
Il valore della maschera del canale.
[in] aEnergyList
Un puntatore all'elenco delle misurazioni energetiche.
[in] aEnergyListLength
Numero di voci in aEnergyListLength .
[in] aContext
Un puntatore al contesto specifico dell'applicazione.

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
[in] aEvent
Il tipo di evento del falegname.
[in] aJoinerInfo
Un puntatore alle informazioni sul falegname.
[in] aJoinerId
Un puntatore all'ID Joiner (se non noto, sarà NULL).
[in] aContext
Un puntatore al contesto specifico dell'applicazione.

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
[in] aPanId
Il valore ID PAN.
[in] aChannelMask
Il valore della maschera del canale.
[in] aContext
Un puntatore al contesto specifico dell'applicazione.

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
[in] aChannelMask
Il valore della maschera del canale.
[in] aEnergyList
Un puntatore all'elenco delle misurazioni energetiche.
[in] aEnergyListLength
Numero di voci in aEnergyListLength .
[in] aContext
Un puntatore al contesto specifico dell'applicazione.

otCommissioningDataset

struct otCommissioningDataset otCommissioningDataset

Questa struttura rappresenta un set di dati di messa in servizio.

otJoinerInfo

struct otJoinerInfo otJoinerInfo

Questa struttura rappresenta una Joiner Info.

otJoinerInfoType

enum otJoinerInfoType otJoinerInfoType

Questa enumerazione definisce un Joiner Info Typer.

otJoinerPskd

struct otJoinerPskd otJoinerPskd

Questa struttura rappresenta un Joiner PSKd.

otSteeringData

struct otSteeringData otSteeringData

Questa struttura rappresenta i dati di governo.

Funzioni

otCommissionerAddJoiner

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

Questa funzione aggiunge una voce di falegname.

Dettagli
Parametri
[in] aInstance
Puntatore a un'istanza di OpenThread.
[in] aEui64
Un puntatore a IEEE EUI-64 di Joiner o NULL per qualsiasi Joiner.
[in] aPskd
Un puntatore al PSKd.
[in] aTimeout
Un tempo dopo il quale un Joiner viene automaticamente rimosso, in secondi.
Valori restituiti
OT_ERROR_NONE
Aggiunto con successo il falegname.
OT_ERROR_NO_BUFS
Nessun buffer disponibile per aggiungere il Joiner.
OT_ERROR_INVALID_ARGS
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 dato valore Joiner Discerner.

Dettagli
Parametri
[in] aInstance
Puntatore a un'istanza di OpenThread.
[in] aDiscerner
Un puntatore al Joiner Discerner.
[in] aPskd
Un puntatore al PSKd.
[in] aTimeout
Un tempo dopo il quale un Joiner viene automaticamente rimosso, in secondi.
Valori restituiti
OT_ERROR_NONE
Aggiunto con successo il falegname.
OT_ERROR_NO_BUFS
Nessun buffer disponibile per aggiungere il Joiner.
OT_ERROR_INVALID_ARGS
aDiscerner o aPskd non è valido.
OT_ERROR_INVALID_STATE
Il commissario non è attivo.

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
[in] aInstance
Puntatore a 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 tra due successive trasmissioni MLE Announce (in millisecondi).
[in] aAddress
Un puntatore alla destinazione IPv6.
Valori restituiti
OT_ERROR_NONE
Accodato con successo il messaggio Announce Begin.
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 di query di scansione energetica.

Dettagli
Parametri
[in] aInstance
Puntatore a un'istanza di OpenThread.
[in] aChannelMask
Il valore della maschera del canale.
[in] aCount
Il numero di misurazioni di energia per canale.
[in] aPeriod
Il tempo tra le misurazioni dell'energia (millisecondi).
[in] aScanDuration
La durata della scansione per ogni misurazione di energia (millisecondi).
[in] aAddress
Un puntatore alla destinazione IPv6.
[in] aCallback
Un puntatore a una funzione chiamata alla ricezione di un messaggio di Energy Report.
[in] aContext
Un puntatore al contesto specifico dell'applicazione.
Valori restituiti
OT_ERROR_NONE
Accodato correttamente il messaggio di query di analisi energetica.
OT_ERROR_NO_BUFS
Buffer insufficienti per generare un messaggio di query di analisi energetica.
OT_ERROR_INVALID_STATE
Il commissario non è attivo.

otCommissionerGetNextJoinerInfo

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

Questo metodo ottiene informazioni sul falegname alla posizione di aIterator.

Dettagli
Parametri
[in] aInstance
Un puntatore all'istanza.
[in,out] aIterator
Puntatore al contesto dell'iteratore di Joiner Info.
[out] aJoiner
Un riferimento alle informazioni di Joiner.
Valori restituiti
OT_ERROR_NONE
Ottieni con successo le informazioni su Joiner.
OT_ERROR_NOT_FOUND
Non trovato il prossimo falegname.

otCommissionerGetProvisioningUrl

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

Questa funzione ottiene l'URL di provisioning.

Dettagli
Parametri
[in] aInstance
Puntatore a un'istanza di OpenThread.
ritorna
Un puntatore alla stringa dell'URL.

otCommissionerGetSessionId

uint16_t otCommissionerGetSessionId(
  otInstance *aInstance
)

Questa funzione restituisce l'ID della sessione del Commissario.

Dettagli
Parametri
[in] aInstance
Puntatore a un'istanza di OpenThread.
ritorna
L'ID della sessione del commissario corrente.

otCommissionerGetState

otCommissionerState otCommissionerGetState(
  otInstance *aInstance
)

Questa funzione restituisce il Commissario di Stato.

Dettagli
Parametri
[in] aInstance
Puntatore a un'istanza di OpenThread.
Valori restituiti
OT_COMMISSIONER_STATE_DISABLED
Commissario disabile.
OT_COMMISSIONER_STATE_PETITION
Diventare commissario.
OT_COMMISSIONER_STATE_ACTIVE
Commissario abilitato.

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
[in] aInstance
Puntatore a un'istanza di OpenThread.
[in] aPanId
L'ID PAN da interrogare.
[in] aChannelMask
Il valore della maschera del canale.
[in] aAddress
Un puntatore alla destinazione IPv6.
[in] aCallback
Puntatore a una funzione chiamata alla ricezione di un messaggio di conflitto ID PAN.
[in] aContext
Un puntatore al contesto specifico dell'applicazione.
Valori restituiti
OT_ERROR_NONE
Accodamento riuscito del messaggio di query ID PAN.
OT_ERROR_NO_BUFS
Buffer insufficienti per generare un messaggio di query ID PAN.
OT_ERROR_INVALID_STATE
Il commissario non è attivo.

otCommissionerRemoveJoiner

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

Questa funzione rimuove una voce di Joiner.

Dettagli
Parametri
[in] aInstance
Puntatore a un'istanza di OpenThread.
[in] aEui64
Un puntatore a IEEE EUI-64 di Joiner o NULL per qualsiasi Joiner.
Valori restituiti
OT_ERROR_NONE
Rimosso con successo il Joiner.
OT_ERROR_NOT_FOUND
Il Joiner specificato da aEui64 non è stato trovato.
OT_ERROR_INVALID_ARGS
aEui64 non è valido.
OT_ERROR_INVALID_STATE
Il commissario non è attivo.

otCommissionerRemoveJoinerWithDiscerner

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

Questa funzione rimuove una voce di Joiner.

Dettagli
Parametri
[in] aInstance
Puntatore a un'istanza di OpenThread.
[in] aEui64
Un puntatore al Joiner Discerner.
Valori restituiti
OT_ERROR_NONE
Rimosso con successo il Joiner.
OT_ERROR_NOT_FOUND
Il Joiner specificato da aEui64 non è stato trovato.
OT_ERROR_INVALID_ARGS
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
Puntatore a un'istanza di OpenThread.
[in] aTlvs
Un puntatore a TLV.
[in] aLength
La lunghezza dei TLV.
Valori restituiti
OT_ERROR_NONE
Invia con successo il comando dataset meshcop.
OT_ERROR_NO_BUFS
Spazio nel buffer insufficiente per l'invio.
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
Puntatore a un'istanza di OpenThread.
[in] aDataset
Un puntatore al set di dati di messa in servizio.
[in] aTlvs
Un puntatore a TLV.
[in] aLength
La lunghezza dei TLV.
Valori restituiti
OT_ERROR_NONE
Invia con successo il comando dataset meshcop.
OT_ERROR_NO_BUFS
Spazio nel buffer insufficiente per l'invio.
OT_ERROR_INVALID_STATE
Il commissario non è attivo.

otCommissionerSetProvisioningUrl

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

Questa funzione imposta l'URL di provisioning.

Dettagli
Parametri
[in] aInstance
Puntatore a un'istanza di OpenThread.
[in] aProvisioningUrl
Un puntatore all'URL di provisioning (può essere NULL da impostare come stringa vuota).
Valori restituiti
OT_ERROR_NONE
Imposta correttamente l'URL di provisioning.
OT_ERROR_INVALID_ARGS
aProvisioningUrl non è 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
Puntatore a un'istanza di OpenThread.
[in] aStateCallback
Puntatore a una funzione che viene chiamata quando cambia lo stato del commissario.
[in] aJoinerCallback
Si verifica un puntatore a una funzione chiamata con un evento di joiner.
[in] aCallbackContext
Un puntatore al contesto specifico dell'applicazione.
Valori restituiti
OT_ERROR_NONE
Avviato con successo il servizio di Commissario.
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
Puntatore a un'istanza di OpenThread.
Valori restituiti
OT_ERROR_NONE
Interrotto con successo il servizio del Commissario.
OT_ERROR_ALREADY
Il Commissario è già fermo.

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)