Google is committed to advancing racial equity for Black communities. See how.

Cette page a été traduite par l'API Cloud Translation.

Questions d'ordre 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 permettant de limiter le nombre d'entrées de service et/ou de préfixe similaires (préfixe sur le réseau maillé ou route externe) dans les données du réseau Thread en surveillant les données réseau et en déterminant si des entrées doivent être ajoutées ou supprimées.

Toutes les fonctions de ce module nécessitent que OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE soit activé.

Remarque:Les fonctions de ce module nécessitent OPENTHREAD_FTD=1 ou OPENTHREAD_MTD=1.

É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, OT_NETWORK_DIAGNOSTIC_TLV_VERSION = 24, OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME = 25, OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL = 26, OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION = 27, OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION = 28, OT_NETWORK_DIAGNOSTIC_TLV_CHILD = 29, OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST = 30, OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR = 31, OT_NETWORK_DIAGNOSTIC_TLV_ANSWER = 32, OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID = 33, OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS = 34 }	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 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 }`	enum Définit des valeurs valides pour `mPreference` dans `otExternalRouteConfig` et `otBorderRouterConfig`.

Typedefs
`otBorderRouterConfig`	typedef `struct otBorderRouterConfig` Représente une configuration de routeur de bordure.
`otDetachGracefullyCallback)(void *aContext)`	typedef `void(*` Ce rappel informe l'application que le processus de dissociation est terminé.
`otExternalRouteConfig`	typedef `struct otExternalRouteConfig` Représente une configuration de route externe.
`otIpCounters`	typedef `struct otIpCounters` Représente les compteurs de niveaux d'adresses IP.
`otLeaderData`	typedef `struct otLeaderData` Représente les données des threads Thread.
`otLinkModeConfig`	typedef `struct otLinkModeConfig` Représente une configuration du mode lien MLE.
`otLowpanContextInfo`	typedef `struct otLowpanContextInfo` Représente les informations d'ID de contexte 6LoWPAN associées à un préfixe dans les données réseau.
`otMleCounters`	typedef `struct otMleCounters` Représente les compteurs MLE de threads.
`otNeighborInfoIterator`	typedef `int16_t` Utilisé pour itérer la table voisine.
`otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)`	typedef `void(*` Le type de pointeur définit le rappel utilisé pour avertir l'ajout ou la suppression d'une entrée "DNS/SRP" des données du réseau Thread.
`otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix aPrefix, void aContext)`	typedef `void(*` Le type de pointeur définit le rappel utilisé pour avertir la présence d'une entrée de préfixe (sur le réseau maillé ou route externe) ajoutée aux données du réseau Thread ou supprimée de celles-ci.
`otNetDataPublisherEvent`	typedef `enum otNetDataPublisherEvent` Représente les événements signalés à partir des rappels de l'éditeur.
`otNetworkDataIterator`	typedef `uint32_t` Permet de itérer les informations de données réseau.
`otNetworkDiagChildEntry`	typedef `struct otNetworkDiagChildEntry` Représente une entrée de table enfant de diagnostic réseau.
`otNetworkDiagConnectivity`	typedef `struct otNetworkDiagConnectivity` Représente une valeur de connectivité de diagnostic réseau.
`otNetworkDiagIterator`	typedef `uint16_t` Permet de itérer via le fichier de diagnostic réseau.
`otNetworkDiagMacCounters`	typedef `struct otNetworkDiagMacCounters` Représente une valeur pour les compteurs Mac de diagnostic réseau.
`otNetworkDiagMleCounters`	typedef `struct otNetworkDiagMleCounters` Représente une valeur de compteur MLE de diagnostic du réseau.
`otNetworkDiagRoute`	typedef `struct otNetworkDiagRoute` Représente une valeur TLV de diagnostic du réseau.
`otNetworkDiagRouteData`	typedef `struct otNetworkDiagRouteData` Représente une donnée de routage de diagnostic de réseau.
`otNetworkDiagTlv`	typedef `struct otNetworkDiagTlv` Représente un fichier TLV de diagnostic du réseau.
`otReceiveDiagnosticGetCallback)(otError aError, otMessage aMessage, const otMessageInfo aMessageInfo, void *aContext)`	typedef `void(*` Le pointeur est appelé lorsque la réponse Get de diagnostic réseau est reçue.
`otRoutePreference`	typedef `enum otRoutePreference` Définit des valeurs valides pour `mPreference` dans `otExternalRouteConfig` et `otBorderRouterConfig`.
`otServerConfig`	typedef `struct otServerConfig` Représente une configuration de serveur.
`otServiceConfig`	typedef `struct otServiceConfig` Représente une configuration de service.
`otThreadAnycastLocatorCallback)(void aContext, otError aError, const otIp6Address aMeshLocalAddress, uint16_t aRloc16)`	typedef `void(*` Le type de pointeur définit le rappel pour avertir le résultat d'une requête `otThreadLocateAnycastDestination()`.
`otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo aInfo, void aContext)`	typedef `void(*` Pointer est appelé à chaque fois qu'un message de requête de découverte MLE est reçu.
`otThreadDiscoveryRequestInfo`	typedef `struct otThreadDiscoveryRequestInfo` Représente les données de la requête Thread Discovery.
`otThreadParentResponseCallback)(otThreadParentResponseInfo aInfo, void aContext)`	typedef `void(*` Pointer est appelé à chaque fois qu'un message de réponse parent MLE est reçu.
`otThreadParentResponseInfo`	typedef `struct otThreadParentResponseInfo` Représente les données de réponse du MLE parent.

Fonctions
`otConvertDurationInSecondsToString(uint32_t aDuration, char *aBuffer, uint16_t aSize)`	`void` Convertit une durée de `uint32_t` (en secondes) en chaîne lisible.
`otNetDataContainsOmrPrefix(otInstance aInstance, const otIp6Prefix aPrefix)`	`bool` Vérifiez si un préfixe donné peut servir de préfixe OMR valide, ainsi que les données réseau du leader.
`otNetDataGet(otInstance aInstance, bool aStable, uint8_t aData, uint8_t *aDataLength)`	`otError` Fournissez une copie complète ou stable des données du réseau Thread de la partition.
`otNetDataGetLength(otInstance *aInstance)`	`uint8_t` Obtenez la longueur actuelle (nombre d'octets) des données du réseau Thread de Partition.
`otNetDataGetMaxLength(otInstance *aInstance)`	`uint8_t` Obtenez la longueur maximale observée des données du réseau Thread depuis l'initialisation de la pile OT ou le dernier appel à `otNetDataResetMaxLength()`.
`otNetDataGetNextLowpanContextInfo(otInstance aInstance, otNetworkDataIterator aIterator, otLowpanContextInfo *aContextInfo)`	`otError` Obtenez les informations suivantes de l'ID de contexte 6LoWPAN dans les données réseau de la partition.
`otNetDataGetNextOnMeshPrefix(otInstance aInstance, otNetworkDataIterator aIterator, otBorderRouterConfig *aConfig)`	`otError` Permet d'obtenir le préfixe sur réseau maillé suivant dans les données réseau de la partition.
`otNetDataGetNextRoute(otInstance aInstance, otNetworkDataIterator aIterator, otExternalRouteConfig *aConfig)`	`otError` Obtenez la route externe suivante dans les données réseau de la partition.
`otNetDataGetNextService(otInstance aInstance, otNetworkDataIterator aIterator, otServiceConfig *aConfig)`	`otError` Obtenez le service suivant dans les données réseau de la partition.
`otNetDataGetStableVersion(otInstance *aInstance)`	`uint8_t` Obtenez la version stable des données réseau.
`otNetDataGetVersion(otInstance *aInstance)`	`uint8_t` Obtenir la version des données réseau
`otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)`	`bool` Indique si l'entrée "Service DNS/SRP" est actuellement ajoutée aux données du réseau Thread.
`otNetDataIsPrefixAdded(otInstance aInstance, const otIp6Prefix aPrefix)`	`bool` 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` Demande la publication de l'adresse Anycast DNS/SRP Service dans les données du réseau Thread.
`otNetDataPublishDnsSrpServiceUnicast(otInstance aInstance, const otIp6Address aAddress, uint16_t aPort)`	`void` Demande la publication de l'adresse DNS/SRP du service dans les données du réseau Thread.
`otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)`	`void` Demande la publication de l'adresse DNS/SRP du service dans les données du réseau Thread.
`otNetDataPublishExternalRoute(otInstance aInstance, const otExternalRouteConfig aConfig)`	`otError` Demande la publication d'un préfixe de routage externe dans les données du réseau Thread.
`otNetDataPublishOnMeshPrefix(otInstance aInstance, const otBorderRouterConfig aConfig)`	`otError` Demande la publication d'un préfixe sur le maillage dans les données du réseau Thread.
`otNetDataReplacePublishedExternalRoute(otInstance aInstance, const otIp6Prefix aPrefix, const otExternalRouteConfig *aConfig)`	`otError` Remplace une route externe précédemment publiée dans les données du réseau Thread.
`otNetDataResetMaxLength(otInstance *aInstance)`	`void` Réinitialiser la longueur maximale suivie des données du réseau Thread.
`otNetDataSetDnsSrpServicePublisherCallback(otInstance aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void aContext)`	`void` Définit un rappel pour indiquer quand 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` Définit un rappel pour indiquer quand 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)`	`otError` Vérifiez si les données de direction incluent un menuisier.
`otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance aInstance, const struct otJoinerDiscerner aDiscerner)`	`otError` Vérifiez si les données de direction incluent un Joiner avec 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)`	`otError` Annule la publication d'un préfixe de routage sur réseau maillé ou externe publié.
`otThreadBecomeChild(otInstance *aInstance)`	`otError` Essayez de l'associer à nouveau en tant qu'enfant.
`otThreadBecomeDetached(otInstance *aInstance)`	`otError` Dissocier du réseau Thread.
`otThreadDetachGracefully(otInstance aInstance, otDetachGracefullyCallback aCallback, void aContext)`	`otError` Notifie d'autres nœuds du réseau (le cas échéant), puis arrête 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)`	`otError` Lance une analyse Thread Discovery.
`otThreadGetChildTimeout(otInstance *aInstance)`	`uint32_t` Récupère le délai avant expiration du thread enfant (en secondes) utilisé dans le rôle enfant.
`otThreadGetDeviceRole(otInstance *aInstance)`	`otDeviceRole` Obtenez le rôle de l'appareil.
`otThreadGetDomainName(otInstance *aInstance)`	`const char *` Récupère le nom de domaine Thread.
`otThreadGetExtendedPanId(otInstance *aInstance)`	`const otExtendedPanId *` Récupère l'ID PAN étendu de la norme IEEE 802.15.4.
`otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)`	`const otIp6InterfaceIdentifier *` Récupère l'identifiant d'interface spécifié manuellement pour l'adresse unicast de domaine Thread.
`otThreadGetIp6Counters(otInstance *aInstance)`	`const otIpCounters *` Récupère les compteurs IPv6.
`otThreadGetKeySequenceCounter(otInstance *aInstance)`	`uint32_t` Récupère le thGroupByKeySequenceCounter.
`otThreadGetKeySwitchGuardTime(otInstance *aInstance)`	`uint32_t` Récupère l'élément thSlideSwitchGuardTime (en heures).
`otThreadGetLeaderData(otInstance aInstance, otLeaderData aLeaderData)`	`otError` Obtenir les données sur le leader des threads
`otThreadGetLeaderRloc(otInstance aInstance, otIp6Address aLeaderRloc)`	`otError` Renvoie un pointeur vers le RLOC du leader.
`otThreadGetLeaderRouterId(otInstance *aInstance)`	`uint8_t` Obtenez l'ID de routeur du leader.
`otThreadGetLeaderWeight(otInstance *aInstance)`	`uint8_t` Prenez le poids du leader.
`otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)`	`const otIp6Address *` Récupère l'adresse de multidiffusion Thread Link-Local, tous les nœuds Thread.
`otThreadGetLinkLocalIp6Address(otInstance *aInstance)`	`const otIp6Address *` Récupère l'adresse IPv6 locale du lien Thread.
`otThreadGetLinkMode(otInstance *aInstance)`	`otLinkModeConfig` Obtenez la configuration du mode lien MLE.
`otThreadGetMaxTimeInQueue(otInstance *aInstance)`	`uint32_t` Récupère la durée maximale de la file d'attente des messages dans la file d'attente de transmission.
`otThreadGetMeshLocalEid(otInstance *aInstance)`	`const otIp6Address *` Récupère l'adresse EID locale du maillage.
`otThreadGetMeshLocalPrefix(otInstance *aInstance)`	`const otMeshLocalPrefix *` Renvoie un pointeur vers le préfixe local du maillage.
`otThreadGetMleCounters(otInstance *aInstance)`	`const otMleCounters *` Récupère les compteurs de MLE Thread.
`otThreadGetNetworkKey(otInstance aInstance, otNetworkKey aNetworkKey)`	`void` Obtenez la clé réseau Thread.
`otThreadGetNetworkKeyRef(otInstance *aInstance)`	`otNetworkKeyRef` Obtenez le `otNetworkKeyRef` pour la clé réseau Thread.
`otThreadGetNetworkName(otInstance *aInstance)`	`const char *` Obtenir le nom du réseau Thread
`otThreadGetNextDiagnosticTlv(const otMessage aMessage, otNetworkDiagIterator aIterator, otNetworkDiagTlv *aNetworkDiagTlv)`	`otError` Récupère le prochain fichier TLV de diagnostic réseau dans le message.
`otThreadGetNextNeighborInfo(otInstance aInstance, otNeighborInfoIterator aIterator, otNeighborInfo *aInfo)`	`otError` Récupère les informations voisines.
`otThreadGetParentAverageRssi(otInstance aInstance, int8_t aParentRssi)`	`otError` La fonction récupère le RSSI moyen du parent Thread.
`otThreadGetParentInfo(otInstance aInstance, otRouterInfo aParentInfo)`	`otError` La fonction récupère les informations de diagnostic d'un routeur Thread en tant que parent.
`otThreadGetParentLastRssi(otInstance aInstance, int8_t aLastRssi)`	`otError` La fonction récupère le RSSI du dernier paquet à partir du thread Thread.
`otThreadGetPartitionId(otInstance *aInstance)`	`uint32_t` Obtenez l'ID de partition.
`otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)`	`const otIp6Address *` Récupère l'adresse de multidiffusion Nœuds Thread Realm-Local.
`otThreadGetRloc(otInstance *aInstance)`	`const otIp6Address *` Récupère l'adresse de l'outil de localisation de routage des threads.
`otThreadGetRloc16(otInstance *aInstance)`	`uint16_t` Obtenez le RLOC16.
`otThreadGetServiceAloc(otInstance aInstance, uint8_t aServiceId, otIp6Address aServiceAloc)`	`otError` Récupère l'ALOC du service pour l'ID de service donné.
`otThreadGetTimeInQueueHistogram(otInstance aInstance, uint16_t aNumBins, uint32_t *aBinInterval)`	`const uint32_t *` Récupère l'histogramme de la file d'attente pour les messages de la file d'attente de transmission.
`otThreadGetVendorModel(otInstance *aInstance)`	`const char *` Obtenez la chaîne du modèle du fournisseur.
`otThreadGetVendorName(otInstance *aInstance)`	`const char *` Obtenez la chaîne du nom du fournisseur.
`otThreadGetVendorSwVersion(otInstance *aInstance)`	`const char *` Permet d'obtenir la chaîne de version SW du fournisseur.
`otThreadGetVersion(void)`	`uint16_t` Récupère la version du protocole Thread.
`otThreadIsAnycastLocateInProgress(otInstance *aInstance)`	`bool` Indique si une requête de localisation Anycast est en cours.
`otThreadIsDiscoverInProgress(otInstance *aInstance)`	`bool` Détermine si une découverte de thread MLE est en cours.
`otThreadIsSingleton(otInstance *aInstance)`	`bool` Indique si un nœud est le seul routeur du réseau.
`otThreadLocateAnycastDestination(otInstance aInstance, const otIp6Address aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)`	`otError` Demande la localisation la plus proche d'une adresse Anycast donnée.
`otThreadRegisterParentResponseCallback(otInstance aInstance, otThreadParentResponseCallback aCallback, void aContext)`	`void` Enregistre un rappel pour recevoir des données de réponse du MLE parent.
`otThreadResetIp6Counters(otInstance *aInstance)`	`void` Réinitialise les compteurs IPv6.
`otThreadResetMleCounters(otInstance *aInstance)`	`void` Réinitialise les compteurs MLE de thread.
`otThreadResetTimeInQueueStat(otInstance *aInstance)`	`void` Réinitialise les statistiques sur le temps d'attente dans la file d'attente des transmissions.
`otThreadSearchForBetterParent(otInstance *aInstance)`	`otError` Lance la recherche d'un meilleur parent pour l'enfant tout en le maintenant connecté à son parent actuel.
`otThreadSendAddressNotification(otInstance aInstance, otIp6Address aDestination, otIp6Address aTarget, otIp6InterfaceIdentifier aMlIid)`	`void` 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)`	`otError` Envoyer une requête de diagnostic réseau.
`otThreadSendDiagnosticReset(otInstance aInstance, const otIp6Address aDestination, const uint8_t aTlvTypes[], uint8_t aCount)`	`otError` Envoyez une requête de réinitialisation du diagnostic réseau.
`otThreadSendProactiveBackboneNotification(otInstance aInstance, otIp6Address aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)`	`otError` Envoie un message proactif de backbone (PRO_BB.ntf) sur le lien backbone.
`otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)`	`void` Définit le délai avant expiration des threads enfants (en secondes) lors de l'utilisation du rôle enfant.
`otThreadSetDiscoveryRequestCallback(otInstance aInstance, otThreadDiscoveryRequestCallback aCallback, void aContext)`	`void` Définit un rappel pour recevoir les données de la requête de découverte MLE.
`otThreadSetDomainName(otInstance aInstance, const char aDomainName)`	`otError` Définit le nom de domaine des threads.
`otThreadSetEnabled(otInstance *aInstance, bool aEnabled)`	`otError` Lance l'opération de protocole Thread.
`otThreadSetExtendedPanId(otInstance aInstance, const otExtendedPanId aExtendedPanId)`	`otError` Définit l'ID PAN étendu de la norme IEEE 802.15.4.
`otThreadSetFixedDuaInterfaceIdentifier(otInstance aInstance, const otIp6InterfaceIdentifier aIid)`	`otError` Définit ou efface l'identifiant d'interface spécifié manuellement pour l'adresse unicast du domaine Thread.
`otThreadSetJoinerAdvertisement(otInstance aInstance, uint32_t aOui, const uint8_t aAdvData, uint8_t aAdvDataLength)`	`otError` Définit l'annonce de la jointure Thread lors de la découverte du réseau Thread.
`otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)`	`void` Définit l'élément thSlideSequenceCounter.
`otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)`	`void` Définit l'élément thSlideSwitchGuardTime (en heures).
`otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)`	`otError` Définissez la configuration du mode lien MLE.
`otThreadSetMeshLocalPrefix(otInstance aInstance, const otMeshLocalPrefix aMeshLocalPrefix)`	`otError` Définit le préfixe local du maillage.
`otThreadSetNetworkKey(otInstance aInstance, const otNetworkKey aKey)`	`otError` Définissez la clé réseau Thread.
`otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)`	`otError` Définissez la clé réseau Thread en tant que `otNetworkKeyRef`.
`otThreadSetNetworkName(otInstance aInstance, const char aNetworkName)`	`otError` Définissez le nom du réseau Thread.
`otThreadSetVendorModel(otInstance aInstance, const char aVendorModel)`	`otError` Définissez la chaîne du modèle du fournisseur.
`otThreadSetVendorName(otInstance aInstance, const char aVendorName)`	`otError` Définissez la chaîne de nom du fournisseur.
`otThreadSetVendorSwVersion(otInstance aInstance, const char aVendorSwVersion)`	`otError` Définissez la chaîne de version du logiciel du fournisseur.

Structs
otBorderRouterConfig.	Représente une configuration de routeur de bordure.
otExternalRouteConfig	Représente une configuration de route externe.
Compteurs d'adresses IP	Représente les compteurs de niveaux d'adresses IP.
otLeaderData.	Représente les données des threads Thread.
otLinkModeConfig.	Représente une configuration du mode lien MLE.
otLowpanContextInfo	Représente les informations d'ID de contexte 6LoWPAN associées à un préfixe dans les données réseau.
otMleCounters ;	Représente les compteurs MLE de threads.
otNeighborInfo.	Contient les informations de diagnostic d'un nœud Thread voisin.
otNetworkDiagChildEntry	Représente une entrée de table enfant de diagnostic réseau.
otNetworkDiagConnectivity	Représente une valeur de connectivité de diagnostic réseau.
otNetworkDiagMacCounters	Représente une valeur pour les compteurs Mac de diagnostic réseau.
otNetworkDiagMleCounters :	Représente une valeur de compteur MLE de diagnostic du réseau.
otNetworkDiagRoute	Représente une valeur TLV de diagnostic du réseau.
otNetworkDiagRouteData	Représente une donnée de routage de diagnostic de réseau.
otNetworkDiagTlv	Représente un fichier TLV de diagnostic du réseau.
otRouterInfo.	Contient les informations de diagnostic d'un routeur Thread.
otServerConfig.	Représente une configuration de serveur.
otServiceConfig.	Représente une configuration de service.
otThreadDiscoveryRequestInfo.	Représente les données de la requête Thread Discovery.
otThreadParentResponseInfo	Représente les données de réponse du MLE parent.

Énumérations

énumération anonyme

 anonymous enum

Propriétés
`OT_NETWORK_DIAGNOSTIC_TLV_ANSWER`	Réponse au TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL`	Niveau de batterie (TLV)
`OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES`	TLV des pages de chaîne.
`OT_NETWORK_DIAGNOSTIC_TLV_CHILD`	TLV enfant.
`OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST`	Fichier TLV de la liste d'adresses IPv6 enfants.
`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 MAC étendue.
`OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST`	Fichier TLV de la liste d'adresses IPv6.
`OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA`	TLV des données leader.
`OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS`	Compteur de valeurs MAC TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT`	TLV maximal de délai avant expiration de l'enfant.
`OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS`	MLE Counter TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_MODE`	Mode TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA`	TLV de données réseau.
`OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID`	ID de requête TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_ROUTE`	TLV Route64
`OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR`	fichier TLV de routeur.
`OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS`	Address16 TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE`	Tension source d'alimentation TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION`	Version TLV de la pile de threads.
`OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT`	TLV (délai d'interrogation maximal pour les SED) avant expiration
`OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST`	Type de liste : TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL`	TLV du modèle du fournisseur.
`OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME`	TLV (Nom du fournisseur).
`OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION`	TLV de version du fournisseur du fournisseur.
`OT_NETWORK_DIAGNOSTIC_TLV_VERSION`	Version TLV.

OTDeviceRole

 otDeviceRole

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

Propriétés
`OT_DEVICE_ROLE_CHILD`	Le rôle Thread enfant.
`OT_DEVICE_ROLE_DETACHED`	Ne participe 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 thread.
`OT_DEVICE_ROLE_ROUTER`	Le rôle de routeur de thread.

OTNetDataPublisherEvent

 otNetDataPublisherEvent

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

OTRoutePreference

 otRoutePreference

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

Propriétés
`OT_ROUTE_PREFERENCE_HIGH`	Préférence pour l'itinéraire élevée.
`OT_ROUTE_PREFERENCE_LOW`	Préférence de routage faible.
`OT_ROUTE_PREFERENCE_MED`	Préférence de routage moyenne.

Typedefs

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

Représente une configuration de 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.

OTExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

Représente une configuration de route externe.

Compteurs

struct otIpCounters otIpCounters

Représente les compteurs de niveaux d'adresses IP.

OTLeaderData

struct otLeaderData otLeaderData

Représente les données des threads Thread.

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

Représente une configuration du mode lien MLE.

OTLowpanContextInfo

struct otLowpanContextInfo otLowpanContextInfo

Représente les informations d'ID de contexte 6LoWPAN associées à un préfixe dans les données réseau.

Compteurs

struct otMleCounters otMleCounters

Représente les compteurs MLE de threads.

otNeighborInfoIterator

int16_t otNeighborInfoIterator

Utilisé pour itérer la table voisine.

otNetDataDnsSrpServicePublisherCallback

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

Le type de pointeur définit le rappel utilisé pour avertir l'ajout ou la suppression d'une entrée "DNS/SRP" des données du réseau Thread.

Lors de la suppression, le rappel est appelé indépendamment du fait que l'entrée est supprimé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 (par exemple, un appel à otNetDataUnpublishDnsSrpService()).

Détails

Paramètres

`[in] aEvent`	Indique l'événement (indique que 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)

Le type de pointeur définit le rappel utilisé pour avertir la présence d'une entrée de préfixe (sur le réseau maillé ou route externe) 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 réseau) ou via un appel explicite pour annuler la publication.

Détails

Paramètres

`[in] aEvent`	Indique l'événement (indique que 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

Représente les événements signalés à partir des rappels de l'éditeur.

otNetworkDataIterator

uint32_t otNetworkDataIterator

Permet de itérer les informations de données réseau.

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

Représente une entrée de table enfant de diagnostic réseau.

OTNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

Représente une valeur de connectivité de diagnostic réseau.

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

Permet de itérer via le fichier de diagnostic réseau.

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

Représente une valeur pour les compteurs Mac de diagnostic réseau.

Pour obtenir la définition des champs de membre, consultez la RFC 2863.

otNetworkDiagMleCounters

struct otNetworkDiagMleCounters otNetworkDiagMleCounters

Représente une valeur de compteur MLE de diagnostic du réseau.

OTNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

Représente une valeur TLV de diagnostic du réseau.

OTNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

Représente une donnée de routage de diagnostic de réseau.

OTNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

Représente un fichier TLV de diagnostic du réseau.

otReceiveDiagnosticGetCallback

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

Le pointeur est appelé lorsque la réponse Get de diagnostic réseau est reçue.

Détails

Paramètres

`[in] aError`	Erreur en cas d'é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 réseau reçue. Disponible uniquement lorsque `aError` est `OT_ERROR_NONE`.
`[in] aMessageInfo`	Un pointeur vers les informations sur le message pour `aMessage`. Disponible uniquement lorsque `aError` est `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

Représente une configuration de serveur.

OTServiceConfig

struct otServiceConfig otServiceConfig

Représente une configuration de service.

otThreadAnycastLocatorCallback

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

Le type de pointeur définit le rappel pour avertir 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 la transaction a bien été effectuée. OT_ERROR_RESPONSE_TIMEOUT indique une destination introuvable. OT_ERROR_ABORT indique que la requête a été annulée.
`[in] aMeshLocalAddress`	Un pointeur vers l'EID local du maillage de la destination la plus proche de l'adresse Anycast lorsque `aError` est OT_ERROR_NONE, ou NULL dans le cas contraire.
`[in] aRloc16`	RLOC16 de la destination (sinon trouvé), RLOC16 non valide (0xfffe).

otThreadDiscoveryRequestCallback

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

Pointer 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 contexte spécifique à l'application de rappel.

OTThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Représente les données de la requête Thread Discovery.

otThreadParentResponseCallback

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

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

Il est utilisé dans otThreadRegisterParentResponseCallback().

Détails

Paramètres

`[in] aInfo`	Pointeur pointant vers un emplacement sur une pile contenant les données statistiques.
`[in] aContext`	Un pointeur vers un contexte propre au client de rappel.

OTThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

Représente les données de réponse du MLE parent.

Fonctions

otConvertDurationInSecondsToString

void otConvertDurationInSecondsToString(
  uint32_t aDuration,
  char *aBuffer,
  uint16_t aSize
)

Convertit une durée de uint32_t (en secondes) en chaîne lisible.

Nécessite l'activation de OPENTHREAD_CONFIG_UPTIME_ENABLE.

La chaîne suit le format "::" pour les heures, les minutes, les secondes (si la durée est inférieure à un jour) ou ".

d.::" (d'une durée supérieure à une journée).

Si la chaîne obtenue ne tient pas dans aBuffer (dans ses caractères aSize), elle sera tronquée, mais la chaîne générée sera toujours terminée.

Elle est destinée à être utilisée avec mAge ou mConnectionTime dans des structures otNeighborInfo ou otChildInfo.

Détails

Paramètres

`[in] aDuration`	Intervalle de durée en secondes.
`[out] aBuffer`	Un pointeur vers un tableau de caractères pour générer la chaîne.
`[in] aSize`	Taille de `aBuffer` (en octets). Recommandé pour utiliser `OT_DURATION_STRING_SIZE`.

otNetDataContainsOmrPrefix

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

Vérifiez si un préfixe donné peut servir de préfixe OMR valide, ainsi que les données réseau du leader.

Remarque:Cette API n'est disponible que si OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE est utilisé.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aPrefix`	Un pointeur vers le préfixe IPv6.

Renvoie

Indique si aPrefix est un préfixe OMR valide et 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
)

