Update SparkFun_Ublox_Arduino_Library.h

Author: averywallis

src/SparkFun_Ublox_Arduino_Library.h

@@ -120,31 +120,37 @@ const uint8_t UBX_CLASS_SEC = 0x27; //Security Feature Messages
 const uint8_t UBX_CLASS_HNR = 0x28; //(NEO-M8P ONLY!!!) High Rate Navigation Results Messages: High rate time, position speed, heading
 const uint8_t UBX_CLASS_NMEA = 0xF0; //NMEA Strings: standard NMEA strings
 
-
-const uint8_t UBX_CFG_PRT = 0x00;  //Used to configure port specifics
-const uint8_t UBX_CFG_RST = 0x04;  //Used to reset device
-const uint8_t UBX_CFG_RATE = 0x08; //Used to set port baud rates
-const uint8_t UBX_CFG_CFG = 0x09;  //Used to save current configuration
-const uint8_t UBX_CFG_RXM = 0x11;  //Used to set receiver power management (power save mode)
-const uint8_t UBX_CFG_NAV5 = 0x24; //Used to configure the navigation engine including the dynamic model
-
-const uint8_t UBX_CFG_VALSET = 0x8A; //Used for config of higher version Ublox modules (ie protocol v27 and above)
-const uint8_t UBX_CFG_VALGET = 0x8B; //Used for config of higher version Ublox modules (ie protocol v27 and above)
-const uint8_t UBX_CFG_VALDEL = 0x8C; //Used for config of higher version Ublox modules (ie protocol v27 and above)
-
-const uint8_t UBX_CFG_GEOFENCE = 0x69; //Used to configure a geofence
-const uint8_t UBX_CFG_ANT = 0x13;	  //Used to configure the antenna control settings
-const uint8_t UBX_NAV_GEOFENCE = 0x39; //Used to poll the geofence status
-
-const uint8_t UBX_CFG_TMODE3 = 0x71; //Used to enable Survey In Mode
-const uint8_t SVIN_MODE_DISABLE = 0x00;
-const uint8_t SVIN_MODE_ENABLE = 0x01;
-
-const uint8_t UBX_NAV_PVT = 0x07;		//All the things! Position, velocity, time, PDOP, height, h/v accuracies, number of satellites
-const uint8_t UBX_NAV_HPPOSECEF = 0x13; //Find our positional accuracy (high precision)
-const uint8_t UBX_NAV_HPPOSLLH = 0x14;  //Used for obtaining lat/long/alt in high precision
-const uint8_t UBX_NAV_SVIN = 0x3B;		//Used for checking Survey In status
-const uint8_t UBX_NAV_RELPOSNED = 0x3C; //Relative Positioning Information in NED frame
+//The following are used for configuration. Descriptions are from the ZED-F9P Interface Description pg 33-34 and NEO-M9N Interface Description pg 47-48
+const uint8_t UBX_CFG_ANT = 0x13; //Antenna Control Settings. Used to configure the antenna control settings
+const uint8_t UBX_CFG_BATCH = 0x93; //Get/set data batching configuration.
+const uint8_t UBX_CFG_CFG = 0x09; //Clear, Save, and Load Configurations. Used to save current configuration
+const uint8_t UBX_CFG_DAT = 0x06; //Set User-defined Datum or The currently defined Datum
+const uint8_t UBX_CFG_DGNSS = 0x70; //DGNSS configuration
+const uint8_t UBX_CFG_GEOFENCE = 0x69; //Geofencing configuration. Used to configure a geofence
+const uint8_t UBX_CFG_GNSS = 0x3E; //GNSS system configuration
+const uint8_t UBX_CFG_INF = 0x02; //Depending on packet length, either: poll configuration for one protocol, or information message configuration
+const uint8_t UBX_CFG_ITFM = 0x39; //Jamming/Interference Monitor configuration
+const uint8_t UBX_CFG_LOGFILTER = 0x47; //Data Logger Configuration
+const uint8_t UBX_CFG_MSG = 0x01; //Poll a message configuration, or Set Message Rate(s), or Set Message Rate
+const uint8_t UBX_CFG_NAV5 = 0x24; //Navigation Engine Settings. Used to configure the navigation engine including the dynamic model.
+const uint8_t UBX_CFG_NAVX5 = 0x23; //Navigation Engine Expert Settings
+const uint8_t UBX_CFG_NMEA = 0x17; //Extended NMEA protocol configuration V1
+const uint8_t UBX_CFG_ODO = 0x1E; //Odometer, Low-speed COG Engine Settings
+const uint8_t UBX_CFG_PM2 = 0x3B; //Extended power management configuration
+const uint8_t UBX_CFG_PMS = 0x86; //Power mode setup
+const uint8_t UBX_CFG_PRT = 0x00; //Used to configure port specifics. Polls the configuration for one I/O Port, or Port configuration for UART ports, or Port configuration for USB port, or Port configuration for SPI port, or Port configuration for DDC port
+const uint8_t UBX_CFG_PWR = 0x57; //Put receiver in a defined power state
+const uint8_t UBX_CFG_RATE = 0x08; //Navigation/Measurement Rate Settings. Used to set port baud rates.
+const uint8_t UBX_CFG_RINV = 0x34; //Contents of Remote Inventory
+const uint8_t UBX_CFG_RST = 0x04; //Reset Receiver / Clear Backup Data Structures. Used to reset device. 
+const uint8_t UBX_CFG_RXM = 0x11; //RXM configuration
+const uint8_t UBX_CFG_SBAS = 0x16; //SBAS configuration
+const uint8_t UBX_CFG_TMODE3 = 0x71; //Time Mode Settings 3. Used to enable Survey In Mode
+const uint8_t UBX_CFG_TP5 = 0x31; //Time Pulse Parameters
+const uint8_t UBX_CFG_USB = 0x1B; //USB Configuration
+const uint8_t UBX_CFG_VALDEL = 0x8C; //Used for config of higher version Ublox modules (ie protocol v27 and above). Deletes values corresponding to provided keys/ provided keys with a transaction
+const uint8_t UBX_CFG_VALGET = 0x8B; //Used for config of higher version Ublox modules (ie protocol v27 and above). Configuration Items
+const uint8_t UBX_CFG_VALSET = 0x8A; //Used for config of higher version Ublox modules (ie protocol v27 and above). Sets values corresponding to provided key-value pairs/ provided key-value pairs within a transaction.
 
 //The following are used to enable NMEA messages. Descriptions come from the NMEA messages overview in the ZED-F9P Interface Description
 const uint8_t UBX_NMEA_MSB = 0xF0; //All NMEA enable commands have 0xF0 as MSB
