sbgEComCmdAdvanced.h File Reference

Advanced settings related commands. More...

#include <sbgCommon.h>
#include <sbgECom.h>

Go to the source code of this file.

Data Structures
struct	_SbgEComAdvancedConf
struct	_SbgEComValidityThresholds

Macros
#define	SBG_ECOM_GNSS_OPT_01   (uint32_t)(0x00000001 << 0)
#define	SBG_ECOM_NMEA_OPT_MODE_STD   (uint32_t)(0x00000001 << 0)
#define	SBG_ECOM_NMEA_OPT_FORCE_UTC   (uint32_t)(0x00000001 << 4)

Typedefs
typedef enum _SbgEComTimeReferenceSrc	SbgEComTimeReferenceSrc
typedef struct _SbgEComAdvancedConf	SbgEComAdvancedConf
typedef struct _SbgEComValidityThresholds	SbgEComValidityThresholds

Enumerations
enum	_SbgEComTimeReferenceSrc {   SBG_ECOM_TIME_REF_DISABLED = 0 ,   SBG_ECOM_TIME_REF_SYNC_IN_A ,   SBG_ECOM_TIME_REF_UTC_GPS_1 }

Functions
SbgErrorCode	sbgEComCmdAdvancedGetConf (SbgEComHandle *pHandle, SbgEComAdvancedConf *pConf)
SbgErrorCode	sbgEComCmdAdvancedSetConf (SbgEComHandle *pHandle, const SbgEComAdvancedConf *pConf)
SbgErrorCode	sbgEComCmdAdvancedGetThresholds (SbgEComHandle *pHandle, SbgEComValidityThresholds *pConf)
SbgErrorCode	sbgEComCmdAdvancedSetThresholds (SbgEComHandle *pHandle, const SbgEComValidityThresholds *pConf)

Detailed Description

Advanced settings related commands.

Author

SBG Systems

Date

11 June 2014

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_GNSS_OPT_01

#define SBG_ECOM_GNSS_OPT_01   (uint32_t)(0x00000001 << 0)

List all options for the GNSS bitmask options Reserved advanced GNSS option for ELLIPSE-N/D v3

SBG_ECOM_NMEA_OPT_MODE_STD

#define SBG_ECOM_NMEA_OPT_MODE_STD   (uint32_t)(0x00000001 << 0)

List all options for the NMEA bitmask options Output NMEA messages that complies with 82 chars limit

SBG_ECOM_NMEA_OPT_FORCE_UTC

#define SBG_ECOM_NMEA_OPT_FORCE_UTC   (uint32_t)(0x00000001 << 4)

Always output time in NMEA messages even if invalid

Typedef Documentation

SbgEComTimeReferenceSrc

typedef enum _SbgEComTimeReferenceSrc SbgEComTimeReferenceSrc

List of available time reference source.

SbgEComAdvancedConf

typedef struct _SbgEComAdvancedConf SbgEComAdvancedConf

Structure containing all the info for advanced configuration.

SbgEComValidityThresholds

typedef struct _SbgEComValidityThresholds SbgEComValidityThresholds

Structure containing all validity thresholds (status outputs) Setting these thresholds to 0.0 will keep default configuration

Enumeration Type Documentation

_SbgEComTimeReferenceSrc

enum _SbgEComTimeReferenceSrc

List of available time reference source.

Enumerator
SBG_ECOM_TIME_REF_DISABLED	The device is running it's internal clock without any time reference.
SBG_ECOM_TIME_REF_SYNC_IN_A	The main port sync in A is used as a time reference.
SBG_ECOM_TIME_REF_UTC_GPS_1	The GPS 1 module is used to provide both time reference and UTC data.

Function Documentation

sbgEComCmdAdvancedGetConf()

SbgErrorCode sbgEComCmdAdvancedGetConf	(	SbgEComHandle *	pHandle,
		SbgEComAdvancedConf *	pConf
	)

Retrieve the advanced configurations.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pConf	Pointer to a SbgEComAdvancedConf to contain the current configuration.

Returns

SBG_NO_ERROR if the command has been executed successfully.

sbgEComCmdAdvancedSetConf()

SbgErrorCode sbgEComCmdAdvancedSetConf	(	SbgEComHandle *	pHandle,
		const SbgEComAdvancedConf *	pConf
	)

Set the advanced configurations.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	pConf	Pointer to a SbgEComAdvancedConf that contains the new configuration.

Returns

SBG_NO_ERROR if the command has been executed successfully.

sbgEComCmdAdvancedGetThresholds()

SbgErrorCode sbgEComCmdAdvancedGetThresholds	(	SbgEComHandle *	pHandle,
		SbgEComValidityThresholds *	pConf
	)

Retrieve the current validity thresholds

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pConf	Pointer to a SbgEComValidityThresholds to contain the current configuration.

Returns

SBG_NO_ERROR if the command has been executed successfully.

sbgEComCmdAdvancedSetThresholds()

SbgErrorCode sbgEComCmdAdvancedSetThresholds	(	SbgEComHandle *	pHandle,
		const SbgEComValidityThresholds *	pConf
	)

Set the validity thresholds

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	pConf	Pointer to a SbgEComValidityThresholds that contains the new configuration.

Returns

SBG_NO_ERROR if the command has been executed successfully.