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

Général

Ce module comprend 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 (préfixe sur le réseau maillé ou route externe) similaires dans les données du réseau Thread en surveillant les données du réseau et en déterminant si ou quand ajouter ou supprimer 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
}
énumération, 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
}
énumération, enum
Représente un rôle d'appareil Thread.
otNetDataPublisherEvent{
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
}
énumération, enum
Cette énumération représente les événements signalés à partir des rappels de l'éditeur.
otRoutePreference{
  OT_ROUTE_PREFERENCE_LOW = -1,
  OT_ROUTE_PREFERENCE_MED = 0,
  OT_ROUTE_PREFERENCE_HIGH = 1
}
énumération, enum
Définit les valeurs valides pour mPreference dans otExternalRouteConfig et otBorderRouterConfig.

Définitions

otBorderRouterConfig Définition
Cette structure représente la configuration d'un routeur de bordure.
otDetachGracefullyCallback)(void *aContext) Définition
void(*
Ce rappel informe l'application que le processus de dissociation est terminé.
otExternalRouteConfig Définition
Cette structure représente une configuration de route externe.
otIpCounters Définition
struct otIpCounters
Cette structure représente les compteurs de niveau IP.
otLeaderData Définition
struct otLeaderData
Cette structure représente les données Thread Leader.
otLinkModeConfig Définition
Cette structure représente une configuration du mode d'association MLE.
otMleCounters Définition
struct otMleCounters
Cette structure représente les compteurs de MLE de thread.
otNeighborInfoIterator Définition
int16_t
Utilisé pour itérer la table voisine.
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext) Définition
void(*
Ce type de pointeur de fonction définit le rappel utilisé pour avertir 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) Définition
void(*
Ce type de pointeur de fonction définit le rappel utilisé pour avertir l'ajout d'un préfixe (route réseau maillé ou externe) aux données du réseau Thread, ou suppression de celles-ci.
otNetDataPublisherEvent Définition
Cette énumération représente les événements signalés à partir des rappels de l'éditeur.
otNetworkDataIterator Définition
uint32_t
Permet de itérer les informations des données réseau.
otNetworkDiagChildEntry Définition
Cette structure représente une entrée de table enfant de diagnostic réseau.
otNetworkDiagConnectivity Définition
Cette structure représente une valeur de connectivité du diagnostic réseau.
otNetworkDiagIterator Définition
uint16_t
Permet de itérer via le diagnostic du réseau TLV.
otNetworkDiagMacCounters Définition
Cette structure représente une valeur de compteurs de diagnostic réseau pour Mac.
otNetworkDiagRoute Définition
Cette structure représente une valeur TLV de route de diagnostic réseau.
otNetworkDiagRouteData Définition
Cette structure représente des données de routage de diagnostic de réseau.
otNetworkDiagTlv Définition
Cette structure représente un fichier TLV de diagnostic réseau.
otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) Définition
void(*
Ce pointeur de fonction est appelé lorsque la réponse de type "Diagnostic réseau" est reçue.
otRoutePreference Définition
Définit les valeurs valides pour mPreference dans otExternalRouteConfig et otBorderRouterConfig.
otServerConfig Définition
Cette structure représente une configuration de serveur.
otServiceConfig Définition
Cette structure représente une configuration de service.
otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) Définition
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) Définition
void(*
Ce pointeur de fonction est appelé à chaque fois qu'un message de requête de découverte MLE est reçu.
otThreadDiscoveryRequestInfo Définition
Cette structure représente les données de requête Thread Discovery.
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext) Définition
void(*
Ce pointeur de fonction est appelé à chaque fois qu'un message de réponse parent MLE est reçu.
otThreadParentResponseInfo Définition
Cette structure représente les données MLE Parent Response.

Fonctions

otNetDataContainsOmrPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Cette fonction vérifie si un préfixe donné peut agir en tant que préfixe OMR valide, et si les données réseau du 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)
Cette fonction obtient le prochain préfixe de maillage activé 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 "Service DNS/SRP" est ajoutée ou non 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 (route maillée ou externe) est actuellement 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 de service dans les données du réseau Thread.
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
Cette fonction demande la publication des adresses DNS/SRP du service Thread.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
void
Cette fonction demande la publication des adresses DNS/SRP du service 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 l'envoi d'une notification lorsqu'un 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 être informé lorsqu'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 comprennent un menuisier.
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
Vérifiez si les données de direction comprennent un Joiner ayant une valeur de discerneur donnée.
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
void
Annule la publication des entrées de service DNS/SRP (anycast ou Unicast) précédemment ajoutées aux données du réseau Thread.
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
Annule la publication d'un préfixe de routage externe ou sur réseau maillé publié.
otThreadBecomeChild(otInstance *aInstance)
Essayez de le réassocier en tant qu'enfant.
otThreadBecomeDetached(otInstance *aInstance)
Dissocier du réseau Thread.
otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
Cette fonction avertit les autres nœuds du réseau (le cas échéant), puis interrompt le fonctionnement du protocole Thread.
otThreadDeviceRoleToString(otDeviceRole aRole)
const char *
Convertissez le rôle de l'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
Récupère le délai d'expiration enfant du thread (en secondes) utilisé dans le rôle enfant.
otThreadGetDeviceRole(otInstance *aInstance)
Obtenez le rôle correspondant à l'appareil.
otThreadGetDomainName(otInstance *aInstance)
const char *
Récupère le nom de domaine du thread.
otThreadGetExtendedPanId(otInstance *aInstance)
const otExtendedPanId *
Récupère l'ID PAN étendu de la norme IEEE 802.15.4.
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
Récupère l'identifiant d'interface spécifié manuellement pour l'adresse Unicast du domaine de thread.
otThreadGetIp6Counters(otInstance *aInstance)
const otIpCounters *
Récupère les compteurs IPv6.
otThreadGetKeySequenceCounter(otInstance *aInstance)
uint32_t
Obtenez le code de la variable th알SéquenceCounter.
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
uint32_t
Obtenez le paramètre th알SwitchGuardTime.
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
Cette fonction récupère les données Thread Lead.
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
Cette fonction renvoie un pointeur vers la fonction RLOC du responsable.
otThreadGetLeaderRouterId(otInstance *aInstance)
uint8_t
Obtenez l'ID de 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, tous les nœuds Thread.
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
const otIp6Address *
Cette fonction renvoie l'adresse IPv6 locale du lien de 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 locale du maillage.
otThreadGetMeshLocalPrefix(otInstance *aInstance)
Cette fonction renvoie un pointeur au préfixe local du maillage.
otThreadGetMleCounters(otInstance *aInstance)
const otMleCounters *
Récupère les compteurs MLE de thread.
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
void
Obtenez la clé réseau Thread.
otThreadGetNetworkKeyRef(otInstance *aInstance)
Obtenez le otNetworkKeyRef pour 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 de réseau dans le message.
otThreadGetNextNeighborInfo(otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
Cette fonction obtient les informations du prochain voisin.
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 l'identifiant RSSI du dernier paquet à partir du thread parent.
otThreadGetPartitionId(otInstance *aInstance)
uint32_t
Obtenez l'ID de 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 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 un nœud est le seul routeur du réseau.
otThreadLocateAnycastDestination(otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
Cette fonction demande à localiser 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 réponse parentale MLE.
otThreadResetIp6Counters(otInstance *aInstance)
void
Réinitialise les compteurs IPv6.
otThreadResetMleCounters(otInstance *aInstance)
void
Réinitialise les compteurs MLE de thread.
otThreadSearchForBetterParent(otInstance *aInstance)
Démarre le processus pour que l'enfant recherche un meilleur parent tout en restant associé à son parent actuel.
otThreadSendAddressNotification(otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
Cette fonction envoie un message ADDR_NTF.ntf (notification d'adresse proactive).
otThreadSendDiagnosticGet(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
Envoyez une requête Get de diagnostic réseau.
otThreadSendDiagnosticReset(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
Envoyez une demande de réinitialisation du diagnostic réseau.
otThreadSendProactiveBackboneNotification(otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
Cette fonction envoie un message de notification sur le réseau backbone (PRO_BB.ntf) de manière proactive.
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
void
Définit le délai d'expiration enfant (en secondes) du thread enfant utilisé dans le 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éfinit le nom de domaine du thread.
otThreadSetEnabled(otInstance *aInstance, bool aEnabled)
Cette fonction lance l'opération du protocole Thread.
otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
Définit l'ID PAN étendu de la norme IEEE 802.15.4.
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
Définit ou efface l'identifiant d'interface spécifié manuellement pour l'adresse unicast du fil de discussion.
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
Cette méthode définit l'annonce Thread Joiner lors de la découverte du réseau Thread.
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
void
Définissez le paramètre th알SéquenceCounter.
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
Définissez l'heure de th알SwitchSwitchTime.
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
Définir 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 (OTExternalRouteConfig)

Cette structure représente une configuration de route externe.

Compteurs IoT

Cette structure représente les compteurs de niveau IP.

otLeaderData

Cette structure représente les données Thread Leader.

otLinkModeConfig

Cette structure représente une configuration du mode d'association MLE.

Compteurs

Cette structure représente les compteurs de MLE de thread.

InfosNeighbor

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é du diagnostic réseau.

otNetworkDiagMacCounters

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

otNetworkDiagRoute (Route du réseau réseau)

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 Thread.

otServerConfig (OTServerConfig)

Cette structure représente une configuration de serveur.

otServiceConfig.

Cette structure représente une configuration de service.

otThreadDiscoveryRequestInfo.

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

otThreadParentResponseInfo

Cette structure représente les données MLE Parent Response.

Énumérations

énumération anonyme

 anonymous enum
Propriétés
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

Niveau de charge des piles.

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

TLV des pages de chaîne.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

Fichier TLV de la table enfant.

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

TLV de connectivité.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

Fichier TLV d'adresse étendue MAC.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

TLV de la liste d'adresses IPv6.

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

TLV des données leaders.

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

Compteurs MAC TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

TLV du délai avant expiration de l'enfant.

OT_NETWORK_DIAGNOSTIC_TLV_MODE

Mode TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

TLV de données réseau.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

Route64 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

TLV de l'adresse 16.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

Tension d'alimentation TLV.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

Délai d'inactivité du TLV (période d'interrogation maximale des SED)

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

TLV de la liste de types.

Rôle de l'appareil

 otDeviceRole

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

Propriétés
OT_DEVICE_ROLE_CHILD

Rôle Thread enfant.

OT_DEVICE_ROLE_DETACHED

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

OT_DEVICE_ROLE_DISABLED

La pile Thread est désactivée.

OT_DEVICE_ROLE_LEADER

Le rôle de responsable de fil de discussion.

OT_DEVICE_ROLE_ROUTER

Rôle de routeur de thread.

OTNetDataPublisherEvent

 otNetDataPublisherEvent

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

Propriétés
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.

Préférence de routage

 otRoutePreference

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

Propriétés
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.

otDetachGracefulCallback

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.

RouteRouteexterne externe

struct otExternalRouteConfig otExternalRouteConfig

Cette structure représente une configuration de route externe.

Compteurs OTIp

struct otIpCounters otIpCounters

Cette structure représente les compteurs de niveau IP.

OTLeaderData

struct otLeaderData otLeaderData

Cette structure représente les données Thread Leader.

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

Cette structure représente une configuration du mode d'association MLE.

Compteurs

struct otMleCounters otMleCounters

Cette structure représente les compteurs de MLE de thread.

otNeighborInfoiter

int16_t otNeighborInfoIterator

Utilisé pour itérer la table voisine.

otNetDataDnsSrpServicePublisherCallback

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

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

Lors de la suppression, le rappel est appelé 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 du réseau) ou via un appel explicite pour annuler la publication de l'entrée (par exemple, un appel à otNetDataUnpublishDnsSrpService()).

Détails
Paramètres
[in] aEvent
Indique l'événement (indique 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 avertir l'ajout d'un préfixe (route réseau maillé ou externe) aux données du réseau Thread, ou suppression de celles-ci.

Lors de la suppression, le rappel est appelé 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 (indique si l'entrée a été ajoutée ou supprimée).
[in] aPrefix
Un 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 à partir des rappels de l'éditeur.

otNetworkDataiter

uint32_t otNetworkDataIterator

Permet de itérer 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é du diagnostic réseau.

otNetworkDiagité

uint16_t otNetworkDiagIterator

Permet de itérer via le diagnostic du réseau TLV.

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

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

Pour en savoir plus sur les champs des membres, consultez le document RFC 2863.

Route du réseau

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 type "Diagnostic 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
Pointeur vers le tampon du message contenant la charge utile de réponse de diagnostic de réseau reçue. Disponible uniquement lorsque aError est OT_ERROR_NONE.
[in] aMessageInfo
Un pointeur vers les informations du message pour aMessage. Disponible uniquement lorsque aError est OT_ERROR_NONE.
[in] aContext
Un pointeur vers un contexte spécifique à l'application.

Préférence de routage

enum otRoutePreference otRoutePreference

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

Configuration du serveur

struct otServerConfig otServerConfig

Cette structure représente une configuration de serveur.

ServiceService

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 local du réseau maillé de la destination la plus proche de l'adresse Anycast lorsque aError est OT_ERROR_NONE, ou NULL dans le cas contraire.
[in] aRloc16
Valeur RLOC16 de la destination, si ce n'est pas le cas, RLOC16 non valide (0xfffe).

otThreadDiscoveryRequestCallback

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

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

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

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Cette structure représente les données de 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 statistiques.
[in] aContext
Un pointeur pour rappeler le contexte spécifique au client.

OTThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

Cette structure représente les données MLE Parent Response.

Fonctions

otNetDataContainsOmrPrefix

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

Cette fonction vérifie si un préfixe donné peut agir en tant que préfixe OMR valide, et si les données réseau du 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 du 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 indiquée par aData. Lors de la sortie, nombre d'octets copiés.

otNetDataGetNextOnMeshPrefix

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

Cette fonction obtient le prochain préfixe de maillage activé 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é, elle doit être définie sur OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Point vers lequel les informations du préfixe de maillage seront placées.
Valeurs de retour
OT_ERROR_NONE
Le préfixe suivant du réseau maillé a bien été trouvé.
OT_ERROR_NOT_FOUND
Aucun préfixe On Mesh n'existe 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 vers lequel les informations sur l'itinéraire externe seront placées.
Valeurs de retour
OT_ERROR_NONE
La route externe a bien été trouvée.
OT_ERROR_NOT_FOUND
Aucune autre entrée de route externe 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, elle doit être définie sur OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Un pointeur vers l'emplacement des informations sur le service.
Valeurs de retour
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 du 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 du réseau.

otNetDataIsDnsSrpServiceAdded

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

Cette fonction indique si l'entrée "Service DNS/SRP" est ajoutée ou non 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 de retour
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 il n'y a aucune entrée à publier.

otNetDataIsPrefixAjouté

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

Cette fonction indique si une entrée de préfixe publiée (route maillée ou externe) est actuellement 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 de retour
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 il n'y a aucune entrée à publier.

otNetDataPublishDnsSrpServiceanycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

Cette fonction demande la publication d'une adresse Anycast DNS/SRP de service 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 toute entrée de"Service DNS/SRP"déjà publiée (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 des adresses DNS/SRP du service Thread.

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

Un appel à cette fonction supprimera et remplacera toute entrée de "Service DNS/SRP" déjà publiée (de l'appel précédent à l'une des fonctions otNetDataPublishDnsSrpService{Type}()).

Cette fonction publie l'adresse Unicast du service DNS/SRP 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 des adresses DNS/SRP du service Thread.

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

Un appel à cette fonction supprimera et remplacera toute entrée de"Service DNS/SRP"déjà publiée (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 de service, cette fonction utilise l'EID local du réseau maillé 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 (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. En particulier, 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, la modification des indicateurs est immédiatement répercutée dans les données du réseau. Ainsi, les entrées existantes dans les données du réseau ne seront pas supprimées brusquement. Notez qu'une modification du niveau de préférence peut potentiellement entraîner la suppression de l'entrée des données réseau après avoir déterminé que d'autres nœuds 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 route externe à publier (NE DOIT PAS être NULL).
Valeurs de retour
OT_ERROR_NONE
La route externe a bien été publiée.
OT_ERROR_INVALID_ARGS
aConfig n'est pas valide (préfixe incorrect, combinaisons d'indicateurs non valides ou instables).
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 sur réseau maillé et la route externe) déterminé 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. En particulier, 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, la modification des indicateurs est immédiatement répercutée dans les données du réseau. Ainsi, les entrées existantes dans les données du réseau ne seront pas supprimées brusquement. Notez qu'une modification du niveau de préférence peut potentiellement entraîner la suppression de l'entrée des données réseau après avoir déterminé que d'autres nœuds 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 sur réseau maillé à publier (NE DOIT PAS être NULL).
Valeurs de retour
OT_ERROR_NONE
Le préfixe sur le réseau maillé a bien été publié.
OT_ERROR_INVALID_ARGS
aConfig n'est pas valide (préfixe incorrect, combinaisons d'indicateurs non valides ou instables).
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 sur réseau maillé et la route externe) déterminé 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 l'envoi d'une notification lorsqu'un 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 précédemment définie.

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 la fonction de rappel (peut être NULL s'il n'est pas nécessaire).
[in] aContext
Pointeur vers un contexte spécifique à l'application (utilisé lorsque la méthode aCallback est appelée).

otNetDataSetPrefixPublisherCallback

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

Cette fonction définit un rappel pour être informé lorsqu'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 précédemment définie.

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 la fonction de rappel (peut être NULL s'il n'est pas nécessaire).
[in] aContext
Pointeur vers un contexte spécifique à l'application (utilisé lorsque la méthode aCallback est appelée).

otNetDataSteeringDataCheckJoiner

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

Vérifiez si les données de direction comprennent un menuisier.

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

otNetDataSteeringDataCheckJoinerWithDiscerner (en anglais)

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

Vérifiez si les données de direction comprennent un Joiner ayant une valeur de discerneur donnée.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aDiscerner
Un pointeur sur l'opérateur de jointure.
Valeurs de retour
OT_ERROR_NONE
aDiscerner est inclus dans les données de direction.
OT_ERROR_INVALID_STATE
Aucune donnée sur la direction n'est disponible.
OT_ERROR_NOT_FOUND
aDiscerner n'est pas inclus dans les données de direction.

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

Annule la publication des entrées de service DNS/SRP (anycast ou Unicast) précédemment ajoutées 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 routage externe ou sur réseau 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 (NE DOIT PAS être NULL).
Valeurs de retour
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.

otThreadTransformEnfant

otError otThreadBecomeChild(
  otInstance *aInstance
)

Essayez de le réassocier en tant qu'enfant.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Valeurs de retour
OT_ERROR_NONE
Vous tentez de devenir un enfant.
OT_ERROR_INVALID_STATE
Fil de discussion désactivé.

otThreaddevient dissocié

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Dissocier du réseau Thread.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Valeurs de retour
OT_ERROR_NONE
La dissociation du réseau Thread a bien été effectuée.
OT_ERROR_INVALID_STATE
Fil de discussion désactivé.

OTThreadDetachGraceful

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

Cette fonction avertit les autres nœuds du réseau (le cas échéant), puis interrompt le fonctionnement du protocole Thread.

Il envoie une libération d'adresse s'il s'agit d'un routeur, ou définit son délai d'expiration enfant sur 0 s'il s'agit d'un enfant.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aCallback
Pointeur vers une fonction appelée à la fin de la dissociation.
[in] aContext
Un pointeur vers un rappel propre à l'application.
Valeurs de retour
OT_ERROR_NONE
La dissociation a réussi.
OT_ERROR_BUSY
La dissociation est déjà en cours.

otThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

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

Détails
Paramètres
[in] aRole
Rôle de l'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
Vecteur de bits indiquant les canaux à rechercher (ex. : OT_CHANNEL_11_MASK).
[in] aPanId
Le filtre d'ID PAN (défini sur Diffusion PAN pour désactiver le filtre)
[in] aJoiner
Valeur de l'indicateur Joiner dans le TLV de la requête de découverte.
[in] aEnableEui64Filtering
TRUE pour filtrer les réponses sur EUI-64, FALSE dans le cas contraire.
[in] aCallback
Un pointeur sur une fonction appelée sur la réception d'une réponse ou d'une analyse de découverte MLE est terminé.
[in] aCallbackContext
Un pointeur vers un contexte spécifique à l'application.
Valeurs de retour
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
)

Récupère le délai d'expiration enfant du thread (en secondes) utilisé dans le rôle enfant.

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

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Obtenez le rôle correspondant à l'appareil.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Valeurs de retour
OT_DEVICE_ROLE_DISABLED
La pile Thread 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 fonctionne actuellement en tant que Thread Leader.

otThreadGetDomain

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Récupère le nom de domaine du thread.

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

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Récupère l'ID 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'ID PAN étendu de la norme IEEE 802.15.4.
Voir aussi :
otThreadSetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

Récupère l'identifiant d'interface spécifié manuellement pour l'adresse Unicast du domaine de thread.

Disponible 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 également :
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counter

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Récupère 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 code de la variable th알SéquenceCounter.

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

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Obtenez le paramètre th알SwitchGuardTime.

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

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Cette fonction récupère les données Thread Lead.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[out] aLeaderData
Un pointeur vers l'emplacement des données de la variante optimale.
Valeurs de retour
OT_ERROR_NONE
Les données du responsable ont bien été récupérées.
OT_ERROR_DETACHED
Actuellement non associé.

otThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

Cette fonction renvoie un pointeur vers la fonction RLOC du responsable.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[out] aLeaderRloc
Un signal au RLOC du responsable
Valeurs de retour
OT_ERROR_NONE
Le RLOC du responsable a bien été écrit dans aLeaderRloc.
OT_ERROR_INVALID_ARGS
aLeaderRloc était NULL.
OT_ERROR_DETACHED
Actuellement non associé à une partition de thread.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Obtenez l'ID de 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
Le poids du leader

otThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Cette fonction renvoie l'adresse de multidiffusion Thread Link-Local, tous les nœuds Thread.

Il s'agit d'une adresse de liaison locale locale Unicast basée sur un préfixe [RFC 3306], avec:

  • flgs défini sur 3 (P = 1 et T = 1)
  • Scop défini sur 2
  • plen défini sur 64
  • le préfixe réseau défini sur le préfixe local du réseau maillé
  • ID du groupe défini sur 1

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Pointeur vers l'adresse de multidiffusion Thread Link-Local, tous les nœuds Thread.

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

Cette fonction renvoie l'adresse IPv6 locale du lien de thread.

L'adresse locale du lien Thread est dérivée de l'adresse IEEE802.15.4 Extended Address en tant qu'identifiant d'interface.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Pointeur vers l'adresse IPv6 de liaison locale.

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 d'association MLE.
Voir également :
otThreadSetLinkMode

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

Cette fonction renvoie un pointeur vers l'adresse EID locale du maillage.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Pointeur vers l'adresse EID locale du maillage.

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

Cette fonction renvoie un pointeur au préfixe local du maillage.

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

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Récupère les compteurs MLE de thread.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Un pointeur vers les compteurs de 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 également:
otThreadSetNetworkKey

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

Obtenez le otNetworkKeyRef pour 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
Pointeur vers le nom du réseau Thread.
Voir également:
otThreadSetNetworkName

otThreadGetNextDiagnosticTlv

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

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

Un appel ultérieur à cette fonction n'est autorisé que lorsque la valeur affichée est OT_ERROR_NONE.

Détails
Paramètres
[in] aMessage
Pointeur vers un message.
[in,out] aIterator
Un pointeur vers le contexte de l'itérateur de diagnostic réseau Pour obtenir le premier TLV de diagnostic réseau, il doit être défini sur OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
[out] aNetworkDiagTlv
Point vers lequel les informations TLV de diagnostic du réseau seront placées.
Valeurs de retour
OT_ERROR_NONE
Le prochain TLV de diagnostic réseau a bien été trouvé.
OT_ERROR_NOT_FOUND
Le message ne contient pas de TLV de diagnostic réseau.
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 du prochain voisin.

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 sur le voisin.
Valeurs de retour
OT_ERROR_NONE
L'entrée voisine suivante a bien été trouvée dans la table.
OT_ERROR_NOT_FOUND
Aucune entrée de voisin 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 vers lequel le RSSI parent doit être placé.

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
Un pointeur vers l'emplacement des informations du routeur parent.

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

La fonction récupère l'identifiant RSSI du dernier paquet à partir du thread parent.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[out] aLastRssi
Point vers lequel le dernier RSSI doit être placé.
Valeurs de retour
OT_ERROR_NONE
Les données RSSI ont bien été récupérées.
OT_ERROR_FAILED
Impossible d'obtenir des données RSSI.
OT_ERROR_INVALID_ARGS
aLastRssi est NULL.

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Obtenez l'ID de 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".

Il s'agit d'une adresse de mandcast basée sur un préfixe Unicast locale (RFC 3306), avec:

  • flgs défini sur 3 (P = 1 et T = 1)
  • Scop défini sur 3
  • plen défini sur 64
  • le préfixe réseau défini sur le préfixe local du réseau maillé
  • ID du groupe défini sur 1

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

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

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

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Pointeur vers l'adresse 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
Le 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 obtenir ALOC.
[out] aServiceAloc
Un pointeur pour générer l'ALOC du service. NE DOIT PAS être NULL.
Valeurs de retour
OT_ERROR_NONE
L'ALOC du service a bien été récupéré.
OT_ERROR_DETACHED
L'interface Thread n'est actuellement associée à aucune partition.

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 OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE est activé.

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

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 un nœud est le seul routeur du réseau.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Valeurs de retour
TRUE
C'est le seul routeur du réseau.
FALSE
Il s'agit d'un enfant ou d'un routeur unique du réseau.

otThreadFindAnycastDestination

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

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

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

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 consigner le résultat.
[in] aContext
Contexte arbitraire utilisé avec aCallback.
Valeurs de retour
OT_ERROR_NONE
La requête a bien été lancée. aCallback sera invoqué 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
Hors tampon 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 réponse parentale 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 parentale MLE.
[in] aContext
Un pointeur pour rappeler le contexte spécifique au client.

otThreadResetIp6Counter

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Réinitialise les compteurs IPv6.

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

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Réinitialise les compteurs MLE de thread.

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

OTThreadSearchForBetterParent

otError otThreadSearchForBetterParent(
  otInstance *aInstance
)

Démarre le processus pour que l'enfant recherche un meilleur parent tout en restant associé à son parent actuel.

Doit être utilisé lorsque l'appareil est associé à un enfant.

Détails
Valeurs de retour
OT_ERROR_NONE
Le processus de recherche d'un meilleur parent a démarré.
OT_ERROR_INVALID_STATE
Le rôle d'appareil n'est pas un enfant.

otThreadSendAddressNotification

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

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

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

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
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 Get 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 réseau.
[in] aCount
Nombre de types dans aTlvTypes.
[in] aCallback
Pointeur vers une fonction appelée lorsque la réponse "Get Diagnostic Network" est reçue ou "NULL" pour désactiver le rappel.
[in] aCallbackContext
Un pointeur vers un contexte spécifique à l'application.
Valeurs de retour
OT_ERROR_NONE
La tâche DIAG_GET.req a bien été mise 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
)

Envoyez une demande de réinitialisation du 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 réseau. Actuellement, seul le type 9 est autorisé.
[in] aCount
Nombre de types dans aTlvTypes
Valeurs de retour
OT_ERROR_NONE
Le fichier 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 sur le réseau backbone (PRO_BB.ntf) de manière proactive.

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

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 de retour
OT_ERROR_NONE
Le lien backbone a bien été envoyé via PRO_BB.ntf.
OT_ERROR_NO_BUFS
Si le tampon de message est insuffisant.

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Définit le délai d'expiration enfant (en secondes) du thread enfant utilisé dans le 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 également:
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 requête de découverte MLE.
[in] aContext
Un pointeur vers un rappel propre à l'application.

otThreadSetDomain

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

Définit le nom de domaine du thread.

L'opération ne réussit 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 thread.
Valeurs de retour
OT_ERROR_NONE
Le nom de domaine du thread a bien été défini.
OT_ERROR_INVALID_STATE
Les protocoles Thread sont activés.
Voir aussi:
otThreadGetDomain

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

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

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

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

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aEnabled
TRUE si Thread est activé, FALSE dans le cas contraire.
Valeurs de retour
OT_ERROR_NONE
L'opération du protocole Thread a bien été lancée.
OT_ERROR_INVALID_STATE
L'interface réseau n'était pas opérationnelle.

otThreadSetExtendedPanId

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

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

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

otThreadSetFixedDuaInterfaceIdentifier

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

Définit ou efface l'identifiant d'interface spécifié manuellement pour l'adresse unicast du fil de discussion.

Disponible 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 de retour
OT_ERROR_NONE
L'identifiant d'interface a bien été défini/supprimé.
OT_ERROR_INVALID_ARGS
L'identifiant d'interface spécifié est réservé.
Voir aussi:
otThreadGetFixedDuaInterfaceIdentifier

otThreadSetJoinerAnnonce

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

Cette méthode définit l'annonce Thread Joiner lors de la découverte du réseau Thread.

L'annonce Thread Joiner permet à un membre du programme de promotion de diffuser ses propres informations spécifiques à l'application (telles que l'ID de fournisseur, l'ID produit, l'identifiant de la discrimination, etc.) via un TLV de publicité proposé par les participants, et de mettre ces informations à la disposition des Commissaires ou des candidats. Sans interaction humaine.

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

otThreadSetKeySéquenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Définissez le paramètre th알SéquenceCounter.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aKeySequenceCounter
La valeur de th알SéquenceCounter
Voir également :
otThreadGetKeySéquenceCounter

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Définissez l'heure de th알SwitchSwitchTime.

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

otThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Définir 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 de retour
OT_ERROR_NONE
La configuration du mode d'association MLE a bien été définie.
Voir également :
otThreadGetLinkMode

otThreadSetMeshLocalPrefix

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

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

Cette fonction ne fonctionne que lorsque les protocoles Thread sont désactivés. Un appel réussi à cette fonction invalide 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 maillage.
Valeurs de retour
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 ne fonctionne que lorsque les protocoles Thread sont désactivés. Un appel réussi à cette fonction invalide 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
Un pointeur vers un tampon contenant la clé réseau Thread.
Valeurs de retour
OT_ERROR_NONE
La clé 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 ne fonctionne que lorsque les protocoles Thread sont désactivés. Un appel réussi à cette fonction invalide 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é de réseau Thread.
Valeurs de retour
OT_ERROR_NONE
La clé 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 ne fonctionne que lorsque les protocoles Thread sont désactivés. Un appel réussi à cette fonction invalide 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
Pointeur vers le nom du réseau Thread.
Valeurs de retour
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 également:
otThreadGetNetworkName

Macros

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Longueur maximale d'une annonce associée.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Initialisation pour otNeighborInfoiter.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Longueur maximale du TLV de base de fil de discussion.

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 table enfant de 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, quasiment inférieure.

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Taille maximale des données de service en 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.