Необработанная ссылка
Этот модуль включает функции, управляющие необработанной конфигурацией канального уровня.
Резюме
Определения типов |
---|
otLinkRawEnergyScanDone )(otInstance *aInstance, int8_t aEnergyScanMaxRssi) | определение типа void(* Этот указатель функции при получении кадра IEEE 802.15.4. |
otLinkRawReceiveDone )(otInstance *aInstance, otRadioFrame *aFrame, otError aError) | определение типа void(* Этот указатель функции при получении кадра IEEE 802.15.4. |
otLinkRawTransmitDone )(otInstance *aInstance, otRadioFrame *aFrame, otRadioFrame *aAckFrame, otError aError) | определение типа void(* Этот указатель функции при получении кадра IEEE 802.15.4. |
Функции |
---|
otLinkRawEnergyScan ( otInstance *aInstance, uint8_t aScanChannel, uint16_t aScanDuration, otLinkRawEnergyScanDone aCallback) | Этот метод запускает последовательность сканирования энергии на радио. |
otLinkRawGetCaps ( otInstance *aInstance) | Получить возможности радио. |
otLinkRawGetPromiscuous ( otInstance *aInstance) | bool Эта функция получает статус беспорядочного режима. |
otLinkRawGetRadioTime ( otInstance *aInstance) | uint64_t Получить текущее время платформы (ширина 64 бита) радиочипа. |
otLinkRawGetRssi ( otInstance *aInstance) | int8_t Получите самое последнее измерение RSSI. |
otLinkRawGetTransmitBuffer ( otInstance *aInstance) | Радиопереходы с передачи на прием. |
otLinkRawIsEnabled ( otInstance *aInstance) | bool Эта функция указывает, включен ли необработанный канальный уровень. |
otLinkRawReceive ( otInstance *aInstance) | Перевод радиостанции из спящего режима в режим приема. |
otLinkRawSetMacFrameCounter ( otInstance *aInstance, uint32_t aMacFrameCounter) | Устанавливает текущее значение счетчика кадров MAC. |
otLinkRawSetMacKey ( otInstance *aInstance, uint8_t aKeyIdMode, uint8_t aKeyId, const otMacKey *aPrevKey, const otMacKey *aCurrKey, const otMacKey *aNextKey) | Обновите ключи MAC и индекс ключа. |
otLinkRawSetPromiscuous ( otInstance *aInstance, bool aEnable) | Эта функция включает или отключает беспорядочный режим. |
otLinkRawSetReceiveDone ( otInstance *aInstance, otLinkRawReceiveDone aCallback) | Эта функция включает/отключает необработанный канальный уровень. |
otLinkRawSetShortAddress ( otInstance *aInstance, uint16_t aShortAddress) | Установите Короткий адрес для фильтрации адресов. |
otLinkRawSleep ( otInstance *aInstance) | Переведите радио из режима приема в спящий режим. |
otLinkRawSrcMatchAddExtEntry ( otInstance *aInstance, const otExtAddress *aExtAddress) | Добавление расширенного адреса в исходную таблицу соответствий. |
otLinkRawSrcMatchAddShortEntry ( otInstance *aInstance, uint16_t aShortAddress) | Добавление короткого адреса в исходную таблицу соответствий. |
otLinkRawSrcMatchClearExtEntries ( otInstance *aInstance) | Удаление всех расширенных адресов из исходной таблицы соответствий. |
otLinkRawSrcMatchClearExtEntry ( otInstance *aInstance, const otExtAddress *aExtAddress) | Удаление расширенного адреса в исходную таблицу соответствий радиостанции. |
otLinkRawSrcMatchClearShortEntries ( otInstance *aInstance) | Удаление всех коротких адресов из исходной таблицы соответствий. |
otLinkRawSrcMatchClearShortEntry ( otInstance *aInstance, uint16_t aShortAddress) | Удаление короткого адреса из исходной таблицы соответствий. |
otLinkRawSrcMatchEnable ( otInstance *aInstance, bool aEnable) | Включить/выключить соответствие источника для ожидающего кадра. |
otLinkRawTransmit ( otInstance *aInstance, otLinkRawTransmitDone aCallback) | Этот метод начинает последовательность передачи по радио. |
Определения типов
otLinkRawEnergyScanDone
void(* otLinkRawEnergyScanDone)(otInstance *aInstance, int8_t aEnergyScanMaxRssi)
Этот указатель функции при получении кадра IEEE 802.15.4.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. | [in] aEnergyScanMaxRssi | Максимальный RSSI, обнаруженный на сканируемом канале. |
|
otLinkRawReceiveDone
void(* otLinkRawReceiveDone)(otInstance *aInstance, otRadioFrame *aFrame, otError aError)
Этот указатель функции при получении кадра IEEE 802.15.4.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. | [in] aFrame | Указатель на полученный кадр или NULL, если операция приема была прервана. | [in] aError | OT_ERROR_NONE при успешном получении кадра. OT_ERROR_ABORT, когда прием был прерван, а кадр не получен. |
|
otLinkRawTransmitDone
void(* otLinkRawTransmitDone)(otInstance *aInstance, otRadioFrame *aFrame, otRadioFrame *aAckFrame, otError aError)
Этот указатель функции при получении кадра IEEE 802.15.4.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. | [in] aFrame | Указатель на кадр, который был передан. | [in] aAckFrame | Указатель на кадр ACK. | [in] aError | OT_ERROR_NONE при передаче кадра. OT_ERROR_NO_ACK, когда кадр был передан, но не было получено подтверждения OT_ERROR_CHANNEL_ACCESS_FAILURE, когда передача не могла быть осуществлена из-за активности на канале. OT_ERROR_ABORT, когда передача была прервана по другим причинам. |
|
Функции
otLinkRawEnergyScan
otError otLinkRawEnergyScan(
otInstance *aInstance,
uint8_t aScanChannel,
uint16_t aScanDuration,
otLinkRawEnergyScanDone aCallback
)
Этот метод запускает последовательность сканирования энергии на радио.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. | [in] aScanChannel | Канал для сканирования энергии. | [in] aScanDuration | Продолжительность сканирования канала в миллисекундах. | [in] aCallback | Указатель на функцию, вызываемую по завершении сканирования канала. |
|
Возвращаемые значения | OT_ERROR_NONE | Успешно начал сканирование канала. | OT_ERROR_BUSY | Радио выполняет энергетическое сканирование. | OT_ERROR_NOT_IMPLEMENTED | Радио не поддерживает сканирование энергии. | OT_ERROR_INVALID_STATE | Если необработанный канальный слой не включен. |
|
otLinkRawGetCaps
otRadioCaps otLinkRawGetCaps(
otInstance *aInstance
)
Получить возможности радио.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. |
|
Возвращает | Битовый вектор возможностей радиосвязи. Стек включает или отключает некоторые функции на основе этого значения. |
otLinkRawGetPromiscuous
bool otLinkRawGetPromiscuous(
otInstance *aInstance
)
Эта функция получает статус беспорядочного режима.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. |
|
Возвращаемые значения | true | Неразборчивый режим включен. | false | Неразборчивый режим отключен. |
|
otLinkRawGetRadioTime
uint64_t otLinkRawGetRadioTime(
otInstance *aInstance
)
Получить текущее время платформы (ширина 64 бита) радиочипа.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. |
|
Возвращает | Текущее время радио в микросекундах. |
int8_t otLinkRawGetRssi(
otInstance *aInstance
)
Получите самое последнее измерение RSSI.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. |
|
Возвращает | RSSI в дБм, когда он действителен. 127, когда RSSI недействителен. |
otLinkRawGetTransmitBuffer
otRadioFrame * otLinkRawGetTransmitBuffer(
otInstance *aInstance
)
Радиопереходы с передачи на прием.
Этот метод возвращает указатель на буфер передачи.
Вызывающий объект формирует кадр IEEE 802.15.4 в этом буфере, а затем вызывает otLinkRawTransmit() для запроса передачи.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. |
|
Возвращает | Указатель на буфер передачи или NULL, если необработанный канальный уровень не включен. |
otLinkRawIsEnabled
bool otLinkRawIsEnabled(
otInstance *aInstance
)
Эта функция указывает, включен ли необработанный канальный уровень.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. |
|
Возвращаемые значения | true | Необработанный канальный уровень включен. | false | Необработанный канальный слой отключен. |
|
otLinkRawReceive
otError otLinkRawReceive(
otInstance *aInstance
)
Перевод радиостанции из спящего режима в режим приема.
Включи радио.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. |
|
Возвращаемые значения | OT_ERROR_NONE | Успешный переход к получению. | OT_ERROR_INVALID_STATE | Радио было отключено или работало на передачу. |
|
otLinkRawSetMacFrameCounter
otError otLinkRawSetMacFrameCounter(
otInstance *aInstance,
uint32_t aMacFrameCounter
)
Устанавливает текущее значение счетчика кадров MAC.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. | [in] aMacFrameCounter | Значение счетчика кадров MAC. |
|
Возвращаемые значения | OT_ERROR_NONE | В случае успеха. | OT_ERROR_INVALID_STATE | Если необработанный канальный слой не включен. |
|
otLinkRawSetMacKey
otError otLinkRawSetMacKey(
otInstance *aInstance,
uint8_t aKeyIdMode,
uint8_t aKeyId,
const otMacKey *aPrevKey,
const otMacKey *aCurrKey,
const otMacKey *aNextKey
)
Обновите ключи MAC и индекс ключа.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. | [in] aKeyIdMode | Режим идентификации ключа. | [in] aKeyId | Ключевой индекс. | [in] aPrevKey | Предыдущий MAC-ключ. | [in] aCurrKey | Текущий MAC-ключ. | [in] aNextKey | Следующий MAC-ключ. |
|
Возвращаемые значения | OT_ERROR_NONE | В случае успеха. | OT_ERROR_INVALID_STATE | Если необработанный канальный слой не включен. |
|
otLinkRawSetPromiscuous
otError otLinkRawSetPromiscuous(
otInstance *aInstance,
bool aEnable
)
Эта функция включает или отключает беспорядочный режим.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. | [in] aEnable | Значение для включения или отключения беспорядочного режима. |
|
Возвращаемые значения | OT_ERROR_NONE | В случае успеха. | OT_ERROR_INVALID_STATE | Если необработанный канальный слой не включен. |
|
otLinkRawSetReceiveDone
otError otLinkRawSetReceiveDone(
otInstance *aInstance,
otLinkRawReceiveDone aCallback
)
Эта функция включает/отключает необработанный канальный уровень.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. | [in] aCallback | Указатель на функцию, вызываемую при получении кадра IEEE 802.15.4. NULL, чтобы отключить уровень необработанных ссылок. |
|
Возвращаемые значения | OT_ERROR_FAILED | Радио не может быть включено/отключено. | OT_ERROR_INVALID_STATE | Если интерфейс OpenThread IPv6 уже включен. | OT_ERROR_NONE | Если состояние включения было успешно установлено. |
|
otLinkRawSetShortAddress
otError otLinkRawSetShortAddress(
otInstance *aInstance,
uint16_t aShortAddress
)
Установите Короткий адрес для фильтрации адресов.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. | [in] aShortAddress | Короткий адрес IEEE 802.15.4. |
|
Возвращаемые значения | OT_ERROR_NONE | В случае успеха. | OT_ERROR_INVALID_STATE | Если необработанный канальный слой не включен. |
|
otLinkRawSleep
otError otLinkRawSleep(
otInstance *aInstance
)
Переведите радио из режима приема в спящий режим.
Выключите радио.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. |
|
Возвращаемые значения | OT_ERROR_NONE | Успешно переведен в режим сна. | OT_ERROR_BUSY | Радио передавало | OT_ERROR_INVALID_STATE | Радио было отключено |
|
otLinkRawSrcMatchAddExtEntry
otError otLinkRawSrcMatchAddExtEntry(
otInstance *aInstance,
const otExtAddress *aExtAddress
)
Добавление расширенного адреса в исходную таблицу соответствий.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. | [in] aExtAddress | Добавляемый расширенный адрес. |
|
Возвращаемые значения | OT_ERROR_NONE | Расширенный адрес успешно добавлен в исходную таблицу соответствий. | OT_ERROR_NO_BUFS | Нет доступной записи в исходной таблице соответствий. | OT_ERROR_INVALID_STATE | Если необработанный канальный слой не включен. |
|
otLinkRawSrcMatchAddShortEntry
otError otLinkRawSrcMatchAddShortEntry(
otInstance *aInstance,
uint16_t aShortAddress
)
Добавление короткого адреса в исходную таблицу соответствий.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. | [in] aShortAddress | Короткий адрес, который нужно добавить. |
|
Возвращаемые значения | OT_ERROR_NONE | Короткий адрес успешно добавлен в исходную таблицу соответствий. | OT_ERROR_NO_BUFS | Нет доступной записи в исходной таблице соответствий. | OT_ERROR_INVALID_STATE | Если необработанный канальный слой не включен. |
|
otLinkRawSrcMatchClearExtEntries
otError otLinkRawSrcMatchClearExtEntries(
otInstance *aInstance
)
Удаление всех расширенных адресов из исходной таблицы соответствий.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. |
|
Возвращаемые значения | OT_ERROR_NONE | В случае успеха. | OT_ERROR_INVALID_STATE | Если необработанный канальный слой не включен. |
|
otLinkRawSrcMatchClearExtEntry
otError otLinkRawSrcMatchClearExtEntry(
otInstance *aInstance,
const otExtAddress *aExtAddress
)
Удаление расширенного адреса в исходную таблицу соответствий радиостанции.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. | [in] aExtAddress | Расширенный адрес будет удален. |
|
Возвращаемые значения | OT_ERROR_NONE | Успешно удален расширенный адрес из исходной таблицы соответствий. | OT_ERROR_NO_ADDRESS | Расширенный адрес отсутствует в исходной таблице соответствий. | OT_ERROR_INVALID_STATE | Если необработанный канальный слой не включен. |
|
otLinkRawSrcMatchClearShortEntries
otError otLinkRawSrcMatchClearShortEntries(
otInstance *aInstance
)
Удаление всех коротких адресов из исходной таблицы соответствий.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. |
|
Возвращаемые значения | OT_ERROR_NONE | В случае успеха. | OT_ERROR_INVALID_STATE | Если необработанный канальный слой не включен. |
|
otLinkRawSrcMatchClearShortEntry
otError otLinkRawSrcMatchClearShortEntry(
otInstance *aInstance,
uint16_t aShortAddress
)
Удаление короткого адреса из исходной таблицы соответствий.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. | [in] aShortAddress | Короткий адрес, который нужно удалить. |
|
Возвращаемые значения | OT_ERROR_NONE | Короткий адрес успешно удален из исходной таблицы соответствий. | OT_ERROR_NO_ADDRESS | Короткий адрес отсутствует в исходной таблице соответствий. | OT_ERROR_INVALID_STATE | Если необработанный канальный слой не включен. |
|
otLinkRawSrcMatchEnable
otError otLinkRawSrcMatchEnable(
otInstance *aInstance,
bool aEnable
)
Включить/выключить соответствие источника для ожидающего кадра.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. | [in] aEnable | Включить/выключить соответствие источника для ожидающего кадра. |
|
Возвращаемые значения | OT_ERROR_NONE | В случае успеха. | OT_ERROR_INVALID_STATE | Если необработанный канальный слой не включен. |
|
otLinkRawTransmit
otError otLinkRawTransmit(
otInstance *aInstance,
otLinkRawTransmitDone aCallback
)
Этот метод начинает последовательность передачи по радио.
Вызывающий должен сформировать кадр IEEE 802.15.4 в буфере, предоставляемом функцией otLinkRawGetTransmitBuffer() , прежде чем запрашивать передачу. Канал и мощность передачи также включены в структуру otRadioFrame .
Последовательность передачи состоит из:
- Перевод радио на передачу с приема.
- Передает PSDU по заданному каналу и с заданной мощностью передачи.
Подробности | Параметры | [in] aInstance | Указатель на экземпляр OpenThread. | [in] aCallback | Указатель на функцию, вызываемую по завершении передачи. |
|
Возвращаемые значения | OT_ERROR_NONE | Успешный переход на передачу. | OT_ERROR_INVALID_STATE | Радио не находилось в состоянии приема. |
|
Ресурсы
Разделы справочника по API OpenThread взяты из исходного кода, доступного на GitHub . Чтобы получить дополнительную информацию или внести свой вклад в нашу документацию, обратитесь к разделу Ресурсы .