CAN Functions

Macros
#define	HAL_ERR_CANSessionMux_BufferTooLong   -44085
#define	HAL_ERR_CANSessionMux_InvalidBuffer   -44086
#define	HAL_ERR_CANSessionMux_MessageNotFound   -44087
#define	HAL_WARN_CANSessionMux_NoToken   44087
#define	HAL_WARN_CANSessionMux_TxQueueFull   44086
#define	HAL_WARN_CANSessionMux_SocketBufferFull   44088
#define	HAL_ERR_CANSessionMux_NotAllowed   -44088
#define	HAL_ERR_CANSessionMux_NotInitialized   -44089
#define	HAL_ERR_CANSessionMux_SessionOverrun   44050
void	HAL_CAN_SendMessage (int32_t busId, uint32_t messageId, const struct HAL_CANMessage *message, int32_t periodMs, int32_t *status)
	Sends a CAN message.
void	HAL_CAN_ReceiveMessage (int32_t busId, uint32_t messageId, struct HAL_CANReceiveMessage *message, int32_t *status)
	Receives a CAN message.
void	HAL_CAN_GetCANStatus (int32_t busId, float *percentBusUtilization, uint32_t *busOffCount, uint32_t *txFullCount, uint32_t *receiveErrorCount, uint32_t *transmitErrorCount, int32_t *status)
	Gets CAN status information.

Detailed Description

Macro Definition Documentation

HAL_ERR_CANSessionMux_BufferTooLong

#define HAL_ERR_CANSessionMux_BufferTooLong   -44085

HAL_ERR_CANSessionMux_InvalidBuffer

#define HAL_ERR_CANSessionMux_InvalidBuffer   -44086

HAL_ERR_CANSessionMux_MessageNotFound

#define HAL_ERR_CANSessionMux_MessageNotFound   -44087

HAL_ERR_CANSessionMux_NotAllowed

#define HAL_ERR_CANSessionMux_NotAllowed   -44088

HAL_ERR_CANSessionMux_NotInitialized

#define HAL_ERR_CANSessionMux_NotInitialized   -44089

HAL_ERR_CANSessionMux_SessionOverrun

#define HAL_ERR_CANSessionMux_SessionOverrun   44050

HAL_WARN_CANSessionMux_NoToken

#define HAL_WARN_CANSessionMux_NoToken   44087

HAL_WARN_CANSessionMux_SocketBufferFull

#define HAL_WARN_CANSessionMux_SocketBufferFull   44088

HAL_WARN_CANSessionMux_TxQueueFull

#define HAL_WARN_CANSessionMux_TxQueueFull   44086

Function Documentation

HAL_CAN_GetCANStatus()

void HAL_CAN_GetCANStatus	(	int32_t	busId,
		float *	percentBusUtilization,
		uint32_t *	busOffCount,
		uint32_t *	txFullCount,
		uint32_t *	receiveErrorCount,
		uint32_t *	transmitErrorCount,
		int32_t *	status )

Gets CAN status information.

Parameters

[in]	busId	the bus number
[out]	percentBusUtilization	the bus utilization
[out]	busOffCount	the number of bus off errors
[out]	txFullCount	the number of tx full errors
[out]	receiveErrorCount	the number of receive errors
[out]	transmitErrorCount	the number of transmit errors
[out]	status	Error status variable. 0 on success.

HAL_CAN_ReceiveMessage()

void HAL_CAN_ReceiveMessage	(	int32_t	busId,
		uint32_t	messageId,
		struct HAL_CANReceiveMessage *	message,
		int32_t *	status )

Receives a CAN message.

Parameters

[in]	busId	The CAN bus number
[in]	messageId	the message id
[out]	message	The CAN message
[out]	status	Error status variable. 0 on success.

HAL_CAN_SendMessage()

void HAL_CAN_SendMessage	(	int32_t	busId,
		uint32_t	messageId,
		const struct HAL_CANMessage *	message,
		int32_t	periodMs,
		int32_t *	status )

Sends a CAN message.

Parameters

[in]	busId	the CAN bus number
[in]	messageId	the message id
[in]	message	the CAN message
[in]	periodMs	the repeat period
[out]	status	Error status variable. 0 on success.