Questions d'ordre général

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

Résumé

L'éditeur de données réseau fournit des mécanismes 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 réseau du thread en surveillant les données réseau et en déterminant si et quand ajouter ou supprimer des entrées.

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

Énumérations

anonymous enum{
  OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS = 0,
  OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS = 1,
  OT_NETWORK_DIAGNOSTIC_TLV_MODE = 2,
  OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT = 3,
  OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY = 4,
  OT_NETWORK_DIAGNOSTIC_TLV_ROUTE = 5,
  OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA = 6,
  OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA = 7,
  OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST = 8,
  OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS = 9,
  OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL = 14,
  OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE = 15,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE = 16,
  OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES = 17,
  OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST = 18,
  OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT = 19,
  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 par les rappels de l'éditeur.
otRoutePreference{
  OT_ROUTE_PREFERENCE_LOW = -1,
  OT_ROUTE_PREFERENCE_MED = 0,
  OT_ROUTE_PREFERENCE_HIGH = 1
}
enum
Définit des valeurs valides pour mPreference dans otExternalRouteConfig et otBorderRouterConfig.

Typedefs

otBorderRouterConfig typedef
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
Représente une configuration de route externe.
otIpCounters typedef
struct otIpCounters
Représente les compteurs de niveau IP.
otLeaderData typedef
struct otLeaderData
Représente les données des fils de discussion.
otLinkModeConfig typedef
Représente une configuration en mode de liaison MLE.
otLowpanContextInfo typedef
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 Thread.
otNeighborInfoIterator typedef
int16_t
Utilisé pour itérer dans la table voisine.
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext) typedef
void(*
Le type de pointeur définit le rappel utilisé pour avertir lorsqu'une entrée "Service DNS/SRP" est ajoutée ou supprimée des données réseau Thread.
otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) typedef
void(*
Le type de pointeur définit le rappel utilisé pour avertir lorsqu'une entrée de préfixe (sur un réseau maillé ou externe) est ajoutée ou supprimée des données réseau Thread.
otNetDataPublisherEvent typedef
Représente les événements signalés par les rappels de l'éditeur.
otNetworkDataIterator typedef
uint32_t
Utilisé pour itérer les informations sur les données réseau.
otNetworkDiagChildEntry typedef
Représente une entrée de tableau enfant de diagnostic réseau.
otNetworkDiagConnectivity typedef
Représente une valeur de connectivité pour le diagnostic réseau.
otNetworkDiagIterator typedef
uint16_t
Utilisé pour itérer via le TLV de diagnostic du réseau.
otNetworkDiagMacCounters typedef
Représente une valeur de compteurs Mac de diagnostic réseau.
otNetworkDiagMleCounters typedef
Représente une valeur de compteurs MLE pour les diagnostics réseau.
otNetworkDiagRoute typedef
Représente une valeur TLV de route de diagnostic réseau.
otNetworkDiagRouteData typedef
Représente les données de routage de diagnostic réseau.
otNetworkDiagTlv typedef
Représente un TLV de diagnostic 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
Définit des valeurs valides pour mPreference dans otExternalRouteConfig et otBorderRouterConfig.
otServerConfig typedef
Représente une configuration de serveur.
otServiceConfig typedef
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(*
Le pointeur est appelé à chaque fois qu'un message de requête de découverte MLE est reçu.
otThreadDiscoveryRequestInfo typedef
Représente les données de requête de découverte Thread.
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext) typedef
void(*
Le pointeur est appelé à chaque fois qu'un message de réponse parent MLE est reçu.
otThreadParentResponseInfo typedef
Représente les données de réponse du parent MLE.

distantes

otConvertDurationInSecondsToString(uint32_t aDuration, char *aBuffer, uint16_t aSize)
void
Convertit une durée uint32_t (en secondes) en une chaîne lisible.
otNetDataContainsOmrPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Vérifiez si un préfixe donné peut servir de préfixe OMR valide et si les données réseau du leader contiennent ce préfixe.
otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
Fournissez une copie complète ou stable des données réseau Thread de la partition.
otNetDataGetCommissioningDataset(otInstance *aInstance, otCommissioningDataset *aDataset)
void
Récupère l'ensemble de données de mise en service à partir des données réseau de la partition.
otNetDataGetLength(otInstance *aInstance)
uint8_t
Obtenez la longueur actuelle (nombre d'octets) des données réseau Thread de la 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 depuis le dernier appel à otNetDataResetMaxLength().
otNetDataGetNextLowpanContextInfo(otInstance *aInstance, otNetworkDataIterator *aIterator, otLowpanContextInfo *aContextInfo)
Obtenez l'ID de contexte 6LoWPAN suivant dans les données réseau de la partition.
otNetDataGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
Obtenez le préfixe "On Mesh" suivant dans les données réseau de la partition.
otNetDataGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
Obtenez la prochaine route externe dans les données réseau de la partition.
otNetDataGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
Obtenir 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
Permet d'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 réseau Thread.
otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Indique si une entrée de préfixe publiée (sur un réseau maillé ou externe) est ajoutée aux données réseau Thread.
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
void
Demande la publication de l'adresse Anycast du service DNS/SRP dans les données réseau Thread.
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
Demande la publication de l'adresse Unicast du service DNS/SRP dans les données réseau Thread.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
void
Demande la publication de l'adresse Unicast du service DNS/SRP dans les données réseau Thread.
otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
Demande la publication d'un préfixe de route externe dans les données réseau Thread.
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
Demande la publication d'un préfixe de réseau maillé dans les données réseau Thread.
otNetDataReplacePublishedExternalRoute(otInstance *aInstance, const otIp6Prefix *aPrefix, const otExternalRouteConfig *aConfig)
Remplace une route externe précédemment publiée dans les données réseau Thread.
otNetDataResetMaxLength(otInstance *aInstance)
void
Réinitialisez la longueur maximale suivie des données réseau Thread.
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
Définit un rappel pour envoyer une notification lorsqu'un "service DNS/SRP" publié est ajouté ou supprimé des données réseau Thread.
otNetDataSetPrefixPublisherCallback(otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
Définit un rappel pour recevoir une notification lorsqu'une entrée de préfixe publiée est effectivement ajoutée ou supprimée des données réseau Thread.
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
Vérifiez si les données de direction incluent une jointure.
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
Vérifiez si les données de direction incluent une jointure avec une valeur de discernement donnée.
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
void
Annule la publication de toute entrée de service DNS/SRP (Anycast ou Unicast) précédemment ajoutée à partir des données réseau Thread.
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
Annule la publication d'un préfixe de routage externe ou sur réseau maillé précédemment publié.
otThreadBecomeChild(otInstance *aInstance)
Essayez de le réassocier en tant qu'enfant.
otThreadBecomeDetached(otInstance *aInstance)
Détachez-vous du réseau Thread.
otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
Notifie les 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)
Lance une analyse de détection de threads.
otThreadGetChildTimeout(otInstance *aInstance)
uint32_t
Récupère le délai d'inactivité enfant Thread (en secondes) utilisé lorsque le rôle "Enfant" est utilisé.
otThreadGetDeviceRole(otInstance *aInstance)
Permet d'obtenir 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 de PAN étendu IEEE 802.15.4.
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
Récupère l'identifiant d'interface spécifié manuellement pour l'adresse Unicast du domaine Thread.
otThreadGetIp6Counters(otInstance *aInstance)
const otIpCounters *
Récupère les compteurs IPv6.
otThreadGetKeySequenceCounter(otInstance *aInstance)
uint32_t
Récupère le thuctionSequenceCounter.
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
uint32_t
Récupère le thprintSwitchGuardTime (en heures).
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
Obtenez les données des fils de discussion.
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
Renvoie un pointeur vers le RLOC de la variante optimale.
otThreadGetLeaderRouterId(otInstance *aInstance)
uint8_t
Obtenez l'ID du routeur leader.
otThreadGetLeaderWeight(otInstance *aInstance)
uint8_t
Obtenez le poids de leader.
otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Récupère l'adresse de multidiffusion de tous les nœuds Thread Link-Local.
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
const otIp6Address *
Récupère l'adresse IPv6 de liaison locale Thread.
otThreadGetLinkMode(otInstance *aInstance)
Permet d'obtenir la configuration du mode de liaison MLE.
otThreadGetMaxTimeInQueue(otInstance *aInstance)
uint32_t
Récupère la durée maximale de la file d'attente pour les messages de la file d'attente de transmission.
otThreadGetMeshLocalEid(otInstance *aInstance)
const otIp6Address *
Récupère l'adresse EID locale du maillage.
otThreadGetMeshLocalPrefix(otInstance *aInstance)
Renvoie un pointeur vers le préfixe local du maillage.
otThreadGetMleCounters(otInstance *aInstance)
const otMleCounters *
Récupère les compteurs MLE Thread.
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
void
Obtenez la clé réseau Thread.
otThreadGetNetworkKeyRef(otInstance *aInstance)
Obtenez le otNetworkKeyRef pour la clé réseau Thread.
otThreadGetNetworkName(otInstance *aInstance)
const char *
Permet d'obtenir le nom du réseau Thread.
otThreadGetNextDiagnosticTlv(const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
Récupère le TLV de diagnostic réseau suivant dans le message.
otThreadGetNextNeighborInfo(otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
Récupère les informations de voisinage suivant.
otThreadGetParentAverageRssi(otInstance *aInstance, int8_t *aParentRssi)
La fonction récupère le RSSI moyen pour le thread parent.
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
La fonction récupère les informations de diagnostic pour un routeur Thread en tant que parent.
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
La fonction récupère le RSSI du dernier paquet à partir du thread parent.
otThreadGetPartitionId(otInstance *aInstance)
uint32_t
Obtenez l'ID de partition.
otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Récupère l'adresse de multidiffusion de tous les nœuds Thread Realm-Local.
otThreadGetRloc(otInstance *aInstance)
const otIp6Address *
Récupère l'adresse RLOC (Thread Routing Locator).
otThreadGetRloc16(otInstance *aInstance)
uint16_t
Récupérez le RLOC16.
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
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 du temps dans la file d'attente pour les messages de la file d'attente de transmission.
otThreadGetVendorModel(otInstance *aInstance)
const char *
Récupérez la chaîne du modèle du fournisseur.
otThreadGetVendorName(otInstance *aInstance)
const char *
Permet d'obtenir la chaîne du nom du fournisseur.
otThreadGetVendorSwVersion(otInstance *aInstance)
const char *
Obtenez la chaîne de version du logiciel 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étection de threads 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)
Demande la localisation de la destination la plus proche d'une adresse Anycast donnée.
otThreadRegisterParentResponseCallback(otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
Enregistre un rappel pour recevoir les données de réponse du parent MLE.
otThreadResetIp6Counters(otInstance *aInstance)
void
Réinitialise les compteurs IPv6.
otThreadResetMleCounters(otInstance *aInstance)
void
Réinitialise les compteurs MLE Thread.
otThreadResetTimeInQueueStat(otInstance *aInstance)
void
Réinitialise les statistiques de temps dans la file d'attente de transmission.
otThreadSearchForBetterParent(otInstance *aInstance)
Lance le processus permettant à l'enfant de rechercher un meilleur parent tout en restant associé à 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)
Envoyer une requête Get de diagnostic réseau.
otThreadSendDiagnosticReset(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
Envoyez une demande de réinitialisation du diagnostic réseau.
otThreadSendProactiveBackboneNotification(otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
Envoie un message de notification de backbone proactif (PRO_BB.ntf) sur le lien "Backbone".
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
void
Définit le délai avant expiration du thread enfant (en secondes) utilisé lorsque le rôle "Enfant" est utilisé.
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)
Définit le nom de domaine Thread.
otThreadSetEnabled(otInstance *aInstance, bool aEnabled)
Démarre les opérations du protocole Thread.
otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
Définit l'ID de PAN étendu IEEE 802.15.4.
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
Définit ou efface l'identifiant d'interface spécifié manuellement pour l'adresse unicast du domaine Thread.
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
Définit l'annonce Thread Joiner lors de la découverte du réseau Thread.
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
void
Définit le thuctionSequenceCounter.
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
Définit le paramètre thuctionSwitchGuardTime (en heures).
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
Définissez la configuration du mode de liaison MLE.
otThreadSetMeshLocalPrefix(otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
Définit le préfixe local du maillage.
otThreadSetNetworkKey(otInstance *aInstance, const otNetworkKey *aKey)
Définissez la clé du réseau Thread.
otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)
Définissez la clé du réseau Thread en tant que otNetworkKeyRef.
otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName)
Définissez le nom du réseau Thread.
otThreadSetVendorModel(otInstance *aInstance, const char *aVendorModel)
Définissez la chaîne du modèle du fournisseur.
otThreadSetVendorName(otInstance *aInstance, const char *aVendorName)
Définissez la chaîne du nom du fournisseur.
otThreadSetVendorSwVersion(otInstance *aInstance, const char *aVendorSwVersion)
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.

otIpCounters

Représente les compteurs de niveau IP.

otLeaderData

Représente les données des fils de discussion.

otLinkModeConfig

Représente une configuration en mode de liaison 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 Thread.

otNeighborInfo

Contient les informations de diagnostic d'un nœud Thread voisin.

otNetworkDiagChildEntry

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

otNetworkDiagConnectivity

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

otNetworkDiagMacCounters

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

otNetworkDiagMleCounters

Représente une valeur de compteurs MLE pour les diagnostics réseau.

otNetworkDiagRoute

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

otNetworkDiagRouteData

Représente les données de routage de diagnostic réseau.

otNetworkDiagTlv

Représente un TLV de diagnostic 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 requête de découverte Thread.

otThreadParentResponseInfo

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

Énumérations

énumération anonyme

 anonymous enum
Propriétés
OT_NETWORK_DIAGNOSTIC_TLV_ANSWER

Répondez "TLV".

OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

Niveau de la batterie (TLV).

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

Résumé des pages de chaînes

OT_NETWORK_DIAGNOSTIC_TLV_CHILD

TLV enfant

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST

TLV de la liste d'adresses IPv6 enfant.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

TLV de la table enfant.

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

Connectivité TLV.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

TLV de l'adresse étendue MAC.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

Le TLV de la liste d'adresses IPv6

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

Leader Data TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

Compteurs MAC TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

Délai maximal d'expiration d'un enfant.

OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS

MLE Counters TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MODE

Mode TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

Network Data TLV.

OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID

ID de requête TLV.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

Route64 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR

Routeur voisin TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

Adresse 16 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

Tension d'alimentation TLV.

OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION

Version TLV de la pile de threads.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

Délai d'inactivité TLV (délai d'interrogation maximal pour les SED)

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

Le TLV de la liste de types.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL

Modèle de fournisseur TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME

Nom du fournisseur TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION

Fournisseur de la version TLV du logiciel

OT_NETWORK_DIAGNOSTIC_TLV_VERSION

Version TLV.

otDeviceRole

 otDeviceRole

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

Propriétés
OT_DEVICE_ROLE_CHILD

Rôle enfant de thread.

OT_DEVICE_ROLE_DETACHED

Ne participe pas actuellement à un réseau/partition Thread.

OT_DEVICE_ROLE_DISABLED

La pile de threads est désactivée.

OT_DEVICE_ROLE_LEADER

Le rôle "Thread Leader"

OT_DEVICE_ROLE_ROUTER

Rôle de routeur Thread.

otNetDataPublisherEvent

 otNetDataPublisherEvent

Représente les événements signalés par les rappels de l'éditeur.

Propriétés
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED

L'entrée publiée est ajoutée aux données 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 élevée pour l'itinéraire.

OT_ROUTE_PREFERENCE_LOW

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

OT_ROUTE_PREFERENCE_MED

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

Typedefs

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

Représente une configuration de routeur de bordure.

otDetachGracefullyCallback

void(* otDetachGracefullyCallback)(void *aContext)

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

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

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

Représente une configuration de route externe.

otIpCounters

struct otIpCounters otIpCounters

Représente les compteurs de niveau IP.

otLeaderData

struct otLeaderData otLeaderData

Représente les données des fils de discussion.

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

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

otMleCounters

struct otMleCounters otMleCounters

Représente les compteurs MLE Thread.

otNeighborInfoIterator

int16_t otNeighborInfoIterator

Utilisé pour itérer dans la table voisine.

otNetDataDnsSrpServicePublisherCallback

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

Le type de pointeur définit le rappel utilisé pour avertir lorsqu'une entrée "Service DNS/SRP" est ajoutée ou supprimée des données réseau Thread.

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

Détails
Paramètres
[in] aEvent
Indique l'événement (ajout ou suppression d'une entrée).
[in] aContext
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 lorsqu'une entrée de préfixe (sur un réseau maillé ou externe) est ajoutée ou supprimée des données réseau Thread.

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

Détails
Paramètres
[in] aEvent
Indique l'événement (ajout ou suppression d'une entrée).
[in] aPrefix
Pointeur vers l'entrée du préfixe.
[in] aContext
Pointeur vers un contexte spécifique à l'application.

otNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

Représente les événements signalés par les rappels de l'éditeur.

otNetworkDataIterator

uint32_t otNetworkDataIterator

Utilisé pour itérer les informations sur les données réseau.

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

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

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

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

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

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

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

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

Consultez la RFC 2863 pour obtenir la définition des champs de membres.

otNetworkDiagMleCounters

struct otNetworkDiagMleCounters otNetworkDiagMleCounters

Représente une valeur de compteurs MLE pour les diagnostics réseau.

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

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

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

Représente les données de routage de diagnostic réseau.

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

Représente un TLV de diagnostic 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 d'obtention de la réponse.
[in] aMessage
Pointeur vers le tampon de message contenant la charge utile de la réponse "Get Network Diagnostic" reçue. Disponible uniquement lorsque aError est défini sur OT_ERROR_NONE.
[in] aMessageInfo
Pointeur vers les informations sur le message pour aMessage. Disponible uniquement lorsque aError est défini sur OT_ERROR_NONE.
[in] aContext
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
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 une réussite. OT_ERROR_ANSWER_TIMEOUT indique que la destination est introuvable. OT_ERROR_ABORT indique que la requête a été annulée.
[in] aMeshLocalAddress
Pointeur vers l'EID local du maillage de la destination la plus proche de l'adresse Anycast lorsque aError est défini sur OT_ERROR_NONE. Sinon, il est NULL.
[in] aRloc16
RLOC16 de la destination si celui-ci est trouvé. RLOC16 non valide pour les autres raisons (0xfffe).

otThreadDiscoveryRequestCallback

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

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

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

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Représente les données de requête de découverte Thread.

otThreadParentResponseCallback

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

Le pointeur 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 vers un emplacement de la pile contenant les données de statistiques.
[in] aContext
Pointeur vers un rappel de contexte spécifique au client.

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

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

distantes

otConvertDurationInSecondsToString

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

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

Nécessite l'activation de OPENTHREAD_CONFIG_UPTIME_ENABLE.

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

d.::" (pour une durée supérieure à un jour).

Si la chaîne obtenue ne rentre pas dans aBuffer (de ses caractères aSize), elle sera tronquée, mais la sortie sera toujours nulle et se termine toujours.

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

Détails
Paramètres
[in] aDuration
Intervalle de durée en secondes.
[out] aBuffer
Pointeur vers un tableau de caractères pour générer la chaîne.
[in] aSize
Taille de aBuffer (en octets). Utilisation recommandée de 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 et si les données réseau du leader contiennent ce préfixe.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aPrefix
Pointeur vers le préfixe IPv6.
Renvoie
Indique si aPrefix est un préfixe OMR valide et si les données du 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 réseau Thread de la partition.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aStable
TRUE lors de la copie de la version stable, FALSE lors de la copie de la version complète.
[out] aData
Pointeur vers le tampon de données.
[in,out] aDataLength
À l'entrée, taille du tampon de données indiqué par aData. À la sortie, nombre d'octets copiés.
Valeurs de retour
OT_ERROR_NONE
Les données réseau Thread ont bien été copiées dans aData et mis à jour aDataLength.
OT_ERROR_NO_BUFS
Espace insuffisant dans aData pour copier l'intégralité des données réseau Thread.

otNetDataGetCommissioningDataset

void otNetDataGetCommissioningDataset(
  otInstance *aInstance,
  otCommissioningDataset *aDataset
)

Récupère l'ensemble de données de mise en service à partir des données réseau de la partition.

Détails
Paramètres
[in] aInstance
Un pointeur vers l'instance OpenThread.
[out] aDataset
Pointeur vers un élément otCommissioningDataset à renseigner.

otNetDataGetLength

uint8_t otNetDataGetLength(
  otInstance *aInstance
)

Obtenez la longueur actuelle (nombre d'octets) des données réseau Thread de la 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 depuis le dernier appel à otNetDataResetMaxLength().

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
Longueur maximale des Données du réseau (marge d'eau élevée pour la longueur des Données réseau).

otNetDataGetNextLowpanContextInfo

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

Obtenez l'ID de contexte 6LoWPAN 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
Pointeur vers l'itérateur de données du réseau. Pour obtenir la première entrée de service, vous devez définir OT_NETWORK_DATA_ITERATOR_INIT.
[out] aContextInfo
Pointeur vers l'emplacement où seront placées les informations d'ID de contexte 6LoWPAN récupérées.
Valeurs de retour
OT_ERROR_NONE
Les informations d'ID de contexte 6LoWPAN suivantes ont été trouvées.
OT_ERROR_NOT_FOUND
Aucune information de contexte 6LoWPAN ultérieure n'existe dans les données réseau de la partition.

otNetDataGetNextOnMeshPrefix

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

Obtenez le préfixe "On Mesh" 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
Pointeur vers le contexte de l'itérateur de données du réseau. Pour obtenir la première entrée dans le réseau maillé, elle doit être définie sur OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Pointeur vers l'emplacement des informations sur le préfixe du réseau maillé.
Valeurs de retour
OT_ERROR_NONE
Le préfixe "On Mesh" suivant a été trouvé.
OT_ERROR_NOT_FOUND
Il n'existe aucun préfixe "On Mesh" dans les données réseau Thread.

otNetDataGetNextRoute

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

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

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in,out] aIterator
Pointeur vers le contexte de l'itérateur de données du réseau. Pour obtenir la première entrée de route externe, elle doit être définie sur OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Pointeur vers l'emplacement des informations sur le routage externe.
Valeurs de retour
OT_ERROR_NONE
Route externe suivante trouvée.
OT_ERROR_NOT_FOUND
Aucune entrée de route externe ultérieure n'existe dans les données réseau Thread.

otNetDataGetNextService

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

Obtenir 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
Pointeur vers le contexte de l'itérateur de données du réseau. Pour obtenir la première entrée de service, vous devez définir OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Pointeur vers l'emplacement des informations de service.
Valeurs de retour
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
)

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

Nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

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

otNetDataIsPrefixAdded

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

Indique si une entrée de préfixe publiée (sur un réseau maillé ou externe) est ajoutée aux données réseau Thread.

Nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

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 de retour
TRUE
L'entrée de préfixe publiée est ajoutée aux données réseau Thread.
FALSE
L'entrée n'est pas ajoutée aux données réseau Thread, ou il n'y a aucune entrée à publier.

otNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

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

Nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

L'appel de cette fonction supprimera et remplacera toute entrée "DNS/SRP Service" précédente publiée (depuis un 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 Unicast du service DNS/SRP dans les données réseau Thread.

Nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

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

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

Détails
Paramètres
[in] aInstance
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 Unicast du service DNS/SRP dans les données réseau Thread.

Nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

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

Contrairement à otNetDataPublishDnsSrpServiceUnicast(), qui nécessite que l'adresse publiée soit indiquée et qui inclut les informations dans les données TLV du service, cette fonction utilise l'EID local du réseau maillé de l'appareil et inclut ces informations dans les données 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 route externe dans les données réseau Thread.

Nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Seules les entrées stables peuvent être publiées (par exemple,aConfig.mStable DOIT être 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 ne modifie que les indicateurs (par exemple, le niveau de préférence) et que le préfixe est déjà ajouté aux données réseau, la modification des indicateurs est immédiatement répercutée dans les données réseau. Cela garantit que les entrées existantes dans les Données du réseau ne sont pas supprimées brusquement. Notez qu'un changement du niveau de préférence peut potentiellement entraîner la suppression de l'entrée dans les données réseau après avoir déterminé que d'autres nœuds publient le même préfixe avec la même préférence ou une préférence 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 de retour
OT_ERROR_NONE
Le routage externe a bien été publié.
OT_ERROR_INVALID_ARGS
La valeur aConfig n'est pas valide (préfixe incorrect, combinaisons d'indicateurs non valides ou instable).
OT_ERROR_NO_BUFS
Impossible d'allouer une entrée pour la nouvelle demande. L'éditeur accepte un nombre limité d'entrées (partagées entre le préfixe du réseau maillé et le routage externe) déterminé 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 de réseau maillé dans les données réseau Thread.

Nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Seules les entrées stables peuvent être publiées (par exemple,aConfig.mStable DOIT être 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 ne modifie que les indicateurs (par exemple, le niveau de préférence) et que le préfixe est déjà ajouté aux données réseau, la modification des indicateurs est immédiatement répercutée dans les données réseau. Cela garantit que les entrées existantes dans les Données du réseau ne sont pas supprimées brusquement. Notez qu'un changement du niveau de préférence peut potentiellement entraîner la suppression de l'entrée dans les données réseau après avoir déterminé que d'autres nœuds publient le même préfixe avec la même préférence ou une préférence supérieure.

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

otNetDataReplacePublishedExternalRoute

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

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

Nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Si aucune correspondance de route externe publiée précédemment n'est aPrefix, cette fonction se comporte de la même manière que otNetDataPublishExternalRoute(), c'est-à-dire qu'elle lance le processus de publication d'aConfig en tant que route externe dans les données réseau Thread.

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

  • Si aPrefix a déjà été ajouté dans les 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 routage dans les données réseau ne sont pas supprimées soudainement et que la transition d'un préfixe au nouveau préfixe est fluide.
  • Si l'ancien aPrefix publié n'a pas été ajouté aux données réseau, il sera remplacé par le nouveau préfixe aConfig, mais il ne sera pas ajouté immédiatement. Au lieu de cela, il lance le processus de publication dans les Données réseau (surveillant les données réseau pour déterminer quand et si ajouter le préfixe, en fonction du nombre de préfixes similaires présents dans les données réseau).

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aPrefix
Préfixe de route externe précédemment publié à remplacer.
[in] aConfig
Configuration de la route externe à publier.
Valeurs de retour
OT_ERROR_NONE
Le routage externe a bien été publié.
OT_ERROR_INVALID_ARGS
La valeur aConfig n'est pas valide (préfixe incorrect, combinaisons d'indicateurs non valides ou instable).
OT_ERROR_NO_BUFS
Impossible d'allouer une entrée pour la nouvelle demande. L'éditeur accepte un nombre limité d'entrées (partagées entre le préfixe du réseau maillé et le routage externe) déterminé par la configuration OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataResetMaxLength

void otNetDataResetMaxLength(
  otInstance *aInstance
)

Réinitialisez la longueur maximale suivie des données 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 envoyer une notification lorsqu'un "service DNS/SRP" publié est ajouté ou supprimé des données réseau Thread.

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

Nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aCallback
Pointeur de la fonction de rappel (peut être NULL si cela n'est pas nécessaire).
[in] aContext
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 recevoir une notification lorsqu'une entrée de préfixe publiée est effectivement ajoutée ou supprimée des données réseau Thread.

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

Nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

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

otNetDataSteeringDataCheckJoiner

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

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

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

otNetDataSteeringDataCheckJoinerWithDiscerner

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

Vérifiez si les données de direction incluent une jointure avec une valeur de discernement donnée.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aDiscerner
Pointeur sur le Joiner Discerner.
Valeurs de retour
OT_ERROR_NONE
aDiscerner est inclus dans les données de pilotage.
OT_ERROR_INVALID_STATE
Aucune donnée de pilotage n'est présente.
OT_ERROR_NOT_FOUND
aDiscerner n'est pas inclus dans les données de pilotage.

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

Annule la publication de toute entrée de service DNS/SRP (Anycast ou Unicast) précédemment ajoutée à partir des données 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 externe ou sur réseau maillé précédemment 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 d'annulation de la publication (NE DOIT PAS être NULL).
Valeurs de retour
OT_ERROR_NONE
La publication du préfixe a bien été annulée.
OT_ERROR_NOT_FOUND
Impossible de trouver le préfixe dans la liste publiée.

otThreadBecomeChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

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

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Valeurs de retour
OT_ERROR_NONE
La tentative de devenir un enfant a bien été lancée.
OT_ERROR_INVALID_STATE
Thread désactivé.

otThreadBecomeDetached

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Détachez-vous du réseau Thread.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Valeurs de retour
OT_ERROR_NONE
L'appareil a bien été dissocié du réseau Thread.
OT_ERROR_INVALID_STATE
Thread désactivé.

otThreadDetachGracefully

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

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

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

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aCallback
Pointeur vers une fonction appelée à la fin de la dissociation.
[in] aContext
Pointeur vers un contexte de rappel spécifique à l'application.
Valeurs de retour
OT_ERROR_NONE
La dissociation a bien commencé.
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.

otThreadDiscover

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

Lance une analyse de détection de threads.

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

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

Récupère le délai d'inactivité enfant Thread (en secondes) utilisé lorsque le rôle "Enfant" est utilisé.

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

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Permet d'obtenir le rôle de l'appareil.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Valeurs de retour
OT_DEVICE_ROLE_DISABLED
La pile de threads est désactivée.
OT_DEVICE_ROLE_DETACHED
L'appareil ne participe actuellement à aucun réseau/partition Thread.
OT_DEVICE_ROLE_CHILD
L'appareil fonctionne actuellement en tant qu'enfant Thread.
OT_DEVICE_ROLE_ROUTER
L'appareil fonctionne actuellement en tant que routeur Thread.
OT_DEVICE_ROLE_LEADER
L'appareil fonctionne actuellement en tant que Thread Leader.

otThreadGetDomainName

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
Pointeur vers le nom de domaine Thread.
Voir aussi:
otThreadSetDomainName

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Récupère l'ID de PAN étendu IEEE 802.15.4.

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

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

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

Disponible lorsque OPENTHREAD_CONFIG_DUA_ENABLE est activé.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
Pointeur vers l'identifiant d'interface défini manuellement, ou valeur NULL si aucun n'a été défini.
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
Pointeur vers les compteurs IPv6.

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Récupère le thuctionSequenceCounter.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
Valeur thuctionSequenceCounter.
Voir aussi:
otThreadSetKeySequenceCounter

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Récupère le thprintSwitchGuardTime (en heures).

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
Valeur thuctionSwitchGuardTime (en heures).
Voir aussi:
otThreadSetKeySwitchGuardTime

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Obtenez les données des fils de discussion.

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

otThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

Renvoie un pointeur vers le RLOC de la variante optimale.

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

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Obtenez l'ID du routeur leader.

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

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

Obtenez le poids de leader.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
Le poids de leader.

otThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

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

L'adresse est une adresse multicast basée sur le préfixe Unicast de liaison locale [RFC 3306], contenant les éléments suivants:

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

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

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

Récupère l'adresse IPv6 de liaison locale Thread.

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

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

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

Permet d'obtenir la configuration du mode de liaison MLE.

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

otThreadGetMaxTimeInQueue

uint32_t otThreadGetMaxTimeInQueue(
  otInstance *aInstance
)

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

Nécessite OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

La durée de la file d'attente est suivie uniquement pour les transmissions directes et est mesurée comme la durée entre l'ajout d'un message à la file d'attente de transmission et son envoi à la couche MAC pour transmission ou sa 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
Durée maximale de la file d'attente 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
Pointeur vers l'adresse EID du réseau maillé local.

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
Pointeur vers le préfixe du maillage de services.

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Récupère les compteurs MLE Thread.

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

Nécessite l'activation de la fonctionnalité de compilation OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

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
)

Permet d'obtenir le nom du réseau Thread.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
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 TLV de diagnostic réseau suivant dans le message.

Nécessite OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

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

Détails
Paramètres
[in] aMessage
Pointeur vers un message.
[in,out] aIterator
Pointeur vers le contexte de l'itérateur Network Diagnostic. Pour obtenir le premier TLV de diagnostic réseau, il doit être défini sur OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
[out] aNetworkDiagTlv
Pointeur vers l'emplacement des informations TLV de Network Diagnostic.
Valeurs de retour
OT_ERROR_NONE
Le prochain TLV de diagnostic réseau a bien été trouvé.
OT_ERROR_NOT_FOUND
Le message ne contient pas de TLV de diagnostic réseau ultérieur.
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 de voisinage suivant.

Il 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
Pointeur vers le contexte de l'itérateur. Pour obtenir la première entrée du voisin, vous devez définir la valeur sur OT_NEIGHBOR_INFO_ITERATOR_INIT.
[out] aInfo
Un pointeur vers les informations du voisin.
Valeurs de retour
OT_ERROR_NONE
L'entrée voisine suivante a bien été trouvée dans la table.
OT_ERROR_NOT_FOUND
Aucune entrée voisine ultérieure n'existe dans la table.
OT_ERROR_INVALID_ARGS
aIterator ou aInfo était NULL.

otThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

La fonction récupère le RSSI moyen pour le thread parent.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[out] aParentRssi
Pointeur vers l'emplacement du RSSI parent.

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

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

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

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[out] aLastRssi
Pointeur vers l'emplacement du dernier RSSI.
Valeurs de retour
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 de tous les nœuds Thread Realm-Local.

L'adresse est une adresse multidiffusion basée sur le préfixe Unicast locale [RFC 3306], contenant les éléments suivants:

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

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

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

Récupère l'adresse RLOC (Thread Routing Locator).

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
Pointeur vers l'adresse RLOC (Thread Routing Locator).

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Récupérez le RLOC16.

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

otThreadGetTimeInQueueHistogram

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

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

Nécessite OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

Un histogramme du temps dans la file d'attente des messages de la file d'attente de transmission est collecté. La durée de la file d'attente est suivie uniquement pour les transmissions directes et est mesurée comme la durée entre l'ajout d'un message à la file d'attente de transmission et son envoi à la couche MAC pour transmission ou sa suppression.

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

Vous pouvez réinitialiser les statistiques collectées en appelant otThreadResetTimeInQueueStat(). Les informations d'histogramme sont collectées depuis l'initialisation de l'instance OpenThread ou depuis la dernière réinitialisation de la collecte des statistiques via l'appel de 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 renvoyant le nombre de bins dans l'histogramme (longueur du tableau).
[out] aBinInterval
Pointeur permettant de renvoyer la longueur d'intervalle de bin de l'histogramme en millisecondes.
Renvoie
Pointeur vers un tableau d'entrées aNumBins représentant les informations d'histogramme collectées.

otThreadGetVendorModel

const char * otThreadGetVendorModel(
  otInstance *aInstance
)

Récupérez 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
)

Permet d'obtenir la chaîne du nom du fournisseur.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
Chaîne du nom du fournisseur.

otThreadGetVendorSwVersion

const char * otThreadGetVendorSwVersion(
  otInstance *aInstance
)

Obtenez la chaîne de version du logiciel fournisseur.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
Chaîne de version du logiciel du fournisseur.

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

Récupère la version du protocole Thread.

Détails
Renvoie
la version du protocole Thread.

otThreadIsAnycastLocateInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

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

N'est disponible que 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étection de threads 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 de retour
TRUE
C'est le seul routeur du réseau.
FALSE
Il s'agit d'un routeur enfant ou non d'un routeur unique dans le réseau.

otThreadLocateAnycastDestination

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

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

N'est disponible que lorsque OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE est activé.

Si une requête précédente est en cours, un appel ultérieur à cette fonction sera annulé et remplacera 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 de retour
OT_ERROR_NONE
La demande 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 de la mémoire tampon pour préparer et envoyer le message de requête.

otThreadRegisterParentResponseCallback

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

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

Nécessite OPENTHREAD_CONFIG_MLE_PARENT_RESPONSE_CALLBACK_API_ENABLE.

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

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

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

otThreadResetTimeInQueueStat

void otThreadResetTimeInQueueStat(
  otInstance *aInstance
)

Réinitialise les statistiques de temps dans la file d'attente de transmission.

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 le processus permettant à l'enfant de rechercher un meilleur parent tout en restant associé à son parent actuel.

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

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

otThreadSendAddressNotification

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

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

N'est disponible que lorsque OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE est activé.

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

otThreadSendDiagnosticReset

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

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

Nécessite OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aDestination
Pointeur vers une adresse de destination.
[in] aTlvTypes
Tableau des types TLV de Network Diagnostic. Actuellement, seul le type 9 est autorisé.
[in] aCount
Nombre de types dans aTlvTypes
Valeurs de retour
OT_ERROR_NONE
Le fichier DIAG_RST.ntf a bien été mis en file d'attente.
OT_ERROR_NO_BUFS
Tampons de message disponibles insuffisants pour envoyer le fichier DIAG_RST.ntf.

otThreadSendProactiveBackboneNotification

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

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

N'est disponible que 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 de retour
OT_ERROR_NONE
Le fichier PRO_BB.ntf a bien été envoyé pour le lien backbone.
OT_ERROR_NO_BUFS
Si la quantité de mémoire tampon des messages est insuffisante.

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Définit le délai avant expiration du thread enfant (en secondes) utilisé lorsque le rôle "Enfant" est utilisé.

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
Pointeur vers une fonction appelée à la réception d'un message de requête de découverte MLE.
[in] aContext
Pointeur vers un contexte de rappel spécifique à l'application.

otThreadSetDomainName

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

Définit le nom de domaine Thread.

L'opération ne réussit que lorsque les protocoles Thread sont désactivés.

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

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Démarre les opérations du protocole Thread.

L'interface doit être opérationnelle lors de l'appel de cette fonction.

Appeler cette fonction avec le paramètre aEnabled défini sur "FALSE" arrête tout processus de dissociation en cours lancé par otThreadDetachGracefully(). 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 de retour
OT_ERROR_NONE
L'opération du protocole Thread a bien été lancée.
OT_ERROR_INVALID_STATE
L'interface réseau n'était pas active.

otThreadSetExtendedPanId

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

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

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aExtendedPanId
Pointeur vers l'ID de PAN étendu IEEE 802.15.4.
Valeurs de retour
OT_ERROR_NONE
L'ID du 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
Pointeur vers l'identifiant d'interface à définir ou vers la valeur NULL à effacer.
Valeurs de retour
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

otThreadSetJoinerAdvertisement

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

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

Une annonce Thread Joiner permet à un Joiner de promouvoir ses propres informations spécifiques à une application (telles que l'ID de fournisseur, l'ID de produit, le discriminateur, etc.) via une nouvelle proposition de TLV de publicité Joiner, et de mettre ces informations à la disposition des commissaires ou des candidats au poste de commissaire sans interaction humaine.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aOui
Valeur IEEE OUI du fournisseur qui sera incluse dans l'annonce Joiner. Seuls les trois octets les moins significatifs sont utilisés, et le plus important est ignoré.
[in] aAdvData
Pointeur vers l'élément AdvData qui sera inclus dans l'annonce Joiner.
[in] aAdvDataLength
Longueur d'AdvData en octets.
Valeurs de retour
OT_ERROR_NONE
L'annonce Joiner a bien été définie.
OT_ERROR_INVALID_ARGS
Données AdvData non valides.

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Définit le thuctionSequenceCounter.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aKeySequenceCounter
Valeur thuctionSequenceCounter.
Voir aussi:
otThreadGetKeySequenceCounter

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Définit le paramètre thuctionSwitchGuardTime (en heures).

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

otThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Définissez la configuration du mode de liaison MLE.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aConfig
Pointeur vers la configuration du mode Lien.
Valeurs de retour
OT_ERROR_NONE
La configuration du mode de liaison 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.

L'opération ne fonctionne que lorsque les protocoles Thread sont désactivés. L'appel réussi de cette fonction invalide les ensembles de données opérationnels actifs et en attente en mémoire non volatile.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aMeshLocalPrefix
Pointeur vers le préfixe du maillage de services.
Valeurs de retour
OT_ERROR_NONE
Le préfixe du réseau maillé 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é du réseau Thread.

L'opération ne fonctionne que lorsque les protocoles Thread sont désactivés. L'appel réussi de cette fonction invalide les ensembles de données opérationnels actifs et en attente en mémoire non volatile.

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

otThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

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

L'opération ne fonctionne que lorsque les protocoles Thread sont désactivés. L'appel réussi de cette fonction invalide les ensembles de données opérationnels actifs et en attente en mémoire non volatile.

Nécessite l'activation de la fonctionnalité de compilation OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

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

otThreadSetNetworkName

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

Définissez le nom du réseau Thread.

L'opération ne fonctionne que lorsque les protocoles Thread sont désactivés. L'appel réussi de cette fonction invalide les ensembles de données opérationnels actifs et en attente en mémoire non volatile.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aNetworkName
Pointeur vers le nom du réseau Thread.
Valeurs de retour
OT_ERROR_NONE
Le nom du réseau Thread a bien été défini.
OT_ERROR_INVALID_STATE
Les protocoles Thread sont activés.
Voir 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 au format UTF8, avec une longueur maximale de 32 caractères (MAX_VENDOR_MODEL_TLV_LENGTH). La longueur maximale n'inclut pas le caractère \0 nul.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aVendorModel
Chaîne du modèle du fournisseur.
Valeurs de retour
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 du nom du fournisseur.

Nécessite OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

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

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aVendorName
Chaîne du nom du fournisseur.
Valeurs de retour
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 \0 nul.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aVendorSwVersion
Chaîne de version du logiciel du fournisseur.
Valeurs de retour
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 sous forme de chaîne de la durée de uint32_t en secondes.

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Longueur maximale AdvData de l'annonce de jointure.

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 de la longueur maximale de la longueur maximale de la base du filetage.

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 du tableau 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 TLV de la version 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 de fournisseur TLV.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH 32

Longueur maximale du nom du fournisseur TLV.

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 de TLV de diagnostic réseau à demander ou à réinitialiser.

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

ID de routeur maximal.

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

Taille maximale des données serveur en octets. Limite théorique, pratiquement bien inférieure.

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Taille maximale des données des services en octets.

Ressources

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