gnss_types.h File Reference

#include <stdint.h>

Include dependency graph for gnss_types.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	GNSS_header_response_t
	This is the first part of the response that every command response from the GNSS receiver has. Refer to page 34-35 of the OEM7 Commands and Logs Reference Manual. More...
struct	GNSS_bestxyza_response_t
	This is the struct for the BESTXYZA Command response. Refer to page 515-517 of the OEM7 Commands and Logs Reference Manual. More...
struct	GNSS_timea_response_t
	This is the struct for the TIMEA Command response. Refer to page 941-943 of the OEM7 Commands and Logs Reference Manual. More...

Enumerations
enum	GNSS_reference_time_status_t {   GNSS_REF_TIME_UNKNOWN = 20 , GNSS_REF_TIME_APPROXIMATE = 60 , GNSS_REF_TIME_COARSEADJUSTING = 80 , GNSS_REF_TIME_COARSE = 100 ,   GNSS_REF_TIME_COARSESTEERING = 120 , GNSS_REF_TIME_FREEWHEELING = 130 , GNSS_REF_TIME_FINEADJUSTING = 140 , GNSS_REF_TIME_FINE = 160 ,   GNSS_REF_TIME_FINEBACKUPSTEERING = 170 , GNSS_REF_TIME_FINESTEERING = 180 , GNSS_REF_TIME_SATTIME = 200 }
	This refers to the status that indicates how well a time is known All reported receiver times are subject to a qualifying time status Refer to page 51-53 of the OEM7 Commands and Logs Reference Manual. More...
enum	GNSS_solution_status_enum_t {   GNSS_SOL_STATUS_SOL_COMPUTED = 0 , GNSS_SOL_STATUS_INSUFFICIENT_OBS = 1 , GNSS_SOL_STATUS_NO_CONVERGENCE = 2 , GNSS_SOL_STATUS_SINGULARITY = 3 ,   GNSS_SOL_STATUS_COV_TRACE = 4 , GNSS_SOL_STATUS_TEST_DIST = 5 , GNSS_SOL_STATUS_COLD_START = 6 , GNSS_SOL_STATUS_V_H_LIMIT = 7 ,   GNSS_SOL_STATUS_VARIANCE = 8 , GNSS_SOL_STATUS_RESIDUALS = 9 , GNSS_SOL_STATUS_RESERVED_10_12 = 10 , GNSS_SOL_STATUS_INTEGRITY_WARNING = 13 }
	This refers to the solution status Refer to table 90 page 500-501 of the OEM7 Commands and Logs Reference Manual. More...
enum	GNSS_position_type_enum_t {   GNSS_TYPE_NONE = 0 , GNSS_TYPE_FIXEDPOS = 1 , GNSS_TYPE_FIXEDHEIGHT = 2 , GNSS_TYPE_RESERVED_3_7 = 3 ,   GNSS_TYPE_DOPPLER_VELOCITY = 8 , GNSS_TYPE_RESERVED_9_15 = 9 , GNSS_TYPE_SINGLE = 16 , GNSS_TYPE_PSDIFF = 17 ,   GNSS_TYPE_WAAS = 18 , GNSS_TYPE_PROPAGATED = 19 , GNSS_TYPE_RESERVED_20_31 = 20 , GNSS_TYPE_L1_FLOAT = 32 ,   GNSS_TYPE_RESERVED_33 = 33 , GNSS_TYPE_NARROW_FLOAT = 34 , GNSS_TYPE_RESERVED_35_47 = 35 , GNSS_TYPE_L1_INT = 48 ,   GNSS_TYPE_WIDE_INT = 49 , GNSS_TYPE_NARROW_INT = 50 , GNSS_TYPE_RTK_DIRECT_INS = 51 , GNSS_TYPE_INS_SBAS = 52 ,   GNSS_TYPE_INS_PSRSP = 53 , GNSS_TYPE_INS_PSRDIFF = 54 , GNSS_TYPE_INS_RTKFLOAT = 55 , GNSS_TYPE_INS_RTKFIXED = 56 ,   GNSS_TYPE_RESERVED_57_67 = 57 , GNSS_TYPE_PPP_CONVERGING = 68 , GNSS_TYPE_PPP = 69 , GNSS_TYPE_OPERATIONAL = 70 ,   GNSS_TYPE_WARNING = 71 , GNSS_TYPE_OUT_OF_BOUNDS = 72 , GNSS_TYPE_INS_PPP_CONVERGING = 73 , GNSS_TYPE_INS_PPP = 74 ,   GNSS_TYPE_PPP_BASIC_CONVERGING = 77 , GNSS_TYPE_PPP_BASIC = 78 , GNSS_TYPE_INS_PPP_BASIC_CONVERGING = 79 , GNSS_TYPE_INS_PPP_BASIC = 80 }
	This refers to the position or velocity type Refer to table 91 page 501-503 of the OEM7 Commands and Logs Reference Manual. More...
