codeskin.can
Interface CANDriver

All Known Implementing Classes:

CANSimDriver, JKvaser, JLawicel, JLawicelNative, JVector

public interface CANDriver

Interface for CAN Driver implementations. Low-level configuration (open method) is hardware specific. Messages are received either by call-back or polling buffer.

Method Summary

void	close() Closes driver.
CANStatusRecord	getCANStatusRecord() Accessor method for status record.
CANMessageBuffer	getMessageBuffer() Accessor method for receive buffer.
int	getNumberOfFilters() Returns the number of acceptance filters available.
CANMessageBuffer	getTxAcknowledgeBuffer() Accessor method for transmit acknowledge buffer.
boolean	goBusOff() Go bus off.
boolean	goBusOn() Go bus on.
void	registerCallBack(CANCallBack canCB) Registers method to be called when CAN message is received.
boolean	sendMessage(CANMessage cmsg) Sends CAN message.
boolean	setAcceptanceFilter(int fid, int code, int mask, boolean isExt) Sets acceptance filter.
boolean	setBaudRate(int baudrate) Sets baud-rate.
boolean	updateStatusRecord() Updates status record.

Method Detail

goBusOn

boolean goBusOn()

Go bus on. Must be called to start receiving and allow sending.

Returns:

true if successful

goBusOff

boolean goBusOff()

Go bus off.

Returns:

true if successful

setBaudRate

boolean setBaudRate(int baudrate)

Sets baud-rate.

Parameters:

baudrate - baudrate

Returns:

true if successful

getNumberOfFilters

int getNumberOfFilters()

Returns the number of acceptance filters available.

Returns:

Number of available filters

setAcceptanceFilter

boolean setAcceptanceFilter(int fid,
                            int code,
                            int mask,
                            boolean isExt)

Sets acceptance filter. Different filters can be configured, depending on implementation. A "1" in the mask means that the corresponding bit in code is relevant.

Parameters:

fid - filter id

code - acceptance code

mask - acceptance mask

isExt - true for extended message filter

Returns:

true if successful

registerCallBack

void registerCallBack(CANCallBack canCB)

Registers method to be called when CAN message is received.

Parameters:

canCB - callback

getMessageBuffer

CANMessageBuffer getMessageBuffer()

Accessor method for receive buffer. Note that receive buffer is only serviced if no callback method has been registered.

Returns:

true if successful

sendMessage

boolean sendMessage(CANMessage cmsg)

Sends CAN message.

Parameters:

cmsg - Message

Returns:

true if successful

close

void close()

Closes driver. Note that open() is implementation specific.

getCANStatusRecord

CANStatusRecord getCANStatusRecord()

Accessor method for status record.

Returns:

status record

updateStatusRecord

boolean updateStatusRecord()

Updates status record.

Returns:

true for success

getTxAcknowledgeBuffer

CANMessageBuffer getTxAcknowledgeBuffer()

Accessor method for transmit acknowledge buffer.

Returns:

CAN buffer