Set di dati operativi

Questo modulo include funzioni per Dataset Updater.

Riepilogo

Le funzioni in questo modulo sono disponibili quando è abilitata la funzionalità Dataset Updater (ovvero OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE è impostato su 1). Inoltre, questa funzionalità è disponibile solo su una build FTD.

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
Questa enumerazione rappresenta i tipi di TLV meshcop.

Defdef

otChannelMask tipodef
uint32_t
Questo tipo rappresenta la Channel Mask.
otDatasetMgmtSetCallback)(otError aResult, void *aContext) tipodef
void(*
Questo puntatore funzione viene chiamato quando si riceve una risposta a una richiesta MGMT_SET o scade.
otDatasetUpdaterCallback)(otError aError, void *aContext) tipodef
void(*
Questo puntatore di funzione di callback viene chiamato al termine di una richiesta di aggiornamento del set di dati, segnalando lo stato della richiesta di aggiornamento del set di dati riuscito o non riuscito.
otExtendedPanId tipodef
Questa struttura rappresenta un ID PAN esteso.
otMeshLocalPrefix tipodef
Questa struttura rappresenta un prefisso locale mesh.
otMeshcopTlvType tipodef
Questa enumerazione rappresenta i tipi di TLV meshcop.
otNetworkKey tipodef
struct otNetworkKey
Questa struttura rappresenta una chiave di rete Thread.
otNetworkKeyRef tipodef
Questo tipo di dati rappresenta KeyRef in NetworkKey.
otNetworkName tipodef
struct otNetworkName
Questa struttura rappresenta un Nome di rete.
otOperationalDataset tipodef
Questa struttura rappresenta un set di dati operativo attivo o in attesa.
otOperationalDatasetComponents tipodef
Questa struttura rappresenta la presenza di componenti diversi nel set di dati operativi o in attesa.
otOperationalDatasetTlvs tipodef
Questa struttura rappresenta un set di dati operativo attivo o in attesa.
otPskc tipodef
struct otPskc
Questa struttura rappresenta un PSKc.
otPskcRef tipodef
Questo tipo di dati rappresenta KeyRef in PSKc.
otSecurityPolicy tipodef
Questa struttura rappresenta il criterio di sicurezza.
otTimestamp tipodef
struct otTimestamp
Questa struttura rappresenta un componente di timestamp del set di dati Thread.

Variabili

OT_TOOL_PACKED_END

Functions

otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)
Questo metodo 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)
Questa funzione genera PSKc da una determinata frase di passaggio, nome di rete e ID PAN esteso.
otDatasetGetActive(otInstance *aInstance, otOperationalDataset *aDataset)
Questa funzione riceve il set di dati operativo attivo.
otDatasetGetActiveTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Questa funzione riceve il set di dati operativo attivo.
otDatasetGetDelayTimerMinimal(otInstance *aInstance)
uint32_t
Calcola un timer di ritardo minimo.
otDatasetGetPending(otInstance *aInstance, otOperationalDataset *aDataset)
Questa funzione riceve il set di dati operativi in attesa.
otDatasetGetPendingTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Questa funzione riceve il set di dati operativi in attesa.
otDatasetIsCommissioned(otInstance *aInstance)
bool
Questa funzione indica se nel set di dati operativo attivo è presente o meno una rete valida.
otDatasetParseTlvs(const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)
Questa funzione analizza un set di dati operativi da un otOperationalDatasetTlvs.
otDatasetSendMgmtActiveGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Questa funzione invia MGMT_ACTIVE_GET.
otDatasetSendMgmtActiveSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Questa funzione invia MGMT_ACTIVE_SET.
otDatasetSendMgmtPendingGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Questa funzione invia MGMT_PENDING_GET.
otDatasetSendMgmtPendingSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Questa funzione invia MGMT_PENDING_SET.
otDatasetSetActive(otInstance *aInstance, const otOperationalDataset *aDataset)
Questa funzione imposta il set di dati operativo attivo.
otDatasetSetActiveTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Questa funzione imposta il set di dati operativo attivo.
otDatasetSetDelayTimerMinimal(otInstance *aInstance, uint32_t aDelayTimerMinimal)
Imposta un timer di ritardo minimo.
otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset)
Questa funzione imposta il set di dati operativo in attesa.
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Questa funzione imposta il set di dati operativo in attesa.
otDatasetUpdaterCancelUpdate(otInstance *aInstance)
void
Questa funzione annulla una richiesta di aggiornamento operativo (se presente) in corso.
otDatasetUpdaterIsUpdateOngoing(otInstance *aInstance)
bool
Questa funzione indica se è in corso una richiesta di aggiornamento del set di dati dell'operazione.
otDatasetUpdaterRequestUpdate(otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext)
Questa funzione richiede un aggiornamento del set di dati operativi.
otNetworkNameFromString(otNetworkName *aNetworkName, const char *aNameString)
Questa funzione imposta un'istanza otNetworkName da una determinata stringa C con terminazione null.

