This file implements SbgECom commands related to GNSS module. More...

#include "sbgEComCmdCommon.h"

Include dependency graph for sbgEComCmdGnss.h:

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

Classes
struct	_SbgEComGnssAlignmentInfo

struct	_SbgEComGnssInstallation

struct	_SbgEComGnssRejectionConf

Typedefs
typedef struct _SbgEComGnssAlignmentInfo	SbgEComGnssAlignmentInfo

typedef struct _SbgEComGnssInstallation	SbgEComGnssInstallation

typedef enum _SbgEComGnssInstallationMode	SbgEComGnssInstallationMode

typedef enum _SbgEComGnssModelsStdIds	SbgEComGnssModelsStdIds

typedef struct _SbgEComGnssRejectionConf	SbgEComGnssRejectionConf

Enumerations
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 }

enum	_SbgEComGnssModelsStdIds { SBG_ECOM_GNSS_MODEL_UBLOX_GPS_GLONASS = 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_UBLOX_HIGH_DYNAMICS = 105, SBG_ECOM_GNSS_MODEL_NOVATEL_EXTERNAL = 106, SBG_ECOM_GNSS_MODEL_ELLIPSE_D_INTERNAL = 107, SBG_ECOM_GNSS_MODEL_UBLOX_HIGH_SPEED = 108, SBG_ECOM_GNSS_MODEL_SEPTENTRIO_EXTERNAL = 109, SBG_ECOM_GNSS_MODEL_UBLOX_LOW_SPEED = 110 }

Functions
	SBG_DEPRECATED (SbgErrorCode sbgEComCmdGnss1GetLeverArmAlignment(SbgEComHandle pHandle, SbgEComGnssAlignmentInfo pAlignConf))

	SBG_DEPRECATED (SbgErrorCode sbgEComCmdGnss1SetLeverArmAlignment(SbgEComHandle pHandle, const SbgEComGnssAlignmentInfo pAlignConf))

SbgErrorCode	sbgEComCmdGnss1GetModelInfo (SbgEComHandle pHandle, SbgEComModelInfo pModelInfo)

SbgErrorCode	sbgEComCmdGnss1GetRejection (SbgEComHandle pHandle, SbgEComGnssRejectionConf pRejectConf)

SbgErrorCode	sbgEComCmdGnss1InstallationGet (SbgEComHandle pHandle, SbgEComGnssInstallation pGnssInstallation)

SbgErrorCode	sbgEComCmdGnss1InstallationSet (SbgEComHandle pHandle, const SbgEComGnssInstallation pGnssInstallation)

SbgErrorCode	sbgEComCmdGnss1SetModelId (SbgEComHandle *pHandle, uint32_t id)

SbgErrorCode	sbgEComCmdGnss1SetRejection (SbgEComHandle pHandle, const SbgEComGnssRejectionConf pRejectConf)

Detailed Description

This file implements SbgECom commands related to GNSS module.

Author: SBG Systems (Maxime Renaudet)

Date: 11 June 2014

Copyright Notice

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 sbgEComCmdGnss.h.

Typedef Documentation

◆ SbgEComGnssAlignmentInfo

typedef struct _SbgEComGnssAlignmentInfo SbgEComGnssAlignmentInfo

DEPRECATED: Command SBG_ECOM_CMD_GNSS_1_LEVER_ARM_ALIGNMENT has been replaced by SBG_ECOM_CMD_GNSS_1_INSTALLATION Holds all necessary information for GNSS module alignment.

◆ SbgEComGnssInstallation

typedef struct _SbgEComGnssInstallation SbgEComGnssInstallation

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

◆ SbgEComGnssInstallationMode

typedef enum _SbgEComGnssInstallationMode SbgEComGnssInstallationMode

GNSS mechanical installation modes for the dual antenna mode.

◆ SbgEComGnssModelsStdIds

typedef enum _SbgEComGnssModelsStdIds SbgEComGnssModelsStdIds

This enum defines the different GNSS model IDs available in standard

◆ SbgEComGnssRejectionConf

typedef struct _SbgEComGnssRejectionConf SbgEComGnssRejectionConf

Holds all necessary information for GNSS module data rejection.

Enumeration Type Documentation

◆ _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.

Definition at line 68 of file sbgEComCmdGnss.h.

◆ _SbgEComGnssModelsStdIds

enum _SbgEComGnssModelsStdIds

This enum defines the different GNSS model IDs available in standard

