sbgECom Library  4.0.1987-stable
C library to interface SBG Systems IMU/AHRS/INS
sbgEComLogMag.h
Go to the documentation of this file.
1 
33 #ifndef SBG_ECOM_LOG_MAG_H
34 #define SBG_ECOM_LOG_MAG_H
35 
36 // sbgCommonLib headers
37 #include <sbgCommon.h>
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 //----------------------------------------------------------------------//
45 //- Log magnetometers status definitions -//
46 //----------------------------------------------------------------------//
47 
51 #define SBG_ECOM_MAG_MAG_X_BIT (0x00000001u << 0)
52 #define SBG_ECOM_MAG_MAG_Y_BIT (0x00000001u << 1)
53 #define SBG_ECOM_MAG_MAG_Z_BIT (0x00000001u << 2)
55 #define SBG_ECOM_MAG_ACCEL_X_BIT (0x00000001u << 3)
56 #define SBG_ECOM_MAG_ACCEL_Y_BIT (0x00000001u << 4)
57 #define SBG_ECOM_MAG_ACCEL_Z_BIT (0x00000001u << 5)
59 #define SBG_ECOM_MAG_MAGS_IN_RANGE (0x00000001u << 6)
60 #define SBG_ECOM_MAG_ACCELS_IN_RANGE (0x00000001u << 7)
62 #define SBG_ECOM_MAG_CALIBRATION_OK (0x00000001u << 8)
64 //----------------------------------------------------------------------//
65 //- Log structure definitions -//
66 //----------------------------------------------------------------------//
67 
71 typedef struct _SbgEComLogMag
72 {
73  uint32_t timeStamp;
74  uint16_t status;
75  float magnetometers[3];
76  float accelerometers[3];
78 
82 typedef struct _SbgEComLogMagCalib
83 {
84  uint32_t timeStamp;
85  uint16_t reserved;
86  uint8_t magData[16];
88 
89 //----------------------------------------------------------------------//
90 //- Public methods -//
91 //----------------------------------------------------------------------//
92 
101 
110 
119 
128 
129 //----------------------------------------------------------------------//
130 //- DEPRECATED - Used for backward compatibility -//
131 //----------------------------------------------------------------------//
132 
133 SBG_DEPRECATED_TYPEDEF(typedef struct _SbgEComLogMag SbgLogMag);
134 SBG_DEPRECATED_TYPEDEF(typedef struct _SbgEComLogMagCalib SbgLogMagCalib);
135 
136 SBG_DEPRECATED(SbgErrorCode sbgEComBinaryLogParseMagData(SbgStreamBuffer *pStreamBuffer, SbgEComLogMag *pLogData));
137 SBG_DEPRECATED(SbgErrorCode sbgEComBinaryLogWriteMagData(SbgStreamBuffer *pStreamBuffer, const SbgEComLogMag *pLogData));
138 
139 SBG_DEPRECATED(SbgErrorCode sbgEComBinaryLogParseMagCalibData(SbgStreamBuffer *pStreamBuffer, SbgEComLogMagCalib *pLogData));
140 SBG_DEPRECATED(SbgErrorCode sbgEComBinaryLogWriteMagCalibData(SbgStreamBuffer *pStreamBuffer, const SbgEComLogMagCalib *pLogData));
141 
142 #ifdef __cplusplus
143 }
144 #endif
145 
146 #endif // SBG_ECOM_LOG_MAG_H
Main header for the SBG Systems common C library.
#define SBG_DEPRECATED_TYPEDEF(decl)
Definition: sbgDefines.h:349
struct _SbgEComLogMag SbgEComLogMag
SbgErrorCode sbgEComLogMagCalibReadFromStream(SbgEComLogMagCalib *pLogData, SbgStreamBuffer *pStreamBuffer)
struct _SbgEComLogMagCalib SbgEComLogMagCalib
SbgErrorCode sbgEComLogMagCalibWriteToStream(const SbgEComLogMagCalib *pLogData, SbgStreamBuffer *pStreamBuffer)
SbgErrorCode sbgEComLogMagWriteToStream(const SbgEComLogMag *pLogData, SbgStreamBuffer *pStreamBuffer)
SbgErrorCode sbgEComLogMagReadFromStream(SbgEComLogMag *pLogData, SbgStreamBuffer *pStreamBuffer)
enum _SbgErrorCode SbgErrorCode
Used to read/write data from/to a memory buffer stream.
SBG_DEPRECATED(SBG_INLINE uint32_t SBG_VERSION(uint8_t major, uint8_t minor, uint8_t rev, uint8_t build))
Definition: sbgEComLogMag.h:83
uint32_t timeStamp
Definition: sbgEComLogMag.h:84
uint16_t reserved
Definition: sbgEComLogMag.h:85
uint8_t magData[16]
Definition: sbgEComLogMag.h:86
Definition: sbgEComLogMag.h:72
float magnetometers[3]
Definition: sbgEComLogMag.h:75
uint16_t status
Definition: sbgEComLogMag.h:74
uint32_t timeStamp
Definition: sbgEComLogMag.h:73
float accelerometers[3]
Definition: sbgEComLogMag.h:76
Definition: sbgStreamBufferCommon.h:201