sbgEComLogMag.h

Go to the documentation of this file.

 
#ifndef SBG_ECOM_LOG_MAG_H
#define SBG_ECOM_LOG_MAG_H
 
// sbgCommonLib headers
#include <sbgCommon.h>
#include <streamBuffer/sbgStreamBuffer.h>
 
// Project headers
#include <defs/sbgEComDefsAiding.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
//----------------------------------------------------------------------//
//- Log magnetometers status definitions                               -//
//----------------------------------------------------------------------//

#define SBG_ECOM_MAG_MAG_X_BIT          (0x00000001u << 0)      
#define SBG_ECOM_MAG_MAG_Y_BIT          (0x00000001u << 1)      
#define SBG_ECOM_MAG_MAG_Z_BIT          (0x00000001u << 2)      
 
#define SBG_ECOM_MAG_ACCEL_X_BIT        (0x00000001u << 3)      
#define SBG_ECOM_MAG_ACCEL_Y_BIT        (0x00000001u << 4)      
#define SBG_ECOM_MAG_ACCEL_Z_BIT        (0x00000001u << 5)      
 
#define SBG_ECOM_MAG_MAGS_IN_RANGE      (0x00000001u << 6)      
#define SBG_ECOM_MAG_ACCELS_IN_RANGE    (0x00000001u << 7)      
 
#define SBG_ECOM_MAG_CALIBRATION_OK     (0x00000001u << 8)      
 
//----------------------------------------------------------------------//
//- Log structure definitions                                          -//
//----------------------------------------------------------------------//

typedef struct _SbgEComLogMag
{
    uint32_t    timeStamp;                 
    uint16_t    status;                       
    float       magnetometers[3];          
    float       accelerometers[3];            
} SbgEComLogMag;
 
//----------------------------------------------------------------------//
//- Public methods                                                     -//
//----------------------------------------------------------------------//

SbgErrorCode sbgEComLogMagReadFromStream(SbgEComLogMag *pLogData, SbgStreamBuffer *pStreamBuffer);

SbgErrorCode sbgEComLogMagWriteToStream(const SbgEComLogMag *pLogData, SbgStreamBuffer *pStreamBuffer);
 
//----------------------------------------------------------------------//
//- Public setters/getters                                             -//
//----------------------------------------------------------------------//

void sbgEComLogMagSetTimeType(SbgEComLogMag *pLogData, SbgEComAidingTimeType timeType);

SbgEComAidingTimeType sbgEComLogMagGetTimeType(const SbgEComLogMag *pLogData);
 
//----------------------------------------------------------------------//
//- DEPRECATED - Used for backward compatibility                       -//
//----------------------------------------------------------------------//
 
SBG_DEPRECATED_TYPEDEF(typedef struct _SbgEComLogMag        SbgLogMag);
 
SBG_DEPRECATED(SbgErrorCode sbgEComBinaryLogParseMagData(SbgStreamBuffer *pStreamBuffer, SbgEComLogMag *pLogData));
SBG_DEPRECATED(SbgErrorCode sbgEComBinaryLogWriteMagData(SbgStreamBuffer *pStreamBuffer, const SbgEComLogMag *pLogData));
 
#ifdef __cplusplus
}
#endif
 
#endif // SBG_ECOM_LOG_MAG_H