Fournissez une copie complète ou stable des données du réseau Thread de la partition.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aStable`	VRAI lors de la copie de la version stable, FAUX lors de la copie de la version complète.
`[out] aData`	Un pointeur vers le tampon de données
`[in,out] aDataLength`	À l'entrée, taille du tampon de données vers `aData`. En cas de sortie, nombre d'octets copiés.

Valeurs renvoyées

`OT_ERROR_NONE`	Les données du réseau Thread ont bien été copiées dans `aData` et les `aDataLength` ont été mises à jour.
`OT_ERROR_NO_BUFS`	Espace insuffisant dans `aData` pour copier complètement les données du réseau Thread.

OTNetDataGetLength

uint8_t otNetDataGetLength(
  otInstance *aInstance
)

Obtenez la longueur actuelle (nombre d'octets) des données du réseau Thread de Partition.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

Longueur des données du réseau.

OTNetDataGetMaxLength

uint8_t otNetDataGetMaxLength(
  otInstance *aInstance
)

Obtenez la longueur maximale observée des données du réseau Thread depuis l'initialisation de la pile OT ou le dernier appel à otNetDataResetMaxLength().

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

Longueur maximale des données réseau (point d'eau élevé pour la longueur des données réseau).

otNetDataGetNextLowpanContextInfo

otError otNetDataGetNextLowpanContextInfo(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otLowpanContextInfo *aContextInfo
)

Obtenez les informations suivantes de l'ID de contexte 6LoWPAN dans les données réseau de la partition.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in,out] aIterator`	Un pointeur vers l'itérateur de données réseau. Pour obtenir la première entrée du service, celle-ci doit être définie sur OT_NETWORK_DATA_ITERATOR_INIT.
`[out] aContextInfo`	Un pointeur vers l'emplacement de l'ID du contexte contextuel 6LoWPAN récupéré.

