sbgEComIds.h

Go to the documentation of this file.

 
#ifndef SBG_ECOM_IDS_H
#define SBG_ECOM_IDS_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
//----------------------------------------------------------------------//
//- Definition of all class id for sbgECom                             -//
//----------------------------------------------------------------------//

typedef enum _SbgEComClass
{
    SBG_ECOM_CLASS_LOG_ECOM_0          = 0x00,         
    SBG_ECOM_CLASS_LOG_ECOM_1          = 0x01,         
 
    SBG_ECOM_CLASS_LOG_NMEA_0          = 0x02,         
    SBG_ECOM_CLASS_LOG_NMEA_1          = 0x03,         
 
    SBG_ECOM_CLASS_LOG_THIRD_PARTY_0    = 0x04,         
 
    SBG_ECOM_CLASS_LOG_NMEA_GNSS        = 0x05,         
 
    SBG_ECOM_CLASS_LOG_CMD_0            = 0x10,         
 
 
    SBG_ECOM_CLASS_LOG_ALL                = 0xFF          
} SbgEComClass;
 
//----------------------------------------------------------------------//
//- Definition of all messages id for sbgECom                          -//
//----------------------------------------------------------------------//

typedef enum _SbgEComLog
{
    SBG_ECOM_LOG_STATUS                  = 1,        
 
    SBG_ECOM_LOG_UTC_TIME                  = 2,        
 
    SBG_ECOM_LOG_IMU_DATA                  = 3,        
 
    SBG_ECOM_LOG_MAG                        = 4,        
    SBG_ECOM_LOG_MAG_CALIB                    = 5,        
 
    SBG_ECOM_LOG_EKF_EULER                    = 6,        
    SBG_ECOM_LOG_EKF_QUAT                  = 7,        
    SBG_ECOM_LOG_EKF_NAV                    = 8,        
 
    SBG_ECOM_LOG_SHIP_MOTION                = 9,        
 
    SBG_ECOM_LOG_GPS1_VEL                  = 13,       
    SBG_ECOM_LOG_GPS1_POS                  = 14,       
    SBG_ECOM_LOG_GPS1_HDT                  = 15,       
 
    SBG_ECOM_LOG_GPS2_VEL                  = 16,       
    SBG_ECOM_LOG_GPS2_POS                  = 17,       
    SBG_ECOM_LOG_GPS2_HDT                  = 18,       
 
    SBG_ECOM_LOG_ODO_VEL                    = 19,       
 
    SBG_ECOM_LOG_EVENT_A                    = 24,       
    SBG_ECOM_LOG_EVENT_B                    = 25,       
    SBG_ECOM_LOG_EVENT_C                    = 26,       
    SBG_ECOM_LOG_EVENT_D                    = 27,       
    SBG_ECOM_LOG_EVENT_E                    = 28,       
 
    SBG_ECOM_LOG_DVL_BOTTOM_TRACK          = 29,       
    SBG_ECOM_LOG_DVL_WATER_TRACK            = 30,       
 
    SBG_ECOM_LOG_GPS1_RAW                  = 31,       
 
    SBG_ECOM_LOG_SHIP_MOTION_HP              = 32,       
 
    SBG_ECOM_LOG_AIR_DATA                  = 36,       
 
    SBG_ECOM_LOG_USBL                      = 37,       
 
    SBG_ECOM_LOG_GPS2_RAW                  = 38,       
 
 
    SBG_ECOM_LOG_IMU_SHORT                    = 44,       
 
    SBG_ECOM_LOG_EVENT_OUT_A                = 45,       
    SBG_ECOM_LOG_EVENT_OUT_B                = 46,       
 
    SBG_ECOM_LOG_DEPTH                        = 47,       
    SBG_ECOM_LOG_DIAG                      = 48,       
 
    SBG_ECOM_LOG_RTCM_RAW                  = 49,       
 
    SBG_ECOM_LOG_GPS1_SAT                  = 50,       
    SBG_ECOM_LOG_GPS2_SAT                  = 51,       
 
    SBG_ECOM_LOG_EKF_ROT_ACCEL_BODY          = 52,       
    SBG_ECOM_LOG_EKF_ROT_ACCEL_NED            = 53,       
    SBG_ECOM_LOG_EKF_VEL_BODY              = 54,       
 
    SBG_ECOM_LOG_SESSION_INFO              = 55,       
 
    SBG_ECOM_LOG_EKF_DEBUG                    = 56,       
 
    SBG_ECOM_LOG_PTP_STATUS                  = 57,       
 
    SBG_ECOM_LOG_VELOCITY_1                  = 58,       
 
    SBG_ECOM_LOG_VIB_MON_FFT                = 59,       
    SBG_ECOM_LOG_VIB_MON_REPORT              = 60,       
 
    SBG_ECOM_LOG_EKF_AIR_DATA              = 61,       
 
    SBG_ECOM_LOG_POSITION_1                  = 62,       
 
    SBG_ECOM_LOG_ECOM_NUM_MESSAGES                        
} SbgEComLog;

