Général

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

Résumé

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

Énumérations
`anonymous enum { OT_SECURITY_POLICY_OBTAIN_MASTER_KEY = 1 << 7, OT_SECURITY_POLICY_NATIVE_COMMISSIONING = 1 << 6, OT_SECURITY_POLICY_ROUTERS = 1 << 5, OT_SECURITY_POLICY_EXTERNAL_COMMISSIONER = 1 << 4, OT_SECURITY_POLICY_BEACONS = 1 << 3 }`	énumération Cette énumération définit les indicateurs TLV de stratégie de sécurité.
anonymous enum { OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS = 0, OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS = 1, OT_NETWORK_DIAGNOSTIC_TLV_MODE = 2, OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT = 3, OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY = 4, OT_NETWORK_DIAGNOSTIC_TLV_ROUTE = 5, OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA = 6, OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA = 7, OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST = 8, OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS = 9, OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL = 14, OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE = 15, OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE = 16, OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES = 17, OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST = 18, OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT = 19 }	énumération
`otDeviceRole { OT_DEVICE_ROLE_DISABLED = 0, OT_DEVICE_ROLE_DETACHED = 1, OT_DEVICE_ROLE_CHILD = 2, OT_DEVICE_ROLE_ROUTER = 3, OT_DEVICE_ROLE_LEADER = 4 }`	énumération Représente un rôle d'appareil Thread.
otMeshcopTlvType { OT_MESHCOP_TLV_CHANNEL = 0, OT_MESHCOP_TLV_PANID = 1, OT_MESHCOP_TLV_EXTPANID = 2, OT_MESHCOP_TLV_NETWORKNAME = 3, OT_MESHCOP_TLV_PSKC = 4, OT_MESHCOP_TLV_MASTERKEY = 5, OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE = 6, OT_MESHCOP_TLV_MESHLOCALPREFIX = 7, OT_MESHCOP_TLV_STEERING_DATA = 8, OT_MESHCOP_TLV_BORDER_AGENT_RLOC = 9, OT_MESHCOP_TLV_COMMISSIONER_ID = 10, OT_MESHCOP_TLV_COMM_SESSION_ID = 11, OT_MESHCOP_TLV_SECURITYPOLICY = 12, OT_MESHCOP_TLV_GET = 13, OT_MESHCOP_TLV_ACTIVETIMESTAMP = 14, OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT = 15, OT_MESHCOP_TLV_STATE = 16, OT_MESHCOP_TLV_JOINER_DTLS = 17, OT_MESHCOP_TLV_JOINER_UDP_PORT = 18, OT_MESHCOP_TLV_JOINER_IID = 19, OT_MESHCOP_TLV_JOINER_RLOC = 20, OT_MESHCOP_TLV_JOINER_ROUTER_KEK = 21, OT_MESHCOP_TLV_PROVISIONING_URL = 32, OT_MESHCOP_TLV_VENDOR_NAME_TLV = 33, OT_MESHCOP_TLV_VENDOR_MODEL_TLV = 34, OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV = 35, OT_MESHCOP_TLV_VENDOR_DATA_TLV = 36, OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV = 37, OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV = 48, OT_MESHCOP_TLV_IPV6_ADDRESS_TLV = 49, OT_MESHCOP_TLV_PENDINGTIMESTAMP = 51, OT_MESHCOP_TLV_DELAYTIMER = 52, OT_MESHCOP_TLV_CHANNELMASK = 53, OT_MESHCOP_TLV_COUNT = 54, OT_MESHCOP_TLV_PERIOD = 55, OT_MESHCOP_TLV_SCAN_DURATION = 56, OT_MESHCOP_TLV_ENERGY_LIST = 57, OT_MESHCOP_TLV_DISCOVERYREQUEST = 128, OT_MESHCOP_TLV_DISCOVERYRESPONSE = 129, OT_MESHCOP_TLV_JOINERADVERTISEMENT = 241 }	énumération Cette énumération représente les types TLV meshcop.
`otRoutePreference { OT_ROUTE_PREFERENCE_LOW = -1, OT_ROUTE_PREFERENCE_MED = 0, OT_ROUTE_PREFERENCE_HIGH = 1 }`	énumération Définit des valeurs valides pour le membre mPreference dans otExternalRouteConfig et otBorderRouterConfig .

Typedefs
`otBorderRouterConfig`	typedef `struct otBorderRouterConfig` Cette structure représente une configuration de routeur frontalier.
`otChannelMask`	typedef `uint32_t` Ce type représente le masque de canal.
`otExtendedPanId`	typedef `struct otExtendedPanId` Cette structure représente un ID PAN étendu.
`otExternalRouteConfig`	typedef `struct otExternalRouteConfig` Cette structure représente une configuration de route externe.
`otIpCounters`	typedef `struct otIpCounters` Cette structure représente les compteurs de niveau IP.
`otLeaderData`	typedef `struct otLeaderData` Cette structure représente les données du leader du fil.
`otLinkModeConfig`	typedef `struct otLinkModeConfig` Cette structure représente une configuration MLE Link Mode.
`otMasterKey`	typedef `struct otMasterKey` Cette structure représente une clé principale de thread.
`otMeshLocalPrefix`	typedef `otIp6NetworkPrefix` Cette structure représente un préfixe local de maillage.
`otMeshcopTlvType`	typedef `enum otMeshcopTlvType` Cette énumération représente les types TLV meshcop.
`otMleCounters`	typedef `struct otMleCounters` Cette structure représente les compteurs Thread MLE.
`otNeighborInfoIterator`	typedef `int16_t` Utilisé pour parcourir la table voisine.
`otNetworkDataIterator`	typedef `uint32_t` Utilisé pour parcourir les informations de données réseau.
`otNetworkDiagChildEntry`	typedef `struct otNetworkDiagChildEntry` Cette structure représente une entrée de table enfant de diagnostic réseau.
`otNetworkDiagConnectivity`	typedef `struct otNetworkDiagConnectivity` Cette structure représente une valeur de connectivité de diagnostic réseau.
`otNetworkDiagIterator`	typedef `uint16_t` Utilisé pour parcourir le TLV de diagnostic réseau.
`otNetworkDiagMacCounters`	typedef `struct otNetworkDiagMacCounters` Cette structure représente une valeur de compteurs Mac de diagnostic réseau.
`otNetworkDiagRoute`	typedef `struct otNetworkDiagRoute` Cette structure représente une valeur TLV de route de diagnostic réseau.
`otNetworkDiagRouteData`	typedef `struct otNetworkDiagRouteData` Cette structure représente les données d'un itinéraire de diagnostic réseau.
`otNetworkDiagTlv`	typedef `struct otNetworkDiagTlv` Cette structure représente un TLV de diagnostic réseau.
`otNetworkName`	typedef `struct otNetworkName` Cette structure représente un nom de réseau.
`otOperationalDataset`	typedef `struct otOperationalDataset` Cette structure représente un ensemble de données opérationnelles actif ou en attente.
`otOperationalDatasetComponents`	typedef `struct otOperationalDatasetComponents` Cette structure représente la présence de différents composants dans le jeu de données opérationnel actif ou en attente.
`otOperationalDatasetTlvs`	typedef `struct otOperationalDatasetTlvs` Cette structure représente un ensemble de données opérationnelles actif ou en attente.
`otPskc`	typedef `struct otPskc` Cette structure représente un PSKc.
`otReceiveDiagnosticGetCallback )(otMessage aMessage, const otMessageInfo aMessageInfo, void *aContext)`	typedef `void(*` Ce pointeur de fonction est appelé lorsque la réponse Network Diagnostic Get est reçue.
`otRoutePreference`	typedef `enum otRoutePreference` Définit des valeurs valides pour le membre mPreference dans otExternalRouteConfig et otBorderRouterConfig .
`otSecurityPolicy`	typedef `struct otSecurityPolicy` Cette structure représente la politique de sécurité.
`otServerConfig`	typedef `struct otServerConfig` Cette structure représente une configuration de serveur.
`otServiceConfig`	typedef `struct otServiceConfig` Cette structure représente une configuration de service.
`otThreadDiscoveryRequestCallback )(const otThreadDiscoveryRequestInfo aInfo, void aContext)`	typedef `void(*` Ce pointeur de fonction est appelé chaque fois qu'un message de demande de découverte MLE est reçu.
`otThreadDiscoveryRequestInfo`	typedef `struct otThreadDiscoveryRequestInfo` Cette structure représente les données de la demande de détection de thread.
`otThreadParentResponseCallback )(otThreadParentResponseInfo aInfo, void aContext)`	typedef `void(*` Ce pointeur de fonction est appelé chaque fois qu'un message de réponse parent MLE est reçu.
`otThreadParentResponseInfo`	typedef `struct otThreadParentResponseInfo` Cette structure représente les données MLE Parent Response.

Variables
`OT_TOOL_PACKED_END`	`OT_TOOL_PACKED_BEGIN struct otMasterKey`

Les fonctions
`otDatasetCreateNewNetwork ( otInstance aInstance, otOperationalDataset aDataset)`	`otError` Cette méthode crée un nouvel ensemble de données opérationnelles à utiliser lors de la formation d'un nouveau réseau.
`otDatasetGeneratePskc (const char aPassPhrase, const otNetworkName aNetworkName, const otExtendedPanId aExtPanId, otPskc aPskc)`	`otError` Cette fonction génère PSKc à partir d'une phrase de passe, d'un nom de réseau et d'un identifiant PAN étendu.
`otDatasetGetActive ( otInstance aInstance, otOperationalDataset aDataset)`	`otError` Cette fonction obtient le jeu de données opérationnel actif.
`otDatasetGetActiveTlvs ( otInstance aInstance, otOperationalDatasetTlvs aDataset)`	`otError` Cette fonction obtient le jeu de données opérationnel actif.
`otDatasetGetDelayTimerMinimal ( otInstance *aInstance)`	`uint32_t` Obtenez un minuteur de retard minimal.
`otDatasetGetPending ( otInstance aInstance, otOperationalDataset aDataset)`	`otError` Cette fonction obtient l'ensemble de données opérationnelles en attente.
`otDatasetGetPendingTlvs ( otInstance aInstance, otOperationalDatasetTlvs aDataset)`	`otError` Cette fonction obtient l'ensemble de données opérationnelles en attente.
`otDatasetIsCommissioned ( otInstance *aInstance)`	`bool` Cette fonction indique si un réseau valide est présent ou non dans le jeu de données opérationnel actif.
`otDatasetSendMgmtActiveGet ( otInstance aInstance, const otOperationalDatasetComponents aDatasetComponents, const uint8_t aTlvTypes, uint8_t aLength, const otIp6Address aAddress)`	`otError` Cette fonction envoie MGMT_ACTIVE_GET.
`otDatasetSendMgmtActiveSet ( otInstance aInstance, const otOperationalDataset aDataset, const uint8_t *aTlvs, uint8_t aLength)`	`otError` Cette fonction envoie MGMT_ACTIVE_SET.
`otDatasetSendMgmtPendingGet ( otInstance aInstance, const otOperationalDatasetComponents aDatasetComponents, const uint8_t aTlvTypes, uint8_t aLength, const otIp6Address aAddress)`	`otError` Cette fonction envoie MGMT_PENDING_GET.
`otDatasetSendMgmtPendingSet ( otInstance aInstance, const otOperationalDataset aDataset, const uint8_t *aTlvs, uint8_t aLength)`	`otError` Cette fonction envoie MGMT_PENDING_SET.
`otDatasetSetActive ( otInstance aInstance, const otOperationalDataset aDataset)`	`otError` Cette fonction définit le jeu de données opérationnel actif.
`otDatasetSetActiveTlvs ( otInstance aInstance, const otOperationalDatasetTlvs aDataset)`	`otError` Cette fonction définit le jeu de données opérationnel actif.
`otDatasetSetDelayTimerMinimal ( otInstance *aInstance, uint32_t aDelayTimerMinimal)`	`otError` Réglez la minuterie de retard minimal.
`otDatasetSetPending ( otInstance aInstance, const otOperationalDataset aDataset)`	`otError` Cette fonction définit l'ensemble de données opérationnelles en attente.
`otDatasetSetPendingTlvs ( otInstance aInstance, const otOperationalDatasetTlvs aDataset)`	`otError` Cette fonction définit l'ensemble de données opérationnelles en attente.
`otNetDataGet ( otInstance aInstance, bool aStable, uint8_t aData, uint8_t *aDataLength)`	`otError` Cette méthode fournit une copie complète ou stable des données du réseau de threads de la partition.
`otNetDataGetNextOnMeshPrefix ( otInstance aInstance, otNetworkDataIterator aIterator, otBorderRouterConfig *aConfig)`	`otError` Cette fonction obtient le prochain préfixe On Mesh dans les données réseau de la partition.
`otNetDataGetNextRoute ( otInstance aInstance, otNetworkDataIterator aIterator, otExternalRouteConfig *aConfig)`	`otError` Cette fonction obtient la prochaine route externe dans les données réseau de la partition.
`otNetDataGetNextService ( otInstance aInstance, otNetworkDataIterator aIterator, otServiceConfig *aConfig)`	`otError` Cette fonction obtient le service suivant dans les données réseau de la partition.
`otNetDataGetStableVersion ( otInstance *aInstance)`	`uint8_t` Obtenez la version stable des données réseau.
`otNetDataGetVersion ( otInstance *aInstance)`	`uint8_t` Obtenez la version des données réseau.
`otNetDataSteeringDataCheckJoiner ( otInstance aInstance, const otExtAddress aEui64)`	`otError` Vérifiez si les données de pilotage incluent un Joiner.
`otNetDataSteeringDataCheckJoinerWithDiscerner ( otInstance aInstance, const struct otJoinerDiscerner aDiscerner)`	`otError` Vérifiez si les données de pilotage incluent un Joiner avec une valeur discerner donnée.
`otThreadBecomeChild ( otInstance *aInstance)`	`otError` Essayez de vous rattacher en tant qu'enfant.
`otThreadBecomeDetached ( otInstance *aInstance)`	`otError` Détachez-vous du réseau Thread.
`otThreadDiscover ( otInstance aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void aCallbackContext)`	`otError` Cette fonction lance une analyse Thread Discovery.
`otThreadGetChildTimeout ( otInstance *aInstance)`	`uint32_t` Obtenez le délai d'expiration de thread enfant utilisé lors du fonctionnement dans le rôle enfant.
`otThreadGetDeviceRole ( otInstance *aInstance)`	`otDeviceRole` Obtenez le rôle de l'appareil.
`otThreadGetDomainName ( otInstance *aInstance)`	`const char *` Obtenez le nom de domaine de thread.
`otThreadGetExtendedPanId ( otInstance *aInstance)`	`const otExtendedPanId *` Obtenez l'ID PAN étendu IEEE 802.15.4.
`otThreadGetFixedDuaInterfaceIdentifier ( otInstance *aInstance)`	`const otIp6InterfaceIdentifier *` Obtenez l'identificateur d'interface spécifié manuellement pour l'adresse de monodiffusion du domaine de thread.
`otThreadGetIp6Counters ( otInstance *aInstance)`	`const otIpCounters *` Obtenez les compteurs IPv6.
`otThreadGetKeySequenceCounter ( otInstance *aInstance)`	`uint32_t` Obtenez le thrKeySequenceCounter.
`otThreadGetKeySwitchGuardTime ( otInstance *aInstance)`	`uint32_t` Obtenez le thrKeySwitchGuardTime.
`otThreadGetLeaderData ( otInstance aInstance, otLeaderData aLeaderData)`	`otError` Cette fonction récupère les données du leader du fil.
`otThreadGetLeaderRloc ( otInstance aInstance, otIp6Address aLeaderRloc)`	`otError` Cette fonction 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` Obtenez le poids du leader.
`otThreadGetLinkLocalIp6Address ( otInstance *aInstance)`	`const otIp6Address *` Cette fonction renvoie l'adresse IPv6 locale du lien Thread.
`otThreadGetLinkMode ( otInstance *aInstance)`	`otLinkModeConfig` Obtenez la configuration du mode de liaison MLE.
`otThreadGetMasterKey ( otInstance *aInstance)`	`const otMasterKey *` Obtenez le thrMasterKey.
`otThreadGetMeshLocalEid ( otInstance *aInstance)`	`const otIp6Address *` Cette fonction renvoie un pointeur vers l'adresse EID locale du maillage.
`otThreadGetMeshLocalPrefix ( otInstance *aInstance)`	`const otMeshLocalPrefix *` Cette fonction renvoie un pointeur vers le préfixe local de maillage.
`otThreadGetMleCounters ( otInstance *aInstance)`	`const otMleCounters *` Obtenez les compteurs Thread MLE.
`otThreadGetNetworkName ( otInstance *aInstance)`	`const char *` Obtenez le nom du réseau de threads.
`otThreadGetNextDiagnosticTlv (const otMessage aMessage, otNetworkDiagIterator aIterator, otNetworkDiagTlv *aNetworkDiagTlv)`	`otError` Cette fonction obtient le prochain TLV de diagnostic réseau dans le message.
`otThreadGetNextNeighborInfo ( otInstance aInstance, otNeighborInfoIterator aIterator, otNeighborInfo *aInfo)`	`otError` Cette fonction obtient les informations sur le prochain voisin.
`otThreadGetParentAverageRssi ( otInstance aInstance, int8_t aParentRssi)`	`otError` La fonction récupère le RSSI moyen pour le parent de thread.
`otThreadGetParentInfo ( otInstance aInstance, otRouterInfo aParentInfo)`	`otError` La fonction récupère les informations de diagnostic pour un routeur de threads en tant que parent.
`otThreadGetParentLastRssi ( otInstance aInstance, int8_t aLastRssi)`	`otError` La fonction récupère le RSSI du dernier paquet du Thread Parent.
`otThreadGetPartitionId ( otInstance *aInstance)`	`uint32_t` Obtenez l'ID de partition.
`otThreadGetRloc ( otInstance *aInstance)`	`const otIp6Address *` Cette fonction renvoie un pointeur vers l'adresse RLOC (Thread Routing Locator).
`otThreadGetRloc16 ( otInstance *aInstance)`	`uint16_t` Obtenez le RLOC16.
`otThreadGetVersion (void)`	`uint16_t` Cette fonction obtient la version du protocole Thread.
`otThreadIsDiscoverInProgress ( otInstance *aInstance)`	`bool` Cette fonction détermine si une découverte de threads MLE est actuellement en cours.
`otThreadIsSingleton ( otInstance *aInstance)`	`bool` Cette fonction indique si un nœud est le seul routeur du réseau.
`otThreadRegisterParentResponseCallback ( otInstance aInstance, otThreadParentResponseCallback aCallback, void aContext)`	`void` Cette fonction enregistre un rappel pour recevoir les données MLE Parent Response.
`otThreadResetIp6Counters ( otInstance *aInstance)`	`void` Réinitialisez les compteurs IPv6.
`otThreadResetMleCounters ( otInstance *aInstance)`	`void` Réinitialisez les compteurs Thread MLE.
`otThreadSendDiagnosticGet ( otInstance aInstance, const otIp6Address aDestination, const uint8_t aTlvTypes[], uint8_t aCount)`	`otError` Envoyez une demande de diagnostic réseau.
`otThreadSendDiagnosticReset ( otInstance aInstance, const otIp6Address aDestination, const uint8_t aTlvTypes[], uint8_t aCount)`	`otError` Envoyez une demande de réinitialisation de diagnostic réseau.
`otThreadSetChildTimeout ( otInstance *aInstance, uint32_t aTimeout)`	`void` Définissez le délai d'expiration de thread enfant utilisé lors de l'utilisation du rôle enfant.
`otThreadSetDiscoveryRequestCallback ( otInstance aInstnace, otThreadDiscoveryRequestCallback aCallback, void aContext)`	`void` Cette fonction définit un rappel pour recevoir les données de demande de découverte MLE.
`otThreadSetDomainName ( otInstance aInstance, const char aDomainName)`	`otError` Définissez le nom de domaine de thread.
`otThreadSetEnabled ( otInstance *aInstance, bool aEnabled)`	`otError` Cette fonction démarre le fonctionnement du protocole Thread.
`otThreadSetExtendedPanId ( otInstance aInstance, const otExtendedPanId aExtendedPanId)`	`otError` Définissez l'ID PAN étendu IEEE 802.15.4.
`otThreadSetFixedDuaInterfaceIdentifier ( otInstance aInstance, const otIp6InterfaceIdentifier aIid)`	`otError` Définissez / effacez l'identificateur d'interface spécifié manuellement pour l'adresse de monodiffusion du domaine de thread.
`otThreadSetJoinerAdvertisement ( otInstance aInstance, uint32_t aOui, const uint8_t aAdvData, uint8_t aAdvDataLength)`	`otError` Cette méthode définit la publication Thread Joiner lors de la découverte du réseau Thread.
`otThreadSetKeySequenceCounter ( otInstance *aInstance, uint32_t aKeySequenceCounter)`	`void` Définissez thrKeySequenceCounter.
`otThreadSetKeySwitchGuardTime ( otInstance *aInstance, uint32_t aKeySwitchGuardTime)`	`void` Définissez thrKeySwitchGuardTime.
`otThreadSetLinkMode ( otInstance *aInstance, otLinkModeConfig aConfig)`	`otError` Définissez la configuration du mode de liaison MLE.
`otThreadSetMasterKey ( otInstance aInstance, const otMasterKey aKey)`	`otError` Définissez thrMasterKey.
`otThreadSetMeshLocalPrefix ( otInstance aInstance, const otMeshLocalPrefix aMeshLocalPrefix)`	`otError` Cette fonction définit le préfixe local de maillage.
`otThreadSetNetworkName ( otInstance aInstance, const char aNetworkName)`	`otError` Définissez le nom du réseau de threads.
`otThreadSetReceiveDiagnosticGetCallback ( otInstance aInstance, otReceiveDiagnosticGetCallback aCallback, void aCallbackContext)`	`void` Cette fonction enregistre un rappel pour fournir la charge utile de réponse brute de diagnostic réseau reçue.

Structs
otBorderRouterConfig	Cette structure représente une configuration de routeur frontalier.
otExtendedPanId	Cette structure représente un ID PAN étendu.
otExternalRouteConfig	Cette structure représente une configuration de route externe.
otIpCounters	Cette structure représente les compteurs de niveau IP.
otLeaderData	Cette structure représente les données du leader du fil.
otLinkModeConfig	Cette structure représente une configuration MLE Link Mode.
otMasterKey	Cette structure représente une clé principale de thread.
otMleCounters	Cette structure représente les compteurs Thread MLE.
otNequartInfo	Cette structure contient des informations de diagnostic pour un nœud Thread voisin.
otNetworkDiagChildEntry	Cette structure représente une entrée de table enfant de diagnostic réseau.
otNetworkDiagConnectivity	Cette structure représente une valeur de connectivité de diagnostic réseau.
otNetworkDiagMacCounters	Cette structure représente une valeur de compteurs Mac de diagnostic réseau.
otNetworkDiagRoute	Cette structure représente une valeur TLV de route de diagnostic réseau.
otNetworkDiagRouteData	Cette structure représente les données d'un itinéraire de diagnostic réseau.
otNetworkDiagTlv	Cette structure représente un TLV de diagnostic réseau.
otNetworkName	Cette structure représente un nom de réseau.
otOperationalDataset	Cette structure représente un ensemble de données opérationnelles actif ou en attente.
otOperationalDatasetComponents	Cette structure représente la présence de différents composants dans le jeu de données opérationnel actif ou en attente.
otOperationalDatasetTlvs	Cette structure représente un ensemble de données opérationnelles actif ou en attente.
otPskc	Cette structure représente PSKc.
otRouterInfo	Cette structure contient des informations de diagnostic pour un routeur de threads.
otSecurityPolicy	Cette structure représente la politique de sécurité.
otServerConfig	Cette structure représente une configuration de serveur.
otServiceConfig	Cette structure représente une configuration de service.
otThreadDiscoveryRequestInfo	Cette structure représente les données de la demande de détection de thread.
otThreadParentResponseInfo	Cette structure représente les données MLE Parent Response.

Énumérations

énumération anonyme

 anonymous enum

Cette énumération définit les indicateurs TLV de stratégie de sécurité.

Propriétés
`OT_SECURITY_POLICY_BEACONS`	Balises activées.
`OT_SECURITY_POLICY_EXTERNAL_COMMISSIONER`	Commissaire externe autorisé.
`OT_SECURITY_POLICY_NATIVE_COMMISSIONING`	Mise en service autochtone.
`OT_SECURITY_POLICY_OBTAIN_MASTER_KEY`	Obtention de la clé principale.
`OT_SECURITY_POLICY_ROUTERS`	Routeurs activés.

énumération anonyme

 anonymous enum

Propriétés
`OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL`	TLV de niveau de batterie.
`OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES`	TLV des pages de chaîne.
`OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE`	Tableau enfant TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY`	Connectivité TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS`	TLV d'adresse étendue MAC.
`OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST`	TLV de la liste d'adresses IPv6.
`OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA`	Leader Data TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS`	Compteurs MAC TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT`	TLV de temporisation maximale de l'enfant.
`OT_NETWORK_DIAGNOSTIC_TLV_MODE`	Mode TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA`	TLV de données réseau.
`OT_NETWORK_DIAGNOSTIC_TLV_ROUTE`	Route64 TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS`	Adresse16 TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE`	Tension d'alimentation TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT`	Timeout TLV (la période d'interrogation maximale pour les SED)
`OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST`	Liste de types TLV.

