sbgEComBinaryLogMag.h File Reference

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

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

Include dependency graph for sbgEComBinaryLogMag.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_SbgLogMag
struct	_SbgLogMagCalib

Macros
#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_ACCELS_IN_RANGE   (0x00000001u << 7)
#define	SBG_ECOM_MAG_CALIBRATION_OK   (0x00000001u << 8)
#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_MAGS_IN_RANGE   (0x00000001u << 6)

Typedefs
typedef struct _SbgLogMag	SbgLogMag
typedef struct _SbgLogMagCalib	SbgLogMagCalib

Functions
SbgErrorCode	sbgEComBinaryLogParseMagCalibData (SbgStreamBuffer *pInputStream, SbgLogMagCalib *pOutputData)
SbgErrorCode	sbgEComBinaryLogParseMagData (SbgStreamBuffer *pInputStream, SbgLogMag *pOutputData)
SbgErrorCode	sbgEComBinaryLogWriteMagCalibData (SbgStreamBuffer *pOutputStream, const SbgLogMagCalib *pInputData)
SbgErrorCode	sbgEComBinaryLogWriteMagData (SbgStreamBuffer *pOutputStream, const SbgLogMag *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.

Definition in file sbgEComBinaryLogMag.h.

Macro Definition Documentation

#define SBG_ECOM_MAG_ACCEL_X_BIT   (0x00000001u << 3)

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

Definition at line 37 of file sbgEComBinaryLogMag.h.

#define SBG_ECOM_MAG_ACCEL_Y_BIT   (0x00000001u << 4)

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

Definition at line 38 of file sbgEComBinaryLogMag.h.

#define SBG_ECOM_MAG_ACCEL_Z_BIT   (0x00000001u << 5)

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

Definition at line 39 of file sbgEComBinaryLogMag.h.

#define SBG_ECOM_MAG_ACCELS_IN_RANGE   (0x00000001u << 7)

Set to 1 if all accelerometers are within operating range.

Definition at line 42 of file sbgEComBinaryLogMag.h.

#define SBG_ECOM_MAG_CALIBRATION_OK   (0x00000001u << 8)

Set to 1 if the magnetometers seems to be calibrated.

Definition at line 44 of file sbgEComBinaryLogMag.h.

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

Definition at line 33 of file sbgEComBinaryLogMag.h.

#define SBG_ECOM_MAG_MAG_Y_BIT   (0x00000001u << 1)

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

Definition at line 34 of file sbgEComBinaryLogMag.h.

#define SBG_ECOM_MAG_MAG_Z_BIT   (0x00000001u << 2)

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

Definition at line 35 of file sbgEComBinaryLogMag.h.

#define SBG_ECOM_MAG_MAGS_IN_RANGE   (0x00000001u << 6)

Set to 1 if all magnetometers are within operating range.

Definition at line 41 of file sbgEComBinaryLogMag.h.

Typedef Documentation

typedef struct _SbgLogMag SbgLogMag

Structure that stores data for the SBG_ECOM_LOG_MAG message.

typedef struct _SbgLogMagCalib SbgLogMagCalib

Structure that stores data for the SBG_ECOM_LOG_MAG_CALIB message.

Function Documentation

SbgErrorCode sbgEComBinaryLogParseMagCalibData	(	SbgStreamBuffer *	pInputStream,
		SbgLogMagCalib *	pOutputData
	)

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

Parameters

[in]	pInputStream	Input stream buffer to read the payload from.
[out]	pOutputData	Pointer on the output structure that stores parsed data.

Returns

SBG_NO_ERROR if the payload has been parsed.

Definition at line 81 of file sbgEComBinaryLogMag.c.

SbgErrorCode sbgEComBinaryLogParseMagData	(	SbgStreamBuffer *	pInputStream,
		SbgLogMag *	pOutputData
	)

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

Parameters

[in]	pInputStream	Input stream buffer to read the payload from.
[out]	pOutputData	Pointer on the output structure that stores parsed data.

Returns

SBG_NO_ERROR if the payload has been parsed.

Definition at line 13 of file sbgEComBinaryLogMag.c.

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]	pOutputStream	Output stream buffer to write the payload to.
[in]	pInputData	Pointer on the input structure that stores data to write.

Returns

SBG_NO_ERROR if the message has been generated in the provided buffer.

Definition at line 107 of file sbgEComBinaryLogMag.c.

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]	pOutputStream	Output stream buffer to write the payload to.
[in]	pInputData	Pointer on the input structure that stores data to write.

Returns

SBG_NO_ERROR if the message has been generated in the provided buffer.

Definition at line 47 of file sbgEComBinaryLogMag.c.