Strutture

ID OtEstesoPan

Questa struttura rappresenta un ID PAN esteso.

Chiave di rete

Questa struttura rappresenta una chiave di rete Thread.

NomeReteot

Questa struttura rappresenta un Nome di rete.

OtOperationalDataset

Questa struttura rappresenta un set di dati operativo attivo o in attesa.

otOperationalDatasetComponents

Questa struttura rappresenta la presenza di componenti diversi nel set di dati operativi o in attesa.

otOperationalDatasetTlvs

Questa struttura rappresenta un set di dati operativo attivo o in attesa.

OtPskc

Questa struttura rappresenta PSKc.

otSecurityPolicy

Questa struttura rappresenta il criterio di sicurezza.

Timestamp ot

Questa struttura rappresenta un componente di timestamp del set di dati Thread.

Enumerazioni

OtMeshcopTlvType

 otMeshcopTlvType

Questa enumerazione rappresenta i tipi di TLV meshcop.

Proprietà
OT_MESHCOP_TLV_ACTIVETIMESTAMP

TLV attivo meshcop

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

Locator di agente di confine meshcop TLV

OT_MESHCOP_TLV_CHANNEL

TLV canale meshcop

OT_MESHCOP_TLV_CHANNELMASK

TLV maschera dei canali meshcop

OT_MESHCOP_TLV_COMMISSIONER_ID

ID Commissioner meshcop

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

TLV porta UDP Commissioner meshcop

OT_MESHCOP_TLV_COMM_SESSION_ID

ID sessione Commissioner meshcop

OT_MESHCOP_TLV_COUNT

Numero di TLV meshcop

OT_MESHCOP_TLV_DELAYTIMER

Timer di ritardo TLV meshcop

OT_MESHCOP_TLV_DISCOVERYREQUEST

TLV richiesta meshcop

OT_MESHCOP_TLV_DISCOVERYRESPONSE

meshTC Discovery Discovery - TLV

OT_MESHCOP_TLV_ENERGY_LIST

Elenco dei consumi energetici TLV meshcop

OT_MESHCOP_TLV_EXTPANID

Mesh Panp esteso con ID TLV

OT_MESHCOP_TLV_GET

meshcop Ottieni TLV

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

TLV indirizzo IPv6 meshcop

OT_MESHCOP_TLV_JOINERADVERTISEMENT

TLV pubblicitario di meshcop

OT_MESHCOP_TLV_JOINER_DTLS

Mesh TLV Encapsulation Joiner meshcop

OT_MESHCOP_TLV_JOINER_IID

TLV IDer meshcop

OT_MESHCOP_TLV_JOINER_RLOC

Locator router meshcop TLV

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

Router mesh mesh KEK TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

TLV porta UDP joiner meshcop

OT_MESHCOP_TLV_MESHLOCALPREFIX

TLV locale mesh mesh

OT_MESHCOP_TLV_NETWORKKEY

TLV chiave di rete meshcop

OT_MESHCOP_TLV_NETWORKNAME

Nome rete TLV meshcop

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE

TLV sequenza di chiavi di rete meshcop

OT_MESHCOP_TLV_PANID

Mesh Cop Id ID TLV

OT_MESHCOP_TLV_PENDINGTIMESTAMP

meshcop - Timestamp in attesa 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 TLV meshcop

OT_MESHCOP_TLV_SECURITYPOLICY

Criterio di sicurezza TLV meshcop

OT_MESHCOP_TLV_STATE

TLV State di Meshcop

OT_MESHCOP_TLV_STEERING_DATA

Dati TLV meshcop

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

TLV incapsulamento UDP meshcop

OT_MESHCOP_TLV_VENDOR_DATA_TLV

Dati TLV fornitore di meshcop

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

Modello TLV del fornitore di meshcop

OT_MESHCOP_TLV_VENDOR_NAME_TLV

Nome fornitore TLV meshcop

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

Versione TLV fornitore di meshcop

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

Meshcop Fornitore SW Versione TLV

Defdef

OtChannelMask

uint32_t otChannelMask

Questo tipo rappresenta la Channel Mask.

otDatasetMgmtSetChiama

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