Valeurs renvoyées

`OT_ERROR_NONE`	Les informations suivantes concernant l'ID de contexte 6LoWPAN ont bien été trouvées.
`OT_ERROR_NOT_FOUND`	Il n'existe aucune autre information de contexte 6LoWPAN dans les données réseau de la partition.

otNetDataGetNextOnMeshPrefix

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

Permet d'obtenir le préfixe sur réseau maillé suivant dans les données réseau de la partition.

Détails

Paramètres

`[in] aInstance`	Un 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 maillage, elle doit être définie sur OT_NETWORK_DATA_ITERATOR_INIT.
`[out] aConfig`	Un pointeur vers l'endroit où les informations du préfixe de maillage seront placées.

Valeurs renvoyées

`OT_ERROR_NONE`	Le préfixe suivant sur le réseau maillé a bien été trouvé.
`OT_ERROR_NOT_FOUND`	Il n'existe aucun préfixe On Mesh ultérieur dans les données du réseau Thread.

OTNetDataGetNextRoute

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

Obtenez la route externe suivante dans les données réseau de la partition.

Détails

Paramètres

`[in] aInstance`	Un 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 la route externe, elle doit être définie sur OT_NETWORK_DATA_ITERATOR_INIT.
`[out] aConfig`	Point où les informations de routage 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 n'existe dans les données du réseau Thread.