otDeviceRole

 otDeviceRole

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

Propriétés
`OT_DEVICE_ROLE_CHILD`	Le rôle Thread Child.
`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 de Thread Leader.
`OT_DEVICE_ROLE_ROUTER`	Le rôle de Thread Router.

otMeshcopTlvType

 otMeshcopTlvType

Cette énumération représente les types TLV meshcop.

Propriétés
`OT_MESHCOP_TLV_ACTIVETIMESTAMP`	TLV d'horodatage actif meshcop
`OT_MESHCOP_TLV_BORDER_AGENT_RLOC`	TLV de localisateur d'agent de frontière meshcop
`OT_MESHCOP_TLV_CHANNEL`	Meshcop Channel TLV
`OT_MESHCOP_TLV_CHANNELMASK`	Masque de canal meshcop TLV
`OT_MESHCOP_TLV_COMMISSIONER_ID`	ID de commissaire meshcop TLV
`OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT`	TLV du port UDP du commissaire meshcop
`OT_MESHCOP_TLV_COMM_SESSION_ID`	ID de session du commissaire meshcop TLV
`OT_MESHCOP_TLV_COUNT`	Meshcop Count TLV
`OT_MESHCOP_TLV_DELAYTIMER`	Meshcop Delay Timer TLV
`OT_MESHCOP_TLV_DISCOVERYREQUEST`	TLV de demande de découverte meshcop
`OT_MESHCOP_TLV_DISCOVERYRESPONSE`	TLV de réponse de découverte meshcop
`OT_MESHCOP_TLV_ENERGY_LIST`	Meshcop Energy List TLV
`OT_MESHCOP_TLV_EXTPANID`	Meshcop Extended Pan Id TLV
`OT_MESHCOP_TLV_GET`	meshcop Obtenir TLV
`OT_MESHCOP_TLV_IPV6_ADDRESS_TLV`	TLV d'adresse IPv6 meshcop
`OT_MESHCOP_TLV_JOINERADVERTISEMENT`	meshcop Joiner Publicité TLV
`OT_MESHCOP_TLV_JOINER_DTLS`	Meshcop Joiner DTLS Encapsulation TLV
`OT_MESHCOP_TLV_JOINER_IID`	Meshcop Joiner IID TLV
`OT_MESHCOP_TLV_JOINER_RLOC`	Meshcop Joiner Router Locator TLV
`OT_MESHCOP_TLV_JOINER_ROUTER_KEK`	routeur de menuisier meshcop KEK TLV
`OT_MESHCOP_TLV_JOINER_UDP_PORT`	TLV du port UDP du jointeur meshcop
`OT_MESHCOP_TLV_MASTERKEY`	Clé principale réseau meshcop TLV
`OT_MESHCOP_TLV_MESHLOCALPREFIX`	meshcop Mesh Local Prefix TLV
`OT_MESHCOP_TLV_NETWORKNAME`	Nom de réseau meshcop TLV
`OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE`	TLV de séquence de clés réseau meshcop
`OT_MESHCOP_TLV_PANID`	Meshcop Pan Id TLV
`OT_MESHCOP_TLV_PENDINGTIMESTAMP`	TLV d'horodatage en attente meshcop
`OT_MESHCOP_TLV_PERIOD`	TLV de période meshcop
`OT_MESHCOP_TLV_PROVISIONING_URL`	TLV de l'URL de provisionnement meshcop
`OT_MESHCOP_TLV_PSKC`	meshcop PSKc TLV
`OT_MESHCOP_TLV_SCAN_DURATION`	TLV de durée d'analyse meshcop
`OT_MESHCOP_TLV_SECURITYPOLICY`	TLV de politique de sécurité meshcop
`OT_MESHCOP_TLV_STATE`	TLV d'état de meshcop
`OT_MESHCOP_TLV_STEERING_DATA`	TLV de données de direction meshcop
`OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV`	TLV d'encapsulation UDP meshcop
`OT_MESHCOP_TLV_VENDOR_DATA_TLV`	TLV de données du fournisseur meshcop
`OT_MESHCOP_TLV_VENDOR_MODEL_TLV`	TLV modèle de fournisseur meshcop
`OT_MESHCOP_TLV_VENDOR_NAME_TLV`	Nom du fournisseur meshcop TLV
`OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV`	TLV version de la pile du fournisseur meshcop
`OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV`	TLV de la version du logiciel du fournisseur meshcop

otRoutePreference

 otRoutePreference

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

Propriétés
`OT_ROUTE_PREFERENCE_HIGH`	Préférence d'itinéraire élevée.
`OT_ROUTE_PREFERENCE_LOW`	Faible préférence d'itinéraire.
`OT_ROUTE_PREFERENCE_MED`	Préférence d'itinéraire moyenne.

Typedefs

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

Cette structure représente une configuration de routeur frontalier.

otChannelMask

uint32_t otChannelMask

Ce type représente le masque de canal.

otExtendedPanId

struct otExtendedPanId otExtendedPanId

Cette structure représente un ID PAN étendu.

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

Cette structure représente une configuration de route externe.

otIpCounters

struct otIpCounters otIpCounters

Cette structure représente les compteurs de niveau IP.

otLeaderData

struct otLeaderData otLeaderData

Cette structure représente les données du leader du fil.

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

Cette structure représente une configuration MLE Link Mode.

otMasterKey

struct otMasterKey otMasterKey

Cette structure représente une clé principale de thread.

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

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

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

Cette énumération représente les types TLV meshcop.

otMleCounters

struct otMleCounters otMleCounters

Cette structure représente les compteurs Thread MLE.

otNequartInfoIterator

int16_t otNeighborInfoIterator

Utilisé pour parcourir la table voisine.

otNetworkDataIterator

uint32_t otNetworkDataIterator

Utilisé pour parcourir les informations de données réseau.

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

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

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

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

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

Utilisé pour parcourir le TLV de diagnostic réseau.

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

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

Voir RFC 2863 pour les définitions des champs de membre.

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

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

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

Cette structure représente les données d'un itinéraire de diagnostic réseau.

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

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

otNetworkName

struct otNetworkName otNetworkName

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

otOperationalDataset

struct otOperationalDataset otOperationalDataset

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

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

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

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

otOperationalDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

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

L'ensemble de données opérationnelles est codé TLV comme spécifié par Thread.

otPskc

struct otPskc otPskc

Cette structure représente un PSKc.

otReceiveDiagnosticGetCallback

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

Ce pointeur de fonction est appelé lorsque la réponse Network Diagnostic Get est reçue.

Détails

Paramètres

`[in] aMessage`	Pointeur vers le tampon de messages contenant la charge utile de la réponse Network Diagnostic Get reçue.
`[in] aMessageInfo`	Un pointeur vers les informations de message pour un `aMessage` .
`[in] aContext`	Un pointeur vers le contexte spécifique à l'application.

otRoutePreference

enum otRoutePreference otRoutePreference

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

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

Cette structure représente la politique de sécurité.

otServerConfig

struct otServerConfig otServerConfig

Cette structure représente une configuration de serveur.

otServiceConfig

struct otServiceConfig otServiceConfig

Cette structure représente une configuration de service.

otThreadDiscoveryRequestCallback

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

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

Détails

Paramètres

`[in] aInfo`	Un pointeur vers les données d'informations de la demande de découverte.
`[in] aContext`	Un pointeur vers le contexte spécifique à l'application de rappel.

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Cette structure représente les données de la demande de détection de thread.

otThreadParentResponseCallback

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

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

Détails

Paramètres

`[in] aStats`	pointeur vers un emplacement sur la pile contenant les données statistiques.
`[in] aContext`	Un pointeur vers le contexte spécifique au client de rappel.

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

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

Variables

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otMasterKey OT_TOOL_PACKED_END

Les fonctions

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Cette méthode crée un nouvel ensemble de données opérationnelles à utiliser lors de la formation d'un nouveau réseau.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[out] aDataset`	L'ensemble de données opérationnelles.