Questo puntatore funzione viene chiamato quando si riceve una risposta a una richiesta MGMT_SET o scade.

Dettagli
Parametri
[in] aResult
Un risultato dell'operazione.
[in] aContext
Un puntatore sul contesto specifico dell'applicazione.
Valori di ritorno
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 di funzione di callback viene chiamato al termine di una richiesta di aggiornamento del set di dati, segnalando lo stato della richiesta di aggiornamento del set di dati riuscito o non riuscito.

Dettagli
Parametri
[in] aError
Lo stato dell'errore. OT_ERROR_NONE indica un aggiornamento del set di dati riuscito. OT_ERROR_INVALID_STATE indica un errore dovuto a stato non valido (MLE disattivato). 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()).

ID OPEsteso

struct otExtendedPanId otExtendedPanId

Questa struttura rappresenta un ID PAN esteso.

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

Questa struttura rappresenta un prefisso locale mesh.

OtMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

Questa enumerazione rappresenta i tipi di TLV meshcop.

Chiave di rete

struct otNetworkKey otNetworkKey

Questa struttura rappresenta una chiave di rete Thread.

OtNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

Questo tipo di dati rappresenta KeyRef in NetworkKey.

Riferimento alla chiave

NomeRete Ot

struct otNetworkName otNetworkName

Questa struttura rappresenta un Nome di rete.

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

Set di dati otoperativo

struct otOperationalDataset otOperationalDataset

Questa struttura rappresenta un set di dati operativo attivo o in attesa.

I componenti nel set di dati sono facoltativi. La struttura mComponets specifica quali componenti sono presenti nel set di dati.

OtOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

Questa struttura rappresenta la presenza di componenti diversi nel set di dati operativi o in attesa.

OtOperationalDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

Questa struttura rappresenta un set di dati operativo attivo o in attesa.

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

OttPskc

struct otPskc otPskc

Questa struttura rappresenta un PSKc.

OtPskcRef

otCryptoKeyRef otPskcRef

Questo tipo di dati rappresenta KeyRef in PSKc.

Riferimento alla chiave

Criteri di sicurezza ot

struct otSecurityPolicy otSecurityPolicy

Questa struttura rappresenta il criterio di sicurezza.

Timestamp ott

struct otTimestamp otTimestamp

Questa struttura rappresenta un componente di timestamp del set di dati Thread.

Variabili

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

Functions

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Questo metodo crea un nuovo set di dati operativi da utilizzare durante la creazione di una nuova rete.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[out] aDataset
Il set di dati operativo.
Valori di ritorno
OT_ERROR_NONE
Creazione di un nuovo set di dati operativo riuscito.
OT_ERROR_FAILED
Impossibile generare valori casuali per i nuovi parametri.

OtDatasetGeneraPskc

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

Questa funzione genera PSKc da una determinata frase di passaggio, nome di rete e ID PAN esteso.

PSKc viene utilizzato per definire la sessione della commissione.

Dettagli
Parametri
[in] aPassPhrase
La frase di passaggio per la messa in servizio.
[in] aNetworkName
Il nome della rete per il calcolo PSKc.
[in] aExtPanId
L'ID PAN esteso per il calcolo PSKc.
[out] aPskc
Un puntatore che consente di generare una variabile del PSKc generato.
Valori di ritorno
OT_ERROR_NONE
Generazione PSKc riuscita.
OT_ERROR_INVALID_ARGS
Gli argomenti di input non sono validi.

otDatasetGetActive

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Questa funzione riceve il set di dati operativo attivo.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[out] aDataset
Un suggerimento per dove verrà posizionato il set di dati operativo attivo.
Valori di ritorno
OT_ERROR_NONE
Recupero del set di dati operativo attivo riuscito.
OT_ERROR_NOT_FOUND
Nessun valore corrispondente nell'archivio di impostazioni.

otDatasetGetActiveTlvs

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Questa funzione riceve il set di dati operativo attivo.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[out] aDataset
Un suggerimento per dove verrà posizionato il set di dati operativo attivo.
Valori di ritorno
OT_ERROR_NONE
Recupero del set di dati operativo attivo riuscito.
OT_ERROR_NOT_FOUND
Nessun valore corrispondente nell'archivio di impostazioni.

otDatasetGetDelayTimerMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

