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

#include "sbgEComCmdCommon.h"

Include dependency graph for sbgEComCmdInterface.h:

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

Classes
struct	_SbgEComInterfaceConf

Typedefs
typedef enum _SbgEComCanBitRate	SbgEComCanBitRate

typedef enum _SbgEComCanMode	SbgEComCanMode

typedef struct _SbgEComInterfaceConf	SbgEComInterfaceConf

typedef enum _SbgEComPortId	SbgEComPortId

typedef enum _SbgEComPortMode	SbgEComPortMode

Enumerations
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 }

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 }

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)

Detailed Description

This file implements SbgECom commands related to interfaces.

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

Typedef Documentation

◆ 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

◆ SbgEComInterfaceConf

typedef struct _SbgEComInterfaceConf SbgEComInterfaceConf

Helper structure to configure a serial interface

◆ SbgEComPortId

typedef enum _SbgEComPortId SbgEComPortId

List of serial interfaces available.

◆ SbgEComPortMode

typedef enum _SbgEComPortMode SbgEComPortMode

List of serial modes available.

Enumeration Type Documentation

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

Definition at line 79 of file sbgEComCmdInterface.h.

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

Definition at line 97 of file sbgEComCmdInterface.h.

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

Definition at line 32 of file sbgEComCmdInterface.h.

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

Definition at line 52 of file sbgEComCmdInterface.h.

Function Documentation

◆ 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]	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.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	bitRate	The bitrate of the CAN interface.
[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.

Classes

Typedefs

Enumerations

Functions

Detailed Description

Copyright Notice

Typedef Documentation

◆ SbgEComCanBitRate

◆ SbgEComCanMode

◆ SbgEComInterfaceConf

◆ SbgEComPortId

◆ SbgEComPortMode

Enumeration Type Documentation

◆ _SbgEComCanBitRate

◆ _SbgEComCanMode

◆ _SbgEComPortId

◆ _SbgEComPortMode

Function Documentation

◆ sbgEComCmdInterfaceGetCanConf()

◆ sbgEComCmdInterfaceGetUartConf()

◆ sbgEComCmdInterfaceSetCanConf()

◆ sbgEComCmdInterfaceSetUartConf()