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

Routeur/tête

Ce module inclut des fonctions pour les routeurs de threads et les variantes optimales.

Résumé

Énumérations
`otCacheEntryState`	enum Cette énumération définit l'état d'entrée du cache EID.
`otNeighborTableEvent{ OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED, OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED, OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED, OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED, OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED }`	enum Cette énumération définit les constantes utilisées dans `otNeighborTableCallback` pour indiquer les modifications dans la table voisine.

Définitions
`otCacheEntryInfo`	CANNOT TRANSLATE `struct otCacheEntryInfo` Cette structure représente une entrée de cache EID.
`otCacheEntryIterator`	CANNOT TRANSLATE `struct otCacheEntryIterator` Ce type représente un itérateur utilisé pour effectuer des itérations via les entrées de la table de cache EID.
`otCacheEntryState`	CANNOT TRANSLATE `enum otCacheEntryState` Cette énumération définit l'état d'entrée du cache EID.
`otChildIp6AddressIterator`	CANNOT TRANSLATE `uint16_t` Utilisé pour effectuer des itérations via les adresses IPv6 d'une entrée enfant Thread.
`otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)`	CANNOT TRANSLATE `void(*` Ce pointeur de fonction est appelé pour avertir qu'une modification a été apportée à la table voisine.

