Vínculo

Este módulo incluye funciones que controlan la configuración de las capas de vínculos.

Resumen

Enumeraciones
otMacFilterAddressMode{
  OT_MAC_FILTER_ADDRESS_MODE_DISABLED,
  OT_MAC_FILTER_ADDRESS_MODE_ALLOWLIST,
  OT_MAC_FILTER_ADDRESS_MODE_DENYLIST
} 		enum
Define el modo de dirección del filtro de MAC.

Typedefs
otActiveScanResult typedef
Representa un pixel contador IEEE 802.15.4 recibido.
otEnergyScanResult typedef
Representa un resultado del análisis de energía.
otHandleActiveScanResult)(otActiveScanResult *aResult, void *aContext) typedef
void(*
Se llama al puntero durante un análisis activo de IEEE 802.15.4 cuando se recibe una baliza IEEE 802.15.4 o se completa el análisis.
otHandleEnergyScanResult)(otEnergyScanResult *aResult, void *aContext) typedef
void(*
Se llama al puntero durante un análisis de energía de IEEE 802.15.4 cuando el resultado de un canal está listo o se completa la búsqueda.
otLinkPcapCallback)(const otRadioFrame *aFrame, bool aIsTx, void *aContext) typedef
void(*
Se llama al puntero cuando se recibe una trama IEEE 802.15.4.
otMacCounters typedef
struct otMacCounters
Representa los contadores de la capa de MAC.
otMacFilterAddressMode typedef
Define el modo de dirección del filtro de MAC.
otMacFilterEntry typedef
Representa una entrada de filtro de Mac.
otMacFilterIterator typedef
uint8_t
Se usa para iterar a través de las entradas de filtro de MAC.
otThreadLinkInfo typedef
Representa información específica del vínculo para los mensajes recibidos de la radio de Thread.

remotas
otLinkActiveScan(otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleActiveScanResult aCallback, void *aCallbackContext)
Inicia un análisis activo de IEEE 802.15.4.
otLinkConvertLinkQualityToRss(otInstance *aInstance, uint8_t aLinkQuality)
int8_t
Convierte la calidad de los vínculos a la intensidad de señal recibida típica.
otLinkConvertRssToLinkQuality(otInstance *aInstance, int8_t aRss)
uint8_t
Convierte la intensidad de la señal recibida en calidad de vínculo.
otLinkEnergyScan(otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleEnergyScanResult aCallback, void *aCallbackContext)
Inicia un análisis de energía según el estándar IEEE 802.15.4.
otLinkFilterAddAddress(otInstance *aInstance, const otExtAddress *aExtAddress)
Agrega un filtro de dirección extendida a MAC.
otLinkFilterAddRssIn(otInstance *aInstance, const otExtAddress *aExtAddress, int8_t aRss)
Agrega la dirección extendida especificada a la lista RssIn (o modifica una dirección existente en la lista RssIn) y establece la entrada de intensidad de la señal recibida (en dBm) para los mensajes de esa dirección.
otLinkFilterClearAddresses(otInstance *aInstance)
void
Borra todas las direcciones extendidas del filtro de MAC.
otLinkFilterClearAllRssIn(otInstance *aInstance)
void
Borra todas las entradas de intensidad de la señal recibida (rss) y del indicador de calidad del vínculo (lqi) (incluidos los valores predeterminados) de la lista RssIn.
otLinkFilterClearDefaultRssIn(otInstance *aInstance)
void
Borra cualquier intensidad de señal recibida predeterminada (en dBm) que se haya establecido previamente en el filtro de MAC.
otLinkFilterGetAddressMode(otInstance *aInstance)
Obtiene el modo de dirección del filtro de MAC.
otLinkFilterGetNextAddress(otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry)
Obtiene una entrada de filtro de direcciones en uso.
otLinkFilterGetNextRssIn(otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry)
Obtiene una entrada de filtro RssIn en uso.
otLinkFilterRemoveAddress(otInstance *aInstance, const otExtAddress *aExtAddress)
void
Quita una dirección extendida del filtro de MAC.
otLinkFilterRemoveRssIn(otInstance *aInstance, const otExtAddress *aExtAddress)
void
Quita la dirección extendida especificada de la lista RssIn.
otLinkFilterSetAddressMode(otInstance *aInstance, otMacFilterAddressMode aMode)
void
Establece el modo de dirección del filtro de MAC.
otLinkFilterSetDefaultRssIn(otInstance *aInstance, int8_t aRss)
void
Fija la intensidad de la señal recibida de forma predeterminada (en dBm) en el filtro de MAC.
otLinkGetCcaFailureRate(otInstance *aInstance)
uint16_t
Muestra la tasa de reprobación actual de CCA (Clear Channel Assessment).
otLinkGetChannel(otInstance *aInstance)
uint8_t
Obtener el canal IEEE 802.15.4
otLinkGetCounters(otInstance *aInstance)
const otMacCounters *
Obtén los contadores de la capa de MAC.
otLinkGetCslChannel(otInstance *aInstance)
uint8_t
Obtiene el canal de CSL.
otLinkGetCslPeriod(otInstance *aInstance)
uint32_t
Obtiene el período de CSL en microsegundos.
otLinkGetCslTimeout(otInstance *aInstance)
uint32_t
Obtiene el tiempo de espera de CSL.
otLinkGetExtendedAddress(otInstance *aInstance)
const otExtAddress *
Obtiene la dirección extendida IEEE 802.15.4.
otLinkGetFactoryAssignedIeeeEui64(otInstance *aInstance, otExtAddress *aEui64)
void
Obtén el EUI-64 del IEEE asignado de fábrica.
otLinkGetMaxFrameRetriesDirect(otInstance *aInstance)
uint8_t
Muestra la cantidad máxima de reintentos de trama durante la transmisión directa.
otLinkGetMaxFrameRetriesIndirect(otInstance *aInstance)
uint8_t
Muestra la cantidad máxima de reintentos de trama durante la transmisión indirecta.
otLinkGetPanId(otInstance *aInstance)
Obtén el ID del número PAN IEEE 802.15.4.
otLinkGetPollPeriod(otInstance *aInstance)
uint32_t
Obtén el período de la encuesta de datos del dispositivo con extremo de sueño.
otLinkGetRegion(otInstance *aInstance, uint16_t *aRegionCode)
Obtén el código de región.
otLinkGetShortAddress(otInstance *aInstance)
Obtén la dirección corta de IEEE 802.15.4.
otLinkGetSupportedChannelMask(otInstance *aInstance)
uint32_t
Obtén la máscara de canal compatible de la capa de MAC.
otLinkGetTxDirectRetrySuccessHistogram(otInstance *aInstance, uint8_t *aNumberOfEntries)
const uint32_t *
Obtiene el histograma de los reintentos de un solo paquete directo hasta que se realiza con éxito.
otLinkGetTxIndirectRetrySuccessHistogram(otInstance *aInstance, uint8_t *aNumberOfEntries)
const uint32_t *
Obtiene el histograma de los reintentos de un solo paquete indirecto hasta que se realiza con éxito.
otLinkIsActiveScanInProgress(otInstance *aInstance)
bool
Indica si un análisis activo de IEEE 802.15.4 está en curso o no.
otLinkIsCslEnabled(otInstance *aInstance)
bool
Indica si el CSL está habilitado o no.
otLinkIsCslSupported(otInstance *aInstance)
bool
Indica si el dispositivo está conectado a un padre que admite CSL.
otLinkIsEnabled(otInstance *aInstance)
bool
Indica si la capa de vínculo está habilitada o no.
otLinkIsEnergyScanInProgress(otInstance *aInstance)
bool
Indica si hay un análisis de energía IEEE 802.15.4 en curso o no.
otLinkIsInTransmitState(otInstance *aInstance)
bool
Indica si un MAC IEEE 802.15.4 se encuentra o no en estado de transmisión.
otLinkIsPromiscuous(otInstance *aInstance)
bool
Indica si el modo promiscuo está habilitado o no en la capa del vínculo.
otLinkIsRadioFilterEnabled(otInstance *aInstance)
bool
Indica si el filtro de radio IEEE 802.15.4 está habilitado o no.
otLinkResetCounters(otInstance *aInstance)
void
Restablece los contadores de la capa de MAC.
otLinkResetTxRetrySuccessHistogram(otInstance *aInstance)
void
Borra las estadísticas de histogramas de las transmisiones directas e indirectas.
otLinkSendDataRequest(otInstance *aInstance)
Pone en cola un mensaje de solicitud de datos IEEE 802.15.4 para su transmisión.
otLinkSendEmptyData(otInstance *aInstance)
Indica al dispositivo que envíe una trama de datos IEEE 802.15.4 vacía.
otLinkSetChannel(otInstance *aInstance, uint8_t aChannel)
Establece el canal IEEE 802.15.4.
otLinkSetCslChannel(otInstance *aInstance, uint8_t aChannel)
Establece el canal CSL.
otLinkSetCslPeriod(otInstance *aInstance, uint32_t aPeriod)
Establece el período de CSL en microsegundos.
otLinkSetCslTimeout(otInstance *aInstance, uint32_t aTimeout)
Establece el tiempo de espera de CSL en segundos.
otLinkSetEnabled(otInstance *aInstance, bool aEnable)
Habilita o inhabilita la capa de vínculos.
otLinkSetExtendedAddress(otInstance *aInstance, const otExtAddress *aExtAddress)
Establece la dirección extendida IEEE 802.15.4.
otLinkSetMaxFrameRetriesDirect(otInstance *aInstance, uint8_t aMaxFrameRetriesDirect)
void
Establece el número máximo de reintentos de trama durante la transmisión directa.
otLinkSetMaxFrameRetriesIndirect(otInstance *aInstance, uint8_t aMaxFrameRetriesIndirect)
void
Establece el número máximo de reintentos de trama durante una transmisión indirecta.
otLinkSetPanId(otInstance *aInstance, otPanId aPanId)
Establece el ID del número PAN IEEE 802.15.4.
otLinkSetPcapCallback(otInstance *aInstance, otLinkPcapCallback aPcapCallback, void *aCallbackContext)
void
Registra una devolución de llamada para proporcionar marcos IEEE 802.15.4 sin procesar recibidos.
otLinkSetPollPeriod(otInstance *aInstance, uint32_t aPollPeriod)
Configurar o borrar el período del sondeo de datos externos o especificados por el usuario para el dispositivo final con sueño
otLinkSetPromiscuous(otInstance *aInstance, bool aPromiscuous)
Habilita o inhabilita el modo promiscuo de la capa de vínculo.
otLinkSetRadioFilterEnabled(otInstance *aInstance, bool aFilterEnabled)
void
Habilita o inhabilita el modo de filtro de radio IEEE 802.15.4.
otLinkSetRegion(otInstance *aInstance, uint16_t aRegionCode)
Establece el código de región.
otLinkSetSupportedChannelMask(otInstance *aInstance, uint32_t aChannelMask)
Configura la máscara de canal compatible de la capa de MAC.

Structs
otActiveScanResult

Representa un pixel contador IEEE 802.15.4 recibido.

otEnergyScanResult

Representa un resultado del análisis de energía.

otMacCounters

Representa los contadores de la capa de MAC.

otMacFilterEntry

Representa una entrada de filtro de Mac.

otThreadLinkInfo

Representa información específica del vínculo para los mensajes recibidos de la radio de Thread.

Enumeraciones

otMacFilterAddressMode

 otMacFilterAddressMode

Define el modo de dirección del filtro de MAC.

Propiedades
OT_MAC_FILTER_ADDRESS_MODE_ALLOWLIST

Se habilitó el modo de filtro de direcciones de la lista de entidades permitidas.

OT_MAC_FILTER_ADDRESS_MODE_DENYLIST

El modo de filtro de direcciones de la lista de bloqueo está habilitado.

OT_MAC_FILTER_ADDRESS_MODE_DISABLED

El filtro de direcciones está inhabilitado.

Typedefs

otActiveScanResult

struct otActiveScanResult otActiveScanResult

Representa un pixel contador IEEE 802.15.4 recibido.

otEnergyScanResult

struct otEnergyScanResult otEnergyScanResult

Representa un resultado del análisis de energía.

otHandleActiveScanResult

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

Se llama al puntero durante un análisis activo de IEEE 802.15.4 cuando se recibe una baliza IEEE 802.15.4 o se completa el análisis.

Detalles
Parámetros
[in] aResult
Un puntero válido para la información del pixel contador o NULL cuando finaliza la búsqueda activa.
[in] aContext
Un puntero para el contexto específico de la aplicación.

otHandleEnergyScanResult

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

Se llama al puntero durante un análisis de energía de IEEE 802.15.4 cuando el resultado de un canal está listo o se completa la búsqueda.

Detalles
Parámetros
[in] aResult
Un puntero válido para la información del resultado del análisis de energía o NULL cuando este finaliza.
[in] aContext
Un puntero para el contexto específico de la aplicación.

otLinkPcapCallback

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

Se llama al puntero cuando se recibe una trama IEEE 802.15.4.

Detalles
Parámetros
[in] aFrame
Un puntero al marco IEEE 802.15.4 recibido.
[in] aIsTx
Si este fotograma se transmite, no se recibe.
[in] aContext
Un puntero para el contexto específico de la aplicación.

otMacCounters

struct otMacCounters otMacCounters

Representa los contadores de la capa de MAC.

otMacFilterAddressMode

enum otMacFilterAddressMode otMacFilterAddressMode

Define el modo de dirección del filtro de MAC.

otMacFilterEntry

struct otMacFilterEntry otMacFilterEntry

Representa una entrada de filtro de Mac.

otMacFilterIterator

uint8_t otMacFilterIterator

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

otThreadLinkInfo

struct otThreadLinkInfo otThreadLinkInfo

Representa información específica del vínculo para los mensajes recibidos de la radio de Thread.

remotas

otLinkActiveScan

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

Inicia un análisis activo de IEEE 802.15.4.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aScanChannels
Vector de bits que indica qué canales buscar (p. ej., OT_CHANNEL_11_MASK)
[in] aScanDuration
Es el tiempo en milisegundos que se invierte en analizar cada canal.
[in] aCallback
Un puntero a una función a la que se llama cuando recibe una baliza o se completa el escaneo.
[in] aCallbackContext
Un puntero para el contexto específico de la aplicación.
Valores que se muestran
OT_ERROR_NONE
Se aceptó la solicitud de Active Scan.
OT_ERROR_BUSY
Ya se está realizando un análisis activo.

otLinkConvertLinkQualityToRss

int8_t otLinkConvertLinkQualityToRss(
  otInstance *aInstance,
  uint8_t aLinkQuality
)

Convierte la calidad de los vínculos a la intensidad de señal recibida típica.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aLinkQuality
El valor LinkQuality, debe estar dentro del rango [0,3].
Qué muestra
La plataforma típica recibió la asignación de intensidad de señal a aLinkQuality.

otLinkConvertRssToLinkQuality

uint8_t otLinkConvertRssToLinkQuality(
  otInstance *aInstance,
  int8_t aRss
)

Convierte la intensidad de la señal recibida en calidad de vínculo.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aRss
El valor de intensidad de la señal recibida que se convertirá.
Qué muestra
Asignación del valor de calidad del vínculo a aRss.

otLinkEnergyScan

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

Inicia un análisis de energía según el estándar IEEE 802.15.4.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aScanChannels
Un vector de bits que indica en qué canales se debe realizar el análisis de energía.
[in] aScanDuration
Es el tiempo en milisegundos que se invierte en analizar cada canal.
[in] aCallback
Un puntero a una función que se llama para pasar el resultado del análisis cuando se indica que se completó.
[in] aCallbackContext
Un puntero para el contexto específico de la aplicación.
Valores que se muestran
OT_ERROR_NONE
Aceptó la solicitud de análisis de energía.
OT_ERROR_BUSY
No se pudo iniciar el análisis de energía.

otLinkFilterAddAddress

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

Agrega un filtro de dirección extendida a MAC.

Está disponible cuando se habilita la configuración de OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aExtAddress
Un puntero a la dirección extendida (NO DEBE ser NULL).
Valores que se muestran
OT_ERROR_NONE
Se agregó correctamente aExtAddress al filtro de MAC.
OT_ERROR_NO_BUFS
No existe ninguna entrada disponible.

otLinkFilterAddRssIn

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

Agrega la dirección extendida especificada a la lista RssIn (o modifica una dirección existente en la lista RssIn) y establece la entrada de intensidad de la señal recibida (en dBm) para los mensajes de esa dirección.

No es necesario que la dirección extendida esté en el filtro address allowlist/denylist para establecer rss.

Está disponible cuando se habilita la configuración de OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aExtAddress
Un puntero para la dirección extendida IEEE 802.15.4. NO DEBE ser NULO.
[in] aRss
La intensidad de la señal recibida (en dBm).
Valores que se muestran
OT_ERROR_NONE
Se agregó correctamente una entrada para aExtAddress y aRss.
OT_ERROR_NO_BUFS
No existe ninguna entrada disponible.

otLinkFilterClearAddresses

void otLinkFilterClearAddresses(
  otInstance *aInstance
)

Borra todas las direcciones extendidas del filtro de MAC.

Está disponible cuando se habilita la configuración de OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.

otLinkFilterClearAllRssIn

void otLinkFilterClearAllRssIn(
  otInstance *aInstance
)

Borra todas las entradas de intensidad de la señal recibida (rss) y del indicador de calidad del vínculo (lqi) (incluidos los valores predeterminados) de la lista RssIn.

Si realizas esta acción, todas las direcciones extendidas usarán la señal al aire.

Está disponible cuando se habilita la configuración de OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.

otLinkFilterClearDefaultRssIn

void otLinkFilterClearDefaultRssIn(
  otInstance *aInstance
)

Borra cualquier intensidad de señal recibida predeterminada (en dBm) que se haya establecido previamente en el filtro de MAC.

Está disponible cuando se habilita la configuración de OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.

otLinkFilterGetAddressMode

otMacFilterAddressMode otLinkFilterGetAddressMode(
  otInstance *aInstance
)

Obtiene el modo de dirección del filtro de MAC.

Está disponible cuando se habilita la configuración de OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
el modo de dirección.

otLinkFilterGetNextAddress

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

Obtiene una entrada de filtro de direcciones en uso.

Está disponible cuando se habilita la configuración de OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in,out] aIterator
Un puntero al contexto del iterador del filtro de MAC. Para obtener la primera entrada de filtro de direcciones en uso, se debe configurar como OT_MAC_FILTER_ITERATOR_INIT. NO DEBE ser NULO.
[out] aEntry
Un puntero hacia donde se coloca la información. NO DEBE ser NULO.
Valores que se muestran
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
)

