Set di dati operativi

Include le funzioni per l'API Operational Dataset.

Riepilogo

Solo per le build di FTD, Dataset Updater include funzioni per gestire gli aggiornamenti dei set di dati.

Per le build di FTD e MTD, l'API Operational Dataset include funzioni per gestire i set di dati attivi e in attesa e le TLV dei set di dati.

Enumerazioni

otMeshcopTlvType{   OT_MESHCOP_TLV_CHANNEL = 0,   OT_MESHCOP_TLV_PANID = 1,   OT_MESHCOP_TLV_EXTPANID = 2,   OT_MESHCOP_TLV_NETWORKNAME = 3,   OT_MESHCOP_TLV_PSKC = 4,   OT_MESHCOP_TLV_NETWORKKEY = 5,   OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE = 6,   OT_MESHCOP_TLV_MESHLOCALPREFIX = 7,   OT_MESHCOP_TLV_STEERING_DATA = 8,   OT_MESHCOP_TLV_BORDER_AGENT_RLOC = 9,   OT_MESHCOP_TLV_COMMISSIONER_ID = 10,   OT_MESHCOP_TLV_COMM_SESSION_ID = 11,   OT_MESHCOP_TLV_SECURITYPOLICY = 12,   OT_MESHCOP_TLV_GET = 13,   OT_MESHCOP_TLV_ACTIVETIMESTAMP = 14,   OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT = 15,   OT_MESHCOP_TLV_STATE = 16,   OT_MESHCOP_TLV_JOINER_DTLS = 17,   OT_MESHCOP_TLV_JOINER_UDP_PORT = 18,   OT_MESHCOP_TLV_JOINER_IID = 19,   OT_MESHCOP_TLV_JOINER_RLOC = 20,   OT_MESHCOP_TLV_JOINER_ROUTER_KEK = 21,   OT_MESHCOP_TLV_PROVISIONING_URL = 32,   OT_MESHCOP_TLV_VENDOR_NAME_TLV = 33,   OT_MESHCOP_TLV_VENDOR_MODEL_TLV = 34,   OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV = 35,   OT_MESHCOP_TLV_VENDOR_DATA_TLV = 36,   OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV = 37,   OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV = 48,   OT_MESHCOP_TLV_IPV6_ADDRESS_TLV = 49,   OT_MESHCOP_TLV_PENDINGTIMESTAMP = 51,   OT_MESHCOP_TLV_DELAYTIMER = 52,   OT_MESHCOP_TLV_CHANNELMASK = 53,   OT_MESHCOP_TLV_COUNT = 54,   OT_MESHCOP_TLV_PERIOD = 55,   OT_MESHCOP_TLV_SCAN_DURATION = 56,   OT_MESHCOP_TLV_ENERGY_LIST = 57,   OT_MESHCOP_TLV_DISCOVERYREQUEST = 128,   OT_MESHCOP_TLV_DISCOVERYRESPONSE = 129,   OT_MESHCOP_TLV_JOINERADVERTISEMENT = 241 }

enum Rappresenta i tipi di TLV meshcop.

