sbgEComCmdInterface.c File Reference

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

Include dependency graph for sbgEComCmdInterface.c:

Go to the source code of this file.

Functions
SbgErrorCode	sbgEComCmdInterfaceGetCanConf (SbgEComHandle *pHandle, SbgEComCanBitRate *pBitrate, SbgEComCanMode *pMode)
SbgErrorCode	sbgEComCmdInterfaceGetUartConf (SbgEComHandle *pHandle, SbgEComPortId interfaceId, SbgEComInterfaceConf *pConf)
SbgErrorCode	sbgEComCmdInterfaceSetCanConf (SbgEComHandle *pHandle, SbgEComCanBitRate bitrate, SbgEComCanMode mode)
SbgErrorCode	sbgEComCmdInterfaceSetUartConf (SbgEComHandle *pHandle, SbgEComPortId interfaceId, const SbgEComInterfaceConf *pConf)

Function Documentation

sbgEComCmdInterfaceGetCanConf()

SbgErrorCode sbgEComCmdInterfaceGetCanConf	(	SbgEComHandle *	pHandle,
		SbgEComCanBitRate *	pBitrate,
		SbgEComCanMode *	pMode
	)

Retrieve the configuration of the CAN interface.

\param[in]  pHandle                                         A valid sbgECom handle.
\param[out] pBitRate                                        The bitrate of the CAN interface.

Parameters

[out]

pCanMode

Mode of the CAN interface.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 142 of file sbgEComCmdInterface.c.

sbgEComCmdInterfaceGetUartConf()

SbgErrorCode sbgEComCmdInterfaceGetUartConf	(	SbgEComHandle *	pHandle,
		SbgEComPortId	interfaceId,
		SbgEComInterfaceConf *	pConf
	)

Retrieve the configuration of one of the interfaces.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	interfaceId	The interface from which the configuration is to be retrieved.
[out]	pConf	Pointer to a SbgEComInterfaceConf struct to hold configuration of the interface.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 8 of file sbgEComCmdInterface.c.

sbgEComCmdInterfaceSetCanConf()

SbgErrorCode sbgEComCmdInterfaceSetCanConf	(	SbgEComHandle *	pHandle,
		SbgEComCanBitRate	bitrate,
		SbgEComCanMode	mode
	)

Set the configuration of the CAN interface.

\param[in]  pHandle                                         A valid sbgECom handle.
\param[in]  bitRate                                         The bitrate of the CAN interface.

Parameters

[in]

pCanMode

Mode of the CAN interface.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 225 of file sbgEComCmdInterface.c.

sbgEComCmdInterfaceSetUartConf()

SbgErrorCode sbgEComCmdInterfaceSetUartConf	(	SbgEComHandle *	pHandle,
		SbgEComPortId	interfaceId,
		const SbgEComInterfaceConf *	pConf
	)

Set the configuration of one of the interfaces.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	interfaceId	The interface from which the configuration is to be retrieved.
[in]	pConf	Pointer to a SbgEComInterfaceConf struct that holds the new configuration for the interface.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 77 of file sbgEComCmdInterface.c.