otNetDataGetNextService

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

Obtenez le service suivant dans les données réseau de la partition.

Détails

Paramètres

`[in] aInstance`	Un 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 service, celle-ci doit être définie sur OT_NETWORK_DATA_ITERATOR_INIT.
`[out] aConfig`	Un pointeur vers l'emplacement des informations sur le service.

Valeurs renvoyées

`OT_ERROR_NONE`	Le service suivant a bien été trouvé.
`OT_ERROR_NOT_FOUND`	Il n'existe aucun service ultérieur dans les données réseau de la partition.

otNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

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

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

Version stable des données réseau.

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

Obtenir la version des données réseau

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

Version des données réseau.

otNetDataIsDnsSrpServiceAdded

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

Indique si l'entrée "Service DNS/SRP" est actuellement ajoutée aux données du réseau Thread.

La fonctionnalité OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE doit être activée.

Détails

Paramètres

[in] aInstance

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

otNetDataIsPrefixAdded

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

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.

La fonctionnalité OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE doit être activée.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aPrefix`	Un 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
)

Demande la publication de l'adresse Anycast DNS/SRP Service dans les données du réseau Thread.

La fonctionnalité OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE doit être activée.

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

Détails

Paramètres

`[in] aInstance`	Un 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
)

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

La fonctionnalité OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE doit être activée.

Publiez 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`	Un 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
)

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

