Parse received USBL position mesurements logs. More...

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

Data Structures
struct	_SbgEComLogUsbl

Macros
#define	SBG_ECOM_USBL_TIME_SYNC (0x0001u << 0)

#define	SBG_ECOM_USBL_POSITION_VALID (0x0001u << 1)

#define	SBG_ECOM_USBL_DEPTH_VALID (0x0001u << 2)

Typedefs
typedef struct _SbgEComLogUsbl	SbgEComLogUsbl

Functions
SbgErrorCode	sbgEComLogUsblReadFromStream (SbgEComLogUsbl pLogData, SbgStreamBuffer pStreamBuffer)

SbgErrorCode	sbgEComLogUsblWriteToStream (const SbgEComLogUsbl pLogData, SbgStreamBuffer pStreamBuffer)

Detailed Description

Parse received USBL position mesurements logs.

Author: SBG Systems

Date: 02 June 2014

USBL binary logs contains underwater positioning data of a USBL beacon.

Copyright: Copyright (C) 2022, 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.

Macro Definition Documentation

◆ SBG_ECOM_USBL_TIME_SYNC

#define SBG_ECOM_USBL_TIME_SYNC (0x0001u << 0)

USBL sensor status mask definitions Set to 1 if the USBL sensor data is correctly time synchronized.

◆ SBG_ECOM_USBL_POSITION_VALID

#define SBG_ECOM_USBL_POSITION_VALID (0x0001u << 1)

Set to 1 if the USBL data represents a valid 2D position.

◆ SBG_ECOM_USBL_DEPTH_VALID

#define SBG_ECOM_USBL_DEPTH_VALID (0x0001u << 2)

Set to 1 if the USBL data has a valid depth information.

Typedef Documentation

◆ SbgEComLogUsbl

typedef struct _SbgEComLogUsbl SbgEComLogUsbl

Log structure for USBL data.

Function Documentation

◆ sbgEComLogUsblReadFromStream()

SbgErrorCode sbgEComLogUsblReadFromStream	(	SbgEComLogUsbl *	pLogData,
		SbgStreamBuffer *	pStreamBuffer
	)

Parse data for the SBG_ECOM_LOG_USBL 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.

◆ sbgEComLogUsblWriteToStream()

SbgErrorCode sbgEComLogUsblWriteToStream	(	const SbgEComLogUsbl *	pLogData,
		SbgStreamBuffer *	pStreamBuffer
	)

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