Связать метрики

Этот модуль включает функции, управляющие протоколом Link Metrics.

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

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

otLinkMetricsEnhAckFlags {
OT_LINK_METRICS_ENH_ACK_CLEAR = 0,
OT_LINK_METRICS_ENH_ACK_REGISTER = 1
}		 перечисление
Флаги расширенного подтверждения.
otLinkMetricsStatus перечисление
Значения состояния метрик связи.

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

otLinkMetricsEnhAckFlags определение типа
Флаги расширенного подтверждения.
otLinkMetricsEnhAckProbingIeReportCallback )(otShortAddress aShortAddress, const otExtAddress *aExtAddress, const otLinkMetricsValues *aMetricsValues, void *aContext) определение типа
void(*
Указатель вызывается при получении IE Enh-ACK Probing IE.
otLinkMetricsMgmtResponseCallback )(const otIp6Address *aSource, otLinkMetricsStatus aStatus, void *aContext) определение типа
void(*
Указатель вызывается при получении ответа управления метриками канала.
otLinkMetricsReportCallback )(const otIp6Address *aSource, const otLinkMetricsValues *aMetricsValues, otLinkMetricsStatus aStatus, void *aContext) определение типа
void(*
Указатель вызывается при получении отчета Link Metrics.
otLinkMetricsSeriesFlags определение типа
Указывает, какие кадры учитываются в серии прямого отслеживания.
otLinkMetricsStatus определение типа
Значения состояния метрик связи.
otLinkMetricsValues определение типа
Представляет результат (значение) запроса Link Metrics.

Функции

otLinkMetricsConfigEnhAckProbing ( otInstance *aInstance, const otIp6Address *aDestination, otLinkMetricsEnhAckFlags aEnhAckFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext, otLinkMetricsEnhAckProbingIeReportCallback aEnhAckCallback, void *aEnhAckCallbackContext)
Отправляет запрос управления метриками канала MLE для настройки/очистки зондирования на основе расширенного ACK.
otLinkMetricsConfigForwardTrackingSeries ( otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, otLinkMetricsSeriesFlags aSeriesFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext)
Отправляет запрос на управление метриками канала MLE для настройки или очистки серии прямого отслеживания.
otLinkMetricsManagerGetMetricsValueByExtAddr ( otInstance *aInstance, const otExtAddress *aExtAddress, otLinkMetricsValues *aLinkMetricsValues)
Получите данные Link Metrics соседа по его расширенному адресу.
otLinkMetricsManagerSetEnabled ( otInstance *aInstance, bool aEnable)
void
Включите или отключите Link Metrics Manager.
otLinkMetricsQuery ( otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsReportCallback aCallback, void *aCallbackContext)
Отправляет запрос данных MLE для запроса метрик канала.
otLinkMetricsSendLinkProbe ( otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, uint8_t aLength)
Отправляет сообщение MLE Link Probe.

Структуры

otLinkMetricsSeriesFlags

Указывает, какие кадры учитываются в серии прямого отслеживания.

otLinkMetricsValues

Представляет результат (значение) запроса Link Metrics.

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

otLinkMetricsEnhAckFlags

 otLinkMetricsEnhAckFlags

Флаги расширенного подтверждения.

Они используются при зондировании на основе расширенного ACK, чтобы указать, следует ли зарегистрировать или очистить зондирование.

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

Прозрачный.

OT_LINK_METRICS_ENH_ACK_REGISTER

Регистр.

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

 otLinkMetricsStatus

Значения состояния метрик связи.

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

otLinkMetricsEnhAckFlags

enum otLinkMetricsEnhAckFlags otLinkMetricsEnhAckFlags

Флаги расширенного подтверждения.

Они используются при зондировании на основе расширенного ACK, чтобы указать, следует ли зарегистрировать или очистить зондирование.

otLinkMetricsEnhAckProbingIeReportCallback

void(* otLinkMetricsEnhAckProbingIeReportCallback)(otShortAddress aShortAddress, const otExtAddress *aExtAddress, const otLinkMetricsValues *aMetricsValues, void *aContext)

Указатель вызывается при получении IE Enh-ACK Probing IE.

Подробности
Параметры
[in] aShortAddress
Короткий Mac-адрес исследуемого субъекта.
[in] aExtAddress
Указатель на расширенный Mac-адрес исследуемого субъекта.
[in] aMetricsValues
Указатель на значения метрик канала, полученные от IE.
[in] aContext
Указатель на контекст конкретного приложения.

otLinkMetricsMgmtResponseCallback

void(* otLinkMetricsMgmtResponseCallback)(const otIp6Address *aSource, otLinkMetricsStatus aStatus, void *aContext)

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

Подробности
Параметры
[in] aSource
Указатель на адрес источника.
[in] aStatus
Код состояния в ответе.
[in] aContext
Указатель на контекст конкретного приложения.

otLinkMetricsReportCallback

void(* otLinkMetricsReportCallback)(const otIp6Address *aSource, const otLinkMetricsValues *aMetricsValues, otLinkMetricsStatus aStatus, void *aContext)

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

Подробности
Параметры
[in] aSource
Указатель на адрес источника.
[in] aMetricsValues
Указатель на значения метрик ссылок (результат запроса).
[in] aStatus
Код состояния в отчете (полезно только в том случае, если aMetricsValues ​​имеет значение NULL).
[in] aContext
Указатель на контекст конкретного приложения.

otLinkMetricsSeriesFlags

struct otLinkMetricsSeriesFlags otLinkMetricsSeriesFlags

Указывает, какие кадры учитываются в серии прямого отслеживания.

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

enum otLinkMetricsStatus otLinkMetricsStatus

Значения состояния метрик связи.

otLinkMetricsValues

struct otLinkMetricsValues otLinkMetricsValues

Представляет результат (значение) запроса Link Metrics.

Функции

otLinkMetricsConfigEnhAckProbing

otError otLinkMetricsConfigEnhAckProbing(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  otLinkMetricsEnhAckFlags aEnhAckFlags,
  const otLinkMetrics *aLinkMetricsFlags,
  otLinkMetricsMgmtResponseCallback aCallback,
  void *aCallbackContext,
  otLinkMetricsEnhAckProbingIeReportCallback aEnhAckCallback,
  void *aEnhAckCallbackContext
)

Отправляет запрос управления метриками канала MLE для настройки/очистки зондирования на основе расширенного ACK.

Для этой функции требуется включенная функция OT_LINK_METRICS_INITIATOR.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aDestination
Указатель на адрес назначения.
[in] aEnhAckFlags
Enh-ACK Флаги, указывающие, регистрировать или очищать зондирование. 0 для очистки и 1 для регистрации. Другие значения зарезервированы.
[in] aLinkMetricsFlags
Указатель на флаги, определяющие, какие метрики запрашивать. Должно быть NULL , когда aEnhAckFlags равно 0 .
[in] aCallback
Указатель на функцию, которая вызывается при получении расширенного подтверждения с метриками канала.
[in] aCallbackContext
Указатель на контекст конкретного приложения.
Возвращаемые значения
OT_ERROR_NONE
Сообщение с запросом на управление метриками каналов успешно отправлено.
OT_ERROR_NO_BUFS
Недостаточно буферов для генерации сообщения запроса управления метриками канала MLE.
OT_ERROR_INVALID_ARGS
aEnhAckFlags не является допустимым значением или aLinkMetricsFlags является неправильным.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination не является локальным для канала или сосед не найден.
OT_ERROR_NOT_CAPABLE
Сосед не является устройством Thread 1.2 и не поддерживает Link Metrics.

otLinkMetricsConfigForwardTrackingSeries

otError otLinkMetricsConfigForwardTrackingSeries(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  uint8_t aSeriesId,
  otLinkMetricsSeriesFlags aSeriesFlags,
  const otLinkMetrics *aLinkMetricsFlags,
  otLinkMetricsMgmtResponseCallback aCallback,
  void *aCallbackContext
)

Отправляет запрос на управление метриками канала MLE для настройки или очистки серии прямого отслеживания.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aDestination
Указатель на адрес назначения.
[in] aSeriesId
Идентификатор серии для работы.
[in] aSeriesFlags
Флаги серий, указывающие, какие кадры следует учитывать.
[in] aLinkMetricsFlags
Указатель на флаги, определяющие, какие метрики запрашивать. Должно быть NULL , если aSeriesFlags равно 0 .
[in] aCallback
Указатель на функцию, которая вызывается при получении ответа управления метриками каналов.
[in] aCallbackContext
Указатель на контекст конкретного приложения.
Возвращаемые значения
OT_ERROR_NONE
Сообщение с запросом на управление метриками каналов успешно отправлено.
OT_ERROR_NO_BUFS
Недостаточно буферов для генерации сообщения запроса управления метриками канала MLE.
OT_ERROR_INVALID_ARGS
aSeriesId находится за пределами допустимого диапазона.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination не является локальным для канала или сосед не найден.
OT_ERROR_NOT_CAPABLE
Сосед не является устройством Thread 1.2 и не поддерживает Link Metrics.

otLinkMetricsManagerGetMetricsValueByExtAddr

otError otLinkMetricsManagerGetMetricsValueByExtAddr(
  otInstance *aInstance,
  const otExtAddress *aExtAddress,
  otLinkMetricsValues *aLinkMetricsValues
)

Получите данные Link Metrics соседа по его расширенному адресу.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aExtAddress
Указатель на расширенный Mac-адрес исследуемого субъекта.
[out] aLinkMetricsValues
Указатель на значения показателей ссылок субъекта.
Возвращаемые значения
OT_ERROR_NONE
Данные Link Metrics успешно получены.
OT_ERROR_INVALID_ARGS
Аргументы недействительны.
OT_ERROR_NOT_FOUND
Сосед с данным расширенным адресом не найден.

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

void otLinkMetricsManagerSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Включите или отключите Link Metrics Manager.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aEnable
Логическое значение, указывающее на включение или отключение.

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

otError otLinkMetricsQuery(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  uint8_t aSeriesId,
  const otLinkMetrics *aLinkMetricsFlags,
  otLinkMetricsReportCallback aCallback,
  void *aCallbackContext
)

Отправляет запрос данных MLE для запроса метрик канала.

Это может быть либо одиночный зонд, либо серия прямого слежения.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aDestination
Указатель на адрес назначения.
[in] aSeriesId
Идентификатор серии для запроса, 0 для одиночного зонда.
[in] aLinkMetricsFlags
Указатель на флаги, определяющие, какие метрики запрашивать.
[in] aCallback
Указатель на функцию, которая вызывается при получении отчета Link Metrics.
[in] aCallbackContext
Указатель на контекст конкретного приложения.
Возвращаемые значения
OT_ERROR_NONE
Сообщение с запросом Link Metrics успешно отправлено.
OT_ERROR_NO_BUFS
Недостаточно буферов для генерации сообщения запроса данных MLE.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination не является локальным для канала или сосед не найден.
OT_ERROR_NOT_CAPABLE
Сосед не является устройством Thread 1.2 и не поддерживает Link Metrics.

otLinkMetricsSendLinkProbe

otError otLinkMetricsSendLinkProbe(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  uint8_t aSeriesId,
  uint8_t aLength
)

Отправляет сообщение MLE Link Probe.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aDestination
Указатель на адрес назначения.
[in] aSeriesId
Идентификатор серии [1, 254], на который направлено сообщение зонда.
[in] aLength
Длина полезных данных в Link Probe TLV, 0, 64 .
Возвращаемые значения
OT_ERROR_NONE
Сообщение Link Probe успешно отправлено.
OT_ERROR_NO_BUFS
Недостаточно буферов для генерации сообщения MLE Link Probe.
OT_ERROR_INVALID_ARGS
aSeriesId или aLength находится за пределами допустимого диапазона.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination не является локальным для канала или сосед не найден.
OT_ERROR_NOT_CAPABLE
Сосед не является устройством Thread 1.2 и не поддерживает Link Metrics.

Ресурсы

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