La fonctionnalité OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE doit être activée.

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

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aPort`	Numéro de port du serveur SRP à publier.

otNetDataPublishExternalRoute

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

Demande la publication d'un préfixe de routage externe dans les données du réseau Thread.

La fonctionnalité OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE doit être activée.

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

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 modifie uniquement les indicateurs (niveau de préférence, par exemple) et que le préfixe est déjà ajouté dans les données réseau, le changement apporté aux indicateurs est immédiatement répercuté dans les données réseau. Cela garantit que les entrées existantes des 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 de l'entrée de 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`	Un 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`	`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 sur 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
)

Demande la publication d'un préfixe sur le maillage dans les données du réseau Thread.

La fonctionnalité OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE doit être activée.

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

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aConfig`	Configuration du préfixe sur le maillage à publier (NE DOIT PAS être NULL).

Valeurs renvoyées

`OT_ERROR_NONE`	Le préfixe sur réseau maillé a été publié.
`OT_ERROR_INVALID_ARGS`	`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 sur réseau maillé et la route externe) déterminées par la configuration `OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES`.

otNetDataReplacePublishExternalRoute

otError otNetDataReplacePublishedExternalRoute(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix,
  const otExternalRouteConfig *aConfig
)

Remplace une route externe précédemment publiée dans les données du réseau Thread.

La fonctionnalité OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE doit être activée.

Si aucune route externe publiée ne correspond à aPrefix, cette fonction se comporte de la même manière que otNetDataPublishExternalRoute(). En d'autres termes, elle lance le processus de publication de aConfig en tant que route externe dans les données du réseau Thread.

Si une entrée d'itinéraire précédemment publiée correspond à aPrefix, elle sera remplacée par le nouveau préfixe de aConfig.

Si aPrefix a déjà été ajouté aux données réseau, la modification du nouveau préfixe dans aConfig est immédiatement répercutée dans les données réseau. Cela garantit que les entrées de route dans les données réseau ne sont pas supprimées brusquement et que la transition d'un préfixe vers le nouveau préfixe est fluide.
Si l'ancien aPrefix publié n'a pas été ajouté aux données du réseau, il sera remplacé par le nouveau préfixe aConfig, mais ne sera pas ajouté immédiatement. Au lieu de cela, il lance le processus de publication dans les données réseau (en surveillant les données réseau pour déterminer quand/si vous ajoutez le préfixe, en fonction du nombre de préfixes similaires présents dans les données réseau).

Détails

Paramètres

`[in] aPrefix`	Préfixe de route externe précédemment publié à remplacer.
`[in] aConfig`	Configuration de la route externe à publier.
`[in] aRequester`	Le demandeur (module `kFromUser` ou `kFromRoutingManager`)

Valeurs renvoyées

`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 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 sur réseau maillé et la route externe) déterminées par la configuration `OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES`.

otNetDataResetMaxLength

void otNetDataResetMaxLength(
  otInstance *aInstance
)

Réinitialiser la longueur maximale suivie des données du réseau Thread.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Voir aussi:
otNetDataGetMaxLength

otNetDataSetDnsSrpServicePublisherCallback

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

Définit un rappel pour indiquer quand 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.

La fonctionnalité OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE doit être activée.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aCallback`	Pointeur de la 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
)

Définit un rappel pour indiquer quand 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.

La fonctionnalité OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE doit être activée.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aCallback`	Pointeur de la 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 un menuisier.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aEui64`	Point sur l'IEEE EUI-64 du Joiner.

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.

