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

#include "sbgEComCmdCommon.h"
#include "../sbgECanId.h"

Include dependency graph for sbgEComCmdOutput.h:

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

Classes
struct	_SbgEComLegacyConf

Typedefs
typedef struct _SbgEComLegacyConf	SbgEComLegacyConf

typedef enum _SbgEComLegacyEndian	SbgEComLegacyEndian

typedef enum _SbgEComLegacyFormat	SbgEComLegacyFormat

typedef enum _SbgEComOutputMode	SbgEComOutputMode

typedef enum _SbgEComOutputMonitoringPoint	SbgEComOutputMonitoringPoint

typedef enum _SbgEComOutputPort	SbgEComOutputPort

Enumerations
enum	_SbgEComLegacyEndian { SBG_ECOM_LEGACY_LITTLE_ENDIAN = 0, SBG_ECOM_LEGACY_BIG_ENDIAN }

enum	_SbgEComLegacyFormat { SBG_ECOM_LEGACY_FORMAT_FLOAT = 0, SBG_ECOM_LEGACY_FORMAT_FIXED }

enum	_SbgEComOutputMode { SBG_ECOM_OUTPUT_MODE_DISABLED = 0, SBG_ECOM_OUTPUT_MODE_MAIN_LOOP = 1, SBG_ECOM_OUTPUT_MODE_DIV_2 = 2, SBG_ECOM_OUTPUT_MODE_DIV_4 = 4, SBG_ECOM_OUTPUT_MODE_DIV_5 = 5, SBG_ECOM_OUTPUT_MODE_DIV_8 = 8, SBG_ECOM_OUTPUT_MODE_DIV_10 = 10, SBG_ECOM_OUTPUT_MODE_DIV_20 = 20, SBG_ECOM_OUTPUT_MODE_DIV_40 = 40, SBG_ECOM_OUTPUT_MODE_DIV_200 = 200, SBG_ECOM_OUTPUT_MODE_PPS = 10000, SBG_ECOM_OUTPUT_MODE_NEW_DATA = 10001, SBG_ECOM_OUTPUT_MODE_EVENT_IN_A = 10003, SBG_ECOM_OUTPUT_MODE_EVENT_IN_B = 10004, SBG_ECOM_OUTPUT_MODE_EVENT_IN_C = 10005, SBG_ECOM_OUTPUT_MODE_EVENT_IN_D = 10006, SBG_ECOM_OUTPUT_MODE_EVENT_IN_E = 10007, SBG_ECOM_OUTPUT_MODE_HIGH_FREQ_LOOP = 20001 }

enum	_SbgEComOutputMonitoringPoint { SBG_ECOM_OUTPUT_MONITORING_POINT_IMU = 0, SBG_ECOM_OUTPUT_MONITORING_POINT_COG = 1, SBG_ECOM_OUTPUT_MONITORING_POINT_1 = 2, SBG_ECOM_OUTPUT_MONITORING_POINT_2 = 3, SBG_ECOM_OUTPUT_MONITORING_POINT_3 = 4, SBG_ECOM_OUTPUT_MONITORING_NUM }

enum	_SbgEComOutputPort { SBG_ECOM_OUTPUT_PORT_A = 0, SBG_ECOM_OUTPUT_PORT_C = 2, SBG_ECOM_OUTPUT_PORT_E = 4 }

Functions
SbgErrorCode	sbgEComCmdCanOutputGetConf (SbgEComHandle pHandle, SbgECanMessageId internalId, SbgEComOutputMode pMode, uint32_t pUserId, bool pExtended)

SbgErrorCode	sbgEComCmdCanOutputSetConf (SbgEComHandle *pHandle, SbgECanMessageId internalId, SbgEComOutputMode mode, uint32_t userId, bool extended)

SbgErrorCode	sbgEComCmdOutputClassGetEnable (SbgEComHandle pHandle, SbgEComOutputPort outputPort, SbgEComClass classId, bool pEnable)

