XMR holdover status. More...

#include <gpsdefs.h>

Data Fields
uint8_t	mode
	XMR/holdover mode, see XMR_HOLDOVER_STATUS_MODES. More...

int8_t	curr_prio
	current priority level, 0..XMULTI_REF_INSTANCES::n_xmr_settings, or XMR_PRIO_LVL_UNSPEC More...

int8_t	nxt_prio
	next priority level after holdover, 0..XMULTI_REF_INSTANCES::n_xmr_settings, or XMR_PRIO_LVL_UNSPEC More...

uint8_t	remote_watchdog
	counts down in XMR_HLDOVR_PRE_AUTONOMOUS mode More...

uint32_t	time_offset_ns
	estimated time offset in holdover operation More...

XMR_HOLDOVER_INTV	elapsed
	elapsed time in holdover mode, only valid if XMR_HLDOVR_MSK_IN_HOLDOVER is set More...

XMR_HOLDOVER_INTV	interval
	current holdover interval, only valid if XMR_HLDOVR_MSK_IN_HOLDOVER is set More...

uint32_t	flags
	holdover status flags, see XMR_HOLDOVER_STATUS_FLAG_MASKS More...

Detailed Description

XMR holdover status.

Only supported if XMRIF_MSK_HOLDOVER_STATUS_SUPP is set in XMULTI_REF_INSTANCES::flags

Reports the current holdover status including the elapsed holdover time and the currently active holdover interval, as well as the indices of the current and next XMR time source.

The flag XMR_HLDOVR_MSK_IN_HOLDOVER is set if holdover mode is currently active.

The fields XMR_HOLDOVER_STATUS::curr_prio and XMR_HOLDOVER_STATUS::nxt_prio specify the current or next priority level which can be in the range 0..XMULTI_REF_INSTANCES::n_xmr_settings-1, or XMR_PRIO_LVL_UNSPEC if the index is undefined, e.g. because no input source is available to which can be switched after the holdover interval.

The XMR_HOLDOVER_STATUS::mode field indicates the current XMR/holdover mode which is usually XMR_HLDOVR_AUTONOMOUS. However, in certain applications XMR switching is controlled remotely, in which case XMR_HOLDOVER_STATUS::mode is set to XMR_HLDOVR_REMOTE.

If the device is in remote mode and needs to switch XMR sources then mode changes to XMR_HLDOVR_PRE_AUTONOMOUS, and the XMR_HOLDOVER_STATUS::remote_watchdog starts to count down. If the watchdog expires before a remote switch command has been received the device switches to XMR_HLDOVR_AUTONOMOUS.

Definition at line 7157 of file gpsdefs.h.

Field Documentation

◆ curr_prio

int8_t XMR_HOLDOVER_STATUS::curr_prio

current priority level, 0..XMULTI_REF_INSTANCES::n_xmr_settings, or XMR_PRIO_LVL_UNSPEC

Definition at line 7160 of file gpsdefs.h.

◆ elapsed

XMR_HOLDOVER_INTV XMR_HOLDOVER_STATUS::elapsed

elapsed time in holdover mode, only valid if XMR_HLDOVR_MSK_IN_HOLDOVER is set

Definition at line 7164 of file gpsdefs.h.

◆ flags

uint32_t XMR_HOLDOVER_STATUS::flags

holdover status flags, see XMR_HOLDOVER_STATUS_FLAG_MASKS

Definition at line 7166 of file gpsdefs.h.

Referenced by mbg_get_all_ucap_info().

◆ interval

XMR_HOLDOVER_INTV XMR_HOLDOVER_STATUS::interval

current holdover interval, only valid if XMR_HLDOVR_MSK_IN_HOLDOVER is set

Definition at line 7165 of file gpsdefs.h.

◆ mode

uint8_t XMR_HOLDOVER_STATUS::mode

XMR/holdover mode, see XMR_HOLDOVER_STATUS_MODES.

Definition at line 7159 of file gpsdefs.h.

Referenced by mbg_get_all_ucap_info().

◆ nxt_prio

int8_t XMR_HOLDOVER_STATUS::nxt_prio

next priority level after holdover, 0..XMULTI_REF_INSTANCES::n_xmr_settings, or XMR_PRIO_LVL_UNSPEC

Definition at line 7161 of file gpsdefs.h.

◆ remote_watchdog

uint8_t XMR_HOLDOVER_STATUS::remote_watchdog

counts down in XMR_HLDOVR_PRE_AUTONOMOUS mode

Definition at line 7162 of file gpsdefs.h.

◆ time_offset_ns

uint32_t XMR_HOLDOVER_STATUS::time_offset_ns

estimated time offset in holdover operation

Definition at line 7163 of file gpsdefs.h.

The documentation for this struct was generated from the following file:

mbglib/common/gpsdefs.h

Data Fields