ネットワーク時刻の同期
このモジュールには、ネットワーク時刻同期サービスを制御する関数が含まれています。
概要
列挙型 |
|
---|---|
otNetworkTimeStatus{
|
列挙型 この列挙型は、OpenThread 時間同期ステータスを表します。 |
Typedef |
|
---|---|
otNetworkTimeStatus
|
typedefenum otNetworkTimeStatus
この列挙型は、OpenThread 時間同期ステータスを表します。 |
otNetworkTimeSyncCallbackFn)(void *aCallbackContext)
|
typedefvoid(*
この関数ポインタは、ネットワーク時間の同期やステータスの変更が発生したときに呼び出されます。 |
関数 |
|
---|---|
otNetworkTimeGet(otInstance *aInstance, uint64_t *aNetworkTime)
|
Thread ネットワークの時間を取得します。
|
otNetworkTimeGetSyncPeriod(otInstance *aInstance)
|
uint16_t
時刻の同期期間を取得します。
|
otNetworkTimeGetXtalThreshold(otInstance *aInstance)
|
uint16_t
Router の時刻同期の 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 時間同期ステータスを表します。
Properties | |
---|---|
OT_NETWORK_TIME_RESYNC_NEEDED
|
デバイスの同期が 2 秒以上行われていません。 |
OT_NETWORK_TIME_SYNCHRONIZED
|
デバイスのネットワーク時間が同期されます。 |
OT_NETWORK_TIME_UNSYNCHRONIZED
|
デバイスがネットワークに接続されていません。 |
Typedef
otNetworkTimeSyncCallbackFn
void(* otNetworkTimeSyncCallbackFn)(void *aCallbackContext)
この関数ポインタは、ネットワーク時間の同期やステータスの変更が発生したときに呼び出されます。
関数
otNetworkTimeGet(英語)
otNetworkTimeStatus otNetworkTimeGet( otInstance *aInstance, uint64_t *aNetworkTime )
Thread ネットワークの時間を取得します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
時刻の同期ステータス。
|
otNetworkTimeGetSyncPeriod
uint16_t otNetworkTimeGetSyncPeriod( otInstance *aInstance )
時刻の同期期間を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
時刻の同期の期間。
|
otNetworkTimeGetXtalThreshold
uint16_t otNetworkTimeGetXtalThreshold( otInstance *aInstance )
Router の時刻同期の XTAL 精度のしきい値を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
Router の XTAL 精度しきい値(PPM)。
|
otNetworkTimeSetSyncPeriod
otError otNetworkTimeSetSyncPeriod( otInstance *aInstance, uint16_t aTimeSyncPeriod )
時刻の同期期間を設定します。
この関数は、スレッド プロトコルが無効になっている場合にのみ呼び出すことができます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otNetworkTimeSetXtalThreshold
otError otNetworkTimeSetXtalThreshold( otInstance *aInstance, uint16_t aXTALThreshold )
ルーター機能対応デバイスの時刻同期の XTAL 精度のしきい値を設定します。
この関数は、スレッド プロトコルが無効になっている場合にのみ呼び出すことができます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otNetworkTimeSyncSetCallback
void otNetworkTimeSyncSetCallback( otInstance *aInstance, otNetworkTimeSyncCallbackFn aCallbackFn, void *aCallbackContext )
ネットワーク時刻の同期やステータスの変更が発生したときに呼び出すコールバックを設定します。
このコールバックは、OPENTHREAD_CONFIG_TIME_SYNC_JUMP_NOTIF_MIN_US でネットワーク時間オフセットがジャンプしたとき、またはステータスが変更された場合にのみ呼び出されます。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
マクロ
OT_TIME_SYNC_INVALID_SEQ(OT_TIME_SYNC_INVALID_SEQ)
OT_TIME_SYNC_INVALID_SEQ 0
ゼロは無効な時間同期シーケンスと見なされます。
リソース
OpenThread API リファレンスのトピックは、GitHub で入手できるソースコードに基づいています。 詳細については、ドキュメントをご覧ください。