Obtiene una entrada de filtro RssIn en uso.

Está disponible cuando se habilita la configuración de OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in,out] aIterator
Un puntero al contexto del iterador del filtro de MAC. NO DEBE ser NULO. Para obtener la primera entrada, se debe configurar en OT_MAC_FILTER_ITERATOR_INIT.
[out] aEntry
Un puntero hacia donde se coloca la información. La última entrada tendría la dirección extendida como 0xff para indicar la intensidad de la señal recibida predeterminada si se estableció. aEntry NO DEBE ser NULO.
Valores que se muestran
OT_ERROR_NONE
Se recuperó correctamente la siguiente entrada.
OT_ERROR_NOT_FOUND
No existe ninguna entrada posterior.

otLinkFilterRemoveAddress

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

Quita una dirección extendida del filtro de MAC.

Está disponible cuando se habilita la configuración de OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aExtAddress
Un puntero a la dirección extendida (NO DEBE ser NULL).

otLinkFilterRemoveRssIn

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

Quita la dirección extendida especificada de la lista RssIn.

Una vez que se quite de la lista RssIn, esta dirección MAC en su lugar usará la configuración predeterminada de rss y lqi (suponiendo que se hayan establecido los valores predeterminados). (Si no se establecieron valores predeterminados, se utiliza la señal inalámbrica).

