Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Set di dati operativi

Include funzioni per l'API Operational Dataset.

Riepilogo

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

Per le build FTD e MTD, l'API Operational Dataset include funzioni per gestire i set di dati attivi e in attesa e i TLV di 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
Questa enumerazione rappresenta i tipi di TLV meshcop.

Defin

otChannelMask Typedef
uint32_t
Questo tipo rappresenta la maschera di canale.
otDatasetMgmtSetCallback)(otError aResult, void *aContext) Typedef
void(*
Il suggerimento di questa funzione viene richiamato quando si riceve una risposta a una richiesta MGMT_SET o si verifica il timeout.
otDatasetUpdaterCallback)(otError aError, void *aContext) Typedef
void(*
Questo puntatore della funzione di callback viene richiamato quando una richiesta di aggiornamento di un set di dati viene completata, segnalando lo stato della richiesta di aggiornamento del set di dati soltanto se l'operazione è riuscita.
otExtendedPanId Typedef
Questa struttura rappresenta un ID PAN esteso.
otMeshLocalPrefix Typedef
Questa struttura rappresenta un prefisso locale mesh.
otMeshcopTlvType Typedef
Questa enumerazione rappresenta i tipi di TLV meshcop.
otNetworkKey Typedef
struct otNetworkKey
Questa struttura rappresenta una chiave di rete Thread.
otNetworkKeyRef Typedef
Questo tipo di dati rappresenta KeyRef per NetworkKey.
otNetworkName Typedef
struct otNetworkName
Questa struttura rappresenta un nome di rete.
otOperationalDataset Typedef
Questa struttura rappresenta un set di dati operativo attivo o in attesa.
otOperationalDatasetComponents Typedef
Questa struttura rappresenta la presenza di componenti diversi nel set di dati operativi attivi o in attesa.
otOperationalDatasetTlvs Typedef
Questa struttura rappresenta un set di dati operativo attivo o in attesa.
otPskc Typedef
struct otPskc
Questa struttura rappresenta un PSKc.
otPskcRef Typedef
Questo tipo di dati rappresenta KeyRef per PSKc.
otSecurityPolicy Typedef
Questa struttura rappresenta il criterio di sicurezza.
otTimestamp Typedef
struct otTimestamp
Questa struttura rappresenta un componente del timestamp set di dati dei thread.

Variabili

OT_TOOL_PACKED_END

Functions

otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)
Solo per FTD. Crea un nuovo set di dati operativi da utilizzare per 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 pass, nome di rete e ID PAN esteso.
otDatasetGetActive(otInstance *aInstance, otOperationalDataset *aDataset)
Recupera 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
Solo per FTD, visualizza 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)
Invia MGMT_ACTIVE_GET.
otDatasetSendMgmtActiveSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Invia MGMT_ACTIVE_SET.
otDatasetSendMgmtPendingGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Invia MGMT_PENDING_GET.
otDatasetSendMgmtPendingSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Invia MGMT_PENDING_SET.
otDatasetSetActive(otInstance *aInstance, const otOperationalDataset *aDataset)
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)
Solo per FTD, imposta un timer di ritardo minimo.
otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset)
Imposta il set di dati operativo in attesa.
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Questa funzione imposta il set di dati operativi in attesa.
otDatasetUpdaterCancelUpdate(otInstance *aInstance)
void
Questa funzione annulla una richiesta di aggiornamento continuativa (se presente) del set di dati operativi.
otDatasetUpdaterIsUpdateOngoing(otInstance *aInstance)
bool
Questa funzione indica se è in corso una richiesta di aggiornamento di un set di dati operativi.
otDatasetUpdaterRequestUpdate(otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext)
Questa funzione richiede un aggiornamento del set di dati operativo.
otNetworkNameFromString(otNetworkName *aNetworkName, const char *aNameString)
Imposta un'istanza otNetworkName da una determinata stringa C con terminazione null.

