UBX-CFG: Configuration input messages

Data Structures
struct	ubx_msg_cfg_prt_spi
	Command or poll response for UBX_MSG_ID_CFG_PRT on the SPI port. More...
struct	ubx_msg_cfg_msg
	Command for UBX_MSG_ID_CFG_MSG that sets the output rate on the current port. More...
struct	ubx_msg_cfg_rate
	Command or poll response for UBX_MSG_ID_CFG_RATE. More...
struct	ubx_msg_cfg_rst
	Command for UBX_MSG_ID_CFG_RST (not acknowledged) More...
struct	ubx_msg_cfg_cfg_m8
	Command for UBX_MSG_ID_CFG_CFG on M8 receivers, with storage device selection. More...
struct	ubx_msg_cfg_cfg_m10
	Command for UBX_MSG_ID_CFG_CFG on M10 receivers. More...
struct	ubx_msg_cfg_nav5
	Command or poll response for UBX_MSG_ID_CFG_NAV5. More...
struct	ubx_msg_cfg_gnss
	Command or poll response for UBX_MSG_ID_CFG_GNSS. More...
struct	ubx_msg_cfg_valset_v0
	Command for UBX_MSG_ID_CFG_VALSET (version 0, no transaction support) More...
struct	ubx_msg_cfg_valset_v1
	Command for UBX_MSG_ID_CFG_VALSET (version 1, with transaction support) More...
struct	ubx_msg_cfg_valget_query
	Poll request for UBX_MSG_ID_CFG_VALGET. More...
struct	ubx_msg_cfg_valget_response
	Response from UBX_MSG_ID_CFG_VALGET. More...

Macros
#define	UBX_MSG_CFG_PRT_TX_READY_CFG(pio, threshold)
	Construct the PIO and threshold portion of ubx_msg_cfg_prt_spi::tx_ready.

Enumerations
enum	ubx_msg_id_cfg {   UBX_MSG_ID_CFG_PRT = 0x00 , UBX_MSG_ID_CFG_MSG = 0x01 , UBX_MSG_ID_CFG_RST = 0x04 , UBX_MSG_ID_CFG_RATE = 0x08 ,   UBX_MSG_ID_CFG_CFG = 0x09 , UBX_MSG_ID_CFG_NAV5 = 0x24 , UBX_MSG_ID_CFG_GNSS = 0x3E , UBX_MSG_ID_CFG_DCDC_BURN = 0x41 ,   UBX_MSG_ID_CFG_VALSET = 0x8a , UBX_MSG_ID_CFG_VALGET = 0x8b , UBX_MSG_ID_CFG_VALDEL = 0x8c }
	UBX-CFG message IDs. More...
enum	ubx_msg_cfg_prt_ports { UBX_MSG_CFG_PRT_PORT_ID_I2C = 0 , UBX_MSG_CFG_PRT_PORT_ID_USB = 3 , UBX_MSG_CFG_PRT_PORT_ID_SPI = 4 }
	Port identifiers for ubx_msg_cfg_prt_spi::port_id. More...
enum	ubx_msg_cfg_prt_proto_mask { UBX_MSG_CFG_PRT_PROTO_MASK_UBX = BIT(0) , UBX_MSG_CFG_PRT_PROTO_MASK_NMEA = BIT(1) , UBX_MSG_CFG_PRT_PROTO_MASK_RTCM2 = BIT(2) , UBX_MSG_CFG_PRT_PROTO_MASK_RTCM3 = BIT(5) }
	Protocol masks for ubx_msg_cfg_prt_spi::in_proto_mask and ubx_msg_cfg_prt_spi::out_proto_mask. More...
enum	ubx_msg_cfg_prt_tx_ready { UBX_MSG_CFG_PRT_TX_READY_EN = BIT(0) , UBX_MSG_CFG_PRT_TX_READY_POL_ACTIVE_HIGH = 0 , UBX_MSG_CFG_PRT_TX_READY_POL_ACTIVE_LOW = BIT(1) }
	TX ready configuration for ubx_msg_cfg_prt_spi::tx_ready. More...
enum	ubx_msg_cfg_prt_spi_mode { UBX_MSG_CFG_PRT_SPI_MODE_0 = (0 << 1) , UBX_MSG_CFG_PRT_SPI_MODE_1 = (1 << 1) , UBX_MSG_CFG_PRT_SPI_MODE_2 = (2 << 1) , UBX_MSG_CFG_PRT_SPI_MODE_3 = (3 << 1) }
	SPI mode for ubx_msg_cfg_prt_spi::mode. More...
enum	ubx_msg_cfg_prt_spi_flags { UBX_MSG_CFG_PRT_SPI_EXTENDED_TIMEOUT = BIT(1) }
	Flags for ubx_msg_cfg_prt_spi::flags. More...
