sbgEComCmdGnss.h File Reference

GNSS aiding module configuration commands. More...

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

Go to the source code of this file.

Data Structures
struct	_SbgEComGnssInstallation
struct	_SbgEComGnssRejectionConf

Typedefs
typedef enum _SbgEComGnssModelsStdIds	SbgEComGnssModelsStdIds
typedef enum _SbgEComGnssInstallationMode	SbgEComGnssInstallationMode
typedef struct _SbgEComGnssInstallation	SbgEComGnssInstallation
typedef struct _SbgEComGnssRejectionConf	SbgEComGnssRejectionConf

Enumerations
enum	_SbgEComGnssModelsStdIds {   SBG_ECOM_GNSS_MODEL_INTERNAL = 101 ,   SBG_ECOM_GNSS_MODEL_NMEA = 102 ,   SBG_ECOM_GNSS_MODEL_UBLOX_GPS_BEIDOU = 103 ,   SBG_ECOM_GNSS_MODEL_UBLOX_EXTERNAL = 104 ,   SBG_ECOM_GNSS_MODEL_RESERVED_01 = 105 ,   SBG_ECOM_GNSS_MODEL_NOVATEL_EXTERNAL = 106 ,   SBG_ECOM_GNSS_MODEL_RESERVED_02 = 107 ,   SBG_ECOM_GNSS_MODEL_RESERVED_03 = 108 ,   SBG_ECOM_GNSS_MODEL_SEPTENTRIO_EXTERNAL = 109 ,   SBG_ECOM_GNSS_MODEL_RESERVED_04 = 110 }
enum	_SbgEComGnssInstallationMode {   SBG_ECOM_GNSS_INSTALLATION_MODE_SINGLE = 1 ,   SBG_ECOM_GNSS_INSTALLATION_MODE_DUAL_AUTO = 2 ,   SBG_ECOM_GNSS_INSTALLATION_MODE_DUAL_ROUGH = 3 ,   SBG_ECOM_GNSS_INSTALLATION_MODE_DUAL_PRECISE = 4 }

Functions
SbgErrorCode	sbgEComCmdGnss1SetModelId (SbgEComHandle *pHandle, SbgEComGnssModelsStdIds modelId)
SbgErrorCode	sbgEComCmdGnss1GetModelId (SbgEComHandle *pHandle, SbgEComGnssModelsStdIds *pModelId)
SbgErrorCode	sbgEComCmdGnss1InstallationGet (SbgEComHandle *pHandle, SbgEComGnssInstallation *pGnssInstallation)
SbgErrorCode	sbgEComCmdGnss1InstallationSet (SbgEComHandle *pHandle, const SbgEComGnssInstallation *pGnssInstallation)
SbgErrorCode	sbgEComCmdGnss1GetRejection (SbgEComHandle *pHandle, SbgEComGnssRejectionConf *pRejectConf)
SbgErrorCode	sbgEComCmdGnss1SetRejection (SbgEComHandle *pHandle, const SbgEComGnssRejectionConf *pRejectConf)

Detailed Description

GNSS aiding module configuration 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.

Typedef Documentation

SbgEComGnssModelsStdIds

typedef enum _SbgEComGnssModelsStdIds SbgEComGnssModelsStdIds

This enum defines the different GNSS model IDs available in standard

SbgEComGnssInstallationMode

typedef enum _SbgEComGnssInstallationMode SbgEComGnssInstallationMode

GNSS mechanical installation modes for the dual antenna mode.

SbgEComGnssInstallation

typedef struct _SbgEComGnssInstallation SbgEComGnssInstallation

GNSS mechanical installation parameters to be used with command SBG_ECOM_CMD_GNSS_::_INSTALLATION

SbgEComGnssRejectionConf

typedef struct _SbgEComGnssRejectionConf SbgEComGnssRejectionConf

Holds all necessary information for GNSS module data rejection.

Enumeration Type Documentation

_SbgEComGnssModelsStdIds

enum _SbgEComGnssModelsStdIds

This enum defines the different GNSS model IDs available in standard