Calcola un timer di ritardo minimo.

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

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Questa funzione riceve il set di dati operativi in attesa.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[out] aDataset
Un puntatore verso dove verrà posizionato il set di dati operativo in attesa.
Valori di ritorno
OT_ERROR_NONE
Recupero del set di dati operativo in attesa completato.
OT_ERROR_NOT_FOUND
Nessun valore corrispondente nell'archivio di impostazioni.

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Questa funzione riceve il set di dati operativi in attesa.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[out] aDataset
Un puntatore verso dove verrà posizionato il set di dati operativo in attesa.
Valori di ritorno
OT_ERROR_NONE
Recupero del set di dati operativo in attesa completato.
OT_ERROR_NOT_FOUND
Nessun valore corrispondente nell'archivio di impostazioni.

otDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

Questa funzione indica se nel set di dati operativo attivo è presente o meno una rete valida.

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

OtDatasetParseTlvs

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

Questa funzione analizza un set di dati operativi da un otOperationalDatasetTlvs.

Dettagli
Parametri
[in] aDatasetTlvs
Un puntatore sui TLV dei set di dati.
[out] aDataset
Un puntatore nel punto in cui verrà posizionato il set di dati.
Valori di ritorno
OT_ERROR_NONE
aDataset impostato correttamente da aDatasetTlvs.
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
)

Questa funzione invia MGMT_ACTIVE_GET.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aDatasetComponents
Un puntatore su una struttura di componenti di un set di dati che specifica quali componenti richiedere.
[in] aTlvTypes
Un puntatore all'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à ALOC leader come valore predefinito.
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.

otDatasetSendMgmtActiveSet

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

Questa funzione invia MGMT_ACTIVE_SET.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aDataset
Un puntatore sul set di dati operativo.
[in] aTlvs
Un puntatore sui TLV.
[in] aLength
La lunghezza dei TLV.
[in] aCallback
Un puntatore a una funzione chiamata alla ricezione o al timeout della risposta.
[in] aContext
Un puntatore sul contesto specifico per l'applicazione per aCallback.
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_BUSY
È in corso una richiesta precedente.

otDatasetSendMgmtPendingGet

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

Questa funzione invia MGMT_PENDING_GET.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aDatasetComponents
Un puntatore su una struttura di componenti di un set di dati che specifica quali componenti richiedere.
[in] aTlvTypes
Un puntatore all'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à ALOC leader come valore predefinito.
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.

otDatasetSendMgmtPendingSet

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

Questa funzione invia MGMT_PENDING_SET.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aDataset
Un puntatore sul set di dati operativo.
[in] aTlvs
Un puntatore sui TLV.
[in] aLength
La lunghezza dei TLV.
[in] aCallback
Un puntatore a una funzione chiamata alla ricezione o al timeout della risposta.
[in] aContext
Un puntatore sul contesto specifico per l'applicazione per aCallback.
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_BUSY
È in corso una richiesta precedente.

OtDatasetSetActive

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

Questa funzione imposta il set di dati operativo attivo.

Se il set di dati non include un timestamp attivo, il set di dati sarà solo parzialmente completo.

Se l'opzione Thread è abilitata su un dispositivo con un set di dati attivo parzialmente completo, il dispositivo tenterà di collegarsi a una rete Thread esistente utilizzando le informazioni esistenti nel set di dati. Per collegarsi a una rete è necessaria solo la chiave di rete del thread.

Se un canale non è incluso nel set di dati, il dispositivo invierà messaggi di annunci di MLE per diversi canali alla ricerca di vicini di altri.

Se si collega correttamente a una rete Thread, il dispositivo recupererà l'intero set di dati attivo dal relativo elemento principale. Tieni presente che un dispositivo che supporta il router non eseguirà la transizione ai ruoli Router o Leader finché il set di dati attivi non è completo.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aDataset
Un puntatore sul set di dati operativo attivo.
Valori di ritorno
OT_ERROR_NONE
Impostazione del set di dati operativo attivo riuscita.
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à delle impostazioni.

otDatasetSetActiveTlvs

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

Questa funzione imposta il set di dati operativo attivo.

Se il set di dati non include un timestamp attivo, il set di dati sarà solo parzialmente completo.

Se l'opzione Thread è abilitata su un dispositivo con un set di dati attivo parzialmente completo, il dispositivo tenterà di collegarsi a una rete Thread esistente utilizzando le informazioni esistenti nel set di dati. Per collegarsi a una rete è necessaria solo la chiave di rete del thread.

Se un canale non è incluso nel set di dati, il dispositivo invierà messaggi di annunci di MLE per diversi canali alla ricerca di vicini di altri.

