This file implements SbgECom commands related to sensor. More...

#include "sbgEComCmdCommon.h"

Include dependency graph for sbgEComCmdSensor.h:

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

Classes
struct	_SbgEComAidingAssignConf

struct	_SbgEComInitConditionConf

struct	_SbgEComSensorAlignmentInfo

Typedefs
typedef struct _SbgEComAidingAssignConf	SbgEComAidingAssignConf

typedef struct _SbgEComInitConditionConf	SbgEComInitConditionConf

typedef enum _SbgEComModulePortAssignment	SbgEComModulePortAssignment

typedef enum _SbgEComModuleSyncAssignment	SbgEComModuleSyncAssignment

typedef enum _SbgEComMotionProfileStdIds	SbgEComMotionProfileStdIds

typedef enum _SbgEComOdometerPinAssignment	SbgEComOdometerPinAssignment

typedef struct _SbgEComSensorAlignmentInfo	SbgEComSensorAlignmentInfo

Enumerations
enum	_SbgEComModulePortAssignment { SBG_ECOM_MODULE_PORT_B = 1, SBG_ECOM_MODULE_PORT_C = 2, SBG_ECOM_MODULE_PORT_D = 3, SBG_ECOM_MODULE_PORT_E = 4, SBG_ECOM_MODULE_INTERNAL = 5, SBG_ECOM_MODULE_DISABLED = 0xFF }

enum	_SbgEComModuleSyncAssignment { SBG_ECOM_MODULE_SYNC_DISABLED = 0, SBG_ECOM_MODULE_SYNC_IN_A = 1, SBG_ECOM_MODULE_SYNC_IN_B = 2, SBG_ECOM_MODULE_SYNC_IN_C = 3, SBG_ECOM_MODULE_SYNC_IN_D = 4, SBG_ECOM_MODULE_SYNC_INTERNAL = 5, SBG_ECOM_MODULE_SYNC_OUT_A = 6, SBG_ECOM_MODULE_SYNC_OUT_B = 7 }

enum	_SbgEComMotionProfileStdIds { SBG_ECOM_MOTION_PROFILE_GENERAL_PURPOSE = 1, SBG_ECOM_MOTION_PROFILE_AUTOMOTIVE = 2, SBG_ECOM_MOTION_PROFILE_MARINE = 3, SBG_ECOM_MOTION_PROFILE_AIRPLANE = 4, SBG_ECOM_MOTION_PROFILE_HELICOPTER = 5, SBG_ECOM_MOTION_PROFILE_UAV_ROTARY_WING = 7, SBG_ECOM_MOTION_PROFILE_HEAVY_MACHINERY = 8 }

enum	_SbgEComOdometerPinAssignment { SBG_ECOM_MODULE_ODO_DISABLED = 0, SBG_ECOM_MODULE_ODO_A = 1, SBG_ECOM_MODULE_ODO_A_B = 2, SBG_ECOM_MODULE_ODO_CAN = 3 }

Functions
SbgErrorCode	sbgEComCmdSensorGetAidingAssignment (SbgEComHandle pHandle, SbgEComAidingAssignConf pConf)

SbgErrorCode	sbgEComCmdSensorGetAlignmentAndLeverArm (SbgEComHandle pHandle, SbgEComSensorAlignmentInfo pAlignConf, float leverArm[3])

SbgErrorCode	sbgEComCmdSensorGetInitCondition (SbgEComHandle pHandle, SbgEComInitConditionConf pConf)

SbgErrorCode	sbgEComCmdSensorGetMotionProfileInfo (SbgEComHandle pHandle, SbgEComModelInfo pMotionProfileInfo)

SbgErrorCode	sbgEComCmdSensorSetAidingAssignment (SbgEComHandle pHandle, const SbgEComAidingAssignConf pConf)

SbgErrorCode	sbgEComCmdSensorSetAlignmentAndLeverArm (SbgEComHandle pHandle, const SbgEComSensorAlignmentInfo pAlignConf, const float leverArm[3])

SbgErrorCode	sbgEComCmdSensorSetInitCondition (SbgEComHandle pHandle, const SbgEComInitConditionConf pConf)

SbgErrorCode	sbgEComCmdSensorSetMotionProfileId (SbgEComHandle *pHandle, uint32_t id)

Detailed Description

This file implements SbgECom commands related to sensor.

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

Typedef Documentation

◆ SbgEComAidingAssignConf

typedef struct _SbgEComAidingAssignConf SbgEComAidingAssignConf

Helper structure for module assignments

◆ SbgEComInitConditionConf

typedef struct _SbgEComInitConditionConf SbgEComInitConditionConf

Helper structure for sensor Initial condition details

◆ SbgEComModulePortAssignment

typedef enum _SbgEComModulePortAssignment SbgEComModulePortAssignment

Ports available for the modules.

◆ SbgEComModuleSyncAssignment