@@ -168,9 +174,6 @@ const uint8_t UBX_NMEA_VLW = 0x0F; //GxVLW (dual ground/water distance)
 const uint8_t UBX_NMEA_VTG = 0x05; //GxVTG (course over ground and Ground speed)
 const uint8_t UBX_NMEA_ZDA = 0x08; //GxZDA (Time and Date)
 
-const uint8_t UBX_MON_VER = 0x04;   //Used for obtaining Protocol Version
-const uint8_t UBX_MON_TXBUF = 0x08; //Used for query tx buffer size/state
-
 //The following are used to configure the NMEA protocol main talker ID and GSV talker ID
 const uint8_t UBX_NMEA_MAINTALKERID_NOTOVERRIDDEN = 0x00; //main talker ID is system dependent
 const uint8_t UBX_NMEA_MAINTALKERID_GP = 0x01; //main talker ID is GPS
@@ -192,8 +195,8 @@ const uint8_t UBX_INF_WARNING = 0x01; //ASCII output with warning contents
 //The following are used to configure LOG UBX messages (loggings messages).  Descriptions from UBX messages overview (ZED_F9P Interface Description Document page 34)
 const uint8_t UBX_LOG_CREATE = 0x07; //Create Log File
 const uint8_t UBX_LOG_ERASE = 0x03; //Erase Logged Data
-const uint8_t UBX_LOG_FINDTIME = 0x0E; //Depending on packet length, either: Find index of a log entry based on a..., or response to FINDTIME requested
-const uint8_t UBX_LOG_INFO = 0x08; //Depending on packet length, either: Poll for log information, or Log information
+const uint8_t UBX_LOG_FINDTIME = 0x0E; //Find index of a log entry based on a given time, or response to FINDTIME requested
+const uint8_t UBX_LOG_INFO = 0x08; //Poll for log information, or Log information
 const uint8_t UBX_LOG_RETRIEVEPOSEXTRA = 0x0F; //Odometer log entry
 const uint8_t UBX_LOG_RETRIEVEPOS = 0x0B; //Position fix log entry
 const uint8_t UBX_LOG_RETRIEVESTRING = 0x0D; //Byte string log entry
@@ -207,7 +210,7 @@ const uint8_t UBX_MGA_BDS_ALM = 0x03; //BDS Almanac Assistance
 const uint8_t UBX_MGA_BDS_HEALTH = 0x03; //BDS Health Assistance
 const uint8_t UBX_MGA_BDS_UTC = 0x03; //BDS UTC Assistance
 const uint8_t UBX_MGA_BDS_IONO = 0x03; //BDS Ionospheric Assistance
-const uint8_t UBX_MGA_DBD = 0x80; //Depending on packet length, either: Poll the Navigation Database, or Navigation Database Dump Entry
+const uint8_t UBX_MGA_DBD = 0x80; //Either: Poll the Navigation Database, or Navigation Database Dump Entry
 const uint8_t UBX_MGA_GAL_EPH = 0x02; //Galileo Ephemeris Assistance
 const uint8_t UBX_MGA_GAL_ALM = 0x02; //Galileo Almanac Assitance
 const uint8_t UBX_MGA_GAL_TIMOFFSET = 0x02; //Galileo GPS time offset assistance