enum	GNSS_clock_model_status_enum_t { GNSS_CLOCK_VALID = 0 , GNSS_CLOCK_CONVERGING = 1 , GNSS_CLOCK_ITERATING = 2 , GNSS_CLOCK_INVALID = 3 }
	This refers to the Clock Model Status Refer to table 105 page 526 of the OEM7 Commands and Logs Reference Manual. More...
enum	GNSS_utc_status_enum_t { GNSS_UTC_INVALID = 0 , GNSS_UTC_VALID = 1 , GNSS_UTC_WARNING = 2 }

Functions
uint8_t	GNSS_reference_time_status_str_to_enum (const char *status_str, GNSS_reference_time_status_t *status)
	Assigns a GNSS time status based on the provided string.
const char *	GNSS_reference_time_status_enum_to_str (GNSS_reference_time_status_t status)
	Assigns a string value based on the provided GNSS time status.
uint8_t	GNSS_solution_status_str_to_enum (const char *status_str, GNSS_solution_status_enum_t *status)
	Assigns a GNSS solution status based on the provided string.
uint8_t	GNSS_position_type_str_to_enum (const char *type_str, GNSS_position_type_enum_t *type)
	Assigns a GNSS position or velocity type based on the provided string.
const char *	GNSS_solution_status_enum_to_str (GNSS_solution_status_enum_t status)
	Assigns a string value based on the provided GNSS solution status.
const char *	GNSS_position_type_enum_to_string (GNSS_position_type_enum_t type)
	Assigns a string value based on the provided GNSS position type.
uint8_t	GNSS_clock_model_status_str_to_enum (const char *status_str, GNSS_clock_model_status_enum_t *status)
	Assigns a GNSS Clock Model status based on the provided string.
uint8_t	GNSS_utc_status_str_to_enum (const char *status_str, GNSS_utc_status_enum_t *status)
	Assigns a GNSS UTC status based on the provided string.
const char *	GNSS_clock_model_status_enum_to_string (GNSS_clock_model_status_enum_t status)
	Assigns a string value based on the provided GNSS clock model status.
const char *	GNSS_utc_status_enum_to_string (GNSS_utc_status_enum_t status)
	Assigns a string value based on the provided GNSS UTC status.

Enumeration Type Documentation

GNSS_clock_model_status_enum_t

enum GNSS_clock_model_status_enum_t

This refers to the Clock Model Status Refer to table 105 page 526 of the OEM7 Commands and Logs Reference Manual.

Enumerator
GNSS_CLOCK_VALID
GNSS_CLOCK_CONVERGING
GNSS_CLOCK_ITERATING
GNSS_CLOCK_INVALID

GNSS_position_type_enum_t

enum GNSS_position_type_enum_t

This refers to the position or velocity type Refer to table 91 page 501-503 of the OEM7 Commands and Logs Reference Manual.

