Gerente de Canal

Este módulo incluye funciones para Channel Manager.

Resumen

Las funciones de este módulo están disponibles cuando la función Channel Manager ( OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE ) está habilitada. Channel Manager está disponible solo en una compilación FTD.

Funciones
`otChannelManagerGetAutoChannelSelectionEnabled ( otInstance *aInstance)`	`bool` Esta función indica si la función de selección automática de canales está habilitada o no.
`otChannelManagerGetAutoChannelSelectionInterval ( otInstance *aInstance)`	`uint32_t` Esta función obtiene el intervalo de período (en segundos) utilizado por la función de selección automática de canales.
`otChannelManagerGetCcaFailureRateThreshold ( otInstance *aInstance)`	`uint16_t` Esta función obtiene el umbral de tasa de falla de CCA.
`otChannelManagerGetDelay ( otInstance *aInstance)`	`uint16_t` Esta función obtiene el retardo (en segundos) que utiliza el administrador de canales para un cambio de canal.
`otChannelManagerGetFavoredChannels ( otInstance *aInstance)`	`uint32_t` Esta función obtiene la máscara de canal preferida.
`otChannelManagerGetRequestedChannel ( otInstance *aInstance)`	`uint8_t` Esta función obtiene el canal de la última llamada exitosa a `otChannelManagerRequestChannelChange()`
`otChannelManagerGetSupportedChannels ( otInstance *aInstance)`	`uint32_t` Esta función obtiene la máscara de canal compatible.
`otChannelManagerRequestChannelChange ( otInstance *aInstance, uint8_t aChannel)`	`void` Esta función solicita un cambio de canal de red de subprocesos.
`otChannelManagerRequestChannelSelect ( otInstance *aInstance, bool aSkipQualityCheck)`	`otError` Esta función solicita que `ChannelManager` verifique y seleccione un nuevo canal e inicie un cambio de canal.
`otChannelManagerSetAutoChannelSelectionEnabled ( otInstance *aInstance, bool aEnabled)`	`void` Esta función habilita / deshabilita la función de selección automática de canales.
`otChannelManagerSetAutoChannelSelectionInterval ( otInstance *aInstance, uint32_t aInterval)`	`otError` Esta función establece el intervalo de período (en segundos) utilizado por la función de selección automática de canales.
`otChannelManagerSetCcaFailureRateThreshold ( otInstance *aInstance, uint16_t aThreshold)`	`void` Esta función establece el umbral de tasa de falla de CCA.
`otChannelManagerSetDelay ( otInstance *aInstance, uint16_t aDelay)`	`otError` Esta función establece el retraso (en segundos) utilizado para un cambio de canal.
`otChannelManagerSetFavoredChannels ( otInstance *aInstance, uint32_t aChannelMask)`	`void` Esta función establece la máscara de canal favorecido.
`otChannelManagerSetSupportedChannels ( otInstance *aInstance, uint32_t aChannelMask)`	`void` Esta función establece la máscara de canal admitida.

Funciones

otChannelManagerGetAutoChannelSelectionEnabled

bool otChannelManagerGetAutoChannelSelectionEnabled(
  otInstance *aInstance
)

Esta función indica si la función de selección automática de canales está habilitada o no.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

VERDADERO si está habilitado, FALSO si está deshabilitado.

otChannelManagerGetAutoChannelSelectionInterval

uint32_t otChannelManagerGetAutoChannelSelectionInterval(
  otInstance *aInstance
)

Esta función obtiene el intervalo de período (en segundos) utilizado por la función de selección automática de canales.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

El intervalo en segundos.

otChannelManagerGetCcaFailureRateThreshold

uint16_t otChannelManagerGetCcaFailureRateThreshold(
  otInstance *aInstance
)

Esta función obtiene el umbral de tasa de falla de CCA.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

El umbral de la tasa de fallos de CCA. El valor 0 se asigna al 0% y 0xffff se asigna al 100%.

otChannelManagerGetDelay

uint16_t otChannelManagerGetDelay(
  otInstance *aInstance
)

Esta función obtiene el retardo (en segundos) que utiliza el administrador de canales para un cambio de canal.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

El retraso (en segundos) para el cambio de canal.

otChannelManagerGetFavoredChannels

uint32_t otChannelManagerGetFavoredChannels(
  otInstance *aInstance
)

Esta función obtiene la máscara de canal preferida.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

Los canales favoritos como una máscara de bits.

otChannelManagerGetRequestedChannel

uint8_t otChannelManagerGetRequestedChannel(
  otInstance *aInstance
)

Esta función obtiene el canal de la última llamada exitosa a otChannelManagerRequestChannelChange()

Detalles
Devoluciones	El último canal solicitado o cero si aún no ha habido una solicitud de cambio de canal.

otChannelManagerGetSupportedChannels

uint32_t otChannelManagerGetSupportedChannels(
  otInstance *aInstance
)

Esta función obtiene la máscara de canal compatible.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

Los canales admitidos como una máscara de bits.

otChannelManagerRequestChannelChange

void otChannelManagerRequestChannelChange(
  otInstance *aInstance,
  uint8_t aChannel
)

Esta función solicita un cambio de canal de red de subprocesos.

La red cambia al canal dado después de un retraso específico (consulte otChannelManagerSetDelay () ). El cambio de canal se realiza actualizando el conjunto de datos operativos pendientes.

Una llamada posterior a esta función cancelará un cambio de canal solicitado previamente en curso.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aChannel`	El nuevo canal de la red Thread.

otChannelManagerRequestChannelSelect

otError otChannelManagerRequestChannelSelect(
  otInstance *aInstance,
  bool aSkipQualityCheck
)

Esta función solicita que ChannelManager verifique y seleccione un nuevo canal e inicie un cambio de canal.

A diferencia de otChannelManagerRequestChannelChange() donde el canal se debe dar como parámetro, esta función le pide al ChannelManager que seleccione un canal por sí mismo (según la información de calidad del canal recopilada).

Una vez llamado, el Channel Manager realizará los siguientes 3 pasos:

1) ChannelManager decide si el cambio de canal sería útil. Esta verificación se puede omitir si aSkipQualityCheck se establece en verdadero (lo que obliga a realizar una selección de canal y omite la verificación de calidad). Este paso utiliza las métricas de calidad del enlace recopiladas en el dispositivo (como la tasa de falla de CCA, las tasas de error de tramas y mensajes por vecino, etc.) para determinar si la calidad del canal actual está al nivel que justifica un cambio de canal.

2) Si pasa el primer paso, ChannelManager selecciona un canal potencialmente mejor. Utiliza los datos de calidad del canal recopilados por el módulo ChannelMonitor . Los canales admitidos y favorecidos se utilizan en este paso. (consulte otChannelManagerSetSupportedChannels () y otChannelManagerSetFavoredChannels () ).

3) Si el canal recién seleccionado es diferente del canal actual, ChannelManager solicita / inicia el proceso de cambio de canal (invocando internamente un RequestChannelChange() ).

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aSkipQualityCheck`	Indica si se debe omitir el control de calidad (paso 1).

Valores devueltos

`OT_ERROR_NONE`	La selección de canal finalizó correctamente.
`OT_ERROR_NOT_FOUND`	La máscara de canal admitida está vacía, por lo que no se pudo seleccionar un canal.

otChannelManagerSetAutoChannelSelectionEnabled

void otChannelManagerSetAutoChannelSelectionEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Esta función habilita / deshabilita la función de selección automática de canales.

Cuando está habilitado, ChannelManager invocará periódicamente un RequestChannelSelect(false) . El intervalo de período se puede establecer mediante SetAutoChannelSelectionInterval() .

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aEnabled`	Indica si habilitar o deshabilitar esta funcionalidad.

otChannelManagerSetAutoChannelSelectionInterval

otError otChannelManagerSetAutoChannelSelectionInterval(
  otInstance *aInstance,
  uint32_t aInterval
)

Esta función establece el intervalo de período (en segundos) utilizado por la función de selección automática de canales.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aInterval`	El intervalo en segundos.

Valores devueltos

`OT_ERROR_NONE`	El intervalo se estableció correctamente.
`OT_ERROR_INVALID_ARGS`	El `aInterval` no es válido (cero).

otChannelManagerSetCcaFailureRateThreshold

void otChannelManagerSetCcaFailureRateThreshold(
  otInstance *aInstance,
  uint16_t aThreshold
)

Esta función establece el umbral de tasa de falla de CCA.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aThreshold`	Un umbral de tasa de falla de CCA. El valor 0 se asigna al 0% y 0xffff se asigna al 100%.

otChannelManagerSetDelay

otError otChannelManagerSetDelay(
  otInstance *aInstance,
  uint16_t aDelay
)

Esta función establece el retraso (en segundos) utilizado para un cambio de canal.

La demora debe ser preferiblemente mayor que el intervalo máximo de sondeo de datos utilizado por todos los dispositivos finales dormidos dentro de la red Thread.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aDelay`	Retraso en segundos.

Valores devueltos

`OT_ERROR_NONE`	El retraso se actualizó correctamente.
`OT_ERROR_INVALID_ARGS`	La demora dada `aDelay` es demasiado corta.

otChannelManagerSetFavoredChannels

void otChannelManagerSetFavoredChannels(
  otInstance *aInstance,
  uint32_t aChannelMask
)

Esta función establece la máscara de canal favorecido.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aChannelMask`	Una máscara de canal.

otChannelManagerSetSupportedChannels

void otChannelManagerSetSupportedChannels(
  otInstance *aInstance,
  uint32_t aChannelMask
)

Esta función establece la máscara de canal admitida.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aChannelMask`	Una máscara de canal.