Ensemble de données opérationnel

Inclut des fonctions pour l'API Operational Dataset.

Résumé

Pour les builds FTD uniquement, le programme de mise à jour d'ensembles de données inclut des fonctions permettant de gérer les mises à jour des ensembles de données.

Pour les builds FTD et MTD, l'API Operational Dataset comprend des fonctions permettant de gérer les ensembles de données actifs et en attente, ainsi que les TLV des ensembles de données.

Énumérations
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
Représente les types de TLV de maillagecop.

Typedefs
otChannelMask typedef
uint32_t
Représente le masque de canal.
otDatasetMgmtSetCallback)(otError aResult, void *aContext) typedef
void(*
Le pointeur est appelé lorsqu'une réponse à une requête MGMT_SET est reçue ou expire.
otDatasetUpdaterCallback)(otError aError, void *aContext) typedef
void(*
Ce pointeur de fonction de rappel est appelé lorsqu'une requête de mise à jour d'ensemble de données se termine, indiquant ainsi l'état de réussite ou d'échec.
otExtendedPanId typedef
Représente un ID de PAN étendu.
otMeshLocalPrefix typedef
Représente un préfixe local de maillage.
otMeshcopTlvType typedef
Représente les types de TLV de maillagecop.
otNetworkKey typedef
struct otNetworkKey
Représente une clé de réseau Thread.
otNetworkKeyRef typedef
Ce type de données représente KeyRef à NetworkKey.
otNetworkName typedef
struct otNetworkName
Représente un nom de réseau.
otOperationalDataset typedef
Représente un ensemble de données opérationnel actif ou en attente.
otOperationalDatasetComponents typedef
Représente la présence de différents composants dans l'ensemble de données opérationnel actif ou en attente.
otOperationalDatasetTlvs typedef
Représente un ensemble de données opérationnel actif ou en attente.
otPskc typedef
struct otPskc
Représente une clé PSKc.
otPskcRef typedef
Ce type de données représente KeyRef dans PSKc.
otSecurityPolicy typedef
Représente la stratégie de sécurité.
otTimestamp typedef
struct otTimestamp
Représente un composant d'horodatage d'ensemble de données Thread.

Variables
OT_TOOL_PACKED_END

distantes
otDatasetConvertToTlvs(const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)
Convertit un ensemble de données opérationnel donné en otOperationalDatasetTlvs.
otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)
Pour FTD uniquement, crée un ensemble de données opérationnel à utiliser lors de la création d'un réseau.
otDatasetGeneratePskc(const char *aPassPhrase, const otNetworkName *aNetworkName, const otExtendedPanId *aExtPanId, otPskc *aPskc)
Génère une clé PSKc à partir d'une phrase de passe, d'un nom de réseau et d'un ID de PAN étendu.
otDatasetGetActive(otInstance *aInstance, otOperationalDataset *aDataset)
Récupère l'ensemble de données opérationnel actif.
otDatasetGetActiveTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Récupère l'ensemble de données opérationnel actif.
otDatasetGetDelayTimerMinimal(otInstance *aInstance)
uint32_t
Pour les FTD uniquement, obtient un délai minimal.
otDatasetGetPending(otInstance *aInstance, otOperationalDataset *aDataset)
Récupère l'ensemble de données opérationnel en attente.
otDatasetGetPendingTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Récupère l'ensemble de données opérationnel en attente.
otDatasetIsCommissioned(otInstance *aInstance)
bool
Indique si un réseau valide figure ou non dans l'ensemble de données opérationnel actif.
otDatasetParseTlvs(const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)
Analyse un ensemble de données opérationnel à partir d'un otOperationalDatasetTlvs donné.
otDatasetSendMgmtActiveGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Envoie MGMT_ACTIVE_GET.
otDatasetSendMgmtActiveSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Envoie MGMT_ACTIVE_SET.
otDatasetSendMgmtPendingGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Envoie MGMT_PENDING_GET.
otDatasetSendMgmtPendingSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Envoie MGMT_PENDING_SET.
otDatasetSetActive(otInstance *aInstance, const otOperationalDataset *aDataset)
Définit l'ensemble de données opérationnel actif.
otDatasetSetActiveTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Définit l'ensemble de données opérationnel actif.
otDatasetSetDelayTimerMinimal(otInstance *aInstance, uint32_t aDelayTimerMinimal)
Pour les valeurs FTD uniquement, définit un délai minimal.
otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset)
Définit l'ensemble de données opérationnel en attente.
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Définit l'ensemble de données opérationnel en attente.
otDatasetUpdateTlvs(const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)
Met à jour un ensemble de données opérationnel donné.
otDatasetUpdaterCancelUpdate(otInstance *aInstance)
void
Annule une requête de mise à jour d'un ensemble de données opérationnel en cours (le cas échéant).
otDatasetUpdaterIsUpdateOngoing(otInstance *aInstance)
bool
Indique si une requête de mise à jour de l'ensemble de données d'opération est en cours.
otDatasetUpdaterRequestUpdate(otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext)
Demande une mise à jour de l'ensemble de données opérationnel.
otNetworkNameFromString(otNetworkName *aNetworkName, const char *aNameString)
Définit une instance otNetworkName à partir d'une chaîne C se terminant par une valeur nulle donnée.