otNetDataSteeringDataCheckJoinerWithDiscerner

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

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

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aDiscerner`	Un pointeur vers le distillateur 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 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

Un pointeur vers une instance OpenThread.

otNetDataUnpublishPrefix

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

Annule la publication d'un préfixe de routage sur réseau maillé ou externe publié.

OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE doit être activé.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aPrefix`	Préfixe à annuler pour publication (NE DOIT PAS être 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.

otThreaddevChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

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

Détails

Paramètres

[in] aInstance

Un 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é.

OtThreadThreadDetached

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Dissocier du réseau Thread.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Valeurs renvoyées

`OT_ERROR_NONE`	Dissociation du réseau Thread réussie.
`OT_ERROR_INVALID_STATE`	Le fil de discussion est désactivé.

OTThreadDetachGraceful

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

Notifie d'autres nœuds du réseau (le cas échéant), puis arrête le fonctionnement du protocole Thread.

Il envoie une version d'adresse s'il s'agit d'un routeur ou définit le délai avant expiration de l'élément enfant sur 0 s'il s'agit d'un enfant.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aCallback`	Un pointeur vers une fonction appelée à la fin de la dissociation.
`[in] aContext`	Un pointeur vers un contexte spécifique à 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 de l'appareil en chaîne lisible.

Détails

Paramètres

[in] aRole

Rôle d'appareil à convertir.

Renvoie

Chaîne représentant aRole.

ThreadThread

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

Lance une analyse Thread Discovery.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aScanChannels`	Vecteur de bits indiquant les canaux à analyser (OT_CHANNEL_11_MASK, par exemple).
`[in] aPanId`	Filtre d'ID PAN (défini sur Diffusion PAN pour désactiver le filtre).
`[in] aJoiner`	Valeur de l'indicateur Joiner dans le fichier TLV de la demande de découverte.
`[in] aEnableEui64Filtering`	VRAI pour filtrer les réponses sur EUI-64, FAUX dans le cas contraire.
`[in] aCallback`	Un pointeur vers une fonction appelée sur la réception d'une réponse de découverte 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
)

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

Détails

Paramètres

[in] aInstance

Un 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

Un pointeur vers une instance OpenThread.

Valeurs renvoyées

`OT_DEVICE_ROLE_DISABLED`	La pile Thread est désactivée.
`OT_DEVICE_ROLE_DETACHED`	L'appareil ne participe actuellement à aucun partitionnement ni réseau 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 leader du thread.

ThreadThread

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Récupère le nom de domaine Thread.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

Un pointeur sur le nom de domaine des threads.

Voir aussi:
otThreadSetPhoneNumber

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

Un pointeur vers une instance OpenThread.

Renvoie

Un pointeur vers l'ID IPAN é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 de domaine Thread.

Disponible lorsque OPENTHREAD_CONFIG_DUA_ENABLE est activé.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

Un pointeur vers l'identifiant d'interface défini manuellement ou vers la valeur NULL si aucune n'a été définie.

Voir aussi:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Récupère les compteurs IPv6.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

Un pointeur vers les compteurs IPv6.

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Récupère le thGroupByKeySequenceCounter.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

La valeur thcloudkmsSequenceCounter.

Voir aussi:
otThreadSetKeySequenceCounter

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Récupère l'élément thSlideSwitchGuardTime (en heures).

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

La valeur thdefineSlotSwitchGuardTime (en heures).

Voir aussi:
otThreadSetKeySwitchGuardGuardTime

OTThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Obtenir les données sur le leader des threads

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[out] aLeaderData`	Un pointeur vers l'emplacement des données principales.

Valeurs renvoyées

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

Renvoie un pointeur vers le RLOC du leader.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[out] aLeaderRloc`	Un aperçu du programme RLOC du leader.

Valeurs renvoyées

`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 threads.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Obtenez l'ID de routeur du leader.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

ID du routeur du leader.

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

Prenez le poids du leader.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

Poids du leader.

otThreadGetLinkLocalThreadThreadsMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Récupère l'adresse de multidiffusion Thread Link-Local, tous les nœuds Thread.

Il s'agit d'une adresse de multidiffusion Unicast locale en lien [RFC 3306], avec:

flips définis sur 3 (P = 1 et T = 1)
scop défini sur 2
Veuillez indiquer la valeur 64
le préfixe réseau est défini sur le préfixe local du maillage
ID du groupe défini sur 1

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

Un pointeur vers l'adresse de multidiffusion Thread Link-Local, tous les nœuds Thread.

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

Récupère l'adresse IPv6 locale du lien Thread.

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

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

Un pointeur vers l'adresse IPv6 locale du lien Thread.

OTThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

Obtenez la configuration du mode lien MLE.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

Configuration du mode lien MLE

Voir aussi:
otThreadSetLinkMode

otThreadGetMaxTimeInQueue

uint32_t otThreadGetMaxTimeInQueue(
  otInstance *aInstance
)

Récupère la durée maximale de la file d'attente des messages dans la file d'attente de transmission.

Nécessite OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

Le suivi de la mise en file d'attente est effectué uniquement pour les transmissions directes. Il est mesuré à partir du moment où un message est ajouté à la file d'attente de transmission et jusqu'à ce qu'il soit transmis à la couche MAC pour une transmission ou une suppression.

Vous pouvez réinitialiser les statistiques collectées en appelant otThreadResetTimeInQueueStat().

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

Temps de file d'attente maximal, en millisecondes, pour tous les messages de la file d'attente de transmission (jusqu'à présent).

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

Récupère l'adresse EID locale du maillage.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

Un pointeur vers l'adresse de l'EID local du maillage.

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

Renvoie un pointeur vers le préfixe local du maillage.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

Un pointeur vers le préfixe local du maillage.

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Récupère les compteurs de MLE Thread.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

Un pointeur vers les compteurs de MLE Thread.

OTThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

Obtenez la clé réseau Thread.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[out] aNetworkKey`	Un pointeur vers un objet `otNetworkKey` pour renvoyer la clé réseau Thread

Voir aussi:
otThreadSetNetworkKey

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

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

La fonctionnalité de compilation OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE doit être activée.

Détails

Paramètres

[in] aInstance

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

Obtenir le nom du réseau Thread

Détails

Paramètres

[in] aInstance

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

Récupère le prochain fichier TLV de diagnostic réseau dans le message.

Nécessite OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

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

Détails

Paramètres

`[in] aMessage`	Un pointeur vers un message.
`[in,out] aIterator`	Un pointeur vers le contexte de l'itérateur de diagnostic du réseau. Pour obtenir le premier fichier TLV de diagnostic du 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 renvoyées

`OT_ERROR_NONE`	Le fichier TLV de diagnostic du réseau a bien été trouvé.
`OT_ERROR_NOT_FOUND`	Le message TLV de diagnostic réseau suivant n'existe pas dans le message.
`OT_ERROR_PARSE`	Échec de l'analyse du diagnostic réseau suivant.

otThreadGetNextNeighborInfo

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

Récupère les informations voisines.

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

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in,out] aIterator`	Un pointeur vers le contexte de l'itérateur. Pour obtenir la première entrée du voisin, celle-ci doit être définie sur OT_NEIGHBOR_INFO_ITERATOR_INIT.
`[out] aInfo`	Un pointeur vers les informations sur le voisin.

Valeurs renvoyées

`OT_ERROR_NONE`	L'entrée de voisine a bien été trouvée dans la table.
`OT_ERROR_NOT_FOUND`	Il n'existe aucune entrée de voisine ultérieure 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`	Un pointeur vers une instance OpenThread.
`[out] aParentRssi`	Un pointeur vers l'emplacement du 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`	Un 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 le RSSI du dernier paquet à partir du thread Thread.

Détails

Paramètres

`[in] aInstance`	Un 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 partition.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

ID de partition.

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Récupère l'adresse de multidiffusion Nœuds Thread Realm-Local.

Il s'agit d'une adresse multicast basée sur le préfixe Unicast local (RFC 3306), avec:

flips définis sur 3 (P = 1 et T = 1)
scop défini sur 3
Veuillez indiquer la valeur 64
le préfixe réseau est défini sur le préfixe local du maillage
ID du groupe défini sur 1

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

Un pointeur vers l'adresse multicast Thread Realm-Local All Thread Nodes.

OTThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

Récupère l'adresse de l'outil de localisation de routage des threads.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

Un pointeur vers l'adresse de l'outil de localisation de routage des threads (RLOC).

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Obtenez le RLOC16.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

RLOC16

otThreadGetServiceAloc

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

