Связь

Этот модуль включает функции, которые управляют конфигурацией канального уровня.

Краткое содержание

Перечисления

otMacFilterAddressMode {
OT_MAC_FILTER_ADDRESS_MODE_DISABLED ,
OT_MAC_FILTER_ADDRESS_MODE_ALLOWLIST ,
OT_MAC_FILTER_ADDRESS_MODE_DENYLIST
}		 перечисление
Определяет адресный режим фильтра Mac.

Определения типов

otActiveScanResult определение типа
Представляет полученный маяк IEEE 802.15.4.
otEnergyScanResult определение типа
Представляет результат сканирования энергии.
otHandleActiveScanResult )(otActiveScanResult *aResult, void *aContext) определение типа
void(*
Указатель вызывается во время активного сканирования IEEE 802.15.4, когда получен маяк IEEE 802.15.4 или сканирование завершено.
otHandleEnergyScanResult )(otEnergyScanResult *aResult, void *aContext) определение типа
void(*
Указатель вызывается во время сканирования энергии IEEE 802.15.4, когда результат для канала готов или сканирование завершается.
otLinkPcapCallback )(const otRadioFrame *aFrame, bool aIsTx, void *aContext) определение типа
void(*
Указатель вызывается при получении кадра IEEE 802.15.4.
otMacCounters определение типа
Представляет счетчики уровня MAC.
otMacFilterAddressMode определение типа
Определяет адресный режим фильтра Mac.
otMacFilterEntry определение типа
Представляет запись фильтра Mac.
otMacFilterIterator определение типа
uint8_t
Используется для перебора записей фильтра Mac.
otThreadLinkInfo определение типа
Представляет информацию, специфичную для канала, для сообщений, полученных от радиоканала Thread.

Функции

otLinkActiveScan ( otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleActiveScanResult aCallback, void *aCallbackContext)
Запускает активное сканирование IEEE 802.15.4.
otLinkConvertLinkQualityToRss ( otInstance *aInstance, uint8_t aLinkQuality)
int8_t
Преобразует качество связи в типичную мощность принимаемого сигнала.
otLinkConvertRssToLinkQuality ( otInstance *aInstance, int8_t aRss)
uint8_t
Преобразует уровень принимаемого сигнала в качество связи.
otLinkEnergyScan ( otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleEnergyScanResult aCallback, void *aCallbackContext)
Запускает сканирование энергопотребления IEEE 802.15.4.
otLinkFilterAddAddress ( otInstance *aInstance, const otExtAddress *aExtAddress)
Добавляет расширенный адрес в MAC-фильтр.
otLinkFilterAddRssIn ( otInstance *aInstance, const otExtAddress *aExtAddress, int8_t aRss)
Добавляет указанный расширенный адрес в список RssIn (или изменяет существующий адрес в списке RssIn ) и устанавливает запись уровня принимаемого сигнала (в дБм) для сообщений с этого адреса.
otLinkFilterClearAddresses ( otInstance *aInstance)
void
Удаляет все расширенные адреса из MAC-фильтра.
otLinkFilterClearAllRssIn ( otInstance *aInstance)
void
Удаляет все записи уровня полученного сигнала ( rss ) и индикатора качества соединения ( lqi ) (включая значения по умолчанию) из списка RssIn .
otLinkFilterClearDefaultRssIn ( otInstance *aInstance)
void
Очищает любую ранее установленную мощность принимаемого сигнала по умолчанию (в дБм) на MAC-фильтре.
otLinkFilterGetAddressMode ( otInstance *aInstance)
Получает адресный режим фильтра MAC.
otLinkFilterGetNextAddress ( otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry)
Получает используемую запись фильтра адресов.
otLinkFilterGetNextRssIn ( otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry)
Получает используемую запись фильтра RssIn.
otLinkFilterRemoveAddress ( otInstance *aInstance, const otExtAddress *aExtAddress)
void
Удаляет расширенный адрес из MAC-фильтра.
otLinkFilterRemoveRssIn ( otInstance *aInstance, const otExtAddress *aExtAddress)
void
Удаляет указанный расширенный адрес из списка RssIn .
otLinkFilterSetAddressMode ( otInstance *aInstance, otMacFilterAddressMode aMode)
void
Устанавливает адресный режим фильтра MAC.
otLinkFilterSetDefaultRssIn ( otInstance *aInstance, int8_t aRss)
void
Устанавливает мощность принимаемого сигнала по умолчанию (в дБм) для MAC-фильтра.
otLinkGetCcaFailureRate ( otInstance *aInstance)
uint16_t
Возвращает текущую частоту отказов CCA (оценка чистого канала).
otLinkGetChannel ( otInstance *aInstance)
uint8_t
Получите канал IEEE 802.15.4.
otLinkGetCounters ( otInstance *aInstance)
const otMacCounters *
Получите счетчики уровня MAC.
otLinkGetCslChannel ( otInstance *aInstance)
uint8_t
Получает канал CSL.
otLinkGetCslPeriod ( otInstance *aInstance)
uint32_t
Получает период CSL в микросекундах.
otLinkGetCslTimeout ( otInstance *aInstance)
uint32_t
Получает тайм-аут CSL.
otLinkGetExtendedAddress ( otInstance *aInstance)
const otExtAddress *
Получает расширенный адрес IEEE 802.15.4.
otLinkGetFactoryAssignedIeeeEui64 ( otInstance *aInstance, otExtAddress *aEui64)
void
Получите назначенный на заводе стандарт IEEE EUI-64.
otLinkGetMaxFrameRetriesDirect ( otInstance *aInstance)
uint8_t
Возвращает максимальное количество повторов кадров во время прямой передачи.
otLinkGetMaxFrameRetriesIndirect ( otInstance *aInstance)
uint8_t
Возвращает максимальное количество повторов кадров во время непрямой передачи.
otLinkGetPanId ( otInstance *aInstance)
Получите идентификатор PAN IEEE 802.15.4.
otLinkGetPollPeriod ( otInstance *aInstance)
uint32_t
Получите период опроса данных сонного конечного устройства.
otLinkGetRegion ( otInstance *aInstance, uint16_t *aRegionCode)
Получите код региона.
otLinkGetShortAddress ( otInstance *aInstance)
Получите короткий адрес IEEE 802.15.4.
otLinkGetSupportedChannelMask ( otInstance *aInstance)
uint32_t
Получите поддерживаемую маску канала уровня MAC.
otLinkGetTxDirectRetrySuccessHistogram ( otInstance *aInstance, uint8_t *aNumberOfEntries)
const uint32_t *
Получает гистограмму повторных попыток одного прямого пакета до успешного завершения.
otLinkGetTxIndirectRetrySuccessHistogram ( otInstance *aInstance, uint8_t *aNumberOfEntries)
const uint32_t *
Получает гистограмму повторных попыток одного косвенного пакета до успешного завершения.
otLinkIsActiveScanInProgress ( otInstance *aInstance)
bool
Указывает, выполняется ли в данный момент активное сканирование IEEE 802.15.4.
otLinkIsCslEnabled ( otInstance *aInstance)
bool
Указывает, включен ли CSL.
otLinkIsCslSupported ( otInstance *aInstance)
bool
Указывает, подключено ли устройство к родительскому устройству, поддерживающему CSL.
otLinkIsEnabled ( otInstance *aInstance)
bool
Указывает, включен ли канальный уровень.
otLinkIsEnergyScanInProgress ( otInstance *aInstance)
bool
Указывает, выполняется ли в данный момент сканирование энергопотребления IEEE 802.15.4.
otLinkIsInTransmitState ( otInstance *aInstance)
bool
Указывает, находится ли MAC IEEE 802.15.4 в состоянии передачи.
otLinkIsPromiscuous ( otInstance *aInstance)
bool
Указывает, включен ли неразборчивый режим на канальном уровне.
otLinkIsRadioFilterEnabled ( otInstance *aInstance)
bool
Указывает, включен ли радиофильтр IEEE 802.15.4.
otLinkResetCounters ( otInstance *aInstance)
void
Сбрасывает счетчики уровня MAC.
otLinkResetTxRetrySuccessHistogram ( otInstance *aInstance)
void
Очищает статистику гистограммы для прямых и косвенных передач.
otLinkSendDataRequest ( otInstance *aInstance)
Ставит в очередь сообщение запроса данных IEEE 802.15.4 для передачи.
otLinkSendEmptyData ( otInstance *aInstance)
Указывает устройству отправить пустой кадр данных IEEE 802.15.4.
otLinkSetChannel ( otInstance *aInstance, uint8_t aChannel)
Установите канал IEEE 802.15.4.
otLinkSetCslChannel ( otInstance *aInstance, uint8_t aChannel)
Устанавливает канал CSL.
otLinkSetCslPeriod ( otInstance *aInstance, uint32_t aPeriod)
Устанавливает период CSL в микросекундах.
otLinkSetCslTimeout ( otInstance *aInstance, uint32_t aTimeout)
Устанавливает тайм-аут CSL в секундах.
otLinkSetEnabled ( otInstance *aInstance, bool aEnable)
Включает или отключает канальный уровень.
otLinkSetExtendedAddress ( otInstance *aInstance, const otExtAddress *aExtAddress)
Устанавливает расширенный адрес IEEE 802.15.4.
otLinkSetMaxFrameRetriesDirect ( otInstance *aInstance, uint8_t aMaxFrameRetriesDirect)
void
Устанавливает максимальное количество повторов кадров во время прямой передачи.
otLinkSetMaxFrameRetriesIndirect ( otInstance *aInstance, uint8_t aMaxFrameRetriesIndirect)
void
Устанавливает максимальное количество повторов кадров во время непрямой передачи.
otLinkSetPanId ( otInstance *aInstance, otPanId aPanId)
Установите идентификатор PAN IEEE 802.15.4.
otLinkSetPcapCallback ( otInstance *aInstance, otLinkPcapCallback aPcapCallback, void *aCallbackContext)
void
Регистрирует обратный вызов для предоставления полученных необработанных кадров IEEE 802.15.4.
otLinkSetPollPeriod ( otInstance *aInstance, uint32_t aPollPeriod)
Установить/очистить период опроса пользовательских/внешних данных для спящего конечного устройства.
otLinkSetPromiscuous ( otInstance *aInstance, bool aPromiscuous)
Включает или отключает беспорядочный режим канального уровня.
otLinkSetRadioFilterEnabled ( otInstance *aInstance, bool aFilterEnabled)
void
Включает/отключает режим радиофильтра IEEE 802.15.4.
otLinkSetRegion ( otInstance *aInstance, uint16_t aRegionCode)
Устанавливает код региона.
otLinkSetSupportedChannelMask ( otInstance *aInstance, uint32_t aChannelMask)
Установите поддерживаемую маску канала уровня MAC.

Структуры

отактивесканресулт

Представляет полученный маяк IEEE 802.15.4.

отEnergyScanResult

Представляет результат сканирования энергии.

otMacCounters

Представляет счетчики уровня MAC.

отMacFilterEntry

Представляет запись фильтра Mac.

отThreadLinkInfo

Представляет информацию, специфичную для канала, для сообщений, полученных от радиоканала Thread.

Перечисления

отмакфильтраддрессмоде

 otMacFilterAddressMode

Определяет адресный режим фильтра Mac.

Характеристики
OT_MAC_FILTER_ADDRESS_MODE_ALLOWLIST

Включен режим фильтрации адресов белого списка.

OT_MAC_FILTER_ADDRESS_MODE_DENYLIST

Включен режим фильтрации адресов из списка запрещенных.

OT_MAC_FILTER_ADDRESS_MODE_DISABLED

Фильтр адресов отключен.

Определения типов

отактивесканресулт

struct otActiveScanResult otActiveScanResult

Представляет полученный маяк IEEE 802.15.4.

отEnergyScanResult

struct otEnergyScanResult otEnergyScanResult

Представляет результат сканирования энергии.

отхандлеактивесканресулт

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

Указатель вызывается во время активного сканирования IEEE 802.15.4, когда получен маяк IEEE 802.15.4 или сканирование завершено.

Подробности
Параметры
[in] aResult
Действительный указатель на информацию маяка или NULL после завершения активного сканирования.
[in] aContext
Указатель на контекст конкретного приложения.

отхандлеэнергисканресулт

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

Указатель вызывается во время сканирования энергии IEEE 802.15.4, когда результат для канала готов или сканирование завершается.

Подробности
Параметры
[in] aResult
Действительный указатель на информацию о результатах сканирования энергии или NULL после завершения сканирования энергии.
[in] aContext
Указатель на контекст конкретного приложения.

otLinkPcapCallback

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

Указатель вызывается при получении кадра IEEE 802.15.4.

Подробности
Параметры
[in] aFrame
Указатель на полученный кадр IEEE 802.15.4.
[in] aIsTx
Передается ли этот кадр, а не получен.
[in] aContext
Указатель на контекст конкретного приложения.

otMacCounters

struct otMacCounters otMacCounters

Представляет счетчики уровня MAC.

отмакфильтраддрессмоде

enum otMacFilterAddressMode otMacFilterAddressMode

Определяет адресный режим фильтра Mac.

отMacFilterEntry

struct otMacFilterEntry otMacFilterEntry

Представляет запись фильтра Mac.

отMacFilterIterator

uint8_t otMacFilterIterator

Используется для перебора записей фильтра Mac.

отThreadLinkInfo

struct otThreadLinkInfo otThreadLinkInfo

Представляет информацию, специфичную для канала, для сообщений, полученных от радиоканала Thread.

Функции

отлинкактивескан

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

Запускает активное сканирование IEEE 802.15.4.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aScanChannels
Битовый вектор, указывающий, какие каналы сканировать (например, OT_CHANNEL_11_MASK).
[in] aScanDuration
Время в миллисекундах, необходимое для сканирования каждого канала.
[in] aCallback
Указатель на функцию, вызываемую при получении маяка или завершении сканирования.
[in] aCallbackContext
Указатель на контекст конкретного приложения.
Возвращаемые значения
OT_ERROR_NONE
Принят запрос на активное сканирование.
OT_ERROR_BUSY
Активное сканирование уже выполняется.

otLinkConvertLinkQualityToRss

int8_t otLinkConvertLinkQualityToRss(
  otInstance *aInstance,
  uint8_t aLinkQuality
)

Преобразует качество связи в типичную мощность принимаемого сигнала.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aLinkQuality
Значение LinkQuality должно находиться в диапазоне [0,3].
Возврат
Типичная платформа получила отображение мощности сигнала в aLinkQuality .

otLinkConvertRssToLinkQuality

uint8_t otLinkConvertRssToLinkQuality(
  otInstance *aInstance,
  int8_t aRss
)

Преобразует уровень принимаемого сигнала в качество связи.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aRss
Значение мощности полученного сигнала, которое необходимо преобразовать.
Возврат
Сопоставление значений качества связи с aRss .

otLinkEnergyScan

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

Запускает сканирование энергопотребления IEEE 802.15.4.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aScanChannels
Битовый вектор, указывающий, на каких каналах выполнять сканирование энергии.
[in] aScanDuration
Время в миллисекундах, необходимое для сканирования каждого канала.
[in] aCallback
Указатель на функцию, вызываемую для передачи результата сканирования при указании завершения сканирования.
[in] aCallbackContext
Указатель на контекст конкретного приложения.
Возвращаемые значения
OT_ERROR_NONE
Принят запрос на сканирование энергии.
OT_ERROR_BUSY
Не удалось запустить энергетическое сканирование.

отлинкфилтераддресс

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

Добавляет расширенный адрес в MAC-фильтр.

Доступно, если включена конфигурация OPENTHREAD_CONFIG_MAC_FILTER_ENABLE .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aExtAddress
Указатель на расширенный адрес (НЕ ДОЛЖЕН быть NULL).
Возвращаемые значения
OT_ERROR_NONE
Успешно добавлено aExtAddress в MAC-фильтр.
OT_ERROR_NO_BUFS
Доступной записи не существует.

отлинкфилтераддрссин

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

Добавляет указанный расширенный адрес в список RssIn (или изменяет существующий адрес в списке RssIn ) и устанавливает запись уровня принимаемого сигнала (в дБм) для сообщений с этого адреса.

Расширенный адрес не обязательно должен находиться в фильтре address allowlist/denylist , чтобы установить rss .

Доступно, если включена конфигурация OPENTHREAD_CONFIG_MAC_FILTER_ENABLE .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aExtAddress
Указатель на расширенный адрес IEEE 802.15.4. НЕ ДОЛЖНО быть НУЛЕМ.
[in] aRss
Уровень принимаемого сигнала (в дБм).
Возвращаемые значения
OT_ERROR_NONE
Запись для aExtAddress и aRss успешно добавлена.
OT_ERROR_NO_BUFS
Доступной записи не существует.

otLinkFilterClearAddresses

void otLinkFilterClearAddresses(
  otInstance *aInstance
)

Удаляет все расширенные адреса из MAC-фильтра.

Доступно, если включена конфигурация OPENTHREAD_CONFIG_MAC_FILTER_ENABLE .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.

otLinkFilterClearAllRssIn

void otLinkFilterClearAllRssIn(
  otInstance *aInstance
)

Удаляет все записи уровня полученного сигнала ( rss ) и индикатора качества соединения ( lqi ) (включая значения по умолчанию) из списка RssIn .

Выполнение этого действия означает, что все расширенные адреса будут использовать эфирный сигнал.

Доступно, если включена конфигурация OPENTHREAD_CONFIG_MAC_FILTER_ENABLE .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.

otLinkFilterClearDefaultRssIn

void otLinkFilterClearDefaultRssIn(
  otInstance *aInstance
)

Очищает любую ранее установленную мощность принимаемого сигнала по умолчанию (в дБм) на MAC-фильтре.

Доступно, если включена конфигурация OPENTHREAD_CONFIG_MAC_FILTER_ENABLE .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.

отлинкфилтержетаддрессмоде

otMacFilterAddressMode otLinkFilterGetAddressMode(
  otInstance *aInstance
)

Получает адресный режим фильтра MAC.

Доступно, если включена конфигурация OPENTHREAD_CONFIG_MAC_FILTER_ENABLE .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
адресный режим.

otLinkFilterGetNextAddress

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

Получает используемую запись фильтра адресов.

Доступно, если включена конфигурация OPENTHREAD_CONFIG_MAC_FILTER_ENABLE .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in,out] aIterator
Указатель на контекст итератора MAC-фильтра. Чтобы получить первую используемую запись фильтра адресов, ей следует установить значение OT_MAC_FILTER_ITERATOR_INIT. НЕ ДОЛЖНО быть НУЛЕМ.
[out] aEntry
Указатель на то, где размещается информация. НЕ ДОЛЖНО быть НУЛЕМ.
Возвращаемые значения
OT_ERROR_NONE
Успешно получена используемая запись фильтра адресов.
OT_ERROR_NOT_FOUND
Никакой последующей записи не существует.

