Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Ensemble de données opérationnel

Inclut des fonctions pour l'API Operational Dataset.

Résumé

Pour les builds FTD uniquement, l'outil de mise à jour des 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 d'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
}
énumération, enum
Cette énumération représente les types de TLV du maillage.

Définitions

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

Variables

OT_TOOL_PACKED_END

Fonctions

otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)
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)
Cette fonction génère une clé PSKc à partir d'une phrase secrète, 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)
Cette fonction récupère l'ensemble de données opérationnel actif.
otDatasetGetDelayTimerMinimal(otInstance *aInstance)
uint32_t
FTD uniquement : obtient un retardateur minimal.
otDatasetGetPending(otInstance *aInstance, otOperationalDataset *aDataset)
Cette fonction récupère l'ensemble de données opérationnel en attente.
otDatasetGetPendingTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Cette fonction récupère l'ensemble de données opérationnel en attente.
otDatasetIsCommissioned(otInstance *aInstance)
bool
Cette fonction indique si un réseau valide est présent dans l'ensemble de données opérationnel actif.
otDatasetParseTlvs(const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)
Cette fonction analyse un ensemble de données opérationnel à partir d'un otOperationalDatasetTlvs.
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)
Cette fonction définit l'ensemble de données opérationnel actif.
otDatasetSetDelayTimerMinimal(otInstance *aInstance, uint32_t aDelayTimerMinimal)
FTD uniquement : définit un retardateur minimal.
otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset)
Définit l'ensemble de données opérationnel en attente.
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Cette fonction définit l'ensemble de données opérationnel en attente.
otDatasetUpdaterCancelUpdate(otInstance *aInstance)
void
Cette fonction annule une requête de mise à jour d'un ensemble de données en cours (le cas échéant).
otDatasetUpdaterIsUpdateOngoing(otInstance *aInstance)
bool
Cette fonction indique si une requête de mise à jour de l'ensemble de données sur les opérations est en cours.
otDatasetUpdaterRequestUpdate(otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext)
Cette fonction demande la 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 terminée et nulle.

Structures

otExtendedPanId

Cette structure représente un ID de carte PAN étendu.

OTNetworkKey

Cette structure représente une clé réseau Thread.

Nom du réseau

Cette structure représente un nom de réseau.

otOperationalDataset

Cette structure représente un ensemble de données opérationnel actif ou en attente.

otOperationalDatasetComponents

Cette structure représente la présence de différents composants dans un ensemble de données opérationnel actif ou en attente.

otOperationalDatasetTlvs

Cette structure représente un ensemble de données opérationnel actif ou en attente.

OTPskc

Cette structure représente PSKc.

Stratégie de sécurité

Cette structure représente une stratégie de sécurité.

otTimestamp

Cette structure représente un composant d'horodatage d'ensemble de données de fils de discussion.

Énumérations

otMeshcopTlvType

 otMeshcopTlvType

Cette énumération représente les types de TLV du maillage.

Propriétés
OT_MESHCOP_TLV_ACTIVETIMESTAMP

Code temporel actif (TLV) du réseau maillécop

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

TLV du classificateur d'agent de frontière

OT_MESHCOP_TLV_CHANNEL

TLV du canal maillécop

OT_MESHCOP_TLV_CHANNELMASK

TLV du masque de canal maillécop

OT_MESHCOP_TLV_COMMISSIONER_ID

TLV du commissaire maillécop

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

TLV du port UDP du commissaire maillé

OT_MESHCOP_TLV_COMM_SESSION_ID

ID de session du commissaire maillécop

OT_MESHCOP_TLV_COUNT

TLV du nombre de maillages

OT_MESHCOP_TLV_DELAYTIMER

TLV de retard du maillagecop

OT_MESHCOP_TLV_DISCOVERYREQUEST

TLV de demande de maillage de services

OT_MESHCOP_TLV_DISCOVERYRESPONSE

TLV de réponse de maillage dans Discovery

OT_MESHCOP_TLV_ENERGY_LIST

Liste d'énergie maillée TLV

OT_MESHCOP_TLV_EXTPANID

Code TLV étendu du réseau maillécop

OT_MESHCOP_TLV_GET

maillécop Obtenir le TLV

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

TLV d'adresse IPv6 du réseau maillé

OT_MESHCOP_TLV_JOINERADVERTISEMENT

TLV d'annonce de jointure de maillage

OT_MESHCOP_TLV_JOINER_DTLS

Encapsulation du protocole DTLS à jointure de maillage

OT_MESHCOP_TLV_JOINER_IID

TLV de jointure IID TLV

OT_MESHCOP_TLV_JOINER_RLOC

