sbgEComCmdOutput.h File Reference

Commands used to setup logs to output over the device interfaces. More...

#include <sbgCommon.h>
#include <sbgECom.h>

Go to the source code of this file.

Typedefs
typedef enum _SbgEComOutputPort	SbgEComOutputPort
typedef enum _SbgEComOutputMode	SbgEComOutputMode
typedef enum _SbgEComOutputMonitoringPoint	SbgEComOutputMonitoringPoint

Enumerations
enum	_SbgEComOutputPort {   SBG_ECOM_OUTPUT_PORT_A = 0 ,   SBG_ECOM_OUTPUT_PORT_C = 2 ,   SBG_ECOM_OUTPUT_PORT_E = 4 }
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 }

Functions
SbgErrorCode	sbgEComCmdOutputGetConf (SbgEComHandle *pHandle, SbgEComOutputPort outputPort, SbgEComClass classId, SbgEComMsgId msgId, SbgEComOutputMode *pMode)
SbgErrorCode	sbgEComCmdOutputSetConf (SbgEComHandle *pHandle, SbgEComOutputPort outputPort, SbgEComClass classId, SbgEComMsgId msgId, SbgEComOutputMode mode)
SbgErrorCode	sbgEComCmdOutputClassGetEnable (SbgEComHandle *pHandle, SbgEComOutputPort outputPort, SbgEComClass classId, bool *pEnable)
SbgErrorCode	sbgEComCmdOutputClassSetEnable (SbgEComHandle *pHandle, SbgEComOutputPort outputPort, SbgEComClass classId, bool enable)
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	sbgEComCmdOutputGetNmeaTalkerId (SbgEComHandle *pHandle, SbgEComOutputPort outputPort, char *pNmeaTalkerId)
SbgErrorCode	sbgEComCmdOutputSetNmeaTalkerId (SbgEComHandle *pHandle, SbgEComOutputPort outputPort, const char *pNmeaTalkerId)

Detailed Description

Commands used to setup logs to output over the device interfaces.

Author

SBG Systems

Date

11 June 2014

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

SbgEComOutputPort

typedef enum _SbgEComOutputPort SbgEComOutputPort

List of output ports available.

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.

Enumeration Type Documentation

_SbgEComOutputPort

enum _SbgEComOutputPort

List of output 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

_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

_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.

Function Documentation

sbgEComCmdOutputGetConf()

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

Retrieve the configuration of one message for an 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.

sbgEComCmdOutputSetConf()

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

Set the configuration of one message for an 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.

sbgEComCmdOutputClassGetEnable()

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

Retrieve if a whole message class is enabled or not for an output interface.

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.

sbgEComCmdOutputClassSetEnable()

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

Set if a whole message class is enabled or not for an output interface.

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.

sbgEComCmdCanOutputGetConf()

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

Retrieve the configuration of one message for 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.

sbgEComCmdCanOutputSetConf()

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

Set the configuration of one message for 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.

sbgEComCmdOutputGetNmeaTalkerId()

SbgErrorCode sbgEComCmdOutputGetNmeaTalkerId	(	SbgEComHandle *	pHandle,
		SbgEComOutputPort	outputPort,
		char *	pNmeaTalkerId
	)

Retrieve the NMEA talker id for an output interface.

Parameters

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

Returns

SBG_NO_ERROR if the command has been executed successfully.

sbgEComCmdOutputSetNmeaTalkerId()

SbgErrorCode sbgEComCmdOutputSetNmeaTalkerId	(	SbgEComHandle *	pHandle,
		SbgEComOutputPort	outputPort,
		const char *	pNmeaTalkerId
	)

Set the NMEA talker id for an output interface.

Parameters

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

Returns

SBG_NO_ERROR if the command has been executed successfully.