sbgEComCmdAirData.h File Reference

AirData 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	_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	sbgEComCmdAirDataSetModelId (SbgEComHandle *pHandle, SbgEComAirDataModelsIds modelId)
SbgErrorCode	sbgEComCmdAirDataGetModelId (SbgEComHandle *pHandle, SbgEComAirDataModelsIds *pModelId)
SbgErrorCode	sbgEComCmdAirDataSetLeverArm (SbgEComHandle *pHandle, const float *pLeverArm)
SbgErrorCode	sbgEComCmdAirDataGetLeverArm (SbgEComHandle *pHandle, float *pLeverArm)
SbgErrorCode	sbgEComCmdAirDataSetRejection (SbgEComHandle *pHandle, const SbgEComAirDataRejectionConf *pRejectConf)
SbgErrorCode	sbgEComCmdAirDataGetRejection (SbgEComHandle *pHandle, SbgEComAirDataRejectionConf *pRejectConf)

Detailed Description

AirData aiding module configuration commands.

Author

SBG Systems

Date

18 February 2019

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

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.

Function Documentation

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.

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.

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.

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.

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.

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.