enum	ubx_msg_cfg_rate_time_ref {   UBX_MSG_CFG_RATE_TIME_REF_UTC = 0 , UBX_MSG_CFG_RATE_TIME_REF_GPS = 1 , UBX_MSG_CFG_RATE_TIME_REF_GLONASS = 2 , UBX_MSG_CFG_RATE_TIME_REF_BEIDOU = 3 ,   UBX_MSG_CFG_RATE_TIME_REF_GALILEO = 4 , UBX_MSG_CFG_RATE_TIME_REF_NAVIC = 5 }
	Time reference for ubx_msg_cfg_rate::time_ref. More...
enum	ubx_msg_cfg_rst_bbr_mask { UBX_MSG_CFG_RST_BBR_HOT_START = 0x0000 , UBX_MSG_CFG_RST_BBR_WARM_START = 0x0001 , UBX_MSG_CFG_RST_BBR_COLD_START = 0xFFFF }
	Backup data to clear for ubx_msg_cfg_rst::nav_bbr_mask. More...
enum	ubx_msg_cfg_rst_mode { UBX_MSG_CFG_RST_MODE_HARDWARE = 0x0000 }
	Reset type for ubx_msg_cfg_rst::reset_mode. More...
enum	ubx_msg_cfg_cfg_mask {   UBX_MSG_CFG_CFG_MASK_IO_PORT = BIT(0) , UBX_MSG_CFG_CFG_MASK_MSG_CONF = BIT(1) , UBX_MSG_CFG_CFG_MASK_INF_MSG = BIT(2) , UBX_MSG_CFG_CFG_MASK_NAV_CONF = BIT(3) ,   UBX_MSG_CFG_CFG_MASK_RXM_CONF = BIT(4) , UBX_MSG_CFG_CFG_MASK_SEN_CONF = BIT(8) , UBX_MSG_CFG_CFG_MASK_RINV_CONF = BIT(9) , UBX_MSG_CFG_CFG_MASK_ANT_CONF = BIT(10) ,   UBX_MSG_CFG_CFG_MASK_LOG_CONF = BIT(11) , UBX_MSG_CFG_CFG_MASK_FTS_CONF = BIT(12) }
	Configuration sections for the UBX_MSG_ID_CFG_CFG clear, save and load masks. More...
enum	ubx_msg_cfg_cfg_device { UBX_MSG_CFG_CFG_DEVICE_BBR = BIT(0) , UBX_MSG_CFG_CFG_DEVICE_FLASH = BIT(1) , UBX_MSG_CFG_CFG_DEVICE_EEPROM = BIT(2) , UBX_MSG_CFG_CFG_DEVICE_SPI_FLASH = BIT(4) }
	Storage devices for ubx_msg_cfg_cfg_m8::device_mask. More...
enum	ubx_msg_cfg_gnss_flags { UBX_MSG_CFG_GNSS_FLAGS_ENABLED = BIT(0) }
	Flags for ubx_msg_cfg_gnss::ubx_msg_cfg_gnss_cfg::flags. More...
enum	ubx_msg_cfg_valset_layers { UBX_MSG_CFG_VALSET_LAYERS_RAM = BIT(0) , UBX_MSG_CFG_VALSET_LAYERS_BBR = BIT(1) , UBX_MSG_CFG_VALSET_LAYERS_FLASH = BIT(2) }
	Configuration layers to write with UBX_MSG_ID_CFG_VALSET. More...
enum	ubx_msg_cfg_valset_transaction { UBX_MSG_CFG_VALSET_TRANSACTION_NONE = 0 , UBX_MSG_CFG_VALSET_TRANSACTION_START = 1 , UBX_MSG_CFG_VALSET_TRANSACTION_ONGOING = 2 , UBX_MSG_CFG_VALSET_TRANSACTION_APPLY = 3 }
	Transaction state for ubx_msg_cfg_valset_v1::transaction. More...
enum	ubx_msg_cfg_valget_layer { UBX_MSG_CFG_VALGET_LAYER_RAM = 0 , UBX_MSG_CFG_VALGET_LAYER_BBR = 1 , UBX_MSG_CFG_VALGET_LAYER_FLASH = 2 , UBX_MSG_CFG_VALGET_LAYER_DEFAULT = 7 }
	Configuration layer to read with UBX_MSG_ID_CFG_VALGET. More...

Detailed Description

Macro Definition Documentation

UBX_MSG_CFG_PRT_TX_READY_CFG

#define UBX_MSG_CFG_PRT_TX_READY_CFG	(		pio,
			threshold )

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/gnss/ubx/protocol.h>

Value:

(pio << 2) | ((threshold / 8) << 7)

Construct the PIO and threshold portion of ubx_msg_cfg_prt_spi::tx_ready.

Parameters