Enumerator
GNSS_TYPE_NONE
GNSS_TYPE_FIXEDPOS
GNSS_TYPE_FIXEDHEIGHT
GNSS_TYPE_RESERVED_3_7
GNSS_TYPE_DOPPLER_VELOCITY
GNSS_TYPE_RESERVED_9_15
GNSS_TYPE_SINGLE
GNSS_TYPE_PSDIFF
GNSS_TYPE_WAAS
GNSS_TYPE_PROPAGATED
GNSS_TYPE_RESERVED_20_31
GNSS_TYPE_L1_FLOAT
GNSS_TYPE_RESERVED_33
GNSS_TYPE_NARROW_FLOAT
GNSS_TYPE_RESERVED_35_47
GNSS_TYPE_L1_INT
GNSS_TYPE_WIDE_INT
GNSS_TYPE_NARROW_INT
GNSS_TYPE_RTK_DIRECT_INS
GNSS_TYPE_INS_SBAS
GNSS_TYPE_INS_PSRSP
GNSS_TYPE_INS_PSRDIFF
GNSS_TYPE_INS_RTKFLOAT
GNSS_TYPE_INS_RTKFIXED
GNSS_TYPE_RESERVED_57_67
GNSS_TYPE_PPP_CONVERGING
GNSS_TYPE_PPP
GNSS_TYPE_OPERATIONAL
GNSS_TYPE_WARNING
GNSS_TYPE_OUT_OF_BOUNDS
GNSS_TYPE_INS_PPP_CONVERGING
GNSS_TYPE_INS_PPP
GNSS_TYPE_PPP_BASIC_CONVERGING
GNSS_TYPE_PPP_BASIC
GNSS_TYPE_INS_PPP_BASIC_CONVERGING
GNSS_TYPE_INS_PPP_BASIC

GNSS_reference_time_status_t

enum GNSS_reference_time_status_t

This refers to the status that indicates how well a time is known All reported receiver times are subject to a qualifying time status Refer to page 51-53 of the OEM7 Commands and Logs Reference Manual.

Enumerator
GNSS_REF_TIME_UNKNOWN
GNSS_REF_TIME_APPROXIMATE
GNSS_REF_TIME_COARSEADJUSTING
GNSS_REF_TIME_COARSE
GNSS_REF_TIME_COARSESTEERING
GNSS_REF_TIME_FREEWHEELING
GNSS_REF_TIME_FINEADJUSTING
GNSS_REF_TIME_FINE
GNSS_REF_TIME_FINEBACKUPSTEERING
GNSS_REF_TIME_FINESTEERING
GNSS_REF_TIME_SATTIME

GNSS_solution_status_enum_t

enum GNSS_solution_status_enum_t

This refers to the solution status Refer to table 90 page 500-501 of the OEM7 Commands and Logs Reference Manual.

Enumerator
GNSS_SOL_STATUS_SOL_COMPUTED
GNSS_SOL_STATUS_INSUFFICIENT_OBS
GNSS_SOL_STATUS_NO_CONVERGENCE
GNSS_SOL_STATUS_SINGULARITY
GNSS_SOL_STATUS_COV_TRACE
GNSS_SOL_STATUS_TEST_DIST
GNSS_SOL_STATUS_COLD_START
GNSS_SOL_STATUS_V_H_LIMIT
GNSS_SOL_STATUS_VARIANCE
GNSS_SOL_STATUS_RESIDUALS
GNSS_SOL_STATUS_RESERVED_10_12
GNSS_SOL_STATUS_INTEGRITY_WARNING

GNSS_utc_status_enum_t

enum GNSS_utc_status_enum_t

Enumerator
GNSS_UTC_INVALID
GNSS_UTC_VALID
GNSS_UTC_WARNING

Function Documentation

GNSS_clock_model_status_enum_to_string()

const char * GNSS_clock_model_status_enum_to_string

(

GNSS_clock_model_status_enum_t

status

)

Assigns a string value based on the provided GNSS clock model status.

Parameters

