Parse magnetic calibration logs. More...

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

Data Structures
struct	_SbgEComLogMagCalib

Typedefs
typedef struct _SbgEComLogMagCalib	SbgEComLogMagCalib

Functions
SbgErrorCode	sbgEComLogMagCalibReadFromStream (SbgEComLogMagCalib pLogData, SbgStreamBuffer pStreamBuffer)

SbgErrorCode	sbgEComLogMagCalibWriteToStream (const SbgEComLogMagCalib pLogData, SbgStreamBuffer pStreamBuffer)

Detailed Description

Parse magnetic calibration logs.

Author: SBG Systems

Date: 15 Mai 2024

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

License

The MIT license

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Typedef Documentation

◆ SbgEComLogMagCalib

typedef struct _SbgEComLogMagCalib SbgEComLogMagCalib

Represents data from the SBG_ECOM_LOG_MAG_CALIB message.

This structure contains raw magnetic field data that has not been compensated for soft and hard iron effects. It is intended to be used with SBG Systems' magnetic calibration algorithms, which calculate the necessary compensation parameters to correct for these distortions.

Note: An effective strategy for utilizing this data involves storing the raw data stream that includes this message and later processing it with the sbgCenter software to perform offline soft and hard iron magnetic compensation.

Function Documentation

◆ sbgEComLogMagCalibReadFromStream()

SbgErrorCode sbgEComLogMagCalibReadFromStream	(	SbgEComLogMagCalib *	pLogData,
		SbgStreamBuffer *	pStreamBuffer )

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

Parameters

[out]	pLogData	Log structure instance to fill.
[in]	pStreamBuffer	Input stream buffer to read the log from.

Returns: SBG_NO_ERROR if a valid log has been read from the stream buffer.

◆ sbgEComLogMagCalibWriteToStream()

SbgErrorCode sbgEComLogMagCalibWriteToStream	(	const SbgEComLogMagCalib *	pLogData,
		SbgStreamBuffer *	pStreamBuffer )

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