Struttura

OtExtendedPanId

Questa struttura rappresenta un ID PAN esteso.

Chiave OtNetwork

Questa struttura rappresenta una chiave di rete Thread.

NomeRete Ot

Questa struttura rappresenta un nome di rete.

Set di dati operativi

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 attivi o in attesa.

otOperationalDatasetTlvs

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

OtPskc

Questa struttura rappresenta PSKc.

Criteri di sicurezza ot

Questa struttura rappresenta il criterio di sicurezza.

Timestamp

Questa struttura rappresenta un componente del timestamp set di dati dei thread.

Enumerazioni

Tipo otMeshcopTlvType

 otMeshcopTlvType

Questa enumerazione rappresenta i tipi di TLV meshcop.

Proprietà
OT_MESHCOP_TLV_ACTIVETIMESTAMP

Timestamp TLV attivo meshcop

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

Localizzatore di agenti di frontiera meshcop

OT_MESHCOP_TLV_CHANNEL

TLV del canale meshcop

OT_MESHCOP_TLV_CHANNELMASK

Maschera del canale meshcop TLV

OT_MESHCOP_TLV_COMMISSIONER_ID

ID Commissioner meshcop TLV

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

Meshcop Commissioner UDP Port TLV

OT_MESHCOP_TLV_COMM_SESSION_ID

ID sessione Commissioner meshcop

OT_MESHCOP_TLV_COUNT

Conteggio TLV meshcop

OT_MESHCOP_TLV_DELAYTIMER

Timer TLV meshcop

OT_MESHCOP_TLV_DISCOVERYREQUEST

TLV - Richiesta di rilevamento meshcop

OT_MESHCOP_TLV_DISCOVERYRESPONSE

TLV di rilevamento meshcop

OT_MESHCOP_TLV_ENERGY_LIST

Elenco di energia TLV meshcop

OT_MESHCOP_TLV_EXTPANID

ID Panning esteso meshcop

OT_MESHCOP_TLV_GET

meshcop Ottieni TLV

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

TLV indirizzo IPv6 meshcop

OT_MESHCOP_TLV_JOINERADVERTISEMENT

TLV pubblicitario per joiner meshcop

OT_MESHCOP_TLV_JOINER_DTLS

TLV per incapsulamento DTLS meshcop

OT_MESHCOP_TLV_JOINER_IID

TLV IDI Joiner meshcop

OT_MESHCOP_TLV_JOINER_RLOC

Localizzatore router TLV meshcop

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

Router mesh Joint KEK TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

TLV porta UDP meshcocoer Joiner

OT_MESHCOP_TLV_MESHLOCALPREFIX

Prefisso locale TLV meshcop

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

ID TLV meshcop

OT_MESHCOP_TLV_PENDINGTIMESTAMP

Timestamp TLV in attesa di meshcop

OT_MESHCOP_TLV_PERIOD

TLV periodo 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

TLV - Criterio di sicurezza meshcop

OT_MESHCOP_TLV_STATE

TLV stato meshcop

OT_MESHCOP_TLV_STEERING_DATA

Dati TLV meshcop

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

TLV di incapsulamento UDP meshcop

OT_MESHCOP_TLV_VENDOR_DATA_TLV

Dati TLV del fornitore meshcop

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

Modello TLV del fornitore meshcop

OT_MESHCOP_TLV_VENDOR_NAME_TLV

Nome fornitore TLV meshcop

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

Versione TLV fornitore fornitore meshcop

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

Versione SW del fornitore TLV di meshcop

Defin

OtChannelMask

uint32_t otChannelMask

Questo tipo rappresenta la maschera di canale.

otDatasetMgmtSetRichiama

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

Il suggerimento di questa funzione viene richiamato quando si riceve una risposta a una richiesta MGMT_SET o si verifica il timeout.

