#include "sbgEComCmdOutput.h"
#include <streamBuffer/sbgStreamBuffer.h>

Include dependency graph for sbgEComCmdOutput.c:

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 pConf)

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 conf)

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

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

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]	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]	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.
\param[in]  pHandle                                         A valid sbgECom handle.
\param[in]  outputPort                                      The output port of the device for the log concerned.

Parameters

[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]	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.
\param[in]  pHandle                                         A valid sbgECom handle.
\param[in]  outputPort                                      The output port of the device for the log concerned.

Parameters

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

Functions

Function Documentation

◆ sbgEComCmdCanOutputGetConf()

◆ sbgEComCmdCanOutputSetConf()

◆ sbgEComCmdOutputClassGetEnable()

◆ sbgEComCmdOutputClassSetEnable()

◆ sbgEComCmdOutputGetConf()

◆ sbgEComCmdOutputGetLegacyConf()

◆ sbgEComCmdOutputGetNmeaTalkerId()

◆ sbgEComCmdOutputSetConf()

◆ sbgEComCmdOutputSetLegacyConf()

◆ sbgEComCmdOutputSetNmeaTalkerId()