Typedef
otChannelMask	typedef uint32_t Rappresenta la maschera del canale.
otDatasetMgmtSetCallback)(otError aResult, void *aContext)	typedef void(* Il puntatore viene chiamato quando si riceve una risposta a una richiesta MGMT_SET o si verifica un timeout.
otDatasetUpdaterCallback)(otError aError, void *aContext)	typedef void(* Questo puntatore della funzione di callback viene richiamato quando termina una richiesta di aggiornamento del set di dati e viene segnalato lo stato di operazione riuscita o non riuscita della richiesta di aggiornamento del set di dati.
otExtendedPanId	typedef struct otExtendedPanId Rappresenta un ID PAN esteso.
otMeshLocalPrefix	typedef otIp6NetworkPrefix Rappresenta un prefisso locale mesh.
otMeshcopTlvType	typedef enum otMeshcopTlvType Rappresenta i tipi di TLV meshcop.
otNetworkKey	typedef struct otNetworkKey Rappresenta una chiave di rete Thread.
otNetworkKeyRef	typedef otCryptoKeyRef Questo tipo di dati rappresenta KeyRef e NetworkKey.
otNetworkName	typedef struct otNetworkName Rappresenta un nome di rete.
otOperationalDataset	typedef struct otOperationalDataset Rappresenta un set di dati operativo attivo o in attesa.
otOperationalDatasetComponents	typedef struct otOperationalDatasetComponents Rappresenta la presenza di componenti diversi nel set di dati operativo attivi o in attesa.
otOperationalDatasetTlvs	typedef struct otOperationalDatasetTlvs Rappresenta un set di dati operativo attivo o in attesa.
otPskc	typedef struct otPskc Rappresenta una PSKc.
otPskcRef	typedef otCryptoKeyRef Questo tipo di dati rappresenta KeyRef per PSKc.
otSecurityPolicy	typedef struct otSecurityPolicy Rappresenta il criterio di sicurezza.
otTimestamp	typedef struct otTimestamp Rappresenta un componente timestamp del set di dati Thread.

Variabili
OT_TOOL_PACKED_END	OT_TOOL_PACKED_BEGIN struct otNetworkKey

Funzioni
otDatasetConvertToTlvs(const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)	otError Converte un determinato set di dati operativi in otOperationalDatasetTlvs.
otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)	otError Solo per FTD, crea un nuovo set di dati operativi da utilizzare durante la creazione di una nuova rete.
otDatasetGeneratePskc(const char *aPassPhrase, const otNetworkName *aNetworkName, const otExtendedPanId *aExtPanId, otPskc *aPskc)	otError Genera PSKc da una passphrase, dal nome della rete e dall'ID PAN esteso specificati.
otDatasetGetActive(otInstance *aInstance, otOperationalDataset *aDataset)	otError Restituisce il set di dati operativo attivo.
otDatasetGetActiveTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)	otError Restituisce il set di dati operativo attivo.
otDatasetGetDelayTimerMinimal(otInstance *aInstance)	uint32_t Solo per FTD, ha un timer con ritardo minimo.
otDatasetGetPending(otInstance *aInstance, otOperationalDataset *aDataset)	otError Restituisce il set di dati operativo in attesa.
otDatasetGetPendingTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)	otError Restituisce il set di dati operativo in attesa.
otDatasetIsCommissioned(otInstance *aInstance)	bool Indica se nel set di dati operativi attivi è presente una rete valida.
otDatasetParseTlvs(const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)	otError Analizza un set di dati operativo da un determinato otOperationalDatasetTlvs.
otDatasetSendMgmtActiveGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)	otError Invia MGMT_ACTIVE_GET.
otDatasetSendMgmtActiveSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)	otError Invia MGMT_ACTIVE_SET.
otDatasetSendMgmtPendingGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)	otError Invia MGMT_PENDING_GET.
otDatasetSendMgmtPendingSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)	otError Invia MGMT_PENDING_SET.
otDatasetSetActive(otInstance *aInstance, const otOperationalDataset *aDataset)	otError Imposta il set di dati operativo attivo.
otDatasetSetActiveTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)	otError Imposta il set di dati operativo attivo.
otDatasetSetDelayTimerMinimal(otInstance *aInstance, uint32_t aDelayTimerMinimal)	otError Solo per FTD, imposta un timer con ritardo minimo.
otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset)	otError Imposta il set di dati operativo in attesa.
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)	otError Imposta il set di dati operativo in attesa.
otDatasetUpdateTlvs(const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)	otError Aggiorna un determinato set di dati operativi.
otDatasetUpdaterCancelUpdate(otInstance *aInstance)	void Annulla un'eventuale richiesta di aggiornamento del set di dati operativo in corso.
otDatasetUpdaterIsUpdateOngoing(otInstance *aInstance)	bool Indica se è in corso una richiesta di aggiornamento del set di dati dell'operazione.
otDatasetUpdaterRequestUpdate(otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext)	otError Richiede un aggiornamento del set di dati operativo.
otNetworkNameFromString(otNetworkName *aNetworkName, const char *aNameString)	otError Imposta un'istanza otNetworkName da una determinata stringa C terminata con null.

Strutture
otExtendedPanId	Rappresenta un ID PAN esteso.
otNetworkKey	Rappresenta una chiave di rete Thread.
otNetworkName	Rappresenta un nome di rete.
otOperationalDataset	Rappresenta un set di dati operativo attivo o in attesa.
otOperationalDatasetComponents	Rappresenta la presenza di componenti diversi nel set di dati operativo attivi o in attesa.
otOperationalDatasetTlvs	Rappresenta un set di dati operativo attivo o in attesa.
otPskc	Rappresenta la PSKc.
otSecurityPolicy	Rappresenta il criterio di sicurezza.
otTimestamp	Rappresenta un componente timestamp del set di dati Thread.

Enumerazioni