typedef enum _SbgEComModuleSyncAssignment SbgEComModuleSyncAssignment

Synchronization signals available for the modules.

◆ SbgEComMotionProfileStdIds

typedef enum _SbgEComMotionProfileStdIds SbgEComMotionProfileStdIds

This enum defines the different motion profile IDs available in standard

◆ SbgEComOdometerPinAssignment

typedef enum _SbgEComOdometerPinAssignment SbgEComOdometerPinAssignment

List of configurations available for the odometer.

◆ SbgEComSensorAlignmentInfo

typedef struct _SbgEComSensorAlignmentInfo SbgEComSensorAlignmentInfo

Helper structure for sensor alignment details

Enumeration Type Documentation

◆ _SbgEComModulePortAssignment

enum _SbgEComModulePortAssignment

Ports available for the modules.

Enumerator
SBG_ECOM_MODULE_PORT_B	Module connected on PORT_B.
SBG_ECOM_MODULE_PORT_C	Module connected on PORT_C.
SBG_ECOM_MODULE_PORT_D	Module connected on PORT_D.
SBG_ECOM_MODULE_PORT_E	Module connected on PORT_E.
SBG_ECOM_MODULE_INTERNAL	Module is connected internally.
SBG_ECOM_MODULE_DISABLED	Module is disabled.

Definition at line 32 of file sbgEComCmdSensor.h.

◆ _SbgEComModuleSyncAssignment

enum _SbgEComModuleSyncAssignment

Synchronization signals available for the modules.

Enumerator
SBG_ECOM_MODULE_SYNC_DISABLED	Module is disabled.
SBG_ECOM_MODULE_SYNC_IN_A	Synchronization is done using SYNC_IN_A pin.
SBG_ECOM_MODULE_SYNC_IN_B	Synchronization is done using SYNC_IN_B pin.
SBG_ECOM_MODULE_SYNC_IN_C	Synchronization is done using SYNC_IN_C pin.
SBG_ECOM_MODULE_SYNC_IN_D	Synchronization is done using SYNC_IN_D pin.
SBG_ECOM_MODULE_SYNC_INTERNAL	Synchronization is internal.
SBG_ECOM_MODULE_SYNC_OUT_A	Synchronization signal is output on SYNC_OUT_A.
SBG_ECOM_MODULE_SYNC_OUT_B	Synchronization signal is output on SYNC_OUT_B.

Definition at line 45 of file sbgEComCmdSensor.h.

◆ _SbgEComMotionProfileStdIds

enum _SbgEComMotionProfileStdIds

This enum defines the different motion profile IDs available in standard

Enumerator
SBG_ECOM_MOTION_PROFILE_GENERAL_PURPOSE	Should be used as a default when other profiles do not apply
SBG_ECOM_MOTION_PROFILE_AUTOMOTIVE	Dedicated to car applications
SBG_ECOM_MOTION_PROFILE_MARINE	Used in marine and underwater applications
SBG_ECOM_MOTION_PROFILE_AIRPLANE	For fixed wings aircraft
SBG_ECOM_MOTION_PROFILE_HELICOPTER	For rotary wing aircraft
SBG_ECOM_MOTION_PROFILE_UAV_ROTARY_WING	For rotary wing UAVs that have low dynamics
SBG_ECOM_MOTION_PROFILE_HEAVY_MACHINERY	For vibrating applications with low dynamics and no specific travel direction

Definition at line 71 of file sbgEComCmdSensor.h.

◆ _SbgEComOdometerPinAssignment

enum _SbgEComOdometerPinAssignment

List of configurations available for the odometer.

Enumerator
SBG_ECOM_MODULE_ODO_DISABLED	Odometer is disabled.
SBG_ECOM_MODULE_ODO_A	Odometer connected only to ODO_A (unidirectional)..
SBG_ECOM_MODULE_ODO_A_B	Odometer connected to both ODO_A (signal A) and ODO_B (Signal B or direction) for bidirectional odometer..
SBG_ECOM_MODULE_ODO_CAN	Vehicle odometer using CAN (OBD-II).

Definition at line 60 of file sbgEComCmdSensor.h.

Function Documentation

◆ sbgEComCmdSensorGetAidingAssignment()

SbgErrorCode sbgEComCmdSensorGetAidingAssignment	(	SbgEComHandle *	pHandle,
		SbgEComAidingAssignConf *	pConf
	)

Retrieve the assignment of the aiding sensors.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pConf	Pointer to a SbgEComAidingAssignConf to contain the current assignment of the aiding sensors.

Returns: SBG_NO_ERROR if the command has been executed successfully.

< Reserved fields to ignore

Definition at line 193 of file sbgEComCmdSensor.c.

◆ sbgEComCmdSensorGetAlignmentAndLeverArm()

