Google is committed to advancing racial equity for Black communities. See how.
Se usó la API de Cloud Translation para traducir esta página.
Switch to English

Enrutador / Líder

Este módulo incluye funciones para Thread Routers y Leaders.

Resumen

Enumeraciones

otCacheEntryState enumeración
Esta enumeración define el estado de entrada del caché 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
}
enumeración
Esta enumeración define las constantes utilizadas en otNeighborTableCallback para indicar si se está agregando o otNeighborTableCallback un hijo o vecino del enrutador.

Typedefs

otCacheEntryInfo typedef
Esta estructura representa una entrada de caché EID.
otCacheEntryIterator typedef
Este tipo representa un iterador utilizado para iterar a través de las entradas de la tabla de caché EID.
otCacheEntryState typedef
Esta enumeración define el estado de entrada del caché EID.
otChildIp6AddressIterator typedef
uint16_t
Se utiliza para iterar a través de las direcciones IPv6 de una entrada Thread Child.
otNeighborTableCallback )(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo) typedef
void(*
Este puntero de función se llama para notificar que se está agregando o quitando un vecino secundario o enrutador de la tabla vecina.

Las funciones

otThreadBecomeLeader ( otInstance *aInstance)
Conviértete en un líder y comienza una nueva partición.
otThreadBecomeRouter ( otInstance *aInstance)
Intenta convertirte en un enrutador.
otThreadGetChildInfoById ( otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
La función retiene información de diagnóstico para un niño adjunto por su ID de niño o RLOC16.
otThreadGetChildInfoByIndex ( otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
La función retiene información de diagnóstico para un hijo adjunto por el índice de la tabla interna.
otThreadGetChildNextIp6Address ( otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
Esta función obtiene la siguiente dirección IPv6 (usando un iterador) para un niño dado.
otThreadGetContextIdReuseDelay ( otInstance *aInstance)
uint32_t
Obtenga el parámetro CONTEXT_ID_REUSE_DELAY utilizado en el rol Líder.
otThreadGetJoinerUdpPort ( otInstance *aInstance)
uint16_t
Obtenga el puerto UDP de Joiner.
otThreadGetLocalLeaderPartitionId ( otInstance *aInstance)
uint32_t
Obtenga el Id. De partición de líder de subprocesos que se utiliza al operar en el rol de líder.
otThreadGetLocalLeaderWeight ( otInstance *aInstance)
uint8_t
Obtenga el peso de líder de subproceso utilizado cuando se opera en el rol de líder.
otThreadGetMaxAllowedChildren ( otInstance *aInstance)
uint16_t
Obtenga el número máximo de niños actualmente permitido.
otThreadGetMaxChildIpAddresses ( otInstance *aInstance)
uint8_t
Esta función obtiene el número máximo de direcciones IP que cada niño MTD puede registrar con este dispositivo como padre.
otThreadGetMaxRouterId ( otInstance *aInstance)
uint8_t
La función devuelve la ID de enrutador máxima permitida.
otThreadGetNetworkIdTimeout ( otInstance *aInstance)
uint8_t
Obtenga el parámetro NETWORK_ID_TIMEOUT utilizado en la función de enrutador.
otThreadGetNextCacheEntry ( otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
Esta función obtiene la siguiente entrada de caché EID (usando un iterador).
otThreadGetParentPriority ( otInstance *aInstance)
int8_t
Obtenga la prioridad principal asignada.
otThreadGetPskc ( otInstance *aInstance)
const otPskc *
Obtenga el hilo PSKc.
otThreadGetRouterDowngradeThreshold ( otInstance *aInstance)
uint8_t
Obtenga el parámetro ROUTER_DOWNGRADE_THRESHOLD utilizado en la función de enrutador.
otThreadGetRouterIdSequence ( otInstance *aInstance)
uint8_t
Obtenga la secuencia de identificación de enrutador actual.
otThreadGetRouterInfo ( otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)
La función retiene información de diagnóstico para un determinado Thread Router.
otThreadGetRouterSelectionJitter ( otInstance *aInstance)
uint8_t
Obtenga el parámetro ROUTER_SELECTION_JITTER utilizado en el rol REED / Router.
otThreadGetRouterUpgradeThreshold ( otInstance *aInstance)
uint8_t
Obtenga el parámetro ROUTER_UPGRADE_THRESHOLD utilizado en el rol REED.
otThreadIsRouterEligible ( otInstance *aInstance)
bool
Este método indica si el dispositivo es o no elegible para el enrutador.
otThreadRegisterNeighborTableCallback ( otInstance *aInstance, otNeighborTableCallback aCallback)
void
Esta función registra una función de devolución de llamada de tabla vecina.
otThreadReleaseRouterId ( otInstance *aInstance, uint8_t aRouterId)
Libere una ID de enrutador que el dispositivo haya asignado en la función Líder.
otThreadSetContextIdReuseDelay ( otInstance *aInstance, uint32_t aDelay)
void
Establezca el parámetro CONTEXT_ID_REUSE_DELAY utilizado en el rol Líder.
otThreadSetJoinerUdpPort ( otInstance *aInstance, uint16_t aJoinerUdpPort)
Configure el puerto UDP de Joiner.
otThreadSetLocalLeaderPartitionId ( otInstance *aInstance, uint32_t aPartitionId)
void
Establezca el Id. De partición de Líder de subprocesos utilizado cuando se opera en el rol de Líder
otThreadSetLocalLeaderWeight ( otInstance *aInstance, uint8_t aWeight)
void
Establezca el peso del líder de subproceso utilizado cuando se opera en el rol de líder.
otThreadSetMaxAllowedChildren ( otInstance *aInstance, uint16_t aMaxChildren)
Establezca el número máximo de niños permitidos actualmente.
otThreadSetMaxChildIpAddresses ( otInstance *aInstance, uint8_t aMaxIpAddresses)
Esta función establece / restaura el número máximo de direcciones IP que cada niño MTD puede registrar con este dispositivo como padre.
otThreadSetNetworkIdTimeout ( otInstance *aInstance, uint8_t aTimeout)
void
Establezca el parámetro NETWORK_ID_TIMEOUT utilizado en la función Líder.
otThreadSetParentPriority ( otInstance *aInstance, int8_t aParentPriority)
Establecer la prioridad principal.
otThreadSetPreferredRouterId ( otInstance *aInstance, uint8_t aRouterId)
Establezca el Id. De enrutador preferido.
otThreadSetPskc ( otInstance *aInstance, const otPskc *aPskc)
Establecer el hilo PSKc.
otThreadSetRouterDowngradeThreshold ( otInstance *aInstance, uint8_t aThreshold)
void
Establezca el parámetro ROUTER_DOWNGRADE_THRESHOLD utilizado en la función Líder.
otThreadSetRouterEligible ( otInstance *aInstance, bool aEligible)
Esta función establece si el dispositivo es o no elegible para el enrutador.
otThreadSetRouterSelectionJitter ( otInstance *aInstance, uint8_t aRouterJitter)
void
Establezca el parámetro ROUTER_SELECTION_JITTER utilizado en la función REED / Router.
otThreadSetRouterUpgradeThreshold ( otInstance *aInstance, uint8_t aThreshold)
void
Establezca el parámetro ROUTER_UPGRADE_THRESHOLD utilizado en la función Líder.
otThreadSetSteeringData ( otInstance *aInstance, const otExtAddress *aExtAddress)
void
Establecer datos de dirección fuera de banda.

Estructuras

otCacheEntryInfo

Esta estructura representa una entrada de caché EID.

otCacheEntryIterator

Este tipo representa un iterador utilizado para iterar a través de las entradas de la tabla de caché EID.

otChildInfo

Esta estructura contiene información de diagnóstico para un subproceso secundario.

otNeighborTableEntryInfo

Este tipo representa una información de entrada de la tabla vecina (secundaria o enrutador) y se utiliza como un parámetro en la devolución de llamada de la tabla vecina otNeighborTableCallback .

Enumeraciones

otCacheEntryState

 otCacheEntryState

Esta enumeración define el estado de entrada del caché EID.

otNeighborTableEvent

 otNeighborTableEvent

Esta enumeración define las constantes utilizadas en otNeighborTableCallback para indicar si se está agregando o otNeighborTableCallback un hijo o vecino del enrutador.

Propiedades
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED

Se está agregando un niño.

OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED

Un niño está siendo removido.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED

Se está agregando un enrutador.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED

Se está quitando un enrutador.

Typedefs

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

Esta estructura representa una entrada de caché EID.

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

Este tipo representa un iterador utilizado para iterar a través de las entradas de la tabla de caché EID.

Para inicializar el iterador y comenzar desde la primera entrada en la tabla de caché, configure todos sus campos en la estructura a cero (por ejemplo, memset el iterador a cero).

otCacheEntryState

enum otCacheEntryState otCacheEntryState

Esta enumeración define el estado de entrada del caché EID.

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

Se utiliza para iterar a través de las direcciones IPv6 de una entrada Thread Child.

otNeighborTableCallback

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

Se llama a este puntero de función para notificar que se está agregando o quitando un vecino secundario o enrutador de la tabla vecina.

Detalles
Parámetros
[in] aEvent
Una bandera de evento.
[in] aEntryInfo
Un puntero a la información de entrada de la tabla.

Las funciones

otThreadBecomeLeader

 otError otThreadBecomeLeader(
  otInstance *aInstance
)

Conviértete en un líder y comienza una nueva partición.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Valores de retorno
OT_ERROR_NONE
Con éxito se convirtió en un líder y comenzó una nueva partición.
OT_ERROR_INVALID_STATE
El hilo está deshabilitado.

otThreadBecomeRouter

 otError otThreadBecomeRouter(
  otInstance *aInstance
)

Intenta convertirte en un enrutador.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Valores de retorno
OT_ERROR_NONE
Comience con éxito el intento de convertirse en un enrutador.
OT_ERROR_INVALID_STATE
El hilo está deshabilitado.

otThreadGetChildInfoById

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

La función retiene información de diagnóstico para un niño adjunto por su ID de niño o RLOC16.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aChildId
El ID de niño o RLOC16 para el niño adjunto.
[out] aChildInfo
Un puntero a donde se coloca la información del niño.
Valores de retorno
OT_ERROR_NONE
aChildInfo se actualizó con éxito con la información de la ID dada.
OT_ERROR_NOT_FOUND
Ningún niño válido con esta identificación de niño.
OT_ERROR_INVALID_ARGS
Si aChildInfo es NULL.

otThreadGetChildInfoByIndex

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

La función retiene información de diagnóstico para un hijo adjunto por el índice de la tabla interna.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aChildIndex
El índice de la tabla.
[out] aChildInfo
Un puntero a donde se coloca la información del niño.
Valores de retorno
OT_ERROR_NONE
aChildInfo se actualizó con éxito con la información para el índice dado.
OT_ERROR_NOT_FOUND
No hay hijos válidos en este índice.
OT_ERROR_INVALID_ARGS
O aChildInfo es NULL o aChildIndex está fuera de rango (más alto que el índice de tabla máximo).
Ver también:
otGetMaxAllowedChildren

otThreadGetChildNextIp6Address

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

Esta función obtiene la siguiente dirección IPv6 (usando un iterador) para un hijo determinado.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aChildIndex
El índice hijo.
[in,out] aIterator
Un puntero al iterador. En caso de éxito, el iterador se actualizará para señalar la siguiente entrada de la lista. Para obtener la primera dirección IPv6, el iterador debe establecerse en OT_CHILD_IP6_ADDRESS_ITERATOR_INIT.
[out] aAddress
Un puntero a una dirección IPv6 donde se coloca la siguiente dirección del niño (en caso de éxito).
Valores de retorno
OT_ERROR_NONE
Se encontró con éxito la siguiente dirección IPv6 ( aAddress se actualizó correctamente).
OT_ERROR_NOT_FOUND
El niño no tiene entrada de dirección IPv6 posterior.
OT_ERROR_INVALID_ARGS
aIterator o aAddress son NULL, o child en aChildIndex no es válido.
Ver también:
otThreadGetChildInfoByIndex

otThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

Obtenga el parámetro CONTEXT_ID_REUSE_DELAY utilizado en el rol Líder.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El valor CONTEXT_ID_REUSE_DELAY.
Ver también:
otThreadSetContextIdReuseDelay

otThreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Obtenga el puerto Joiner UDP.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El número de puerto UDP de Joiner.
Ver también:
otThreadSetJoinerUdpPort

otThreadGetLocalLeaderPartitionId

uint32_t otThreadGetLocalLeaderPartitionId(
  otInstance *aInstance
)

Obtenga el Id. De partición de líder de subprocesos que se utiliza al operar en el rol de líder.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El valor de Id de partición del líder de subprocesos.

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

Obtenga el peso de líder de subproceso utilizado cuando se opera en el rol de líder.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El valor del peso del líder del hilo.
Ver también:
otThreadSetLeaderWeight

otThreadGetMaxAllowedChildren

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

Obtenga el número máximo de niños actualmente permitido.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El número máximo de niños actualmente permitido.
Ver también:
otThreadSetMaxAllowedChildren

otThreadGetMaxChildIpAddresses

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

Esta función obtiene el número máximo de direcciones IP que cada niño MTD puede registrar con este dispositivo como padre.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El número máximo de direcciones IP que cada niño MTD puede registrar con este dispositivo como padre.
Ver también:
otThreadSetMaxChildIpAddresses

otThreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

La función devuelve la ID de enrutador máxima permitida.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El ID de enrutador máximo permitido.

otThreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

Obtenga el parámetro NETWORK_ID_TIMEOUT utilizado en la función de enrutador.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El valor NETWORK_ID_TIMEOUT.
Ver también:
otThreadSetNetworkIdTimeout

otThreadGetNextCacheEntry

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

Esta función obtiene la siguiente entrada de caché EID (usando un iterador).

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[out] aEntryInfo
Un puntero a donde se coloca la información de entrada de caché EID.
[in,out] aIterator
Un puntero a un iterador. Se actualizará para apuntar a la siguiente entrada en caso de éxito Para obtener la primera entrada, inicialice el iterador estableciendo todos sus campos en cero (por ejemplo, memset la estructura del iterador en cero).
Valores de retorno
OT_ERROR_NONE
aEntryInfo con éxito aEntryInfo para la siguiente entrada de caché EID.
OT_ERROR_NOT_FOUND
No más entradas en la tabla de caché de direcciones.

otThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

Obtenga la prioridad principal asignada.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El valor de prioridad principal asignado, -2 significa no asignado.
Ver también:
otThreadSetParentPriority

otThreadGetPskc

const otPskc * otThreadGetPskc(
  otInstance *aInstance
)

Obtenga el hilo PSKc.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
Un puntero al hilo PSKc
Ver también:
otThreadSetPskc

otThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

Obtenga el parámetro ROUTER_DOWNGRADE_THRESHOLD utilizado en la función de enrutador.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El valor ROUTER_DOWNGRADE_THRESHOLD.
Ver también:
otThreadSetRouterDowngradeThreshold

otThreadGetRouterIdSequence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

Obtenga la secuencia de identificación de enrutador actual.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
La secuencia de identificación del enrutador.

otThreadGetRouterInfo

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

La función retiene información de diagnóstico para un determinado Thread Router.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aRouterId
La ID del enrutador o RLOC16 para un enrutador determinado.
[out] aRouterInfo
Un puntero a donde se coloca la información del enrutador.
Valores de retorno
OT_ERROR_NONE
Recuperó correctamente la información del enrutador para la identificación dada
OT_ERROR_NOT_FOUND
No hay entrada de enrutador con la identificación dada.
OT_ERROR_INVALID_ARGS
aRouterInfo es NULL.

otThreadGetRouterSelectionJitter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

Obtenga el parámetro ROUTER_SELECTION_JITTER utilizado en la función REED / Router.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El valor ROUTER_SELECTION_JITTER.
Ver también:
otThreadSetRouterSelectionJitter

otThreadGetRouterUpgradeThreshold

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

Obtenga el parámetro ROUTER_UPGRADE_THRESHOLD utilizado en el rol REED.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El valor ROUTER_UPGRADE_THRESHOLD.
Ver también:
otThreadSetRouterUpgradeThreshold

otThreadIsRouterEligible

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

Este método indica si el dispositivo es o no elegible para el enrutador.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Valores de retorno
TRUE
Si el dispositivo es elegible para enrutador.
FALSE
Si el dispositivo no es elegible para el enrutador.

otThreadRegisterNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

Esta función registra una función de devolución de llamada de tabla vecina.

La devolución de llamada proporcionada (si no es NULL) se invocará cuando se agregue / elimine una entrada vecina secundaria o enrutadora a / de la tabla vecina. Las llamadas posteriores a este método sobrescribirán la devolución de llamada anterior. Tenga en cuenta que esta devolución de llamada se invoca mientras se actualiza la tabla vecina / secundaria y siempre antes de otStateChangedCallback .

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aCallback
Un puntero a la función de controlador de devolución de llamada.

otThreadReleaseRouterId

 otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Libere una ID de enrutador que haya sido asignada por el dispositivo en la función Líder.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aRouterId
La ID del enrutador para liberar. El rango válido es [0, 62].
Valores de retorno
OT_ERROR_NONE
Lanzó con éxito la identificación del enrutador.
OT_ERROR_INVALID_ARGS
aRouterId no está en el rango [0, 62].
OT_ERROR_INVALID_STATE
El dispositivo no está funcionando actualmente como líder.
OT_ERROR_NOT_FOUND
La identificación del enrutador no está asignada actualmente.

otThreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

Establezca el parámetro CONTEXT_ID_REUSE_DELAY utilizado en el rol Líder.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aDelay
El valor CONTEXT_ID_REUSE_DELAY.
Ver también:
otThreadGetContextIdReuseDelay

otThreadSetJoinerUdpPort

 otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

Configure el puerto UDP de Joiner.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aJoinerUdpPort
El número de puerto UDP de Joiner.
Valores de retorno
OT_ERROR_NONE
Configure con éxito el puerto UDP de Joiner.
Ver también:
otThreadGetJoinerUdpPort

otThreadSetLocalLeaderPartitionId

void otThreadSetLocalLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

Establezca el Id. De partición de Líder de subprocesos utilizado cuando se opera en el rol de Líder

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aPartitionId
El valor de Id de partición del líder de subprocesos.

otThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

Establezca el peso del líder de subproceso utilizado cuando se opera en el rol de líder.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aWeight
El valor del peso del líder del hilo.
Ver también:
otThreadGetLeaderWeight

otThreadSetMaxAllowedChildren

 otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

Establezca el número máximo de niños permitidos actualmente.

Este parámetro solo se puede configurar cuando se ha detenido la operación del protocolo de subprocesos.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aMaxChildren
El máximo permitido de niños.
Valores de retorno
OT_ERROR_NONE
Establecer con éxito el máximo.
OT_ERROR_INVALID_ARGS
Si aMaxChildren no está en el rango [1, OPENTHREAD_CONFIG_MLE_MAX_CHILDREN].
OT_ERROR_INVALID_STATE
Si el hilo no se detiene.
Ver también:
otThreadGetMaxAllowedChildren

otThreadSetMaxChildIpAddresses

 otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

Esta función establece / restaura el número máximo de direcciones IP que cada niño MTD puede registrar con este dispositivo como padre.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aMaxIpAddresses
El número máximo de direcciones IP que cada niño MTD puede registrar con este dispositivo como padre. 0 para borrar la configuración y restaurar el valor predeterminado.
Valores de retorno
OT_ERROR_NONE
Estableció / borró con éxito el número.
OT_ERROR_INVALID_ARGS
Si excede el número máximo permitido.
Ver también:
otThreadGetMaxChildIpAddresses

otThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

Establezca el parámetro NETWORK_ID_TIMEOUT utilizado en la función Líder.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aTimeout
El valor NETWORK_ID_TIMEOUT.
Ver también:
otThreadGetNetworkIdTimeout

otThreadSetParentPriority

 otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

Establecer la prioridad principal.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aParentPriority
El valor de prioridad principal.
Valores de retorno
OT_ERROR_NONE
Establecer correctamente la prioridad principal.
OT_ERROR_INVALID_ARGS
Si el valor de prioridad principal no está entre 1, 0, -1 y -2.
Ver también:
otThreadGetParentPriority

otThreadSetPreferredRouterId

 otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Establezca el Id. De enrutador preferido.

Al convertirse en un enrutador / líder, el nodo intenta usar este ID de enrutador. Si el Id. De enrutador preferido no está configurado o si no se puede utilizar, se elige un id. De enrutador generado aleatoriamente. Esta propiedad solo se puede establecer cuando la función del dispositivo está separada o deshabilitada.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aRouterId
El ID de enrutador preferido.
Valores de retorno
OT_ERROR_NONE
Establezca correctamente el Id. De enrutador preferido.
OT_ERROR_INVALID_STATE
No se pudo establecer (el rol no está separado o deshabilitado)

otThreadSetPskc

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

Establecer el hilo PSKc.

Esta función solo tendrá éxito cuando los protocolos de subprocesos estén deshabilitados. Una llamada exitosa a esta función también invalidará los conjuntos de datos operativos activos y pendientes en la memoria no volátil.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aPskc
Un puntero al nuevo hilo PSKc.
Valores de retorno
OT_ERROR_NONE
Establecer correctamente el hilo PSKc.
OT_ERROR_INVALID_STATE
Los protocolos de subprocesos están habilitados.
Ver también:
otThreadGetPskc

otThreadSetRouterDowngradeThreshold

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Establezca el parámetro ROUTER_DOWNGRADE_THRESHOLD utilizado en la función Líder.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aThreshold
El valor ROUTER_DOWNGRADE_THRESHOLD.
Ver también:
otThreadGetRouterDowngradeThreshold

otThreadSetRouterEligible

 otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

Esta función establece si el dispositivo es o no elegible para el enrutador.

Si aEligible es falso y el dispositivo está funcionando actualmente como un enrutador, esta llamada hará que el dispositivo se desconecte e intente volver a conectarlo como un niño.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aEligible
VERDADERO para configurar el dispositivo como elegible para enrutador, FALSO de lo contrario.
Valores de retorno
OT_ERROR_NONE
Establezca con éxito la configuración elegible para el enrutador.
OT_ERROR_NOT_CAPABLE
El dispositivo no es capaz de convertirse en un enrutador.

otThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

Establezca el parámetro ROUTER_SELECTION_JITTER utilizado en la función REED / Router.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aRouterJitter
El valor ROUTER_SELECTION_JITTER.
Ver también:
otThreadGetRouterSelectionJitter

otThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Establezca el parámetro ROUTER_UPGRADE_THRESHOLD utilizado en la función Líder.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aThreshold
El valor ROUTER_UPGRADE_THRESHOLD.
Ver también:
otThreadGetRouterUpgradeThreshold

otThreadSetSteeringData

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

Establecer los datos de dirección fuera de banda.

La opción de configuración OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE debe establecerse para permitir la configuración de los datos de dirección fuera de banda.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aExtAddress
Dirección utilizada para actualizar los datos de dirección. Todos los ceros para borrar los datos de dirección (sin datos de dirección). Todos los 0xFF para configurar los datos de dirección / filtro de floración para aceptar / permitir todo. Un EUI64 específico que luego se agrega a los datos actuales de dirección / filtro de floración.

Macros

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Inicializador para otChildIP6AddressIterator.