Functions
`otThreadBecomeLeader(otInstance *aInstance)`	`otError` Devenez un leader et créez une nouvelle partition.
`otThreadBecomeRouter(otInstance *aInstance)`	`otError` Essayez de devenir routeur.
`otThreadGetChildInfoById(otInstance aInstance, uint16_t aChildId, otChildInfo aChildInfo)`	`otError` La fonction conserve les informations de diagnostic d'un enfant joint à son identifiant enfant ou RLOC16.
`otThreadGetChildInfoByIndex(otInstance aInstance, uint16_t aChildIndex, otChildInfo aChildInfo)`	`otError` La fonction conserve les informations de diagnostic d'un enfant associé par l'index de table interne.
`otThreadGetChildNextIp6Address(otInstance aInstance, uint16_t aChildIndex, otChildIp6AddressIterator aIterator, otIp6Address *aAddress)`	`otError` Cette fonction obtient l'adresse IPv6 suivante (à l'aide d'un itérateur) pour un enfant donné.
`otThreadGetContextIdReuseDelay(otInstance *aInstance)`	`uint32_t` Obtenez le paramètre CONTEXT_ID_REUSE_DELAY utilisé dans le rôle de responsable.
`otThreadGetJoinerUdpPort(otInstance *aInstance)`	`uint16_t` Récupérez le port UDP de la jointure.
`otThreadGetLocalLeaderWeight(otInstance *aInstance)`	`uint8_t` Obtenez la pondération de leader de fil de discussion dans le rôle de leader.
`otThreadGetMaxAllowedChildren(otInstance *aInstance)`	`uint16_t` Obtenez le nombre maximal d'enfants actuellement autorisé.
`otThreadGetMaxChildIpAddresses(otInstance *aInstance)`	`uint8_t` Cette fonction obtient le nombre maximal d'adresses IP que chaque enfant MTD peut enregistrer sur cet appareil en tant que parent.
`otThreadGetMaxRouterId(otInstance *aInstance)`	`uint8_t` La fonction renvoie l'ID de routeur maximal autorisé.
`otThreadGetNetworkIdTimeout(otInstance *aInstance)`	`uint8_t` Obtenez le paramètre NETWORK_ID_TIMEOUT utilisé dans le rôle Router.
`otThreadGetNextCacheEntry(otInstance aInstance, otCacheEntryInfo aEntryInfo, otCacheEntryIterator *aIterator)`	`otError` Cette fonction obtient la prochaine entrée de cache EID (à l'aide d'un itérateur).
`otThreadGetParentPriority(otInstance *aInstance)`	`int8_t` Obtenez la priorité parente attribuée.
`otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)`	`uint32_t` Obtenez l'ID de la partition du leader du fil de discussion préféré dans le rôle de leader.
`otThreadGetPskc(otInstance aInstance, otPskc aPskc)`	`void` Obtenez le PSKc de Thread.
`otThreadGetPskcRef(otInstance *aInstance)`	`otPskcRef` Obtenez la référence de la clé PSKc stockée.
`otThreadGetRouterDowngradeThreshold(otInstance *aInstance)`	`uint8_t` Obtenez le paramètre ROUTER_DOWNGRADE_THRESHOLD dans le rôle Routeur.
`otThreadGetRouterIdRange(otInstance aInstance, uint8_t aMinRouterId, uint8_t *aMaxRouterId)`	`void` Cette fonction obtient la plage d'ID de routeur autorisés à être attribués aux nœuds du réseau de fils de discussion.
`otThreadGetRouterIdSequence(otInstance *aInstance)`	`uint8_t` Obtenez la séquence d'identifiants actuelle du routeur.
`otThreadGetRouterInfo(otInstance aInstance, uint16_t aRouterId, otRouterInfo aRouterInfo)`	`otError` La fonction conserve les informations de diagnostic d'un routeur de fils de discussion donné.
`otThreadGetRouterSelectionJitter(otInstance *aInstance)`	`uint8_t` Obtenez le paramètre ROUTER_REFERENCE_JITTER utilisé dans le rôle REED/Router.
`otThreadGetRouterUpgradeThreshold(otInstance *aInstance)`	`uint8_t` Obtenez le paramètre ROUTER_UPGRADE_THRESHOLD dans le rôle REED.
`otThreadIsRouterEligible(otInstance *aInstance)`	`bool` Cette méthode indique si l'appareil est éligible ou non au routeur.
`otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback)`	`void` Cette fonction enregistre une fonction de rappel de table de voisins.
`otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)`	`otError` Libérez un ID de routeur attribué par l'appareil dans le rôle de leader.
`otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled)`	`void` Cette fonction indique si l'appareil a été commandé à l'aide du CCM.
`otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t aDelay)`	`void` Définissez le paramètre CONTEXT_ID_REUSE_DELAY associé à ce rôle.
`otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)`	`otError` Définissez le port UDP de la jointure.
`otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)`	`void` Permet de définir la pondération de leader de fil de discussion utilisée dans le cadre du rôle de responsable.
`otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)`	`otError` Définissez le nombre maximal d'enfants actuellement autorisé.
`otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)`	`otError` Cette fonction définit/restaure le nombre maximal d'adresses IP que chaque enfant MTD peut enregistrer sur cet appareil en tant que parent.
`otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)`	`void` Définissez le paramètre NETWORK_ID_TIMEOUT utilisé dans le rôle de leader.
`otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)`	`otError` Définissez la priorité du parent.
`otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)`	`void` Définissez l'ID de la partition du leader du fil de discussion à utiliser dans le rôle de leader.
`otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)`	`otError` Définissez l'ID de routeur à utiliser.
`otThreadSetPskc(otInstance aInstance, const otPskc aPskc)`	`otError` Définissez la balise PSKc de Thread.
`otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)`	`otError` Définissez la balise PSKc de Thread.
`otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)`	`void` Définissez le paramètre ROUTER_DOWNGRADE_THRESHOLD dans le rôle Leader.
`otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)`	`otError` Cette fonction indique si l'appareil est éligible au routeur ou non.
`otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)`	`otError` Cette fonction définit la plage d'ID de routeur autorisés à attribuer des nœuds au réseau de fils de discussion.
`otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)`	`void` Définissez le paramètre ROUTER_Sélection_JITTER utilisé dans le rôle REED/Router.
`otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8_t aThreshold)`	`void` Définissez le paramètre ROUTER_UPGRADE_THRESHOLD dans le rôle Leader.
`otThreadSetSteeringData(otInstance aInstance, const otExtAddress aExtAddress)`	`void` Définissez la direction des données de direction hors bande.
`otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)`	`void` Cette fonction détermine si le seuil de version TLV de la règle de sécurité pour le routage (champ RV) est activé.

Structures
otCacheEntryInfo	Cette structure représente une entrée de cache EID.
otCacheEntryiter	Ce type représente un itérateur utilisé pour effectuer des itérations via les entrées de la table de cache EID.
otChildInfo	Cette structure contient des informations de diagnostic pour un enfant Thread.
otNeighborTableEntryInfo	Ce type représente les informations sur l'entrée de la table voisine (enfant ou routeur) et est utilisé en tant que paramètre dans le rappel de la table voisine (`otNeighborTableCallback`).