Structs
otExtendedPanId

Représente un ID de PAN étendu.

otNetworkKey

Représente une clé de réseau Thread.

otNetworkName

Représente un nom de réseau.

otOperationalDataset

Représente un ensemble de données opérationnel actif ou en attente.

otOperationalDatasetComponents

Représente la présence de différents composants dans l'ensemble de données opérationnel actif ou en attente.

otOperationalDatasetTlvs

Représente un ensemble de données opérationnel actif ou en attente.

otPskc

Représente PSKc.

otSecurityPolicy

Représente la stratégie de sécurité.

otTimestamp

Représente un composant d'horodatage d'ensemble de données Thread.

Énumérations

otMeshcopTlvType

 otMeshcopTlvType

Représente les types de TLV de maillagecop.

Propriétés
OT_MESHCOP_TLV_ACTIVETIMESTAMP

TLV de code temporel actif de meshcop

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

Meshcop Border Agent Locator TLV

OT_MESHCOP_TLV_CHANNEL

Meshcop Channel TLV

OT_MESHCOP_TLV_CHANNELMASK

Masque de canal maillécop

OT_MESHCOP_TLV_COMMISSIONER_ID

ID de commissaire maillécop TLV

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

Port UDP du commissaire maillécop TLV

OT_MESHCOP_TLV_COMM_SESSION_ID

ID de session du commissaire maillécop TLV

OT_MESHCOP_TLV_COUNT

Countcop TLV

OT_MESHCOP_TLV_DELAYTIMER

Retardateur délai maillé TLV

OT_MESHCOP_TLV_DISCOVERYREQUEST

TLV de la requête de découverte maillagecop

OT_MESHCOP_TLV_DISCOVERYRESPONSE

Réponses aux requêtes de découverte de maillagecop

OT_MESHCOP_TLV_ENERGY_LIST

Liste d'énergie maillécop TLV

OT_MESHCOP_TLV_EXTPANID

ID de panoramique étendu maillécop (TLV)

OT_MESHCOP_TLV_GET

maillagecop Obtenir le TLV

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

TLV de l'adresse IPv6 Meshcop

OT_MESHCOP_TLV_JOINERADVERTISEMENT

TLV de l'annonce de jointure de maillagecop

OT_MESHCOP_TLV_JOINER_DTLS

Encapsulation DTLS de jonction maillécop (TLV)

OT_MESHCOP_TLV_JOINER_IID

Jointures maillées IID TLV

OT_MESHCOP_TLV_JOINER_RLOC

Locator de routeur de jointures maillécop TLV

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

Routeur de jointures maillécop KEK TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

Port UDP de jonction maillécop (TLV)

OT_MESHCOP_TLV_MESHLOCALPREFIX

TLV du préfixe local du maillage maillé

OT_MESHCOP_TLV_NETWORKKEY

TLV de clé réseau maillécop

OT_MESHCOP_TLV_NETWORKNAME

Nom du réseau maillé TLV

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE

TLV de la séquence de clés du réseau maillécop

OT_MESHCOP_TLV_PANID

Maillage Pan ID TLV

OT_MESHCOP_TLV_PENDINGTIMESTAMP

Meshcop Pending Timestamp TLV

OT_MESHCOP_TLV_PERIOD

Période maillécop TLV

OT_MESHCOP_TLV_PROVISIONING_URL

TLV de l'URL de provisionnement maillagecop

OT_MESHCOP_TLV_PSKC

Meshcop PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

Durée de l'analyse maillécop TLV