Está disponible cuando se habilita la configuración de OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.

No se realiza ninguna acción si no hay ninguna entrada existente en la lista RssIn que coincida con la dirección extendida especificada.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aExtAddress
Un puntero para la dirección extendida IEEE 802.15.4. NO DEBE ser NULO.

otLinkFilterSetAddressMode

void otLinkFilterSetAddressMode(
  otInstance *aInstance,
  otMacFilterAddressMode aMode
)

Establece el modo de dirección del filtro de MAC.

Está disponible cuando se habilita la configuración de OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aMode
El modo de dirección que se establecerá.

otLinkFilterSetDefaultRssIn

void otLinkFilterSetDefaultRssIn(
  otInstance *aInstance,
  int8_t aRss
)

Fija la intensidad de la señal recibida de forma predeterminada (en dBm) en el filtro de MAC.

Está disponible cuando se habilita la configuración de OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.

El valor de RSS predeterminado se utiliza para todas las tramas recibidas de las direcciones para las que no hay una entrada RSS-IN explícita en la lista de Filtro (agregada mediante otLinkFilterAddRssIn()).

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aRss
La intensidad de la señal recibida (en dBm) predeterminada que se establecerá.

otLinkGetCcaFailureRate

uint16_t otLinkGetCcaFailureRate(
  otInstance *aInstance
)

Muestra la tasa de reprobación actual de CCA (Clear Channel Assessment).

La velocidad se mantiene durante un período de (aproximadamente) la última transmisión de tramas de OPENTHREAD_CONFIG_CCA_FAILURE_RATE_AVERAGING_WINDOW.

Detalles
Qué muestra
Es la tasa de fallas de CCA con el valor máximo 0xffff que corresponde a una tasa de fallas del 100%.

otLinkGetChannel

uint8_t otLinkGetChannel(
  otInstance *aInstance
)

Obtener el canal IEEE 802.15.4

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El canal IEEE 802.15.4
Consulta también:
otLinkSetChannel

otLinkGetCounters

const otMacCounters * otLinkGetCounters(
  otInstance *aInstance
)

Obtén los contadores de la capa de MAC.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Un puntero para los contadores de la capa de MAC.

otLinkGetCslChannel

uint8_t otLinkGetCslChannel(
  otInstance *aInstance
)

Obtiene el canal de CSL.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El canal de CSL

otLinkGetCslPeriod

uint32_t otLinkGetCslPeriod(
  otInstance *aInstance
)

Obtiene el período de CSL en microsegundos.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El período de CSL en microsegundos.

otLinkGetCslTimeout

uint32_t otLinkGetCslTimeout(
  otInstance *aInstance
)