Énumérations

otCacheEntryState

 otCacheEntryState

Cette énumération définit l'état d'entrée du cache EID.

otNeighborTableEvent

 otNeighborTableEvent

Cette énumération définit les constantes utilisées dans otNeighborTableCallback pour indiquer les modifications dans la table voisine.

Properties
`OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED`	Un enfant est en cours d'ajout.
`OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED`	Le mode enfant est modifié.
`OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED`	Un enfant est en cours de suppression.
`OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED`	Un routeur est en cours d'ajout.
`OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED`	Un routeur est en cours de suppression.

Définitions

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

Cette structure représente une entrée de cache EID.

otCacheEntryiter

struct otCacheEntryIterator otCacheEntryIterator

Ce type représente un itérateur utilisé pour effectuer des itérations via les entrées de la table de cache EID.

Pour initialiser l'itérateur et commencer à partir de la première entrée de la table de cache, définissez tous les champs de la structure sur zéro (ex. memset l'itérateur à zéro.)

otCacheEntryState

enum otCacheEntryState otCacheEntryState

Cette énumération définit l'état d'entrée du cache EID.

otChildIp6Addressitération

uint16_t otChildIp6AddressIterator

Utilisé pour effectuer des itérations via les adresses IPv6 d'une entrée enfant Thread.

otNeighborTableCallback

void(* otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)

Ce pointeur de fonction est appelé pour avertir qu'une modification a été apportée à la table voisine.

Détails

Paramètres

`[in] aEvent`	Indicateur d'événement.
`[in] aEntryInfo`	Pointeur vers des informations sur l'entrée de la table.

Functions

otThreaddeLeader

otError otThreadBecomeLeader(
  otInstance *aInstance
)

Devenez un leader et créez une nouvelle partition.

Détails

Paramètres

[in] aInstance

Pointeur vers une instance OpenThread.

Valeurs renvoyées

`OT_ERROR_NONE`	Vous êtes maintenant un leader et une nouvelle partition a été lancée.
`OT_ERROR_INVALID_STATE`	Le fil de discussion est désactivé.

Routeur

otError otThreadBecomeRouter(
  otInstance *aInstance
)

Essayez de devenir routeur.

Détails

Paramètres

[in] aInstance

Pointeur vers une instance OpenThread.

Valeurs renvoyées

`OT_ERROR_NONE`	Essayez de devenir un routeur.
`OT_ERROR_INVALID_STATE`	Le fil de discussion est désactivé.

otThreadGetChildInfoById

otError otThreadGetChildInfoById(
  otInstance *aInstance,
  uint16_t aChildId,
  otChildInfo *aChildInfo
)

La fonction conserve les informations de diagnostic d'un enfant joint à son identifiant enfant ou RLOC16.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aChildId`	ID enfant ou RLOC16 de l'enfant associé.
`[out] aChildInfo`	Point de repère indiquant où les informations sur l'enfant sont placées.

Valeurs renvoyées

`OT_ERROR_NONE`	`aChildInfo` a bien été mis à jour avec les informations de l'ID indiqué.
`OT_ERROR_NOT_FOUND`	Aucun enfant valide ne possède cet ID enfant.
`OT_ERROR_INVALID_ARGS`	Si `aChildInfo` est NULL.

otThreadGetChildInfoByIndex

otError otThreadGetChildInfoByIndex(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildInfo *aChildInfo
)