Dettagli
Parametri
[in] aResult
Un 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
Non è stata ricevuta alcuna risposta o conferma durante il periodo di timeout.

otDatasetUpdaterCallback

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

Questo puntatore della funzione di callback viene richiamato quando una richiesta di aggiornamento di un set di dati viene completata, segnalando lo stato della richiesta di aggiornamento del set di dati soltanto se l'operazione è riuscita.

Disponibile quando OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE è attivato.

Dettagli
Parametri
[in] aError
Lo stato dell'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 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()).

IDPan esteso

struct otExtendedPanId otExtendedPanId

Questa struttura rappresenta un ID PAN esteso.

Prefisso locale otMesh

otIp6NetworkPrefix otMeshLocalPrefix

Questa struttura rappresenta un prefisso locale mesh.

Tipo otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

Questa enumerazione rappresenta i tipi di TLV meshcop.

Chiave OtNetwork

struct otNetworkKey otNetworkKey

Questa struttura rappresenta una chiave di rete Thread.

OtNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

Questo tipo di dati rappresenta KeyRef per NetworkKey.

Riferimento a chiave

NomeRete Ot

struct otNetworkName otNetworkName

Questa struttura rappresenta un nome di rete.

otNetworkName è una stringa C terminata 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 del 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 attivi o in attesa.

OtOperationsDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

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

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

OtPskc

struct otPskc otPskc

Questa struttura rappresenta un PSKc.

OtPskcRef

otCryptoKeyRef otPskcRef

Questo tipo di dati rappresenta KeyRef per PSKc.

Riferimento a chiave

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

Questa struttura rappresenta il criterio di sicurezza.

Timestamp otti

struct otTimestamp otTimestamp

Questa struttura rappresenta un componente del timestamp set di dati dei thread.

Variabili

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

Functions

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Solo per FTD. Crea un nuovo set di dati operativi da utilizzare per 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.

otDatasetGeneraPskc

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

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

Il PSKc viene utilizzato per definire la sessione della Commissione.

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

otDatasetGetActive

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Recupera il set di dati operativo attivo.

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

otDatasetGetActiveTlvs

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Questa funzione riceve il set di dati operativo attivo.

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

otDatasetGetDelayTimerMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

Solo per FTD, visualizza un timer di 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
)

Questa funzione riceve il set di dati operativi in attesa.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[out] aDataset
Un puntatore che indica dove verrà posizionato il set di dati operativo in attesa.
Valori restituiti
OT_ERROR_NONE
Recupero del set di dati operativo in attesa riuscito.
OT_ERROR_NOT_FOUND
Nessun valore corrispondente nell'archivio delle impostazioni.

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Questa funzione riceve il set di dati operativi in attesa.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[out] aDataset
Un puntatore che indica dove verrà posizionato il set di dati operativo in attesa.
Valori restituiti
OT_ERROR_NONE
Recupero del set di dati operativo in attesa riuscito.
OT_ERROR_NOT_FOUND
Nessun valore corrispondente nell'archivio delle 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 a un'istanza OpenThread.
Restituisce
TRUE se nel set di dati operativo attivo è presente una rete valida, FALSE in caso contrario.

OtDatasetParseTlv

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

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

Dettagli
Parametri
[in] aDatasetTlvs
Un puntatore ai TLV dei set di dati.
[out] aDataset
Un puntatore che indica dove verrà posizionato il set di dati.
Valori restituiti
OT_ERROR_NONE
Impostazione aDataset di 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 alla struttura dei componenti del set di dati che specifica quali componenti richiedere.
[in] aTlvTypes
Un puntatore a un array che contiene 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 come valore predefinito.
Valori restituiti
OT_ERROR_NONE
Invio del comando del set di dati meshcop riuscito.
OT_ERROR_NO_BUFS
Spazio del buffer insufficiente da inviare.

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 al set di dati operativo.
[in] aTlvs
Un puntatore ai 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 al contesto specifico dell'applicazione per aCallback.
Valori restituiti
OT_ERROR_NONE
Invio del comando del set di dati meshcop riuscito.
OT_ERROR_NO_BUFS
Spazio del 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
)

