Link

Este módulo inclui funções que controlam a configuração da camada de links.

Resumo

Enumerações
otMacFilterAddressMode{
  OT_MAC_FILTER_ADDRESS_MODE_DISABLED,
  OT_MAC_FILTER_ADDRESS_MODE_ALLOWLIST,
  OT_MAC_FILTER_ADDRESS_MODE_DENYLIST
} 		enum
Define o modo de endereço do filtro do MAC.

Typedefs
otActiveScanResult typedef
Representa um beacon IEEE 802.15.4 recebido.
otEnergyScanResult typedef
Representa um resultado da verificação de energia.
otHandleActiveScanResult)(otActiveScanResult *aResult, void *aContext) typedef
void(*
O ponteiro é chamado durante uma verificação ativa de IEEE 802.15.4 quando um sensor IEEE 802.15.4 é recebido ou quando a verificação é concluída.
otHandleEnergyScanResult)(otEnergyScanResult *aResult, void *aContext) typedef
void(*
O ponteiro é chamado durante uma verificação de energia IEEE 802.15.4 quando o resultado de um canal está pronto ou a verificação é concluída.
otLinkPcapCallback)(const otRadioFrame *aFrame, bool aIsTx, void *aContext) typedef
void(*
O ponteiro é chamado quando um frame IEEE 802.15.4 é recebido.
otMacCounters typedef
struct otMacCounters
Representa os contadores da camada MAC.
otMacFilterAddressMode typedef
Define o modo de endereço do filtro do MAC.
otMacFilterEntry typedef
Representa uma entrada de filtro do Mac.
otMacFilterIterator typedef
uint8_t
Usado para iterar nas entradas de filtro do Mac.
otThreadLinkInfo typedef
Representa informações específicas de link para mensagens recebidas do rádio Thread.

remotas
otLinkActiveScan(otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleActiveScanResult aCallback, void *aCallbackContext)
Inicia uma verificação ativa IEEE 802.15.4.
otLinkConvertLinkQualityToRss(otInstance *aInstance, uint8_t aLinkQuality)
int8_t
Converte a qualidade do link na intensidade típica de sinal recebido.
otLinkConvertRssToLinkQuality(otInstance *aInstance, int8_t aRss)
uint8_t
Converte a intensidade do sinal recebido para a qualidade do link.
otLinkEnergyScan(otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleEnergyScanResult aCallback, void *aCallbackContext)
Inicia uma verificação de energia IEEE 802.15.4.
otLinkFilterAddAddress(otInstance *aInstance, const otExtAddress *aExtAddress)
Adiciona um endereço estendido ao filtro MAC.
otLinkFilterAddRssIn(otInstance *aInstance, const otExtAddress *aExtAddress, int8_t aRss)
Adiciona o endereço estendido especificado à lista de RssIn (ou modifica um endereço existente na lista de RssIn) e define a intensidade do sinal recebido (em dBm) para as mensagens desse endereço.
otLinkFilterClearAddresses(otInstance *aInstance)
void
Limpa todos os endereços estendidos do filtro MAC.
otLinkFilterClearAllRssIn(otInstance *aInstance)
void
Limpa todas as entradas do indicador de qualidade do link (lqi) e da intensidade do sinal recebido (rss) (incluindo padrões) da lista RssIn.
otLinkFilterClearDefaultRssIn(otInstance *aInstance)
void
Limpa qualquer intensidade de sinal recebido padrão previamente definida (em dBm) no filtro MAC.
otLinkFilterGetAddressMode(otInstance *aInstance)
Recebe o modo de endereço do filtro MAC.
otLinkFilterGetNextAddress(otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry)
Recebe uma entrada de filtro de endereço em uso.
otLinkFilterGetNextRssIn(otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry)
Recebe uma entrada de filtro RssIn em uso.
otLinkFilterRemoveAddress(otInstance *aInstance, const otExtAddress *aExtAddress)
void
Remove um endereço estendido do filtro MAC.
otLinkFilterRemoveRssIn(otInstance *aInstance, const otExtAddress *aExtAddress)
void
Remove o endereço estendido especificado da lista de RssIn.
otLinkFilterSetAddressMode(otInstance *aInstance, otMacFilterAddressMode aMode)
void
Define o modo de endereço do filtro MAC.
otLinkFilterSetDefaultRssIn(otInstance *aInstance, int8_t aRss)
void
Define a intensidade padrão do sinal recebido (em dBm) no filtro MAC.
otLinkGetCcaFailureRate(otInstance *aInstance)
uint16_t
Retorna a taxa de falha atual da CCA (avaliação de canal claro).
otLinkGetChannel(otInstance *aInstance)
uint8_t
Acessar o canal IEEE 802.15.4.
otLinkGetCounters(otInstance *aInstance)
const otMacCounters *
Acessa os contadores da camada MAC.
otLinkGetCslChannel(otInstance *aInstance)
uint8_t
Acessa o canal da CSL.
otLinkGetCslPeriod(otInstance *aInstance)
uint32_t
Recebe o período da CSL em microssegundos.
otLinkGetCslTimeout(otInstance *aInstance)
uint32_t
Recebe o tempo limite da CSL.
otLinkGetExtendedAddress(otInstance *aInstance)
const otExtAddress *
Recebe o endereço estendido IEEE 802.15.4.
otLinkGetFactoryAssignedIeeeEui64(otInstance *aInstance, otExtAddress *aEui64)
void
Recebe o IEEE EUI-64 atribuído de fábrica.
otLinkGetMaxFrameRetriesDirect(otInstance *aInstance)
uint8_t
Retorna o número máximo de tentativas de frame durante a transmissão direta.
otLinkGetMaxFrameRetriesIndirect(otInstance *aInstance)
uint8_t
Retorna o número máximo de tentativas de frame durante a transmissão indireta.
otLinkGetPanId(otInstance *aInstance)
Encontre o ID PAN IEEE 802.15.4.
otLinkGetPollPeriod(otInstance *aInstance)
uint32_t
Acessa o período de pesquisa de dados do dispositivo final sonolento.
otLinkGetRegion(otInstance *aInstance, uint16_t *aRegionCode)
Consiga o código da região.
otLinkGetShortAddress(otInstance *aInstance)
Consiga o endereço curto IEEE 802.15.4.
otLinkGetSupportedChannelMask(otInstance *aInstance)
uint32_t
Acessa a máscara de canal compatível da camada MAC.
otLinkGetTxDirectRetrySuccessHistogram(otInstance *aInstance, uint8_t *aNumberOfEntries)
const uint32_t *
Recebe o histograma de tentativas para um único pacote direto até o sucesso.
otLinkGetTxIndirectRetrySuccessHistogram(otInstance *aInstance, uint8_t *aNumberOfEntries)
const uint32_t *
Recebe o histograma de tentativas para um único pacote indireto até que seja bem-sucedido.
otLinkIsActiveScanInProgress(otInstance *aInstance)
bool
Indica se uma verificação ativa IEEE 802.15.4 está ou não em andamento.
otLinkIsCslEnabled(otInstance *aInstance)
bool
Indica se a CSL está ativada ou não.
otLinkIsCslSupported(otInstance *aInstance)
bool
Indica se o dispositivo está conectado a um familiar responsável compatível com a CSL.
otLinkIsEnabled(otInstance *aInstance)
bool
Indica se a camada de enlace está ativada ou não.
otLinkIsEnergyScanInProgress(otInstance *aInstance)
bool
Indica se uma verificação de energia IEEE 802.15.4 está em andamento.
otLinkIsInTransmitState(otInstance *aInstance)
bool
Indica se um MAC IEEE 802.15.4 está no estado de transmissão.
otLinkIsPromiscuous(otInstance *aInstance)
bool
Indica se o modo promíscuo está ativado na camada de enlace.
otLinkIsRadioFilterEnabled(otInstance *aInstance)
bool
Indica se o filtro de rádio IEEE 802.15.4 está ativado ou não.
otLinkResetCounters(otInstance *aInstance)
void
Redefine os contadores da camada MAC.
otLinkResetTxRetrySuccessHistogram(otInstance *aInstance)
void
Limpa as estatísticas do histograma para transmissões diretas e indiretas.
otLinkSendDataRequest(otInstance *aInstance)
Coloca uma mensagem de solicitação de dados IEEE 802.15.4 na fila para transmissão.
otLinkSendEmptyData(otInstance *aInstance)
Instrui o dispositivo a enviar um data frame IEEE 802.15.4 vazio.
otLinkSetChannel(otInstance *aInstance, uint8_t aChannel)
Configure o canal IEEE 802.15.4.
otLinkSetCslChannel(otInstance *aInstance, uint8_t aChannel)
Define o canal da CSL.
otLinkSetCslPeriod(otInstance *aInstance, uint32_t aPeriod)
Define o período da CSL em microssegundos.
otLinkSetCslTimeout(otInstance *aInstance, uint32_t aTimeout)
Define o tempo limite da CSL em segundos.
otLinkSetEnabled(otInstance *aInstance, bool aEnable)
Ativa ou desativa a camada de enlace.
otLinkSetExtendedAddress(otInstance *aInstance, const otExtAddress *aExtAddress)
Define o endereço estendido IEEE 802.15.4.
otLinkSetMaxFrameRetriesDirect(otInstance *aInstance, uint8_t aMaxFrameRetriesDirect)
void
Define o número máximo de tentativas de frame durante a transmissão direta.
otLinkSetMaxFrameRetriesIndirect(otInstance *aInstance, uint8_t aMaxFrameRetriesIndirect)
void
Define o número máximo de tentativas de frame durante a transmissão indireta.
otLinkSetPanId(otInstance *aInstance, otPanId aPanId)
Defina o ID PAN IEEE 802.15.4.
otLinkSetPcapCallback(otInstance *aInstance, otLinkPcapCallback aPcapCallback, void *aCallbackContext)
void
Registra um callback para fornecer frames IEEE 802.15.4 brutos recebidos.
otLinkSetPollPeriod(otInstance *aInstance, uint32_t aPollPeriod)
Definir/limpar o período de enquete com dados externos/especificado pelo usuário para o dispositivo final com sono.
otLinkSetPromiscuous(otInstance *aInstance, bool aPromiscuous)
Ativa ou desativa o modo promíscuo da camada de vínculo.
otLinkSetRadioFilterEnabled(otInstance *aInstance, bool aFilterEnabled)
void
Ativa/desativa o modo de filtro de rádio IEEE 802.15.4.
otLinkSetRegion(otInstance *aInstance, uint16_t aRegionCode)
Define o código da região.
otLinkSetSupportedChannelMask(otInstance *aInstance, uint32_t aChannelMask)
Define a máscara de canal compatível da camada MAC.

Estruturas
otActiveScanResult

Representa um beacon IEEE 802.15.4 recebido.

otEnergyScanResult

Representa um resultado da verificação de energia.

otMacCounters

Representa os contadores da camada MAC.

otMacFilterEntry

Representa uma entrada de filtro do Mac.

otThreadLinkInfo

Representa informações específicas de link para mensagens recebidas do rádio Thread.

Enumerações

otMacFilterAddressMode

 otMacFilterAddressMode

Define o modo de endereço do filtro do MAC.

Propriedades
OT_MAC_FILTER_ADDRESS_MODE_ALLOWLIST

O modo de filtro de endereços da lista de permissões está ativado.

OT_MAC_FILTER_ADDRESS_MODE_DENYLIST

O modo de filtro de endereços da lista de bloqueio está ativado.

OT_MAC_FILTER_ADDRESS_MODE_DISABLED

O filtro de endereço está desativado.

Typedefs

otActiveScanResult

struct otActiveScanResult otActiveScanResult

Representa um beacon IEEE 802.15.4 recebido.

otEnergyScanResult

struct otEnergyScanResult otEnergyScanResult

Representa um resultado da verificação de energia.

otHandleActiveScanResult

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

O ponteiro é chamado durante uma verificação ativa de IEEE 802.15.4 quando um sensor IEEE 802.15.4 é recebido ou quando a verificação é concluída.

Detalhes
Parâmetros
[in] aResult
Um ponteiro válido para as informações do beacon ou NULL quando a verificação ativa é concluída.
[in] aContext
Um ponteiro para o contexto específico do aplicativo.

otHandleEnergyScanResult

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

O ponteiro é chamado durante uma verificação de energia IEEE 802.15.4 quando o resultado de um canal está pronto ou a verificação é concluída.

Detalhes
Parâmetros
[in] aResult
Um ponteiro válido para as informações do resultado da verificação de energia ou NULL quando ela é concluída.
[in] aContext
Um ponteiro para o contexto específico do aplicativo.

otLinkPcapCallback

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

O ponteiro é chamado quando um frame IEEE 802.15.4 é recebido.

Detalhes
Parâmetros
[in] aFrame
Um ponteiro para o frame IEEE 802.15.4 recebido.
[in] aIsTx
Indica se o frame é transmitido ou não.
[in] aContext
Um ponteiro para o contexto específico do aplicativo.

otMacCounters

struct otMacCounters otMacCounters

Representa os contadores da camada MAC.

otMacFilterAddressMode

enum otMacFilterAddressMode otMacFilterAddressMode

Define o modo de endereço do filtro do MAC.

otMacFilterEntry

struct otMacFilterEntry otMacFilterEntry

Representa uma entrada de filtro do Mac.

otMacFilterIterator

uint8_t otMacFilterIterator

Usado para iterar nas entradas de filtro do Mac.

otThreadLinkInfo

struct otThreadLinkInfo otThreadLinkInfo

Representa informações específicas de link para mensagens recebidas do rádio Thread.

remotas

otLinkActiveScan

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

Inicia uma verificação ativa IEEE 802.15.4.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aScanChannels
Um vetor de bits que indica quais canais verificar (por exemplo, OT_CHANNEL_11_MASK).
[in] aScanDuration
O tempo em milissegundos gasto na verificação de cada canal.
[in] aCallback
Um ponteiro para uma função chamada ao receber um sensor ou uma verificação é concluída.
[in] aCallbackContext
Um ponteiro para o contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
A solicitação de verificação ativa foi aceita.
OT_ERROR_BUSY
Já executando uma verificação ativa.

otLinkConvertLinkQualityToRss

int8_t otLinkConvertLinkQualityToRss(
  otInstance *aInstance,
  uint8_t aLinkQuality
)

Converte a qualidade do link na intensidade típica de sinal recebido.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aLinkQuality
Valor LinkQuality, deve estar no intervalo [0,3].
Retorna
Mapeamento de intensidade do sinal recebido pela plataforma típica para aLinkQuality.

otLinkConvertRssToLinkQuality

uint8_t otLinkConvertRssToLinkQuality(
  otInstance *aInstance,
  int8_t aRss
)

Converte a intensidade do sinal recebido para a qualidade do link.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aRss
O valor da intensidade do sinal recebido a ser convertido.
Retorna
Vincular o mapeamento do valor de qualidade a aRss.

otLinkEnergyScan

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

Inicia uma verificação de energia IEEE 802.15.4.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aScanChannels
Um vetor de bit que indica em quais canais realizar a verificação de energia.
[in] aScanDuration
O tempo em milissegundos gasto na verificação de cada canal.
[in] aCallback
Um ponteiro para uma função chamada para transmitir o resultado da verificação ao indicar a conclusão da verificação.
[in] aCallbackContext
Um ponteiro para o contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
A solicitação do Energy Scan foi aceita.
OT_ERROR_BUSY
Não foi possível iniciar a verificação de energia.

otLinkFilterAddAddress

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

Adiciona um endereço estendido ao filtro MAC.

Disponível quando a configuração OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está ativada.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aExtAddress
Um ponteiro para o endereço estendido (NÃO DEVE ser NULL).
Valores de retorno
OT_ERROR_NONE
aExtAddress foi adicionado ao filtro MAC.
OT_ERROR_NO_BUFS
Não existe uma entrada disponível.

otLinkFilterAddRssIn

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

Adiciona o endereço estendido especificado à lista de RssIn (ou modifica um endereço existente na lista de RssIn) e define a intensidade do sinal recebido (em dBm) para as mensagens desse endereço.

O endereço completo não precisa estar no filtro address allowlist/denylist para definir o rss.

Disponível quando a configuração OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está ativada.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aExtAddress
Um ponteiro para o endereço estendido IEEE 802.15.4. NÃO PODE ser NULL.
[in] aRss
Intensidade do sinal recebido (em dBm).
Valores de retorno
OT_ERROR_NONE
Uma entrada para aExtAddress e aRss foi adicionada.
OT_ERROR_NO_BUFS
Não existe uma entrada disponível.

otLinkFilterClearAddresses

void otLinkFilterClearAddresses(
  otInstance *aInstance
)

Limpa todos os endereços estendidos do filtro MAC.

Disponível quando a configuração OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está ativada.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.

otLinkFilterClearAllRssIn

void otLinkFilterClearAllRssIn(
  otInstance *aInstance
)

Limpa todas as entradas do indicador de qualidade do link (lqi) e da intensidade do sinal recebido (rss) (incluindo padrões) da lista RssIn.

Realizar essa ação significa que todos os endereços estendidos usarão o sinal transmitido.

Disponível quando a configuração OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está ativada.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.

otLinkFilterClearDefaultRssIn

void otLinkFilterClearDefaultRssIn(
  otInstance *aInstance
)

Limpa qualquer intensidade de sinal recebido padrão previamente definida (em dBm) no filtro MAC.

Disponível quando a configuração OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está ativada.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.

otLinkFilterGetAddressMode

otMacFilterAddressMode otLinkFilterGetAddressMode(
  otInstance *aInstance
)

Recebe o modo de endereço do filtro MAC.

Disponível quando a configuração OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está ativada.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
o modo de endereço.

otLinkFilterGetNextAddress

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

Recebe uma entrada de filtro de endereço em uso.

Disponível quando a configuração OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está ativada.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in,out] aIterator
Um ponteiro para o contexto do iterador de filtro MAC. Para conseguir a primeira entrada de filtro de endereço em uso, ele precisa ser definido como OT_MAC_FILTER_ITERATOR_INIT. NÃO PODE ser NULL.
[out] aEntry
Um ponteiro para o local onde as informações são colocadas. NÃO PODE ser NULL.
Valores de retorno
OT_ERROR_NONE
Uma entrada de filtro de endereço em uso foi recuperada.
OT_ERROR_NOT_FOUND
Não existe uma entrada subsequente.

