mbgtools-lx  4.2.8
Status of buffered (non-volatile) data

Macros

#define _mbg_swab_bvar_stat(_p)   _mbg_swab16( (_p) )
 
#define BVAR_MASK   ( ( 1UL << N_BVAR_BIT ) - 1 )
 Bit mask for all defined bits. More...
 
#define BVAR_FLAG_NAMES
 String initializer for BVAR_STAT flag names. More...
 

Typedefs

typedef uint16_t BVAR_STAT
 Status flags of battery buffered data. More...
 

Enumerations

enum  BVAR_FLAG_BITS {
  BVAR_BIT_CFGH_INVALID, BVAR_BIT_ALM_NOT_COMPLETE, BVAR_BIT_UTC_INVALID, BVAR_BIT_IONO_INVALID,
  BVAR_BIT_RCVR_POS_INVALID, N_BVAR_BIT
}
 Enumeration of flag bits used to define BVAR_FLAGS. More...
 
enum  BVAR_FLAGS {
  BVAR_CFGH_INVALID = ( 1UL << BVAR_BIT_CFGH_INVALID ), BVAR_ALM_NOT_COMPLETE = ( 1UL << BVAR_BIT_ALM_NOT_COMPLETE ), BVAR_UTC_INVALID = ( 1UL << BVAR_BIT_UTC_INVALID ), BVAR_IONO_INVALID = ( 1UL << BVAR_BIT_IONO_INVALID ),
  BVAR_RCVR_POS_INVALID = ( 1UL << BVAR_BIT_RCVR_POS_INVALID )
}
 Bit masks associated with BVAR_FLAG_BITS. More...
 

Detailed Description

Status word, associated bit numbers and bit masks indicating whether certain data from the GPS satellites are available and valid.

These bits defined are set in BVAR_STAT if the corresponding parameters are NOT valid and complete.

Macro Definition Documentation

◆ _mbg_swab_bvar_stat

#define _mbg_swab_bvar_stat (   _p)    _mbg_swab16( (_p) )

Definition at line 772 of file gpsdefs.h.

Referenced by mbg_get_gps_bvar_stat(), and mbgextio_get_bvar_stat().

◆ BVAR_FLAG_NAMES

#define BVAR_FLAG_NAMES
Value:
{ \
"Sat. config and health", \
"Almanac", \
"UTC offset", \
"Ionospheric correction", \
"Receiver position" \
}

String initializer for BVAR_STAT flag names.

See also
BVAR_STAT
BVAR_FLAG_BITS
BVAR_FLAGS

Definition at line 828 of file gpsdefs.h.

◆ BVAR_MASK

#define BVAR_MASK   ( ( 1UL << N_BVAR_BIT ) - 1 )

Bit mask for all defined bits.

Definition at line 818 of file gpsdefs.h.

Typedef Documentation

◆ BVAR_STAT

Status flags of battery buffered data.

Related to data received from the satellites, or data derived thereof.

All '0' means OK, single bits set to '1' indicate the associated type of GPS data is not available.

See also
BVAR_FLAGS

Definition at line 770 of file gpsdefs.h.

Enumeration Type Documentation

◆ BVAR_FLAG_BITS

Enumeration of flag bits used to define BVAR_FLAGS.

For each bit which is set this means the associated data set in non-volatile memory is not available, or incomplete. Most data sets will just be re-collected from the data streams sent by the satellites. However, the receiver position has usually been computed earlier during normal operation, and will be re-computed when a sufficient number of satellites can be received.

See also
BVAR_STAT
BVAR_FLAGS
BVAR_FLAG_NAMES
Enumerator
BVAR_BIT_CFGH_INVALID 

Satellite configuration and health parameters incomplete.

BVAR_BIT_ALM_NOT_COMPLETE 

Almanac parameters incomplete.

BVAR_BIT_UTC_INVALID 

UTC offset parameters incomplete

BVAR_BIT_IONO_INVALID 

Ionospheric correction parameters incomplete.

BVAR_BIT_RCVR_POS_INVALID 

No valid receiver position available.

N_BVAR_BIT 

number of defined BVAR_STAT bits

Definition at line 789 of file gpsdefs.h.

◆ BVAR_FLAGS

enum BVAR_FLAGS

Bit masks associated with BVAR_FLAG_BITS.

Used with BVAR_STAT.

See also
BVAR_STAT
BVAR_FLAG_BITS
BVAR_FLAG_NAMES
Enumerator
BVAR_CFGH_INVALID 

see BVAR_BIT_CFGH_INVALID

BVAR_ALM_NOT_COMPLETE 

see BVAR_BIT_ALM_NOT_COMPLETE

BVAR_UTC_INVALID 

see BVAR_BIT_UTC_INVALID

BVAR_IONO_INVALID 

see BVAR_BIT_IONO_INVALID

BVAR_RCVR_POS_INVALID 

see BVAR_BIT_RCVR_POS_INVALID

Definition at line 809 of file gpsdefs.h.