SbgErrorCode	sbgEComCmdOutputClassSetEnable (SbgEComHandle *pHandle, SbgEComOutputPort outputPort, SbgEComClass classId, bool enable)

SbgErrorCode	sbgEComCmdOutputGetConf (SbgEComHandle pHandle, SbgEComOutputPort outputPort, SbgEComClass classId, SbgEComMsgId msgId, SbgEComOutputMode pMode)

SbgErrorCode	sbgEComCmdOutputGetLegacyConf (SbgEComHandle pHandle, SbgEComOutputPort outputPort, SbgEComLegacyConf pConf)

SbgErrorCode	sbgEComCmdOutputGetNmeaTalkerId (SbgEComHandle *pHandle, SbgEComOutputPort outputPort, char nmeaTalkerId[2])

SbgErrorCode	sbgEComCmdOutputSetConf (SbgEComHandle *pHandle, SbgEComOutputPort outputPort, SbgEComClass classId, SbgEComMsgId msgId, SbgEComOutputMode mode)

SbgErrorCode	sbgEComCmdOutputSetLegacyConf (SbgEComHandle pHandle, SbgEComOutputPort outputPort, const SbgEComLegacyConf pConf)

SbgErrorCode	sbgEComCmdOutputSetNmeaTalkerId (SbgEComHandle *pHandle, SbgEComOutputPort outputPort, const char nmeaTalkerId[2])

Detailed Description

This file implements SbgECom commands related to outputs.

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

Typedef Documentation

◆ SbgEComLegacyConf

typedef struct _SbgEComLegacyConf SbgEComLegacyConf

Helper structure to configure legacy output.

◆ SbgEComLegacyEndian

typedef enum _SbgEComLegacyEndian SbgEComLegacyEndian

List of available legacy output endiannesses.

◆ SbgEComLegacyFormat

typedef enum _SbgEComLegacyFormat SbgEComLegacyFormat

List of available legacy output format.

◆ SbgEComOutputMode

typedef enum _SbgEComOutputMode SbgEComOutputMode

List of output modes available.

◆ SbgEComOutputMonitoringPoint

typedef enum _SbgEComOutputMonitoringPoint SbgEComOutputMonitoringPoint

Defines which monitoring point to use for an output port. This feature enabled deporting measurements at a specific monitoring point.

◆ SbgEComOutputPort

typedef enum _SbgEComOutputPort SbgEComOutputPort

List of ouput ports available.

Enumeration Type Documentation

◆ _SbgEComLegacyEndian

enum _SbgEComLegacyEndian

List of available legacy output endiannesses.

Enumerator
SBG_ECOM_LEGACY_LITTLE_ENDIAN	Data is output in little endian format.
SBG_ECOM_LEGACY_BIG_ENDIAN	Data is output in big endian format.

Definition at line 52 of file sbgEComCmdOutput.h.

◆ _SbgEComLegacyFormat

enum _SbgEComLegacyFormat

List of available legacy output format.

Enumerator
SBG_ECOM_LEGACY_FORMAT_FLOAT	Data is output in floating point.
SBG_ECOM_LEGACY_FORMAT_FIXED	Data is output in fixed point.

Definition at line 43 of file sbgEComCmdOutput.h.

◆ _SbgEComOutputMode

enum _SbgEComOutputMode

List of output modes available.