Obtiene el tiempo de espera de CSL.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El tiempo de espera del CSL en segundos.

otLinkGetExtendedAddress

const otExtAddress * otLinkGetExtendedAddress(
  otInstance *aInstance
)

Obtiene la dirección extendida IEEE 802.15.4.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Un puntero para la dirección extendida IEEE 802.15.4.

otLinkGetFactoryAssignedIeeeEui64

void otLinkGetFactoryAssignedIeeeEui64(
  otInstance *aInstance,
  otExtAddress *aEui64
)

Obtén el EUI-64 del IEEE asignado de fábrica.

Detalles
Parámetros
[in] aInstance
Un puntero para la instancia de OpenThread.
[out] aEui64
Un puntero hacia el lugar en el que se coloca el EUI-64 del IEEE asignado de fábrica.

otLinkGetMaxFrameRetriesDirect

uint8_t otLinkGetMaxFrameRetriesDirect(
  otInstance *aInstance
)

Muestra la cantidad máxima de reintentos de trama durante la transmisión directa.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
La cantidad máxima de reintentos durante la transmisión directa.

otLinkGetMaxFrameRetriesIndirect

uint8_t otLinkGetMaxFrameRetriesIndirect(
  otInstance *aInstance
)

Muestra la cantidad máxima de reintentos de trama durante la transmisión indirecta.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
La cantidad máxima de reintentos durante una transmisión indirecta.

otLinkGetPanId

otPanId otLinkGetPanId(
  otInstance *aInstance
)

Obtén el ID del número PAN IEEE 802.15.4.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El ID PAN IEEE 802.15.4.
Consulta también:
otLinkSetPanId

otLinkGetPollPeriod

uint32_t otLinkGetPollPeriod(
  otInstance *aInstance
)

Obtén el período de la encuesta de datos del dispositivo con extremo de sueño.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Es el período de sondeo de datos del dispositivo final con sueño en milisegundos.
Consulta también:
otLinkSetPollPeriod

otLinkGetRegion

otError otLinkGetRegion(
  otInstance *aInstance,
  uint16_t *aRegionCode
)

Obtén el código de región.

