sbgECom  1.11.920-stable
Data Structures | Macros | Typedefs | Functions
sbgEComBinaryLogMag.h File Reference

This file is used to parse received magnetometer binary logs. More...

#include <sbgCommon.h>
#include <streamBuffer/sbgStreamBuffer.h>

Go to the source code of this file.

Data Structures

struct  _SbgLogMag
 
struct  _SbgLogMagCalib
 

Macros

#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)
 

Typedefs

typedef struct _SbgLogMag SbgLogMag
 
typedef struct _SbgLogMagCalib SbgLogMagCalib
 

Functions

SbgErrorCode sbgEComBinaryLogParseMagData (SbgStreamBuffer *pInputStream, SbgLogMag *pOutputData)
 
SbgErrorCode sbgEComBinaryLogWriteMagData (SbgStreamBuffer *pOutputStream, const SbgLogMag *pInputData)
 
SbgErrorCode sbgEComBinaryLogParseMagCalibData (SbgStreamBuffer *pInputStream, SbgLogMagCalib *pOutputData)
 
SbgErrorCode sbgEComBinaryLogWriteMagCalibData (SbgStreamBuffer *pOutputStream, const SbgLogMagCalib *pInputData)
 

Detailed Description

This file is used to parse received magnetometer binary logs.

Author
SBG Systems (Raphael Siryani)
Date
12 March 2013

Copyright Notice

Copyright (C) 2007-2013, SBG Systems SAS. All rights reserved.

This source code is intended for use only by SBG Systems SAS and those that have explicit written permission to use it from SBG Systems SAS.

THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.

Macro Definition Documentation

§ SBG_ECOM_MAG_MAG_X_BIT

#define SBG_ECOM_MAG_MAG_X_BIT   (0x00000001u << 0)

Log magnetometer data status mask definitionsSet to 1 if the magnetometer X passes Built In Test.

§ SBG_ECOM_MAG_MAG_Y_BIT

#define SBG_ECOM_MAG_MAG_Y_BIT   (0x00000001u << 1)

Set to 1 if the magnetometer Y passes Built In Test.

§ SBG_ECOM_MAG_MAG_Z_BIT

#define SBG_ECOM_MAG_MAG_Z_BIT   (0x00000001u << 2)

Set to 1 if the magnetometer Z passes Built In Test.

§ SBG_ECOM_MAG_ACCEL_X_BIT

#define SBG_ECOM_MAG_ACCEL_X_BIT   (0x00000001u << 3)

Set to 1 if the accelerometer X passes Built In Test.

§ SBG_ECOM_MAG_ACCEL_Y_BIT

#define SBG_ECOM_MAG_ACCEL_Y_BIT   (0x00000001u << 4)

Set to 1 if the accelerometer Y passes Built In Test.

§ SBG_ECOM_MAG_ACCEL_Z_BIT

#define SBG_ECOM_MAG_ACCEL_Z_BIT   (0x00000001u << 5)

Set to 1 if the accelerometer Z passes Built In Test.

§ SBG_ECOM_MAG_MAGS_IN_RANGE

#define SBG_ECOM_MAG_MAGS_IN_RANGE   (0x00000001u << 6)

Set to 1 if all magnetometers are within operating range.

§ SBG_ECOM_MAG_ACCELS_IN_RANGE

#define SBG_ECOM_MAG_ACCELS_IN_RANGE   (0x00000001u << 7)

Set to 1 if all accelerometers are within operating range.

§ SBG_ECOM_MAG_CALIBRATION_OK

#define SBG_ECOM_MAG_CALIBRATION_OK   (0x00000001u << 8)

Set to 1 if the magnetometers seems to be calibrated.

Typedef Documentation

§ SbgLogMag

typedef struct _SbgLogMag SbgLogMag

Structure that stores data for the SBG_ECOM_LOG_MAG message.

§ SbgLogMagCalib

Structure that stores data for the SBG_ECOM_LOG_MAG_CALIB message.

Function Documentation

§ sbgEComBinaryLogParseMagData()

SbgErrorCode sbgEComBinaryLogParseMagData ( SbgStreamBuffer *  pInputStream,
SbgLogMag pOutputData 
)

Parse data for the SBG_ECOM_LOG_MAG message and fill the corresponding structure.

Parameters
[in]pInputStreamInput stream buffer to read the payload from.
[out]pOutputDataPointer on the output structure that stores parsed data.
Returns
SBG_NO_ERROR if the payload has been parsed.

§ sbgEComBinaryLogWriteMagData()

SbgErrorCode sbgEComBinaryLogWriteMagData ( SbgStreamBuffer *  pOutputStream,
const SbgLogMag pInputData 
)

Write data for the SBG_ECOM_LOG_MAG message to the output stream buffer from the provided structure.

Parameters
[out]pOutputStreamOutput stream buffer to write the payload to.
[in]pInputDataPointer on the input structure that stores data to write.
Returns
SBG_NO_ERROR if the message has been generated in the provided buffer.

§ sbgEComBinaryLogParseMagCalibData()

SbgErrorCode sbgEComBinaryLogParseMagCalibData ( SbgStreamBuffer *  pInputStream,
SbgLogMagCalib pOutputData 
)

Parse data for the SBG_ECOM_LOG_MAG_CALIB message and fill the corresponding structure.

Parameters
[in]pInputStreamInput stream buffer to read the payload from.
[out]pOutputDataPointer on the output structure that stores parsed data.
Returns
SBG_NO_ERROR if the payload has been parsed.

§ sbgEComBinaryLogWriteMagCalibData()

SbgErrorCode sbgEComBinaryLogWriteMagCalibData ( SbgStreamBuffer *  pOutputStream,
const SbgLogMagCalib pInputData 
)

Write data for the SBG_ECOM_LOG_MAG_CALIB message to the output stream buffer from the provided structure.

Parameters
[out]pOutputStreamOutput stream buffer to write the payload to.
[in]pInputDataPointer on the input structure that stores data to write.
Returns
SBG_NO_ERROR if the message has been generated in the provided buffer.