otLinkFilterGetNextRssIn

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

Получает используемую запись фильтра RssIn.

Доступно, если включена конфигурация OPENTHREAD_CONFIG_MAC_FILTER_ENABLE .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in,out] aIterator
Указатель на контекст итератора MAC-фильтра. НЕ ДОЛЖНО быть НУЛЕМ. Чтобы получить первую запись, ей следует установить значение OT_MAC_FILTER_ITERATOR_INIT.
[out] aEntry
Указатель на то, где размещается информация. Последняя запись будет иметь расширенный адрес, состоящий из 0xff, чтобы указать мощность принимаемого сигнала по умолчанию, если она была установлена. aEntry НЕ ДОЛЖНА быть NULL.
Возвращаемые значения
OT_ERROR_NONE
Успешно получена следующая запись.
OT_ERROR_NOT_FOUND
Никакой последующей записи не существует.

отлинкфилтерремовеадрес

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

Удаляет расширенный адрес из MAC-фильтра.

Доступно, если включена конфигурация OPENTHREAD_CONFIG_MAC_FILTER_ENABLE .

Никакие действия не выполняются, если в фильтре нет записи, соответствующей данному расширенному адресу.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aExtAddress
Указатель на расширенный адрес (НЕ ДОЛЖЕН быть NULL).