Invia MGMT_PENDING_GET.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aDatasetComponents
Un puntatore alla struttura dei componenti del set di dati che specifica quali componenti richiedere.
[in] aTlvTypes
Un puntatore a un array che contiene 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 come valore predefinito.
Valori restituiti
OT_ERROR_NONE
Invio del comando del set di dati meshcop riuscito.
OT_ERROR_NO_BUFS
Spazio del buffer insufficiente da inviare.

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 al set di dati operativo.
[in] aTlvs
Un puntatore ai 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 al contesto specifico dell'applicazione per aCallback.
Valori restituiti
OT_ERROR_NONE
Invio del comando del set di dati meshcop riuscito.
OT_ERROR_NO_BUFS
Spazio del buffer insufficiente da inviare.
OT_ERROR_BUSY
È in corso una richiesta precedente.

otSetSetSetAttivo

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

Imposta il set di dati operativo attivo.

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

Se viene attivato il thread 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 il collegamento a una rete è necessaria solo la chiave di rete Thread.

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

Se il dispositivo riesce a collegarsi a una rete Thread, recupera il set di dati attivo completo dal dispositivo principale. Tieni presente che un dispositivo compatibile con 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 attivo attivo riuscito.
OT_ERROR_NO_BUFS
Margine insufficiente per l'impostazione del set di dati operativo attivo.
OT_ERROR_NOT_IMPLEMENTED
La piattaforma non implementa 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 è solo parzialmente completo.

Se viene attivato il thread 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 il collegamento a una rete è necessaria solo la chiave di rete Thread.

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

Se il dispositivo riesce a collegarsi a una rete Thread, recupera il set di dati attivo completo dal dispositivo principale. Tieni presente che un dispositivo compatibile con 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 attivo attivo riuscito.
OT_ERROR_NO_BUFS
Margine insufficiente per l'impostazione del set di dati operativo attivo.
OT_ERROR_NOT_IMPLEMENTED
La piattaforma non implementa funzionalità delle impostazioni.

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

Solo per FTD, imposta un timer di ritardo minimo.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aDelayTimerMinimal
Il 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.

otSetSetSetIn sospeso

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
Il set di dati operativi in attesa è stato impostato correttamente.
OT_ERROR_NO_BUFS
Spazio del buffer insufficiente per impostare il set di dati operativo in attesa.
OT_ERROR_NOT_IMPLEMENTED
La piattaforma non implementa funzionalità delle impostazioni.

otDatasetSetPendingTlvs

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

Questa funzione imposta il set di dati operativi 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
Il set di dati operativi in attesa è stato impostato correttamente.
OT_ERROR_NO_BUFS
Spazio del buffer insufficiente per impostare il set di dati operativo in attesa.
OT_ERROR_NOT_IMPLEMENTED
La piattaforma non implementa funzionalità delle impostazioni.

otDatasetUpdaterAnnullaAggiorna

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

Questa funzione annulla una richiesta di aggiornamento continuativa (se presente) del set di dati operativi.

Disponibile quando OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE è attivato.

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

otDatasetUpdaterIsUpdateOnward

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

Questa funzione indica se è in corso una richiesta di aggiornamento di un set di dati operativi.

Disponibile quando OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE è attivato.

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

otDatasetUpdaterRequestUpdate

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

Questa funzione richiede un aggiornamento del set di dati operativo.

Disponibile quando OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE è attivato.

