Enlace

Este módulo incluye funciones que controlan la configuración de la capa de enlace.

Resumen

Enumeraciones
`otMacFilterAddressMode { OT_MAC_FILTER_ADDRESS_MODE_DISABLED , OT_MAC_FILTER_ADDRESS_MODE_ALLOWLIST , OT_MAC_FILTER_ADDRESS_MODE_DENYLIST }`	enumeración Define el modo de dirección del filtro mac.

Typedefs
`otActiveScanResult`	typedef `struct otActiveScanResult` Esta estructura representa una baliza IEEE 802.15.4 recibida.
`otEnergyScanResult`	typedef `struct otEnergyScanResult` Esta estructura representa un resultado de escaneo de energía.
`otHandleActiveScanResult )(otActiveScanResult aResult, void aContext)`	typedef `void(*` Este puntero de función se llama durante una exploración activa IEEE 802.15.4 cuando se recibe una baliza IEEE 802.15.4 o se completa la exploración.
`otHandleEnergyScanResult )(otEnergyScanResult aResult, void aContext)`	typedef `void(*` Este puntero de función se llama durante una exploración de energía IEEE 802.15.4 cuando el resultado de un canal está listo o se completa la exploración.
`otLinkPcapCallback )(const otRadioFrame aFrame, bool aIsTx, void aContext)`	typedef `void(*` Este puntero de función se llama cuando se recibe una trama IEEE 802.15.4.
`otMacCounters`	typedef `struct otMacCounters` Esta estructura representa los contadores de la capa MAC.
`otMacFilterAddressMode`	typedef `enum otMacFilterAddressMode` Define el modo de dirección del filtro mac.
`otMacFilterEntry`	typedef `struct otMacFilterEntry` Esta estructura representa una entrada de filtro de Mac.
`otMacFilterIterator`	typedef `uint8_t` Se usa para iterar a través de las entradas del filtro mac.
`otThreadLinkInfo`	typedef `struct otThreadLinkInfo` Esta estructura representa información específica del enlace para los mensajes recibidos de la radio Thread.

