نمونه، مثال
این ماژول شامل توابعی است که نمونه OpenThread را کنترل می کند.
خلاصه
Typedefs | |
---|---|
otChangedFlags | typedefuint32_t این نوع یک میدان بیت را نشان می دهد که وضعیت/پیکربندی خاصی را نشان می دهد که تغییر کرده است. |
otInstance | typedefstruct otInstance این ساختار ساختار نمونه OpenThread را نشان می دهد. |
otStateChangedCallback )(otChangedFlags aFlags, void *aContext) | typedefvoid(* این نشانگر تابع برای اطلاع از تنظیمات خاص یا تغییرات حالت در 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
می شوند.
Typedefs
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()
باعث می شود که نمونه به عنوان اولیه در نظر گرفته شود.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | اگر نمونه داده شده معتبر/ابتدایی باشد درست است، در غیر این صورت نادرست است. |
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
اندازه توصیه شده برای نمایش رشته ای از زمان کار.
منابع
موضوعات مرجع OpenThread API از کد منبع موجود در GitHub سرچشمه می گیرند. برای اطلاعات بیشتر، یا مشارکت در اسناد ما، به منابع مراجعه کنید.
،نمونه، مثال
این ماژول شامل توابعی است که نمونه OpenThread را کنترل می کند.
خلاصه
Typedefs | |
---|---|
otChangedFlags | typedefuint32_t این نوع یک میدان بیت را نشان می دهد که وضعیت/پیکربندی خاصی را نشان می دهد که تغییر کرده است. |
otInstance | typedefstruct otInstance این ساختار ساختار نمونه OpenThread را نشان می دهد. |
otStateChangedCallback )(otChangedFlags aFlags, void *aContext) | typedefvoid(* این نشانگر تابع برای اطلاع از تنظیمات خاص یا تغییرات حالت در 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
می شوند.
Typedefs
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()
باعث می شود که نمونه به عنوان اولیه در نظر گرفته شود.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | اگر نمونه داده شده معتبر/ابتدایی باشد درست است، در غیر این صورت نادرست است. |
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
اندازه توصیه شده برای نمایش رشته ای از زمان کار.
منابع
موضوعات مرجع OpenThread API از کد منبع موجود در GitHub سرچشمه می گیرند. برای اطلاعات بیشتر، یا مشارکت در اسناد ما، به منابع مراجعه کنید.