El formato de región de radio es la representación ASCII de 2 bytes del código ISO 3166 alfa-2.

Detalles
Parámetros
[in] aInstance
Estructura de instancias de OpenThread
[out] aRegionCode
Es el código regional de la radio. El aRegionCode >> 8 es el primer carácter ASCII y aRegionCode & 0xff es el segundo.
Valores que se muestran
OT_ERROR_INVALID_ARGS
aRegionCode es nullptr.
OT_ERROR_FAILED
Otros errores específicos de la plataforma
OT_ERROR_NONE
El código regional se obtuvo correctamente.
OT_ERROR_NOT_IMPLEMENTED
La función no está implementada.

otLinkGetShortAddress

otShortAddress otLinkGetShortAddress(
  otInstance *aInstance
)

Obtén la dirección corta de IEEE 802.15.4.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Un puntero para la dirección corta IEEE 802.15.4.

otLinkGetSupportedChannelMask

uint32_t otLinkGetSupportedChannelMask(
  otInstance *aInstance
)

Obtén la máscara de canal compatible de la capa de MAC.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
La máscara de canal compatible como uint32_t con el bit 0 (lsb) asignado al canal 0, el bit 1 al canal 1, así sucesivamente.

otLinkGetTxDirectRetrySuccessHistogram

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

Obtiene el histograma de los reintentos de un solo paquete directo hasta que se realiza con éxito.

Es válido cuando se habilita la configuración OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aNumberOfEntries
Un puntero hacia donde se coloca el tamaño del array de histograma que se muestra.
Qué muestra
Un puntero para el histograma de reintentos (en forma de un array). El elemento enésimo indica que el paquete se envió con el enésimo reintento.

otLinkGetTxIndirectRetrySuccessHistogram

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

Obtiene el histograma de los reintentos de un solo paquete indirecto hasta que se realiza con éxito.

Es válido cuando se habilita la configuración OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aNumberOfEntries
Un puntero hacia donde se coloca el tamaño del array de histograma que se muestra.
Qué muestra
Un puntero para el histograma de reintentos (en forma de un array). El elemento enésimo indica que el paquete se envió con el enésimo reintento.

otLinkIsActiveScanInProgress

bool otLinkIsActiveScanInProgress(
  otInstance *aInstance
)

Indica si un análisis activo de IEEE 802.15.4 está en curso o no.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
true si un análisis activo de IEEE 802.15.4 está en curso; de lo contrario, es falso.

otLinkIsCslEnabled

bool otLinkIsCslEnabled(
  otInstance *aInstance
)

Indica si el CSL está habilitado o no.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores que se muestran
TRUE
La capa de vínculo está habilitada para CSL.
FALSE
La capa de vínculo no está habilitada para CSL.

otLinkIsCslSupported

bool otLinkIsCslSupported(
  otInstance *aInstance
)

Indica si el dispositivo está conectado a un padre que admite CSL.

Detalles
Valores que se muestran
TRUE
Si la madre o el padre admite la CSL
FALSE
Si la madre o el padre no admite la CSL.

otLinkIsEnabled

bool otLinkIsEnabled(
  otInstance *aInstance
)

Indica si la capa de vínculo está habilitada o no.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores que se muestran
TRUE
La capa de vínculos está habilitada.
FALSE
La capa de vínculo no está habilitada.

otLinkIsEnergyScanInProgress

bool otLinkIsEnergyScanInProgress(
  otInstance *aInstance
)

Indica si hay un análisis de energía IEEE 802.15.4 en curso o no.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
true si un análisis de energía IEEE 802.15.4 está en curso; de lo contrario, es falso.

otLinkIsInTransmitState

bool otLinkIsInTransmitState(
  otInstance *aInstance
)

Indica si un MAC IEEE 802.15.4 se encuentra o no en estado de transmisión.

El módulo de MAC se encuentra en estado de transmisión durante el procedimiento de CSMA/CA, CCA, los datos, la baliza o la transmisión de tramas de solicitud de datos y recibe una ACK de una trama transmitida. El módulo de MAC no se encuentra 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 para una instancia de OpenThread.
Qué muestra
true si un MAC IEEE 802.15.4 está en estado de transmisión; de lo contrario, es falso.

otLinkIsPromiscuous

bool otLinkIsPromiscuous(
  otInstance *aInstance
)

Indica si el modo promiscuo está habilitado o no en la capa del vínculo.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores que se muestran
TRUE
El modo promiscuo está habilitado.
FALSE
El modo promiscuo no está habilitado.

otLinkIsRadioFilterEnabled

bool otLinkIsRadioFilterEnabled(
  otInstance *aInstance
)

Indica si el filtro de radio IEEE 802.15.4 está habilitado o no.

Está disponible cuando se habilita la configuración de OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.

Detalles
Valores que se muestran
TRUE
Si el filtro de radio está habilitado.
FALSE
Si el filtro de radio está inhabilitado.

otLinkResetCounters

void otLinkResetCounters(
  otInstance *aInstance
)

Restablece los contadores de la capa de MAC.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.