Funciones
`otLinkActiveScan ( otInstance aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleActiveScanResult aCallback, void aCallbackContext)`	`otError` Esta función inicia una exploración activa IEEE 802.15.4.
`otLinkConvertLinkQualityToRss ( otInstance *aInstance, uint8_t aLinkQuality)`	`int8_t` Este método convierte la calidad del enlace en la intensidad de la señal recibida típica.
`otLinkConvertRssToLinkQuality ( otInstance *aInstance, int8_t aRss)`	`uint8_t` Este método convierte la intensidad de la señal recibida en calidad del enlace.
`otLinkCslGetChannel ( otInstance *aInstance)`	`uint8_t` Esta función obtiene el canal CSL.
`otLinkCslGetPeriod ( otInstance *aInstance)`	`uint16_t` Esta función obtiene el período CSL.
`otLinkCslGetTimeout ( otInstance *aInstance)`	`uint32_t` Esta función obtiene el tiempo de espera de CSL.
`otLinkCslSetChannel ( otInstance *aInstance, uint8_t aChannel)`	`otError` Esta función establece el canal CSL.
`otLinkCslSetPeriod ( otInstance *aInstance, uint16_t aPeriod)`	`otError` Esta función establece el período CSL.
`otLinkCslSetTimeout ( otInstance *aInstance, uint32_t aTimeout)`	`otError` Esta función establece el tiempo de espera de CSL.
`otLinkEnergyScan ( otInstance aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleEnergyScanResult aCallback, void aCallbackContext)`	`otError` Esta función inicia un análisis de energía IEEE 802.15.4.
`otLinkFilterAddAddress ( otInstance aInstance, const otExtAddress aExtAddress)`	`otError` Este método agrega una dirección extendida al filtro MAC.
`otLinkFilterAddRssIn ( otInstance aInstance, const otExtAddress aExtAddress, int8_t aRss)`	`otError` Este método agrega una entrada de intensidad de señal recibida fija (en dBm) para los mensajes de una dirección extendida dada en el filtro MAC.
`otLinkFilterClearAddresses ( otInstance *aInstance)`	`void` Este método borra todas las direcciones extendidas del filtro MAC.
`otLinkFilterClearAllRssIn ( otInstance *aInstance)`	`void` Este método borra todas las entradas de intensidad de la señal recibida (incluida la entrada RSS predeterminada) en el filtro MAC.
`otLinkFilterClearDefaultRssIn ( otInstance *aInstance)`	`void` Este método borra cualquier intensidad de señal recibida predeterminada establecida previamente (en dBm) en el filtro MAC.
`otLinkFilterGetAddressMode ( otInstance *aInstance)`	`otMacFilterAddressMode` Esta función obtiene el modo de dirección del filtro MAC.
`otLinkFilterGetNextAddress ( otInstance aInstance, otMacFilterIterator aIterator, otMacFilterEntry *aEntry)`	`otError` Este método obtiene una entrada de filtro de dirección en uso.
`otLinkFilterGetNextRssIn ( otInstance aInstance, otMacFilterIterator aIterator, otMacFilterEntry *aEntry)`	`otError` Este método obtiene una entrada de filtro RssIn en uso.
`otLinkFilterRemoveAddress ( otInstance aInstance, const otExtAddress aExtAddress)`	`void` Este método elimina una dirección extendida del filtro MAC.
`otLinkFilterRemoveRssIn ( otInstance aInstance, const otExtAddress aExtAddress)`	`void` Este método elimina una entrada de filtro MAC para la configuración fija de la intensidad de la señal recibida para una dirección extendida determinada.
`otLinkFilterSetAddressMode ( otInstance *aInstance, otMacFilterAddressMode aMode)`	`void` Esta función establece el modo de dirección del filtro MAC.
`otLinkFilterSetDefaultRssIn ( otInstance *aInstance, int8_t aRss)`	`void` Este método establece la intensidad de la señal recibida predeterminada (en dBm) en el filtro MAC.
`otLinkGetCcaFailureRate ( otInstance *aInstance)`	`uint16_t` Esta función devuelve la tasa de falla actual de CCA (evaluación de canal transparente).
`otLinkGetChannel ( otInstance *aInstance)`	`uint8_t` Obtenga el canal IEEE 802.15.4.
`otLinkGetCounters ( otInstance *aInstance)`	`const otMacCounters *` Obtenga los contadores de la capa MAC.
`otLinkGetExtendedAddress ( otInstance *aInstance)`	`const otExtAddress *` Obtenga la dirección extendida IEEE 802.15.4.
`otLinkGetFactoryAssignedIeeeEui64 ( otInstance aInstance, otExtAddress aEui64)`	`void` Obtenga el IEEE EUI-64 asignado de fábrica.
`otLinkGetMaxFrameRetriesDirect ( otInstance *aInstance)`	`uint8_t` Este método devuelve el número máximo de reintentos de tramas durante la transmisión directa.
`otLinkGetMaxFrameRetriesIndirect ( otInstance *aInstance)`	`uint8_t` Este método devuelve el número máximo de reintentos de trama durante la transmisión indirecta.
`otLinkGetPanId ( otInstance *aInstance)`	`otPanId` Obtenga el ID de PAN IEEE 802.15.4.
`otLinkGetPollPeriod ( otInstance *aInstance)`	`uint32_t` Obtenga el período de encuesta de datos del dispositivo final con sueño.
`otLinkGetShortAddress ( otInstance *aInstance)`	`otShortAddress` Obtenga la dirección corta IEEE 802.15.4.
`otLinkGetSupportedChannelMask ( otInstance *aInstance)`	`uint32_t` Obtenga la máscara de canal compatible de la capa MAC.
`otLinkGetTxDirectRetrySuccessHistogram ( otInstance aInstance, uint8_t aNumberOfEntries)`	`const uint32_t *` Este método obtiene un histograma de reintentos para un solo paquete directo hasta que se realiza correctamente.
`otLinkGetTxIndirectRetrySuccessHistogram ( otInstance aInstance, uint8_t aNumberOfEntries)`	`const uint32_t *` Este método obtiene un histograma de reintentos para un solo paquete indirecto hasta que se realiza correctamente.
`otLinkIsActiveScanInProgress ( otInstance *aInstance)`	`bool` Esta función indica si se está realizando o no una exploración activa IEEE 802.15.4.
`otLinkIsEnabled ( otInstance *aInstance)`	`bool` Esta función indica si la capa de enlace está habilitada o no.
`otLinkIsEnergyScanInProgress ( otInstance *aInstance)`	`bool` Esta función indica si se está realizando o no un análisis de energía IEEE 802.15.4.
`otLinkIsInTransmitState ( otInstance *aInstance)`	`bool` Esta función indica si una MAC IEEE 802.15.4 está en estado de transmisión.
`otLinkIsPromiscuous ( otInstance *aInstance)`	`bool` Esta función indica si el modo promiscuo está habilitado en la capa de enlace.
`otLinkOutOfBandTransmitRequest ( otInstance aInstance, otRadioFrame aOobFrame)`	`otError` Esta función pone en cola una trama IEEE 802.15.4 fuera de banda para su transmisión.
`otLinkResetCounters ( otInstance *aInstance)`	`void` Reinicie los contadores de la capa MAC.
`otLinkResetTxRetrySuccessHistogram ( otInstance *aInstance)`	`void` Este método borra las estadísticas del histograma para transmisiones directas e indirectas.
`otLinkSendDataRequest ( otInstance *aInstance)`	`otError` Esta función pone en cola un mensaje de solicitud de datos IEEE 802.15.4 para su transmisión.
`otLinkSetChannel ( otInstance *aInstance, uint8_t aChannel)`	`otError` Configure el canal IEEE 802.15.4.
`otLinkSetEnabled ( otInstance *aInstance, bool aEnable)`	`otError` Esta función habilita o deshabilita la capa de enlace.
`otLinkSetExtendedAddress ( otInstance aInstance, const otExtAddress aExtAddress)`	`otError` Esta función establece la dirección extendida IEEE 802.15.4.
`otLinkSetMaxFrameRetriesDirect ( otInstance *aInstance, uint8_t aMaxFrameRetriesDirect)`	`void` Este método establece el número máximo de reintentos de tramas durante la transmisión directa.
`otLinkSetMaxFrameRetriesIndirect ( otInstance *aInstance, uint8_t aMaxFrameRetriesIndirect)`	`void` Este método establece el número máximo de reintentos de trama durante la transmisión indirecta.
`otLinkSetPanId ( otInstance *aInstance, otPanId aPanId)`	`otError` Configure el ID de PAN IEEE 802.15.4.
`otLinkSetPcapCallback ( otInstance aInstance, otLinkPcapCallback aPcapCallback, void aCallbackContext)`	`void` Esta función registra una devolución de llamada para proporcionar tramas IEEE 802.15.4 sin procesar recibidas.
`otLinkSetPollPeriod ( otInstance *aInstance, uint32_t aPollPeriod)`	`otError` Establecer / borrar el período de sondeo de datos externo / especificado por el usuario para el dispositivo final con sueño.
`otLinkSetPromiscuous ( otInstance *aInstance, bool aPromiscuous)`	`otError` Esta función habilita o deshabilita el modo promiscuo de la capa de enlace.
`otLinkSetSupportedChannelMask ( otInstance *aInstance, uint32_t aChannelMask)`	`otError` Establezca la máscara de canal admitida de la capa MAC.