otLinkFilterGetNextRssIn

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

Recebe uma entrada de filtro RssIn em uso.

Disponível quando a configuração OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está ativada.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in,out] aIterator
Um ponteiro para o contexto do iterador de filtro MAC. NÃO PODE ser NULL. Para conseguir a primeira entrada, defina como OT_MAC_FILTER_ITERATOR_INIT.
[out] aEntry
Um ponteiro para o local onde as informações são colocadas. A última entrada teria o endereço estendido como 0xff para indicar a intensidade do sinal recebido padrão, se ela tiver sido definida. aEntry NÃO PODE ser NULL.
Valores de retorno
OT_ERROR_NONE
A próxima entrada foi recuperada.
OT_ERROR_NOT_FOUND
Não existe uma entrada subsequente.

otLinkFilterRemoveAddress

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

Remove um endereço estendido do filtro MAC.

Disponível quando a configuração OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está ativada.

Nenhuma ação será realizada se não houver uma entrada no filtro que corresponda ao endereço estendido fornecido.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aExtAddress
Um ponteiro para o endereço estendido (NÃO DEVE ser NULL).

otLinkFilterRemoveRssIn

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

Remove o endereço estendido especificado da lista de RssIn.

Depois de removido da lista de RssIn, este endereço MAC usará as configurações padrão de rss e lqi, presumindo que os padrões tenham sido definidos. Se nenhum padrão tiver sido definido, o sinal over-air será usado.

Disponível quando a configuração OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está ativada.

Nenhuma ação será realizada se não houver uma entrada na lista de RssIn correspondente ao endereço estendido especificado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aExtAddress
Um ponteiro para o endereço estendido IEEE 802.15.4. NÃO PODE ser NULL.

otLinkFilterSetAddressMode

void otLinkFilterSetAddressMode(
  otInstance *aInstance,
  otMacFilterAddressMode aMode
)

Define o modo de endereço do filtro MAC.

Disponível quando a configuração OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está ativada.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aMode
O modo de endereço a ser definido.

otLinkFilterSetDefaultRssIn

void otLinkFilterSetDefaultRssIn(
  otInstance *aInstance,
  int8_t aRss
)

Define a intensidade padrão do sinal recebido (em dBm) no filtro MAC.

Disponível quando a configuração OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está ativada.

O valor RSS padrão é usado para todos os frames recebidos de endereços sem uma entrada RSS-IN explícita na lista de filtros (adicionado usando otLinkFilterAddRssIn()).

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aRss
A intensidade do sinal recebido padrão (em dBm) a ser definido.

otLinkGetCcaFailureRate

uint16_t otLinkGetCcaFailureRate(
  otInstance *aInstance
)

Retorna a taxa de falha atual da CCA (avaliação de canal claro).