aDataset deve contenere i campi da aggiornare e il relativo nuovo valore. Non deve contenere i 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 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
Contesto arbitrario trasmesso al callback.
Valori restituiti
OT_ERROR_NONE
Aggiornamento del set di dati avviato correttamente (aCallback verrà richiamato al completamento).
OT_ERROR_INVALID_STATE
Dispositivo disattivato (MLE disattivato).
OT_ERROR_INVALID_ARGS
aDataset non è valido (contiene timestamp attivo o in attesa).
OT_ERROR_BUSY
Impossibile avviare l'aggiornamento. Uno precedente è in corso.
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 con terminazione null.

aNameString deve seguire la codifica UTF-8 e la lunghezza del nome della rete non deve essere più lunga di OT_NETWORK_NAME_MAX_SIZE.

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

Macro

OT_CHANNEL_10_MASSA

 OT_CHANNEL_10_MASK (1 << 10)

Canale 10.

OT_CHANNEL_11_MASSA

 OT_CHANNEL_11_MASK (1 << 11)

Canale 11.

OT_CHANNEL_12_MASSA

 OT_CHANNEL_12_MASK (1 << 12)

Canale 12.

OT_CANALE_13_MASCHERA

 OT_CHANNEL_13_MASK (1 << 13)

Canale 13.

OT_CHANNEL_14_MASSA

 OT_CHANNEL_14_MASK (1 << 14)

Canale 14.

OT_CHANNEL_15_MASSA

 OT_CHANNEL_15_MASK (1 << 15)

Canale 15.

OT_CHANNEL_16_MASSA

 OT_CHANNEL_16_MASK (1 << 16)

Canale 16.

OT_CHANNEL_17_MASSA

 OT_CHANNEL_17_MASK (1 << 17)

Canale 17.

OT_CANALE_18_MASCHERA

 OT_CHANNEL_18_MASK (1 << 18)

Canale 18.

OT_CHANNEL_19_MASSA

 OT_CHANNEL_19_MASK (1 << 19)

Canale 19.

OT_CHANNEL_1_MASSA

 OT_CHANNEL_1_MASK (1 << 1)

Canale 1.

OT_CANALE_20_MASCHERA

 OT_CHANNEL_20_MASK (1 << 20)

Canale 20.

OT_CHANNEL_21_MASSA

 OT_CHANNEL_21_MASK (1 << 21)

Canale 21.

OT_CHANNEL_22_MASSA

 OT_CHANNEL_22_MASK (1 << 22)

Canale 22.

OT_CANALE_23_MASCHERA

 OT_CHANNEL_23_MASK (1 << 23)

Canale 23.

OT_CHANNEL_24_MASSA

 OT_CHANNEL_24_MASK (1 << 24)

Canale 24.

OT_CHANNEL_25_MASSA

 OT_CHANNEL_25_MASK (1 << 25)

Canale 25.

OT_CANALE_26_MASCHERA

 OT_CHANNEL_26_MASK (1 << 26)

Canale 26.

OT_CHANNEL_2_MASSA

 OT_CHANNEL_2_MASK (1 << 2)

Canale 2.

OT_CHANNEL_3_MASSA

 OT_CHANNEL_3_MASK (1 << 3)

Canale 3.

OT_CHANNEL_4_MASSA

 OT_CHANNEL_4_MASK (1 << 4)

Canale 4.

OT_CHANNEL_5_MASSA

 OT_CHANNEL_5_MASK (1 << 5)

Canale 5.

OT_CANALE_6_MASCHERA

 OT_CHANNEL_6_MASK (1 << 6)

Canale 6.

OT_CHANNEL_7_MASSA

 OT_CHANNEL_7_MASK (1 << 7)

Canale 7.

OT_CANALE_8_MASCHERA

 OT_CHANNEL_8_MASK (1 << 8)

Canale 8.

OT_CHANNEL_9_MASSA

 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

Dimensione massima del campo Thread Rete Nome (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 PSKc (byte)

Risorse

Gli argomenti di riferimento dell'API OpenThread provengono dal codice sorgente, disponibile su GitHub. Per scoprire di più o per contribuire alla nostra documentazione, consulta le Risorse.