La fonction conserve les informations de diagnostic d'un enfant associé par l'index de table interne.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aChildIndex`	L'index de la table
`[out] aChildInfo`	Point de repère indiquant où les informations sur l'enfant sont placées.

Valeurs renvoyées

`OT_ERROR_NONE`	`aChildInfo` a bien été mis à jour avec les informations de l'index donné.
`OT_ERROR_NOT_FOUND`	Aucun enfant valide pour cet index.
`OT_ERROR_INVALID_ARGS`	Soit `aChildInfo` est NULL, soit `aChildIndex` se trouve en dehors de la plage (supérieur à l'index de table maximal).

Voir aussi:
otGetMaxAllowedChild

otThreadGetChildNextIp6Address

otError otThreadGetChildNextIp6Address(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildIp6AddressIterator *aIterator,
  otIp6Address *aAddress
)

Cette fonction obtient l'adresse IPv6 suivante (à l'aide d'un itérateur) pour un enfant donné.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aChildIndex`	L'index enfant
`[in,out] aIterator`	Pointeur vers l'itérateur. En cas de réussite, l'itérateur est mis à jour pour pointer vers l'entrée suivante de la liste. Pour obtenir la première adresse IPv6, l'itérateur doit être défini sur OT_CHILD_IP6_ADDRESS_ITERATOR_INIT.
`[out] aAddress`	Pointeur vers une adresse IPv6 où l'adresse suivante de l'enfant est placée (en cas de réussite).

Valeurs renvoyées

`OT_ERROR_NONE`	L'adresse IPv6 suivante (`aAddress`) a bien été mise à jour.
`OT_ERROR_NOT_FOUND`	L'enfant ne possède pas d'adresse IPv6 ultérieure.
`OT_ERROR_INVALID_ARGS`	`aIterator` ou `aAddress` sont NULL ou l'enfant de `aChildIndex` n'est pas valide.

Voir aussi :
otThreadGetChildInfoByIndex

otThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

Obtenez le paramètre CONTEXT_ID_REUSE_DELAY utilisé dans le rôle de responsable.

Détails

Paramètres

[in] aInstance

Pointeur vers une instance OpenThread.

Renvoie

Valeur CONTEXT_ID_REUSE_DELAY.

Voir aussi:
otThreadSetContextIdReuseDelay

otThreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Récupérez le port UDP de la jointure.

Détails

Paramètres

[in] aInstance

Pointeur vers une instance OpenThread.

Renvoie

Numéro de port UDP de la jointure.

Voir aussi :
otThreadSetJoinerUdpPort

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

Obtenez la pondération de leader de fil de discussion dans le rôle de leader.

Détails

Paramètres

[in] aInstance

Pointeur vers une instance OpenThread.

Renvoie

Valeur du poids du leader du fil de discussion.

Voir aussi :
otThreadSetLeaderWeight

otThreadGetMaxAllowedChild

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

Obtenez le nombre maximal d'enfants actuellement autorisé.

Détails

Paramètres

[in] aInstance

Pointeur vers une instance OpenThread.

Renvoie

Nombre maximal d'enfants autorisé actuellement.

Voir aussi:
otThreadSetMaxAllowedChild

otThreadGetMaxChildIpAddresses

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

Cette fonction obtient le nombre maximal d'adresses IP que chaque enfant MTD peut enregistrer sur cet appareil en tant que parent.

Détails

Paramètres

[in] aInstance

Pointeur vers une instance OpenThread.

Renvoie

Nombre maximal d'adresses IP que chaque enfant MTD peut enregistrer sur cet appareil en tant que parent.

Voir aussi :
otThreadSetMaxChildIpAddresses

otThreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

La fonction renvoie l'ID de routeur maximal autorisé.

Détails

Paramètres

[in] aInstance

Pointeur vers une instance OpenThread.

Renvoie

ID de routeur maximal autorisé.

otThreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

Obtenez le paramètre NETWORK_ID_TIMEOUT utilisé dans le rôle Router.

Détails

Paramètres

[in] aInstance

Pointeur vers une instance OpenThread.

Renvoie

Valeur NETWORK_ID_TIMEOUT.

Voir aussi:
otThreadSetNetworkIdTimeout

otThreadGetNextCacheEntry

otError otThreadGetNextCacheEntry(
  otInstance *aInstance,
  otCacheEntryInfo *aEntryInfo,
  otCacheEntryIterator *aIterator
)

Cette fonction obtient la prochaine entrée de cache EID (à l'aide d'un itérateur).

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[out] aEntryInfo`	Point à l'emplacement où les informations d'entrée du cache EID sont placées.
`[in,out] aIterator`	Pointeur vers un itérateur. Elle sera mise à jour pour passer à la prochaine entrée. Pour obtenir la première entrée, initialisez l'itérateur en définissant tous ses champs sur zéro (ex. : `memset` de la structure de l'itérateur sur zéro).

Valeurs renvoyées

`OT_ERROR_NONE`	`aEntryInfo` a bien été renseigné pour la prochaine entrée de cache EID.
`OT_ERROR_NOT_FOUND`	La table du cache d'adresses ne contient plus d'entrées.

otThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

Obtenez la priorité parente attribuée.

Détails

Paramètres

[in] aInstance

Pointeur vers une instance OpenThread.

Renvoie

La valeur de priorité parente attribuée, -2, n'est pas attribuée.

Voir aussi :
otThreadSetParentPriority

otThreadGetPreferredLeaderPartitionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

Obtenez l'ID de la partition du leader du fil de discussion préféré dans le rôle de leader.

Détails

Paramètres

[in] aInstance

Pointeur vers une instance OpenThread.

Renvoie

Valeur de l'ID de la partition du leader du fil de discussion.

OTThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

Obtenez le PSKc de Thread.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[out] aPskc`	Un pointeur vers un `otPskc` pour renvoyer le PSKc Thread récupéré.

Voir aussi:
otThreadSetPskc

otThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

Obtenez la référence de la clé PSKc stockée.

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

Détails

Paramètres

[in] aInstance

Pointeur vers une instance OpenThread.

Renvoie

Référence clé à PSKc

Voir aussi :
otThreadSetPskcRef

otThreadGetRouterPasserSeuil

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

Obtenez le paramètre ROUTER_DOWNGRADE_THRESHOLD dans le rôle Routeur.

Détails

Paramètres

[in] aInstance

Pointeur vers une instance OpenThread.

Renvoie

La valeur ROUTER_DOWNGRADE_THRESHOLD.

Voir aussi:
otThreadSetRouterGRADEThreshold

otThreadGetRouterIdRange

void otThreadGetRouterIdRange(
  otInstance *aInstance,
  uint8_t *aMinRouterId,
  uint8_t *aMaxRouterId
)

Cette fonction obtient la plage d'ID de routeur autorisés à être attribués aux nœuds du réseau de fils de discussion.

Remarque : Cette API nécessite OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE et n'est utilisée qu'à des fins de test. Tous les ID de routeur compris dans la plage [aMinRouterId, aMaxRouterId] sont autorisés.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[out] aMinRouterId`	ID minimal du routeur.
`[out] aMaxRouterId`	ID maximal du routeur.

Voir aussi:
otThreadSetRouterIdRange

otThreadGetRouterIdSéquence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

Obtenez la séquence d'identifiants actuelle du routeur.

Détails

Paramètres

[in] aInstance

Pointeur vers une instance OpenThread.

Renvoie

La séquence d'identifiants du routeur.

otThreadGetRouterInfo

otError otThreadGetRouterInfo(
  otInstance *aInstance,
  uint16_t aRouterId,
  otRouterInfo *aRouterInfo
)

La fonction conserve les informations de diagnostic d'un routeur de fils de discussion donné.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aRouterId`	ID de routeur ou RLOC16 pour un routeur donné.
`[out] aRouterInfo`	Un pointeur vers l'emplacement où les informations du routeur sont placées.

Valeurs renvoyées

`OT_ERROR_NONE`	Les informations du routeur associées à cet ID ont bien été récupérées.
`OT_ERROR_NOT_FOUND`	Aucune entrée de routeur avec l'ID indiqué.
`OT_ERROR_INVALID_ARGS`	`aRouterInfo` est NULL.

otThreadGetRouterSelectionJitter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

Obtenez le paramètre ROUTER_REFERENCE_JITTER utilisé dans le rôle REED/Router.

Détails

Paramètres

[in] aInstance

Pointeur vers une instance OpenThread.

Renvoie

Valeur ROUTER_SELECTED_JITTER.

Voir aussi:
otThreadSetRouterSelectionJitter

otThreadGetRouterUpgradeThreshold

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

Obtenez le paramètre ROUTER_UPGRADE_THRESHOLD dans le rôle REED.

Détails

Paramètres

[in] aInstance

Pointeur vers une instance OpenThread.

Renvoie