pio	PIO to use as the TX ready pin
threshold	Number of pending TX bytes before the pin is asserted

Enumeration Type Documentation

ubx_msg_cfg_cfg_device

enum ubx_msg_cfg_cfg_device

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/gnss/ubx/protocol.h>

Storage devices for ubx_msg_cfg_cfg_m8::device_mask.

Enumerator
UBX_MSG_CFG_CFG_DEVICE_BBR	Battery backed RAM.
UBX_MSG_CFG_CFG_DEVICE_FLASH	Flash.
UBX_MSG_CFG_CFG_DEVICE_EEPROM	EEPROM.
UBX_MSG_CFG_CFG_DEVICE_SPI_FLASH	SPI flash.

ubx_msg_cfg_cfg_mask

enum ubx_msg_cfg_cfg_mask

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/gnss/ubx/protocol.h>

Configuration sections for the UBX_MSG_ID_CFG_CFG clear, save and load masks.

Enumerator
UBX_MSG_CFG_CFG_MASK_IO_PORT	Communications port settings.
UBX_MSG_CFG_CFG_MASK_MSG_CONF	Message configuration.
UBX_MSG_CFG_CFG_MASK_INF_MSG	Information message configuration.
UBX_MSG_CFG_CFG_MASK_NAV_CONF	Navigation configuration.
UBX_MSG_CFG_CFG_MASK_RXM_CONF	Receiver manager configuration.
UBX_MSG_CFG_CFG_MASK_SEN_CONF	Sensor interface configuration.
UBX_MSG_CFG_CFG_MASK_RINV_CONF	Remote inventory configuration.
UBX_MSG_CFG_CFG_MASK_ANT_CONF	Antenna configuration.
UBX_MSG_CFG_CFG_MASK_LOG_CONF	Logging configuration.
UBX_MSG_CFG_CFG_MASK_FTS_CONF	FTS configuration (FTS products only)

ubx_msg_cfg_gnss_flags

enum ubx_msg_cfg_gnss_flags

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/gnss/ubx/protocol.h>

Flags for ubx_msg_cfg_gnss::ubx_msg_cfg_gnss_cfg::flags.

Enumerator
UBX_MSG_CFG_GNSS_FLAGS_ENABLED	GNSS system is enabled.

ubx_msg_cfg_prt_ports

enum ubx_msg_cfg_prt_ports

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/gnss/ubx/protocol.h>

Port identifiers for ubx_msg_cfg_prt_spi::port_id.

Enumerator
UBX_MSG_CFG_PRT_PORT_ID_I2C	DDC (I2C compatible) port.
UBX_MSG_CFG_PRT_PORT_ID_USB	USB port.
UBX_MSG_CFG_PRT_PORT_ID_SPI	SPI port.

ubx_msg_cfg_prt_proto_mask

enum ubx_msg_cfg_prt_proto_mask

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/gnss/ubx/protocol.h>

Protocol masks for ubx_msg_cfg_prt_spi::in_proto_mask and ubx_msg_cfg_prt_spi::out_proto_mask.

Enumerator
UBX_MSG_CFG_PRT_PROTO_MASK_UBX	UBX protocol.
UBX_MSG_CFG_PRT_PROTO_MASK_NMEA	NMEA protocol.
UBX_MSG_CFG_PRT_PROTO_MASK_RTCM2	RTCM2 protocol.
UBX_MSG_CFG_PRT_PROTO_MASK_RTCM3	RTCM3 protocol.

ubx_msg_cfg_prt_spi_flags

enum ubx_msg_cfg_prt_spi_flags

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/gnss/ubx/protocol.h>

Flags for ubx_msg_cfg_prt_spi::flags.

Enumerator
UBX_MSG_CFG_PRT_SPI_EXTENDED_TIMEOUT	Only time out the port when at least 4 kB of TX memory is allocated.

ubx_msg_cfg_prt_spi_mode

enum ubx_msg_cfg_prt_spi_mode

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/gnss/ubx/protocol.h>

SPI mode for ubx_msg_cfg_prt_spi::mode.

Enumerator
UBX_MSG_CFG_PRT_SPI_MODE_0	SPI mode 0 (CPOL = 0, CPHA = 0)
UBX_MSG_CFG_PRT_SPI_MODE_1	SPI mode 1 (CPOL = 0, CPHA = 1)
UBX_MSG_CFG_PRT_SPI_MODE_2	SPI mode 2 (CPOL = 1, CPHA = 0)
UBX_MSG_CFG_PRT_SPI_MODE_3	SPI mode 3 (CPOL = 1, CPHA = 1)

ubx_msg_cfg_prt_tx_ready

enum ubx_msg_cfg_prt_tx_ready

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/gnss/ubx/protocol.h>