A taxa é mantida durante uma janela de, aproximadamente, as últimas OPENTHREAD_CONFIG_CCA_FAILURE_RATE_AVERAGING_WINDOW transmissões de frame.

Detalhes
Retorna
A taxa de falha de CCA com o valor máximo 0xffff correspondente a 100% de taxa de falha.

otLinkGetChannel

uint8_t otLinkGetChannel(
  otInstance *aInstance
)

Acessar o canal IEEE 802.15.4.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O canal IEEE 802.15.4.
Consulte também:
otLinkSetChannel

otLinkGetCounters

const otMacCounters * otLinkGetCounters(
  otInstance *aInstance
)

Acessa os contadores da camada MAC.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para os contadores da camada MAC.

otLinkGetCslChannel

uint8_t otLinkGetCslChannel(
  otInstance *aInstance
)

Acessa o canal da CSL.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O canal da CSL.

otLinkGetCslPeriod

uint32_t otLinkGetCslPeriod(
  otInstance *aInstance
)

Recebe o período da CSL em microssegundos.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Período da CSL em microssegundos.

otLinkGetCslTimeout

uint32_t otLinkGetCslTimeout(
  otInstance *aInstance
)

Recebe o tempo limite da CSL.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O tempo limite da CSL em segundos.

otLinkGetExtendedAddress

const otExtAddress * otLinkGetExtendedAddress(
  otInstance *aInstance
)

Recebe o endereço estendido IEEE 802.15.4.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o endereço estendido IEEE 802.15.4.

otLinkGetFactoryAssignedIeeeEui64

void otLinkGetFactoryAssignedIeeeEui64(
  otInstance *aInstance,
  otExtAddress *aEui64
)

Recebe o IEEE EUI-64 atribuído de fábrica.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para a instância do OpenThread.
[out] aEui64
Um ponteiro para onde o IEEE EUI-64 atribuído de fábrica é colocado.

otLinkGetMaxFrameRetriesDirect

uint8_t otLinkGetMaxFrameRetriesDirect(
  otInstance *aInstance
)

Retorna o número máximo de tentativas de frame durante a transmissão direta.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O número máximo de tentativas durante a transmissão direta.

otLinkGetMaxFrameRetriesIndirect

uint8_t otLinkGetMaxFrameRetriesIndirect(
  otInstance *aInstance
)

Retorna o número máximo de tentativas de frame durante a transmissão indireta.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O número máximo de tentativas durante a transmissão indireta.

otLinkGetPanId

otPanId otLinkGetPanId(
  otInstance *aInstance
)

Encontre o ID PAN IEEE 802.15.4.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O ID PAN IEEE 802.15.4.
Consulte também:
otLinkSetPanId

otLinkGetPollPeriod

uint32_t otLinkGetPollPeriod(
  otInstance *aInstance
)

Acessa o período de pesquisa de dados do dispositivo final sonolento.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O período de pesquisa de dados do dispositivo final com sono, em milissegundos.
Consulte também:
otLinkSetPollPeriod

otLinkGetRegion

otError otLinkGetRegion(
  otInstance *aInstance,
  uint16_t *aRegionCode
)

Consiga o código da região.

O formato de região do rádio é a representação ascii de 2 bytes do código ISO 3166 alfa-2.

Detalhes
Parâmetros
[in] aInstance
A estrutura da instância do OpenThread.
[out] aRegionCode
O código da região do rádio. O aRegionCode >> 8 é o primeiro caractere ASCII e o aRegionCode & 0xff é o segundo.
Valores de retorno
OT_ERROR_INVALID_ARGS
aRegionCode é nullptr.
OT_ERROR_FAILED
Outros erros específicos da plataforma.
OT_ERROR_NONE
O código da região foi recebido.
OT_ERROR_NOT_IMPLEMENTED
O recurso não foi implementado.

otLinkGetShortAddress

otShortAddress otLinkGetShortAddress(
  otInstance *aInstance
)

Consiga o endereço curto IEEE 802.15.4.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o endereço curto IEEE 802.15.4.

otLinkGetSupportedChannelMask

uint32_t otLinkGetSupportedChannelMask(
  otInstance *aInstance
)

Acessa a máscara de canal compatível da camada MAC.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
A máscara de canal compatível, como uint32_t, com mapeamento do bit 0 (lsb) para o canal 0, do bit 1 para o canal 1, assim por diante.

otLinkGetTxDirectRetrySuccessHistogram

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

Recebe o histograma de tentativas para um único pacote direto até o sucesso.

É válido quando a configuração OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE está ativada.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aNumberOfEntries
Um ponteiro para onde o tamanho da matriz de histograma retornada é colocado.
Retorna
Um ponteiro para o histograma de tentativas (em forma de uma matriz). O enésimo elemento indica que o pacote foi enviado com n-ésima nova tentativa.

otLinkGetTxIndirectRetrySuccessHistogram

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

Recebe o histograma de tentativas para um único pacote indireto até que seja bem-sucedido.

É válido quando a configuração OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE está ativada.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aNumberOfEntries
Um ponteiro para onde o tamanho da matriz de histograma retornada é colocado.
Retorna
Um ponteiro para o histograma de tentativas (em forma de uma matriz). O enésimo elemento indica que o pacote foi enviado com n-ésima nova tentativa.

otLinkIsActiveScanInProgress

bool otLinkIsActiveScanInProgress(
  otInstance *aInstance
)

Indica se uma verificação ativa IEEE 802.15.4 está ou não em andamento.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
verdadeiro se uma verificação ativa IEEE 802.15.4 estiver em andamento; caso contrário, será falso.

otLinkIsCslEnabled

bool otLinkIsCslEnabled(
  otInstance *aInstance
)

Indica se a CSL está ativada ou não.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
TRUE
A camada de links está ativada para a CSL.
FALSE
A camada de links não está ativada para a CSL.

otLinkIsCslSupported

bool otLinkIsCslSupported(
  otInstance *aInstance
)

Indica se o dispositivo está conectado a um familiar responsável compatível com a CSL.

Detalhes
Valores de retorno
TRUE
Se o familiar responsável for compatível com a CSL.
FALSE
Se o familiar responsável não oferecer suporte à CSL.

otLinkIsEnabled

bool otLinkIsEnabled(
  otInstance *aInstance
)

Indica se a camada de enlace está ativada ou não.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
TRUE
A camada de links está ativada.
FALSE
A camada de links não está ativada.

otLinkIsEnergyScanInProgress

bool otLinkIsEnergyScanInProgress(
  otInstance *aInstance
)

Indica se uma verificação de energia IEEE 802.15.4 está em andamento.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
verdadeiro se uma verificação de energia IEEE 802.15.4 estiver em andamento; caso contrário, será falso.

otLinkIsInTransmitState

bool otLinkIsInTransmitState(
  otInstance *aInstance
)

Indica se um MAC IEEE 802.15.4 está no estado de transmissão.

O módulo MAC está no estado de transmissão durante o procedimento CSMA/CA, a transmissão de quadros de dados, de beacon ou de solicitação de dados CCA e o recebimento de uma ACK de um frame transmitido. O módulo MAC não está no estado de transmissão durante a transmissão de um frame ACK ou de um frame de solicitação de beacon.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
verdadeiro se um MAC IEEE 802.15.4 estiver no estado de transmissão; caso contrário, será falso.

otLinkIsPromiscuous

bool otLinkIsPromiscuous(
  otInstance *aInstance
)

Indica se o modo promíscuo está ativado na camada de enlace.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
TRUE
O modo promíscuo está ativado.
FALSE
O modo promíscuo não está ativado.

otLinkIsRadioFilterEnabled

bool otLinkIsRadioFilterEnabled(
  otInstance *aInstance
)

Indica se o filtro de rádio IEEE 802.15.4 está ativado ou não.

Disponível quando a configuração OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está ativada.

Detalhes
Valores de retorno
TRUE
Se o filtro de opção estiver ativado.
FALSE
Se o filtro de opção estiver desativado.

otLinkResetCounters

void otLinkResetCounters(
  otInstance *aInstance
)

Redefine os contadores da camada MAC.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.

otLinkResetTxRetrySuccessHistogram

void otLinkResetTxRetrySuccessHistogram(
  otInstance *aInstance
)

Limpa as estatísticas do histograma para transmissões diretas e indiretas.

É válido quando a configuração OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE está ativada.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.

otLinkSendDataRequest

otError otLinkSendDataRequest(
  otInstance *aInstance
)

Coloca uma mensagem de solicitação de dados IEEE 802.15.4 na fila para transmissão.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
OT_ERROR_NONE
Uma mensagem de solicitação de dados IEEE 802.15.4 foi colocada na fila com sucesso.
OT_ERROR_INVALID_STATE
O dispositivo não está no modo "rx-off-when-idle".
OT_ERROR_NO_BUFS
Buffers de mensagem insuficientes disponíveis.

otLinkSendEmptyData

otError otLinkSendEmptyData(
  otInstance *aInstance
)

Instrui o dispositivo a enviar um data frame IEEE 802.15.4 vazio.

Só é compatível com um dispositivo Rx-Off-When-Idle para enviar um data frame vazio ao respectivo pai. Observação: disponível apenas quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
OT_ERROR_NONE
Uma mensagem vazia foi enfileirada com sucesso.
OT_ERROR_INVALID_STATE
O dispositivo não está no modo Rx-Off-When-Idle.
OT_ERROR_NO_BUFS
Buffers de mensagem insuficientes disponíveis.

otLinkSetChannel

otError otLinkSetChannel(
  otInstance *aInstance,
  uint8_t aChannel
)

Configure o canal IEEE 802.15.4.

Só funciona quando os protocolos do Thread estão desativados. Uma chamada bem-sucedida para esta função invalida os conjuntos de dados operacionais ativos e pendentes na memória não volátil.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aChannel
O canal IEEE 802.15.4.
Valores de retorno
OT_ERROR_NONE
O canal foi configurado.
OT_ERROR_INVALID_ARGS
Se aChannel não estiver no intervalo [11, 26] ou não estiver na máscara de canal com suporte.
OT_ERROR_INVALID_STATE
Os protocolos de Thread estão ativados.
Consulte também:
otLinkGetChannel

otLinkSetCslChannel

otError otLinkSetCslChannel(
  otInstance *aInstance,
  uint8_t aChannel
)

Define o canal da CSL.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aChannel
O canal de amostra da CSL. O valor do canal precisa ser 0 (definir canal da CSL não especificada) ou estar dentro do intervalo [1, 10] (se compatível com 915 MHz) e 11, 26.
Valores de retorno
OT_ERROR_NONE
Os parâmetros da CSL foram definidos.
OT_ERROR_INVALID_ARGS
aChannel inválido.

otLinkSetCslPeriod

otError otLinkSetCslPeriod(
  otInstance *aInstance,
  uint32_t aPeriod
)

Define o período da CSL em microssegundos.

Defina esse parâmetro como 0 para desativar a CSL.

O período da CSL PRECISA ser um múltiplo de OT_LINK_CSL_PERIOD_TEN_SYMBOLS_UNIT_IN_USEC. Caso contrário, OT_ERROR_INVALID_ARGS será retornado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aPeriod
Período da CSL em microssegundos.
Valores de retorno
OT_ERROR_NONE
O período da CSL foi definido.
OT_ERROR_INVALID_ARGS
Período da CSL inválido

otLinkSetCslTimeout

otError otLinkSetCslTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Define o tempo limite da CSL em segundos.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aTimeout
O tempo limite da CSL em segundos.
Valores de retorno
OT_ERROR_NONE
O tempo limite da CSL foi definido.
OT_ERROR_INVALID_ARGS
Tempo limite de CSL inválido.

otLinkSetEnabled

otError otLinkSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Ativa ou desativa a camada de enlace.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aEnable
verdadeiro para ativar a camada de enlace ou falso para ativar.
Valores de retorno
OT_ERROR_NONE
A camada de links foi ativada / desativada.
OT_ERROR_INVALID_STATE
Não foi possível desativar a camada de links porque a interface Thread está ativada.

otLinkSetExtendedAddress

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

Define o endereço estendido IEEE 802.15.4.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aExtAddress
Um ponteiro para o endereço estendido IEEE 802.15.4.
Valores de retorno
OT_ERROR_NONE
O endereço estendido IEEE 802.15.4 foi definido.
OT_ERROR_INVALID_ARGS
aExtAddress estava NULL.
OT_ERROR_INVALID_STATE
Os protocolos de Thread estão ativados.

otLinkSetMaxFrameRetriesDirect

void otLinkSetMaxFrameRetriesDirect(
  otInstance *aInstance,
  uint8_t aMaxFrameRetriesDirect
)

Define o número máximo de tentativas de frame durante a transmissão direta.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aMaxFrameRetriesDirect
O número máximo de tentativas durante a transmissão direta.

otLinkSetMaxFrameRetriesIndirect

void otLinkSetMaxFrameRetriesIndirect(
  otInstance *aInstance,
  uint8_t aMaxFrameRetriesIndirect
)

Define o número máximo de tentativas de frame durante a transmissão indireta.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aMaxFrameRetriesIndirect
O número máximo de tentativas durante a transmissão indireta.

otLinkSetPanId

otError otLinkSetPanId(
  otInstance *aInstance,
  otPanId aPanId
)

