sbgECom  1.11.920-stable
Data Structures | Typedefs | Enumerations | Functions
sbgEComCmdAirData.h File Reference

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

#include <sbgCommon.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

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.

Typedef Documentation

§ SbgEComAirDataModelsIds

This enum defines the different AirData model IDs available in standard

§ SbgEComAirDataRejectionConf

Holds all necessary information for AirData module data rejection.

Enumeration Type Documentation

§ _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]pHandleA valid sbgECom handle.
[in]modelIdAirData 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]pHandleA valid sbgECom handle.
[out]pModelIdReturns 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]pHandleA valid sbgECom handle.
[in]pLeverArmThe 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]pHandleA valid sbgECom handle.
[out]pLeverArmReturns 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]pHandleA valid sbgECom handle.
[out]pRejectConfThe 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]pHandleA valid sbgECom handle.
[out]pRejectConfReturn the rejection configuration currently in use.
Returns
SBG_NO_ERROR if the command has been executed successfully.