TX ready configuration for ubx_msg_cfg_prt_spi::tx_ready.

Enumerator
UBX_MSG_CFG_PRT_TX_READY_EN	Enable the TX ready pin.
UBX_MSG_CFG_PRT_TX_READY_POL_ACTIVE_HIGH	TX ready pin is active high.
UBX_MSG_CFG_PRT_TX_READY_POL_ACTIVE_LOW	TX ready pin is active low.

ubx_msg_cfg_rate_time_ref

enum ubx_msg_cfg_rate_time_ref

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/gnss/ubx/protocol.h>

Time reference for ubx_msg_cfg_rate::time_ref.

Enumerator
UBX_MSG_CFG_RATE_TIME_REF_UTC	UTC time.
UBX_MSG_CFG_RATE_TIME_REF_GPS	GPS time.
UBX_MSG_CFG_RATE_TIME_REF_GLONASS	GLONASS time.
UBX_MSG_CFG_RATE_TIME_REF_BEIDOU	BeiDou time.
UBX_MSG_CFG_RATE_TIME_REF_GALILEO	Galileo time.
UBX_MSG_CFG_RATE_TIME_REF_NAVIC	NavIC time.

ubx_msg_cfg_rst_bbr_mask

enum ubx_msg_cfg_rst_bbr_mask

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/gnss/ubx/protocol.h>

Backup data to clear for ubx_msg_cfg_rst::nav_bbr_mask.

Enumerator
UBX_MSG_CFG_RST_BBR_HOT_START	Hot start, keep all backup data.
UBX_MSG_CFG_RST_BBR_WARM_START	Warm start, clear ephemeris data.
UBX_MSG_CFG_RST_BBR_COLD_START	Cold start, clear all backup data.

ubx_msg_cfg_rst_mode

enum ubx_msg_cfg_rst_mode

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/gnss/ubx/protocol.h>

Reset type for ubx_msg_cfg_rst::reset_mode.

Enumerator
UBX_MSG_CFG_RST_MODE_HARDWARE	Immediate hardware (watchdog) reset.

ubx_msg_cfg_valget_layer

enum ubx_msg_cfg_valget_layer

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/gnss/ubx/protocol.h>

Configuration layer to read with UBX_MSG_ID_CFG_VALGET.

Enumerator
UBX_MSG_CFG_VALGET_LAYER_RAM	RAM layer.
UBX_MSG_CFG_VALGET_LAYER_BBR	Battery backed RAM layer.
UBX_MSG_CFG_VALGET_LAYER_FLASH	Flash layer.
UBX_MSG_CFG_VALGET_LAYER_DEFAULT	Default values.

ubx_msg_cfg_valset_layers

enum ubx_msg_cfg_valset_layers

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/gnss/ubx/protocol.h>

Configuration layers to write with UBX_MSG_ID_CFG_VALSET.

Enumerator
UBX_MSG_CFG_VALSET_LAYERS_RAM	RAM layer.
UBX_MSG_CFG_VALSET_LAYERS_BBR	Battery backed RAM layer.
UBX_MSG_CFG_VALSET_LAYERS_FLASH	Flash layer.

ubx_msg_cfg_valset_transaction

enum ubx_msg_cfg_valset_transaction

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/gnss/ubx/protocol.h>

Transaction state for ubx_msg_cfg_valset_v1::transaction.

Enumerator
UBX_MSG_CFG_VALSET_TRANSACTION_NONE	No transaction, apply the values immediately.
UBX_MSG_CFG_VALSET_TRANSACTION_START	Start a new transaction, discarding any pending one.
UBX_MSG_CFG_VALSET_TRANSACTION_ONGOING	Add the values to the current transaction.
UBX_MSG_CFG_VALSET_TRANSACTION_APPLY	Add the values and apply the transaction.

ubx_msg_id_cfg

enum ubx_msg_id_cfg

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/gnss/ubx/protocol.h>

UBX-CFG message IDs.

Enumerator
UBX_MSG_ID_CFG_PRT	Port configuration.
UBX_MSG_ID_CFG_MSG	Message output rate configuration.
UBX_MSG_ID_CFG_RST	Reset receiver and clear backup data.
UBX_MSG_ID_CFG_RATE	Navigation and measurement rate configuration.
UBX_MSG_ID_CFG_CFG	Clear, save and load configurations.
UBX_MSG_ID_CFG_NAV5	Navigation engine configuration.
UBX_MSG_ID_CFG_GNSS	GNSS system configuration.
UBX_MSG_ID_CFG_DCDC_BURN	Burn the DC-DC converter fuse (irreversible)
UBX_MSG_ID_CFG_VALSET	Set configuration item values.
UBX_MSG_ID_CFG_VALGET	Get configuration item values.
UBX_MSG_ID_CFG_VALDEL	Delete configuration item values.