otLinkFilterRemoveRssIn

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

Удаляет указанный расширенный адрес из списка RssIn .

После удаления из списка RssIn этот MAC-адрес вместо этого будет использовать настройки rss и lqi по умолчанию, при условии, что значения по умолчанию установлены. (Если настройки по умолчанию не установлены, используется эфирный сигнал.)

Доступно, если включена конфигурация OPENTHREAD_CONFIG_MAC_FILTER_ENABLE .

Никакие действия не выполняются, если в списке RssIn нет записи, соответствующей указанному расширенному адресу.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aExtAddress
Указатель на расширенный адрес IEEE 802.15.4. НЕ ДОЛЖНО быть НУЛЕМ.

отлинкфилтерсетаддрессмоде

void otLinkFilterSetAddressMode(
  otInstance *aInstance,
  otMacFilterAddressMode aMode
)

Устанавливает адресный режим фильтра MAC.

Доступно, если включена конфигурация OPENTHREAD_CONFIG_MAC_FILTER_ENABLE .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aMode
Режим адреса, который необходимо установить.

otLinkFilterSetDefaultRssIn

void otLinkFilterSetDefaultRssIn(
  otInstance *aInstance,
  int8_t aRss
)

Устанавливает мощность принимаемого сигнала по умолчанию (в дБм) для MAC-фильтра.