typedef enum _SbgEComLog1MsgId
{
    SBG_ECOM_LOG_FAST_IMU_DATA                = 0,        
    SBG_ECOM_LOG_ECOM_1_NUM_MESSAGES                    
} SbgEComLog1;

typedef enum _SbgEComNmeaLog
{
    SBG_ECOM_LOG_NMEA_GGA                  = 0,        
    SBG_ECOM_LOG_NMEA_RMC                  = 1,        
    SBG_ECOM_LOG_NMEA_ZDA                  = 2,        
    SBG_ECOM_LOG_NMEA_HDT                  = 3,        
    SBG_ECOM_LOG_NMEA_GST                  = 4,        
    SBG_ECOM_LOG_NMEA_VBW                  = 5,        
    SBG_ECOM_LOG_NMEA_DPT                  = 7,        
    SBG_ECOM_LOG_NMEA_VTG                  = 8,        
    SBG_ECOM_LOG_NMEA_ROT                  = 9,        
    SBG_ECOM_LOG_NMEA_GSV                  = 10,       
    SBG_ECOM_LOG_NMEA_GSA                  = 11,       
    SBG_ECOM_LOG_NMEA_NUM_MESSAGES                        
} SbgEComNmeaLog;

typedef enum _SbgEComIdNmea1Log
{
    SBG_ECOM_LOG_NMEA_1_PRDID              = 0,        
    SBG_ECOM_LOG_NMEA_1_PSBGI              = 1,        
    SBG_ECOM_LOG_NMEA_1_PASHR              = 2,        
    SBG_ECOM_LOG_NMEA_1_PSBGB              = 3,        
 
    SBG_ECOM_LOG_NMEA_1_PHINF              = 5,        
    SBG_ECOM_LOG_NMEA_1_PHTRO              = 6,        
    SBG_ECOM_LOG_NMEA_1_PHLIN              = 7,        
    SBG_ECOM_LOG_NMEA_1_PHOCT              = 8,        
    SBG_ECOM_LOG_NMEA_1_INDYN              = 9,        
 
    SBG_ECOM_LOG_NMEA_1_GGK                  = 10,       
    SBG_ECOM_LOG_NMEA_1_PPS                  = 11,       
    SBG_ECOM_LOG_NMEA_1_AVR                  = 14,       
 
    SBG_ECOM_LOG_NMEA_1_WASSP              = 12,       
 
    SBG_ECOM_LOG_NMEA_1_PSBGA              = 13,       
 
    SBG_ECOM_LOG_NMEA_1_NUM_MESSAGES                    
} SbgEComIdNmea1Log;

typedef enum _SbgEComIdThirdParty
{
    SBG_ECOM_THIRD_PARTY_TSS1              = 0,        
    SBG_ECOM_THIRD_PARTY_KVH                = 1,        
 
    SBG_ECOM_THIRD_PARTY_PD0                = 2,        
    SBG_ECOM_THIRD_PARTY_SIMRAD_1000        = 3,        
    SBG_ECOM_THIRD_PARTY_SIMRAD_3000        = 4,        
 
    SBG_ECOM_THIRD_PARTY_SEAPATH_B26        = 5,        
    SBG_ECOM_THIRD_PARTY_DOLOG_HRP            = 6,        
    SBG_ECOM_THIRD_PARTY_AHRS_500          = 7,        
    SBG_ECOM_THIRD_PARTY_ADA_01              = 8,        
 
    SBG_ECOM_THIRD_PARTY_AT_ITINS          = 9,        
 
    SBG_ECOM_THIRD_PARTY_KONGSBERG_MB      = 10,       
 
    SBG_ECOM_LOG_THIRD_PARTY_NUM_MESSAGES              
} SbgEComIdThirdParty;

typedef enum _SbgEComNmeaGnssLog
{
    SBG_ECOM_LOG_NMEA_GNSS_GGA                = 0,        
    SBG_ECOM_LOG_NMEA_GNSS_RMC                = 1,        
    SBG_ECOM_LOG_NMEA_GNSS_ZDA                = 2,        
    SBG_ECOM_LOG_NMEA_GNSS_HDT                = 3,        
    SBG_ECOM_LOG_NMEA_GNSS_GST                = 4,        
    SBG_ECOM_LOG_NMEA_GNSS_VTG                = 8,        
    SBG_ECOM_LOG_NMEA_GNSS_GSA                = 11,       
} SbgEComNmeaGnssLog;
 