Enumerator
SBG_ECOM_GNSS_MODEL_INTERNAL	Default internal GNSS for ELLIPSE-N and ELLIPSE-D
SBG_ECOM_GNSS_MODEL_NMEA	ELLIPSE-E to accept an external GNSS using NMEA protocol
SBG_ECOM_GNSS_MODEL_UBLOX_GPS_BEIDOU	Only for ELLIPSE-N hardware 1 & 2 to select GPS+BEIDOU instead of the default GPS+GLONASS
SBG_ECOM_GNSS_MODEL_UBLOX_EXTERNAL	ELLIPSE-E to accept an external Ublox GNSS (receive only - passive)
SBG_ECOM_GNSS_MODEL_RESERVED_01	Reserved, do not use
SBG_ECOM_GNSS_MODEL_NOVATEL_EXTERNAL	ELLIPSE-E to accept an external Novatel GNSS (receive only - passive)
SBG_ECOM_GNSS_MODEL_RESERVED_02	Reserved, do not use
SBG_ECOM_GNSS_MODEL_RESERVED_03	Reserved, do not use
SBG_ECOM_GNSS_MODEL_SEPTENTRIO_EXTERNAL	ELLIPSE-E to accept an external Septentrio GNSS(receive only - passive)
SBG_ECOM_GNSS_MODEL_RESERVED_04	Reserved, do not use

_SbgEComGnssInstallationMode

enum _SbgEComGnssInstallationMode

GNSS mechanical installation modes for the dual antenna mode.

Enumerator
SBG_ECOM_GNSS_INSTALLATION_MODE_SINGLE	The GNSS will be used in single antenna mode only and the secondary lever arm is not used.
SBG_ECOM_GNSS_INSTALLATION_MODE_DUAL_AUTO	[Reserved] The GNSS dual antenna information will be used but the secondary lever arm is not known.
SBG_ECOM_GNSS_INSTALLATION_MODE_DUAL_ROUGH	The GNSS dual antenna information will be used and we have a rough guess for the secondary lever arm.
SBG_ECOM_GNSS_INSTALLATION_MODE_DUAL_PRECISE	The GNSS dual antenna information will be used and the secondary lever arm is accurately entered and doesn't need online re-estimation.

Function Documentation

sbgEComCmdGnss1SetModelId()

SbgErrorCode sbgEComCmdGnss1SetModelId	(	SbgEComHandle *	pHandle,
		SbgEComGnssModelsStdIds	modelId
	)

Set GNSS error model id.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	modelId	Model ID to set

Returns

SBG_NO_ERROR if the command has been executed successfully.

sbgEComCmdGnss1GetModelId()

SbgErrorCode sbgEComCmdGnss1GetModelId	(	SbgEComHandle *	pHandle,
		SbgEComGnssModelsStdIds *	pModelId
	)

Retrieve GNSS error model id.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pModelId	Retrieved model id.

Returns

SBG_NO_ERROR if the command has been executed successfully.

sbgEComCmdGnss1InstallationGet()

SbgErrorCode sbgEComCmdGnss1InstallationGet	(	SbgEComHandle *	pHandle,
		SbgEComGnssInstallation *	pGnssInstallation
	)

Retrieve the mechanical installation parameters for the GNSS 1 module.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pGnssInstallation	Used to store the retrieved the GNSS installation parameters.

Returns

SBG_NO_ERROR if the command has been executed successfully.

sbgEComCmdGnss1InstallationSet()

SbgErrorCode sbgEComCmdGnss1InstallationSet	(	SbgEComHandle *	pHandle,
		const SbgEComGnssInstallation *	pGnssInstallation
	)

Set the mechanical installation parameters for the GNSS 1 module.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	pGnssInstallation	The GNSS installation parameters to set.

Returns

SBG_NO_ERROR if the command has been executed successfully.

sbgEComCmdGnss1GetRejection()

SbgErrorCode sbgEComCmdGnss1GetRejection	(	SbgEComHandle *	pHandle,
		SbgEComGnssRejectionConf *	pRejectConf
	)

Retrieve the rejection configuration of the gnss module.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pRejectConf	Pointer to a SbgEComGnssRejectionConf struct to hold rejection configuration of the gnss module.

Returns

SBG_NO_ERROR if the command has been executed successfully.

sbgEComCmdGnss1SetRejection()

SbgErrorCode sbgEComCmdGnss1SetRejection	(	SbgEComHandle *	pHandle,
		const SbgEComGnssRejectionConf *	pRejectConf
	)

Set the rejection configuration of the gnss module.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pRejectConf	Pointer to a SbgEComGnssRejectionConf struct holding rejection configuration for the gnss module.

Returns

SBG_NO_ERROR if the command has been executed successfully.