otMeshcopTlvType

 otMeshcopTlvType

Rappresenta i tipi di TLV meshcop.

Proprietà
OT_MESHCOP_TLV_ACTIVETIMESTAMP	Timestamp attivo del timestamp meshcop TLV
OT_MESHCOP_TLV_BORDER_AGENT_RLOC	TLV Border Agent Locator meshcop
OT_MESHCOP_TLV_CHANNEL	TLV canale meshcop
OT_MESHCOP_TLV_CHANNELMASK	Maschera canale meshcop TLV
OT_MESHCOP_TLV_COMMISSIONER_ID	ID Commissioner meshcop TLV
OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT	TLV porta UDP Commissioner meshcop
OT_MESHCOP_TLV_COMM_SESSION_ID	ID sessione Commissioner meshcop TLV
OT_MESHCOP_TLV_COUNT	Numero meshcop TLV
OT_MESHCOP_TLV_DELAYTIMER	Ritardo timer meshcop TLV
OT_MESHCOP_TLV_DISCOVERYREQUEST	TLV richiesta di rilevamento meshcop
OT_MESHCOP_TLV_DISCOVERYRESPONSE	TLV Discovery Response meshcop
OT_MESHCOP_TLV_ENERGY_LIST	TLV elenco di energia meshcop
OT_MESHCOP_TLV_EXTPANID	ID pan esterno meshcop TLV
OT_MESHCOP_TLV_GET	Meshcop Ottieni TLV
OT_MESHCOP_TLV_IPV6_ADDRESS_TLV	TLV indirizzo IPv6 meshcop
OT_MESHCOP_TLV_JOINERADVERTISEMENT	TLV Pubblicità per il joiner meshcop
OT_MESHCOP_TLV_JOINER_DTLS	Incapsulamento DTLS Joiner meshcop TLV
OT_MESHCOP_TLV_JOINER_IID	IID joiner meshcop TLV
OT_MESHCOP_TLV_JOINER_RLOC	Localizzatore router Joiner meshcop TLV
OT_MESHCOP_TLV_JOINER_ROUTER_KEK	Router per falegname meshcop KEK TLV
OT_MESHCOP_TLV_JOINER_UDP_PORT	TLV della porta UDP del joiner meshcop
OT_MESHCOP_TLV_MESHLOCALPREFIX	Prefisso locale mesh meshcop TLV
OT_MESHCOP_TLV_NETWORKKEY	TLV chiave di rete meshcop
OT_MESHCOP_TLV_NETWORKNAME	Nome rete meshcop TLV
OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE	TLV sequenza chiavi di rete meshcop
OT_MESHCOP_TLV_PANID	ID pan meshcop TLV
OT_MESHCOP_TLV_PENDINGTIMESTAMP	Timestamp in attesa di meshcop TLV
OT_MESHCOP_TLV_PERIOD	TLV periodo meshcop
OT_MESHCOP_TLV_PROVISIONING_URL	TLV URL di provisioning meshcop
OT_MESHCOP_TLV_PSKC	Meshcop PSKc TLV
OT_MESHCOP_TLV_SCAN_DURATION	Durata scansione meshcop TLV
OT_MESHCOP_TLV_SECURITYPOLICY	TLV relativo ai criteri di sicurezza di meshcop
OT_MESHCOP_TLV_STATE	TLV stato meshcop
OT_MESHCOP_TLV_STEERING_DATA	Dati sullo sterzo di meshcop TLV
OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV	TLV di incapsulamento UDP meshcop
OT_MESHCOP_TLV_VENDOR_DATA_TLV	TLV dati fornitore meshcop
OT_MESHCOP_TLV_VENDOR_MODEL_TLV	Modello fornitore meshcop TLV
OT_MESHCOP_TLV_VENDOR_NAME_TLV	Nome fornitore meshcop TLV
OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV	TLV versione stack fornitore meshcop
OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV	TLV fornitore versione SW fornitore meshcop

Typedef

otChannelMask

uint32_t otChannelMask

Rappresenta la maschera del canale.

otDatasetMgmtSetCallback

void(* otDatasetMgmtSetCallback)(otError aResult, void *aContext)

Il puntatore viene chiamato quando si riceve una risposta a una richiesta MGMT_SET o si verifica un timeout.