SbgErrorCode sbgEComCmdSensorGetAlignmentAndLeverArm	(	SbgEComHandle *	pHandle,
		SbgEComSensorAlignmentInfo *	pAlignConf,
		float	leverArm[3]
	)

Retrieve the alignment and lever arm configuration of the sensor.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pAlignConf	Pointer to a SbgEComSensorAlignmentInfo struct to hold alignment configuration of the sensor.
[out]	leverArm	Pointer to a table to contain lever arm X, Y, Z components in meters.

Returns: SBG_NO_ERROR if the command has been executed successfully.

Definition at line 358 of file sbgEComCmdSensor.c.

◆ sbgEComCmdSensorGetInitCondition()

SbgErrorCode sbgEComCmdSensorGetInitCondition	(	SbgEComHandle *	pHandle,
		SbgEComInitConditionConf *	pConf
	)

Retrieve the initial conditions settings.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pConf	Pointer to a SbgEComInitConditionConf to contain the current initial conditions settings.

Returns: SBG_NO_ERROR if the command has been executed successfully.

Definition at line 44 of file sbgEComCmdSensor.c.

◆ sbgEComCmdSensorGetMotionProfileInfo()

SbgErrorCode sbgEComCmdSensorGetMotionProfileInfo	(	SbgEComHandle *	pHandle,
		SbgEComModelInfo *	pModelInfo
	)

Retrieve Motion profile information.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pMotionProfileInfo	Pointer to a SbgEComModelInfo to contain the current motion profile info.

Returns: SBG_NO_ERROR if the command has been executed successfully.

Definition at line 30 of file sbgEComCmdSensor.c.

◆ sbgEComCmdSensorSetAidingAssignment()

SbgErrorCode sbgEComCmdSensorSetAidingAssignment	(	SbgEComHandle *	pHandle,
		const SbgEComAidingAssignConf *	pConf
	)

Set the assignment of the aiding sensors.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pConf	Pointer to a SbgEComAidingAssignConf containing the new assignment of the aiding sensors.

Returns: SBG_NO_ERROR if the command has been executed successfully.

Definition at line 273 of file sbgEComCmdSensor.c.

◆ sbgEComCmdSensorSetAlignmentAndLeverArm()

SbgErrorCode sbgEComCmdSensorSetAlignmentAndLeverArm	(	SbgEComHandle *	pHandle,
		const SbgEComSensorAlignmentInfo *	pAlignConf,
		const float	leverArm[3]
	)

Set the alignment and lever arm configuration of the sensor.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	pAlignConf	Pointer to a SbgEComSensorAlignmentInfo struct holding alignment configuration for the sensor.
[in]	leverArm	Pointer to a table containing lever arm X, Y, Z components in meters.

Returns: SBG_NO_ERROR if the command has been executed successfully.

Definition at line 437 of file sbgEComCmdSensor.c.

◆ sbgEComCmdSensorSetInitCondition()

SbgErrorCode sbgEComCmdSensorSetInitCondition	(	SbgEComHandle *	pHandle,
		const SbgEComInitConditionConf *	pConf
	)

Set the initial condition configuration.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	pConf	Pointer to a SbgEComInitConditionConf containing the new initial condition configuration.

Returns: SBG_NO_ERROR if the command has been executed successfully.

Definition at line 119 of file sbgEComCmdSensor.c.

◆ sbgEComCmdSensorSetMotionProfileId()

SbgErrorCode sbgEComCmdSensorSetMotionProfileId	(	SbgEComHandle *	pHandle,
		uint32_t	id
	)

Set a Motion profile ID.

Parameters

[in]	pHandle	A valid sbgECom handle.

Definition at line 15 of file sbgEComCmdSensor.c.

Classes

Typedefs

Enumerations

Functions

Detailed Description

Copyright Notice

Typedef Documentation

◆ SbgEComAidingAssignConf

◆ SbgEComInitConditionConf

◆ SbgEComModulePortAssignment

◆ SbgEComModuleSyncAssignment

◆ SbgEComMotionProfileStdIds

◆ SbgEComOdometerPinAssignment

◆ SbgEComSensorAlignmentInfo

Enumeration Type Documentation

◆ _SbgEComModulePortAssignment

◆ _SbgEComModuleSyncAssignment

◆ _SbgEComMotionProfileStdIds

◆ _SbgEComOdometerPinAssignment

Function Documentation

◆ sbgEComCmdSensorGetAidingAssignment()

◆ sbgEComCmdSensorGetAlignmentAndLeverArm()

◆ sbgEComCmdSensorGetInitCondition()

◆ sbgEComCmdSensorGetMotionProfileInfo()

◆ sbgEComCmdSensorSetAidingAssignment()

◆ sbgEComCmdSensorSetAlignmentAndLeverArm()

◆ sbgEComCmdSensorSetInitCondition()

◆ sbgEComCmdSensorSetMotionProfileId()