TLV de localisation de routeur de jointure de maillage

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

Routeur KEK TLV de la jointure de maillage

OT_MESHCOP_TLV_JOINER_UDP_PORT

TLV du port UDP de la jointure maillée

OT_MESHCOP_TLV_MESHLOCALPREFIX

TLV de préfixe local de maillage maillé

OT_MESHCOP_TLV_NETWORKKEY

TLV de clé réseau maillécop

OT_MESHCOP_TLV_NETWORKNAME

TLV du nom du réseau maillécop

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE

Fichier TLV de séquence de clés réseau maillécop

OT_MESHCOP_TLV_PANID

Code TLV du réseau maillécop

OT_MESHCOP_TLV_PENDINGTIMESTAMP

TLV d'horodatage en attente du réseau maillécop

OT_MESHCOP_TLV_PERIOD

TLV de la période maillée

OT_MESHCOP_TLV_PROVISIONING_URL

Fichier TLV de provisionnement de l'URL du réseau maillé

OT_MESHCOP_TLV_PSKC

réseau maillé PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

Durée d'analyse du maillage maillé

OT_MESHCOP_TLV_SECURITYPOLICY

TLV de la règle de sécurité du réseau maillé

OT_MESHCOP_TLV_STATE

TLV de l'État du maillage de services

OT_MESHCOP_TLV_STEERING_DATA

Fichier TLV de direction réseau maillécop

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

Fichier TLV d'encapsulation du protocole UDP maillé

OT_MESHCOP_TLV_VENDOR_DATA_TLV

Fichier TLV du fournisseur de maillage de services

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

TLV du modèle de fournisseur maillage

OT_MESHCOP_TLV_VENDOR_NAME_TLV

Nom du fournisseur du réseau maillécop

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

Fichier TLV de la pile de fournisseurs du réseau maillé

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

TLV du fournisseur de maillage de services (TLV)

Définitions

otChannelMask

uint32_t otChannelMask

Ce type représente le masque de canal.

otDatasetMgmtSetCallback

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

Ce pointeur de fonction 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
Un pointeur vers un contexte spécifique à l'application.
Valeurs de retour
OT_ERROR_NONE
La demande a été acceptée par le responsable.
OT_ERROR_REJECTED
La demande a été refusée par le responsable.
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 un pair.
OT_ERROR_RESPONSE_TIMEOUT
Aucune réponse ni accusé de réception reçus pendant le délai imparti.

otDatasetUpdaterCallback

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

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

Disponible lorsque OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE est activé.

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

otExtendedPanId

struct otExtendedPanId otExtendedPanId

Cette structure représente un ID de carte PAN étendu.

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

Cette structure représente un préfixe local de maillage.

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

Cette énumération représente les types de TLV du maillage.

Clé du réseau

struct otNetworkKey otNetworkKey

Cette structure représente une clé réseau Thread.

OTNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

Ce type de données représente la clé KeyRef de NetworkKey.

Référence à la clé

Nom du réseau

struct otNetworkName otNetworkName

Cette structure représente un nom de réseau.

Le otNetworkName est une chaîne C terminée à zéro. Le tableau de caractères m8 doit impérativement se terminer par \0.

Opération opérationnelle

struct otOperationalDataset otOperationalDataset

Cette structure représente un ensemble de données opérationnel actif ou en attente.

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

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

Cette structure représente la présence de différents composants dans un ensemble de données opérationnel actif ou en attente.

otOperationalDatasetTlv

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

Cette structure représente un ensemble de données opérationnel actif ou en attente.

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

OTPskc

struct otPskc otPskc

Cette structure représente une clé PSKc.

OTPskcRef

otCryptoKeyRef otPskcRef

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

Référence à la clé

Stratégie de sécurité

struct otSecurityPolicy otSecurityPolicy

Cette structure représente une stratégie de sécurité.

Horodatage

struct otTimestamp otTimestamp

Cette structure représente un composant d'horodatage d'ensemble de données de fils de discussion.

Variables

OT_OUTIL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

Fonctions

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

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
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
)

Cette fonction génère une clé PSKc à partir d'une phrase secrète, d'un nom de réseau et d'un ID de PAN étendu.

PSKc permet d'établir la session du commissaire.

Détails
Paramètres
[in] aPassPhrase
Phrase de passe de mise en service.
[in] aNetworkName
Nom du réseau pour le calcul PSKc.
[in] aExtPanId
ID PAN étendu pour le calcul PSKc.
[out] aPskc
Un pointeur vers une variable pour générer le PSKc généré.
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
Pointeur vers une instance OpenThread.
[out] aDataset
Point vers lequel placera 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 de paramètres.