typedef enum _SbgEComCmd
{
    /* Acknowledge */
    SBG_ECOM_CMD_ACK                        = 0,        
 
    /* Special settings commands */
    SBG_ECOM_CMD_SETTINGS_ACTION            = 1,        
    SBG_ECOM_CMD_IMPORT_SETTINGS            = 2,        
    SBG_ECOM_CMD_EXPORT_SETTINGS            = 3,        
 
    /* Device info */
    SBG_ECOM_CMD_INFO                      = 4,        
 
    /* Sensor parameters */
    SBG_ECOM_CMD_INIT_PARAMETERS            = 5,        
    SBG_ECOM_CMD_MOTION_PROFILE_ID            = 7,        
    SBG_ECOM_CMD_IMU_ALIGNMENT_LEVER_ARM    = 8,        
    SBG_ECOM_CMD_AIDING_ASSIGNMENT            = 9,        
 
    /* Magnetometer configuration */
    SBG_ECOM_CMD_MAGNETOMETER_MODEL_ID        = 11,       
    SBG_ECOM_CMD_MAGNETOMETER_REJECT_MODE  = 12,       
    SBG_ECOM_CMD_SET_MAG_CALIB                = 13,       
 
    /* Magnetometer on-board calibration */
    SBG_ECOM_CMD_START_MAG_CALIB            = 14,       
    SBG_ECOM_CMD_COMPUTE_MAG_CALIB            = 15,       
 
    /* GNSS configuration */
    SBG_ECOM_CMD_GNSS_1_MODEL_ID            = 17,       
    SBG_ECOM_CMD_GNSS_1_LEVER_ARM_ALIGNMENT = 18,        
    SBG_ECOM_CMD_GNSS_1_REJECT_MODES        = 19,       
 
    /* Odometer configuration */
    SBG_ECOM_CMD_ODO_CONF                  = 20,       
    SBG_ECOM_CMD_ODO_LEVER_ARM                = 21,       
    SBG_ECOM_CMD_ODO_REJECT_MODE            = 22,       
 
    /* Interfaces configuration */
    SBG_ECOM_CMD_UART_CONF                    = 23,       
    SBG_ECOM_CMD_CAN_BUS_CONF              = 24,       
    SBG_ECOM_CMD_CAN_OUTPUT_CONF            = 25,       
 
    /* Events configuration */
    SBG_ECOM_CMD_SYNC_IN_CONF              = 26,       
    SBG_ECOM_CMD_SYNC_OUT_CONF                = 27,       
 
    /* Output configuration */
    SBG_ECOM_CMD_NMEA_TALKER_ID          = 29,       
    SBG_ECOM_CMD_OUTPUT_CONF                = 30,       
 
    /* Advanced configuration */
    SBG_ECOM_CMD_ADVANCED_CONF                = 32,       
 
    /* Features related commands */
    SBG_ECOM_CMD_FEATURES                  = 33,       
 
    /* Licenses related commands */
    SBG_ECOM_CMD_LICENSE_APPLY                = 34,       
 
    /* Message class output switch */
    SBG_ECOM_CMD_OUTPUT_CLASS_ENABLE        = 35,       
 
    /* Ethernet configuration */
    SBG_ECOM_CMD_ETHERNET_CONF                = 36,       
    SBG_ECOM_CMD_ETHERNET_INFO                = 37,       
 
    /* Validity thresholds */
    SBG_ECOM_CMD_VALIDITY_THRESHOLDS        = 38,       
 
    /* DVL configuration */
    SBG_ECOM_CMD_DVL_MODEL_ID              = 39,       
    SBG_ECOM_CMD_DVL_INSTALLATION          = 40,       
    SBG_ECOM_CMD_DVL_REJECT_MODES          = 41,       
 
    /* AirData configuration */
    SBG_ECOM_CMD_AIRDATA_MODEL_ID          = 42,       
    SBG_ECOM_CMD_AIRDATA_LEVER_ARM            = 43,       
    SBG_ECOM_CMD_AIRDATA_REJECT_MODES      = 44,       
 
    /* Odometer configuration (using CAN) */
    SBG_ECOM_CMD_ODO_CAN_CONF              = 45,       
 
    SBG_ECOM_CMD_GNSS_1_INSTALLATION        = 46,       
 
    /* REST API related commands */
    SBG_ECOM_CMD_API_POST                  = 47,       
    SBG_ECOM_CMD_API_GET                    = 48,       
 
    /* Misc. */
    SBG_ECOM_LOG_ECOM_NUM_CMDS                            
} SbgEComCmd;

typedef uint8_t SbgEComMsgId;
 
//----------------------------------------------------------------------//
//- Inline helpers for log IDs                                         -//
//----------------------------------------------------------------------//

SBG_INLINE bool sbgEComMsgClassIsALog(SbgEComClass msgClass)
{
    //
    // Test if this class id is part of the enum
    //
    if ((msgClass == SBG_ECOM_CLASS_LOG_ECOM_0) || (msgClass == SBG_ECOM_CLASS_LOG_ECOM_1) )
    {
        return true;
    }
    else
    {
        return false;
    }
}
 
//----------------------------------------------------------------------//
//- DEPRECATED - Used for backward compatibility                       -//
//----------------------------------------------------------------------//
 
#ifdef SBG_ECOM_USE_DEPRECATED_MACROS
    #define SBG_ECOM_LOG_NMEA_RTO                   (SBG_ECOM_LOG_NMEA_ROT)
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif  // SBG_ECOM_IDS_H