Valeurs de retour

`OT_ERROR_NONE`	Création réussie d'un nouvel ensemble de données opérationnelles.
`OT_ERROR_FAILED`	Échec de la génération de valeurs aléatoires pour les nouveaux paramètres.

otDatasetGeneratePskc

otError otDatasetGeneratePskc(
  const char *aPassPhrase,
  const otNetworkName *aNetworkName,
  const otExtendedPanId *aExtPanId,
  otPskc *aPskc
)

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

PSKc est utilisé pour établir la session du commissaire.

Détails

Paramètres

`[in] aPassPhrase`	La phrase de passe de mise en service.
`[in] aNetworkName`	Le nom du réseau pour le calcul PSKc.
`[in] aExtPanId`	ID PAN étendu pour le calcul PSKc.
`[out] aPskc`	Un pointeur vers une variable pour afficher le PSKc généré.

Valeurs de retour

`OT_ERROR_NONE`	Générez PSKc avec succès.
`OT_ERROR_INVALID_ARGS`	Si l'un des arguments d'entrée n'est pas valide.

otDatasetGetActive

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Cette fonction obtient le jeu de données opérationnel actif.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[out] aDataset`	Un pointeur vers où le jeu de données opérationnel actif sera placé.

Valeurs de retour

`OT_ERROR_NONE`	Récupération réussie du jeu de données opérationnel actif.
`OT_ERROR_NOT_FOUND`	Aucune valeur correspondante dans la mémoire de réglage.

otDatasetGetActiveTlvs

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Cette fonction obtient le jeu de données opérationnel actif.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[out] aDataset`	Un pointeur vers où le jeu de données opérationnel actif sera placé.

Valeurs de retour

`OT_ERROR_NONE`	Récupération réussie du jeu de données opérationnel actif.
`OT_ERROR_NOT_FOUND`	Aucune valeur correspondante dans la mémoire de réglage.

otDatasetGetDelayTimerMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

Obtenez un minuteur de retard minimal.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Valeurs de retour

the

valeur du temporisateur de retard minimal (en ms).

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Cette fonction obtient l'ensemble de données opérationnelles en attente.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[out] aDataset`	Un pointeur vers l'emplacement de l'ensemble de données opérationnelles en attente.

Valeurs de retour

`OT_ERROR_NONE`	Récupération réussie de l'ensemble de données opérationnelles en attente.
`OT_ERROR_NOT_FOUND`	Aucune valeur correspondante dans la mémoire de réglage.

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Cette fonction obtient l'ensemble de données opérationnelles en attente.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[out] aDataset`	Un pointeur vers l'emplacement de l'ensemble de données opérationnelles en attente.

Valeurs de retour

`OT_ERROR_NONE`	Récupération réussie de l'ensemble de données opérationnelles en attente.
`OT_ERROR_NOT_FOUND`	Aucune valeur correspondante dans la mémoire de réglage.

otDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

Cette fonction indique si un réseau valide est présent ou non dans le jeu de données opérationnel actif.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Retour

TRUE si un réseau valide est présent dans le jeu de données opérationnel actif, FALSE sinon.

otDatasetSendMgmtActiveGet

otError otDatasetSendMgmtActiveGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

Cette fonction envoie MGMT_ACTIVE_GET.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[in] aDatasetComponents`	Pointeur vers une structure de composants de jeu de données spécifiant les composants à demander.
`[in] aTlvTypes`	Un pointeur vers un tableau contenant des types TLV bruts supplémentaires à demander.
`[in] aLength`	La longueur des `aTlvTypes` .
`[in] aAddress`	Un pointeur vers la destination IPv6, s'il est NULL, utilisera Leader ALOC par défaut.

Valeurs de retour

`OT_ERROR_NONE`	Envoyez avec succès la commande d'ensemble de données meshcop.
`OT_ERROR_NO_BUFS`	Espace tampon insuffisant pour l'envoi.

otDatasetSendMgmtActiveSet

otError otDatasetSendMgmtActiveSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength
)

Cette fonction envoie MGMT_ACTIVE_SET.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[in] aDataset`	Un pointeur vers un jeu de données opérationnel.
`[in] aTlvs`	Un pointeur vers les TLV.
`[in] aLength`	La longueur des TLV.

Valeurs de retour

`OT_ERROR_NONE`	Envoyez avec succès la commande d'ensemble de données meshcop.
`OT_ERROR_NO_BUFS`	Espace tampon insuffisant pour l'envoi.

otDatasetSendMgmtPendingGet

otError otDatasetSendMgmtPendingGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

Cette fonction envoie MGMT_PENDING_GET.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[in] aDatasetComponents`	Pointeur vers une structure de composants de jeu de données spécifiant les composants à demander.
`[in] aTlvTypes`	Un pointeur vers un tableau contenant des types TLV bruts supplémentaires à demander.
`[in] aLength`	La longueur des `aTlvTypes` .
`[in] aAddress`	Un pointeur vers la destination IPv6, s'il est NULL, utilisera Leader ALOC par défaut.

Valeurs de retour

`OT_ERROR_NONE`	Envoyez avec succès la commande d'ensemble de données meshcop.
`OT_ERROR_NO_BUFS`	Espace tampon insuffisant pour l'envoi.

otDatasetSendMgmtPendingSet

otError otDatasetSendMgmtPendingSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength
)

Cette fonction envoie MGMT_PENDING_SET.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[in] aDataset`	Un pointeur vers un jeu de données opérationnel.
`[in] aTlvs`	Un pointeur vers les TLV.
`[in] aLength`	La longueur des TLV.

Valeurs de retour

`OT_ERROR_NONE`	Envoyez avec succès la commande d'ensemble de données meshcop.
`OT_ERROR_NO_BUFS`	Espace tampon insuffisant pour l'envoi.

otDatasetSetActive