Récupère l'ALOC du service pour l'ID de service donné.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aServiceId`	ID du service pour lequel obtenir ALOC.
`[out] aServiceAloc`	Un pointeur pour générer l'ALOC du service DOIT NE 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 de threads.

otThreadGetTimeInQueueHistogram

const uint32_t * otThreadGetTimeInQueueHistogram(
  otInstance *aInstance,
  uint16_t *aNumBins,
  uint32_t *aBinInterval
)

Récupère l'histogramme de la file d'attente pour les messages de la file d'attente de transmission.

Nécessite OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

Un histogramme de la file d'attente des messages dans la file d'attente de transmission est collecté. Le suivi de la mise en file d'attente est effectué uniquement pour les transmissions directes. Il est mesuré à partir du moment où un message est ajouté à la file d'attente de transmission et jusqu'à ce qu'il soit transmis à la couche MAC pour une transmission ou une suppression.

L'histogramme est renvoyé sous forme de tableau de valeurs uint32_t avec des entrées aNumBins. La première entrée du tableau (index 0) représente le nombre de messages dont la file d'attente est inférieure à aBinInterval. La deuxième entrée représente le nombre de messages dont la file d'attente est supérieure ou égale à aBinInterval, mais inférieure à 2 * aBinInterval. Et ainsi de suite. La dernière entrée représente le nombre de messages dont la file d'attente est supérieure ou égale à (aNumBins - 1) * aBinInterval.

Vous pouvez réinitialiser les statistiques collectées en appelant otThreadResetTimeInQueueStat(). Les informations de l'histogramme sont collectées depuis l'initialisation de l'instance OpenThread ou depuis la dernière réinitialisation de la collecte des statistiques en appelant otThreadResetTimeInQueueStat().

Les pointeurs aNumBins et aBinInterval NE DOIVENT PAS être NULL.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[out] aNumBins`	Pointeur permettant de renvoyer le nombre de bacs dans l'histogramme (longueur du tableau).
`[out] aBinInterval`	Pointeur pour renvoyer la longueur de l'intervalle de l'histogramme en milliseconde.

Renvoie

Un pointeur vers un tableau d'entrées aNumBins représentant les informations de l'histogramme collectées.

otThreadGetVendorModel

const char * otThreadGetVendorModel(
  otInstance *aInstance
)

Obtenez la chaîne du modèle du fournisseur.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

Chaîne du modèle du fournisseur.

otThreadGetVendorName

const char * otThreadGetVendorName(
  otInstance *aInstance
)

Obtenez la chaîne du nom du fournisseur.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

Chaîne de nom du fournisseur.

otThreadGetVendorSwVersion

const char * otThreadGetVendorSwVersion(
  otInstance *aInstance
)

Permet d'obtenir la chaîne de version SW du fournisseur.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Renvoie

Chaîne de version SW du fournisseur.

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

Récupère la version du protocole Thread.

Détails
Renvoie	la version du protocole Thread.

otThreadIsAnycastLocaliserInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

Indique si une requête de localisation Anycast est en cours.

Disponible uniquement lorsque OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE est activé.

Détails

Paramètres

[in] aInstance

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

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

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

OTThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

Indique si un nœud est le seul routeur du réseau.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Valeurs renvoyées

`TRUE`	Il s'agit du 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
)

Demande la localisation la plus proche d'une adresse Anycast donnée.

Disponible uniquement 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`	Un pointeur vers une instance OpenThread.
`[in] aAnycastAddress`	Adresse Anycast à localiser. NE DOIT PAS être NULL.
`[in] aCallback`	Fonction de rappel pour signaler le résultat.
`[in] aContext`	Contexte arbitraire utilisé avec `aCallback`.

Valeurs renvoyées

`OT_ERROR_NONE`	La requête a bien été lancé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`	Hors mémoire pour préparer et envoyer le message de requête.

otThreadRegisterParentResponseCallback

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

Enregistre un rappel pour recevoir des données de réponse du MLE parent.

Nécessite OPENTHREAD_CONFIG_MLE_PARENT_RESPONSE_CALLBACK_API_ENABLE.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aCallback`	Un pointeur vers une fonction appelée à la réception d'un message de réponse du MLE parent.
`[in] aContext`	Un pointeur vers un contexte propre au client de rappel.

otThreadResetIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Réinitialise les compteurs IPv6.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Réinitialise les compteurs MLE de thread.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

otThreadResetTimeInQueueStat

void otThreadResetTimeInQueueStat(
  otInstance *aInstance
)

Réinitialise les statistiques sur le temps d'attente dans la file d'attente des transmissions.

Nécessite OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

OTThreadSearchForBetterParent

otError otThreadSearchForBetterParent(
  otInstance *aInstance
)

Lance la recherche d'un meilleur parent pour l'enfant tout en le maintenant connecté à son parent actuel.

À utiliser lorsque l'appareil est connecté en tant qu'enfant.

Détails

Valeurs renvoyées

`OT_ERROR_NONE`	Le processus de recherche d'un meilleur parent a réussi.
`OT_ERROR_INVALID_STATE`	Le rôle de l'appareil n'est pas enfant.

OTThreadSendAddressNotification

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

Envoie un message de notification d'adresse proactive (ADDR_NTF.ntf).

Disponible uniquement lorsque OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE est activé.

Détails

Paramètres

`[in] aInstance`	Un 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
)

Envoyer une requête de diagnostic réseau.

Nécessite OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aDestination`	Un pointeur vers l'adresse de destination.
`[in] aTlvTypes`	Tableau des types TLV de diagnostic du réseau.
`[in] aCount`	Nombre de types dans aTlvTypes.
`[in] aCallback`	Un pointeur vers une fonction appelée lorsque la réponse de diagnostic du réseau reçoit une réponse 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é ajouté à la 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 requête de réinitialisation du diagnostic réseau.

Nécessite OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aDestination`	Un pointeur vers l'adresse de destination.
`[in] aTlvTypes`	Tableau des types TLV de diagnostic du réseau. Actuellement, 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é ajouté à la 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
)

Envoie un message proactif de backbone (PRO_BB.ntf) sur le lien backbone.

Disponible uniquement lorsque OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE est activé.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aTarget`	Adresse cible du message PRO_BB.ntf.
`[in] aMlIid`	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 la mémoire tampon des messages est insuffisante.

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Définit le délai avant expiration des threads enfants (en secondes) lors de l'utilisation du rôle enfant.

Détails

Paramètres

`[in] aInstance`	Un 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
)

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

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aCallback`	Un pointeur vers une fonction appelée lors de la réception d'un message de requête de découverte MLE.
`[in] aContext`	Un pointeur vers un contexte spécifique à l'application de rappel.

otThreadSetNom

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

Définit le nom de domaine des threads.

Réussite uniquement lorsque les protocoles Thread sont désactivés

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aDomainName`	Un pointeur sur le nom de domaine des threads.

Valeurs renvoyées

`OT_ERROR_NONE`	Le nom de domaine des threads a bien été défini.
`OT_ERROR_INVALID_STATE`	Les protocoles Thread sont activés.

Voir aussi:
otThreadGetPhoneNumber

OTThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Lance l'opération de 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`	Un pointeur vers une instance OpenThread.
`[in] aEnabled`	TRUE si Thread est activé, FALSE dans le cas contraire.

Valeurs renvoyées

`OT_ERROR_NONE`	L'opération de protocole Thread a démarré.
`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`	Un pointeur vers une instance OpenThread.
`[in] aExtendedPanId`	Un pointeur vers l'ID IPAN é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

otThreadSetFixedDuaInterfaceIdentifier

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

Définit ou efface l'identifiant d'interface spécifié manuellement pour l'adresse unicast du domaine Thread.

Disponible lorsque OPENTHREAD_CONFIG_DUA_ENABLE est activé.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aIid`	Un pointeur vers l'identifiant d'interface à définir ou la valeur NULL pour effacer.

Valeurs renvoyées

`OT_ERROR_NONE`	L'identifiant d'interface a bien été défini/effacé.
`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
)