otLinkResetTxRetrySuccessHistogram

void otLinkResetTxRetrySuccessHistogram(
  otInstance *aInstance
)

Borra las estadísticas de histogramas de las transmisiones directas e indirectas.

Es válido cuando se habilita la configuración OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.

otLinkSendDataRequest

otError otLinkSendDataRequest(
  otInstance *aInstance
)

Pone en cola un mensaje de solicitud de datos IEEE 802.15.4 para su transmisión.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores que se muestran
OT_ERROR_NONE
Se puso correctamente en cola un mensaje de solicitud de datos IEEE 802.15.4.
OT_ERROR_INVALID_STATE
El dispositivo no está en modo rx-off-when-idle.
OT_ERROR_NO_BUFS
No hay suficientes búferes de mensaje disponibles.

otLinkSendEmptyData

otError otLinkSendEmptyData(
  otInstance *aInstance
)

Indica al dispositivo que envíe una trama de datos IEEE 802.15.4 vacía.

Solo es compatible con un dispositivo Rx-Off-When-Idle para enviar un marco de datos vacío a su elemento superior. Nota: Solo está disponible cuando se habilita OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores que se muestran
OT_ERROR_NONE
Se puso correctamente un mensaje vacío en la cola.
OT_ERROR_INVALID_STATE
El dispositivo no está en modo Rx-Off-When-Idle.
OT_ERROR_NO_BUFS
No hay suficientes búferes de mensaje disponibles.

otLinkSetChannel

otError otLinkSetChannel(
  otInstance *aInstance,
  uint8_t aChannel
)

Establece el canal IEEE 802.15.4.

Solo tiene éxito cuando los protocolos de Thread están inhabilitados. 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 para una instancia de OpenThread.
[in] aChannel
El canal IEEE 802.15.4
Valores que se muestran
OT_ERROR_NONE
El canal se configuró correctamente.
OT_ERROR_INVALID_ARGS
Si aChannel no está dentro del rango [11, 26] o no está en la máscara de canal compatible.
OT_ERROR_INVALID_STATE
Los protocolos de subprocesos están habilitados.
Consulta también:
otLinkGetChannel

otLinkSetCslChannel

otError otLinkSetCslChannel(
  otInstance *aInstance,
  uint8_t aChannel
)

Establece el canal CSL.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aChannel
El canal de muestra de CSL. El valor del canal debe ser 0 (Establecer canal CSL sin especificar) o dentro del rango [1, 10] (si se admite 915 MHz) y 11, 26.
Valores que se muestran
OT_ERROR_NONE
Los parámetros de CSL se establecieron correctamente.
OT_ERROR_INVALID_ARGS
aChannel no es válido.

otLinkSetCslPeriod

otError otLinkSetCslPeriod(
  otInstance *aInstance,
  uint32_t aPeriod
)

Establece el período de CSL en microsegundos.

Para inhabilitar la CSL, establece este parámetro en 0.

El período de CSL DEBE ser un múltiplo de OT_LINK_CSL_PERIOD_TEN_SYMBOLS_UNIT_IN_USEC; de lo contrario, se muestra OT_ERROR_INVALID_ARGS.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aPeriod
El período de CSL en microsegundos.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente el período de CSL.
OT_ERROR_INVALID_ARGS
Período de CSL no válido

otLinkSetCslTimeout

otError otLinkSetCslTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Establece el tiempo de espera de CSL en segundos.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aTimeout
El tiempo de espera del CSL en segundos.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente el tiempo de espera del CSL.
OT_ERROR_INVALID_ARGS
El tiempo de espera del CSL no es válido.

otLinkSetEnabled

otError otLinkSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Habilita o inhabilita la capa de vínculos.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aEnable
true para habilitar la capa de vínculo o false de lo contrario.
Valores que se muestran
OT_ERROR_NONE
Se habilitó o inhabilitó correctamente la capa de vínculo.
OT_ERROR_INVALID_STATE
No se pudo inhabilitar la capa de vínculo porque la interfaz Thread está habilitada.

otLinkSetExtendedAddress

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

Establece la dirección extendida IEEE 802.15.4.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aExtAddress
Un puntero para la dirección extendida IEEE 802.15.4.
Valores que se muestran
OT_ERROR_NONE
Se configuró 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
)

Establece el número máximo de reintentos de trama durante la transmisión directa.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aMaxFrameRetriesDirect
La cantidad máxima de reintentos durante la transmisión directa.

otLinkSetMaxFrameRetriesIndirect

void otLinkSetMaxFrameRetriesIndirect(
  otInstance *aInstance,
  uint8_t aMaxFrameRetriesIndirect
)

Establece el número máximo de reintentos de trama durante una transmisión indirecta.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aMaxFrameRetriesIndirect
La cantidad máxima de reintentos durante una transmisión indirecta.

otLinkSetPanId

otError otLinkSetPanId(
  otInstance *aInstance,
  otPanId aPanId
)

Establece el ID del número PAN IEEE 802.15.4.

