sbgEComCmdInterface.h File Reference

Commands used to configure device serial, CAN and Ethernet interfaces. More...

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

Go to the source code of this file.

Data Structures
struct	_SbgEComInterfaceConf

Typedefs
typedef enum _SbgEComPortId	SbgEComPortId
typedef enum _SbgEComPortMode	SbgEComPortMode
typedef struct _SbgEComInterfaceConf	SbgEComInterfaceConf
typedef enum _SbgEComCanBitRate	SbgEComCanBitRate
typedef enum _SbgEComCanMode	SbgEComCanMode

Enumerations
enum	_SbgEComPortId {   SBG_ECOM_IF_COM_A = 0 ,   SBG_ECOM_IF_COM_B = 1 ,   SBG_ECOM_IF_COM_C = 2 ,   SBG_ECOM_IF_COM_D = 3 ,   SBG_ECOM_IF_COM_E = 4 ,   SBG_ECOM_IF_ETH_0 = 10 ,   SBG_ECOM_IF_ETH_1 = 11 ,   SBG_ECOM_IF_ETH_2 = 12 ,   SBG_ECOM_IF_ETH_3 = 13 ,   SBG_ECOM_IF_ETH_4 = 14 ,   SBG_ECOM_IF_DATA_LOGGER = 20 }
enum	_SbgEComPortMode {   SBG_ECOM_UART_MODE_OFF = 0 ,   SBG_ECOM_UART_MODE_232 = 1 ,   SBG_ECOM_UART_MODE_422 = 2 }
enum	_SbgEComCanBitRate {   SBG_ECOM_CAN_BITRATE_DISABLED = 0 ,   SBG_ECOM_CAN_BITRATE_10 = 10 ,   SBG_ECOM_CAN_BITRATE_20 = 20 ,   SBG_ECOM_CAN_BITRATE_25 = 25 ,   SBG_ECOM_CAN_BITRATE_50 = 50 ,   SBG_ECOM_CAN_BITRATE_100 = 100 ,   SBG_ECOM_CAN_BITRATE_125 = 125 ,   SBG_ECOM_CAN_BITRATE_250 = 250 ,   SBG_ECOM_CAN_BITRATE_500 = 500 ,   SBG_ECOM_CAN_BITRATE_750 = 750 ,   SBG_ECOM_CAN_BITRATE_1000 = 1000 }
enum	_SbgEComCanMode {   SBG_ECOM_CAN_MODE_UNDEFINED = 0 ,   SBG_ECOM_CAN_MODE_SPY = 1 ,   SBG_ECOM_CAN_MODE_NORMAL = 2 ,   SBG_ECOM_CAN_NR_MODE }

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

Detailed Description

Commands used to configure device serial, CAN and Ethernet 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

SbgEComPortId

typedef enum _SbgEComPortId SbgEComPortId

List of serial interfaces available.

SbgEComPortMode

typedef enum _SbgEComPortMode SbgEComPortMode

List of serial modes available.

SbgEComInterfaceConf

typedef struct _SbgEComInterfaceConf SbgEComInterfaceConf

Helper structure to configure a serial interface

SbgEComCanBitRate

typedef enum _SbgEComCanBitRate SbgEComCanBitRate

Enum containing the list of all available bit rates (in KB/s).

SbgEComCanMode

typedef enum _SbgEComCanMode SbgEComCanMode

Enum containing the list of different CAN modes

Enumeration Type Documentation

_SbgEComPortId

enum _SbgEComPortId

List of serial interfaces available.

Enumerator
SBG_ECOM_IF_COM_A	Main communication interface. Full duplex.
SBG_ECOM_IF_COM_B	Auxiliary input interface for RTCM.
SBG_ECOM_IF_COM_C	Auxiliary communication interface. Full duplex.
SBG_ECOM_IF_COM_D	Auxiliary input interface.
SBG_ECOM_IF_COM_E	Auxiliary output interface.
SBG_ECOM_IF_ETH_0	Ethernet interface 0.
SBG_ECOM_IF_ETH_1	Ethernet interface 1.
SBG_ECOM_IF_ETH_2	Ethernet interface 2.
SBG_ECOM_IF_ETH_3	Ethernet interface 3.
SBG_ECOM_IF_ETH_4	Ethernet interface 4.
SBG_ECOM_IF_DATA_LOGGER	Data logger interface.

_SbgEComPortMode

enum _SbgEComPortMode

List of serial modes available.

Enumerator
SBG_ECOM_UART_MODE_OFF	This interface is turned OFF.
SBG_ECOM_UART_MODE_232	This interface is using RS-232 communications.
SBG_ECOM_UART_MODE_422	This interface is using RS-422 communications.

_SbgEComCanBitRate

enum _SbgEComCanBitRate

Enum containing the list of all available bit rates (in KB/s).

Enumerator
SBG_ECOM_CAN_BITRATE_DISABLED	The CAN interface is disabled.
SBG_ECOM_CAN_BITRATE_10	10Kb/s.
SBG_ECOM_CAN_BITRATE_20	20Kb/s.
SBG_ECOM_CAN_BITRATE_25	25Kb/s.
SBG_ECOM_CAN_BITRATE_50	50Kb/s.
SBG_ECOM_CAN_BITRATE_100	100Kb/s.
SBG_ECOM_CAN_BITRATE_125	125Kb/s.
SBG_ECOM_CAN_BITRATE_250	250Kb/s.
SBG_ECOM_CAN_BITRATE_500	500Kb/s.
SBG_ECOM_CAN_BITRATE_750	750Kb/s.
SBG_ECOM_CAN_BITRATE_1000	1Mb/s.

_SbgEComCanMode

enum _SbgEComCanMode

Enum containing the list of different CAN modes

Enumerator
SBG_ECOM_CAN_MODE_UNDEFINED	CAN Mode undefined.
SBG_ECOM_CAN_MODE_SPY	Only listening on the CAN bus and doesn't sent anything (even RX ACK bit).
SBG_ECOM_CAN_MODE_NORMAL	The device is allowed to both send and receive over the CAN bus.

Function Documentation

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.

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.

sbgEComCmdInterfaceGetCanConf()

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

Retrieve the configuration of the CAN interface.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pBitrate	The bitrate of the CAN interface.
[out]	pMode	Mode of the CAN interface.

Returns

SBG_NO_ERROR if the command has been executed successfully.

sbgEComCmdInterfaceSetCanConf()

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

Set the configuration of the CAN interface.

Parameters

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

Returns

SBG_NO_ERROR if the command has been executed successfully.