Этот модуль включает абстракцию платформы для функций диагностики.
Краткое содержание
Функции |
---|
otPlatDiagAlarmCallback ( otInstance *aInstance) | void Обрабатывает тревожное событие. |
otPlatDiagChannelSet (uint8_t aChannel) | void Устанавливает канал, который будет использоваться для заводской диагностики. |
otPlatDiagGpioGet (uint32_t aGpio, bool *aValue) | Получает значение gpio. |
otPlatDiagGpioGetMode (uint32_t aGpio, otGpioMode *aMode) | Получает режим gpio. |
otPlatDiagGpioSet (uint32_t aGpio, bool aValue) | Устанавливает значение gpio. |
otPlatDiagGpioSetMode (uint32_t aGpio, otGpioMode aMode) | Устанавливает режим gpio. |
otPlatDiagModeGet (void) | bool Указывает, включен ли режим заводской диагностики. |
otPlatDiagModeSet (bool aMode) | void Включает/отключает режим заводской диагностики. |
otPlatDiagProcess ( otInstance *aInstance, uint8_t aArgsLength, char *aArgs[], char *aOutput, size_t aOutputMaxLen) | Обрабатывает командную строку заводской диагностики. |
otPlatDiagRadioGetPowerSettings ( otInstance *aInstance, uint8_t aChannel, int16_t *aTargetPower, int16_t *aActualPower, uint8_t *aRawPowerSetting, uint16_t *aRawPowerSettingLength) | Получите настройки мощности для данного канала. |
otPlatDiagRadioGetRawPowerSetting ( otInstance *aInstance, uint8_t *aRawPowerSetting, uint16_t *aRawPowerSettingLength) | Получите необработанные настройки мощности радио для диагностического модуля. |
otPlatDiagRadioRawPowerSettingEnable ( otInstance *aInstance, bool aEnable) | |
otPlatDiagRadioReceived ( otInstance *aInstance, otRadioFrame *aFrame, otError aError) | void Обрабатывает полученный радиокадр. |
otPlatDiagRadioSetRawPowerSetting ( otInstance *aInstance, const uint8_t *aRawPowerSetting, uint16_t aRawPowerSettingLength) | Установите настройки мощности радиомодуля для диагностического модуля. |
otPlatDiagRadioTransmitCarrier ( otInstance *aInstance, bool aEnable) | Запустите/остановите уровень платформы для передачи непрерывной несущей волны. |
otPlatDiagRadioTransmitStream ( otInstance *aInstance, bool aEnable) | Запустите/остановите уровень платформы для передачи потока символов. |
otPlatDiagTxPowerSet (int8_t aTxPower) | void Устанавливает мощность передачи, используемую для заводской диагностики. |
Перечисления
отGpioMode
otGpioMode
Определяет режимы gpio.
Характеристики |
---|
OT_GPIO_MODE_INPUT | Режим входа без тянущего резистора. |
OT_GPIO_MODE_OUTPUT | Режим вывода. |
Функции
otPlatDiagAlarmCallback
void otPlatDiagAlarmCallback(
otInstance *aInstance
)
Обрабатывает тревожное событие.
Подробности | Параметры | [in] aInstance | Экземпляр OpenThread для текущего запроса. |
|
отПлатдиагканалсет
void otPlatDiagChannelSet(
uint8_t aChannel
)
Устанавливает канал, который будет использоваться для заводской диагностики.
Подробности | Параметры | [in] aChannel | Стоимость канала. |
|
otPlatDiagGpioGet
otError otPlatDiagGpioGet(
uint32_t aGpio,
bool *aValue
)
Получает значение gpio.
Подробности | Параметры | [in] aGpio | Номер gpio. | [out] aValue | Указатель, куда поместить значение gpio. |
|
Возвращаемые значения | OT_ERROR_NONE | Значение gpio получено успешно. | OT_ERROR_FAILED | Произошла ошибка платформы при получении значения gpio. | OT_ERROR_INVALID_ARGS | aGpio не поддерживается или aValue имеет значение NULL. | OT_ERROR_INVALID_STATE | Режим диагностики не включен или aGpio не настроен в качестве входа. | OT_ERROR_NOT_IMPLEMENTED | Эта функция не реализована и не настроена на платформе. |
|
отПлатдиаггпиожетмоде
otError otPlatDiagGpioGetMode(
uint32_t aGpio,
otGpioMode *aMode
)
Получает режим gpio.
Подробности | Параметры | [in] aGpio | Номер gpio. | [out] aMode | Указатель, куда поставить режим gpio. |
|
Возвращаемые значения | OT_ERROR_NONE | Успешно получил режим gpio. | OT_ERROR_FAILED | Режим, возвращаемый платформой, не реализован в OpenThread, или при получении режима gpio произошла ошибка платформы. | OT_ERROR_INVALID_ARGS | aGpio не поддерживается или aMode имеет значение NULL. | OT_ERROR_INVALID_STATE | Режим диагностики не был включен. | OT_ERROR_NOT_IMPLEMENTED | Эта функция не реализована и не настроена на платформе. |
|
otPlatDiagGpioSet
otError otPlatDiagGpioSet(
uint32_t aGpio,
bool aValue
)
Устанавливает значение gpio.
Подробности | Параметры | [in] aGpio | Номер gpio. | [in] aValue | true, чтобы установить высокий уровень gpio, или false в противном случае. |
|
Возвращаемые значения | OT_ERROR_NONE | Успешно установил gpio. | OT_ERROR_FAILED | Произошла ошибка платформы при настройке gpio. | OT_ERROR_INVALID_ARGS | aGpio не поддерживается. | OT_ERROR_INVALID_STATE | Режим диагностики не включен или aGpio не настроен как выход. | OT_ERROR_NOT_IMPLEMENTED | Эта функция не реализована и не настроена на платформе. |
|
отПлатдиаггпиосетмоде
otError otPlatDiagGpioSetMode(
uint32_t aGpio,
otGpioMode aMode
)
Устанавливает режим gpio.
Подробности | Параметры | [in] aGpio | Номер gpio. | [out] aMode | Режим gpio. |
|
Возвращаемые значения | OT_ERROR_NONE | Успешно установили режим gpio. | OT_ERROR_FAILED | Произошла ошибка платформы при настройке режима gpio. | OT_ERROR_INVALID_ARGS | aGpio или aMode не поддерживаются. | OT_ERROR_INVALID_STATE | Режим диагностики не был включен. | OT_ERROR_NOT_IMPLEMENTED | Эта функция не реализована и не настроена на платформе. |
|
отплатдиагмодежет
bool otPlatDiagModeGet(
void
)
Указывает, включен ли режим заводской диагностики.
Подробности | Возврат | TRUE, если включен режим заводской диагностики, в противном случае FALSE. |
отПлатдиагмодесет
void otPlatDiagModeSet(
bool aMode
)
Включает/отключает режим заводской диагностики.
Подробности | Параметры | [in] aMode | TRUE для включения режима диагностики, FALSE в противном случае. |
|
отПлатДиагПроцесс
otError otPlatDiagProcess(
otInstance *aInstance,
uint8_t aArgsLength,
char *aArgs[],
char *aOutput,
size_t aOutputMaxLen
)
Обрабатывает командную строку заводской диагностики.
Вывод этой функции (содержимое, записанное в aOutput
) ДОЛЖЕН заканчиваться символом \0
, и \0
находится в выходном буфере.
Подробности | Параметры | [in] aInstance | Экземпляр OpenThread для текущего запроса. | [in] aArgsLength | Количество аргументов в aArgs . | [in] aArgs | Аргументы командной строки диагностики. | [out] aOutput | Результат выполнения диагностики. | [in] aOutputMaxLen | Размер выходного буфера. |
|
Возвращаемые значения | OT_ERROR_INVALID_ARGS | Команда поддерживается, но предоставлены недопустимые аргументы. | OT_ERROR_NONE | Команда успешно обработана. | OT_ERROR_INVALID_COMMAND | Команда недействительна или не поддерживается. |
|
otPlatDiagRadioGetPowerSettings
otError otPlatDiagRadioGetPowerSettings(
otInstance *aInstance,
uint8_t aChannel,
int16_t *aTargetPower,
int16_t *aActualPower,
uint8_t *aRawPowerSetting,
uint16_t *aRawPowerSettingLength
)
Получите настройки мощности для данного канала.
Подробности | Параметры | [in] aInstance | Структура экземпляра OpenThread. | [in] aChannel | Радиоканал. | [out] aTargetPower | Целевая мощность в 0,01 дБм. | [out] aActualPower | Реальная мощность в 0,01 дБм. | [out] aRawPowerSetting | Указатель на массив байтов необработанной настройки мощности. | [in,out] aRawPowerSettingLength | На входе указатель на размер aRawPowerSetting . На выходе указатель на длину необработанных данных настройки мощности. |
|
Возвращаемые значения | OT_ERROR_NONE | Успешно получена целевая мощность. | OT_ERROR_INVALID_ARGS | aChannel недействителен, aActualPower , aRawPowerSetting или aRawPowerSettingLength имеет значение NULL или слишком короткий. | OT_ERROR_NOT_FOUND | Настройки питания для aChannel не найдены. | OT_ERROR_NOT_IMPLEMENTED | Этот метод не реализован. |
|
otPlatDiagRadioGetRawPowerSetting
otError otPlatDiagRadioGetRawPowerSetting(
otInstance *aInstance,
uint8_t *aRawPowerSetting,
uint16_t *aRawPowerSettingLength
)
Получите необработанные настройки мощности радио для диагностического модуля.
Подробности | Параметры | [in] aInstance | Структура экземпляра OpenThread. | [out] aRawPowerSetting | Указатель на массив байтов необработанной настройки мощности. | [in,out] aRawPowerSettingLength | На входе указатель на размер aRawPowerSetting . На выходе указатель на длину необработанных данных настройки мощности. |
|
Возвращаемые значения | OT_ERROR_NONE | Успешно установите исходную настройку мощности. | OT_ERROR_INVALID_ARGS | aRawPowerSetting или aRawPowerSettingLength имеет значение NULL или слишком короткое. | OT_ERROR_NOT_FOUND | Необработанная настройка мощности не установлена. | OT_ERROR_NOT_IMPLEMENTED | Этот метод не реализован. |
|
otPlatDiagRadioRawPowerSettingEnable
otError otPlatDiagRadioRawPowerSettingEnable(
otInstance *aInstance,
bool aEnable
)
Включите/отключите уровень платформы, чтобы использовать необработанные настройки мощности, установленные с помощью otPlatDiagRadioSetRawPowerSetting()
.
Подробности | Параметры | [in] aInstance | Структура экземпляра OpenThread. | [in] aEnable | TRUE, чтобы включить или FALSE, чтобы отключить настройку необработанной мощности. |
|
Возвращаемые значения | OT_ERROR_NONE | Успешно включил/отключил настройку необработанной мощности. | OT_ERROR_NOT_IMPLEMENTED | Этот метод не реализован. |
|
otPlatDiagRadioReceived
void otPlatDiagRadioReceived(
otInstance *aInstance,
otRadioFrame *aFrame,
otError aError
)
Обрабатывает полученный радиокадр.
Подробности | Параметры | [in] aInstance | Экземпляр OpenThread для текущего запроса. | [in] aFrame | Полученный радиокадр. | [in] aError | Статус полученного радиокадра. |
|
otPlatDiagRadioSetRawPowerSetting
otError otPlatDiagRadioSetRawPowerSetting(
otInstance *aInstance,
const uint8_t *aRawPowerSetting,
uint16_t aRawPowerSettingLength
)
Установите настройки мощности радиомодуля для диагностического модуля.
Подробности | Параметры | [in] aInstance | Структура экземпляра OpenThread. | [in] aRawPowerSetting | Указатель на массив байтов необработанной настройки мощности. | [in] aRawPowerSettingLength | Длина aRawPowerSetting . |
|
Возвращаемые значения | OT_ERROR_NONE | Успешно установите исходную настройку мощности. | OT_ERROR_INVALID_ARGS | aRawPowerSetting имеет значение NULL или aRawPowerSettingLength слишком длинный. | OT_ERROR_NOT_IMPLEMENTED | Этот метод не реализован. |
|
otPlatDiagRadioTransmitCarrier
otError otPlatDiagRadioTransmitCarrier(
otInstance *aInstance,
bool aEnable
)
Запустите/остановите уровень платформы для передачи непрерывной несущей волны.
Подробности | Параметры | [in] aInstance | Структура экземпляра OpenThread. | [in] aEnable | TRUE для включения или FALSE для отключения уровня платформы для передачи непрерывной несущей волны. |
|
Возвращаемые значения | OT_ERROR_NONE | Успешно включено/отключено. | OT_ERROR_INVALID_STATE | Радио не находилось в состоянии приема. | OT_ERROR_NOT_IMPLEMENTED | Этот метод не реализован. |
|
otPlatDiagRadioTransmitStream
otError otPlatDiagRadioTransmitStream(
otInstance *aInstance,
bool aEnable
)
Запустите/остановите уровень платформы для передачи потока символов.
Подробности | Параметры | [in] aInstance | Структура экземпляра OpenThread. | [in] aEnable | TRUE для включения или FALSE для отключения уровня платформы для передачи потока. |
|
Возвращаемые значения | OT_ERROR_NONE | Успешно включено/отключено. | OT_ERROR_INVALID_STATE | Радио не находилось в состоянии приема. | OT_ERROR_NOT_IMPLEMENTED | Эта функция не реализована. |
|
отПлатДиагТксПауэрсет
void otPlatDiagTxPowerSet(
int8_t aTxPower
)
Устанавливает мощность передачи, используемую для заводской диагностики.
Подробности | Параметры | [in] aTxPower | Значение мощности передачи. |
|
Ресурсы
Справочные разделы API OpenThread взяты из исходного кода, доступного на GitHub . Для получения дополнительной информации или внесения вклада в нашу документацию обратитесь к Ресурсам .