Доступно, если включена конфигурация OPENTHREAD_CONFIG_MAC_FILTER_ENABLE .

Значение RSS по умолчанию используется для всех полученных кадров с адресов, для которых нет явной записи RSS-IN в списке фильтров (добавлено с помощью otLinkFilterAddRssIn() ).

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aRss
Уровень принимаемого сигнала по умолчанию (в дБм), который необходимо установить.

отлинкжетккафаилурерате

uint16_t otLinkGetCcaFailureRate(
  otInstance *aInstance
)

Возвращает текущую частоту отказов CCA (оценка чистого канала).

Скорость поддерживается в течение окна (примерно) последних передач кадров OPENTHREAD_CONFIG_CCA_FAILURE_RATE_AVERAGING_WINDOW .

Подробности
Возврат
Интенсивность отказов CCA с максимальным значением 0xffff , соответствующим 100% интенсивности отказов.

otLinkGetChannel

uint8_t otLinkGetChannel(
  otInstance *aInstance
)

Получите канал IEEE 802.15.4.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Канал IEEE 802.15.4.
Смотрите также:
отлинксетканал

otLinkGetCounters

const otMacCounters * otLinkGetCounters(
  otInstance *aInstance
)

Получите счетчики уровня MAC.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Указатель на счетчики уровня MAC.

отлинкжеткслканал

uint8_t otLinkGetCslChannel(
  otInstance *aInstance
)

Получает канал CSL.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Канал CSL.

отлинкжеткслпериод

uint32_t otLinkGetCslPeriod(
  otInstance *aInstance
)

Получает период CSL в микросекундах.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Период CSL в микросекундах.

отлинкжетклтимеаут

uint32_t otLinkGetCslTimeout(
  otInstance *aInstance
)

Получает тайм-аут CSL.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Тайм-аут CSL в секундах.

отлинкжетекстендадрес

const otExtAddress * otLinkGetExtendedAddress(
  otInstance *aInstance
)

Получает расширенный адрес IEEE 802.15.4.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Указатель на расширенный адрес IEEE 802.15.4.

otLinkGetFactoryAssignedIeeEui64

void otLinkGetFactoryAssignedIeeeEui64(
  otInstance *aInstance,
  otExtAddress *aEui64
)

Получите назначенный на заводе стандарт IEEE EUI-64.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[out] aEui64
Указатель на место расположения назначенного на заводе IEEE EUI-64.

otLinkGetMaxFrameRetriesDirect

uint8_t otLinkGetMaxFrameRetriesDirect(
  otInstance *aInstance
)

Возвращает максимальное количество повторов кадров во время прямой передачи.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Максимальное количество повторов при прямой передаче.

otLinkGetMaxFrameRetriesIndirect

uint8_t otLinkGetMaxFrameRetriesIndirect(
  otInstance *aInstance
)

Возвращает максимальное количество повторов кадров во время непрямой передачи.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Максимальное количество повторов при непрямой передаче.

отлинкжетпанид

otPanId otLinkGetPanId(
  otInstance *aInstance
)

Получите идентификатор PAN IEEE 802.15.4.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Идентификатор PAN IEEE 802.15.4.
Смотрите также:
отлинксетпанид

отлинкжетполлпериод

uint32_t otLinkGetPollPeriod(
  otInstance *aInstance
)

Получите период опроса данных сонного конечного устройства.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Период опроса данных спящего конечного устройства в миллисекундах.
Смотрите также:
отлинксетполлпериод

otLinkGetRegion

otError otLinkGetRegion(
  otInstance *aInstance,
  uint16_t *aRegionCode
)

Получите код региона.

Формат радиорегиона представляет собой 2-байтовое ascii-представление кода альфа-2 ISO 3166.

Подробности
Параметры
[in] aInstance
Структура экземпляра OpenThread.
[out] aRegionCode
Код региона радио. aRegionCode >> 8 — это первый символ ascii, а aRegionCode & 0xff — второй символ ascii.
Возвращаемые значения
OT_ERROR_INVALID_ARGS
aRegionCode имеет значение nullptr.
OT_ERROR_FAILED
Другие ошибки, специфичные для платформы.
OT_ERROR_NONE
Код региона получен успешно.
OT_ERROR_NOT_IMPLEMENTED
Функция не реализована.

отлинкжетшортадрес

otShortAddress otLinkGetShortAddress(
  otInstance *aInstance
)

Получите короткий адрес IEEE 802.15.4.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Указатель на короткий адрес IEEE 802.15.4.

otLinkGetSupportedChannelMask

uint32_t otLinkGetSupportedChannelMask(
  otInstance *aInstance
)

Получите поддерживаемую маску канала уровня MAC.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Поддерживаемая маска канала: uint32_t с битом 0 (младший бит), сопоставленным с каналом 0, битом 1 с каналом 1 и т. д.

otLinkGetTxDirectRetrySuccessГистограмма

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

Получает гистограмму повторных попыток одного прямого пакета до успешного завершения.

Действительно, если включена конфигурация OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[out] aNumberOfEntries
Указатель на то, где находится размер возвращаемого массива гистограмм.
Возврат
Указатель на гистограмму повторов (в виде массива). n-й элемент указывает, что пакет был отправлен с n-й повторной попыткой.

otLinkGetTxIndirectRetrySuccessHistogram

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

Получает гистограмму повторных попыток одного косвенного пакета до успешного завершения.

Действительно, если включена конфигурация OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[out] aNumberOfEntries
Указатель на то, где находится размер возвращаемого массива гистограмм.
Возврат
Указатель на гистограмму повторов (в виде массива). n-й элемент указывает, что пакет был отправлен с n-й повторной попыткой.

отлинкисактивесканинпрогресс

bool otLinkIsActiveScanInProgress(
  otInstance *aInstance
)

Указывает, выполняется ли в данный момент активное сканирование IEEE 802.15.4.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
true, если активное сканирование IEEE 802.15.4 выполняется, в противном случае — false.

отлинкиссленаблед

bool otLinkIsCslEnabled(
  otInstance *aInstance
)

Указывает, включен ли CSL.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возвращаемые значения
TRUE
Канальный уровень включен CSL.
FALSE
Канальный уровень не поддерживает CSL.

otLinkIsCslSupported

bool otLinkIsCslSupported(
  otInstance *aInstance
)

Указывает, подключено ли устройство к родительскому устройству, поддерживающему CSL.

Подробности
Возвращаемые значения
TRUE
Если родитель поддерживает CSL.
FALSE
Если родительский элемент не поддерживает CSL.

отлинкисенаблед

bool otLinkIsEnabled(
  otInstance *aInstance
)

Указывает, включен ли канальный уровень.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возвращаемые значения
TRUE
Уровень связи включен.
FALSE
Уровень связи не включен.

otLinkIsEnergyScanInProgress

bool otLinkIsEnergyScanInProgress(
  otInstance *aInstance
)

Указывает, выполняется ли в данный момент сканирование энергопотребления IEEE 802.15.4.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
true, если выполняется сканирование энергии IEEE 802.15.4, в противном случае — false.

отлинкиссинтрансмитстате

bool otLinkIsInTransmitState(
  otInstance *aInstance
)

Указывает, находится ли MAC IEEE 802.15.4 в состоянии передачи.

Модуль MAC находится в состоянии передачи во время процедуры CSMA/CA, CCA, передачи данных, маяка или кадра запроса данных и получения ACK переданного кадра. Модуль MAC не находится в состоянии передачи во время передачи кадра ACK или кадра запроса маяка.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
true, если MAC IEEE 802.15.4 находится в состоянии передачи, в противном случае — false.

otLinkIsPromiscousous

bool otLinkIsPromiscuous(
  otInstance *aInstance
)

Указывает, включен ли неразборчивый режим на канальном уровне.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возвращаемые значения
TRUE
Беспорядочный режим включен.
FALSE
Неразборчивый режим не включен.

отлинкисрадиофилтеренаблед

bool otLinkIsRadioFilterEnabled(
  otInstance *aInstance
)

Указывает, включен ли радиофильтр IEEE 802.15.4.

Доступно, если включена конфигурация OPENTHREAD_CONFIG_MAC_FILTER_ENABLE .

Подробности
Возвращаемые значения
TRUE
Если включен радиофильтр.
FALSE
Если радиофильтр отключен.

otLinkResetCounters

void otLinkResetCounters(
  otInstance *aInstance
)

Сбрасывает счетчики уровня MAC.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.

otLinkResetTxRetrySuccessHistogram

void otLinkResetTxRetrySuccessHistogram(
  otInstance *aInstance
)

Очищает статистику гистограммы для прямых и косвенных передач.

Действительно, если включена конфигурация OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.

отлинксенддатарекуест