Dettagli
Parametri	[in] aResult Il risultato dell'operazione. [in] aContext Un puntatore al contesto specifico dell'applicazione.
Valori restituiti	OT_ERROR_NONE La richiesta è stata accettata dal leader. OT_ERROR_REJECTED La richiesta è stata rifiutata dal leader. OT_ERROR_PARSE Si è verificato un errore durante l'analisi della risposta. OT_ERROR_ABORT La richiesta è stata reimpostata dal peer. OT_ERROR_RESPONSE_TIMEOUT Nessuna risposta o conferma ricevuta durante il periodo di timeout.

otDatasetUpdaterCallback

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

Questo puntatore della funzione di callback viene richiamato quando termina una richiesta di aggiornamento del set di dati e viene segnalato lo stato di operazione riuscita o non riuscita della richiesta di aggiornamento del set di dati.

Disponibile quando OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE è abilitato.

Dettagli

Parametri

[in] aError Lo stato di errore. OT_ERROR_NONE indica che l'aggiornamento del set di dati è riuscito. OT_ERROR_INVALID_STATE indica un errore dovuto a uno stato non valido (MLE in fase di disattivazione). OT_ERROR_ALREADY indica un errore dovuto a un altro dispositivo all'interno della rete che richiede un aggiornamento del set di dati in conflitto. [in] aContext Un puntatore al contesto arbitrario (fornito dall'utente in otDatasetUpdaterRequestUpdate()).

otExtendedPanId

struct otExtendedPanId otExtendedPanId

Rappresenta un ID PAN esteso.

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

Rappresenta un prefisso locale mesh.

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

Rappresenta i tipi di TLV meshcop.

otNetworkKey

struct otNetworkKey otNetworkKey

Rappresenta una chiave di rete Thread.

otNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

Questo tipo di dati rappresenta KeyRef e NetworkKey.

Riferimento alla chiave

otNetworkName

struct otNetworkName otNetworkName

Rappresenta un nome di rete.

otNetworkName è una stringa C terminata con valore null (ad es. L'array di caratteri m8 DEVE terminare con il carattere null \0).

otOperationalDataset

struct otOperationalDataset otOperationalDataset

Rappresenta un set di dati operativo attivo o in attesa.

I componenti del set di dati sono facoltativi. La struttura mComponents specifica i componenti presenti nel set di dati.

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

Rappresenta la presenza di componenti diversi nel set di dati operativo attivi o in attesa.

otOperationalDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

Rappresenta un set di dati operativo attivo o in attesa.

Il set di dati operativo è codificato in TLV come specificato da Thread.

otPskc

struct otPskc otPskc

Rappresenta una PSKc.

otPskcRef

otCryptoKeyRef otPskcRef

Questo tipo di dati rappresenta KeyRef per PSKc.

Riferimento alla chiave

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

Rappresenta il criterio di sicurezza.

otTimestamp

struct otTimestamp otTimestamp

Rappresenta un componente timestamp del set di dati Thread.

Variabili

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

Funzioni

otDatasetConvertToTlvs

otError otDatasetConvertToTlvs(
  const otOperationalDataset *aDataset,
  otOperationalDatasetTlvs *aDatasetTlvs
)

Converte un determinato set di dati operativi in otOperationalDatasetTlvs.

Dettagli
Parametri	[in] aDataset Un set di dati operativo da convertire in TLV. [out] aDatasetTlvs Un puntatore ai TLV del set di dati per restituire il risultato.
Valori restituiti	OT_ERROR_NONE Conversione di aDataset riuscita e aggiornamento di aDatasetTlvs completato. OT_ERROR_INVALID_ARGS aDataset non è valido, non contiene timestamp attivi o in attesa.

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Solo per FTD, crea un nuovo set di dati operativi da utilizzare durante la creazione di una nuova rete.

Dettagli
Parametri	[in] aInstance Un puntatore a un'istanza OpenThread. [out] aDataset Il set di dati operativi.
Valori restituiti	OT_ERROR_NONE Nuovo set di dati operativo creato. OT_ERROR_FAILED Impossibile generare valori casuali per i nuovi parametri.

otDatasetGeneratePskc

otError otDatasetGeneratePskc(
  const char *aPassPhrase,
  const otNetworkName *aNetworkName,
  const otExtendedPanId *aExtPanId,
  otPskc *aPskc
)

Genera PSKc da una passphrase, dal nome della rete e dall'ID PAN esteso specificati.

La PSKc viene utilizzata per stabilire la sessione Commissioner.

Dettagli
Parametri	[in] aPassPhrase La passphrase di messa in servizio. [in] aNetworkName Il nome della rete per il calcolo di PSKc. [in] aExtPanId L'ID PAN esteso per il calcolo della PSKc. [out] aPskc Un puntatore alla variabile per generare il PSKc generato.
Valori restituiti	OT_ERROR_NONE Generazione PSKc riuscita. OT_ERROR_INVALID_ARGS Se uno degli argomenti di input non è valido.

otDatasetGetActive

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Restituisce il set di dati operativo attivo.

Dettagli
Parametri	[in] aInstance Un puntatore a un'istanza OpenThread. [out] aDataset Un puntatore al punto in cui verrà posizionato il set di dati operativo attivo.
Valori restituiti	OT_ERROR_NONE Set di dati operativo attivo recuperato. OT_ERROR_NOT_FOUND Nessun valore corrispondente nell'archivio delle impostazioni.

otDatasetGetActiveTlvs

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Restituisce il set di dati operativo attivo.

Dettagli
Parametri	[in] aInstance Un puntatore a un'istanza OpenThread. [out] aDataset Un puntatore al punto in cui verrà posizionato il set di dati operativo attivo.
Valori restituiti	OT_ERROR_NONE Set di dati operativo attivo recuperato. OT_ERROR_NOT_FOUND Nessun valore corrispondente nell'archivio delle impostazioni.

otDatasetGetDelayTimerMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

Solo per FTD, ha un timer con ritardo minimo.

Dettagli
Parametri	[in] aInstance Un puntatore a un'istanza OpenThread.
Valori restituiti	the valore del timer di ritardo minimo (in ms).

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Restituisce il set di dati operativo in attesa.

Dettagli
Parametri	[in] aInstance Un puntatore a un'istanza OpenThread. [out] aDataset Un puntatore al punto in cui verrà posizionato il set di dati operativo in attesa.
Valori restituiti	OT_ERROR_NONE Set di dati operativo in attesa recuperato. OT_ERROR_NOT_FOUND Nessun valore corrispondente nell'archivio delle impostazioni.

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Restituisce il set di dati operativo in attesa.

Dettagli
Parametri	[in] aInstance Un puntatore a un'istanza OpenThread. [out] aDataset Un puntatore al punto in cui verrà posizionato il set di dati operativo in attesa.
Valori restituiti	OT_ERROR_NONE Set di dati operativo in attesa recuperato. OT_ERROR_NOT_FOUND Nessun valore corrispondente nell'archivio delle impostazioni.

otDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

Indica se nel set di dati operativi attivi è presente una rete valida.

Dettagli
Parametri	[in] aInstance Un puntatore a un'istanza OpenThread.
Restituisce	TRUE se è presente una rete valida nel set di dati operativo attivo, altrimenti FALSE.

otDatasetParseTlvs

otError otDatasetParseTlvs(
  const otOperationalDatasetTlvs *aDatasetTlvs,
  otOperationalDataset *aDataset
)

Analizza un set di dati operativo da un determinato otOperationalDatasetTlvs.

Dettagli
Parametri	[in] aDatasetTlvs Un puntatore ai TLV di un set di dati. [out] aDataset Un puntatore al punto in cui verrà posizionato il set di dati.
Valori restituiti	OT_ERROR_NONE Impostazione di aDataset da aDatasetTlvs riuscita. OT_ERROR_INVALID_ARGS Il campo aDatasetTlvs non è valido.

otDatasetSendMgmtActiveGet

otError otDatasetSendMgmtActiveGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

Invia MGMT_ACTIVE_GET.

Dettagli
Parametri	[in] aInstance Un puntatore a un'istanza OpenThread. [in] aDatasetComponents Un puntatore a una struttura di componenti del set di dati che specifica i componenti da richiedere. [in] aTlvTypes Un puntatore a un array contenente altri tipi di TLV non elaborati da richiedere. [in] aLength La lunghezza di aTlvTypes. [in] aAddress Un puntatore alla destinazione IPv6, se è NULL, utilizzerà Leader ALOC per impostazione predefinita.
Valori restituiti	OT_ERROR_NONE Invio del comando per il set di dati meshcop riuscito. OT_ERROR_NO_BUFS Spazio nel buffer insufficiente per l'invio.

otDatasetSendMgmtActiveSet

otError otDatasetSendMgmtActiveSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

Invia MGMT_ACTIVE_SET.

Dettagli
Parametri	[in] aInstance Un puntatore a un'istanza OpenThread. [in] aDataset Un puntatore a un set di dati operativo. [in] aTlvs Un puntatore ai TLV. [in] aLength La durata dei TLV. [in] aCallback Un puntatore a una funzione che viene richiamata alla ricezione o al timeout della risposta. [in] aContext Un puntatore al contesto specifico dell'applicazione per aCallback.
Valori restituiti	OT_ERROR_NONE Invio del comando per il set di dati meshcop riuscito. OT_ERROR_NO_BUFS Spazio nel buffer insufficiente per l'invio. OT_ERROR_BUSY È in corso una richiesta precedente.

otDatasetSendMgmtPendingGet

otError otDatasetSendMgmtPendingGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

Invia MGMT_PENDING_GET.

Dettagli
Parametri	[in] aInstance Un puntatore a un'istanza OpenThread. [in] aDatasetComponents Un puntatore a una struttura di componenti del set di dati che specifica i componenti da richiedere. [in] aTlvTypes Un puntatore a un array contenente altri tipi di TLV non elaborati da richiedere. [in] aLength La lunghezza di aTlvTypes. [in] aAddress Un puntatore alla destinazione IPv6, se è NULL, utilizzerà Leader ALOC per impostazione predefinita.
Valori restituiti	OT_ERROR_NONE Invio del comando per il set di dati meshcop riuscito. OT_ERROR_NO_BUFS Spazio nel buffer insufficiente per l'invio.

otDatasetSendMgmtPendingSet

otError otDatasetSendMgmtPendingSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

Invia MGMT_PENDING_SET.

Dettagli
Parametri	[in] aInstance Un puntatore a un'istanza OpenThread. [in] aDataset Un puntatore a un set di dati operativo. [in] aTlvs Un puntatore ai TLV. [in] aLength La durata dei TLV. [in] aCallback Un puntatore a una funzione che viene richiamata alla ricezione o al timeout della risposta. [in] aContext Un puntatore al contesto specifico dell'applicazione per aCallback.
Valori restituiti	OT_ERROR_NONE Invio del comando per il set di dati meshcop riuscito. OT_ERROR_NO_BUFS Spazio nel buffer insufficiente per l'invio. OT_ERROR_BUSY È in corso una richiesta precedente.

otDatasetSetActive

otError otDatasetSetActive(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

Imposta il set di dati operativo attivo.

Se il set di dati non include un timestamp attivo, significa che è completo solo parzialmente.

Se Thread è abilitato su un dispositivo con un set di dati attivo parzialmente completo, il dispositivo tenterà di connettersi a una rete Thread esistente utilizzando qualsiasi informazione esistente nel set di dati. Per collegarsi a una rete è necessaria solo la chiave di rete Thread.

Se il canale non è incluso nel set di dati, il dispositivo invierà messaggi MLE Annuncia i messaggi su diversi canali per trovare vicini su altri canali.

Se il dispositivo si collega correttamente a una rete Thread, recupererà il set di dati attivo completo dal relativo elemento principale. Tieni presente che un dispositivo che supporta il router non passerà ai ruoli Router o Leader finché non avrà un set di dati attivo completo.

Dettagli
Parametri	[in] aInstance Un puntatore a un'istanza OpenThread. [in] aDataset Un puntatore al set di dati operativo attivo.
Valori restituiti	OT_ERROR_NONE Set di dati operativo attivo impostato. OT_ERROR_NO_BUFS Spazio di buffer insufficiente per impostare il set di dati operativo attivo. OT_ERROR_NOT_IMPLEMENTED La piattaforma non implementa la funzionalità relativa alle impostazioni.

otDatasetSetActiveTlvs

otError otDatasetSetActiveTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

Imposta il set di dati operativo attivo.

Se il set di dati non include un timestamp attivo, significa che è completo solo parzialmente.

Se Thread è abilitato su un dispositivo con un set di dati attivo parzialmente completo, il dispositivo tenterà di connettersi a una rete Thread esistente utilizzando qualsiasi informazione esistente nel set di dati. Per collegarsi a una rete è necessaria solo la chiave di rete Thread.

Se il canale non è incluso nel set di dati, il dispositivo invierà messaggi MLE Annuncia i messaggi su diversi canali per trovare vicini su altri canali.

Se il dispositivo si collega correttamente a una rete Thread, recupererà il set di dati attivo completo dal relativo elemento principale. Tieni presente che un dispositivo che supporta il router non passerà ai ruoli Router o Leader finché non avrà un set di dati attivo completo.

Dettagli
Parametri	[in] aInstance Un puntatore a un'istanza OpenThread. [in] aDataset Un puntatore al set di dati operativo attivo.
Valori restituiti	OT_ERROR_NONE Set di dati operativo attivo impostato. OT_ERROR_NO_BUFS Spazio di buffer insufficiente per impostare il set di dati operativo attivo. OT_ERROR_NOT_IMPLEMENTED La piattaforma non implementa la funzionalità relativa alle impostazioni.

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

Solo per FTD, imposta un timer con ritardo minimo.

Nota: questa API è riservata esclusivamente a test e demo. La modifica delle impostazioni con questa API renderà un'applicazione di produzione non conforme alla specifica Thread.

Dettagli
Parametri	[in] aInstance Un puntatore a un'istanza OpenThread. [in] aDelayTimerMinimal Valore del timer di ritardo minimo (in ms).
Valori restituiti	OT_ERROR_NONE Timer di ritardo minimo impostato correttamente. OT_ERROR_INVALID_ARGS Se aDelayTimerMinimal non è valido.

otDatasetSetPending

otError otDatasetSetPending(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

Imposta il set di dati operativo in attesa.

Dettagli
Parametri	[in] aInstance Un puntatore a un'istanza OpenThread. [in] aDataset Un puntatore al set di dati operativo in attesa.
Valori restituiti	OT_ERROR_NONE Set di dati operativo in attesa impostato. OT_ERROR_NO_BUFS Spazio di buffer insufficiente per impostare il set di dati operativo in attesa. OT_ERROR_NOT_IMPLEMENTED La piattaforma non implementa la funzionalità relativa alle impostazioni.

otDatasetSetPendingTlvs

otError otDatasetSetPendingTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

Imposta il set di dati operativo in attesa.

Dettagli
Parametri	[in] aInstance Un puntatore a un'istanza OpenThread. [in] aDataset Un puntatore al set di dati operativo in attesa.
Valori restituiti	OT_ERROR_NONE Set di dati operativo in attesa impostato. OT_ERROR_NO_BUFS Spazio di buffer insufficiente per impostare il set di dati operativo in attesa. OT_ERROR_NOT_IMPLEMENTED La piattaforma non implementa la funzionalità relativa alle impostazioni.

otDatasetUpdateTlvs

otError otDatasetUpdateTlvs(
  const otOperationalDataset *aDataset,
  otOperationalDatasetTlvs *aDatasetTlvs
)

Aggiorna un determinato set di dati operativi.

aDataset contiene i campi da aggiornare e il nuovo valore.

Dettagli
Parametri	[in] aDataset Specifica l'insieme di tipi e valori da aggiornare. [in,out] aDatasetTlvs Un puntatore ai TLV del set di dati da aggiornare.
Valori restituiti	OT_ERROR_NONE Aggiornamento di aDatasetTlvs completato. OT_ERROR_INVALID_ARGS aDataset contiene valori non validi. OT_ERROR_NO_BUFS Spazio insufficiente in aDatasetTlvs per applicare l'aggiornamento.

otDatasetUpdaterCancelUpdate

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

Annulla un'eventuale richiesta di aggiornamento del set di dati operativo in corso.

Disponibile quando OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE è abilitato.

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

otDatasetUpdaterIsUpdateOngoing

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

Indica se è in corso una richiesta di aggiornamento del set di dati dell'operazione.

Disponibile quando OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE è abilitato.

Dettagli
Parametri	[in] aInstance Un puntatore a un'istanza OpenThread.
Valori restituiti	TRUE È in corso un aggiornamento. FALSE Non ci sono aggiornamenti in corso.

otDatasetUpdaterRequestUpdate

otError otDatasetUpdaterRequestUpdate(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  otDatasetUpdaterCallback aCallback,
  void *aContext
)

Richiede un aggiornamento del set di dati operativo.

Disponibile quando OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE è abilitato.

aDataset deve contenere i campi da aggiornare e il nuovo valore. Non deve contenere i campi per il timestamp attivo o in attesa. Il campo Ritardo è facoltativo; se non viene fornito, verrà utilizzato un valore predefinito (1000 ms).

Dettagli
Parametri	[in] aInstance Un puntatore a un'istanza OpenThread. [in] aDataset Un puntatore al set di dati contenente i campi da modificare. [in] aCallback Un callback per indicare quando termina la richiesta di aggiornamento del set di dati. [in] aContext Un contesto arbitrario passato al callback.
Valori restituiti	OT_ERROR_NONE Aggiornamento del set di dati avviato correttamente (la chiamata a aCallback verrà richiamata al completamento). OT_ERROR_INVALID_STATE Il dispositivo è disabilitato (MLE è disattivato). OT_ERROR_INVALID_ARGS aDataset non è valido (contiene timestamp di attività o di attesa). OT_ERROR_BUSY Impossibile avviare aggiornamento. È in corso un aggiornamento precedente. OT_ERROR_NO_BUFS Impossibile allocare il buffer per salvare il set di dati.

otNetworkNameFromString

otError otNetworkNameFromString(
  otNetworkName *aNetworkName,
  const char *aNameString
)

Imposta un'istanza otNetworkName da una determinata stringa C terminata con null.

aNameString deve seguire la codifica UTF-8 e la lunghezza del nome di rete non deve essere superiore a OT_NETWORK_NAME_MAX_SIZE.

Dettagli
Parametri	[out] aNetworkName Un puntatore alla otNetworkName da impostare. [in] aNameString Una stringa nome C.
Valori restituiti	OT_ERROR_NONE Impostazione di aNetworkName da aNameString riuscita. OT_ERROR_INVALID_ARGS aNameStrng non è valido (troppo lungo o non segue la codifica UTF-8).

Macro

OT_CHANNEL_10_MASK

 OT_CHANNEL_10_MASK (1 << 10)

Canale 10.

OT_CHANNEL_11_MASK

 OT_CHANNEL_11_MASK (1 << 11)

Canale 11.

OT_CHANNEL_12_MASK

 OT_CHANNEL_12_MASK (1 << 12)

Canale 12.

OT_CHANNEL_13_MASK

 OT_CHANNEL_13_MASK (1 << 13)

Canale 13.

OT_CHANNEL_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

Canale 14.

OT_CHANNEL_15_MASK

 OT_CHANNEL_15_MASK (1 << 15)

Canale 15.

OT_CHANNEL_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

Canale 16.

OT_CHANNEL_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

Canale 17.

OT_CHANNEL_18_MASK

 OT_CHANNEL_18_MASK (1 << 18)

Canale 18.

OT_CHANNEL_19_MASK

 OT_CHANNEL_19_MASK (1 << 19)

Canale 19.

OT_CHANNEL_1_MASK

 OT_CHANNEL_1_MASK (1 << 1)

Canale 1.

OT_CHANNEL_20_MASK

 OT_CHANNEL_20_MASK (1 << 20)

Canale 20.

OT_CHANNEL_21_MASK

 OT_CHANNEL_21_MASK (1 << 21)

Canale 21.

OT_CHANNEL_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

Canale 22.

OT_CHANNEL_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

Canale 23.

OT_CHANNEL_24_MASK

 OT_CHANNEL_24_MASK (1 << 24)

Canale 24.

OT_CHANNEL_25_MASK

 OT_CHANNEL_25_MASK (1 << 25)

Canale 25.

OT_CHANNEL_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

Canale 26.

OT_CHANNEL_2_MASK

 OT_CHANNEL_2_MASK (1 << 2)

Canale 2.

OT_CHANNEL_3_MASK

 OT_CHANNEL_3_MASK (1 << 3)

Canale 3.

OT_CHANNEL_4_MASK

 OT_CHANNEL_4_MASK (1 << 4)

Canale 4.

OT_CHANNEL_5_MASK

 OT_CHANNEL_5_MASK (1 << 5)

Canale 5.

OT_CHANNEL_6_MASK

 OT_CHANNEL_6_MASK (1 << 6)

Canale 6.

OT_CHANNEL_7_MASK

 OT_CHANNEL_7_MASK (1 << 7)

Canale 7.

OT_CHANNEL_8_MASK

 OT_CHANNEL_8_MASK (1 << 8)

Canale 8.

OT_CHANNEL_9_MASK

 OT_CHANNEL_9_MASK (1 << 9)

Canale 9.

OT_EXT_PAN_ID_SIZE

 OT_EXT_PAN_ID_SIZE 8

Dimensioni di un ID PAN thread (byte)

OT_MESH_LOCAL_PREFIX_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

Dimensione del prefisso locale della rete mesh (byte)

OT_NETWORK_KEY_SIZE

 OT_NETWORK_KEY_SIZE 16

Dimensioni della chiave di rete Thread (byte)

OT_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

Dimensioni massime del campo Nome rete Thread (byte)

OT_OPERATIONAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

Lunghezza massima del set di dati operativo in byte.

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

Dimensione massima della PSKc (byte)

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.