NMEA_data.h

Go to the documentation of this file.

/**************************************************************************/
/**************************************************************************/
#ifndef _NMEA_DATA_H
#define _NMEA_DATA_H
#include "Arduino.h"

#define NMEA_MAX_WP_ID                                                         \
  20 
#define NMEA_MAX_SENTENCE_ID                                                   \
  20 
#define NMEA_MAX_SOURCE_ID                                                     \
  3 

/*************************************************************************
  doubles and floats are identical on AVR processors like the UNO where space
  is tight. doubles avoid the roundoff errors that led to the fixed point mods
  in https://github.com/adafruit/Adafruit-GPS-Library/pull/13, provided the
  processor supports actual doubles like the SAMD series with more storage. The
  total penalty for going all double is under a few hundred bytes / instance or
  0 bytes / instance on an UNO. This typedef allows a switch to lower precision
  to save some storage if needed. A float carries 23 bits of fractional
  resolution, giving a resolution of at least 9 significant digits, thus 6
  significant digits in the decimal place of an angular value like latitude, and
  thus a resolution on earth of at least 110 mm. That's closer than GPS will
  hit, and closer than needed for navigation, so floats can be used to save a
  little storage.
 **************************************************************************/
#ifndef NMEA_FLOAT_T
#define NMEA_FLOAT_T float 
#endif
typedef NMEA_FLOAT_T
    nmea_float_t; 

/**************************************************************************/
typedef struct {
  int16_t *data = NULL;          
  unsigned n = 0;                
  uint32_t lastHistory = 0;      
  uint16_t historyInterval = 20; 
  nmea_float_t scale = 1.0;      
  nmea_float_t offset = 0.0;     
} nmea_history_t;

/**************************************************************************/
/**************************************************************************/
typedef enum {
  NMEA_SIMPLE_FLOAT = 0,  
  NMEA_COMPASS_ANGLE = 1, 
  NMEA_BOAT_ANGLE = 2,    
  NMEA_COMPASS_ANGLE_SIN =
      11, 
  NMEA_BOAT_ANGLE_SIN =
      12, 
  NMEA_DDMM = 20, 
  NMEA_HHMMSS =
      30 
} nmea_value_type_t;

/**************************************************************************/
/**************************************************************************/
typedef struct {
  nmea_float_t latest = 0.0; 
  nmea_float_t smoothed =
      0.0;                  
  uint32_t lastUpdate = 0;  
  uint16_t response = 1000; 
  nmea_value_type_t type =
      NMEA_SIMPLE_FLOAT; 
  byte ockam = 0; 
  nmea_history_t *hist = NULL; 
  char *label = NULL;          
  char *unit = NULL;           
  char *fmt = NULL;            
} nmea_datavalue_t;

/**************************************************************************/
/**************************************************************************/
typedef enum {
  NMEA_HDOP = 0, 
  NMEA_LAT,      
  NMEA_LON,      
  NMEA_LATWP,    
  NMEA_LONWP,    
  NMEA_SOG,      
  NMEA_COG,      
  NMEA_COG_SIN,  
  NMEA_COG_COS,  
  NMEA_COGWP,    
  NMEA_XTE,      
  NMEA_DISTWP,   
  NMEA_AWA, 
  NMEA_AWA_SIN, 
  NMEA_AWA_COS, 
  NMEA_AWS,     
  NMEA_TWA,     
  NMEA_TWA_SIN, 
  NMEA_TWA_COS, 
  NMEA_TWD, 
  NMEA_TWD_SIN, 
  NMEA_TWD_COS, 
  NMEA_TWS,     
  NMEA_VMG,     
  NMEA_VMGWP,   
  NMEA_HEEL,    
  NMEA_PITCH,   
  NMEA_HDG,     
  NMEA_HDG_SIN, 
  NMEA_HDG_COS, 
  NMEA_HDT,     
  NMEA_HDT_SIN, 
  NMEA_HDT_COS, 
  NMEA_VTW,     
  NMEA_LOG,     
  NMEA_LOGR,    
  NMEA_DEPTH,   
  NMEA_RPM_M1,  
  NMEA_TEMPERATURE_M1,    
  NMEA_PRESSURE_M1,       
  NMEA_VOLTAGE_M1,        
  NMEA_CURRENT_M1,        
  NMEA_RPM_M2,            
  NMEA_TEMPERATURE_M2,    
  NMEA_PRESSURE_M2,       
  NMEA_VOLTAGE_M2,        
  NMEA_CURRENT_M2,        
  NMEA_TEMPERATURE_AIR,   
  NMEA_TEMPERATURE_WATER, 
  NMEA_HUMIDITY,          
  NMEA_BAROMETER, 
  NMEA_USR_00,    
  NMEA_USR_01,    
  NMEA_USR_02,    
  NMEA_USR_03,
  NMEA_USR_04,
  NMEA_USR_05,
  NMEA_USR_06,
  NMEA_USR_07,
  NMEA_USR_08,
  NMEA_USR_09,
  NMEA_USR_10,
  NMEA_USR_11,
  NMEA_USR_12,
  NMEA_MAX_INDEX 
} nmea_index_t;  

#endif // _NMEA_DATA_H