Général

Ce module inclut des fonctions pour tous les rôles Thread.

Résumé

L'éditeur de données réseau fournit des mécanismes pour limiter le nombre d'entrées de service et/ou de préfixe similaires dans le préfixe de réseau maillé ou d'une route externe dans les données du réseau Thread en surveillant les données réseau et en définissant si et quand ajouter des entrées.

Toutes les fonctions de ce module nécessitent l'activation de OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE.

Énumérations

anonymous enum{
  OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS = 0,
  OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS = 1,
  OT_NETWORK_DIAGNOSTIC_TLV_MODE = 2,
  OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT = 3,
  OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY = 4,
  OT_NETWORK_DIAGNOSTIC_TLV_ROUTE = 5,
  OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA = 6,
  OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA = 7,
  OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST = 8,
  OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS = 9,
  OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL = 14,
  OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE = 15,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE = 16,
  OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES = 17,
  OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST = 18,
  OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT = 19
}
enum
otDeviceRole{
  OT_DEVICE_ROLE_DISABLED = 0,
  OT_DEVICE_ROLE_DETACHED = 1,
  OT_DEVICE_ROLE_CHILD = 2,
  OT_DEVICE_ROLE_ROUTER = 3,
  OT_DEVICE_ROLE_LEADER = 4
}
enum
Représente un rôle d'appareil Thread.
otNetDataPublisherEvent{
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
}
enum
Cette énumération représente les événements signalés par les rappels de l'éditeur.
otRoutePreference{
  OT_ROUTE_PREFERENCE_LOW = -1,
  OT_ROUTE_PREFERENCE_MED = 0,
  OT_ROUTE_PREFERENCE_HIGH = 1
}
enum
Définit des valeurs valides pour mPreference dans otExternalRouteConfig et otBorderRouterConfig.

Définitions

otBorderRouterConfig CANNOT TRANSLATE
Cette structure représente la configuration d'un routeur de bordure.
otDetachGracefullyCallback)(void *aContext) CANNOT TRANSLATE
void(*
Ce rappel informe l'application que le processus de dissociation est terminé.
otExternalRouteConfig CANNOT TRANSLATE
Cette structure représente une configuration de route externe.
otIpCounters CANNOT TRANSLATE
struct otIpCounters
Cette structure représente les compteurs de niveau d'adresse IP.
otLeaderData CANNOT TRANSLATE
struct otLeaderData
Cette structure représente les données des dirigeants de fils de discussion.
otLinkModeConfig CANNOT TRANSLATE
Cette structure représente une configuration du mode liaison MLE.
otMleCounters CANNOT TRANSLATE
struct otMleCounters
Cette structure représente les compteurs MLE de thread.
otNeighborInfoIterator CANNOT TRANSLATE
int16_t
Utilisé pour effectuer une itération dans la table voisine.
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext) CANNOT TRANSLATE
void(*
Ce type de pointeur de fonction définit le rappel utilisé pour envoyer une notification lorsqu'une entrée de service DNS/SRP est ajoutée aux données du réseau Thread ou supprimée de celles-ci.
otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) CANNOT TRANSLATE
void(*
Ce type de pointeur de fonction définit le rappel utilisé pour envoyer une notification lorsqu'une entrée de préfixe (réseau maillé ou route externe) est ajoutée aux données du réseau Thread ou supprimée de celles-ci.
otNetDataPublisherEvent CANNOT TRANSLATE
Cette énumération représente les événements signalés par les rappels de l'éditeur.
otNetworkDataIterator CANNOT TRANSLATE
uint32_t
Permet de parcourir les informations des données réseau.
otNetworkDiagChildEntry CANNOT TRANSLATE
Cette structure représente une entrée de table enfant de diagnostic réseau.
otNetworkDiagConnectivity CANNOT TRANSLATE
Cette structure représente une valeur de connectivité de diagnostic du réseau.
otNetworkDiagIterator CANNOT TRANSLATE
uint16_t
Utilisé pour effectuer des itérations dans le fichier TLV de diagnostic du réseau.
otNetworkDiagMacCounters CANNOT TRANSLATE
Cette structure représente une valeur de compteurs de diagnostic réseau.
otNetworkDiagRoute CANNOT TRANSLATE
Cette structure représente une valeur TLV de route de diagnostic réseau.
otNetworkDiagRouteData CANNOT TRANSLATE
Cette structure représente des données de routage de diagnostic de réseau.
otNetworkDiagTlv CANNOT TRANSLATE
Cette structure représente un fichier TLV de diagnostic réseau.
otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) CANNOT TRANSLATE
void(*
Ce pointeur de fonction est appelé lorsque la réponse de diagnostic de réseau est reçue.
otRoutePreference CANNOT TRANSLATE
Définit des valeurs valides pour mPreference dans otExternalRouteConfig et otBorderRouterConfig.
otServerConfig CANNOT TRANSLATE
Cette structure représente la configuration du serveur,
otServiceConfig CANNOT TRANSLATE
Cette structure représente une configuration de service.
otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) CANNOT TRANSLATE
void(*
Ce type de pointeur de fonction définit le rappel pour informer le résultat d'une requête otThreadLocateAnycastDestination().
otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) CANNOT TRANSLATE
void(*
Ce pointeur de fonction est appelé chaque fois qu'un message de demande de découverte MLE est reçu.
otThreadDiscoveryRequestInfo CANNOT TRANSLATE
Cette structure représente les données de la requête Thread Discovery.
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext) CANNOT TRANSLATE
void(*
Ce pointeur de fonction est appelé à chaque fois qu'un message de réponse parent MLE est reçu.
otThreadParentResponseInfo CANNOT TRANSLATE
Cette structure représente les données de la réponse parent MLE.

Fonctions

otNetDataContainsOmrPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Cette fonction vérifie si un préfixe donné peut faire office de préfixe OMR valide, et si les données réseau de Leader contiennent ce préfixe.
otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
Cette méthode fournit une copie complète ou stable des données du réseau Thread.
otNetDataGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
La fonction récupère le préfixe de réseau maillé suivant dans les données réseau de la partition.
otNetDataGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
Cette fonction obtient la route externe suivante dans les données réseau de la partition.
otNetDataGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
Cette fonction obtient le service suivant dans les données réseau de la partition.
otNetDataGetStableVersion(otInstance *aInstance)
uint8_t
Obtenez la version stable des données du réseau.
otNetDataGetVersion(otInstance *aInstance)
uint8_t
Obtenez la version des données réseau.
otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)
bool
Cette fonction indique si l'entrée de type "DNS/SRP Service" (Service DNS/SRP) est ajoutée aux données du réseau Thread.
otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Cette fonction indique si une entrée de préfixe publiée (sur le réseau maillé ou la route externe) est ajoutée aux données du réseau Thread.
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
void
Cette fonction demande la publication d'une adresse Anycast DNS/SRP pour la publication de données dans le réseau Thread.
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
Cette fonction demande la publication de l'adresse DNS/du service SRP dans les données du réseau Thread.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
void
Cette fonction demande la publication de l'adresse DNS/du service SRP dans les données du réseau Thread.
otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
Cette fonction demande la publication d'un préfixe de route externe dans les données du réseau Thread.
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
Cette fonction demande la publication d'un préfixe sur le réseau maillé dans les données du réseau Thread.
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
Cette fonction définit un rappel pour envoyer une notification lorsque le service DNS/SRP publié est ajouté aux données du réseau Thread ou supprimé de celles-ci.
otNetDataSetPrefixPublisherCallback(otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
Cette fonction définit un rappel pour signaler à quel moment une entrée de préfixe publiée est réellement ajoutée aux données du réseau Thread ou supprimée de celles-ci.
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
Vérifiez si les données de direction incluent une jointure.
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
Vérifiez si les données de direction comprennent une jointure avec une valeur de discerner donnée.
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
void
Annule la publication de toute entrée de service DNS/SRP (Anycast ou Unicast) précédemment ajoutée aux données du réseau Thread.
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
annule la publication d'un préfixe de route externe (ou maillé) publié.
otThreadBecomeChild(otInstance *aInstance)
Essayez de l'associer à nouveau en tant qu'enfant.
otThreadBecomeDetached(otInstance *aInstance)
Dissocier du réseau Thread.
otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
Cette fonction informe les autres nœuds du réseau (le cas échéant) et arrête l'opération de protocole Thread.
otThreadDeviceRoleToString(otDeviceRole aRole)
const char *
Convertissez le rôle d'appareil en chaîne lisible.
otThreadDiscover(otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
Cette fonction lance une analyse Thread Discovery.
otThreadGetChildTimeout(otInstance *aInstance)
uint32_t
Obtenez le délai avant expiration du fil de discussion Thread utilisé lorsque le rôle enfant est utilisé.
otThreadGetDeviceRole(otInstance *aInstance)
Obtenez le rôle de l'appareil.
otThreadGetDomainName(otInstance *aInstance)
const char *
Obtenez le nom de domaine du fil de discussion.
otThreadGetExtendedPanId(otInstance *aInstance)
const otExtendedPanId *
Obtenez l'identifiant PAN étendu de la norme IEEE 802.15.4.
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
Obtenez l'identifiant d'interface spécifié manuellement pour l'adresse unicast de domaine de fils de discussion.
otThreadGetIp6Counters(otInstance *aInstance)
const otIpCounters *
Obtenez les compteurs IPv6.
otThreadGetKeySequenceCounter(otInstance *aInstance)
uint32_t
Obtenez le paramètre thmozillaSéquenceCounter.
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
uint32_t
Obtenez la commande thmozillaSwitchGuardTime.
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
Cette fonction obtient les données des dirigeants de fils de discussion.
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
Cette fonction renvoie un repère au RLOC du dirigeant.
otThreadGetLeaderRouterId(otInstance *aInstance)
uint8_t
Obtenez l'ID du routeur du leader.
otThreadGetLeaderWeight(otInstance *aInstance)
uint8_t
Obtenez le poids du leader.
otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Cette fonction renvoie l'adresse de multidiffusion Thread Link-Local All Thread Nodes.
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
const otIp6Address *
Cette fonction renvoie l'adresse IPv6 locale du lien Thread.
otThreadGetLinkMode(otInstance *aInstance)
Obtenez la configuration du mode d'association MLE.
otThreadGetMeshLocalEid(otInstance *aInstance)
const otIp6Address *
Cette fonction renvoie un pointeur vers l'adresse EID local du réseau maillé.
otThreadGetMeshLocalPrefix(otInstance *aInstance)
Cette fonction renvoie un pointeur vers le préfixe local du réseau maillé.
otThreadGetMleCounters(otInstance *aInstance)
const otMleCounters *
Obtenez les compteurs MLE de Thread.
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
void
Obtenez la clé réseau Thread.
otThreadGetNetworkKeyRef(otInstance *aInstance)
Obtenez le otNetworkKeyRef de la clé réseau Thread.
otThreadGetNetworkName(otInstance *aInstance)
const char *
Obtenez le nom du réseau Thread.
otThreadGetNextDiagnosticTlv(const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
Cette fonction reçoit le prochain TLV de diagnostic réseau dans le message.
otThreadGetNextNeighborInfo(otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
Cette fonction obtient les informations voisines suivantes.
otThreadGetParentAverageRssi(otInstance *aInstance, int8_t *aParentRssi)
La fonction récupère le RSSI moyen du parent Thread.
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
La fonction récupère les informations de diagnostic d'un routeur Thread en tant que parent.
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
La fonction récupère le flux RSSI du dernier paquet à partir du thread Thread.
otThreadGetPartitionId(otInstance *aInstance)
uint32_t
Obtenez l'ID de la partition.
otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Cette fonction renvoie l'adresse de multidiffusion Thread Realm-Local All Thread Nodes.
otThreadGetRloc(otInstance *aInstance)
const otIp6Address *
Cette fonction renvoie un pointeur vers l'adresse du RLOC (Thread Routing Locator).
otThreadGetRloc16(otInstance *aInstance)
uint16_t
Obtenez le RLOC16.
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
Cette fonction récupère l'ALOC du service pour l'ID de service donné.
otThreadGetVersion(void)
uint16_t
Cette fonction obtient la version du protocole Thread.
otThreadIsAnycastLocateInProgress(otInstance *aInstance)
bool
Cette fonction indique si une requête de localisation Anycast est en cours.
otThreadIsDiscoverInProgress(otInstance *aInstance)
bool
Cette fonction détermine si une découverte de thread MLE est en cours.
otThreadIsSingleton(otInstance *aInstance)
bool
Cette fonction indique si le nœud est le seul routeur du réseau.
otThreadLocateAnycastDestination(otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
Cette fonction demande la destination la plus proche d'une adresse Anycast donnée.
otThreadRegisterParentResponseCallback(otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
Cette fonction enregistre un rappel pour recevoir les données de la réponse parent MLE.
otThreadResetIp6Counters(otInstance *aInstance)
void
Réinitialisez les compteurs IPv6.
otThreadResetMleCounters(otInstance *aInstance)
void
Réinitialisez les compteurs Thread MLE.
otThreadSendAddressNotification(otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
Cette fonction envoie un message de notification d'adresse proactive (ADDR_NTF.ntf).
otThreadSendDiagnosticGet(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
Envoyez une requête de diagnostic réseau.
otThreadSendDiagnosticReset(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
Envoyer une demande de réinitialisation du diagnostic du réseau.
otThreadSendProactiveBackboneNotification(otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
Cette fonction envoie un message de notification backbone proactive (PRO_BB.ntf) sur le lien backbone.
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
void
Définissez le délai avant expiration du thread enfant utilisé lors de l'utilisation du rôle Enfant.
otThreadSetDiscoveryRequestCallback(otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
Cette fonction définit un rappel pour recevoir les données de la requête de découverte MLE.
otThreadSetDomainName(otInstance *aInstance, const char *aDomainName)
Définissez le nom de domaine Thread.
otThreadSetEnabled(otInstance *aInstance, bool aEnabled)
Cette fonction lance l'opération de protocole Thread.
otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
Définissez l'ID PAN étendu de la norme IEEE 802.15.4.
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
Définir/Effacer l'identifiant d'interface spécifié manuellement pour l'adresse unicast du domaine de fils de discussion.
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
Cette méthode permet de définir la publicité pour Thread Joiner lors de la découverte du réseau Thread.
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
void
Définissez le paramètre thmozillaRuleCounter.
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
Définissez la valeur thmozillaSwitchGuardTime.
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
Définissez la configuration du mode d'association MLE.
otThreadSetMeshLocalPrefix(otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
Cette fonction définit le préfixe local du maillage.
otThreadSetNetworkKey(otInstance *aInstance, const otNetworkKey *aKey)
Définissez la clé réseau Thread.
otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)
Définissez la clé réseau Thread en tant que otNetworkKeyRef.
otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName)
Définissez le nom du réseau Thread.

Structures

otBorderRouterConfig

Cette structure représente la configuration d'un routeur de bordure.

otExternalRouteConfig

Cette structure représente une configuration de route externe.

otIpCounters

Cette structure représente les compteurs de niveau d'adresse IP.

otLeaderData

Cette structure représente les données des dirigeants de fils de discussion.

otLinkModeConfig

Cette structure représente une configuration du mode liaison MLE.

otMleCounters

Cette structure représente les compteurs MLE de thread.

otNeighborInfo

Cette structure contient des informations de diagnostic pour un nœud Thread voisin.

otNetworkDiagChildEntry

Cette structure représente une entrée de table enfant de diagnostic réseau.

otNetworkDiagConnectivity

Cette structure représente une valeur de connectivité de diagnostic du réseau.

otNetworkDiagMacCounters

Cette structure représente une valeur de compteurs de diagnostic réseau.

otNetworkDiagRoute

Cette structure représente une valeur TLV de route de diagnostic réseau.

otNetworkDiagRouteData

Cette structure représente des données de routage de diagnostic de réseau.

otNetworkDiagTlv

Cette structure représente un fichier TLV de diagnostic réseau.

otRouterInfo

Cette structure contient des informations de diagnostic pour un routeur de fils de discussion.

otServerConfig

Cette structure représente la configuration du serveur,

otServiceConfig

Cette structure représente une configuration de service.

otThreadDiscoveryRequestInfo

Cette structure représente les données de la requête Thread Discovery.

otThreadParentResponseInfo

Cette structure représente les données de la réponse parent MLE.

Énumérations

énumération anonyme

 anonymous enum
Properties
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

Niveau de batterie (TLV)

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

Fichier TLV sur les pages de chaîne

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

Valeur TLV de la table enfant

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

TLV de connectivité.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

Fichier TLV d'adresse MAC étendu.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

Fichier TLV de liste d'adresses IPv6.

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

TLV pour les leaders de données

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

Compteurs MAC (TLV).

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

Valeur TLV de délai d'inactivité maximale de l'enfant.

OT_NETWORK_DIAGNOSTIC_TLV_MODE

Mode TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

Fichier TLV de données réseau.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

Route64 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

Adresse 16 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

TLV.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

Expiration du délai d'attente (TLV) pour les SED

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

Type de liste TLV.

OTDeviceRole

 otDeviceRole

Représente un rôle d'appareil Thread.

Properties
OT_DEVICE_ROLE_CHILD

Le rôle Thread enfant.

OT_DEVICE_ROLE_DETACHED

Vous ne participez actuellement à aucun réseau/partition Thread.

OT_DEVICE_ROLE_DISABLED

La pile de fils de discussion est désactivée.

OT_DEVICE_ROLE_LEADER

Le rôle de responsable du fil de discussion.

OT_DEVICE_ROLE_ROUTER

Le rôle du routeur de thread.

otNetDataPublisherEvent

 otNetDataPublisherEvent

Cette énumération représente les événements signalés par les rappels de l'éditeur.

Properties
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED

L'entrée publiée est ajoutée aux données du réseau Thread.

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

L'entrée publiée est supprimée des données du réseau Thread.

OTRoutePreference

 otRoutePreference

Définit des valeurs valides pour mPreference dans otExternalRouteConfig et otBorderRouterConfig.

Properties
OT_ROUTE_PREFERENCE_HIGH

Préférence d'itinéraire élevée.

OT_ROUTE_PREFERENCE_LOW

Préférence d'itinéraire faible.

OT_ROUTE_PREFERENCE_MED

Préférence d'itinéraire moyenne.

Définitions

OTBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

Cette structure représente la configuration d'un routeur de bordure.

otDetachGracelyCallback

void(* otDetachGracefullyCallback)(void *aContext)

Ce rappel informe l'application que le processus de dissociation est terminé.

Détails
Paramètres
[in] aContext
Un pointeur vers un contexte spécifique à l'application

OTExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

Cette structure représente une configuration de route externe.

Compteurs automatiques

struct otIpCounters otIpCounters

Cette structure représente les compteurs de niveau d'adresse IP.

OTLeader Data

struct otLeaderData otLeaderData

Cette structure représente les données des dirigeants de fils de discussion.

OTLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

Cette structure représente une configuration du mode liaison MLE.

otMleCompteurs

struct otMleCounters otMleCounters

Cette structure représente les compteurs MLE de thread.

otNeighborInfoitération

int16_t otNeighborInfoIterator

Utilisé pour effectuer une itération dans la table voisine.

otNetDataDnsSrpServicePublisherCallback

void(* otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)

Ce type de pointeur de fonction définit le rappel utilisé pour envoyer une notification lorsqu'une entrée de service DNS/SRP est ajoutée aux données du réseau Thread ou supprimée de celles-ci.

Lorsque le rappel est supprimé, il est invoqué indépendamment de la suppression de l'entrée par Publisher (par exemple, lorsque de trop nombreuses entrées similaires sont déjà présentes dans les données réseau) ou via un appel explicite pour annuler la publication de l'entrée (c'est-à-dire, un appel vers otNetDataUnpublishDnsSrpService()).

Détails
Paramètres
[in] aEvent
Indique l'événement (si l'entrée a été ajoutée ou supprimée).
[in] aContext
Un pointeur vers un contexte spécifique à l'application

otNetDataPrefixPublisherCallback

void(* otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)

Ce type de pointeur de fonction définit le rappel utilisé pour envoyer une notification lorsqu'une entrée de préfixe (réseau maillé ou route externe) est ajoutée aux données du réseau Thread ou supprimée de celles-ci.

Lorsqu'il est supprimé, le rappel est invoqué indépendamment de la suppression de l'entrée par Publisher (par exemple, lorsqu'il y a trop d'entrées similaires déjà présentes dans les données réseau) ou via un appel explicite pour annuler la publication de l'entrée.

Détails
Paramètres
[in] aEvent
Indique l'événement (si l'entrée a été ajoutée ou supprimée).
[in] aPrefix
Pointeur vers l'entrée du préfixe.
[in] aContext
Un pointeur vers un contexte spécifique à l'application

otNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

Cette énumération représente les événements signalés par les rappels de l'éditeur.

OTNetworkDataitération

uint32_t otNetworkDataIterator

Permet de parcourir les informations des données réseau.

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

Cette structure représente une entrée de table enfant de diagnostic réseau.

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

Cette structure représente une valeur de connectivité de diagnostic du réseau.

OTNetworkDiagitération

uint16_t otNetworkDiagIterator

Utilisé pour effectuer des itérations dans le fichier TLV de diagnostic du réseau.

otNetworkDiagMacCompteurs

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

Cette structure représente une valeur de compteurs de diagnostic réseau.

Reportez-vous à la RFC 2863 pour obtenir la définition des champs des membres.

OTNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

Cette structure représente une valeur TLV de route de diagnostic réseau.

OTNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

Cette structure représente des données de routage de diagnostic de réseau.

OTNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

Cette structure représente un fichier TLV de diagnostic réseau.

otReceiveDiagnosticGetCallback

void(* otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)

Ce pointeur de fonction est appelé lorsque la réponse de diagnostic de réseau est reçue.

Détails
Paramètres
[in] aError
Erreur lors de l'échec de l'obtention de la réponse.
[in] aMessage
Un pointeur vers le tampon de message contenant la charge utile de réponse de diagnostic du réseau reçue. Disponible uniquement lorsque aError est défini sur OT_ERROR_NONE.
[in] aMessageInfo
Pointeur vers les informations du message aMessage. Disponible uniquement lorsque aError est défini sur OT_ERROR_NONE.
[in] aContext
Un pointeur vers un contexte spécifique à l'application

OTRoutePreference

enum otRoutePreference otRoutePreference

Définit des valeurs valides pour mPreference dans otExternalRouteConfig et otBorderRouterConfig.

OTServerConfig

struct otServerConfig otServerConfig

Cette structure représente la configuration du serveur,

OTServiceConfig

struct otServiceConfig otServiceConfig

Cette structure représente une configuration de service.

otThreadanycastLocatorCallback

void(* otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)

Ce type de pointeur de fonction définit le rappel pour informer le résultat d'une requête otThreadLocateAnycastDestination().

Détails
Paramètres
[in] aContext
Un pointeur vers un contexte arbitraire (fourni lorsque le rappel est enregistré).
[in] aError
Erreur lors du traitement de la requête. OT_ERROR_NONE indique que l'opération a réussi. OT_ERROR_RESPONSE_TIMEOUT indique une destination introuvable. OT_ERROR_ABORT indique que la requête a été annulée.
[in] aMeshLocalAddress
Pointeur vers l'EID du réseau maillé local de la destination la plus proche de l'adresse Anycast lorsque aError est OT_ERROR_NONE, avec la valeur NULL.
[in] aRloc16
RLOC16 de la destination s'il est trouvé, sinon RLOC16 non valide (0xfffe).

otThreadDiscoveryRequestCallback

void(* otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)

Ce pointeur de fonction est appelé chaque fois qu'un message de demande de découverte MLE est reçu.

Détails
Paramètres
[in] aInfo
Un pointeur vers les données de la requête de découverte.
[in] aContext
Un pointeur vers un contexte spécifique pour l'application de rappel.

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Cette structure représente les données de la requête Thread Discovery.

otThreadParentResponseCallback

void(* otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)

Ce pointeur de fonction est appelé à chaque fois qu'un message de réponse parent MLE est reçu.

Détails
Paramètres
[in] aInfo
Pointeur vers un emplacement sur une pile contenant les données de statistiques.
[in] aContext
Un pointeur vers un contexte spécifique pour le rappel du client.

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

Cette structure représente les données de la réponse parent MLE.

Fonctions

otNetDataContainsOmrPrefix

bool otNetDataContainsOmrPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Cette fonction vérifie si un préfixe donné peut faire office de préfixe OMR valide, et si les données réseau de Leader contiennent ce préfixe.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aPrefix
Pointeur vers le préfixe IPv6.
Renvoie
Indique si aPrefix est un préfixe OMR valide et si les données réseau de Leader contiennent le préfixe OMR aPrefix.

OTNetDataGet

otError otNetDataGet(
  otInstance *aInstance,
  bool aStable,
  uint8_t *aData,
  uint8_t *aDataLength
)

Cette méthode fournit une copie complète ou stable des données du réseau Thread.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aStable
TRUE lors de la copie de la version stable, FALSE lors de la copie de la version complète.
[out] aData
Pointeur vers le tampon de données.
[in,out] aDataLength
À l'entrée, taille du tampon de données dirigé par aData. Lors de la sortie, nombre d'octets copiés.

otNetDataGetNextOnMeshPrefix

otError otNetDataGetNextOnMeshPrefix(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otBorderRouterConfig *aConfig
)

La fonction récupère le préfixe de réseau maillé suivant dans les données réseau de la partition.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in,out] aIterator
Un pointeur vers le contexte de l'itérateur de données réseau. Pour obtenir la première entrée du réseau maillé, il doit être défini sur OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Point de repère contenant les informations du préfixe de réseau maillé.
Valeurs renvoyées
OT_ERROR_NONE
Le préfixe suivant du réseau maillé a bien été trouvé.
OT_ERROR_NOT_FOUND
Le préfixe Thread Mesh n'existe pas dans les données du réseau Thread.

otNetDataGetNextRoute

otError otNetDataGetNextRoute(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otExternalRouteConfig *aConfig
)

Cette fonction obtient la route externe suivante dans les données réseau de la partition.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in,out] aIterator
Un pointeur vers le contexte de l'itérateur de données réseau. Pour obtenir la première entrée d'itinéraire externe, elle doit être définie sur OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Point de repère à partir duquel les informations relatives à l'itinéraire externe seront placées.
Valeurs renvoyées
OT_ERROR_NONE
La route externe suivante a bien été trouvée.
OT_ERROR_NOT_FOUND
Aucune entrée de route externe ultérieure n'existe dans les données du réseau Thread.

otNetDataGetNextService

otError otNetDataGetNextService(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otServiceConfig *aConfig
)

Cette fonction obtient le service suivant dans les données réseau de la partition.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in,out] aIterator
Un pointeur vers le contexte de l'itérateur de données réseau. Pour obtenir la première entrée de service, définissez-la sur OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Pointeur vers lequel les informations sur le service seront placées.
Valeurs renvoyées
OT_ERROR_NONE
Le service suivant a bien été trouvé.
OT_ERROR_NOT_FOUND
Aucun service ultérieur n'existe dans les données réseau de la partition.

otNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

Obtenez la version stable des données du réseau.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Version stable des données réseau.

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

Obtenez la version des données réseau.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Version des données réseau.

otNetDataIsDnsSrpServiceAdded

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

Cette fonction indique si l'entrée de type "DNS/SRP Service" (Service DNS/SRP) est ajoutée aux données du réseau Thread.

Cette fonction nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Valeurs renvoyées
TRUE
L'entrée de service DNS/SRP publiée est ajoutée aux données du réseau Thread.
FALSE
L'entrée n'est pas ajoutée aux données du réseau Thread ou aucune entrée à publier.

otNetDataIsPrefixAjouté

bool otNetDataIsPrefixAdded(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Cette fonction indique si une entrée de préfixe publiée (sur le réseau maillé ou la route externe) est ajoutée aux données du réseau Thread.

Cette fonction nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aPrefix
Pointeur vers le préfixe (NE DOIT PAS être NULL).
Valeurs renvoyées
TRUE
L'entrée de préfixe publiée est ajoutée aux données du réseau Thread.
FALSE
L'entrée n'est pas ajoutée aux données du réseau Thread ou aucune entrée à publier.

otNetDataPublishDnsSrpServiceanycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

Cette fonction demande la publication d'une adresse Anycast DNS/SRP pour la publication de données dans le réseau Thread.

Cette fonction nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Un appel à cette fonction supprimera et remplacera toutes les entrées précédentes du service DNS/SRP (de l'appel précédent à l'une des fonctions otNetDataPublishDnsSrpService{Type}()).

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aSequenceNUmber
Numéro de séquence du service Anycast DNS/SRP.

otNetDataPublishDnsSrpServiceUnicast

void otNetDataPublishDnsSrpServiceUnicast(
  otInstance *aInstance,
  const otIp6Address *aAddress,
  uint16_t aPort
)

Cette fonction demande la publication de l'adresse DNS/du service SRP dans les données du réseau Thread.

Cette fonction nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Un appel à cette fonction supprimera et remplacera toutes les entrées précédentes du service DNS/SRP (de l'appel précédent à l'une des fonctions otNetDataPublishDnsSrpService{Type}()).

Cette fonction publie l'adresse Unicast DNS/SRP du service en incluant l'adresse et les informations de port dans les données TLV du service.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aAddress
Adresse du serveur DNS/SRP à publier (NE DOIT PAS être NULL).
[in] aPort
Numéro de port du serveur SRP à publier.

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

Cette fonction demande la publication de l'adresse DNS/du service SRP dans les données du réseau Thread.

Cette fonction nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Un appel à cette fonction supprimera et remplacera toutes les entrées précédentes du service DNS/SRP (de l'appel précédent à l'une des fonctions otNetDataPublishDnsSrpService{Type}()).

Contrairement à otNetDataPublishDnsSrpServiceUnicast(), qui nécessite de fournir l'adresse publiée et inclut les informations des données TLV du service, cette fonction utilise l'EID du réseau local de l'appareil et inclut les informations des données TLV du serveur.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aPort
Numéro de port du serveur SRP à publier.

otNetDataPublishExternalRoute

otError otNetDataPublishExternalRoute(
  otInstance *aInstance,
  const otExternalRouteConfig *aConfig
)

Cette fonction demande la publication d'un préfixe de route externe dans les données du réseau Thread.

Cette fonction nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Seules les entrées stables peuvent être publiées (par exemple,aConfig.mStable DOIT être TRUE).

Un appel ultérieur à cette méthode remplacera une requête précédente pour le même préfixe. Par exemple, si le nouvel appel ne modifie que les indicateurs (par exemple, le niveau de préférence) et que le préfixe est déjà ajouté dans les données du réseau, le changement en fonction des indicateurs est immédiatement répercuté dans les données du réseau. Cela garantit que les entrées existantes dans les données réseau ne sont pas supprimées brusquement. Notez qu'une modification du niveau de préférence peut entraîner la suppression ultérieure de l'entrée des données réseau après la détermination d'autres nœuds qui publient le même préfixe avec une préférence identique ou supérieure.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aConfig
Configuration de la route externe à publier (NE DOIT PAS être NULL).
Valeurs renvoyées
OT_ERROR_NONE
La route externe a bien été publiée.
OT_ERROR_INVALID_ARGS
L'élément aConfig n'est pas valide (préfixe incorrect, combinaisons d'indicateurs non valides ou non stables).
OT_ERROR_NO_BUFS
Impossible d'allouer une entrée pour la nouvelle requête. L'éditeur accepte un nombre limité d'entrées (partagées entre le préfixe de réseau maillé et la route externe) déterminées par la configuration OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataPublishOnMeshPrefix

otError otNetDataPublishOnMeshPrefix(
  otInstance *aInstance,
  const otBorderRouterConfig *aConfig
)

Cette fonction demande la publication d'un préfixe sur le réseau maillé dans les données du réseau Thread.

Cette fonction nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Seules les entrées stables peuvent être publiées (par exemple,aConfig.mStable DOIT être TRUE).

Un appel ultérieur à cette méthode remplacera une requête précédente pour le même préfixe. Par exemple, si le nouvel appel ne modifie que les indicateurs (par exemple, le niveau de préférence) et que le préfixe est déjà ajouté dans les données du réseau, le changement en fonction des indicateurs est immédiatement répercuté dans les données du réseau. Cela garantit que les entrées existantes dans les données réseau ne sont pas supprimées brusquement. Notez qu'une modification du niveau de préférence peut entraîner la suppression ultérieure de l'entrée des données réseau après la détermination d'autres nœuds qui publient le même préfixe avec une préférence identique ou supérieure.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aConfig
Configuration du préfixe on-mesh à publier (DO NOT NULL).
Valeurs renvoyées
OT_ERROR_NONE
Le préfixe on-mesh a bien été publié.
OT_ERROR_INVALID_ARGS
L'élément aConfig n'est pas valide (préfixe incorrect, combinaisons d'indicateurs non valides ou non stables).
OT_ERROR_NO_BUFS
Impossible d'allouer une entrée pour la nouvelle requête. L'éditeur accepte un nombre limité d'entrées (partagées entre le préfixe de réseau maillé et la route externe) déterminées par la configuration OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataSetDnsSrpServicePublisherCallback

void otNetDataSetDnsSrpServicePublisherCallback(
  otInstance *aInstance,
  otNetDataDnsSrpServicePublisherCallback aCallback,
  void *aContext
)

Cette fonction définit un rappel pour envoyer une notification lorsque le service DNS/SRP publié est ajouté aux données du réseau Thread ou supprimé de celles-ci.

Un appel ultérieur à cette fonction remplace toute fonction de rappel définie précédemment.

Cette fonction nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aCallback
Pointeur de fonction de rappel (peut être NULL si nécessaire).
[in] aContext
Un pointeur vers un contexte spécifique à l'application (utilisé lorsque aCallback est appelé)

otNetDataSetPrefixPublisherCallback

void otNetDataSetPrefixPublisherCallback(
  otInstance *aInstance,
  otNetDataPrefixPublisherCallback aCallback,
  void *aContext
)

Cette fonction définit un rappel pour signaler à quel moment une entrée de préfixe publiée est réellement ajoutée aux données du réseau Thread ou supprimée de celles-ci.

Un appel ultérieur à cette fonction remplace toute fonction de rappel définie précédemment.

Cette fonction nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aCallback
Pointeur de fonction de rappel (peut être NULL si nécessaire).
[in] aContext
Un pointeur vers un contexte spécifique à l'application (utilisé lorsque aCallback est appelé)

otNetDataSteeringDataCheckJoiner

otError otNetDataSteeringDataCheckJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64
)

Vérifiez si les données de direction incluent une jointure.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aEui64
Un pointeur vers la jointure IEEE EUI-64.
Valeurs renvoyées
OT_ERROR_NONE
aEui64 est inclus dans les données de direction.
OT_ERROR_INVALID_STATE
Aucune donnée de direction n'est présente.
OT_ERROR_NOT_FOUND
aEui64 n'est pas inclus dans les données de direction.

otNetDataSteeringDataCheckJoinerDisDisner

otError otNetDataSteeringDataCheckJoinerWithDiscerner(
  otInstance *aInstance,
  const struct otJoinerDiscerner *aDiscerner
)

Vérifiez si les données de direction comprennent une jointure avec une valeur de discerner donnée.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aDiscerner
Pointeur vers l'agent de jointure.
Valeurs renvoyées
OT_ERROR_NONE
aDiscerner est inclus dans les données de direction.
OT_ERROR_INVALID_STATE
Aucune donnée de direction n'est présente.
OT_ERROR_NOT_FOUND
aDiscerner n'est pas inclus dans les données de direction.

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

Annule la publication de toute entrée de service DNS/SRP (Anycast ou Unicast) précédemment ajoutée aux données du réseau Thread.

OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE doit être activé.

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

otNetDataUnpublishPrefix

otError otNetDataUnpublishPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

annule la publication d'un préfixe de route externe (ou maillé) publié.

OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE doit être activé.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aPrefix
Préfixe à annuler pour la publication (DO NOT be NULL).
Valeurs renvoyées
OT_ERROR_NONE
La publication du préfixe a bien été annulée.
OT_ERROR_NOT_FOUND
Impossible de trouver le préfixe dans la liste publiée.

otThreaddemain

otError otThreadBecomeChild(
  otInstance *aInstance
)

Essayez de l'associer à nouveau en tant qu'enfant.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Valeurs renvoyées
OT_ERROR_NONE
Essayez de devenir un enfant.
OT_ERROR_INVALID_STATE
Le fil de discussion est désactivé.

otThreaddestinataire

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Dissocier du réseau Thread.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Valeurs renvoyées
OT_ERROR_NONE
La connexion a bien été dissociée du réseau Thread.
OT_ERROR_INVALID_STATE
Le fil de discussion est désactivé.

otThreadDetachGraceful

otError otThreadDetachGracefully(
  otInstance *aInstance,
  otDetachGracefullyCallback aCallback,
  void *aContext
)

Cette fonction informe les autres nœuds du réseau (le cas échéant) et arrête l'opération de protocole Thread.

Il envoie une libération d'adresses s'il s'agit d'un routeur, ou définit son délai d'inactivité sur 0 si le routeur est un enfant.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aCallback
Pointeur vers une fonction qui est appelée à la fin de la dissociation.
[in] aContext
Un pointeur vers un contexte spécifique pour l'application de rappel.
Valeurs renvoyées
OT_ERROR_NONE
La dissociation a bien été effectuée.
OT_ERROR_BUSY
La dissociation est déjà en cours.

otThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

Convertissez le rôle d'appareil en chaîne lisible.

Détails
Paramètres
[in] aRole
Rôle Appareil à convertir.
Renvoie
Chaîne représentant aRole.

OTThreadDiscover

otError otThreadDiscover(
  otInstance *aInstance,
  uint32_t aScanChannels,
  uint16_t aPanId,
  bool aJoiner,
  bool aEnableEui64Filtering,
  otHandleActiveScanResult aCallback,
  void *aCallbackContext
)

Cette fonction lance une analyse Thread Discovery.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aScanChannels
Bit vectoriel indiquant les canaux à rechercher (par exemple, OT_CHANNEL_11_MASK).
[in] aPanId
Filtre d'ID PAN (défini sur PAN de diffusion pour désactiver le filtre).
[in] aJoiner
Valeur de l'indicateur de jointure dans le fichier TLV de la demande de découverte.
[in] aEnableEui64Filtering
TRUE pour filtrer les réponses sur EUI-64 ou FALSE dans le cas contraire.
[in] aCallback
Pointeur vers une fonction appelée sur la réception d'une réponse de détection MLE ou d'une analyse terminée.
[in] aCallbackContext
Un pointeur vers un contexte spécifique à l'application
Valeurs renvoyées
OT_ERROR_NONE
L'analyse Thread Discovery a bien été lancée.
OT_ERROR_INVALID_STATE
L'interface IPv6 n'est pas activée (netif n'est pas opérationnel).
OT_ERROR_NO_BUFS
Impossible d'allouer un message pour la demande de découverte.
OT_ERROR_BUSY
L'analyse Thread Discovery est déjà en cours.

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

Obtenez le délai avant expiration du fil de discussion Thread utilisé lorsque le rôle enfant est utilisé.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Valeur du délai avant expiration du thread enfant, en secondes.
Voir aussi:
otThreadSetChildTimeout

OTThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Obtenez le rôle de l'appareil.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Valeurs renvoyées
OT_DEVICE_ROLE_DISABLED
La pile de fils de discussion est désactivée.
OT_DEVICE_ROLE_DETACHED
L'appareil ne participe actuellement à aucun réseau/partition Thread.
OT_DEVICE_ROLE_CHILD
L'appareil fonctionne actuellement en tant qu'enfant Thread.
OT_DEVICE_ROLE_ROUTER
L'appareil fonctionne actuellement en tant que routeur Thread.
OT_DEVICE_ROLE_LEADER
L'appareil est actuellement l'un des leaders du fil de discussion.

otThreadGetNom

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Obtenez le nom de domaine du fil de discussion.

Cette fonction n'est disponible que depuis Thread 1.2.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Un pointeur vers le nom de domaine du fil de discussion.
Voir aussi :
otThreadSetEndpoint

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Obtenez l'identifiant PAN étendu de la norme IEEE 802.15.4.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Un pointeur vers l'identifiant PAN étendu de la norme IEEE 802.15.4.
Voir aussi:
otThreadSetExtendedPanId

otThreadGetFixDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

Obtenez l'identifiant d'interface spécifié manuellement pour l'adresse unicast de domaine de fils de discussion.

Cette fonction n'est disponible que depuis Thread 1.2 lorsque OPENTHREAD_CONFIG_DUA_ENABLE est activé.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Pointeur vers l'identifiant d'interface défini manuellement ou NULL si aucun n'a été défini.
Voir aussi :
otThreadSetFixDuaInterfaceIdentifier

otThreadGetIp6Compteurs

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Obtenez les compteurs IPv6.

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

otThreadGetKeySéquenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Obtenez le paramètre thmozillaSéquenceCounter.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
La valeur de la règle th알ATIONCounter
Voir aussi:
otThreadSetKeySéquenceCounter

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Obtenez la commande thmozillaSwitchGuardTime.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Valeur thmozillaSwitchGuardTime (en heures).
Voir également :
otThreadSetKeySwitchGuardTime

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Cette fonction obtient les données des dirigeants de fils de discussion.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[out] aLeaderData
Point de repère indiquant où les données de la variante optimale sont placées.
Valeurs renvoyées
OT_ERROR_NONE
Les données des variantes principales ont bien été récupérées.
OT_ERROR_DETACHED
Aucune pièce jointe actuellement.

otThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

Cette fonction renvoie un repère au RLOC du dirigeant.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[out] aLeaderRloc
Un pointeur vers le RLOC du dirigeant.
Valeurs renvoyées
OT_ERROR_NONE
Le RLOC du dirigeant a bien été écrit à aLeaderRloc.
OT_ERROR_INVALID_ARGS
La valeur de aLeaderRloc était NULL.
OT_ERROR_DETACHED
Actuellement, il n'est pas associé à une partition de thread.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Obtenez l'ID du routeur du leader.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
ID du routeur du leader.

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

Obtenez le poids du leader.

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

otThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Cette fonction renvoie l'adresse de multidiffusion Thread Link-Local All Thread Nodes.

Il s'agit d'une adresse URL locale Préfixe Unicast RFC [3306], avec:

  • flgs défini sur 3 (P = 1 et T = 1)
  • Scop défini sur 2
  • Veuillez définir la valeur 64
  • le préfixe réseau défini sur "Préfixe local du réseau maillé"
  • ID de groupe défini sur 1

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Un pointeur vers l'adresse de multidiffusion Thread Link-Local All Thread Nodes.

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

Cette fonction renvoie l'adresse IPv6 locale du lien Thread.

L'adresse locale du lien Thread est dérivée à l'aide de l'IEEE802.15.4 d'adresse étendue comme identifiant d'interface.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Un pointeur vers l'adresse IPv6 du lien local.

OTThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

Obtenez la configuration du mode d'association MLE.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Configuration du mode lien MLE.
Voir aussi:
otThreadSetLinkMode

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

Cette fonction renvoie un pointeur vers l'adresse EID local du réseau maillé.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Pointeur vers l'adresse EID du réseau maillé local.

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

Cette fonction renvoie un pointeur vers le préfixe local du réseau maillé.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Pointeur vers le préfixe local du réseau maillé.

otThreadGetMleCompteurs

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Obtenez les compteurs MLE de Thread.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Un pointeur vers les compteurs MLE de Thread.

OTThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

Obtenez la clé réseau Thread.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[out] aNetworkKey
Un pointeur vers un otNetworkkey pour renvoyer la clé réseau Thread.
Voir aussi :
otThreadSetNetworkKey

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

Obtenez le otNetworkKeyRef de la clé réseau Thread.

Cette fonction nécessite l'activation de la fonctionnalité de compilation OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Référence à la clé réseau Thread stockée en mémoire.
Voir aussi :
otThreadSetNetworkKeyRef

OTThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

Obtenez le nom du réseau Thread.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Un pointeur vers le nom du réseau Thread.
Voir aussi :
otThreadSetNetworkName

otThreadGetNextDiagnosticTlv

otError otThreadGetNextDiagnosticTlv(
  const otMessage *aMessage,
  otNetworkDiagIterator *aIterator,
  otNetworkDiagTlv *aNetworkDiagTlv
)

Cette fonction reçoit le prochain TLV de diagnostic réseau dans le message.

Un appel ultérieur à cette fonction n'est autorisé que lorsque la valeur de retour actuelle est OT_ERROR_NONE.

Détails
Paramètres
[in] aMessage
Pointeur vers un message.
[in,out] aIterator
Pointeur vers le contexte de l'itérateur de diagnostic réseau. Pour obtenir le premier TLV de diagnostic réseau, définissez-le sur OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
[out] aNetworkDiagTlv
Point à quel endroit les informations TLV de diagnostic du réseau seront placées.
Valeurs renvoyées
OT_ERROR_NONE
Le fichier TLV de diagnostic du réseau a bien été trouvé.
OT_ERROR_NOT_FOUND
Le fichier TLV de diagnostic du réseau suivant n'existe pas dans le message.
OT_ERROR_PARSE
Échec de l'analyse du prochain diagnostic réseau.

otThreadGetNextNeighborInfo

otError otThreadGetNextNeighborInfo(
  otInstance *aInstance,
  otNeighborInfoIterator *aIterator,
  otNeighborInfo *aInfo
)

Cette fonction obtient les informations voisines suivantes.

Elle permet de parcourir les entrées de la table voisine.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in,out] aIterator
Pointeur vers le contexte de l'itérateur. Pour obtenir la première entrée voisine, elle doit être définie sur OT_NEIGHBOR_INFO_ITERATOR_INIT.
[out] aInfo
Un pointeur vers les informations des voisins.
Valeurs renvoyées
OT_ERROR_NONE
L'entrée voisine dans la table a bien été trouvée.
OT_ERROR_NOT_FOUND
Aucune entrée de voisine n'existe dans la table.
OT_ERROR_INVALID_ARGS
aIterator ou aInfo était NULL.

otThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

La fonction récupère le RSSI moyen du parent Thread.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[out] aParentRssi
Point à placer sur le RSSI parent.

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

La fonction récupère les informations de diagnostic d'un routeur Thread en tant que parent.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[out] aParentInfo
Pointeur indiquant l'emplacement des informations du routeur parent.

otThreadGetParentDernièreRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

La fonction récupère le flux RSSI du dernier paquet à partir du thread Thread.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[out] aLastRssi
Un pointeur vers l'emplacement du dernier RSSI.
Valeurs renvoyées
OT_ERROR_NONE
Les données RSSI ont bien été récupérées.
OT_ERROR_FAILED
Impossible d'obtenir les données RSSI.
OT_ERROR_INVALID_ARGS
aLastRssi est NULL.

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Obtenez l'ID de la partition.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
ID de la partition.

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Cette fonction renvoie l'adresse de multidiffusion Thread Realm-Local All Thread Nodes.

L'adresse est une adresse Multcast de norme Unicast locale locale [RFC 3306], avec:

  • flgs défini sur 3 (P = 1 et T = 1)
  • Scop 3
  • Veuillez définir la valeur 64
  • le préfixe réseau défini sur "Préfixe local du réseau maillé"
  • ID de groupe défini sur 1

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Un pointeur vers l'adresse multicast des nœuds Thread Realm-Local de tous les nœuds Thread.

OTThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

Cette fonction renvoie un pointeur vers l'adresse du RLOC (Thread Routing Locator).

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Un pointeur vers l'adresse de l'outil de localisation de routage des fils de discussion (RLOC, Thread Routing Locator).

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Obtenez le RLOC16.

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

otThreadGetServiceAloc

otError otThreadGetServiceAloc(
  otInstance *aInstance,
  uint8_t aServiceId,
  otIp6Address *aServiceAloc
)

Cette fonction récupère l'ALOC du service pour l'ID de service donné.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aServiceId
ID de service pour lequel acheter ALOC.
[out] aServiceAloc
Point de sortie pour l'ALOC du service. NE DOIT PAS ÊTRE NULL.
Valeurs renvoyées
OT_ERROR_NONE
L'ALOC du service a bien été récupéré.
OT_ERROR_DETACHED
L'interface Thread n'est actuellement pas associée à une partition Thread.

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

Cette fonction obtient la version du protocole Thread.

Détails
Renvoie
la version du protocole Thread.

otThreadIsanycastFindInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

Cette fonction indique si une requête de localisation Anycast est en cours.

Cette fonction n'est disponible que lorsque l'option OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE est activée.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
TRUE si une requête de localisation Anycast est en cours, FALSE dans le cas contraire.

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

Cette fonction détermine si une découverte de thread MLE est en cours.

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

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

Cette fonction indique si le nœud est le seul routeur du réseau.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Valeurs renvoyées
TRUE
C'est le seul routeur du réseau.
FALSE
C'est un enfant ou un autre routeur du réseau.

otThreadFindanycastDestination

otError otThreadLocateAnycastDestination(
  otInstance *aInstance,
  const otIp6Address *aAnycastAddress,
  otThreadAnycastLocatorCallback aCallback,
  void *aContext
)

Cette fonction demande la destination la plus proche d'une adresse Anycast donnée.

Cette fonction n'est disponible que lorsque l'option OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE est activée.

Si une requête précédente est en cours, un appel ultérieur à cette fonction annule et remplace la requête précédente.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aAnycastAddress
Adresse Anycast à localiser. NE DOIT PAS être NULL.
[in] aCallback
Fonction de rappel pour générer le résultat.
[in] aContext
Contexte arbitraire utilisé avec aCallback
Valeurs renvoyées
OT_ERROR_NONE
La requête a bien été traitée. aCallback sera appelé pour signaler le résultat.
OT_ERROR_INVALID_ARGS
aAnycastAddress n'est pas une adresse Anycast valide ou aCallback est NULL.
OT_ERROR_NO_BUFS
Mémoire tampon insuffisante pour préparer et envoyer le message de requête.

otThreadRegisterParentResponseCallback

void otThreadRegisterParentResponseCallback(
  otInstance *aInstance,
  otThreadParentResponseCallback aCallback,
  void *aContext
)

Cette fonction enregistre un rappel pour recevoir les données de la réponse parent MLE.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aCallback
Pointeur vers une fonction qui est appelée lors de la réception d'un message de réponse parent MLE.
[in] aContext
Un pointeur vers un contexte spécifique pour le rappel du client.

otThreadResetIp6Compteurs

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Réinitialisez les compteurs IPv6.

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

otThreadResetMleCompteurs

void otThreadResetMleCounters(
  otInstance *aInstance
)

Réinitialisez les compteurs Thread MLE.

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

otThreadSendAddressNotification

void otThreadSendAddressNotification(
  otInstance *aInstance,
  otIp6Address *aDestination,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid
)

Cette fonction envoie un message de notification d'adresse proactive (ADDR_NTF.ntf).

Cette fonction n'est disponible que lorsque l'option OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE est activée.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aDestination
Destination à laquelle envoyer le message ADDR_NTF.ntf.
[in] aTarget
Adresse cible du message ADDR_NTF.ntf.
[in] aMlIid
Identifiant ML-IID du message ADDR_NTF.ntf.

otThreadSendDiagnosticGet

otError otThreadSendDiagnosticGet(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount,
  otReceiveDiagnosticGetCallback aCallback,
  void *aCallbackContext
)

Envoyez une requête de diagnostic réseau.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aDestination
Pointeur vers l'adresse de destination.
[in] aTlvTypes
Tableau des types de TLV de diagnostic du réseau.
[in] aCount
Nombre de types dans "aTlvTypes".
[in] aCallback
Pointeur vers une fonction appelée lorsque la réponse "Get Diagnostic Get" est reçue ou "NULL" pour désactiver le rappel.
[in] aCallbackContext
Un pointeur vers un contexte spécifique à l'application
Valeurs renvoyées
OT_ERROR_NONE
L'élément DIAG_GET.req a bien été mis en file d'attente.
OT_ERROR_NO_BUFS
Tampons de message insuffisants pour envoyer DIAG_GET.req.

otThreadSendDiagnosticReset

otError otThreadSendDiagnosticReset(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount
)

Envoyer une demande de réinitialisation du diagnostic du réseau.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aDestination
Pointeur vers l'adresse de destination.
[in] aTlvTypes
Tableau des types de TLV de diagnostic du réseau. Pour le moment, seul le type 9 est autorisé.
[in] aCount
Nombre de types dans aTlvTypes
Valeurs renvoyées
OT_ERROR_NONE
L'élément DIAG_RST.ntf a bien été mis en file d'attente.
OT_ERROR_NO_BUFS
Tampons de message insuffisants pour envoyer DIAG_RST.ntf.

otThreadSendProactiveBackboneNotification

otError otThreadSendProactiveBackboneNotification(
  otInstance *aInstance,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid,
  uint32_t aTimeSinceLastTransaction
)

Cette fonction envoie un message de notification backbone proactive (PRO_BB.ntf) sur le lien backbone.

Cette fonction n'est disponible que lorsque l'option OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE est activée.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aTarget
Adresse cible du message PRO_BB.ntf.
[in] aMlIid
Identifiant ML-IID du message PRO_BB.ntf.
[in] aTimeSinceLastTransaction
Temps écoulé depuis la dernière transaction (en secondes).
Valeurs renvoyées
OT_ERROR_NONE
Le lien backbone du fichier PRO_BB.ntf a bien été envoyé.
OT_ERROR_NO_BUFS
Si le tampon de message est insuffisant,

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Définissez le délai avant expiration du thread enfant utilisé lors de l'utilisation du rôle Enfant.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aTimeout
Valeur du délai avant expiration, en secondes.
Voir aussi :
otThreadGetChildTimeout

otThreadSetDiscoveryRequestCallback

void otThreadSetDiscoveryRequestCallback(
  otInstance *aInstance,
  otThreadDiscoveryRequestCallback aCallback,
  void *aContext
)

Cette fonction définit un rappel pour recevoir les données de la requête de découverte MLE.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aCallback
Pointeur vers une fonction qui est appelée lors de la réception d'un message de demande de découverte MLE.
[in] aContext
Un pointeur vers un contexte spécifique pour l'application de rappel.

otThreadSet bureaux

otError otThreadSetDomainName(
  otInstance *aInstance,
  const char *aDomainName
)

Définissez le nom de domaine Thread.

Cette fonction n'est disponible que depuis Thread 1.2. Cette fonction n'aboutit que lorsque les protocoles Thread sont désactivés.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aDomainName
Un pointeur vers le nom de domaine du fil de discussion.
Valeurs renvoyées
OT_ERROR_NONE
Le nom de domaine du fil de discussion a bien été défini.
OT_ERROR_INVALID_STATE
Les protocoles Thread sont activés.
Voir aussi:
otThreadGetQwiklab

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Cette fonction lance l'opération de protocole Thread.

L'interface doit être active lorsque vous appelez cette fonction.

L'appel de cette fonction avec la fonction aEnabled définie sur FALSE arrête tous les processus en cours de dissociation lancés par otThreadDetachGraceful(). Son rappel sera appelé.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aEnabled
Prend la valeur TRUE si Thread est activé.
Valeurs renvoyées
OT_ERROR_NONE
L'opération de protocole Thread a bien été lancée.
OT_ERROR_INVALID_STATE
L'interface réseau n'a pas été opérationnelle.

otThreadSetExtendPanId

otError otThreadSetExtendedPanId(
  otInstance *aInstance,
  const otExtendedPanId *aExtendedPanId
)

Définissez l'ID PAN étendu de la norme IEEE 802.15.4.

Cette fonction ne peut être appelée que lorsque les protocoles Thread sont désactivés. L'appel de cette fonction aboutit dans les ensembles de données opérationnels actifs et en attente dans la mémoire non volatile.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aExtendedPanId
Un pointeur vers l'identifiant PAN étendu de la norme IEEE 802.15.4.
Valeurs renvoyées
OT_ERROR_NONE
L'ID de PAN étendu a bien été défini.
OT_ERROR_INVALID_STATE
Les protocoles Thread sont activés.
Voir aussi:
otThreadGetExtendedPanId

otThreadSetFixDuaInterfaceIdentifier

otError otThreadSetFixedDuaInterfaceIdentifier(
  otInstance *aInstance,
  const otIp6InterfaceIdentifier *aIid
)

Définir/Effacer l'identifiant d'interface spécifié manuellement pour l'adresse unicast du domaine de fils de discussion.

Cette fonction n'est disponible que depuis Thread 1.2 lorsque OPENTHREAD_CONFIG_DUA_ENABLE est activé.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aIid
Pointeur vers l'identifiant d'interface à définir ou NULL pour effacer.
Valeurs renvoyées
OT_ERROR_NONE
L'identifiant d'interface a bien été défini et effacé.
OT_ERROR_INVALID_ARGS
L'identifiant d'interface spécifié est réservé.
Voir aussi :
otThreadGetFixDuaInterfaceIdentifier

otThreadSetJoinerAdvertising

otError otThreadSetJoinerAdvertisement(
  otInstance *aInstance,
  uint32_t aOui,
  const uint8_t *aAdvData,
  uint8_t aAdvDataLength
)

Cette méthode permet de définir la publicité pour Thread Joiner lors de la découverte du réseau Thread.

Une Publicité de fil de discussion est utilisée pour permettre à un Joint d'effectuer la promotion de ses propres informations spécifiques à l'application (telles que l'ID de fournisseur, l'ID de produit, le Discriminateur, etc.) via un TLV de publicité proposé, et de rendre ces informations accessibles aux Commissaires ou aux Candidats sans aucune interaction humaine.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aOui
Valeur UI du fournisseur qui sera incluse dans l'annonce associée. Seuls les trois octets les moins significatifs sont utilisés, et l'octet le plus significatif est ignoré.
[in] aAdvData
Pointeur vers les données AdvData qui seront incluses dans la Publicité Joiner.
[in] aAdvDataLength
Longueur d'AdvData en octets.
Valeurs renvoyées
OT_ERROR_NONE
L'annonce de jointures a bien été définie.
OT_ERROR_INVALID_ARGS
Données AdvData non valides.

otThreadSetKeySerialCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Définissez le paramètre thmozillaRuleCounter.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aKeySequenceCounter
La valeur de la règle th알ATIONCounter
Voir aussi :
otThreadGetKeySéquenceCounter

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Définissez la valeur thmozillaSwitchGuardTime.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aKeySwitchGuardTime
Valeur thmozillaSwitchGuardTime (en heures).
Voir aussi :
otThreadGetKeySwitchGuardTime

otThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Définissez la configuration du mode d'association MLE.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aConfig
Un pointeur vers la configuration du mode lien
Valeurs renvoyées
OT_ERROR_NONE
La configuration du mode d'association MLE a bien été définie.
Voir aussi:
otThreadGetLinkMode

otThreadSetMeshLocalPrefix

otError otThreadSetMeshLocalPrefix(
  otInstance *aInstance,
  const otMeshLocalPrefix *aMeshLocalPrefix
)

Cette fonction définit le préfixe local du maillage.

Cette fonction n'aboutit que lorsque les protocoles Thread sont désactivés. L'appel de cette fonction aboutit dans les ensembles de données opérationnels actifs et en attente dans la mémoire non volatile.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aMeshLocalPrefix
Pointeur vers le préfixe local du réseau maillé.
Valeurs renvoyées
OT_ERROR_NONE
Le préfixe local du maillage a bien été défini.
OT_ERROR_INVALID_STATE
Les protocoles Thread sont activés.

OTThreadSetNetworkKey

otError otThreadSetNetworkKey(
  otInstance *aInstance,
  const otNetworkKey *aKey
)

Définissez la clé réseau Thread.

Cette fonction n'aboutit que lorsque les protocoles Thread sont désactivés. L'appel de cette fonction aboutit dans les ensembles de données opérationnels actifs et en attente dans la mémoire non volatile.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aKey
Point d'accès à un tampon contenant la clé réseau Thread.
Valeurs renvoyées
OT_ERROR_NONE
La clé de réseau Thread a bien été définie.
OT_ERROR_INVALID_STATE
Les protocoles Thread sont activés.
Voir aussi:
otThreadGetNetworkKey

otThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

Définissez la clé réseau Thread en tant que otNetworkKeyRef.

Cette fonction n'aboutit que lorsque les protocoles Thread sont désactivés. L'appel de cette fonction aboutit dans les ensembles de données opérationnels actifs et en attente dans la mémoire non volatile.

Cette fonction nécessite l'activation de la fonctionnalité de compilation OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aKeyRef
Référence à la clé réseau Thread.
Valeurs renvoyées
OT_ERROR_NONE
La clé de réseau Thread a bien été définie.
OT_ERROR_INVALID_STATE
Les protocoles Thread sont activés.
Voir aussi :
otThreadGetNetworkKeyRef

otThreadSetNetworkName

otError otThreadSetNetworkName(
  otInstance *aInstance,
  const char *aNetworkName
)

Définissez le nom du réseau Thread.

Cette fonction n'aboutit que lorsque les protocoles Thread sont désactivés. L'appel de cette fonction aboutit dans les ensembles de données opérationnels actifs et en attente dans la mémoire non volatile.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aNetworkName
Un pointeur vers le nom du réseau Thread.
Valeurs renvoyées
OT_ERROR_NONE
Le nom du réseau Thread a bien été défini.
OT_ERROR_INVALID_STATE
Les protocoles Thread sont activés.
Voir aussi :
otThreadGetNetworkName

Macros

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Durée maximale des annonces associées à des jointures.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Initialisation de otNeighborInfoiter.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Longueur maximale du TLV de base du thread.

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

Valeur permettant d'initialiser otNetworkDataIterator.

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

Taille de l'entrée de la table enfant du diagnostic réseau.

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Initialisation de otNetworkDiagiter.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

Nombre maximal de types de TLV de diagnostic réseau à demander ou à réinitialiser.

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

ID de routeur maximal.

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

Taille maximale des données du serveur en octets. Limite théorique, presque bien plus faible.

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Taille maximale des données de service en octets.

Resources

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