Enumerator
SBG_ECOM_GNSS_MODEL_UBLOX_GPS_GLONASS	Used on Ellipse-N to setup the internal GNSS in GPS+GLONASS
SBG_ECOM_GNSS_MODEL_NMEA	Used on ELLIPSE-E to accept an external GNSS using NMEA protocol
SBG_ECOM_GNSS_MODEL_UBLOX_GPS_BEIDOU	Used on ELLIPSE-N to setup the internal GNSS in GPS+BEIDOU
SBG_ECOM_GNSS_MODEL_UBLOX_EXTERNAL	Used on ELLIPSE-E to accept an external Ublox GNSS (read only)
SBG_ECOM_GNSS_MODEL_UBLOX_HIGH_DYNAMICS	Used on ELLIPSE-N to setup the internal GNSS to high dynamic motion constraints.
SBG_ECOM_GNSS_MODEL_NOVATEL_EXTERNAL	Used on ELLIPSE-E to accept an external Novatel GNSS (read only)
SBG_ECOM_GNSS_MODEL_ELLIPSE_D_INTERNAL	Used on ELLIPSE-D to setup the internal GNSS receiver.
SBG_ECOM_GNSS_MODEL_UBLOX_HIGH_SPEED	Used on ELLIPSE-N to setup the internal GNSS for high speed applications (airborne > 200 km/h)
SBG_ECOM_GNSS_MODEL_SEPTENTRIO_EXTERNAL	Used on ELLIPSE-E to accept an external Septentrio GNSS (read only)
SBG_ECOM_GNSS_MODEL_UBLOX_LOW_SPEED	Used on ELLIPSE-N to setup the internal GNSS receiver for pedestrian applications.

Definition at line 51 of file sbgEComCmdGnss.h.

Function Documentation

◆ SBG_DEPRECATED() [1/2]

SBG_DEPRECATED ( SbgErrorCode sbgEComCmdGnss1GetLeverArmAlignmentSbgEComHandle *pHandle, SbgEComGnssAlignmentInfo *pAlignConf )

Retrieve the lever arm and alignment configuration of the gnss 1 module.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pAlignConf	Pointer to a SbgEComGnssAlignmentInfo struct to hold alignment configuration of the gnss module.

Returns: SBG_NO_ERROR if the command has been executed successfully.

◆ SBG_DEPRECATED() [2/2]

SBG_DEPRECATED ( SbgErrorCode sbgEComCmdGnss1SetLeverArmAlignmentSbgEComHandle *pHandle, const SbgEComGnssAlignmentInfo *pAlignConf )

Set the lever arm and alignment configuration of the gnss 1 module.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	pAlignConf	Pointer to a SbgEComGnssAlignmentInfo struct holding alignment configuration for the gnss module.

Returns: SBG_NO_ERROR if the command has been executed successfully.

◆ sbgEComCmdGnss1GetModelInfo()

SbgErrorCode sbgEComCmdGnss1GetModelInfo	(	SbgEComHandle *	pHandle,
		SbgEComModelInfo *	pModelInfo
	)

Retrieve GNSS error model information.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pMotionProfileInfo	Pointer to a SbgEComModelInfo to contain the current GNSS error model info.

Returns: SBG_NO_ERROR if the command has been executed successfully.

Definition at line 371 of file sbgEComCmdGnss.c.

◆ sbgEComCmdGnss1GetRejection()

SbgErrorCode sbgEComCmdGnss1GetRejection	(	SbgEComHandle *	pHandle,
		SbgEComGnssRejectionConf *	pRejectConf
	)

Retrieve the rejection configuration of the gnss module.

Parameters

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

Returns: SBG_NO_ERROR if the command has been executed successfully.

Definition at line 532 of file sbgEComCmdGnss.c.

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

Definition at line 516 of file sbgEComCmdGnss.c.

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

Definition at line 524 of file sbgEComCmdGnss.c.

◆ sbgEComCmdGnss1SetModelId()

SbgErrorCode sbgEComCmdGnss1SetModelId	(	SbgEComHandle *	pHandle,
		uint32_t	id
	)

Set GNSS error model id.

Parameters

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

Returns: SBG_NO_ERROR if the command has been executed successfully.

Definition at line 364 of file sbgEComCmdGnss.c.

◆ sbgEComCmdGnss1SetRejection()

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

Set the rejection configuration of the gnss module.

Parameters

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

Returns: SBG_NO_ERROR if the command has been executed successfully.

Definition at line 540 of file sbgEComCmdGnss.c.

Classes

Typedefs

Enumerations

Functions

Detailed Description

Copyright Notice

Typedef Documentation

◆ SbgEComGnssAlignmentInfo

◆ SbgEComGnssInstallation

◆ SbgEComGnssInstallationMode

◆ SbgEComGnssModelsStdIds

◆ SbgEComGnssRejectionConf

Enumeration Type Documentation

◆ _SbgEComGnssInstallationMode

◆ _SbgEComGnssModelsStdIds

Function Documentation

◆ SBG_DEPRECATED() [1/2]

◆ SBG_DEPRECATED() [2/2]

◆ sbgEComCmdGnss1GetModelInfo()

◆ sbgEComCmdGnss1GetRejection()

◆ sbgEComCmdGnss1InstallationGet()

◆ sbgEComCmdGnss1InstallationSet()

◆ sbgEComCmdGnss1SetModelId()

◆ sbgEComCmdGnss1SetRejection()