Enumerator
SBG_ECOM_OUTPUT_MODE_DISABLED	This output is disabled.
SBG_ECOM_OUTPUT_MODE_MAIN_LOOP	Output the message every main loop (ie 200 Hz).
SBG_ECOM_OUTPUT_MODE_DIV_2	Output the message every 2 main loops (ie 100 Hz).
SBG_ECOM_OUTPUT_MODE_DIV_4	Output the message every 4 main loops (ie 50 Hz).
SBG_ECOM_OUTPUT_MODE_DIV_5	Output the message every 4 main loops (ie 40 Hz).
SBG_ECOM_OUTPUT_MODE_DIV_8	Output the message every 8 main loops (ie 25 Hz).
SBG_ECOM_OUTPUT_MODE_DIV_10	Output the message every 10 main loops (ie 20 Hz).
SBG_ECOM_OUTPUT_MODE_DIV_20	Output the message every 20 main loops (ie 10 Hz).
SBG_ECOM_OUTPUT_MODE_DIV_40	Output the message every 40 main loops (ie 5 Hz).
SBG_ECOM_OUTPUT_MODE_DIV_200	Output the message every 200 main loops (ie 1 Hz).
SBG_ECOM_OUTPUT_MODE_PPS	Output the message on a Pulse Per Second event.
SBG_ECOM_OUTPUT_MODE_NEW_DATA	Output sent when a new data is available.
SBG_ECOM_OUTPUT_MODE_EVENT_IN_A	Output the message when a Sync A is received.
SBG_ECOM_OUTPUT_MODE_EVENT_IN_B	Output the message when a Sync B is received.
SBG_ECOM_OUTPUT_MODE_EVENT_IN_C	Output the message when a Sync C is received.
SBG_ECOM_OUTPUT_MODE_EVENT_IN_D	Output the message when a Sync D is received.
SBG_ECOM_OUTPUT_MODE_EVENT_IN_E	Output the message when a Sync E is received.
SBG_ECOM_OUTPUT_MODE_HIGH_FREQ_LOOP	Output the message in the 1KHz IMU loop

Definition at line 61 of file sbgEComCmdOutput.h.

◆ _SbgEComOutputMonitoringPoint

enum _SbgEComOutputMonitoringPoint

Defines which monitoring point to use for an output port. This feature enabled deporting measurements at a specific monitoring point.

Enumerator
SBG_ECOM_OUTPUT_MONITORING_POINT_IMU	Output measurements at the IMU location.
SBG_ECOM_OUTPUT_MONITORING_POINT_COG	Output measurements at the center of rotation.
SBG_ECOM_OUTPUT_MONITORING_POINT_1	Output measurements at the user deported location 1 (only for Ekinox and Apogee).
SBG_ECOM_OUTPUT_MONITORING_POINT_2	Output measurements at the user deported location 2 (only for Ekinox and Apogee).
SBG_ECOM_OUTPUT_MONITORING_POINT_3	Output measurements at the user deported location 3 (only for Ekinox and Apogee).
SBG_ECOM_OUTPUT_MONITORING_NUM	Number of output monitoring points.

Definition at line 87 of file sbgEComCmdOutput.h.

◆ _SbgEComOutputPort

enum _SbgEComOutputPort

List of ouput ports available.

Enumerator
SBG_ECOM_OUTPUT_PORT_A	Main output port.
SBG_ECOM_OUTPUT_PORT_C	Secondary output port only available on Ellipse-E devices
SBG_ECOM_OUTPUT_PORT_E	Secondary output port only available on B1 devices

Definition at line 33 of file sbgEComCmdOutput.h.

Function Documentation

◆ sbgEComCmdCanOutputGetConf()

SbgErrorCode sbgEComCmdCanOutputGetConf	(	SbgEComHandle *	pHandle,
		SbgECanMessageId	internalId,
		SbgEComOutputMode *	pMode,
		uint32_t *	pUserId,
		bool *	pExtended
	)

Retrieve the configuration of one the message on the CAN interface.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	internalId	The internal message id.
[out]	pMode	Pointer to a SbgEComOutputMode to contain the current output mode of the message.
[out]	pUserId	The user defined message id.
[out]	pExtended	TRUE if the user id uses the extended format.

Returns: SBG_NO_ERROR if the command has been executed successfully.

Definition at line 386 of file sbgEComCmdOutput.c.

◆ sbgEComCmdCanOutputSetConf()

