sbgEComIds.h
Go to the documentation of this file.
1 
27 #ifndef __SBG_ECOM_IDS_H__
28 #define __SBG_ECOM_IDS_H__
29 
30 //----------------------------------------------------------------------//
31 //- Macro definitions -//
32 //----------------------------------------------------------------------//
33 
37 #define SBG_ECOM_BUILD_ID(classId, logId) (((uint16)classId << 8) | (uint8)logId)
38 
39 //----------------------------------------------------------------------//
40 //- Definition of all class id for sbgECom -//
41 //----------------------------------------------------------------------//
42 
46 typedef enum _SbgEComClass
47 {
48  SBG_ECOM_CLASS_LOG_ECOM_0 = 0x00,
50  SBG_ECOM_CLASS_LOG_ECOM_1 = 0x01,
52  SBG_ECOM_CLASS_LOG_NMEA_0 = 0x02,
54  SBG_ECOM_CLASS_LOG_NMEA_1 = 0x03,
56  SBG_ECOM_CLASS_LOG_THIRD_PARTY_0 = 0x04,
58  SBG_ECOM_CLASS_LOG_CMD_0 = 0x10
59 } SbgEComClass;
60 
61 //----------------------------------------------------------------------//
62 //- Definition of all messages id for sbgECom -//
63 //----------------------------------------------------------------------//
64 
68 typedef enum _SbgEComLog
69 {
70  SBG_ECOM_LOG_STATUS = 1,
72  SBG_ECOM_LOG_UTC_TIME = 2,
74  SBG_ECOM_LOG_IMU_DATA = 3,
76  SBG_ECOM_LOG_MAG = 4,
77  SBG_ECOM_LOG_MAG_CALIB = 5,
79  SBG_ECOM_LOG_EKF_EULER = 6,
80  SBG_ECOM_LOG_EKF_QUAT = 7,
81  SBG_ECOM_LOG_EKF_NAV = 8,
83  SBG_ECOM_LOG_SHIP_MOTION = 9,
85  SBG_ECOM_LOG_GPS1_VEL = 13,
86  SBG_ECOM_LOG_GPS1_POS = 14,
87  SBG_ECOM_LOG_GPS1_HDT = 15,
88  SBG_ECOM_LOG_GPS1_RAW = 31,
90  SBG_ECOM_LOG_GPS2_VEL = 16,
91  SBG_ECOM_LOG_GPS2_POS = 17,
92  SBG_ECOM_LOG_GPS2_HDT = 18,
93  SBG_ECOM_LOG_GPS2_RAW = 38,
95  SBG_ECOM_LOG_ODO_VEL = 19,
97  SBG_ECOM_LOG_EVENT_A = 24,
98  SBG_ECOM_LOG_EVENT_B = 25,
99  SBG_ECOM_LOG_EVENT_C = 26,
100  SBG_ECOM_LOG_EVENT_D = 27,
101  SBG_ECOM_LOG_EVENT_E = 28,
103  SBG_ECOM_LOG_DVL_BOTTOM_TRACK = 29,
104  SBG_ECOM_LOG_DVL_WATER_TRACK = 30,
106  SBG_ECOM_LOG_SHIP_MOTION_HP = 32,
108  SBG_ECOM_LOG_PRESSURE = 36,
110  SBG_ECOM_LOG_USBL = 37,
112  SBG_ECOM_LOG_DEBUG_0 = 39,
114  SBG_ECOM_LOG_ECOM_NUM_MESSAGES
115 } SbgEComLog;
116 
120 typedef enum _SbgEComLog1MsgId
121 {
122  SBG_ECOM_LOG_FAST_IMU_DATA = 0,
123  SBG_ECOM_LOG_ECOM_1_NUM_MESSAGES
124 } SbgEComLog1;
125 
129 typedef enum _SbgEComNmeaLog
130 {
131  SBG_ECOM_LOG_NMEA_GGA = 0,
132  SBG_ECOM_LOG_NMEA_RMC = 1,
133  SBG_ECOM_LOG_NMEA_ZDA = 2,
134  SBG_ECOM_LOG_NMEA_HDT = 3,
135  SBG_ECOM_LOG_NMEA_GST = 4,
136  SBG_ECOM_LOG_NMEA_VBW = 5,
137  SBG_ECOM_LOG_NMEA_DPT = 7,
138  SBG_ECOM_LOG_NMEA_VTG = 8,
139  SBG_ECOM_LOG_NMEA_NUM_MESSAGES
140 } SbgEComNmeaLog;
141 
145 typedef enum _SbgEComIdNmea1Log
146 {
147  SBG_ECOM_LOG_NMEA_1_PRDID = 0,
148  SBG_ECOM_LOG_NMEA_1_PSBGI = 1,
149  SBG_ECOM_LOG_NMEA_1_PASHR = 2,
150  SBG_ECOM_LOG_NMEA_1_PSBGB = 3,
152  SBG_ECOM_THIRD_PARTY_IXBLUE_PHINF = 5,
153  SBG_ECOM_THIRD_PARTY_IXBLUE_PHTRO = 6,
154  SBG_ECOM_THIRD_PARTY_IXBLUE_PHLIN = 7,
155  SBG_ECOM_THIRD_PARTY_IXBLUE_PHOCT = 8,
157  SBG_ECOM_LOG_NMEA_1_NUM_MESSAGES
158 } SbgEComIdNmea1Log;
159 
163 typedef enum _SbgEComIdThirdParty
164 {
165  SBG_ECOM_THIRD_PARTY_TSS1 = 0,
166  SBG_ECOM_THIRD_PARTY_KVH = 1,
168  SBG_ECOM_THIRD_PARTY_PD0 = 2,
169  SBG_ECOM_THIRD_PARTY_SIMRAD_1000 = 3,
170  SBG_ECOM_THIRD_PARTY_SIMRAD_3000 = 4,
172  SBG_ECOM_THIRD_PARTY_SEAPATH_B26 = 5,
174  SBG_ECOM_LOG_THIRD_PARTY_NUM_MESSAGES
175 } SbgEComIdThirdParty;
176 
180 typedef enum _SbgEComCmd
181 {
182  /* Acknowledge */
183  SBG_ECOM_CMD_ACK = 0,
185  /* Special settings commands */
186  SBG_ECOM_CMD_SETTINGS_ACTION = 1,
187  SBG_ECOM_CMD_IMPORT_SETTINGS = 2,
188  SBG_ECOM_CMD_EXPORT_SETTINGS = 3,
190  /* Device info */
191  SBG_ECOM_CMD_INFO = 4,
193  /* Sensor parameters */
194  SBG_ECOM_CMD_INIT_PARAMETERS = 5,
195  SBG_ECOM_CMD_SET_MOTION_PROFILE = 6,
196  SBG_ECOM_CMD_MOTION_PROFILE_ID = 7,
197  SBG_ECOM_CMD_IMU_ALIGNMENT_LEVER_ARM = 8,
198  SBG_ECOM_CMD_AIDING_ASSIGNMENT = 9,
200  /* Magnetometer configuration */
201  SBG_ECOM_CMD_MAGNETOMETER_SET_MODEL = 10,
202  SBG_ECOM_CMD_MAGNETOMETER_MODEL_ID = 11,
203  SBG_ECOM_CMD_MAGNETOMETER_REJECT_MODE = 12,
204  SBG_ECOM_CMD_SET_MAG_CALIB = 13,
206  /* Magnetometer onboard calibration */
207  SBG_ECOM_CMD_START_MAG_CALIB = 14,
208  SBG_ECOM_CMD_COMPUTE_MAG_CALIB = 15,
210  /* GNSS configuration */
211  SBG_ECOM_CMD_GNSS_1_SET_MODEL = 16,
212  SBG_ECOM_CMD_GNSS_1_MODEL_ID = 17,
213  SBG_ECOM_CMD_GNSS_1_LEVER_ARM_ALIGNMENT = 18,
214  SBG_ECOM_CMD_GNSS_1_REJECT_MODES = 19,
216  /* Odometer configuration */
217  SBG_ECOM_CMD_ODO_CONF = 20,
218  SBG_ECOM_CMD_ODO_LEVER_ARM = 21,
219  SBG_ECOM_CMD_ODO_REJECT_MODE = 22,
221  /* Interfaces configuration */
222  SBG_ECOM_CMD_UART_CONF = 23,
223  SBG_ECOM_CMD_CAN_BUS_CONF = 24,
224  SBG_ECOM_CMD_CAN_OUTPUT_CONF = 25,
226  /* Events configuration */
227  SBG_ECOM_CMD_SYNC_IN_CONF = 26,
228  SBG_ECOM_CMD_SYNC_OUT_CONF = 27,
230  /* Output configuration */
231  SBG_ECOM_CMD_NMEA_TALKER_ID = 29,
232  SBG_ECOM_CMD_OUTPUT_CONF = 30,
233  SBG_ECOM_CMD_LEGACY_CONT_OUTPUT_CONF = 31,
235  /* Avanced configuration */
236  SBG_ECOM_CMD_ADVANCED_CONF = 32,
238  /* Features related commands */
239  SBG_ECOM_CMD_FEATURES = 33,
241  /* Licenses related commands */
242  SBG_ECOM_CMD_LICENSE_APPLY = 34,
244  /* Message class output switch */
245  SBG_ECOM_CMD_OUTPUT_CLASS_ENABLE = 35,
247  /* Ethernet configuration */
248  SBG_ECOM_CMD_ETHERNET_CONF = 36,
249  SBG_ECOM_CMD_ETHERNET_INFO = 37,
251  /* Misc. */
252  SBG_ECOM_LOG_ECOM_NUM_CMDS
253 } SbgEComCmd;
254 
258 typedef union _SbgEComUnifiedId
259 {
260  SbgEComLog eComLog;
261  SbgEComLog1 eCom1Log;
262  SbgEComNmeaLog nmeaId;
263  SbgEComIdNmea1Log nmea1Id;
264  SbgEComIdThirdParty thirdPartyId;
265  SbgEComCmd eComCmd;
266 } SbgEComUnifiedId;
267 
272 typedef uint16 SbgEComCmdId;
273 
278 typedef uint8 SbgEComMsgId;
279 
280 //----------------------------------------------------------------------//
281 //- Inline helpers for log IDs -//
282 //----------------------------------------------------------------------//
283 
289 SBG_INLINE bool sbgEComMsgClassIsALog(SbgEComClass msgClass)
290 {
291  //
292  // Test if this class id is part of the enum
293  //
294  if ( (msgClass == SBG_ECOM_CLASS_LOG_ECOM_0) || (msgClass == SBG_ECOM_CLASS_LOG_ECOM_1) )
295  {
296  return TRUE;
297  }
298  else
299  {
300  return FALSE;
301  }
302 }
303 
304 
310 SBG_INLINE bool sbgEComBinaryLogIsCmdValid(uint16 cmdId)
311 {
312  //
313  // Test if this command id is part of the enum
314  // TODO Improve that test!!
315  //
316  if ( (cmdId >= SBG_ECOM_LOG_STATUS) && (cmdId <= SBG_ECOM_LOG_DEBUG_0) )
317  {
318  return TRUE;
319  }
320  else
321  {
322  return FALSE;
323  }
324 }
325 
326 #endif /* __SBG_ECOM_CMDS_H__ */
sbgEComBinaryLogIsCmdValid
SBG_INLINE bool sbgEComBinaryLogIsCmdValid(uint16 cmdId)
Definition: sbgEComIds.h:310
SbgEComLog
enum _SbgEComLog SbgEComLog
SbgEComCmd
enum _SbgEComCmd SbgEComCmd
_SbgEComNmeaLog
_SbgEComNmeaLog
Definition: sbgEComIds.h:129
SbgEComIdNmea1Log
enum _SbgEComIdNmea1Log SbgEComIdNmea1Log
_SbgEComUnifiedId::thirdPartyId
SbgEComIdThirdParty thirdPartyId
Definition: sbgEComIds.h:264
TRUE
#define TRUE
Definition: sbgDefines.h:39
_SbgEComLog1MsgId
_SbgEComLog1MsgId
Definition: sbgEComIds.h:120
SbgEComUnifiedId
union _SbgEComUnifiedId SbgEComUnifiedId
_SbgEComUnifiedId::eComCmd
SbgEComCmd eComCmd
Definition: sbgEComIds.h:265
SbgEComCmdId
uint16 SbgEComCmdId
Definition: sbgEComIds.h:272
SbgEComIdThirdParty
enum _SbgEComIdThirdParty SbgEComIdThirdParty
SBG_INLINE
#define SBG_INLINE
Definition: sbgDefines.h:94
_SbgEComIdThirdParty
_SbgEComIdThirdParty
Definition: sbgEComIds.h:163
SbgEComMsgId
uint8 SbgEComMsgId
Definition: sbgEComIds.h:278
SbgEComNmeaLog
enum _SbgEComNmeaLog SbgEComNmeaLog
_SbgEComUnifiedId
Definition: sbgEComIds.h:258
_SbgEComIdNmea1Log
_SbgEComIdNmea1Log
Definition: sbgEComIds.h:145
_SbgEComUnifiedId::nmea1Id
SbgEComIdNmea1Log nmea1Id
Definition: sbgEComIds.h:263
_SbgEComUnifiedId::eComLog
SbgEComLog eComLog
Definition: sbgEComIds.h:260
uint8
unsigned char uint8
Definition: sbgTypes.h:56
_SbgEComCmd
_SbgEComCmd
Definition: sbgEComIds.h:180
_SbgEComUnifiedId::nmeaId
SbgEComNmeaLog nmeaId
Definition: sbgEComIds.h:262
_SbgEComClass
_SbgEComClass
Definition: sbgEComIds.h:46
SbgEComClass
enum _SbgEComClass SbgEComClass
sbgEComMsgClassIsALog
SBG_INLINE bool sbgEComMsgClassIsALog(SbgEComClass msgClass)
Definition: sbgEComIds.h:289
FALSE
#define FALSE
Definition: sbgDefines.h:35
SbgEComLog1
enum _SbgEComLog1MsgId SbgEComLog1
uint16
unsigned short uint16
Definition: sbgTypes.h:57
_SbgEComLog
_SbgEComLog
Definition: sbgEComIds.h:68
_SbgEComUnifiedId::eCom1Log
SbgEComLog1 eCom1Log
Definition: sbgEComIds.h:261

sbg_driver
Author(s):
autogenerated on Sun Jan 27 2019 03:42:20