Solo tiene éxito cuando los protocolos de Thread están inhabilitados. 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 para una instancia de OpenThread.
[in] aPanId
El ID PAN IEEE 802.15.4.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente el ID del PAN.
OT_ERROR_INVALID_ARGS
Si aPanId no está en el rango [0, 65534].
OT_ERROR_INVALID_STATE
Los protocolos de subprocesos están habilitados.
Consulta también:
otLinkGetPanId

otLinkSetPcapCallback

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

Registra una devolución de llamada para proporcionar marcos IEEE 802.15.4 sin procesar recibidos.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aPcapCallback
Un puntero a una función a la que se llama cuando se recibe un marco de vínculo IEEE 802.15.4 o NULL para inhabilitar la devolución de llamada.
[in] aCallbackContext
Un puntero para el contexto específico de la aplicación.

otLinkSetPollPeriod

otError otLinkSetPollPeriod(
  otInstance *aInstance,
  uint32_t aPollPeriod
)

Configurar o borrar el período del sondeo de datos externos o especificados por el usuario para el dispositivo final con sueño

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aPollPeriod
del período de sondeo de datos en milisegundos.
Valores que se muestran
OT_ERROR_NONE
Se estableció o borró correctamente el período de encuesta especificado por el usuario.
OT_ERROR_INVALID_ARGS
Si aPollPeriod no es válido.
Consulta también:
otLinkGetPollPeriod

otLinkSetPromiscuous

otError otLinkSetPromiscuous(
  otInstance *aInstance,
  bool aPromiscuous
)

Habilita o inhabilita el modo promiscuo de la capa de vínculo.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aPromiscuous
true para habilitar el modo promiscuo o false de lo contrario.
Valores que se muestran
OT_ERROR_NONE
Se habilitó correctamente el modo promiscuo.
OT_ERROR_INVALID_STATE
No se pudo habilitar el modo promiscuo porque la interfaz Thread está habilitada.

otLinkSetRadioFilterEnabled

void otLinkSetRadioFilterEnabled(
  otInstance *aInstance,
  bool aFilterEnabled
)

Habilita o inhabilita el modo de filtro de radio IEEE 802.15.4.

Está disponible cuando se habilita la configuración de OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.

El filtro de radio se utiliza principalmente para realizar pruebas. Se puede usar para bloquear temporalmente todos los archivos tx/rx en la radio 802.15.4. Cuando se habilita el filtro de radio, la radio se suspende en lugar de recibir (para garantizar que el dispositivo no reciba ningún fotograma ni ninguna confirmación de envío). Además, las solicitudes de transmisión de trama se devuelven de inmediato sin enviar la trama por aire (devuelve el error "no ack" si se solicita ack; de lo contrario, muestra el error correcto).

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aFilterEnabled
TRUE para habilitar el filtro de radio, FALSE para inhabilitar

otLinkSetRegion

otError otLinkSetRegion(
  otInstance *aInstance,
  uint16_t aRegionCode
)

Establece el código de región.

El formato de región de radio es la representación ASCII de 2 bytes del código ISO 3166 alfa-2.

Detalles
Parámetros
[in] aInstance
Estructura de instancias de OpenThread
[in] aRegionCode
Es el código regional de la radio. El aRegionCode >> 8 es el primer carácter ASCII y aRegionCode & 0xff es el segundo.
Valores que se muestran
OT_ERROR_FAILED
Otros errores específicos de la plataforma
OT_ERROR_NONE
Se configuró correctamente el código regional.
OT_ERROR_NOT_IMPLEMENTED
La función no está implementada.

otLinkSetSupportedChannelMask

otError otLinkSetSupportedChannelMask(
  otInstance *aInstance,
  uint32_t aChannelMask
)

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

Solo tiene éxito cuando los protocolos de Thread están inhabilitados.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aChannelMask
La máscara de canal compatible (asignación de bit 0 o lsb al canal 0, etcétera).
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente la máscara de canal compatible.
OT_ERROR_INVALID_STATE
Los protocolos de subprocesos están habilitados.

Macros

 OT_LINK_CSL_PERIOD_TEN_SYMBOLS_UNIT_IN_USEC (160)

Representa la unidad de símbolos de diez símbolos de CSL en microsegundos.

El período de CSL (en microsegundos) DEBE ser un múltiplo de este valor.

OT_MAC_FILTER_FIXED_RSS_DISABLED

 OT_MAC_FILTER_FIXED_RSS_DISABLED 127

Se usa para indicar que no se estableció ninguna intensidad fija de señal recibida.

OT_MAC_FILTER_ITERATOR_INIT

 OT_MAC_FILTER_ITERATOR_INIT 0

Inicializador para otMacFilterIterator.

OT_US_PER_TEN_SYMBOLS

 OT_US_PER_TEN_SYMBOLS OT_RADIO_TEN_SYMBOLS_TIME

Tiempo para 10 símbolos en unidades de microsegundos.

Recursos

Los temas de referencia de la API de OpenThread se originan a partir del código fuente, disponible en GitHub. Para obtener más información o contribuir a nuestra documentación, consulta Recursos.