otError otDatasetSetActive(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

Cette fonction définit le jeu de données opérationnel actif.

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

Si Thread est activé sur un appareil qui possède un ensemble de données actif partiellement complet, l'appareil tentera de se connecter à un réseau Thread existant en utilisant toutes les informations existantes dans l'ensemble de données. Seule la clé principale de thread est nécessaire pour se connecter à un réseau.

Si le canal n'est pas inclus dans l'ensemble de données, l'appareil enverra des messages d'annonce MLE sur différents canaux pour trouver des voisins sur d'autres canaux.

Si le périphérique se connecte avec succès à un réseau Thread, le périphérique récupère alors l'ensemble de données actif complet de son parent. Notez qu'un périphérique compatible avec un routeur ne passera pas aux rôles de routeur ou de leader tant qu'il n'aura pas un ensemble de données actif complet.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[in] aDataset`	Un pointeur vers le jeu de données opérationnel actif.

Valeurs de retour

`OT_ERROR_NONE`	Définissez avec succès le jeu de données opérationnel actif.
`OT_ERROR_NO_BUFS`	Espace tampon insuffisant pour définir le jeu de données opérationnel actif.
`OT_ERROR_NOT_IMPLEMENTED`	La plate-forme n'implémente pas la fonctionnalité de paramètres.

otDatasetSetActiveTlvs

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

Cette fonction définit le jeu de données opérationnel actif.

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

Si le canal n'est pas inclus dans l'ensemble de données, l'appareil enverra des messages d'annonce MLE sur différents canaux pour trouver des voisins sur d'autres canaux.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[in] aDataset`	Un pointeur vers le jeu de données opérationnel actif.

Valeurs de retour

`OT_ERROR_NONE`	Définissez avec succès le jeu de données opérationnel actif.
`OT_ERROR_NO_BUFS`	Espace tampon insuffisant pour définir le jeu de données opérationnel actif.
`OT_ERROR_NOT_IMPLEMENTED`	La plate-forme n'implémente pas la fonctionnalité de paramètres.

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

Réglez la minuterie de retard minimal.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[in] aDelayTimerMinimal`	La valeur du temporisateur de retard minimal (en ms).

Valeurs de retour

`OT_ERROR_NONE`	Réglez avec succès la minuterie de retard minimal.
`OT_ERROR_INVALID_ARGS`	Si `aDelayTimerMinimal` n'est pas valide.

otDatasetSetPending

otError otDatasetSetPending(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

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

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[in] aDataset`	Un pointeur vers l'ensemble de données opérationnelles en attente.

Valeurs de retour

`OT_ERROR_NONE`	Définissez avec succès l'ensemble de données opérationnelles en attente.
`OT_ERROR_NO_BUFS`	Espace tampon insuffisant pour définir l'ensemble de données opérationnelles en attente.
`OT_ERROR_NOT_IMPLEMENTED`	La plate-forme n'implémente pas la fonctionnalité de paramètres.

otDatasetSetPendingTlvs

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

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

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[in] aDataset`	Un pointeur vers l'ensemble de données opérationnelles en attente.

Valeurs de retour

`OT_ERROR_NONE`	Définissez avec succès l'ensemble de données opérationnelles en attente.
`OT_ERROR_NO_BUFS`	Espace tampon insuffisant pour définir l'ensemble de données opérationnelles en attente.
`OT_ERROR_NOT_IMPLEMENTED`	La plate-forme n'implémente pas la fonctionnalité de paramètres.

otNetDataGet

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

Cette méthode fournit une copie complète ou stable des données du réseau de threads de la partition.

Détails

Paramètres

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

otNetDataGetNextOnMeshPrefix

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

Cette fonction obtient le prochain préfixe On Mesh dans les données réseau de la partition.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'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 sur le maillage, elle doit être définie sur OT_NETWORK_DATA_ITERATOR_INIT.
`[out] aConfig`	Un pointeur vers l'emplacement des informations sur le préfixe de maillage.

Valeurs de retour

`OT_ERROR_NONE`	Le prochain préfixe On Mesh a été trouvé.
`OT_ERROR_NOT_FOUND`	Aucun préfixe On Mesh subséquent n'existe dans les données du réseau de threads.

otNetDataGetNextRoute

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

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

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'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 route externe, elle doit être définie sur OT_NETWORK_DATA_ITERATOR_INIT.
`[out] aConfig`	Un pointeur vers l'emplacement des informations sur l'itinéraire externe.

Valeurs de retour

`OT_ERROR_NONE`	La prochaine route externe a été trouvée avec succès.
`OT_ERROR_NOT_FOUND`	Aucune entrée de route externe ultérieure n'existe dans les données du réseau de threads.

otNetDataGetNextService

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

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

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[in,out] aIterator`	Un pointeur vers le contexte de l'itérateur de données réseau. Pour obtenir la première entrée de service, elle doit être définie sur OT_NETWORK_DATA_ITERATOR_INIT.
`[out] aConfig`	Un pointeur vers où les informations de service seront placées.

Valeurs de retour

`OT_ERROR_NONE`	Le service suivant a été trouvé avec succès.
`OT_ERROR_NOT_FOUND`	Aucun service ultérieur n'existe dans les données réseau de la partition.

otNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

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

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Retour

La version stable des données réseau.

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

Obtenez la version des données réseau.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Retour

La version des données réseau.

otNetDataSteeringDataCheckJoiner

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

Vérifiez si les données de pilotage incluent un Joiner.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[in] aEui64`	Un pointeur vers IEEE EUI-64 du menuisier.

Valeurs de retour

`OT_ERROR_NONE`	`aEui64` est inclus dans les données de direction.
`OT_ERROR_INVALID_STATE`	Aucune donnée de direction 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 menuisier avec une valeur discerner donnée.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[in] aDiscerner`	Un pointeur vers 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 direction présente.
`OT_ERROR_NOT_FOUND`	`aDiscerner` n'est pas inclus dans les données de pilotage.

otThreadBecomeEnfant

otError otThreadBecomeChild(
  otInstance *aInstance
)

Essayez de vous rattacher en tant qu'enfant.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Valeurs de retour

`OT_ERROR_NONE`	Commencez avec succès à devenir un enfant.
`OT_ERROR_INVALID_STATE`	Le fil est désactivé.

otThreadBecomeDétaché

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Détachez-vous du réseau Thread.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Valeurs de retour

`OT_ERROR_NONE`	Déconnexion réussie du réseau Thread.
`OT_ERROR_INVALID_STATE`	Le fil est désactivé.

otThreadDécouvrir

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

Cette fonction lance une analyse Thread Discovery.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[in] aScanChannels`	Un vecteur de bits indiquant les canaux à scruter (par exemple OT_CHANNEL_11_MASK).
`[in] aPanId`	Le filtre PAN ID (réglé sur Broadcast PAN pour désactiver le filtre).
`[in] aJoiner`	Valeur de l'indicateur de jointure dans le TLV de demande de découverte.
`[in] aEnableEui64Filtering`	TRUE pour filtrer les réponses sur EUI-64, FALSE sinon.
`[in] aCallback`	Un pointeur vers une fonction appelée lors de la réception d'une réponse de découverte MLE ou d'une analyse se termine.
`[in] aCallbackContext`	Un pointeur vers le contexte spécifique à l'application.

Valeurs de retour

`OT_ERROR_NONE`	A accepté la demande de découverte de threads.
`OT_ERROR_BUSY`	Vous effectuez déjà une découverte de threads.

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

Obtenez le délai d'expiration de thread enfant utilisé lors du fonctionnement dans le rôle enfant.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Retour

Valeur du délai d'expiration du thread enfant en secondes.

Voir également:
otThreadSetChildTimeout

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Obtenez le rôle de l'appareil.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Valeurs de retour

`OT_DEVICE_ROLE_DISABLED`	La pile de threads est désactivée.
`OT_DEVICE_ROLE_DETACHED`	Le périphérique ne participe actuellement pas à un réseau / partition Thread.
`OT_DEVICE_ROLE_CHILD`	L'appareil fonctionne actuellement en tant qu'enfant de fil.
`OT_DEVICE_ROLE_ROUTER`	L'appareil fonctionne actuellement comme un routeur de threads.
`OT_DEVICE_ROLE_LEADER`	L'appareil fonctionne actuellement en tant que Thread Leader.

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Obtenez le nom de domaine de thread.

Cette fonction n'est disponible que depuis Thread 1.2.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Retour

Un pointeur vers le nom de domaine de thread.

Voir également:
otThreadSetDomainName

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Obtenez l'ID PAN étendu IEEE 802.15.4.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Retour

Un pointeur vers l'ID PAN étendu IEEE 802.15.4.

Voir également:
otThreadSetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

Obtenez l'identificateur d'interface spécifié manuellement pour l'adresse de monodiffusion du domaine de thread.

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

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Retour

Un pointeur vers l'identificateur d'interface qui a été défini manuellement, ou NULL si aucun n'a été défini.

Voir également:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Obtenez les compteurs IPv6.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Retour

Un pointeur vers les compteurs IPv6.

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Obtenez le thrKeySequenceCounter.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Retour

La valeur thrKeySequenceCounter.

Voir également:
otThreadSetKeySequenceCounter

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Obtenez le thrKeySwitchGuardTime.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Retour

Valeur thrKeySwitchGuardTime (en heures).

Voir également:
otThreadSetKeySwitchGuardTime

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Cette fonction récupère les données du leader du fil.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[out] aLeaderData`	Un pointeur vers l'emplacement des données de repère.

Valeurs de retour

`OT_ERROR_NONE`	Récupération réussie des données de leader.
`OT_ERROR_DETACHED`	Pas actuellement attaché.

otThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

Cette fonction renvoie un pointeur vers le RLOC du leader.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[out] aLeaderRloc`	Un pointeur vers le RLOC du leader.

Valeurs de retour

`OT_ERROR_NONE`	Le RLOC du leader a été écrit avec succès dans `aLeaderRloc` .
`OT_ERROR_INVALID_ARGS`	`aLeaderRloc` était NULL.
`OT_ERROR_DETACHED`	Pas actuellement attaché à une partition de thread.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Obtenez l'ID de routeur du leader.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Retour

L'identifiant du routeur du leader.

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

Obtenez le poids du leader.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Retour

Le poids du leader.

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

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

L'adresse locale du lien de thread est dérivée en utilisant l'adresse étendue IEEE802.15.4 comme identificateur d'interface.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Retour

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

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

Obtenez la configuration du mode de liaison MLE.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Retour

La configuration du mode de liaison MLE.

Voir également:
otThreadSetLinkMode

otThreadGetMasterKey

const otMasterKey * otThreadGetMasterKey(
  otInstance *aInstance
)

Obtenez le thrMasterKey.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Retour

Un pointeur vers un tampon contenant la thrMasterKey.

Voir également:
otThreadSetMasterKey

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

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

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Retour

Un pointeur vers l'adresse EID locale du maillage.

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

Cette fonction renvoie un pointeur vers le préfixe local de maillage.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Retour

Un pointeur vers le préfixe local de maillage.

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Obtenez les compteurs Thread MLE.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Retour

Un pointeur vers les compteurs Thread MLE.

otThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

Obtenez le nom du réseau de threads.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Retour

Un pointeur vers le nom du réseau de threads.

Voir également:
otThreadSetNetworkName

otThreadGetNextDiagnosticTlv

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

Cette fonction obtient le prochain TLV de diagnostic réseau dans le message.

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

Détails

Paramètres

`[in] aMessage`	Un pointeur vers un message.
`[in,out] aIterator`	Un pointeur vers le contexte de l'itérateur de diagnostic réseau. Pour obtenir le premier TLV de diagnostic réseau, il doit être défini sur OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
`[out] aNetworkDiagTlv`	Un pointeur vers l'emplacement des informations TLV de diagnostic réseau.

Valeurs de retour

`OT_ERROR_NONE`	Le prochain TLV de diagnostic réseau a été trouvé avec succès.
`OT_ERROR_NOT_FOUND`	Aucun TLV de diagnostic réseau subséquent n'existe dans le message.
`OT_ERROR_PARSE`	L'analyse du diagnostic réseau suivant a échoué.

otThreadGetNextNequartInfo

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

Cette fonction obtient les informations sur le prochain voisin.

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

Détails

Paramètres

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

Valeurs de retour

`OT_ERROR_NONE`	La prochaine entrée voisine a é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 parent de thread.

Détails

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[out] aParentRssi`	A pointer to where the parent RSSI should be placed.

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

The function retrieves diagnostic information for a Thread Router as parent.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[out] aParentInfo`	A pointer to where the parent router information is placed.

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

The function retrieves the RSSI of the last packet from the Thread Parent.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[out] aLastRssi`	A pointer to where the last RSSI should be placed.

Return Values

`OT_ERROR_NONE`	Successfully retrieved the RSSI data.
`OT_ERROR_FAILED`	Unable to get RSSI data.
`OT_ERROR_INVALID_ARGS`	`aLastRssi` is NULL.

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Get the Partition ID.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

Returns

The Partition ID.

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

This function returns a pointer to the Thread Routing Locator (RLOC) address.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

Returns

A pointer to the Thread Routing Locator (RLOC) address.

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Get the RLOC16.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

Returns

The RLOC16.

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

This function gets the Thread protocol version.

Details
Returns	the Thread protocol version.

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

This function determines if an MLE Thread Discovery is currently in progress.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

This function indicates whether a node is the only router on the network.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

Return Values

`TRUE`	It is the only router in the network.
`FALSE`	It is a child or is not a single router in the network.

otThreadRegisterParentResponseCallback

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

This function registers a callback to receive MLE Parent Response data.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aCallback`	A pointer to a function that is called upon receiving an MLE Parent Response message.
`[in] aContext`	A pointer to callback client-specific context.

otThreadResetIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Reset the IPv6 counters.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Reset the Thread MLE counters.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

otThreadSendDiagnosticGet

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

Send a Network Diagnostic Get request.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aDestination`	A pointer to destination address.
`[in] aTlvTypes`	An array of Network Diagnostic TLV types.
`[in] aCount`	Number of types in aTlvTypes.

Return Values

`OT_ERROR_NONE`	Successfully queued the DIAG_GET.req.
`OT_ERROR_NO_BUFS`	Insufficient message buffers available to send DIAG_GET.req.

otThreadSendDiagnosticReset

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

Send a Network Diagnostic Reset request.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aDestination`	A pointer to destination address.
`[in] aTlvTypes`	An array of Network Diagnostic TLV types. Currently only Type 9 is allowed.
`[in] aCount`	Number of types in aTlvTypes

Return Values

`OT_ERROR_NONE`	Successfully queued the DIAG_RST.ntf.
`OT_ERROR_NO_BUFS`	Insufficient message buffers available to send DIAG_RST.ntf.

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Set the Thread Child Timeout used when operating in the Child role.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aTimeout`	The timeout value in seconds.

See also:
otThreadGetChildTimeout

otThreadSetDiscoveryRequestCallback

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

This function sets a callback to receive MLE Discovery Request data.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aCallback`	A pointer to a function that is called upon receiving an MLE Discovery Request message.
`[in] aContext`	A pointer to callback application-specific context.

otThreadSetDomainName

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

Set the Thread Domain Name.

This function is only available since Thread 1.2. This function succeeds only when Thread protocols are disabled.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aDomainName`	A pointer to the Thread Domain Name.

Return Values

`OT_ERROR_NONE`	Successfully set the Thread Domain Name.
`OT_ERROR_INVALID_STATE`	Thread protocols are enabled.

See also:
otThreadGetDomainName

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

This function starts Thread protocol operation.

The interface must be up when calling this function.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aEnabled`	TRUE if Thread is enabled, FALSE otherwise.

Return Values

`OT_ERROR_NONE`	Successfully started Thread protocol operation.
`OT_ERROR_INVALID_STATE`	The network interface was not not up.

otThreadSetExtendedPanId

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

Set the IEEE 802.15.4 Extended PAN ID.

This function can only be called while Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aExtendedPanId`	A pointer to the IEEE 802.15.4 Extended PAN ID.

Return Values

`OT_ERROR_NONE`	Successfully set the Extended PAN ID.
`OT_ERROR_INVALID_STATE`	Thread protocols are enabled.

See also:
otThreadGetExtendedPanId

otThreadSetFixedDuaInterfaceIdentifier

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

Set/Clear the Interface Identifier manually specified for the Thread Domain Unicast Address.

This function is only available since Thread 1.2 when OPENTHREAD_CONFIG_DUA_ENABLE is enabled.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aIid`	A pointer to the Interface Identifier to set or NULL to clear.

Return Values

`OT_ERROR_NONE`	Successfully set/cleared the Interface Identifier.
`OT_ERROR_INVALID_ARGS`	The specified Interface Identifier is reserved.

See also:
otThreadGetFixedDuaInterfaceIdentifier

otThreadSetJoinerAdvertisement

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

This method sets the Thread Joiner Advertisement when discovering Thread network.

Thread Joiner Advertisement is used to allow a Joiner to advertise its own application-specific information (such as Vendor ID, Product ID, Discriminator, etc.) via a newly-proposed Joiner Advertisement TLV, and to make this information available to Commissioners or Commissioner Candidates without human interaction.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aOui`	The Vendor IEEE OUI value that will be included in the Joiner Advertisement. Only the least significant 3 bytes will be used, and the most significant byte will be ignored.
`[in] aAdvData`	A pointer to the AdvData that will be included in the Joiner Advertisement.
`[in] aAdvDataLength`	The length of AdvData in bytes.

Return Values

`OT_ERROR_NONE`	Successfully set Joiner Advertisement.
`OT_ERROR_INVALID_ARGS`	Invalid AdvData.

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Set the thrKeySequenceCounter.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aKeySequenceCounter`	The thrKeySequenceCounter value.

See also:
otThreadGetKeySequenceCounter

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Set the thrKeySwitchGuardTime.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aKeySwitchGuardTime`	The thrKeySwitchGuardTime value (in hours).

See also:
otThreadGetKeySwitchGuardTime

otThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Set the MLE Link Mode configuration.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aConfig`	A pointer to the Link Mode configuration.

Return Values

OT_ERROR_NONE

Successfully set the MLE Link Mode configuration.

See also:
otThreadGetLinkMode

otThreadSetMasterKey

otError otThreadSetMasterKey(
  otInstance *aInstance,
  const otMasterKey *aKey
)

Set the thrMasterKey.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aKey`	A pointer to a buffer containing the thrMasterKey.

Return Values

`OT_ERROR_NONE`	Successfully set the thrMasterKey.
`OT_ERROR_INVALID_ARGS`	If aKeyLength is larger than 16.
`OT_ERROR_INVALID_STATE`	Thread protocols are enabled.

See also:
otThreadGetMasterKey

otThreadSetMeshLocalPrefix

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

This function sets the Mesh Local Prefix.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aMeshLocalPrefix`	A pointer to the Mesh Local Prefix.

Return Values

`OT_ERROR_NONE`	Successfully set the Mesh Local Prefix.
`OT_ERROR_INVALID_STATE`	Thread protocols are enabled.

otThreadSetNetworkName

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

Set the Thread Network Name.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aNetworkName`	A pointer to the Thread Network Name.

Return Values

`OT_ERROR_NONE`	Successfully set the Thread Network Name.
`OT_ERROR_INVALID_STATE`	Thread protocols are enabled.

See also:
otThreadGetNetworkName

otThreadSetReceiveDiagnosticGetCallback

void otThreadSetReceiveDiagnosticGetCallback(
  otInstance *aInstance,
  otReceiveDiagnosticGetCallback aCallback,
  void *aCallbackContext
)

This function registers a callback to provide received raw Network Diagnostic Get response payload.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aCallback`	A pointer to a function that is called when Network Diagnostic Get response is received or NULL to disable the callback.
`[in] aCallbackContext`	A pointer to application-specific context.

Macros

OT_CHANNEL_10_MASK

 OT_CHANNEL_10_MASK (1 << 10)

Channel 10.

OT_CHANNEL_11_MASK

 OT_CHANNEL_11_MASK (1 << 11)

Channel 11.

OT_CHANNEL_12_MASK

 OT_CHANNEL_12_MASK (1 << 12)

Channel 12.

OT_CHANNEL_13_MASK

 OT_CHANNEL_13_MASK (1 << 13)

Channel 13.

OT_CHANNEL_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

Channel 14.

OT_CHANNEL_15_MASK

 OT_CHANNEL_15_MASK (1 << 15)

Channel 15.

OT_CHANNEL_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

Channel 16.

OT_CHANNEL_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

Channel 17.

OT_CHANNEL_18_MASK

 OT_CHANNEL_18_MASK (1 << 18)

Channel 18.

OT_CHANNEL_19_MASK

 OT_CHANNEL_19_MASK (1 << 19)

Channel 19.

OT_CHANNEL_1_MASK

 OT_CHANNEL_1_MASK (1 << 1)

Channel 1.

OT_CHANNEL_20_MASK

 OT_CHANNEL_20_MASK (1 << 20)

Channel 20.

OT_CHANNEL_21_MASK

 OT_CHANNEL_21_MASK (1 << 21)

Channel 21.

OT_CHANNEL_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

Channel 22.

OT_CHANNEL_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

Channel 23.

OT_CHANNEL_24_MASK

 OT_CHANNEL_24_MASK (1 << 24)

Channel 24.

OT_CHANNEL_25_MASK

 OT_CHANNEL_25_MASK (1 << 25)

Channel 25.

OT_CHANNEL_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

Channel 26.

OT_CHANNEL_2_MASK

 OT_CHANNEL_2_MASK (1 << 2)

Channel 2.

OT_CHANNEL_3_MASK

 OT_CHANNEL_3_MASK (1 << 3)

Channel 3.

OT_CHANNEL_4_MASK

 OT_CHANNEL_4_MASK (1 << 4)

Channel 4.

OT_CHANNEL_5_MASK

 OT_CHANNEL_5_MASK (1 << 5)

Channel 5.

OT_CHANNEL_6_MASK

 OT_CHANNEL_6_MASK (1 << 6)

Channel 6.

OT_CHANNEL_7_MASK

 OT_CHANNEL_7_MASK (1 << 7)

Channel 7.

OT_CHANNEL_8_MASK

 OT_CHANNEL_8_MASK (1 << 8)

Channel 8.

OT_CHANNEL_9_MASK

 OT_CHANNEL_9_MASK (1 << 9)

Channel 9.

OT_EXT_PAN_ID_SIZE

 OT_EXT_PAN_ID_SIZE 8

Size of a Thread PAN ID (bytes)

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Maximum AdvData Length of Joiner Advertisement.

OT_MASTER_KEY_SIZE

 OT_MASTER_KEY_SIZE 16

Size of the Thread Master Key (bytes)

OT_MESH_LOCAL_PREFIX_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

Size of the Mesh Local Prefix (bytes)

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Initializer for otNeighborInfoIterator.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Maximum value length of Thread Base TLV.

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

Initializer for otNetworkDataIterator.

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

Size of Network Diagnostic Child Table entry.

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Initializer for otNetworkDiagIterator.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

Maximum Number of Network Diagnostic TLV Types to Request or Reset.

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

Maximum Router ID.

OT_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

Maximum size of the Thread Network Name field (bytes)

OT_OPERATIONAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

Maximum length of Operational Dataset in bytes.

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

Maximum size of the PSKc (bytes)

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

Maximum size of Server Data in bytes. This is theoretical limit, practical one is much lower.

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Maximum size of Service Data in bytes.

Général

Résumé

Énumérations

Typedefs

Variables

Les fonctions

Structs

Énumérations

énumération anonyme

énumération anonyme

otDeviceRole

otMeshcopTlvType

otRoutePreference

Typedefs

otBorderRouterConfig

otChannelMask

otExtendedPanId

otExternalRouteConfig

otIpCounters

otLeaderData

otLinkModeConfig

otMasterKey

otMeshLocalPrefix

otMeshcopTlvType

otMleCounters

otNequartInfoIterator

otNetworkDataIterator

otNetworkDiagChildEntry

otNetworkDiagConnectivity

otNetworkDiagIterator

otNetworkDiagMacCounters

otNetworkDiagRoute

otNetworkDiagRouteData

otNetworkDiagTlv

otNetworkName

otOperationalDataset

otOperationalDatasetComponents

otOperationalDatasetTlvs

otPskc

otReceiveDiagnosticGetCallback

otRoutePreference

otSecurityPolicy

otServerConfig

otServiceConfig

otThreadDiscoveryRequestCallback

otThreadDiscoveryRequestInfo

otThreadParentResponseCallback

otThreadParentResponseInfo

Variables

OT_TOOL_PACKED_END

Les fonctions

otDatasetCreateNewNetwork

otDatasetGeneratePskc

otDatasetGetActive

otDatasetGetActiveTlvs

otDatasetGetDelayTimerMinimal

otDatasetGetPending

otDatasetGetPendingTlvs

otDatasetIsCommissioned

otDatasetSendMgmtActiveGet

otDatasetSendMgmtActiveSet

otDatasetSendMgmtPendingGet

otDatasetSendMgmtPendingSet

otDatasetSetActive

otDatasetSetActiveTlvs

otDatasetSetDelayTimerMinimal

otDatasetSetPending

otDatasetSetPendingTlvs

otNetDataGet

otNetDataGetNextOnMeshPrefix

otNetDataGetNextRoute

otNetDataGetNextService

otNetDataGetStableVersion

otNetDataGetVersion

otNetDataSteeringDataCheckJoiner

otNetDataSteeringDataCheckJoinerWithDiscerner

otThreadBecomeEnfant

otThreadBecomeDétaché

otThreadDécouvrir

otThreadGetChildTimeout