Estructuras
otActiveScanResult	Esta estructura representa una baliza IEEE 802.15.4 recibida.
otEnergyScanResult	Esta estructura representa un resultado de escaneo de energía.
otMacCounters	Esta estructura representa los contadores de la capa MAC.
otMacFilterEntry	Esta estructura representa una entrada de filtro de Mac.
otThreadLinkInfo	Esta estructura representa información específica del enlace para los mensajes recibidos de la radio Thread.

Enumeraciones

otMacFilterAddressMode

 otMacFilterAddressMode

Define el modo de dirección del filtro mac.

Propiedades
`OT_MAC_FILTER_ADDRESS_MODE_ALLOWLIST`	El modo de filtro de direcciones de lista de permitidos está habilitado.
`OT_MAC_FILTER_ADDRESS_MODE_DENYLIST`	El modo de filtro de direcciones de lista denegada está habilitado.
`OT_MAC_FILTER_ADDRESS_MODE_DISABLED`	El filtro de direcciones está desactivado.

Typedefs

otActiveScanResult

struct otActiveScanResult otActiveScanResult

Esta estructura representa una baliza IEEE 802.15.4 recibida.

otEnergyScanResult

struct otEnergyScanResult otEnergyScanResult

Esta estructura representa un resultado de escaneo de energía.

otHandleActiveScanResult

void(* otHandleActiveScanResult)(otActiveScanResult *aResult, void *aContext)

Este puntero de función se llama durante una exploración activa IEEE 802.15.4 cuando se recibe una baliza IEEE 802.15.4 o se completa la exploración.

Detalles

Parámetros

`[in] aResult`	Un puntero válido a la información de la baliza o NULL cuando se completa el escaneo activo.
`[in] aContext`	Un puntero al contexto específico de la aplicación.

otHandleEnergyScanResult

void(* otHandleEnergyScanResult)(otEnergyScanResult *aResult, void *aContext)

Este puntero de función se llama durante una exploración de energía IEEE 802.15.4 cuando el resultado de un canal está listo o se completa la exploración.

Detalles

Parámetros

`[in] aResult`	Un puntero válido a la información del resultado del escaneo de energía o NULL cuando se completa el escaneo de energía.
`[in] aContext`	Un puntero al contexto específico de la aplicación.

otLinkPcapCallback

void(* otLinkPcapCallback)(const otRadioFrame *aFrame, bool aIsTx, void *aContext)

Este puntero de función se llama cuando se recibe una trama IEEE 802.15.4.

Nota: Esta devolución de llamada se llama después del procesamiento de FCS y aFrame posible que un aFrame no contenga el FCS real que se recibió.

Detalles

Parámetros

`[in] aFrame`	Un puntero a la trama IEEE 802.15.4 recibida.
`[in] aIsTx`	Si esta trama se transmite, no se recibe.
`[in] aContext`	Un puntero al contexto específico de la aplicación.

otMacCounters

struct otMacCounters otMacCounters

Esta estructura representa los contadores de la capa MAC.

otMacFilterAddressMode

enum otMacFilterAddressMode otMacFilterAddressMode

Define el modo de dirección del filtro mac.

otMacFilterEntry

struct otMacFilterEntry otMacFilterEntry

Esta estructura representa una entrada de filtro de Mac.

otMacFilterIterator

uint8_t otMacFilterIterator

Se usa para iterar a través de las entradas del filtro mac.

otThreadLinkInfo

struct otThreadLinkInfo otThreadLinkInfo

Esta estructura representa información específica de enlace para mensajes recibidos de la radio Thread.

Funciones

otLinkActiveScan

otError otLinkActiveScan(
  otInstance *aInstance,
  uint32_t aScanChannels,
  uint16_t aScanDuration,
  otHandleActiveScanResult aCallback,
  void *aCallbackContext
)

Esta función inicia una exploración activa IEEE 802.15.4.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aScanChannels`	Un vector de bits que indica qué canales explorar (por ejemplo, OT_CHANNEL_11_MASK).
`[in] aScanDuration`	El tiempo en milisegundos para explorar cada canal.
`[in] aCallback`	Un puntero a una función llamada al recibir una baliza o un escaneo se completa.
`[in] aCallbackContext`	Un puntero al contexto específico de la aplicación.

Valores devueltos

`OT_ERROR_NONE`	Aceptó la solicitud de análisis activo.
`OT_ERROR_BUSY`	Ya estoy realizando un escaneo activo.

otLinkConvertLinkQualityToRss

int8_t otLinkConvertLinkQualityToRss(
  otInstance *aInstance,
  uint8_t aLinkQuality
)

Este método convierte la calidad del enlace en la intensidad de la señal recibida típica.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aLinkQuality`	Valor de LinkQuality, debe estar en el rango [0,3].

Devoluciones

La plataforma típica recibió el mapeo de la intensidad de la señal a aLinkQuality .

otLinkConvertRssToLinkQuality

uint8_t otLinkConvertRssToLinkQuality(
  otInstance *aInstance,
  int8_t aRss
)

Este método convierte la intensidad de la señal recibida en calidad del enlace.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aRss`	El valor de intensidad de la señal recibida que se va a convertir.

Devoluciones

Vincular la asignación de valor de calidad a aRss .

otLinkCslGetChannel

uint8_t otLinkCslGetChannel(
  otInstance *aInstance
)

Esta función obtiene el canal CSL.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

El canal CSL.

otLinkCslGetPeriod

uint16_t otLinkCslGetPeriod(
  otInstance *aInstance
)

Esta función obtiene el período CSL.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

El período CSL en unidades de 10 símbolos.

otLinkCslGetTimeout

uint32_t otLinkCslGetTimeout(
  otInstance *aInstance
)

Esta función obtiene el tiempo de espera de CSL.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

El tiempo de espera de CSL en segundos.

otLinkCslSetChannel

otError otLinkCslSetChannel(
  otInstance *aInstance,
  uint8_t aChannel
)

Esta función establece el canal CSL.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aChannel`	El canal de muestra CSL.

Valores devueltos

`OT_ERROR_NONE`	Configurar correctamente los parámetros de CSL.
`OT_ERROR_INVALID_ARGS`	`aChannel` no `aChannel` .

otLinkCslSetPeriod

otError otLinkCslSetPeriod(
  otInstance *aInstance,
  uint16_t aPeriod
)

Esta función establece el período de CSL.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aPeriod`	El período CSL en unidades de 10 símbolos.

Valores devueltos

`OT_ERROR_NONE`	Estableció correctamente el período de CSL.
`OT_ERROR_INVALID_ARGS`	Período de CSL no válido.

otLinkCslSetTimeout

otError otLinkCslSetTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Esta función establece el tiempo de espera de CSL.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aTimeout`	El tiempo de espera de CSL en segundos.

Valores devueltos

`OT_ERROR_NONE`	Estableció correctamente el tiempo de espera de CSL.
`OT_ERROR_INVALID_ARGS`	Tiempo de espera de CSL no válido.

otLinkEnergyScan

otError otLinkEnergyScan(
  otInstance *aInstance,
  uint32_t aScanChannels,
  uint16_t aScanDuration,
  otHandleEnergyScanResult aCallback,
  void *aCallbackContext
)

Esta función inicia un análisis de energía IEEE 802.15.4.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aScanChannels`	Un vector de bits que indica en qué canales realizar un escaneo de energía.
`[in] aScanDuration`	El tiempo en milisegundos para explorar cada canal.
`[in] aCallback`	Un puntero a una función llamada para transmitir el resultado del análisis indica la finalización del análisis.
`[in] aCallbackContext`	Un puntero al contexto específico de la aplicación.

Valores devueltos

`OT_ERROR_NONE`	Aceptó la solicitud de Energy Scan.
`OT_ERROR_BUSY`	No se pudo iniciar el escaneo de energía.

otLinkFilterAddAddress

otError otLinkFilterAddAddress(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

Este método agrega una dirección extendida al filtro MAC.

Esta función está disponible cuando la configuración OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está habilitada.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aExtAddress`	Un puntero a la dirección extendida (NO DEBE ser NULO).

Valores devueltos

`OT_ERROR_NONE`	Se agregó `aExtAddress` al filtro MAC.
`OT_ERROR_NO_BUFS`	No existe ninguna entrada disponible.

otLinkFilterAddRssIn

otError otLinkFilterAddRssIn(
  otInstance *aInstance,
  const otExtAddress *aExtAddress,
  int8_t aRss
)

Este método agrega una entrada de intensidad de señal recibida fija (en dBm) para los mensajes de una dirección extendida dada en el filtro MAC.

Esta función está disponible cuando la configuración OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está habilitada.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aExtAddress`	Un puntero a la dirección extendida IEEE 802.15.4. No debe ser nulo.
`[in] aRss`	Una intensidad de la señal recibida (en dBm).

Valores devueltos

`OT_ERROR_NONE`	Se agregó `aExtAddress` una entrada para `aExtAddress` y `aRss` .
`OT_ERROR_NO_BUFS`	No existe ninguna entrada disponible.

otLinkFilterClearAddresses

void otLinkFilterClearAddresses(
  otInstance *aInstance
)

Este método borra todas las direcciones extendidas del filtro MAC.

Esta función está disponible cuando la configuración OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está habilitada.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

otLinkFilterClearAllRssIn

void otLinkFilterClearAllRssIn(
  otInstance *aInstance
)

Este método borra todas las entradas de intensidad de señal recibidas (incluida la entrada RSS predeterminada) en el filtro MAC.

Esta función está disponible cuando la configuración OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está habilitada.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

otLinkFilterClearDefaultRssIn

void otLinkFilterClearDefaultRssIn(
  otInstance *aInstance
)

Este método borra cualquier intensidad de señal recibida predeterminada establecida previamente (en dBm) en el filtro MAC.

Esta función está disponible cuando la configuración OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está habilitada.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

otLinkFilterGetAddressMode

otMacFilterAddressMode otLinkFilterGetAddressMode(
  otInstance *aInstance
)

Esta función obtiene el modo de dirección del filtro MAC.

Esta función está disponible cuando la configuración OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está habilitada.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

el modo de dirección.

otLinkFilterGetNextAddress

otError otLinkFilterGetNextAddress(
  otInstance *aInstance,
  otMacFilterIterator *aIterator,
  otMacFilterEntry *aEntry
)

Este método obtiene una entrada de filtro de dirección en uso.

Esta función está disponible cuando la configuración OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está habilitada.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in,out] aIterator`	Un puntero al contexto del iterador del filtro MAC. Para obtener la primera entrada de filtro de direcciones en uso, debe establecerse en OT_MAC_FILTER_ITERATOR_INIT. No debe ser nulo.
`[out] aEntry`	Un puntero al lugar donde se coloca la información. No debe ser nulo.

Valores devueltos

`OT_ERROR_NONE`	Se recuperó correctamente una entrada de filtro de direcciones en uso.
`OT_ERROR_NOT_FOUND`	No existe ninguna entrada posterior.

otLinkFilterGetNextRssIn

otError otLinkFilterGetNextRssIn(
  otInstance *aInstance,
  otMacFilterIterator *aIterator,
  otMacFilterEntry *aEntry
)

Este método obtiene una entrada de filtro RssIn en uso.

Esta función está disponible cuando la configuración OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está habilitada.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in,out] aIterator`	Un puntero al contexto del iterador del filtro MAC. No debe ser nulo. Para obtener la primera entrada, debe establecerse en OT_MAC_FILTER_ITERATOR_INIT.
`[out] aEntry`	Un puntero al lugar donde se coloca la información. La última entrada tendría la dirección extendida como todo 0xff para indicar la intensidad de la señal recibida predeterminada si estuviera configurada. `aEntry` NO DEBE ser NULO.

Valores devueltos

`OT_ERROR_NONE`	Recuperado con éxito la siguiente entrada.
`OT_ERROR_NOT_FOUND`	No existe ninguna entrada posterior.

otLinkFilterRemoveAddress

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

Este método elimina una dirección extendida del filtro MAC.

Esta función está disponible cuando la configuración OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está habilitada.

No se realiza ninguna acción si no hay una entrada existente en el filtro que coincida con la dirección extendida dada.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aExtAddress`	Un puntero a la dirección extendida (NO DEBE ser NULO).

otLinkFilterRemoveRssIn

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

Este método elimina una entrada de filtro MAC para la configuración fija de la intensidad de la señal recibida para una dirección extendida determinada.

Esta función está disponible cuando la configuración OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está habilitada.

No se realiza ninguna acción si no hay una entrada existente en el filtro que coincida con la dirección extendida dada.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aExtAddress`	Un puntero a la dirección extendida IEEE 802.15.4. No debe ser nulo.

otLinkFilterSetAddressMode

void otLinkFilterSetAddressMode(
  otInstance *aInstance,
  otMacFilterAddressMode aMode
)

Esta función establece el modo de dirección del filtro MAC.

Esta función está disponible cuando la configuración OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está habilitada.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aMode`	El modo de dirección a configurar.

otLinkFilterSetDefaultRssIn

void otLinkFilterSetDefaultRssIn(
  otInstance *aInstance,
  int8_t aRss
)

Este método establece la intensidad de la señal recibida predeterminada (en dBm) en el filtro MAC.

Esta función está disponible cuando la configuración OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está habilitada.

El valor RSS predeterminado se usa para todas las tramas recibidas de direcciones para las cuales no hay una entrada RSS-IN explícita en la lista de filtros (agregada usando otLinkFilterAddRssIn() ).

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aRss`	La intensidad de la señal recibida predeterminada (en dBm) para establecer.

otLinkGetCcaFailureRate

uint16_t otLinkGetCcaFailureRate(
  otInstance *aInstance
)

Esta función devuelve la tasa de falla actual de CCA (evaluación de canal transparente).

La tasa se mantiene durante una ventana de (aproximadamente) las últimas transmisiones de tramas OPENTHREAD_CONFIG_CCA_FAILURE_RATE_AVERAGING_WINDOW .

Detalles
Devoluciones	La tasa de falla de CCA con el valor máximo `0xffff` correspondiente a la tasa de falla del 100%.

otLinkGetChannel

uint8_t otLinkGetChannel(
  otInstance *aInstance
)

Obtenga el canal IEEE 802.15.4.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

El canal IEEE 802.15.4.

Ver también:
otLinkSetChannel

otLinkGetCounters

const otMacCounters * otLinkGetCounters(
  otInstance *aInstance
)

Obtenga los contadores de la capa MAC.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

Un puntero a los contadores de la capa MAC.

otLinkGetExtendedAddress

const otExtAddress * otLinkGetExtendedAddress(
  otInstance *aInstance
)

Obtenga la dirección extendida IEEE 802.15.4.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

Un puntero a la dirección extendida IEEE 802.15.4.

otLinkGetFactoryAssignedIeeeEui64

void otLinkGetFactoryAssignedIeeeEui64(
  otInstance *aInstance,
  otExtAddress *aEui64
)

Obtenga el IEEE EUI-64 asignado de fábrica.

Detalles

Parámetros

`[in] aInstance`	Un puntero a la instancia de OpenThread.
`[out] aEui64`	Un puntero al lugar donde se coloca el IEEE EUI-64 asignado de fábrica.

otLinkGetMaxFrameRetriesDirect

uint8_t otLinkGetMaxFrameRetriesDirect(
  otInstance *aInstance
)

Este método devuelve el número máximo de reintentos de trama durante la transmisión directa.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

El número máximo de reintentos durante la transmisión directa.

otLinkGetMaxFrameRetriesIndirect

uint8_t otLinkGetMaxFrameRetriesIndirect(
  otInstance *aInstance
)

Este método devuelve el número máximo de reintentos de trama durante la transmisión indirecta.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

El número máximo de reintentos durante la transmisión indirecta.

otLinkGetPanId

otPanId otLinkGetPanId(
  otInstance *aInstance
)

Obtenga el ID de PAN IEEE 802.15.4.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

El ID de PAN IEEE 802.15.4.

Ver también:
otLinkSetPanId

otLinkGetPollPeriod

uint32_t otLinkGetPollPeriod(
  otInstance *aInstance
)

Obtenga el período de sondeo de datos del dispositivo final con sueño.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

El período de sondeo de datos del dispositivo final con sueño en milisegundos.

Ver también:
otLinkSetPollPeriod

otLinkGetShortAddress

otShortAddress otLinkGetShortAddress(
  otInstance *aInstance
)

Obtenga la dirección corta IEEE 802.15.4.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

Un puntero a la dirección corta IEEE 802.15.4.

otLinkGetSupportedChannelMask

uint32_t otLinkGetSupportedChannelMask(
  otInstance *aInstance
)

Obtenga la máscara de canal compatible de la capa MAC.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

La máscara de canal admitida como uint32_t con uint32_t de bit 0 (lsb) al canal 0, bit 1 al canal 1, etc.

otLinkGetTxDirectRetrySuccessHistogram

const uint32_t * otLinkGetTxDirectRetrySuccessHistogram(
  otInstance *aInstance,
  uint8_t *aNumberOfEntries
)

Este método obtiene un histograma de reintentos para un solo paquete directo hasta que se realiza correctamente.

Esta función es válida cuando la configuración OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE está habilitada.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[out] aNumberOfEntries`	Un puntero al lugar donde se coloca el tamaño de la matriz de histograma devuelta.

Devoluciones

Un puntero al histograma de reintentos (en forma de matriz). El n-ésimo elemento indica que el paquete se ha enviado con n-ésimo reintento.

otLinkGetTxIndirectRetrySuccessHistogram

const uint32_t * otLinkGetTxIndirectRetrySuccessHistogram(
  otInstance *aInstance,
  uint8_t *aNumberOfEntries
)

Este método obtiene un histograma de reintentos para un solo paquete indirecto hasta que se realiza correctamente.

Esta función es válida cuando la configuración OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE está habilitada.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[out] aNumberOfEntries`	Un puntero al lugar donde se coloca el tamaño de la matriz de histograma devuelta.

Devoluciones

Un puntero al histograma de reintentos (en forma de matriz). El n-ésimo elemento indica que el paquete se ha enviado con n-ésimo reintento.

otLinkIsActiveScanInProgress

bool otLinkIsActiveScanInProgress(
  otInstance *aInstance
)

Esta función indica si hay o no un análisis activo IEEE 802.15.4 en curso.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

Es verdadero si hay un escaneo activo IEEE 802.15.4 en curso, falso en caso contrario.

otLinkIsEnabled

bool otLinkIsEnabled(
  otInstance *aInstance
)

Esta función indica si la capa de enlace está habilitada o no.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Valores devueltos

`true`	La capa de enlace está habilitada.
`false`	La capa de enlace no está habilitada.

otLinkIsEnergyScanInProgress

bool otLinkIsEnergyScanInProgress(
  otInstance *aInstance
)

Esta función indica si se está realizando o no un análisis de energía IEEE 802.15.4.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

Es verdadero si se está realizando un análisis de energía IEEE 802.15.4; de lo contrario, es falso.

otLinkIsInTransmitState

bool otLinkIsInTransmitState(
  otInstance *aInstance
)

Esta función indica si un MAC IEEE 802.15.4 está en estado de transmisión.

El módulo MAC está en estado de transmisión durante el procedimiento CSMA / CA, CCA, transmisión de tramas de datos, baliza o solicitud de datos y recibe un ACK de una trama transmitida. El módulo MAC no está en estado de transmisión durante la transmisión de una trama ACK o una trama de solicitud de baliza.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

Es verdadero si un MAC IEEE 802.15.4 está en el estado de transmisión, falso en caso contrario.

otLinkIsPromiscuous

bool otLinkIsPromiscuous(
  otInstance *aInstance
)

Esta función indica si el modo promiscuo está habilitado o no en la capa de enlace.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Valores devueltos

`true`	El modo promiscuo está habilitado.
`false`	El modo promiscuo no está habilitado.

otLinkOutOfBandTransmitRequest

otError otLinkOutOfBandTransmitRequest(
  otInstance *aInstance,
  otRadioFrame *aOobFrame
)

Esta función pone en cola una trama IEEE 802.15.4 fuera de banda para su transmisión.

Un marco fuera de banda es uno que se generó fuera de OpenThread.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aOobFrame`	Un puntero al fotograma a transmitir.

Valores devueltos

`OT_ERROR_NONE`	Se programó correctamente la transmisión de la trama.
`OT_ERROR_ALREADY`	La capa MAC está ocupada enviando una trama solicitada previamente.
`OT_ERROR_INVALID_STATE`	La capa MAC no está habilitada.
`OT_ERROR_INVALID_ARGS`	El argumento `aOobFrame` es NULL.

otLinkResetCounters

void otLinkResetCounters(
  otInstance *aInstance
)

Reinicie los contadores de la capa MAC.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

otLinkResetTxRetrySuccessHistogram

void otLinkResetTxRetrySuccessHistogram(
  otInstance *aInstance
)

Este método borra las estadísticas del histograma para transmisiones directas e indirectas.

Esta función es válida cuando la configuración OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE está habilitada.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

otLinkSendDataRequest

otError otLinkSendDataRequest(
  otInstance *aInstance
)

Esta función pone en cola un mensaje de solicitud de datos IEEE 802.15.4 para su transmisión.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Valores devueltos

`OT_ERROR_NONE`	Se puso en cola con éxito un mensaje de solicitud de datos IEEE 802.15.4.
`OT_ERROR_ALREADY`	Un mensaje de solicitud de datos IEEE 802.15.4 ya está en cola.
`OT_ERROR_INVALID_STATE`	El dispositivo no está en modo rx-off-when-idle.
`OT_ERROR_NO_BUFS`	Buffers de mensajes insuficientes disponibles.

otLinkSetChannel

otError otLinkSetChannel(
  otInstance *aInstance,
  uint8_t aChannel
)

Configure el canal IEEE 802.15.4.

Esta función solo tiene éxito cuando los protocolos de subprocesos están deshabilitados. Una llamada exitosa a esta función invalida 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] aChannel`	El canal IEEE 802.15.4.

Valores devueltos

`OT_ERROR_NONE`	Configure correctamente el canal.
`OT_ERROR_INVALID_ARGS`	Si un `aChannel` no está en el rango [11, 26] o no está en la máscara de canal admitida.
`OT_ERROR_INVALID_STATE`	Los protocolos de subprocesos están habilitados.

Ver también:
otLinkGetChannel

otLinkSetEnabled

otError otLinkSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Esta función habilita o deshabilita la capa de enlace.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aEnable`	Es true para habilitar la capa de enlace, o false en caso contrario.

Valores devueltos

`OT_ERROR_NONE`	Habilitado / deshabilitado con éxito la capa de enlace.
`OT_ERROR_INVALID_STATE`	No se pudo deshabilitar la capa de enlace porque la interfaz Thread está habilitada.

otLinkSetExtendedAddress

otError otLinkSetExtendedAddress(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

Esta función establece la dirección extendida IEEE 802.15.4.

Esta función solo tiene éxito cuando los protocolos de subprocesos están deshabilitados.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aExtAddress`	Un puntero a la dirección extendida IEEE 802.15.4.

Valores devueltos

`OT_ERROR_NONE`	Configure correctamente la dirección extendida IEEE 802.15.4.
`OT_ERROR_INVALID_ARGS`	`aExtAddress` era NULL.
`OT_ERROR_INVALID_STATE`	Los protocolos de subprocesos están habilitados.

otLinkSetMaxFrameRetriesDirect

void otLinkSetMaxFrameRetriesDirect(
  otInstance *aInstance,
  uint8_t aMaxFrameRetriesDirect
)

Este método establece el número máximo de reintentos de tramas durante la transmisión directa.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aMaxFrameRetriesDirect`	El número máximo de reintentos durante la transmisión directa.

otLinkSetMaxFrameRetriesIndirect

void otLinkSetMaxFrameRetriesIndirect(
  otInstance *aInstance,
  uint8_t aMaxFrameRetriesIndirect
)

Este método establece el número máximo de reintentos de tramas durante la transmisión indirecta.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aMaxFrameRetriesIndirect`	El número máximo de reintentos durante la transmisión indirecta.

otLinkSetPanId

otError otLinkSetPanId(
  otInstance *aInstance,
  otPanId aPanId
)

Configure el ID de PAN IEEE 802.15.4.

Esta función solo tiene éxito cuando los protocolos de subprocesos están deshabilitados. Una llamada exitosa a esta función también invalida 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] aPanId`	El ID de PAN IEEE 802.15.4.

Valores devueltos

`OT_ERROR_NONE`	Estableció correctamente el ID de PAN.
`OT_ERROR_INVALID_ARGS`	Si unPanId no está en el rango [0, 65534].
`OT_ERROR_INVALID_STATE`	Los protocolos de subprocesos están habilitados.

Ver también:
otLinkGetPanId

otLinkSetPcapCallback

void otLinkSetPcapCallback(
  otInstance *aInstance,
  otLinkPcapCallback aPcapCallback,
  void *aCallbackContext
)

Esta función registra una devolución de llamada para proporcionar tramas IEEE 802.15.4 sin procesar recibidas.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aPcapCallback`	Un puntero a una función que se llama cuando se recibe una trama de enlace IEEE 802.15.4 o NULL para deshabilitar la devolución de llamada.
`[in] aCallbackContext`	Un puntero al contexto específico de la aplicación.

otLinkSetPollPeriod

otError otLinkSetPollPeriod(
  otInstance *aInstance,
  uint32_t aPollPeriod
)

Establecer / borrar el período de sondeo de datos externo / especificado por el usuario para el dispositivo final con sueño.

Nota: Esta función actualiza solo el período de encuesta del dispositivo final con sueño. Para actualizar el tiempo de espera del hijo, se otThreadSetChildTimeout() la función otThreadSetChildTimeout() .

Nota: El valor mínimo distinto de cero debe ser OPENTHREAD_CONFIG_MAC_MINIMUM_POLL_PERIOD (10ms). O cero para borrar el período de sondeo especificado por el usuario.

Nota: El valor especificado por el usuario no debe ser mayor que el valor máximo 0x3FFFFFF ((1 << 26) - 1) permitido; de lo contrario, sería recortado por el valor máximo.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aPollPeriod`	período de sondeo de datos en milisegundos.

Valores devueltos

`OT_ERROR_NONE`	El período de sondeo especificado por el usuario se estableció / borró con éxito.
`OT_ERROR_INVALID_ARGS`	Si unPollPeriod no es válido.

Ver también:
otLinkGetPollPeriod

otLinkSetPromiscuous

otError otLinkSetPromiscuous(
  otInstance *aInstance,
  bool aPromiscuous
)

Esta función habilita o deshabilita el modo promiscuo de la capa de enlace.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aPromiscuous`	Es true para habilitar el modo promiscuo, o false en caso contrario.

Valores devueltos

`OT_ERROR_NONE`	Modo promiscuo habilitado con éxito.
`OT_ERROR_INVALID_STATE`	No se pudo habilitar el modo promiscuo porque la interfaz Thread está habilitada.

otLinkSetSupportedChannelMask

otError otLinkSetSupportedChannelMask(
  otInstance *aInstance,
  uint32_t aChannelMask
)

Establezca la máscara de canal admitida de la capa MAC.

Esta función solo tiene éxito cuando los protocolos de subprocesos están deshabilitados.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aChannelMask`	La máscara de canal admitida (asignación de bit 0 o lsb al canal 0, etc.).

Valores devueltos

`OT_ERROR_NONE`	Configure correctamente la máscara de canal compatible.
`OT_ERROR_INVALID_STATE`	Los protocolos de subprocesos están habilitados.

Macros

OT_MAC_FILTER_FIXED_RSS_DISABLED

 OT_MAC_FILTER_FIXED_RSS_DISABLED 127

Se utiliza para indicar que no se estableció una intensidad de señal recibida fija.

OT_MAC_FILTER_ITERATOR_INIT

 OT_MAC_FILTER_ITERATOR_INIT 0

Inicializador para otMacFilterIterator.

OT_US_PER_TEN_SYMBOLS

 OT_US_PER_TEN_SYMBOLS 160

Los microsegundos por 10 símbolos.

Enlace

Resumen

Enumeraciones

Typedefs

Funciones

Estructuras

Enumeraciones

otMacFilterAddressMode

Typedefs

otActiveScanResult

otEnergyScanResult

otHandleActiveScanResult

otHandleEnergyScanResult

otLinkPcapCallback

otMacCounters

otMacFilterAddressMode

otMacFilterEntry

otMacFilterIterator

otThreadLinkInfo

Funciones

otLinkActiveScan

otLinkConvertLinkQualityToRss

otLinkConvertRssToLinkQuality

otLinkCslGetChannel

otLinkCslGetPeriod

otLinkCslGetTimeout

otLinkCslSetChannel

otLinkCslSetPeriod

otLinkCslSetTimeout

otLinkEnergyScan

otLinkFilterAddAddress

otLinkFilterAddRssIn

otLinkFilterClearAddresses

otLinkFilterClearAllRssIn

otLinkFilterClearDefaultRssIn

otLinkFilterGetAddressMode

otLinkFilterGetNextAddress

otLinkFilterGetNextRssIn

otLinkFilterRemoveAddress

otLinkFilterRemoveRssIn

otLinkFilterSetAddressMode

otLinkFilterSetDefaultRssIn

otLinkGetCcaFailureRate

otLinkGetChannel

otLinkGetCounters

otLinkGetExtendedAddress

otLinkGetFactoryAssignedIeeeEui64

otLinkGetMaxFrameRetriesDirect

otLinkGetMaxFrameRetriesIndirect

otLinkGetPanId

otLinkGetPollPeriod

otLinkGetShortAddress

otLinkGetSupportedChannelMask

otLinkGetTxDirectRetrySuccessHistogram

otLinkGetTxIndirectRetrySuccessHistogram

otLinkIsActiveScanInProgress

otLinkIsEnabled

otLinkIsEnergyScanInProgress

otLinkIsInTransmitState

otLinkIsPromiscuous

otLinkOutOfBandTransmitRequest

otLinkResetCounters

otLinkResetTxRetrySuccessHistogram

otLinkSendDataRequest

otLinkSetChannel

otLinkSetEnabled

otLinkSetExtendedAddress

otLinkSetMaxFrameRetriesDirect

otLinkSetMaxFrameRetriesIndirect

otLinkSetPanId

otLinkSetPcapCallback

otLinkSetPollPeriod

otLinkSetPromiscuous

otLinkSetSupportedChannelMask

Macros

OT_MAC_FILTER_FIXED_RSS_DISABLED

OT_MAC_FILTER_ITERATOR_INIT

OT_US_PER_TEN_SYMBOLS