Définit l'annonce de la jointure Thread lors de la découverte du réseau Thread.

La publicité Thread Joiner permet à un membre du programme de mettre en avant ses propres informations spécifiques à l'application (telles que l'ID fournisseur, l'ID produit, le discriminateur, etc.) via un TLV Publicité de nouveau proposé, et de mettre ces informations à la disposition des Commissaires ou des candidats.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aOui`	Valeur UI du fournisseur du fournisseur qui sera incluse dans l'annonce de l'opérateur de jointure. Seuls les 3 octets les moins significatifs sont utilisés, et le plus important est ignoré.
`[in] aAdvData`	Un pointeur sur les AdvData qui seront inclus dans l'Annonce Joiner.
`[in] aAdvDataLength`	Longueur d'AdvData en octets.

Valeurs renvoyées

`OT_ERROR_NONE`	L'annonce de l'association a bien été définie.
`OT_ERROR_INVALID_ARGS`	Données AdvData non valides.

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Définit l'élément thSlideSequenceCounter.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aKeySequenceCounter`	La valeur thcloudkmsSequenceCounter.

Voir aussi:
otThreadGetKeySequenceCounter

otThreadSetKeyGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Définit l'élément thSlideSwitchGuardTime (en heures).

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aKeySwitchGuardTime`	La valeur thdefineSlotSwitchGuardTime (en heures).

Voir aussi:
otThreadGetKeySwitchGuardGuardTime

OTThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Définissez la configuration du mode lien MLE.

Détails

Paramètres

`[in] aInstance`	Un 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 lien MLE a bien été définie.

Voir aussi:
otThreadGetLinkMode

otThreadSetMeshLocalPrefix

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

Définit le préfixe local du maillage.

Cette opération 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`	Un pointeur vers une instance OpenThread.
`[in] aMeshLocalPrefix`	Un pointeur vers le préfixe local du maillage.

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.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aKey`	Un pointeur vers un tampon contenant la clé réseau Thread

Valeurs renvoyées

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

La fonctionnalité de compilation OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE doit être activée.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aKeyRef`	Référence à la clé réseau Thread.

Valeurs renvoyées

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

Détails

Paramètres

`[in] aInstance`	Un 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

otThreadSetVendorModel

otError otThreadSetVendorModel(
  otInstance *aInstance,
  const char *aVendorModel
)

Définissez la chaîne du modèle du fournisseur.

Nécessite OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorModel doit être UTF8 avec une longueur maximale de 32 caractères (MAX_VENDOR_MODEL_TLV_LENGTH). La longueur maximale n'inclut pas le caractère nul \0.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aVendorModel`	Chaîne du modèle du fournisseur.

Valeurs renvoyées

`OT_ERROR_NONE`	Le modèle du fournisseur a bien été défini.
`OT_ERROR_INVALID_ARGS`	`aVendorModel` n'est pas valide (trop long ou non UTF8).

otThreadSetVendorName

otError otThreadSetVendorName(
  otInstance *aInstance,
  const char *aVendorName
)

Définissez la chaîne de nom du fournisseur.

Nécessite OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorName doit être UTF8 avec une longueur maximale de 32 caractères (MAX_VENDOR_NAME_TLV_LENGTH). La longueur maximale n'inclut pas le caractère nul \0.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aVendorName`	Chaîne de nom du fournisseur.

Valeurs renvoyées

`OT_ERROR_NONE`	Le nom du fournisseur a bien été défini.
`OT_ERROR_INVALID_ARGS`	`aVendorName` n'est pas valide (trop long ou non UTF8).

otThreadSetVendorSwVersion

otError otThreadSetVendorSwVersion(
  otInstance *aInstance,
  const char *aVendorSwVersion
)

Définissez la chaîne de version du logiciel du fournisseur.

Nécessite OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorSwVersion doit être au format UTF8 avec une longueur maximale de 16 caractères(MAX_VENDOR_SW_VERSION_TLV_LENGTH). La longueur maximale n'inclut pas le caractère nul \0.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aVendorSwVersion`	Chaîne de version du logiciel du fournisseur.

Valeurs renvoyées

`OT_ERROR_NONE`	La version logicielle du fournisseur a bien été définie.
`OT_ERROR_INVALID_ARGS`	`aVendorSwVersion` n'est pas valide (trop long ou non UTF8).

Macros

OT_DURATION_STRING_SIZE

 OT_DURATION_STRING_SIZE 21

Taille recommandée pour la représentation de la durée de la chaîne en secondes (uint32_t).

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Durée maximale de l'annonce de l'animateur.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Initialiseur pour otNeighborInfoIterator.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Longueur maximale du TLV de base de 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 de diagnostic réseau.

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Initialiseur pour otNetworkDiagIterator.

OT_NETWORK_DIAGNOSTIC_MAX_Thread_STACK_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH 64

Longueur maximale du fichier TLV de la pile de threads.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH 32

Longueur maximale du modèle TLV du modèle du fournisseur.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH 32

Longueur maximale du TLV (Nom du fournisseur).

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH 16

Longueur maximale du TLV de la version logicielle du fournisseur.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

Nombre maximal de types 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 inférieure.

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Taille maximale des données de service en octets.

Ressources

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

Questions d'ordre général

Résumé

Énumérations

Typedefs

Fonctions

Structs

Énumérations

énumération anonyme

OTDeviceRole

OTNetDataPublisherEvent

OTRoutePreference

Typedefs

otBorderRouterConfig

otDetachGracefulCallback

OTExternalRouteConfig

Compteurs

OTLeaderData

otLinkModeConfig

OTLowpanContextInfo

Compteurs

otNeighborInfoIterator

otNetDataDnsSrpServicePublisherCallback

otNetDataPrefixPublisherCallback

OTNetDataPublisherEvent

otNetworkDataIterator

otNetworkDiagChildEntry

OTNetworkDiagConnectivity

otNetworkDiagIterator

otNetworkDiagMacCounters

otNetworkDiagMleCounters

OTNetworkDiagRoute

OTNetworkDiagRouteData

OTNetworkDiagTlv

otReceiveDiagnosticGetCallback

OTRoutePreference

OTServerConfig

OTServiceConfig

otThreadAnycastLocatorCallback

otThreadDiscoveryRequestCallback

OTThreadDiscoveryRequestInfo

otThreadParentResponseCallback

OTThreadParentResponseInfo

Fonctions

otConvertDurationInSecondsToString

otNetDataContainsOmrPrefix

OTNetDataGet

OTNetDataGetLength

OTNetDataGetMaxLength

otNetDataGetNextLowpanContextInfo

otNetDataGetNextOnMeshPrefix

OTNetDataGetNextRoute

otNetDataGetNextService

otNetDataGetStableVersion

otNetDataGetVersion

otNetDataIsDnsSrpServiceAdded

otNetDataIsPrefixAdded

otNetDataPublishDnsSrpServiceAnycast

otNetDataPublishDnsSrpServiceUnicast

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

otNetDataPublishExternalRoute

otNetDataPublishOnMeshPrefix

otNetDataReplacePublishExternalRoute

otNetDataResetMaxLength

otNetDataSetDnsSrpServicePublisherCallback

otNetDataSetPrefixPublisherCallback

otNetDataSteeringDataCheckJoiner

otNetDataSteeringDataCheckJoinerWithDiscerner

otNetDataUnpublishDnsSrpService

otNetDataUnpublishPrefix

otThreaddevChild

OtThreadThreadDetached

OTThreadDetachGraceful

otThreadDeviceRoleToString

ThreadThread

otThreadGetChildTimeout

OTThreadGetDeviceRole

ThreadThread

otThreadGetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters