Пример
Этот модуль включает функции, управляющие экземпляром OpenThread.
Резюме
Определения типов | |
---|---|
otChangedFlags | определение типаuint32_t Этот тип представляет собой битовое поле, указывающее конкретное измененное состояние/конфигурацию. |
otInstance | определение типаstruct otInstance Эта структура представляет структуру экземпляра OpenThread. |
otStateChangedCallback )(otChangedFlags aFlags, void *aContext) | определение типаvoid(* Этот указатель функции вызывается для уведомления об определенных изменениях конфигурации или состояния в OpenThread. |
Функции | |
---|---|
otGetRadioVersionString ( otInstance *aInstance) | const char * Эта функция получает строку версии радио OpenThread. |
otGetVersionString (void) | const char * Эта функция получает строку версии OpenThread. |
otInstanceErasePersistentInfo ( otInstance *aInstance) | Эта функция стирает всю постоянную информацию OpenThread (сетевые настройки), хранящуюся в энергонезависимой памяти. |
otInstanceFactoryReset ( otInstance *aInstance) | void Этот метод удаляет все настройки, хранящиеся в энергонезависимой памяти, а затем запускает сброс платформы. |
otInstanceFinalize ( otInstance *aInstance) | void Эта функция отключает библиотеку OpenThread. |
otInstanceGetUptime ( otInstance *aInstance) | uint64_t Эта функция возвращает текущее время безотказной работы экземпляра (в миллисекундах). |
otInstanceGetUptimeAsString ( otInstance *aInstance, char *aBuffer, uint16_t aSize) | void Эта функция возвращает текущее время безотказной работы экземпляра в виде удобочитаемой строки. |
otInstanceInit (void *aInstanceBuffer, size_t *aInstanceBufferSize) | Эта функция инициализирует библиотеку OpenThread. |
otInstanceInitSingle (void) | Эта функция инициализирует единственный статический экземпляр библиотеки OpenThread. |
otInstanceIsInitialized ( otInstance *aInstance) | bool Эта функция указывает, является ли экземпляр действительным/инициализированным. |
otInstanceReset ( otInstance *aInstance) | void Этот метод вызывает сброс платформы. |
otInstanceResetRadioStack ( otInstance *aInstance) | void Этот метод сбрасывает внутренние состояния радиостека OpenThread. |
otRemoveStateChangeCallback ( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext) | void Эта функция удаляет обратный вызов, чтобы указать, когда в OpenThread изменяется определенная конфигурация или состояние. |
otSetStateChangedCallback ( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext) | Эта функция регистрирует обратный вызов, чтобы указать, когда в OpenThread изменяется определенная конфигурация или состояние. |
Перечисления
анонимное перечисление
anonymous enum
Это перечисление определяет флаги, которые передаются как часть otStateChangedCallback
.
Определения типов
otChangedFlags
uint32_t otChangedFlags
Этот тип представляет собой битовое поле, указывающее конкретное измененное состояние/конфигурацию.
См. определения OT_CHANGED_*
.
otStateChangedCallback
void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)
Этот указатель функции вызывается для уведомления об определенных изменениях конфигурации или состояния в OpenThread.
Подробности | |||||
---|---|---|---|---|---|
Параметры |
|
Функции
otGetRadioVersionString
const char * otGetRadioVersionString( otInstance *aInstance )
Эта функция получает строку версии радио OpenThread.
Подробности | |||
---|---|---|---|
Параметры |
| ||
Возвращает | Указатель на радиоверсию OpenThread. |
otGetVersionString
const char * otGetVersionString( void )
Эта функция получает строку версии OpenThread.
Подробности | |
---|---|
Возвращает | Указатель на версию OpenThread. |
otInstanceErasePersistentInfo
otError otInstanceErasePersistentInfo( otInstance *aInstance )
Эта функция стирает всю постоянную информацию OpenThread (сетевые настройки), хранящуюся в энергонезависимой памяти.
Стирание выполняется успешно, только если устройство находится в disabled
состоянии/роли.
Подробности | |||||
---|---|---|---|---|---|
Параметры |
| ||||
Возвращаемые значения |
|
otInstanceFactoryReset
void otInstanceFactoryReset( otInstance *aInstance )
Этот метод удаляет все настройки, хранящиеся в энергонезависимой памяти, а затем запускает сброс платформы.
Подробности | |||
---|---|---|---|
Параметры |
|
otInstanceFinalize
void otInstanceFinalize( otInstance *aInstance )
Эта функция отключает библиотеку OpenThread.
Вызовите эту функцию, когда OpenThread больше не используется.
Подробности | |||
---|---|---|---|
Параметры |
|
otInstanceGetUptime
uint64_t otInstanceGetUptime( otInstance *aInstance )
Эта функция возвращает текущее время безотказной работы экземпляра (в миллисекундах).
Эта функция требует OPENTHREAD_CONFIG_UPTIME_ENABLE
.
Время безотказной работы указывается как количество миллисекунд с момента инициализации экземпляра OpenThread.
Подробности | |||
---|---|---|---|
Параметры |
| ||
Возвращает | Время безотказной работы (количество миллисекунд). |
otInstanceGetUptimeAsString
void otInstanceGetUptimeAsString( otInstance *aInstance, char *aBuffer, uint16_t aSize )
Эта функция возвращает текущее время безотказной работы экземпляра в виде удобочитаемой строки.
Эта функция требует OPENTHREAD_CONFIG_UPTIME_ENABLE
.
Строка имеет формат "
Если результирующая строка не помещается в aBuffer
(в пределах его символов aSize
), строка будет усечена, но выводимая строка всегда завершается нулем.
Подробности | |||||||
---|---|---|---|---|---|---|---|
Параметры |
|
otInstanceInit
otInstance * otInstanceInit( void *aInstanceBuffer, size_t *aInstanceBufferSize )
Эта функция инициализирует библиотеку OpenThread.
Эта функция инициализирует OpenThread и подготавливает его к последующим вызовам OpenThread API. Эта функция должна вызываться перед любыми другими вызовами OpenThread.
Эта функция доступна и может использоваться только при включенной поддержке нескольких экземпляров OpenThread.
Подробности | |||||
---|---|---|---|---|---|
Параметры |
| ||||
Возвращает | Указатель на новый экземпляр OpenThread. |
otInstanceFinalize
otInstanceInitSingle
otInstance * otInstanceInitSingle( void )
Эта функция инициализирует единственный статический экземпляр библиотеки OpenThread.
Эта функция инициализирует OpenThread и подготавливает его к последующим вызовам OpenThread API. Эта функция должна вызываться перед любыми другими вызовами OpenThread.
Эта функция доступна и может использоваться, только если отключена поддержка нескольких экземпляров OpenThread.
Подробности | |
---|---|
Возвращает | Указатель на единственный экземпляр OpenThread. |
otInstanceIsInitialized
bool otInstanceIsInitialized( otInstance *aInstance )
Эта функция указывает, является ли экземпляр действительным/инициализированным.
Экземпляр считается действительным, если он получен и инициализирован с помощью либо otInstanceInitSingle()
(в случае с одним экземпляром), либо otInstanceInit()
(в случае с несколькими экземплярами). Последующий вызов otInstanceFinalize()
приводит к тому, что экземпляр считается неинициализированным.
Подробности | |||
---|---|---|---|
Параметры |
| ||
Возвращает | TRUE, если данный экземпляр действителен/инициализирован, в противном случае FALSE. |
otInstanceReset
void otInstanceReset( otInstance *aInstance )
Этот метод вызывает сброс платформы.
Процесс сброса гарантирует, что все состояние/информация OpenThread (хранящиеся в энергозависимой памяти) будут удалены. Обратите внимание, что otPlatformReset
не стирает какое-либо постоянное состояние/информацию, сохраненную в энергонезависимой памяти.
Подробности | |||
---|---|---|---|
Параметры |
|
otInstanceResetRadioStack
void otInstanceResetRadioStack( otInstance *aInstance )
Этот метод сбрасывает внутренние состояния радиостека OpenThread.
Обратные вызовы и конфигурации сохраняются.
Этот API доступен только для сборок радио ( OPENTHREAD_RADIO = 1
).
Подробности | |||
---|---|---|---|
Параметры |
|
otRemoveStateChangeCallback
void otRemoveStateChangeCallback( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext )
Эта функция удаляет обратный вызов, чтобы указать, когда в OpenThread изменяется определенная конфигурация или состояние.
Подробности | |||||||
---|---|---|---|---|---|---|---|
Параметры |
|
otSetStateChangedCallback
otError otSetStateChangedCallback( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext )
Эта функция регистрирует обратный вызов, чтобы указать, когда в OpenThread изменяется определенная конфигурация или состояние.
Подробности | |||||||
---|---|---|---|---|---|---|---|
Параметры |
| ||||||
Возвращаемые значения |
|
Макросы
OT_UPTIME_STRING_SIZE
OT_UPTIME_STRING_SIZE 24
Рекомендуемый размер строкового представления времени безотказной работы.
Ресурсы
Разделы справочника по API OpenThread взяты из исходного кода, доступного на GitHub . Чтобы получить дополнительную информацию или внести свой вклад в нашу документацию, обратитесь к разделу Ресурсы .