SbgErrorCode sbgEComCmdCanOutputSetConf	(	SbgEComHandle *	pHandle,
		SbgECanMessageId	internalId,
		SbgEComOutputMode	mode,
		uint32_t	userId,
		bool	extended
	)

Set the configuration of one the message on the CAN interface

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	internalId	The internal message id.
[in]	mode	Pointer to a SbgEComOutputMode containing the new output mode of the message.
[in]	userId	The user defined message id.
[in]	extended	TRUE if the user id uses the extended format.

Returns: SBG_NO_ERROR if the command has been executed successfully.

Set the configuration of one the message on the CAN interface

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	internalId	The internal message id.
[in]	pMode	Pointer to a SbgEComOutputMode containing the new output mode of the message.
[in]	pUserId	The user defined message id.
[in]	pExtended	TRUE if the user id uses the extended format.

Returns: SBG_NO_ERROR if the command has been executed successfully.

Definition at line 469 of file sbgEComCmdOutput.c.

◆ sbgEComCmdOutputClassGetEnable()

SbgErrorCode sbgEComCmdOutputClassGetEnable	(	SbgEComHandle *	pHandle,
		SbgEComOutputPort	outputPort,
		SbgEComClass	classId,
		bool *	pEnable
	)

Retrieve the enable of one of the output class message on one of the output interfaces.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	outputPort	The output port.
[in]	classId	The class to enable or disable.
[out]	pEnable	TRUE to enable message output of this class, FALSE to disable it.

Returns: SBG_NO_ERROR if the command has been executed successfully.

Definition at line 203 of file sbgEComCmdOutput.c.

◆ sbgEComCmdOutputClassSetEnable()

SbgErrorCode sbgEComCmdOutputClassSetEnable	(	SbgEComHandle *	pHandle,
		SbgEComOutputPort	outputPort,
		SbgEComClass	classId,
		bool	enable
	)

Set the enable of one of the output class message on one of the output interfaces.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	outputPort	The output port.
[in]	classId	The class to enable or disable.
[in]	enable	TRUE to enable message output of this class, FALSE to disable it.

Returns: SBG_NO_ERROR if the command has been executed successfully.

Definition at line 302 of file sbgEComCmdOutput.c.

◆ sbgEComCmdOutputGetConf()

SbgErrorCode sbgEComCmdOutputGetConf	(	SbgEComHandle *	pHandle,
		SbgEComOutputPort	outputPort,
		SbgEComClass	classId,
		SbgEComMsgId	msgId,
		SbgEComOutputMode *	pConf
	)

Retrieve the configuration of one the message on one of the output interfaces.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	outputPort	The output port of the device for the log concerned.
[in]	classId	The class of the concerned log.
[in]	msgId	The id of the concerned log.
[out]	pMode	Pointer to a SbgEComOutputMode to contain the current output mode of the message.

Returns: SBG_NO_ERROR if the command has been executed successfully.

Retrieve the configuration of one the message on one of the output interfaces.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	outputPort	The output port of the device for the log concerned.
[in]	classId	The class of the concerned log.
[in]	msgId	The id of the concerned log.
[out]	pConf	Pointer to a SbgEComOutputMode to contain the current output mode of the message.

Returns: SBG_NO_ERROR if the command has been executed successfully.

Definition at line 17 of file sbgEComCmdOutput.c.

◆ sbgEComCmdOutputGetLegacyConf()

SbgErrorCode sbgEComCmdOutputGetLegacyConf	(	SbgEComHandle *	pHandle,
		SbgEComOutputPort	outputPort,
		SbgEComLegacyConf *	pConf
	)

Retrieve the configuration of one the message on one of the output interfaces.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	outputPort	The output port of the device for the log concerned.
[out]	pConf	Pointer to a SbgEComLegacyConf structure to contain legacy configuration.

Returns: SBG_NO_ERROR if the command has been executed successfully.

Definition at line 541 of file sbgEComCmdOutput.c.

◆ sbgEComCmdOutputGetNmeaTalkerId()