@@ -243,27 +246,27 @@ const uint8_t UBX_MON_PATCH = 0x27; //Output information about installed patches
 const uint8_t UBX_MON_RF = 0x38; //RF information
 const uint8_t UBX_MON_RXBUF = 0x07; //Receiver Buffer Status
 const uint8_t UBX_MON_RXR = 0x21; //Receiver Status Information
-const uint8_t UBX_MON_TXBUF = 0x08; //Transmitter Buffer Status
-const uint8_t UBX_MON_VER = 0x04; //Receiver/Software Version
+const uint8_t UBX_MON_TXBUF = 0x08; //Transmitter Buffer Status. Used for query tx buffer size/state.
+const uint8_t UBX_MON_VER = 0x04; //Receiver/Software Version. Used for obtaining Protocol Version.
 
 //The following are used to configure the NAV UBX messages (navigation results messages). Descriptions from UBX messages overview (ZED_F9P Interface Description Document page 35-36)
 const uint8_t UBX_NAV_CLOCK = 0x22; //Clock Solution
 const uint8_t UBX_NAV_DOP = 0x04; //Dilution of precision
 const uint8_t UBX_NAV_EOE = 0x61; //End of Epoch
-const uint8_t UBX_NAV_GEOFENCE = 0x39; //Geofencing status
-const uint8_t UBX_NAV_HPPOSECEF = 0x13; //High Precision Position Solution in ECEF
-const uint8_t UBX_NAV_HPPOSLLH = 0x14; //High Precision Geodetic Position Solution
+const uint8_t UBX_NAV_GEOFENCE = 0x39; //Geofencing status. Used to poll the geofence status
+const uint8_t UBX_NAV_HPPOSECEF = 0x13; //High Precision Position Solution in ECEF. Used to find our positional accuracy (high precision).
+const uint8_t UBX_NAV_HPPOSLLH = 0x14; //High Precision Geodetic Position Solution. Used for obtaining lat/long/alt in high precision
 const uint8_t UBX_NAV_ODO = 0x09; //Odometer Solution
 const uint8_t UBX_NAV_ORB = 0x34; //GNSS Orbit Database Info
 const uint8_t UBX_NAV_POSECEF = 0x01; //Position Solution in ECEF
 const uint8_t UBX_NAV_POSLLH = 0x02; //Geodetic Position Solution
-const uint8_t UBX_NAV_PVT = 0x07; //Navigation Position Velocity Time Solution
+const uint8_t UBX_NAV_PVT = 0x07; //All the things! Position, velocity, time, PDOP, height, h/v accuracies, number of satellites. Navigation Position Velocity Time Solution.
 const uint8_t UBX_NAV_RELPOSNED = 0x3C; //Relative Positioning Information in NED frame
 const uint8_t UBX_NAV_RESETODO = 0x10; //Reset odometer
 const uint8_t UBX_NAV_SAT = 0x35; //Satellite Information
 const uint8_t UBX_NAV_SIG = 0x43; //Signal Information
 const uint8_t UBX_NAV_STATUS = 0x03; //Receiver Navigation Status
-const uint8_t UBX_NAV_SVIN = 0x3B; //Survey-in data
+const uint8_t UBX_NAV_SVIN = 0x3B; //Survey-in data. Used for checking Survey In status
 const uint8_t UBX_NAV_TIMEBDS = 0x24; //BDS Time Solution
 const uint8_t UBX_NAV_TIMEGAL = 0x25; //Galileo Time Solution
 const uint8_t UBX_NAV_TIMEGLO = 0x23; //GLO Time Solution
@@ -290,8 +293,7 @@ const uint8_t UBX_TIM_TP = 0x01; //Time Pulse Timedata
 const uint8_t UBX_TIM_VRFY = 0x06; //Sourced Time Verification
 
 //The following are used to configure the UPD UBX messages (firmware update messages). Descriptions from UBX messages overview (ZED-F9P Interface Description Document page 36)
-const uint8_t UBX_UPD_SOS = 0x14; //Different based on message size (Poll Backup Fil Restore Status, Create Backup File in Flash, Clear Backup File in Flash, Backup File Creation Acknowledge, System Restored from Backup
-
+const uint8_t UBX_UPD_SOS = 0x14; //Poll Backup Fil Restore Status, Create Backup File in Flash, Clear Backup File in Flash, Backup File Creation Acknowledge, System Restored from Backup
 
 
 //The following are used to enable RTCM messages
@@ -310,6 +312,10 @@ const uint8_t UBX_ACK_NACK = 0x00;
 const uint8_t UBX_ACK_ACK = 0x01;
 const uint8_t UBX_ACK_NONE = 0x02; //Not a real value
 
+
+const uint8_t SVIN_MODE_DISABLE = 0x00;
+const uint8_t SVIN_MODE_ENABLE = 0x01;
+
 //The following consts are used to configure the various ports and streams for those ports. See -CFG-PRT.
 const uint8_t COM_PORT_I2C = 0;
 const uint8_t COM_PORT_UART1 = 1;