Google is committed to advancing racial equity for Black communities. See how.
Cette page a été traduite par l'API Cloud Translation.
Switch to English

Routeur / Leader

Ce module comprend des fonctions pour les routeurs de threads et les leaders.

Résumé

Énumérations

otCacheEntryState énumération
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_ROUTER_ADDED ,
OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED
}
énumération
Cette énumération définit les constantes utilisées dans otNeighborTableCallback pour indiquer si un enfant ou un voisin de routeur est ajouté ou supprimé.

Typedefs

otCacheEntryInfo typedef
Cette structure représente une entrée de cache EID.
otCacheEntryIterator typedef
Ce type représente un itérateur utilisé pour parcourir les entrées de la table de cache EID.
otCacheEntryState typedef
Cette énumération définit l'état d'entrée du cache EID.
otChildIp6AddressIterator typedef
uint16_t
Utilisé pour parcourir les adresses IPv6 d'une entrée Thread Child.
otNeighborTableCallback )(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo) typedef
void(*
Ce pointeur de fonction est appelé pour notifier qu'un voisin enfant ou routeur est ajouté ou supprimé de la table des voisins.

Les fonctions

otThreadBecomeLeader ( otInstance *aInstance)
Devenez un leader et démarrez une nouvelle partition.
otThreadBecomeRouter ( otInstance *aInstance)
Essayez de devenir un routeur.
otThreadGetChildInfoById ( otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
La fonction conserve les informations de diagnostic pour un enfant attaché par son ID enfant ou RLOC16.
otThreadGetChildInfoByIndex ( otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
La fonction conserve les informations de diagnostic pour un enfant attaché par l'index de table interne.
otThreadGetChildNextIp6Address ( otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
Cette fonction obtient la prochaine adresse IPv6 (à 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 Leader.
otThreadGetJoinerUdpPort ( otInstance *aInstance)
uint16_t
Obtenez le port UDP Joiner.
otThreadGetLocalLeaderPartitionId ( otInstance *aInstance)
uint32_t
Obtenez l'ID de partition de chef de file utilisé lorsque vous utilisez le rôle de chef.
otThreadGetLocalLeaderWeight ( otInstance *aInstance)
uint8_t
Obtenez le poids du chef de fil utilisé lorsque vous utilisez le rôle de chef.
otThreadGetMaxAllowedChildren ( otInstance *aInstance)
uint16_t
Obtenez le nombre maximum d'enfants actuellement autorisé.
otThreadGetMaxChildIpAddresses ( otInstance *aInstance)
uint8_t
Cette fonction obtient le nombre maximal d'adresses IP que chaque enfant MTD peut enregistrer avec ce périphérique en tant que parent.
otThreadGetMaxRouterId ( otInstance *aInstance)
uint8_t
La fonction renvoie l'ID de routeur maximum autorisé.
otThreadGetNetworkIdTimeout ( otInstance *aInstance)
uint8_t
Obtenez le paramètre NETWORK_ID_TIMEOUT utilisé dans le rôle de routeur.
otThreadGetNextCacheEntry ( otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
Cette fonction obtient la prochaine entrée de cache EID (à l'aide d'un itérateur).
otThreadGetParentPriority ( otInstance *aInstance)
int8_t
Obtenez la priorité parent assignée.
otThreadGetPskc ( otInstance *aInstance)
const otPskc *
Obtenez le fil PSKc.
otThreadGetRouterDowngradeThreshold ( otInstance *aInstance)
uint8_t
Obtenez le paramètre ROUTER_DOWNGRADE_THRESHOLD utilisé dans le rôle de routeur.
otThreadGetRouterIdSequence ( otInstance *aInstance)
uint8_t
Obtenez la séquence d'ID de routeur actuelle.
otThreadGetRouterInfo ( otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)
La fonction conserve les informations de diagnostic pour un routeur de threads donné.
otThreadGetRouterSelectionJitter ( otInstance *aInstance)
uint8_t
Obtenez le paramètre ROUTER_SELECTION_JITTER utilisé dans le rôle REED / Router.
otThreadGetRouterUpgradeThreshold ( otInstance *aInstance)
uint8_t
Obtenez le paramètre ROUTER_UPGRADE_THRESHOLD utilisé 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 voisine.
otThreadReleaseRouterId ( otInstance *aInstance, uint8_t aRouterId)
Libérez un ID de routeur qui a été alloué par le périphérique dans le rôle Leader.
otThreadSetContextIdReuseDelay ( otInstance *aInstance, uint32_t aDelay)
void
Définissez le paramètre CONTEXT_ID_REUSE_DELAY utilisé dans le rôle Leader.
otThreadSetJoinerUdpPort ( otInstance *aInstance, uint16_t aJoinerUdpPort)
Définissez le port UDP Joiner.
otThreadSetLocalLeaderPartitionId ( otInstance *aInstance, uint32_t aPartitionId)
void
Définissez l'ID de partition de chef de file utilisé lors de l'utilisation du rôle de chef de file.
otThreadSetLocalLeaderWeight ( otInstance *aInstance, uint8_t aWeight)
void
Définissez le poids du chef de fil utilisé lors de l'utilisation du rôle de chef de file.
otThreadSetMaxAllowedChildren ( otInstance *aInstance, uint16_t aMaxChildren)
Définissez le nombre maximum d'enfants actuellement autorisés.
otThreadSetMaxChildIpAddresses ( otInstance *aInstance, uint8_t aMaxIpAddresses)
Cette fonction définit / restaure le nombre maximum d'adresses IP que chaque enfant MTD peut enregistrer avec ce périphérique en tant que parent.
otThreadSetNetworkIdTimeout ( otInstance *aInstance, uint8_t aTimeout)
void
Définissez le paramètre NETWORK_ID_TIMEOUT utilisé dans le rôle Leader.
otThreadSetParentPriority ( otInstance *aInstance, int8_t aParentPriority)
Définissez la priorité du parent.
otThreadSetPreferredRouterId ( otInstance *aInstance, uint8_t aRouterId)
Définissez l'ID de routeur préféré.
otThreadSetPskc ( otInstance *aInstance, const otPskc *aPskc)
Définissez le fil PSKc.
otThreadSetRouterDowngradeThreshold ( otInstance *aInstance, uint8_t aThreshold)
void
Définissez le paramètre ROUTER_DOWNGRADE_THRESHOLD utilisé dans le rôle Leader.
otThreadSetRouterEligible ( otInstance *aInstance, bool aEligible)
Cette fonction définit si l'appareil est éligible ou non au routeur.
otThreadSetRouterSelectionJitter ( otInstance *aInstance, uint8_t aRouterJitter)
void
Définissez le paramètre ROUTER_SELECTION_JITTER utilisé dans le rôle REED / Router.
otThreadSetRouterUpgradeThreshold ( otInstance *aInstance, uint8_t aThreshold)
void
Définissez le paramètre ROUTER_UPGRADE_THRESHOLD utilisé dans le rôle Leader.
otThreadSetSteeringData ( otInstance *aInstance, const otExtAddress *aExtAddress)
void
Définissez les données de direction hors bande.

Structs

otCacheEntryInfo

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

otCacheEntryIterator

Ce type représente un itérateur utilisé pour parcourir les entrées de la table de cache EID.

otChildInfo

Cette structure contient des informations de diagnostic pour un thread enfant.

otNequartTableEntryInfo

Ce type représente une information d'entrée de table voisine (enfant ou routeur) et est utilisé comme paramètre dans le rappel de table voisin otNeighborTableCallback .

Énumérations

otCacheEntryState

 otCacheEntryState

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

otNequartTableEvent

 otNeighborTableEvent

Cette énumération définit les constantes utilisées dans otNeighborTableCallback pour indiquer si un enfant ou un voisin de routeur est ajouté ou supprimé.

Propriétés
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED

Un enfant est ajouté.

OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED

Un enfant est enlevé.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED

Un routeur est ajouté.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED

Un routeur est en cours de suppression.

Typedefs

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

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

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

Ce type représente un itérateur utilisé pour parcourir 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 ses champs dans la structure sur zéro (par exemple, memset l'itérateur sur zéro).

otCacheEntryState

enum otCacheEntryState otCacheEntryState

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

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

Utilisé pour parcourir les adresses IPv6 d'une entrée Thread Child.

otNequartTableCallback

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

Ce pointeur de fonction est appelé pour notifier qu'un voisin enfant ou routeur est ajouté ou supprimé de la table des voisins.

Détails
Paramètres
[in] aEvent
Un drapeau d'événement.
[in] aEntryInfo
Un pointeur vers les informations d'entrée de table.

Les fonctions

otThreadDevenirLeader

 otError otThreadBecomeLeader(
  otInstance *aInstance
)

Devenez un leader et démarrez une nouvelle partition.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
Valeurs de retour
OT_ERROR_NONE
Est devenu avec succès un leader et a commencé une nouvelle partition.
OT_ERROR_INVALID_STATE
Le fil est désactivé.

otThreadBecomeRouter

 otError otThreadBecomeRouter(
  otInstance *aInstance
)

Essayez de devenir un routeur.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
Valeurs de retour
OT_ERROR_NONE
Commencez avec succès la tentative de devenir un routeur.
OT_ERROR_INVALID_STATE
Le fil est désactivé.

otThreadGetChildInfoById

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

La fonction conserve les informations de diagnostic pour un enfant attaché par son ID enfant ou RLOC16.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aChildId
L'ID enfant ou RLOC16 pour l'enfant attaché.
[out] aChildInfo
Un pointeur vers l'emplacement des informations sur l'enfant.
Valeurs de retour
OT_ERROR_NONE
aChildInfo été mis à jour avec succès avec les informations pour l'ID donné.
OT_ERROR_NOT_FOUND
Aucun enfant valide avec cette carte d'identité d'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 pour un enfant attaché par l'index de table interne.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aChildIndex
L'index de la table.
[out] aChildInfo
Un pointeur vers l'emplacement des informations sur l'enfant.
Valeurs de retour
OT_ERROR_NONE
aChildInfo été mis à jour avec succès avec les informations de l'index donné.
OT_ERROR_NOT_FOUND
Aucun enfant valide à cet index.
OT_ERROR_INVALID_ARGS
Soit aChildInfo est NULL, soit aChildIndex est hors de portée (supérieur à l'index de table max).
Voir également:
otGetMaxAllowedEnfants

otThreadGetChildNextIp6Address

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

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

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aChildIndex
L'index enfant.
[in,out] aIterator
Un pointeur vers l'itérateur. En cas de succès, l'itérateur sera 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
Un pointeur vers une adresse IPv6 où la prochaine adresse de l'enfant est placée (en cas de succès).
Valeurs de retour
OT_ERROR_NONE
La prochaine adresse IPv6 a été aAddress avec succès (une adresse a été mise à jour avec succès).
OT_ERROR_NOT_FOUND
L'enfant n'a aucune entrée d'adresse IPv6 ultérieure.
OT_ERROR_INVALID_ARGS
aIterator ou aAddress sont NULL, ou child at aChildIndex n'est pas valide.
Voir également:
otThreadGetChildInfoByIndex

otThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

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

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
Retour
La valeur CONTEXT_ID_REUSE_DELAY.
Voir également:
otThreadSetContextIdReuseDelay

otThreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Obtenez le port UDP Joiner.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
Retour
Numéro de port UDP Joiner.
Voir également:
otThreadSetJoinerUdpPort

otThreadGetLocalLeaderPartitionId

uint32_t otThreadGetLocalLeaderPartitionId(
  otInstance *aInstance
)

Obtenez l'ID de partition de chef de file utilisé lorsque vous utilisez le rôle de chef.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
Retour
La valeur de l'ID de partition du chef de file.

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

Obtenez le poids du chef de fil utilisé lorsque vous utilisez le rôle de chef.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
Retour
La valeur du poids du fil leader.
Voir également:
otThreadSetLeaderWeight

otThreadGetMaxAllowedEnfants

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

Obtenez le nombre maximum d'enfants actuellement autorisé.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
Retour
Le nombre maximum d'enfants actuellement autorisé.
Voir également:
otThreadSetMaxAllowedChildren

otThreadGetMaxChildIpAddresses

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

Cette fonction obtient le nombre maximal d'adresses IP que chaque enfant MTD peut enregistrer avec ce périphérique en tant que parent.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
Retour
Le nombre maximal d'adresses IP que chaque enfant MTD peut enregistrer avec ce périphérique en tant que parent.
Voir également:
otThreadSetMaxChildIpAddresses

otThreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

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

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
Retour
ID de routeur maximum autorisé.

otThreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

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

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
Retour
La valeur NETWORK_ID_TIMEOUT.
Voir également:
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
Un pointeur vers une instance d'OpenThread.
[out] aEntryInfo
Un pointeur vers l'emplacement des informations d'entrée du cache EID.
[in,out] aIterator
Un pointeur vers un itérateur. Il sera mis à jour pour pointer vers la prochaine entrée en cas de succès. Pour obtenir la première entrée, initialisez l'itérateur en mettant tous ses champs à zéro (par exemple, memset la structure de l'itérateur à zéro).
Valeurs de retour
OT_ERROR_NONE
aEntryInfo avec aEntryInfo pour la prochaine entrée de cache EID.
OT_ERROR_NOT_FOUND
Plus d'entrées dans la table de cache d'adresses.

otThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

Obtenez la priorité parent assignée.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
Retour
La valeur de priorité parent assignée, -2 signifie non assignée.
Voir également:
otThreadSetParentPriority

otThreadGetPskc

const otPskc * otThreadGetPskc(
  otInstance *aInstance
)

Obtenez le fil PSKc.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
Retour
Un pointeur vers Thread PSKc
Voir également:
otThreadSetPskc

otThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

Obtenez le paramètre ROUTER_DOWNGRADE_THRESHOLD utilisé dans le rôle de routeur.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
Retour
La valeur ROUTER_DOWNGRADE_THRESHOLD.
Voir également:
otThreadSetRouterDowngradeThreshold

otThreadGetRouterIdSequence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

Obtenez la séquence d'ID de routeur actuelle.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
Retour
La séquence d'ID de routeur.

otThreadGetRouterInfo

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

La fonction conserve les informations de diagnostic pour un routeur de threads donné.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aRouterId
L'ID de routeur ou RLOC16 pour un routeur donné.
[out] aRouterInfo
Un pointeur vers l'emplacement des informations du routeur.
Valeurs de retour
OT_ERROR_NONE
Récupération réussie des informations du routeur pour l'ID donné.
OT_ERROR_NOT_FOUND
Aucune entrée de routeur avec l'ID donné.
OT_ERROR_INVALID_ARGS
aRouterInfo est NULL.

otThreadGetRouterSelectionJitter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

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

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
Retour
La valeur ROUTER_SELECTION_JITTER.
Voir également:
otThreadSetRouterSelectionJitter

otThreadGetRouterUpgradeThreshold

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

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

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
Retour
La valeur ROUTER_UPGRADE_THRESHOLD.
Voir également:
otThreadSetRouterUpgradeThreshold

otThreadIsRouterEligible

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

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

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
Valeurs de retour
TRUE
Si l'appareil est compatible avec le routeur.
FALSE
Si l'appareil n'est pas compatible avec le routeur.

otThreadRegisterNequartTableRappel

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

Cette fonction enregistre une fonction de rappel de table voisine.

Le rappel fourni (s'il n'est pas NULL) sera invoqué lorsqu'une entrée voisine enfant ou de routeur est ajoutée / supprimée à / de la table voisine. Les appels suivants à cette méthode écraseront le rappel précédent. Notez que ce rappel est appelé pendant la mise à jour de la table voisine / enfant et toujours avant le otStateChangedCallback .

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aCallback
Un pointeur vers la fonction de gestionnaire de rappel.

otThreadReleaseRouterId

 otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Libérez un ID de routeur qui a été alloué par le périphérique dans le rôle Leader.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aRouterId
L'ID du routeur à libérer. La plage valide est [0, 62].
Valeurs de retour
OT_ERROR_NONE
Libération réussie de l'ID du routeur.
OT_ERROR_INVALID_ARGS
aRouterId n'est pas dans la plage [0, 62].
OT_ERROR_INVALID_STATE
L'appareil ne fonctionne pas actuellement en tant que leader.
OT_ERROR_NOT_FOUND
L'ID du routeur n'est actuellement pas alloué.

otThreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

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

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aDelay
La valeur CONTEXT_ID_REUSE_DELAY.
Voir également:
otThreadGetContextIdReuseDelay

otThreadSetJoinerUdpPort

 otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

Définissez le port UDP Joiner.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aJoinerUdpPort
Numéro de port UDP Joiner.
Valeurs de retour
OT_ERROR_NONE
Définissez avec succès le port UDP Joiner.
Voir également:
otThreadGetJoinerUdpPort

otThreadSetLocalLeaderPartitionId

void otThreadSetLocalLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

Définissez l'ID de partition de leader de thread utilisé lors de l'utilisation du rôle de leader.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aPartitionId
La valeur de l'ID de partition du chef de file.

otThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

Définissez le poids du chef de fil utilisé lors de l'utilisation du rôle de chef de file.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aWeight
La valeur du poids du fil leader.
Voir également:
otThreadGetLeaderWeight

otThreadSetMaxAllowedChildren

 otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

Définissez le nombre maximum d'enfants actuellement autorisés.

Ce paramètre ne peut être défini que lorsque le fonctionnement du protocole Thread a été arrêté.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aMaxChildren
Le maximum d'enfants autorisés.
Valeurs de retour
OT_ERROR_NONE
Réglez avec succès le max.
OT_ERROR_INVALID_ARGS
Si aMaxChildren n'est pas dans la plage [1, OPENTHREAD_CONFIG_MLE_MAX_CHILDREN].
OT_ERROR_INVALID_STATE
Si Thread n'est pas arrêté.
Voir également:
otThreadGetMaxAllowedEnfants

otThreadSetMaxChildIpAddresses

 otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

Cette fonction définit / restaure le nombre maximum d'adresses IP que chaque enfant MTD peut enregistrer avec ce périphérique en tant que parent.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aMaxIpAddresses
Le nombre maximal d'adresses IP que chaque enfant MTD peut enregistrer avec ce périphérique en tant que parent. 0 pour effacer le paramètre et restaurer la valeur par défaut.
Valeurs de retour
OT_ERROR_NONE
Définir / effacer le numéro avec succès.
OT_ERROR_INVALID_ARGS
Si dépasse le nombre maximum autorisé.
Voir également:
otThreadGetMaxChildIpAddresses

otThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

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

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aTimeout
La valeur NETWORK_ID_TIMEOUT.
Voir également:
otThreadGetNetworkIdTimeout

otThreadSetParentPriority

 otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

Définissez la priorité du parent.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aParentPriority
La valeur de priorité du parent.
Valeurs de retour
OT_ERROR_NONE
Définissez avec succès la priorité du parent.
OT_ERROR_INVALID_ARGS
Si la valeur de priorité parent n'est pas comprise entre 1, 0, -1 et -2.
Voir également:
otThreadGetParentPriority

otThreadSetPreferredRouterId

 otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Définissez l'ID de routeur préféré.

En devenant un routeur / leader, le nœud tente d'utiliser cet ID de routeur. 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é aléatoirement est choisi. Cette propriété ne peut être définie que lorsque le rôle de périphérique est détaché ou désactivé.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aRouterId
L'ID de routeur préféré.
Valeurs de retour
OT_ERROR_NONE
Définissez avec succès l'ID de routeur préféré.
OT_ERROR_INVALID_STATE
Impossible de définir (le rôle n'est pas détaché ou désactivé)

otThreadSetPskc

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

Définissez le fil PSKc.

Cette fonction ne réussira que lorsque les protocoles Thread sont désactivés. Un appel réussi à cette fonction invalidera également les ensembles de données opérationnels actifs et en attente dans la mémoire non volatile.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aPskc
Un pointeur vers le nouveau Thread PSKc.
Valeurs de retour
OT_ERROR_NONE
Définissez avec succès le fil PSKc.
OT_ERROR_INVALID_STATE
Les protocoles de thread sont activés.
Voir également:
otThreadGetPskc

otThreadSetRouterDowngradeThreshold

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

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

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aThreshold
La valeur ROUTER_DOWNGRADE_THRESHOLD.
Voir également:
otThreadGetRouterDowngradeThreshold

otThreadSetRouterEligible

 otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

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

Si aEligible est false et que l'appareil fonctionne actuellement en tant que routeur, cet appel provoquera le détachement de l'appareil et une tentative de se reconnecter en tant qu'enfant.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aEligible
TRUE pour configurer l'appareil comme étant compatible avec le routeur, FALSE dans le cas contraire.
Valeurs de retour
OT_ERROR_NONE
Définissez avec succès la configuration éligible au routeur.
OT_ERROR_NOT_CAPABLE
L'appareil n'est pas capable de devenir un routeur.

otThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

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

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aRouterJitter
La valeur ROUTER_SELECTION_JITTER.
Voir également:
otThreadGetRouterSelectionJitter

otThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

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

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aThreshold
La valeur ROUTER_UPGRADE_THRESHOLD.
Voir également:
otThreadGetRouterUpgradeThreshold

otThreadSetSteeringData

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

Définissez les données de direction hors bande.

L'option de configuration OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE doit être définie pour activer la configuration des données de direction hors bande.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aExtAddress
Adresse utilisée pour mettre à jour les données de pilotage. Tous les zéros pour effacer les données de direction (pas de données de direction). Tous les 0xFF pour définir les données de direction / filtre de floraison pour accepter / tout autoriser. Un EUI64 spécifique qui est ensuite ajouté aux données de direction actuelles / filtre de floraison.

Macros

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Initialiseur pour otChildIP6AddressIterator.