Defina o ID PAN IEEE 802.15.4.

Só funciona quando os protocolos do Thread estão desativados. Uma chamada bem-sucedida para esta função também invalida os conjuntos de dados operacionais ativos e pendentes na memória não volátil.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aPanId
O ID PAN IEEE 802.15.4.
Valores de retorno
OT_ERROR_NONE
O ID do PAN foi definido.
OT_ERROR_INVALID_ARGS
Se aPanId não estiver no intervalo [0, 65534].
OT_ERROR_INVALID_STATE
Os protocolos de Thread estão ativados.
Consulte também:
otLinkGetPanId

otLinkSetPcapCallback

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

Registra um callback para fornecer frames IEEE 802.15.4 brutos recebidos.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aPcapCallback
Um ponteiro para uma função que é chamada ao receber um frame de link IEEE 802.15.4 ou NULL para desativar o callback.
[in] aCallbackContext
Um ponteiro para o contexto específico do aplicativo.

otLinkSetPollPeriod

otError otLinkSetPollPeriod(
  otInstance *aInstance,
  uint32_t aPollPeriod
)

Definir/limpar o período de enquete com dados externos/especificado pelo usuário para o dispositivo final com sono.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aPollPeriod
período de pesquisa de dados em milissegundos.
Valores de retorno
OT_ERROR_NONE
Período de enquete especificado pelo usuário definido/apagado.
OT_ERROR_INVALID_ARGS
Se aPollPeriod for inválido.
Consulte também:
otLinkGetPollPeriod

otLinkSetPromiscuous

otError otLinkSetPromiscuous(
  otInstance *aInstance,
  bool aPromiscuous
)

Ativa ou desativa o modo promíscuo da camada de vínculo.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aPromiscuous
verdadeiro para ativar o modo promíscuo ou falso para ativar o modo promíscuo.
Valores de retorno
OT_ERROR_NONE
O modo promíscuo foi ativado.
OT_ERROR_INVALID_STATE
Não foi possível ativar o modo promíscuo porque a interface Thread está ativada.

otLinkSetRadioFilterEnabled

void otLinkSetRadioFilterEnabled(
  otInstance *aInstance,
  bool aFilterEnabled
)

Ativa/desativa o modo de filtro de rádio IEEE 802.15.4.

Disponível quando a configuração OPENTHREAD_CONFIG_MAC_FILTER_ENABLE está ativada.

O filtro de rádio é destinado principalmente para testes. Ela pode ser usada para bloquear temporariamente todas as tx/rx no rádio 802.15.4. Quando o filtro de rádio está ativado, o rádio é colocado em suspensão em vez de receber (para garantir que o dispositivo não receba nenhum frame e/ou potencialmente envie confirmação). Além disso, as solicitações de transmissão de frame retornam imediatamente sem enviar o frame over the air (o erro "no ack" é retornado se a confirmação é solicitada; caso contrário, retorna o sucesso).

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aFilterEnabled
TRUE para ativar o filtro de opção; FALSE para desativar

otLinkSetRegion

otError otLinkSetRegion(
  otInstance *aInstance,
  uint16_t aRegionCode
)

Define o código da região.

O formato de região do rádio é a representação ascii de 2 bytes do código ISO 3166 alfa-2.

Detalhes
Parâmetros
[in] aInstance
A estrutura da instância do OpenThread.
[in] aRegionCode
O código da região do rádio. O aRegionCode >> 8 é o primeiro caractere ASCII e o aRegionCode & 0xff é o segundo.
Valores de retorno
OT_ERROR_FAILED
Outros erros específicos da plataforma.
OT_ERROR_NONE
O código de região foi definido.
OT_ERROR_NOT_IMPLEMENTED
O recurso não foi implementado.

otLinkSetSupportedChannelMask

otError otLinkSetSupportedChannelMask(
  otInstance *aInstance,
  uint32_t aChannelMask
)

Define a máscara de canal compatível da camada MAC.

Só funciona quando os protocolos do Thread estão desativados.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aChannelMask
A máscara de canal suportada (mapeamento de bit 0 ou lsb para o canal 0 e assim por diante).
Valores de retorno
OT_ERROR_NONE
A máscara de canal com suporte foi definida.
OT_ERROR_INVALID_STATE
Os protocolos de Thread estão ativados.

Macros

 OT_LINK_CSL_PERIOD_TEN_SYMBOLS_UNIT_IN_USEC (160)

Representa a unidade de símbolos do período 10 da CSL em microssegundos.

O período da CSL (em microssegundos) PRECISA ser um múltiplo desse valor.

OT_MAC_FILTER_FIXED_RSS_DISABLED

 OT_MAC_FILTER_FIXED_RSS_DISABLED 127

Usado para indicar que nenhuma intensidade fixa de sinal recebido foi definida.

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

Tempo para 10 símbolos em unidades de microssegundos.

Recursos

Os tópicos de Referência da API OpenThread são originados do código-fonte, disponível no GitHub. Para mais informações ou para contribuir com nossa documentação, consulte Recursos.