Valeur de la route ROUTER_UPGRADE_THRESHOLD.

Voir aussi :
otThreadSetRouterUpgradeThreshold

otThreadIsRouterÉligible

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

Cette méthode indique si l'appareil est éligible ou non au routeur.

Détails

Paramètres

[in] aInstance

Pointeur vers une instance OpenThread.

Valeurs renvoyées

`TRUE`	Si l'appareil est éligible au routeur.
`FALSE`	Si l'appareil n'est pas éligible au routeur.

otThreadRegisterNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

Cette fonction enregistre une fonction de rappel de table de voisins.

Le rappel fourni (si la valeur n'est pas NULL) est invoqué en cas de modification de la table voisine (par exemple, un élément enfant ou une voisine du routeur est ajouté/supprimé ou le mode enfant est modifié).

Les appels ultérieurs à cette méthode écraseront le rappel précédent. Notez que ce rappel est appelé pendant que la table voisine ou enfant est mise à jour et toujours avant otStateChangedCallback.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aCallback`	Un pointeur vers une fonction de gestionnaire de rappel.

otThreadReleaseRouterId

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Libérez un ID de routeur attribué par l'appareil dans le rôle de leader.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aRouterId`	ID de routeur à libérer. La plage valide est [0, 62].

Valeurs renvoyées

`OT_ERROR_NONE`	L'ID de routeur a bien été libéré.
`OT_ERROR_INVALID_ARGS`	`aRouterId` n'est pas compris dans la plage [0, 62].
`OT_ERROR_INVALID_STATE`	L'appareil n'est pas en tant que leader.
`OT_ERROR_NOT_FOUND`	L'ID de routeur n'est pas alloué actuellement.

otThreadSetCcmEnabled

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Cette fonction indique si l'appareil a été commandé à l'aide du CCM.

Remarque:Cette API nécessite OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE. Elle n'est utilisée que par Thread Test Harness pour indiquer si cet appareil a été commandé à l'aide du CCM.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aEnabled`	Prend la valeur TRUE si l'appareil a été commandé via CCM.

otThreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

Définissez le paramètre CONTEXT_ID_REUSE_DELAY associé à ce rôle.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aDelay`	Valeur CONTEXT_ID_REUSE_DELAY.

Voir aussi :
otThreadGetContextIdReuseDelay

otThreadSetJoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

Définissez le port UDP de la jointure.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aJoinerUdpPort`	Numéro de port UDP de la jointure.

Valeurs renvoyées

OT_ERROR_NONE

Le port UDP de la jointure a bien été défini.

Voir aussi:
otThreadGetJoinerUdpPort

otThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

Permet de définir la pondération de leader de fil de discussion utilisée dans le cadre du rôle de responsable.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aWeight`	Valeur du poids du leader du fil de discussion.

Voir aussi:
otThreadGetLeaderWeight

otThreadSetMaxAllowedChild

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

Définissez le nombre maximal d'enfants actuellement autorisé.

Ce paramètre ne peut être défini que lorsque l'opération de protocole Thread a été arrêtée.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aMaxChildren`	Nombre maximal d'enfants autorisé.

Valeurs renvoyées

`OT_ERROR_NONE`	Le CPC max. a bien été défini.
`OT_ERROR_INVALID_ARGS`	Si `aMaxChildren` n'est pas compris dans la plage [1, OPENthread_CONFIG_MLE_MAX_CHILDREN].
`OT_ERROR_INVALID_STATE`	Si le fil de discussion n'est pas arrêté.

Voir aussi :
otThreadGetMaxAllowedChild

otThreadSetMaxChildIpAddresses

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

Cette fonction définit/restaure le nombre maximal d'adresses IP que chaque enfant MTD peut enregistrer sur cet appareil en tant que parent.

Remarque : Cette API nécessite OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE. Elle est utilisée uniquement par Thread Test Harness pour limiter les enregistrements d'adresses du parent de référence afin de tester la réaction MTD DUT.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aMaxIpAddresses`	Nombre maximal d'adresses IP que chaque enfant MTD peut enregistrer sur cet appareil en tant que parent. 0 pour effacer le paramètre et restaurer la valeur par défaut.

Valeurs renvoyées

`OT_ERROR_NONE`	Le numéro a été correctement défini et/ou effacé.
`OT_ERROR_INVALID_ARGS`	Si le nombre maximal autorisé est dépassé.

Voir aussi:
otThreadGetMaxChildIpAddresses

otThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

Définissez le paramètre NETWORK_ID_TIMEOUT utilisé dans le rôle de leader.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aTimeout`	Valeur NETWORK_ID_TIMEOUT.

Voir aussi:
otThreadGetNetworkIdTimeout

otThreadSetParentPriority

otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

Définissez la priorité du parent.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aParentPriority`	Valeur de priorité parente.

Valeurs renvoyées

`OT_ERROR_NONE`	La priorité parente a bien été définie.
`OT_ERROR_INVALID_ARGS`	Si la valeur de priorité parente n'est pas comprise entre 1, 0, -1 et -2.

Voir aussi :
otThreadGetParentPriority

otThreadSetPreferredLeaderPartitionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

Définissez l'ID de la partition du leader du fil de discussion à utiliser dans le rôle de leader.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aPartitionId`	Valeur de l'ID de la partition du leader du fil de discussion.

otThreadSetPreferredRouterId

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Définissez l'ID de routeur à utiliser.

Lorsque le nœud devient un routeur ou un leader, le nœud tente d'utiliser cet ID. Si l'ID de routeur préféré n'est pas défini ou s'il ne peut pas être utilisé, un ID de routeur généré de manière aléatoire est sélectionné. Cette propriété ne peut être définie que lorsque le rôle de l'appareil est dissocié ou désactivé.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aRouterId`	ID de routeur à privilégier.

Valeurs renvoyées

`OT_ERROR_NONE`	L'ID de routeur préféré a bien été défini.
`OT_ERROR_INVALID_STATE`	Impossible de définir (le rôle n'est pas dissocié ou désactivé)

otThreadSetPskc

otError otThreadSetPskc(
  otInstance *aInstance,
  const otPskc *aPskc
)

Définissez la balise PSKc de Thread.

Cette fonction n'aboutira que si les protocoles Thread sont désactivés. Si l'opération aboutit, les ensembles de données opérationnels actifs et en attente seront également invalidés dans la mémoire non volatile.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aPskc`	Un pointeur vers le nouveau SKPSK.

Valeurs renvoyées

`OT_ERROR_NONE`	La clé PSKc a bien été définie.
`OT_ERROR_INVALID_STATE`	Les protocoles Thread sont activés.

Voir aussi :
otThreadGetPskc

otThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

Définissez la balise PSKc de Thread.

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

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aKeyRef`	Référence clé à la nouvelle PSKc de thread.

Valeurs renvoyées

`OT_ERROR_NONE`	La clé PSKc a bien été définie.
`OT_ERROR_INVALID_STATE`	Les protocoles Thread sont activés.

Voir aussi :
otThreadGetPskcRef

otThreadSetRouterDOWNThreshold

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Définissez le paramètre ROUTER_DOWNGRADE_THRESHOLD dans le rôle Leader.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aThreshold`	La valeur ROUTER_DOWNGRADE_THRESHOLD.

Voir aussi:
otThreadGetRouterPasserThreshold

otThreadSetRouterÉligible

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

Cette fonction indique si l'appareil est éligible au routeur ou non.

Si la valeur de aEligible est "false" et que l'appareil fonctionne actuellement en tant que routeur, cet appel entraîne la dissociation et l'association de l'appareil en tant qu'enfant.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aEligible`	Prend la valeur TRUE pour configurer l'appareil comme étant éligible au routeur, ou FALSE dans le cas contraire.

Valeurs renvoyées

`OT_ERROR_NONE`	La configuration éligible au routeur a bien été définie.
`OT_ERROR_NOT_CAPABLE`	L'appareil ne peut pas devenir un routeur.

otThreadSetRouterIdRange

otError otThreadSetRouterIdRange(
  otInstance *aInstance,
  uint8_t aMinRouterId,
  uint8_t aMaxRouterId
)

Cette fonction définit la plage d'ID de routeur autorisés à attribuer des nœuds au réseau de fils de discussion.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aMinRouterId`	ID minimal du routeur.
`[in] aMaxRouterId`	ID maximal du routeur.

Valeurs renvoyées

`OT_ERROR_NONE`	La plage a bien été définie.
`OT_ERROR_INVALID_ARGS`	aMinRouterId > aMaxRouterId, ou la plage n'est pas couverte par [0, 62].

Voir aussi:
otThreadGetRouterIdRange

otThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

Définissez le paramètre ROUTER_Sélection_JITTER utilisé dans le rôle REED/Router.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aRouterJitter`	Valeur ROUTER_SELECTED_JITTER.

Voir aussi:
otThreadGetRouterSelectionJitter

otThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Définissez le paramètre ROUTER_UPGRADE_THRESHOLD dans le rôle Leader.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aThreshold`	Valeur de la route ROUTER_UPGRADE_THRESHOLD.

Voir aussi :
otThreadGetRouterUpgradeThreshold

otThreadSetSteeringData

void otThreadSetSteeringData(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

Définissez la direction des données de direction hors bande.

L'option de configuration OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE doit être définie pour permettre de définir le sens d'exclusion des données de direction.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aExtAddress`	Adresse utilisée pour mettre à jour les données de direction. Toutes les zéros pour effacer les données de direction (aucune donnée de direction). Les 0xFFs permettent de définir un filtre de données de direction/d'arrêt complet sur tout accepter/autoriser. Un UEI64 spécifique qui est ensuite ajouté au filtre actuel de données/bloques de direction.

otThreadSetThreadVersionCheckEnabled

void otThreadSetThreadVersionCheckEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Cette fonction détermine si le seuil de version TLV de la règle de sécurité pour le routage (champ RV) est activé.

Remarque:Cette API nécessite OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE. Elle n'est utilisée que par Thread Test Harness pour indiquer que la vérification de la version du protocole de thread doit être ignorée.

Détails

Paramètres

`[in] aInstance`	Pointeur vers une instance OpenThread.
`[in] aEnabled`	Prend la valeur TRUE pour activer le seuil de version TLV de la règle de sécurité pour le routage, ou FALSE dans le cas contraire.

Macros

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT.

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Initialisation de otChildIP6Addressitération

Resources

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

Routeur/tête

Résumé

Énumérations

Définitions

Functions

Structures

Énumérations

otCacheEntryState

otNeighborTableEvent

Définitions

otCacheEntryInfo

otCacheEntryiter

otCacheEntryState

otChildIp6Addressitération

otNeighborTableCallback

Functions

otThreaddeLeader

Routeur

otThreadGetChildInfoById

otThreadGetChildInfoByIndex

otThreadGetChildNextIp6Address

otThreadGetContextIdReuseDelay

otThreadGetJoinerUdpPort

otThreadGetLocalLeaderWeight

otThreadGetMaxAllowedChild

otThreadGetMaxChildIpAddresses

otThreadGetMaxRouterId

otThreadGetNetworkIdTimeout

otThreadGetNextCacheEntry

otThreadGetParentPriority

otThreadGetPreferredLeaderPartitionId

OTThreadGetPskc

otThreadGetPskcRef

otThreadGetRouterPasserSeuil

otThreadGetRouterIdRange

otThreadGetRouterIdSéquence

otThreadGetRouterInfo

otThreadGetRouterSelectionJitter

otThreadGetRouterUpgradeThreshold

otThreadIsRouterÉligible

otThreadRegisterNeighborTableCallback

otThreadReleaseRouterId

otThreadSetCcmEnabled

otThreadSetContextIdReuseDelay

otThreadSetJoinerUdpPort

otThreadSetLocalLeaderWeight

otThreadSetMaxAllowedChild

otThreadSetMaxChildIpAddresses

otThreadSetNetworkIdTimeout

otThreadSetParentPriority

otThreadSetPreferredLeaderPartitionId

otThreadSetPreferredRouterId

otThreadSetPskc

otThreadSetPskcRef

otThreadSetRouterDOWNThreshold

otThreadSetRouterÉligible

otThreadSetRouterIdRange

otThreadSetRouterSelectionJitter

otThreadSetRouterUpgradeThreshold

otThreadSetSteeringData

otThreadSetThreadVersionCheckEnabled

Macros

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT.

Resources