otDatasetGetActiveTlvs

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Cette fonction récupère l'ensemble de données opérationnel actif.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[out] aDataset
Point vers lequel placera 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 de paramètres.

otDatasetGetDelayMinuteMinimum

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

FTD uniquement : obtient un retardateur minimal.

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

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Cette fonction récupère l'ensemble de données opérationnel en attente.

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

otDatasetGetPendingTlv

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Cette fonction récupère l'ensemble de données opérationnel en attente.

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

otDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

Cette fonction indique si un réseau valide est présent dans l'ensemble de données opérationnel actif.

Détails
Paramètres
[in] aInstance
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.

otDatasetParseTlv

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

Cette fonction analyse un ensemble de données opérationnel à partir d'un otOperationalDatasetTlvs.

Détails
Paramètres
[in] aDatasetTlvs
Un pointeur vers les fichiers TLV de l'ensemble de données
[out] aDataset
Point vers lequel l'ensemble de données sera placé.
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
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 pointant vers un tableau contenant des types TLV bruts supplémentaires à demander.
[in] aLength
Longueur de aTlvTypes.
[in] aAddress
Un pointeur vers la destination IPv6, s'il est NULL, utilisera le leader ALOC par défaut.
Valeurs de retour
OT_ERROR_NONE
La commande "datasetcop" de l'ensemble de données a bien été envoyée.
OT_ERROR_NO_BUFS
Espace insuffisant pour l'envoi.

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
Pointeur vers une instance OpenThread.
[in] aDataset
Un pointeur vers l'ensemble de données opérationnel.
[in] aTlvs
Un pointeur vers les TLV.
[in] aLength
Longueur des TLV.
[in] aCallback
Pointeur vers une fonction appelée lors de la réception ou du délai avant expiration de la réponse.
[in] aContext
Un pointeur vers le contexte spécifique à l'application de aCallback.
Valeurs de retour
OT_ERROR_NONE
La commande "datasetcop" de l'ensemble de données a bien été envoyée.
OT_ERROR_NO_BUFS
Espace insuffisant pour l'envoi.
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
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 pointant vers un tableau contenant des types TLV bruts supplémentaires à demander.
[in] aLength
Longueur de aTlvTypes.
[in] aAddress
Un pointeur vers la destination IPv6, s'il est NULL, utilisera le leader ALOC par défaut.
Valeurs de retour
OT_ERROR_NONE
La commande "datasetcop" de l'ensemble de données a bien été envoyée.
OT_ERROR_NO_BUFS
Espace insuffisant pour l'envoi.

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
Pointeur vers une instance OpenThread.
[in] aDataset
Un pointeur vers l'ensemble de données opérationnel.
[in] aTlvs
Un pointeur vers les TLV.
[in] aLength
Longueur des TLV.
[in] aCallback
Pointeur vers une fonction appelée lors de la réception ou du délai avant expiration de la réponse.
[in] aContext
Un pointeur vers le contexte spécifique à l'application de aCallback.
Valeurs de retour
OT_ERROR_NONE
La commande "datasetcop" de l'ensemble de données a bien été envoyée.
OT_ERROR_NO_BUFS
Espace insuffisant pour l'envoi.
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 d'horodatage actif, il n'est que partiellement complet.

Si Thread est activé sur un appareil disposant d'un ensemble de données actif partiellement complet, l'appareil tente de s'associer à un réseau Thread existant en utilisant les informations de l'ensemble de données. Seule la clé de réseau Thread est nécessaire pour la 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 rechercher les voisins sur d'autres canaux.

Si l'appareil est correctement associé à un réseau Thread, il récupère alors l'ensemble de données actif complet de son parent. Notez qu'un appareil compatible avec le routeur ne passe pas aux rôles de routeur ou de responsable tant qu'il ne dispose pas d'un ensemble de données actif complet.

Détails
Paramètres
[in] aInstance
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 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
)

Cette fonction définit l'ensemble de données opérationnel actif.

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

Si Thread est activé sur un appareil disposant d'un ensemble de données actif partiellement complet, l'appareil tente de s'associer à un réseau Thread existant en utilisant les informations de l'ensemble de données. Seule la clé de réseau Thread est nécessaire pour la 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 rechercher les voisins sur d'autres canaux.

Si l'appareil est correctement associé à un réseau Thread, il récupère alors l'ensemble de données actif complet de son parent. Notez qu'un appareil compatible avec le routeur ne passe pas aux rôles de routeur ou de responsable tant qu'il ne dispose pas d'un ensemble de données actif complet.

Détails
Paramètres
[in] aInstance
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 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.

otDatasetSetDelayMinuteMinimum

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

FTD uniquement : définit un retardateur minimal.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aDelayTimerMinimal
Valeur du délai minimal (en ms).
Valeurs de retour
OT_ERROR_NONE
Le retardateur 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
Pointeur vers une instance OpenThread.
[in] aDataset
Un 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 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.

otDatasetSetPendingTlv

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

Cette fonction définit l'ensemble de données opérationnel en attente.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aDataset
Un 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 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.

otDatasetUpdaterCancelUpdate

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

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

Disponible lorsque OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE est activé.

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

otDatasetUpdaterIsUpdateOncontinue

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

Cette fonction indique si une requête de mise à jour de l'ensemble de données sur les opérations est en cours.

Disponible lorsque OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE est activé.

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

otDatasetUpdaterRequestUpdate

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

Cette fonction demande la 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 champs d'horodatage actifs ou en attente. Le champ "Delay" (Délai) est facultatif. Si vous ne le fournissez pas, une valeur par défaut (1 000 ms) est utilisée.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aDataset
Pointeur vers l'ensemble de données contenant les champs à modifier.
[in] aCallback
Rappel indiquant que 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 été lancée (aCallback sera appelée à la fin).
OT_ERROR_INVALID_STATE
L'appareil est désactivé (le MLE est désactivé).
OT_ERROR_INVALID_ARGS
aDataset n'est pas valide (contient un horodatage actif ou en attente).
OT_ERROR_BUSY
Impossible de lancer la mise à jour. Une 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 terminée et nulle.

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 otNetworkName à définir.
[in] aNameString
Une chaîne de nom C.
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)

Canal 10.

OT_CHANNEL_11_MASK

 OT_CHANNEL_11_MASK (1 << 11)

Canal 11.

OT_CHANNEL_12_MASK

 OT_CHANNEL_12_MASK (1 << 12)

Canal 12.

OT_CHANNEL_13_MASK.

 OT_CHANNEL_13_MASK (1 << 13)

Canal 13.

OT_CHANNEL_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

Canal 14.

OT_CHANNEL_15_MASK

 OT_CHANNEL_15_MASK (1 << 15)

Canal 15.

OT_CHANNEL_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

Canal 16.

OT_CHANNEL_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

Canal 17.

OT_CHANNEL_18_MASK

 OT_CHANNEL_18_MASK (1 << 18)

Canal 18.

OT_CHANNEL_19_MASK

 OT_CHANNEL_19_MASK (1 << 19)

Canal 19.

OT_CHANNEL_1_MASK

 OT_CHANNEL_1_MASK (1 << 1)

Canal 1.

OT_CHANNEL_20_MASK

 OT_CHANNEL_20_MASK (1 << 20)

Canal 20.

OT_CHANNEL_21_MASK

 OT_CHANNEL_21_MASK (1 << 21)

Canal 21.

OT_CHANNEL_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

Canal 22.

OT_CHANNEL_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

Canal 23.

OT_CHANNEL_24_MASK

 OT_CHANNEL_24_MASK (1 << 24)

Canal 24.

OT_CHANNEL_25_MASK

 OT_CHANNEL_25_MASK (1 << 25)

Canal 25.

OT_CHANNEL_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

Canal 26.

OT_CHANNEL_2_MASK

 OT_CHANNEL_2_MASK (1 << 2)

Canal 2.

OT_CHANNEL_3_MASK

 OT_CHANNEL_3_MASK (1 << 3)

Canal 3.

OT_CHANNEL_4_MASK

 OT_CHANNEL_4_MASK (1 << 4)

Canal 4.

OT_CHANNEL_5_MASK

 OT_CHANNEL_5_MASK (1 << 5)

Canal 5.

OT_CHANNEL_6_MASK

 OT_CHANNEL_6_MASK (1 << 6)

Canal 6.

OT_CHANNEL_7_MASK

 OT_CHANNEL_7_MASK (1 << 7)

Canal 7.

OT_CHANNEL_8_MASK

 OT_CHANNEL_8_MASK (1 << 8)

Canal 8.

OT_CHANNEL_9_MASK

 OT_CHANNEL_9_MASK (1 << 9)

Canal 9.

OT_EXT_PAN_ID_SIZE

 OT_EXT_PAN_ID_SIZE 8

Taille d'un ID PAN de thread (octets)

OT_MESH_LOCAL_PREFIX_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

Taille du préfixe local du réseau maillé (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 (octets)

Resources

Les sujets de référence de l'API OpenThread proviennent du code source, disponible sur GitHub. Pour plus d'informations ou pour contribuer à notre documentation, reportez-vous à la page Ressources.