otError otLinkSendDataRequest(
  otInstance *aInstance
)

Ставит в очередь сообщение запроса данных IEEE 802.15.4 для передачи.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возвращаемые значения
OT_ERROR_NONE
Сообщение запроса данных IEEE 802.15.4 успешно поставлено в очередь.
OT_ERROR_INVALID_STATE
Устройство не находится в режиме приема-выключения в режиме ожидания.
OT_ERROR_NO_BUFS
Недостаточно доступных буферов сообщений.

отлинксендэмптидата

otError otLinkSendEmptyData(
  otInstance *aInstance
)

Указывает устройству отправить пустой кадр данных IEEE 802.15.4.

Поддерживается только на устройстве Rx-Off-When-Idle для отправки пустого кадра данных его родительскому устройству. Примечание. Доступно только в том случае, если включен OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возвращаемые значения
OT_ERROR_NONE
Пустое сообщение успешно поставлено в очередь.
OT_ERROR_INVALID_STATE
Устройство не находится в режиме Rx-Off-When-Idle.
OT_ERROR_NO_BUFS
Недостаточно доступных буферов сообщений.

отлинксетканал

otError otLinkSetChannel(
  otInstance *aInstance,
  uint8_t aChannel
)

Установите канал IEEE 802.15.4.

Успешно, только если протоколы потоков отключены. Успешный вызов этой функции делает недействительными активные и ожидающие наборы рабочих данных в энергонезависимой памяти.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aChannel
Канал IEEE 802.15.4.
Возвращаемые значения
OT_ERROR_NONE
Канал настроен успешно.
OT_ERROR_INVALID_ARGS
Если aChannel не находится в диапазоне [11, 26] или не входит в поддерживаемую маску канала.
OT_ERROR_INVALID_STATE
Протоколы потоков включены.
Смотрите также:
otLinkGetChannel

отлинксеткслканал

otError otLinkSetCslChannel(
  otInstance *aInstance,
  uint8_t aChannel
)

Устанавливает канал CSL.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aChannel
Пример канала CSL. Значение канала должно быть равно 0 (установить неуказанный канал CSL) или находиться в диапазоне от [1, 10] (если поддерживается частота 915 МГц) до 11, 26 .
Возвращаемые значения
OT_ERROR_NONE
Успешно установили параметры CSL.
OT_ERROR_INVALID_ARGS
Неверный aChannel .

отлинксетклпериод

otError otLinkSetCslPeriod(
  otInstance *aInstance,
  uint32_t aPeriod
)

Устанавливает период CSL в микросекундах.

Отключите CSL, установив для этого параметра значение 0 .

Период CSL ДОЛЖЕН быть кратен OT_LINK_CSL_PERIOD_TEN_SYMBOLS_UNIT_IN_USEC , в противном случае возвращается OT_ERROR_INVALID_ARGS .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aPeriod
Период CSL в микросекундах.
Возвращаемые значения
OT_ERROR_NONE
Успешно установили период CSL.
OT_ERROR_INVALID_ARGS
Неверный период CSL

отлинксетклтимеаут

otError otLinkSetCslTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Устанавливает тайм-аут CSL в секундах.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aTimeout
Тайм-аут CSL в секундах.
Возвращаемые значения
OT_ERROR_NONE
Тайм-аут CSL успешно установлен.
OT_ERROR_INVALID_ARGS
Неверный тайм-аут CSL.

отлинксетенаблед

otError otLinkSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Включает или отключает канальный уровень.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aEnable
true, чтобы включить канальный уровень, или false в противном случае.
Возвращаемые значения
OT_ERROR_NONE
Успешно включил/отключил канальный уровень.
OT_ERROR_INVALID_STATE
Не удалось отключить уровень связи, поскольку интерфейс Thread включен.

отлинксетекстендаддресс

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

Устанавливает расширенный адрес IEEE 802.15.4.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aExtAddress
Указатель на расширенный адрес IEEE 802.15.4.
Возвращаемые значения
OT_ERROR_NONE
Успешно установите расширенный адрес IEEE 802.15.4.
OT_ERROR_INVALID_ARGS
aExtAddress был NULL.
OT_ERROR_INVALID_STATE
Протоколы потоков включены.

otLinkSetMaxFrameRetriesDirect

void otLinkSetMaxFrameRetriesDirect(
  otInstance *aInstance,
  uint8_t aMaxFrameRetriesDirect
)

Устанавливает максимальное количество повторов кадров во время прямой передачи.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aMaxFrameRetriesDirect
Максимальное количество повторов при прямой передаче.

otLinkSetMaxFrameRetriesIndirect

void otLinkSetMaxFrameRetriesIndirect(
  otInstance *aInstance,
  uint8_t aMaxFrameRetriesIndirect
)

Устанавливает максимальное количество повторов кадров во время непрямой передачи.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aMaxFrameRetriesIndirect
Максимальное количество повторов при непрямой передаче.

отлинксетпанид

otError otLinkSetPanId(
  otInstance *aInstance,
  otPanId aPanId
)

Установите идентификатор PAN IEEE 802.15.4.

Успешно, только если протоколы потоков отключены. Успешный вызов этой функции также делает недействительными активные и ожидающие наборы рабочих данных в энергонезависимой памяти.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aPanId
Идентификатор PAN IEEE 802.15.4.
Возвращаемые значения
OT_ERROR_NONE
PAN ID успешно установлен.
OT_ERROR_INVALID_ARGS
Если aPanId не находится в диапазоне [0, 65534].
OT_ERROR_INVALID_STATE
Протоколы потоков включены.
Смотрите также:
отлинкжетпанид

otLinkSetPcapCallback

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

Регистрирует обратный вызов для предоставления полученных необработанных кадров IEEE 802.15.4.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aPcapCallback
Указатель на функцию, которая вызывается при получении кадра ссылки IEEE 802.15.4 или NULL для отключения обратного вызова.
[in] aCallbackContext
Указатель на контекст конкретного приложения.

отлинксетполлпериод

otError otLinkSetPollPeriod(
  otInstance *aInstance,
  uint32_t aPollPeriod
)

Установить/очистить период опроса пользовательских/внешних данных для спящего конечного устройства.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aPollPeriod
период опроса данных в миллисекундах.
Возвращаемые значения
OT_ERROR_NONE
Указанный пользователем период опроса успешно установлен/очистен.
OT_ERROR_INVALID_ARGS
Если aPollPeriod недействителен.
Смотрите также:
отлинкжетполлпериод

otLinkSetБеспорядочный

otError otLinkSetPromiscuous(
  otInstance *aInstance,
  bool aPromiscuous
)

Включает или отключает беспорядочный режим канального уровня.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aPromiscuous
true, чтобы включить беспорядочный режим, или false в противном случае.
Возвращаемые значения
OT_ERROR_NONE
Неразборчивый режим успешно включен.
OT_ERROR_INVALID_STATE
Не удалось включить неразборчивый режим, поскольку включен интерфейс Thread.

отлинксетрадиофилтеренаблед

void otLinkSetRadioFilterEnabled(
  otInstance *aInstance,
  bool aFilterEnabled
)

Включает/отключает режим радиофильтра IEEE 802.15.4.

Доступно, если включена конфигурация OPENTHREAD_CONFIG_MAC_FILTER_ENABLE .

Радиофильтр в основном предназначен для тестирования. Его можно использовать для временной блокировки всех tx/rx на радиоканале 802.15.4. Когда радиофильтр включен, радиопереводится в спящий режим вместо приема (чтобы гарантировать, что устройство не получит никаких кадров и/или потенциально не отправит подтверждение). Кроме того, запросы на передачу кадров возвращаются немедленно, без отправки кадра по беспроводной сети (возврат ошибки «нет подтверждения», если запрошено подтверждение, в противном случае возврат успеха).

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aFilterEnabled
TRUE для включения радиофильтра, FALSE для отключения

отлинксетрегион

otError otLinkSetRegion(
  otInstance *aInstance,
  uint16_t aRegionCode
)

Устанавливает код региона.

Формат радиорегиона — это 2-байтовое ascii-представление кода альфа-2 ISO 3166.

Подробности
Параметры
[in] aInstance
Структура экземпляра OpenThread.
[in] aRegionCode
Код региона радио. aRegionCode >> 8 — это первый символ ascii, а aRegionCode & 0xff — второй символ ascii.
Возвращаемые значения
OT_ERROR_FAILED
Другие ошибки, специфичные для платформы.
OT_ERROR_NONE
Код региона успешно установлен.
OT_ERROR_NOT_IMPLEMENTED
Функция не реализована.

otLinkSetSupportedChannelMask

otError otLinkSetSupportedChannelMask(
  otInstance *aInstance,
  uint32_t aChannelMask
)

Установите поддерживаемую маску канала уровня MAC.

Успешно, только если протоколы потоков отключены.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aChannelMask
Поддерживаемая маска канала (бит 0 или младший бит, сопоставленный с каналом 0 и т. д.).
Возвращаемые значения
OT_ERROR_NONE
Успешно установили поддерживаемую маску канала.
OT_ERROR_INVALID_STATE
Протоколы потоков включены.

Макросы 

 OT_LINK_CSL_PERIOD_TEN_SYMBOLS_UNIT_IN_USEC (160)

Представляет период CSL в десять символов в микросекундах.

Период CSL (в микросекундах) ДОЛЖЕН быть кратным этому значению.

OT_MAC_FILTER_FIXED_RSS_DISABLED

 OT_MAC_FILTER_FIXED_RSS_DISABLED 127

Используется для обозначения того, что фиксированная мощность принимаемого сигнала не установлена.

OT_MAC_FILTER_ITERATOR_INIT

 OT_MAC_FILTER_ITERATOR_INIT 0

Инициализатор для otMacFilterIterator.

OT_US_PER_TEN_SYMBOLS

 OT_US_PER_TEN_SYMBOLS OT_RADIO_TEN_SYMBOLS_TIME

Время для 10 символов в микросекундах.

Ресурсы

Справочные разделы API OpenThread взяты из исходного кода, доступного на GitHub . Для получения дополнительной информации или внесения вклада в нашу документацию обратитесь к Ресурсам .