sbgEComCmdAirData.h File Reference

This file implements sbgECom commands related to AirData module. More...

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

Include dependency graph for sbgEComCmdAirData.h:

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

Go to the source code of this file.

Classes
struct	_SbgEComAirDataRejectionConf

Typedefs
typedef enum _SbgEComAirDataModelsIds	SbgEComAirDataModelsIds
typedef struct _SbgEComAirDataRejectionConf	SbgEComAirDataRejectionConf

Enumerations
enum	_SbgEComAirDataModelsIds { SBG_ECOM_AIR_DATA_MODEL_INTERNAL = 1, SBG_ECOM_AIR_DATA_MODEL_GENERIC_ECOM = 2, SBG_ECOM_AIR_DATA_MODEL_AHRS_500 = 3 }

Functions
SbgErrorCode	sbgEComCmdAirDataGetLeverArm (SbgEComHandle *pHandle, float *pLeverArm)
SbgErrorCode	sbgEComCmdAirDataGetModelId (SbgEComHandle *pHandle, SbgEComAirDataModelsIds *pModelId)
SbgErrorCode	sbgEComCmdAirDataGetRejection (SbgEComHandle *pHandle, SbgEComAirDataRejectionConf *pRejectConf)
SbgErrorCode	sbgEComCmdAirDataSetLeverArm (SbgEComHandle *pHandle, const float *pLeverArm)
SbgErrorCode	sbgEComCmdAirDataSetModelId (SbgEComHandle *pHandle, SbgEComAirDataModelsIds modelId)
SbgErrorCode	sbgEComCmdAirDataSetRejection (SbgEComHandle *pHandle, const SbgEComAirDataRejectionConf *pRejectConf)

Detailed Description

This file implements sbgECom commands related to AirData module.

Author

SBG Systems

Date

18 February 2019

Copyright Notice

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

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

Typedef Documentation

SbgEComAirDataModelsIds

typedef enum _SbgEComAirDataModelsIds SbgEComAirDataModelsIds

This enum defines the different AirData model IDs available in standard

SbgEComAirDataRejectionConf

typedef struct _SbgEComAirDataRejectionConf SbgEComAirDataRejectionConf

Holds all necessary information for AirData module data rejection.

Enumeration Type Documentation

_SbgEComAirDataModelsIds

enum _SbgEComAirDataModelsIds

This enum defines the different AirData model IDs available in standard

Enumerator
SBG_ECOM_AIR_DATA_MODEL_INTERNAL	Use the internal barometer sensor if available.
SBG_ECOM_AIR_DATA_MODEL_GENERIC_ECOM	Generic AirData model using sbgECom input protocol format.
SBG_ECOM_AIR_DATA_MODEL_AHRS_500	Crossbow AHRS-500 compatible input for barometric altitude and airspeed.

Definition at line 36 of file sbgEComCmdAirData.h.

Function Documentation

sbgEComCmdAirDataGetLeverArm()

SbgErrorCode sbgEComCmdAirDataGetLeverArm	(	SbgEComHandle *	pHandle,
		float *	pLeverArm
	)

Retrieve the lever arm configuration of the AirData module.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pLeverArm	Returns the airspeed sensor X,Y,Z lever arm in meters from the pitot sensor to the IMU.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 112 of file sbgEComCmdAirData.c.

sbgEComCmdAirDataGetModelId()

SbgErrorCode sbgEComCmdAirDataGetModelId	(	SbgEComHandle *	pHandle,
		SbgEComAirDataModelsIds *	pModelId
	)

Retrieve the AirData model id currently in use by the device.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pModelId	Returns the AirData model ID currently in use by the device.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 21 of file sbgEComCmdAirData.c.

sbgEComCmdAirDataGetRejection()

SbgErrorCode sbgEComCmdAirDataGetRejection	(	SbgEComHandle *	pHandle,
		SbgEComAirDataRejectionConf *	pRejectConf
	)

Retrieve the current rejection configuration of the AirData module.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pRejectConf	Return the rejection configuration currently in use.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 248 of file sbgEComCmdAirData.c.

sbgEComCmdAirDataSetLeverArm()

SbgErrorCode sbgEComCmdAirDataSetLeverArm	(	SbgEComHandle *	pHandle,
		const float *	pLeverArm
	)

Set the lever arm configuration of the AirData module.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	pLeverArm	The X, Y, Z airspeed sensor lever arm in meters from the pitot sensor to the IMU.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 39 of file sbgEComCmdAirData.c.

sbgEComCmdAirDataSetModelId()

SbgErrorCode sbgEComCmdAirDataSetModelId	(	SbgEComHandle *	pHandle,
		SbgEComAirDataModelsIds	modelId
	)

Set the AirData model to use that both defines the protocol as well as the associated error model.

Parameters

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

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 14 of file sbgEComCmdAirData.c.

sbgEComCmdAirDataSetRejection()

SbgErrorCode sbgEComCmdAirDataSetRejection	(	SbgEComHandle *	pHandle,
		const SbgEComAirDataRejectionConf *	pRejectConf
	)

Set the rejection configuration of the AirData module (this command doesn't need a reboot to be applied)

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pRejectConf	The new rejection configuration to set.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 176 of file sbgEComCmdAirData.c.