status

GNSS_clock_model_status_enum_t value.

Returns

Returns the assigned string value for the GNSS_clock_model_status_enum_t.

Here is the caller graph for this function:

GNSS_clock_model_status_str_to_enum()

uint8_t GNSS_clock_model_status_str_to_enum	(	const char *	status_str,
		GNSS_clock_model_status_enum_t *	status )

Assigns a GNSS Clock Model status based on the provided string.

Parameters

status_str	The status string to parse.
status	Pointer to GNSS_clock_model_status_enum_t where the status will be stored.

Returns

Returns 0 on success, 1 if the status string is unrecognized.

Here is the caller graph for this function:

GNSS_position_type_enum_to_string()

const char * GNSS_position_type_enum_to_string

(

GNSS_position_type_enum_t

type

)

Assigns a string value based on the provided GNSS position type.

Parameters

type	GNSS_position_type_enum_t value.

Returns

Returns the assigned string value for the GNSS_position_type_enum_t.

Here is the caller graph for this function:

GNSS_position_type_str_to_enum()

uint8_t GNSS_position_type_str_to_enum	(	const char *	type_str,
		GNSS_position_type_enum_t *	type )

Assigns a GNSS position or velocity type based on the provided string.

Parameters

type_str	The type string to parse.
type	Pointer to GNSS_position_velocity_type_enum_t where the type will be stored.

Returns

Returns 0 on success, 1 if the type string is unrecognized.

Here is the caller graph for this function:

GNSS_reference_time_status_enum_to_str()

const char * GNSS_reference_time_status_enum_to_str

(

GNSS_reference_time_status_t

status

)

Assigns a string value based on the provided GNSS time status.

Parameters

status

GNSS_reference_time_status_t value.

Returns

Returns the assigned string value for the GNSS time status.

Here is the caller graph for this function:

GNSS_reference_time_status_str_to_enum()

uint8_t GNSS_reference_time_status_str_to_enum	(	const char *	status_str,
		GNSS_reference_time_status_t *	status )

Assigns a GNSS time status based on the provided string.

Parameters

status_str	The status string to parse.
status	Pointer to GNSS_reference_time_status_t where the status will be stored.

Returns

Returns 0 on success, 1 if the status string is unrecognized.

Here is the caller graph for this function:

GNSS_solution_status_enum_to_str()

const char * GNSS_solution_status_enum_to_str

(

GNSS_solution_status_enum_t

status

)

Assigns a string value based on the provided GNSS solution status.

Parameters

status

GNSS_solution_status_enum_t value.

Returns

Returns the assigned string value for the GNSS_solution_status_enum_t.

Here is the caller graph for this function:

GNSS_solution_status_str_to_enum()

uint8_t GNSS_solution_status_str_to_enum	(	const char *	status_str,
		GNSS_solution_status_enum_t *	status )

Assigns a GNSS solution status based on the provided string.

Parameters

status_str	The status string to parse.
status	Pointer to GNSS_solution_status_enum_t where the status will be stored.

Returns

Returns 0 on success, 1 if the status string is unrecognized.

Here is the caller graph for this function:

GNSS_utc_status_enum_to_string()

const char * GNSS_utc_status_enum_to_string

(

GNSS_utc_status_enum_t

status

)

Assigns a string value based on the provided GNSS UTC status.

Parameters

status

GNSS_utc_status_enum_t value.

Returns

Returns the assigned string value for the GNSS_utc_status_enum_t.

Here is the caller graph for this function:

GNSS_utc_status_str_to_enum()

uint8_t GNSS_utc_status_str_to_enum	(	const char *	status_str,
		GNSS_utc_status_enum_t *	status )

Assigns a GNSS UTC status based on the provided string.

Parameters

status_str	The status string to parse.
status	Pointer to GNSS_utc_status_enum_t where the status will be stored.

Returns

Returns 0 on success, 1 if the status string is unrecognized.

Here is the caller graph for this function: