همگام سازی زمان شبکه

این ماژول شامل توابعی است که سرویس همگام سازی زمان شبکه را کنترل می کند.

خلاصه

شمارش ها

otNetworkTimeStatus {
OT_NETWORK_TIME_UNSYNCHRONIZED = -1,
OT_NETWORK_TIME_RESYNC_NEEDED = 0,
OT_NETWORK_TIME_SYNCHRONIZED = 1
}
enum
وضعیت همگام سازی زمان OpenThread را نشان می دهد.

Typedefs

otNetworkTimeStatus typedef
وضعیت همگام سازی زمان OpenThread را نشان می دهد.
otNetworkTimeSyncCallbackFn )(void *aCallbackContext) typedef
void(*
هنگامی که همگام سازی زمان شبکه یا تغییر وضعیت رخ می دهد، اشاره گر فراخوانی می شود.

کارکرد

otNetworkTimeGet ( otInstance *aInstance, uint64_t *aNetworkTime)
زمان شبکه Thread را دریافت کنید.
otNetworkTimeGetSyncPeriod ( otInstance *aInstance)
uint16_t
دوره همگام سازی زمانی را دریافت کنید.
otNetworkTimeGetXtalThreshold ( otInstance *aInstance)
uint16_t
آستانه دقت XTAL همگام سازی زمانی را برای روتر دریافت کنید.
otNetworkTimeSetSyncPeriod ( otInstance *aInstance, uint16_t aTimeSyncPeriod)
دوره همگام سازی زمانی را تنظیم کنید.
otNetworkTimeSetXtalThreshold ( otInstance *aInstance, uint16_t aXTALThreshold)
آستانه دقت XTAL همگام سازی زمانی را برای دستگاه دارای قابلیت روتر تنظیم کنید.
otNetworkTimeSyncSetCallback ( otInstance *aInstance, otNetworkTimeSyncCallbackFn aCallbackFn, void *aCallbackContext)
void
یک تماس برگشتی را تنظیم کنید تا زمانی که همگام سازی زمان شبکه یا تغییر وضعیت رخ می دهد، تماس گرفته شود.

شمارش ها

otNetworkTimeStatus

 otNetworkTimeStatus

وضعیت همگام سازی زمان OpenThread را نشان می دهد.

خواص
OT_NETWORK_TIME_RESYNC_NEEDED

دستگاه برای بیش از دو دوره همگام سازی زمانی دریافت نکرده است.

OT_NETWORK_TIME_SYNCHRONIZED

زمان شبکه دستگاه همگام شده است.

OT_NETWORK_TIME_UNSYNCHRONIZED

دستگاه به شبکه متصل نشده است.

Typedefs

otNetworkTimeStatus

enum otNetworkTimeStatus otNetworkTimeStatus

وضعیت همگام سازی زمان OpenThread را نشان می دهد.

otNetworkTimeSyncCallbackFn

void(* otNetworkTimeSyncCallbackFn)(void *aCallbackContext)

هنگامی که همگام سازی زمان شبکه یا تغییر وضعیت رخ می دهد، اشاره گر فراخوانی می شود.

کارکرد

otNetworkTimeGet

otNetworkTimeStatus otNetworkTimeGet(
  otInstance *aInstance,
  uint64_t *aNetworkTime
)

زمان شبکه Thread را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
ساختار نمونه OpenThread.
[in,out] aNetworkTime
زمان شبکه Thread بر حسب میکروثانیه
برمی گرداند
وضعیت همگام سازی زمان

otNetworkTimeGetSyncPeriod

uint16_t otNetworkTimeGetSyncPeriod(
  otInstance *aInstance
)

دوره همگام سازی زمانی را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
ساختار نمونه OpenThread.
برمی گرداند
دوره همگام سازی زمانی

otNetworkTimeGetXtalThreshold

uint16_t otNetworkTimeGetXtalThreshold(
  otInstance *aInstance
)

آستانه دقت XTAL همگام سازی زمانی را برای روتر دریافت کنید.

جزئیات
مولفه های
[in] aInstance
ساختار نمونه OpenThread.
برمی گرداند
آستانه دقت XTAL برای روتر، در PPM.

otNetworkTimeSetSyncPeriod

otError otNetworkTimeSetSyncPeriod(
  otInstance *aInstance,
  uint16_t aTimeSyncPeriod
)

دوره همگام سازی زمانی را تنظیم کنید.

فقط زمانی می توان فراخوانی کرد که پروتکل های Thread غیرفعال هستند.

جزئیات
مولفه های
[in] aInstance
ساختار نمونه OpenThread.
[in] aTimeSyncPeriod
دوره همگام سازی زمانی، در ثانیه.
ارزش های بازگشتی
OT_ERROR_NONE
دوره همگام سازی زمانی را با موفقیت تنظیم کرد.
OT_ERROR_INVALID_STATE
پروتکل های رشته فعال هستند.

otNetworkTimeSetXtalThreshold

otError otNetworkTimeSetXtalThreshold(
  otInstance *aInstance,
  uint16_t aXTALThreshold
)

آستانه دقت XTAL همگام سازی زمانی را برای دستگاه دارای قابلیت روتر تنظیم کنید.

فقط زمانی می توان فراخوانی کرد که پروتکل های Thread غیرفعال هستند.

جزئیات
مولفه های
[in] aInstance
ساختار نمونه OpenThread.
[in] aXTALThreshold
آستانه دقت XTAL برای روتر، در PPM.
ارزش های بازگشتی
OT_ERROR_NONE
دوره همگام سازی زمانی را با موفقیت تنظیم کرد.
OT_ERROR_INVALID_STATE
پروتکل های رشته فعال هستند.

otNetworkTimeSyncSetCallback

void otNetworkTimeSyncSetCallback(
  otInstance *aInstance,
  otNetworkTimeSyncCallbackFn aCallbackFn,
  void *aCallbackContext
)

یک تماس برگشتی را تنظیم کنید تا زمانی که همگام سازی زمان شبکه یا تغییر وضعیت رخ می دهد، تماس گرفته شود.

این تماس برگشتی فقط زمانی فراخوانی می‌شود که افست زمان شبکه به میزان OPENTHREAD_CONFIG_TIME_SYNC_JUMP_NOTIF_MIN_US افزایش یابد یا وضعیت تغییر کند.

جزئیات
مولفه های
[in] aInstance
ساختار نمونه OpenThread.
[in] aCallbackFn
تابع فراخوانی که باید فراخوانی شود
[in] aCallbackContext
متنی که باید پس از فراخوانی به تابع callback منتقل شود

ماکروها

OT_TIME_SYNC_INVALID_SEQ

 OT_TIME_SYNC_INVALID_SEQ 0

صفر به عنوان دنباله همگام سازی زمانی نامعتبر در نظر گرفته می شود.

منابع

موضوعات مرجع OpenThread API از کد منبع موجود در GitHub سرچشمه می گیرند. برای اطلاعات بیشتر، یا مشارکت در اسناد ما، به منابع مراجعه کنید.