SbgErrorCode sbgEComCmdOutputGetNmeaTalkerId	(	SbgEComHandle *	pHandle,
		SbgEComOutputPort	outputPort,
		char	nmeaTalkerId[2]
	)

Retrieve the NMEA talker id of one of the output interfaces.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	outputPort	The output port of the device for the log concerned.
[out]	nmeaTalkerId	A 2-char array to contain the nmea talker id.

Returns: SBG_NO_ERROR if the command has been executed successfully.

Definition at line 703 of file sbgEComCmdOutput.c.

◆ sbgEComCmdOutputSetConf()

SbgErrorCode sbgEComCmdOutputSetConf	(	SbgEComHandle *	pHandle,
		SbgEComOutputPort	outputPort,
		SbgEComClass	classId,
		SbgEComMsgId	msgId,
		SbgEComOutputMode	conf
	)

Set the configuration of one the message on one of the output interfaces.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	outputPort	The output port of the device for the log concerned.
[in]	classId	The class of the concerned log.
[in]	msgId	The id of the concerned log.
[in]	mode	New output mode to set.

Returns: SBG_NO_ERROR if the command has been executed successfully.

Set the configuration of one the message on one of the output interfaces.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	outputPort	The output port of the device for the log concerned.
[in]	classId	The class of the concerned log.
[in]	msgId	The id of the concerned log.
[in]	conf	New output mode to set.

Returns: SBG_NO_ERROR if the command has been executed successfully.

Definition at line 119 of file sbgEComCmdOutput.c.

◆ sbgEComCmdOutputSetLegacyConf()

SbgErrorCode sbgEComCmdOutputSetLegacyConf	(	SbgEComHandle *	pHandle,
		SbgEComOutputPort	outputPort,
		const SbgEComLegacyConf *	pConf
	)

Set the configuration of one the message on one of the output interfaces.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	outputPort	The output port of the device for the log concerned.
[in]	pConf	Pointer to a SbgEComLegacyConf structure containing new legacy configuration.

Returns: SBG_NO_ERROR if the command has been executed successfully.

Definition at line 629 of file sbgEComCmdOutput.c.

◆ sbgEComCmdOutputSetNmeaTalkerId()

SbgErrorCode sbgEComCmdOutputSetNmeaTalkerId	(	SbgEComHandle *	pHandle,
		SbgEComOutputPort	outputPort,
		const char	nmeaTalkerId[2]
	)

Set the NMEA talker id of one of the output interfaces.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	outputPort	The output port of the device for the log concerned.
[out]	nmeaTalkerId	A 2-char array containint the new nmea talker id.

Returns: SBG_NO_ERROR if the command has been executed successfully.

Definition at line 780 of file sbgEComCmdOutput.c.

Classes

Typedefs

Enumerations

Functions

Detailed Description

Copyright Notice

Typedef Documentation

◆ SbgEComLegacyConf

◆ SbgEComLegacyEndian

◆ SbgEComLegacyFormat

◆ SbgEComOutputMode

◆ SbgEComOutputMonitoringPoint

◆ SbgEComOutputPort

Enumeration Type Documentation

◆ _SbgEComLegacyEndian

◆ _SbgEComLegacyFormat

◆ _SbgEComOutputMode

◆ _SbgEComOutputMonitoringPoint

◆ _SbgEComOutputPort

Function Documentation

◆ sbgEComCmdCanOutputGetConf()

◆ sbgEComCmdCanOutputSetConf()

◆ sbgEComCmdOutputClassGetEnable()

◆ sbgEComCmdOutputClassSetEnable()

◆ sbgEComCmdOutputGetConf()

◆ sbgEComCmdOutputGetLegacyConf()

◆ sbgEComCmdOutputGetNmeaTalkerId()

◆ sbgEComCmdOutputSetConf()

◆ sbgEComCmdOutputSetLegacyConf()

◆ sbgEComCmdOutputSetNmeaTalkerId()