OT_MESHCOP_TLV_SECURITYPOLICY

Règle de sécurité maillécop TLV

OT_MESHCOP_TLV_STATE

Meshcop State TLV

OT_MESHCOP_TLV_STEERING_DATA

Meshcop Steering Data TLV

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

TLV d'encapsulation UDP Meshcop

OT_MESHCOP_TLV_VENDOR_DATA_TLV

Fournisseur de données en ligne maillécop

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

Modèle TLV du fournisseur maillécop

OT_MESHCOP_TLV_VENDOR_NAME_TLV

Nom du fournisseur maillécop TLV

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

Meshcop Vendor Stack Version TLV

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

Fournisseur de maillagecop version TLV du logiciel

Typedefs

otChannelMask

uint32_t otChannelMask

Représente le masque de canal.

otDatasetMgmtSetCallback

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

Le pointeur est appelé lorsqu'une réponse à une requête MGMT_SET est reçue ou expire.

Détails
Paramètres
[in] aResult
Résultat de l'opération.
[in] aContext
Pointeur vers un contexte spécifique à l'application.
Valeurs de retour
OT_ERROR_NONE
La requête a été acceptée par la variante optimale.
OT_ERROR_REJECTED
La requête a été refusée par la variante optimale.
OT_ERROR_PARSE
Une erreur s'est produite lors de l'analyse de la réponse.
OT_ERROR_ABORT
La requête a été réinitialisée par l'homologue.
OT_ERROR_RESPONSE_TIMEOUT
Aucune réponse ou accusé de réception reçu pendant le délai avant expiration.

otDatasetUpdaterCallback

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

Ce pointeur de fonction de rappel est appelé lorsqu'une requête de mise à jour d'ensemble de données se termine, indiquant ainsi l'état de réussite ou d'échec.

Disponible lorsque OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE est activé.

Détails
Paramètres
[in] aError
État d'erreur. OT_ERROR_NONE indique que l'ensemble de données a bien été mis à jour. OT_ERROR_INVALID_STATE indique un échec dû à un état non valide (MLE en cours de désactivation). OT_ERROR_ALREADY indique un échec dû à un autre appareil du réseau qui demande une mise à jour en conflit de l'ensemble de données.
[in] aContext
Pointeur vers le contexte arbitraire (fourni par l'utilisateur dans otDatasetUpdaterRequestUpdate()).

otExtendedPanId

struct otExtendedPanId otExtendedPanId

Représente un ID de PAN étendu.

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

Représente un préfixe local de maillage.

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

Représente les types de TLV de maillagecop.

otNetworkKey

struct otNetworkKey otNetworkKey

Représente une clé de réseau Thread.

otNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

Ce type de données représente KeyRef à NetworkKey.

Référence à la clé

otNetworkName

struct otNetworkName otNetworkName

Représente un nom de réseau.

otNetworkName est une chaîne C se terminant par une valeur nulle (par exemple, Le tableau de caractères m8 DOIT se terminer par une valeur nulle \0).

otOperationalDataset

struct otOperationalDataset otOperationalDataset

Représente un ensemble de données opérationnel actif ou en attente.

Les composants d'un ensemble de données sont facultatifs. La structure mComponents spécifie les composants présents dans l'ensemble de données.

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

Représente la présence de différents composants dans l'ensemble de données opérationnel actif ou en attente.

otOperationalDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

Représente un ensemble de données opérationnel actif ou en attente.

L'ensemble de données opérationnel est encodé en TLV comme spécifié par Thread.

otPskc

struct otPskc otPskc

Représente une clé PSKc.

otPskcRef

otCryptoKeyRef otPskcRef

Ce type de données représente KeyRef dans PSKc.

Référence à la clé

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

Représente la stratégie de sécurité.

otTimestamp

struct otTimestamp otTimestamp

Représente un composant d'horodatage d'ensemble de données Thread.

Variables

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

distantes

otDatasetConvertToTlvs

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

Convertit un ensemble de données opérationnel donné en otOperationalDatasetTlvs.

Détails
Paramètres
[in] aDataset
Ensemble de données opérationnel à convertir en TLV.
[out] aDatasetTlvs
Un pointeur vers les TLV de l'ensemble de données pour renvoyer le résultat.
Valeurs de retour
OT_ERROR_NONE
aDataset a bien été converti et mis à jour aDatasetTlvs.
OT_ERROR_INVALID_ARGS
aDataset n'est pas valide, ne contient pas d'horodatage actif ou en attente.

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Pour FTD uniquement, crée un ensemble de données opérationnel à utiliser lors de la création d'un réseau.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[out] aDataset
Ensemble de données opérationnel.
Valeurs de retour
OT_ERROR_NONE
L'ensemble de données opérationnel a bien été créé.
OT_ERROR_FAILED
Échec de la génération de valeurs aléatoires pour les nouveaux paramètres.

otDatasetGeneratePskc

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

Génère une clé PSKc à partir d'une phrase de passe, d'un nom de réseau et d'un ID de PAN étendu.

La clé PSKc est utilisée pour établir la session du commissaire.

Détails
Paramètres
[in] aPassPhrase
La phrase secrète de mise en service.
[in] aNetworkName
Nom du réseau utilisé pour le calcul PSKc.
[in] aExtPanId
ID de PAN étendu pour le calcul PSKc.
[out] aPskc
Pointeur vers une variable permettant de générer la clé PSKc générée.
Valeurs de retour
OT_ERROR_NONE
La clé PSKc a bien été générée.
OT_ERROR_INVALID_ARGS
Si l'un des arguments d'entrée n'est pas valide.

otDatasetGetActive

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Récupère l'ensemble de données opérationnel actif.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[out] aDataset
Pointeur vers l'emplacement de l'ensemble de données opérationnel actif.
Valeurs de retour
OT_ERROR_NONE
L'ensemble de données opérationnel actif a bien été récupéré.
OT_ERROR_NOT_FOUND
Aucune valeur correspondante dans le magasin des paramètres.

otDatasetGetActiveTlvs

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Récupère l'ensemble de données opérationnel actif.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[out] aDataset
Pointeur vers l'emplacement de l'ensemble de données opérationnel actif.
Valeurs de retour
OT_ERROR_NONE
L'ensemble de données opérationnel actif a bien été récupéré.
OT_ERROR_NOT_FOUND
Aucune valeur correspondante dans le magasin des paramètres.

otDatasetGetDelayTimerMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

Pour les FTD uniquement, obtient un délai minimal.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Valeurs de retour
the
valeur du délai minimal (en ms).

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Récupère l'ensemble de données opérationnel en attente.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[out] aDataset
Pointeur vers l'emplacement de l'ensemble de données opérationnel en attente.
Valeurs de retour
OT_ERROR_NONE
L'ensemble de données opérationnel en attente a bien été récupéré.
OT_ERROR_NOT_FOUND
Aucune valeur correspondante dans le magasin des paramètres.

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Récupère l'ensemble de données opérationnel en attente.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[out] aDataset
Pointeur vers l'emplacement de l'ensemble de données opérationnel en attente.
Valeurs de retour
OT_ERROR_NONE
L'ensemble de données opérationnel en attente a bien été récupéré.
OT_ERROR_NOT_FOUND
Aucune valeur correspondante dans le magasin des paramètres.

otDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

Indique si un réseau valide figure ou non dans l'ensemble de données opérationnel actif.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
"TRUE" si un réseau valide est présent dans l'ensemble de données opérationnel actif, "FALSE" dans le cas contraire.

otDatasetParseTlvs

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

Analyse un ensemble de données opérationnel à partir d'un otOperationalDatasetTlvs donné.

Détails
Paramètres
[in] aDatasetTlvs
Pointeur vers les TLV de l'ensemble de données.
[out] aDataset
Pointeur vers l'emplacement de l'ensemble de données.
Valeurs de retour
OT_ERROR_NONE
aDataset a bien été défini à partir de aDatasetTlvs.
OT_ERROR_INVALID_ARGS
aDatasetTlvs non valide.

otDatasetSendMgmtActiveGet

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

Envoie MGMT_ACTIVE_GET.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aDatasetComponents
Pointeur vers une structure de composants d'ensemble de données spécifiant les composants à demander.
[in] aTlvTypes
Pointeur vers un tableau contenant d'autres types de TLV bruts à demander.
[in] aLength
Longueur de aTlvTypes.
[in] aAddress
Un pointeur vers la destination IPv6, s'il est NULL, utilisera la valeur ALOC principale par défaut.
Valeurs de retour
OT_ERROR_NONE
La commande de l'ensemble de données meshcop a bien été envoyée.
OT_ERROR_NO_BUFS
Espace de mémoire tampon insuffisant pour envoyer.

otDatasetSendMgmtActiveSet

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

Envoie MGMT_ACTIVE_SET.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aDataset
Un pointeur vers un ensemble de données opérationnel.
[in] aTlvs
Point sur les TLV.
[in] aLength
La durée des TLV.
[in] aCallback
Pointeur vers une fonction appelée à la réception ou au délai d'inactivité de la réponse.
[in] aContext
Pointeur vers un contexte spécifique à l'application pour aCallback.
Valeurs de retour
OT_ERROR_NONE
La commande de l'ensemble de données meshcop a bien été envoyée.
OT_ERROR_NO_BUFS
Espace de mémoire tampon insuffisant pour envoyer.
OT_ERROR_BUSY
Une demande précédente est en cours.

otDatasetSendMgmtPendingGet

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

Envoie MGMT_PENDING_GET.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aDatasetComponents
Pointeur vers une structure de composants d'ensemble de données spécifiant les composants à demander.
[in] aTlvTypes
Pointeur vers un tableau contenant d'autres types de TLV bruts à demander.
[in] aLength
Longueur de aTlvTypes.
[in] aAddress
Un pointeur vers la destination IPv6, s'il est NULL, utilisera la valeur ALOC principale par défaut.
Valeurs de retour
OT_ERROR_NONE
La commande de l'ensemble de données meshcop a bien été envoyée.
OT_ERROR_NO_BUFS
Espace de mémoire tampon insuffisant pour envoyer.

otDatasetSendMgmtPendingSet

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

Envoie MGMT_PENDING_SET.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aDataset
Un pointeur vers un ensemble de données opérationnel.
[in] aTlvs
Point sur les TLV.
[in] aLength
La durée des TLV.
[in] aCallback
Pointeur vers une fonction appelée à la réception ou au délai d'inactivité de la réponse.
[in] aContext
Pointeur vers un contexte spécifique à l'application pour aCallback.
Valeurs de retour
OT_ERROR_NONE
La commande de l'ensemble de données meshcop a bien été envoyée.
OT_ERROR_NO_BUFS
Espace de mémoire tampon insuffisant pour envoyer.
OT_ERROR_BUSY
Une demande précédente est en cours.

otDatasetSetActive

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

Définit l'ensemble de données opérationnel actif.

Si l'ensemble de données n'inclut pas de code temporel actif, il n'est que partiellement complet.

Si Thread est activé sur un appareil qui dispose d'un ensemble de données actif partiellement complet, l'appareil tente de se connecter à un réseau Thread existant à l'aide des informations de l'ensemble de données. Seule la clé réseau Thread est nécessaire pour établir une connexion à un réseau.

Si le canal n'est pas inclus dans l'ensemble de données, l'appareil envoie des messages d'annonce MLE sur différents canaux pour trouver les voisins sur d'autres canaux.

Si l'appareil se connecte correctement à un réseau Thread, il récupère l'ensemble de données actif complet auprès de son parent. Notez qu'un appareil compatible avec les routeurs ne passera pas au rôle Routeur ou Dirigeant tant qu'il ne disposera pas d'un ensemble de données actif complet.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aDataset
Un pointeur vers l'ensemble de données opérationnel actif.
Valeurs de retour
OT_ERROR_NONE
L'ensemble de données opérationnel actif a bien été défini.
OT_ERROR_NO_BUFS
Espace tampon insuffisant pour définir l'ensemble de données opérationnel actif.
OT_ERROR_NOT_IMPLEMENTED
La plate-forme n'implémente pas de fonctionnalité de paramétrage.

otDatasetSetActiveTlvs

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

Définit l'ensemble de données opérationnel actif.

Si l'ensemble de données n'inclut pas de code temporel actif, il n'est que partiellement complet.

Si Thread est activé sur un appareil qui dispose d'un ensemble de données actif partiellement complet, l'appareil tente de se connecter à un réseau Thread existant à l'aide des informations de l'ensemble de données. Seule la clé réseau Thread est nécessaire pour établir une connexion à un réseau.

Si le canal n'est pas inclus dans l'ensemble de données, l'appareil envoie des messages d'annonce MLE sur différents canaux pour trouver les voisins sur d'autres canaux.

Si l'appareil se connecte correctement à un réseau Thread, il récupère l'ensemble de données actif complet auprès de son parent. Notez qu'un appareil compatible avec les routeurs ne passera pas au rôle Routeur ou Dirigeant tant qu'il ne disposera pas d'un ensemble de données actif complet.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aDataset
Un pointeur vers l'ensemble de données opérationnel actif.
Valeurs de retour
OT_ERROR_NONE
L'ensemble de données opérationnel actif a bien été défini.
OT_ERROR_NO_BUFS
Espace tampon insuffisant pour définir l'ensemble de données opérationnel actif.
OT_ERROR_NOT_IMPLEMENTED
La plate-forme n'implémente pas de fonctionnalité de paramétrage.

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

Pour les valeurs FTD uniquement, définit un délai minimal.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aDelayTimerMinimal
Valeur du délai minimal du délai (en ms).
Valeurs de retour
OT_ERROR_NONE
Le délai minimal a bien été défini.
OT_ERROR_INVALID_ARGS
Si aDelayTimerMinimal n'est pas valide.

otDatasetSetPending

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

Définit l'ensemble de données opérationnel en attente.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aDataset
Pointeur vers l'ensemble de données opérationnel en attente.
Valeurs de retour
OT_ERROR_NONE
L'ensemble de données opérationnel en attente a bien été défini.
OT_ERROR_NO_BUFS
Espace tampon insuffisant pour définir l'ensemble de données opérationnel en attente.
OT_ERROR_NOT_IMPLEMENTED
La plate-forme n'implémente pas de fonctionnalité de paramétrage.

otDatasetSetPendingTlvs

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

Définit l'ensemble de données opérationnel en attente.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aDataset
Pointeur vers l'ensemble de données opérationnel en attente.
Valeurs de retour
OT_ERROR_NONE
L'ensemble de données opérationnel en attente a bien été défini.
OT_ERROR_NO_BUFS
Espace tampon insuffisant pour définir l'ensemble de données opérationnel en attente.
OT_ERROR_NOT_IMPLEMENTED
La plate-forme n'implémente pas de fonctionnalité de paramétrage.

otDatasetUpdateTlvs

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

Met à jour un ensemble de données opérationnel donné.

aDataset contient les champs à mettre à jour et leur nouvelle valeur.

Détails
Paramètres
[in] aDataset
Spécifie l'ensemble des types et des valeurs à mettre à jour.
[in,out] aDatasetTlvs
Pointeur vers les TLV de l'ensemble de données à mettre à jour.
Valeurs de retour
OT_ERROR_NONE
Mise à jour de aDatasetTlvs réussie.
OT_ERROR_INVALID_ARGS
aDataset contient des valeurs non valides.
OT_ERROR_NO_BUFS
Espace insuffisant dans aDatasetTlvs pour appliquer la mise à jour.

otDatasetUpdaterCancelUpdate

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

Annule une requête de mise à jour d'un ensemble de données opérationnel en cours (le cas échéant).

Disponible lorsque OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE est activé.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.

otDatasetUpdaterIsUpdateOngoing

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

Indique si une requête de mise à jour de l'ensemble de données d'opération est en cours.

Disponible lorsque OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE est activé.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Valeurs de retour
TRUE
Une mise à jour est en cours.
FALSE
Aucune mise à jour n'est en cours.

otDatasetUpdaterRequestUpdate

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

Demande une mise à jour de l'ensemble de données opérationnel.

Disponible lorsque OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE est activé.

aDataset doit contenir les champs à mettre à jour et leur nouvelle valeur. Il ne doit pas contenir de champ "Active" ou "Pending Timestamp". Le champ "Délai" est facultatif. S'il n'est pas renseigné, une valeur par défaut (1 000 ms) serait utilisée.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aDataset
Pointeur vers l'ensemble de données contenant les champs à modifier.
[in] aCallback
Rappel indiquant à quel moment la requête de mise à jour de l'ensemble de données est terminée.
[in] aContext
Contexte arbitraire transmis au rappel.
Valeurs de retour
OT_ERROR_NONE
La mise à jour de l'ensemble de données a bien démarré (aCallback sera appelé une fois l'opération terminée).
OT_ERROR_INVALID_STATE
L'appareil est désactivé (MLE désactivé).
OT_ERROR_INVALID_ARGS
aDataset n'est pas valide (contient "Active" ou "En attente").
OT_ERROR_BUSY
Impossible de lancer la mise à jour, une mise à jour précédente est en cours.
OT_ERROR_NO_BUFS
Impossible d'allouer le tampon pour enregistrer l'ensemble de données.

otNetworkNameFromString

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

Définit une instance otNetworkName à partir d'une chaîne C se terminant par une valeur nulle donnée.

aNameString doit respecter l'encodage UTF-8 et la longueur du nom du réseau ne doit pas dépasser OT_NETWORK_NAME_MAX_SIZE.

Détails
Paramètres
[out] aNetworkName
Pointeur vers l'élément otNetworkName à définir.
[in] aNameString
Une chaîne C de nom.
Valeurs de retour
OT_ERROR_NONE
aNetworkName a bien été défini à partir de aNameString.
OT_ERROR_INVALID_ARGS
aNameStrng n'est pas valide (trop long ou ne respecte pas l'encodage UTF-8).

Macros

OT_CHANNEL_10_MASK

 OT_CHANNEL_10_MASK (1 << 10)

Chaîne 10.

OT_CHANNEL_11_MASK

 OT_CHANNEL_11_MASK (1 << 11)

Chaîne 11.

OT_CHANNEL_12_MASK

 OT_CHANNEL_12_MASK (1 << 12)

Chaîne 12.

OT_CHANNEL_13_MASK

 OT_CHANNEL_13_MASK (1 << 13)

Chaîne 13.

OT_CHANNEL_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

Chaîne 14.

OT_CHANNEL_15_MASK

 OT_CHANNEL_15_MASK (1 << 15)

Chaîne 15.

OT_CHANNEL_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

Chaîne 16.

OT_CHANNEL_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

Chaîne 17.

OT_CHANNEL_18_MASK

 OT_CHANNEL_18_MASK (1 << 18)

Chaîne 18.

OT_CHANNEL_19_MASK

 OT_CHANNEL_19_MASK (1 << 19)

Chaîne 19.

OT_CHANNEL_1_MASK

 OT_CHANNEL_1_MASK (1 << 1)

Chaîne 1.

OT_CHANNEL_20_MASK

 OT_CHANNEL_20_MASK (1 << 20)

Chaîne 20.

OT_CHANNEL_21_MASK

 OT_CHANNEL_21_MASK (1 << 21)

Chaîne 21.

OT_CHANNEL_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

Chaîne 22.

OT_CHANNEL_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

Chaîne 23.

OT_CHANNEL_24_MASK

 OT_CHANNEL_24_MASK (1 << 24)

Chaîne 24.

OT_CHANNEL_25_MASK

 OT_CHANNEL_25_MASK (1 << 25)

Chaîne 25.

OT_CHANNEL_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

Chaîne 26.

OT_CHANNEL_2_MASK

 OT_CHANNEL_2_MASK (1 << 2)

Chaîne 2.

OT_CHANNEL_3_MASK

 OT_CHANNEL_3_MASK (1 << 3)

Chaîne 3.

OT_CHANNEL_4_MASK

 OT_CHANNEL_4_MASK (1 << 4)

Chaîne 4.

OT_CHANNEL_5_MASK

 OT_CHANNEL_5_MASK (1 << 5)

Chaîne 5.

OT_CHANNEL_6_MASK

 OT_CHANNEL_6_MASK (1 << 6)

Chaîne 6.

OT_CHANNEL_7_MASK

 OT_CHANNEL_7_MASK (1 << 7)

Chaîne 7.

OT_CHANNEL_8_MASK

 OT_CHANNEL_8_MASK (1 << 8)

Chaîne 8.

OT_CHANNEL_9_MASK

 OT_CHANNEL_9_MASK (1 << 9)

Chaîne 9.

OT_EXT_PAN_ID_SIZE

 OT_EXT_PAN_ID_SIZE 8

Taille d'un ID de PAN Thread (en octets)

OT_MESH_LOCAL_PREFIX_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

Taille du préfixe local du maillage (en octets)

OT_NETWORK_KEY_SIZE

 OT_NETWORK_KEY_SIZE 16

Taille de la clé réseau Thread (octets)

OT_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

Taille maximale du champ "Nom du réseau Thread" (octets)

OT_OPERATIONAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

Longueur maximale de l'ensemble de données opérationnel en octets.

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

Taille maximale de la clé PSKc (en octets)

Ressources

Les sujets de référence de l'API OpenThread proviennent du code source, disponible sur GitHub. Pour en savoir plus ou pour contribuer à notre documentation, consultez la section Ressources.