Se si collega correttamente a una rete Thread, il dispositivo recupererà l'intero set di dati attivo dal relativo elemento principale. Tieni presente che un dispositivo che supporta il router non eseguirà la transizione ai ruoli Router o Leader finché il set di dati attivi non è completo.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aDataset
Un puntatore sul set di dati operativo attivo.
Valori di ritorno
OT_ERROR_NONE
Impostazione del set di dati operativo attivo riuscita.
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à delle impostazioni.

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

Imposta un timer di ritardo minimo.

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

OtDatasetSetPending

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

Questa funzione imposta il set di dati operativo in attesa.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aDataset
Un puntatore sul set di dati operativo in attesa.
Valori di ritorno
OT_ERROR_NONE
Impostazione del set di dati operativo in attesa riuscita.
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à delle impostazioni.

otDatasetSetPendingTlvs

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

Questa funzione imposta il set di dati operativo in attesa.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aDataset
Un puntatore sul set di dati operativo in attesa.
Valori di ritorno
OT_ERROR_NONE
Impostazione del set di dati operativo in attesa riuscita.
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à delle impostazioni.

otDatasetUpdaterAnnullaUpdate

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

Questa funzione annulla una richiesta di aggiornamento operativo (se presente) in corso.

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

otDatasetUpdaterIsUpdateOncontinue

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

Questa funzione indica se è in corso una richiesta di aggiornamento del set di dati dell'operazione.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Valori di ritorno
TRUE
È in corso un aggiornamento.
FALSE
Nessun aggiornamento in corso.

Aggiornamento otDatasetUpdaterRequest

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

Questa funzione richiede un aggiornamento del set di dati operativi.

aDataset deve contenere i campi da aggiornare e il nuovo valore. Non deve contenere campi Timestamp attivo o In attesa. Il campo Ritardo è facoltativo, se non viene fornito un valore predefinito (1000 ms).

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aDataset
Un puntatore sul set di dati contenente i campi da modificare.
[in] aCallback
Un callback che indica quando termina la richiesta di aggiornamento del set di dati.
[in] aContext
Contesto arbitrario passato per la richiamata.
Valori di ritorno
OT_ERROR_NONE
Aggiornamento del set di dati avviato correttamente (il aCallback verrà richiamato al completamento).
OT_ERROR_INVALID_STATE
Il dispositivo è disattivato (MLE è disattivato).
OT_ERROR_INVALID_ARGS
aDataset non è valido (contiene timestamp attivo o in attesa).
OT_ERROR_BUSY
Impossibile avviare l'aggiornamento: è in corso un evento precedente.
OT_ERROR_NO_BUFS
Impossibile allocare il buffer per salvare il set di dati.

OtNetworkNameFromString

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

Questa funzione imposta un'istanza otNetworkName da una determinata stringa C con terminazione null.

Questa funzione convalida anche che il valore aNameString fornito segue la codifica UTF-8 e la sua lunghezza non è superiore a OT_NETWORK_NAME_MAX_SIZE.

Dettagli
Parametri
[out] aNetworkName
Un puntatore sul otNetworkName da impostare.
[in] aNameString
Una stringa C nome.
Valori di ritorno
OT_ERROR_NONE
aNetworkName impostato correttamente da aNameString.
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_MASCHIA

 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_MASCHIA

 OT_CHANNEL_2_MASK (1 << 2)

Canale 2.

OT_CHANNEL_3_MASCHIA

 OT_CHANNEL_3_MASK (1 << 3)

Canale 3.

OT_CHANNEL_4_MASCHIA

 OT_CHANNEL_4_MASK (1 << 4)

Canale 4.

OT_CHANNEL_5_MASCHIA

 OT_CHANNEL_5_MASK (1 << 5)

Canale 5.

OT_CHANNEL_6_MASK

 OT_CHANNEL_6_MASK (1 << 6)

Canale 6.

OT_CHANNEL_7_MASCHIA

 OT_CHANNEL_7_MASK (1 << 7)

Canale 7.

OT_CHANNEL_8_MASCHIA

 OT_CHANNEL_8_MASK (1 << 8)

Canale 8.

OT_CHANNEL_9_MASCHIA

 OT_CHANNEL_9_MASK (1 << 9)

Canale 9.

OT_EXT_PAN_ID_SIZE

 OT_EXT_PAN_ID_SIZE 8

Dimensioni di un ID PAN di thread (byte)

OT_MESH_LOCAL_PREFIX_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

Dimensioni del prefisso locale mesh (byte)

OT_NETWORK_KEY_SIZE

 OT_NETWORK_KEY_SIZE 16

Dimensioni della chiave di rete del 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 operativi in byte.

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

Dimensione massima del file PSKc (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.