codeskin.can
Class JLawicel

java.lang.Object
  codeskin.can.JLawicel

All Implemented Interfaces:

CANCallBack, CANDriver, SerialPortClient

public class JLawicel
extends java.lang.Object
implements SerialPortClient, CANDriver, CANCallBack

Driver for CAN USB.

Method Summary

void	callBack(CANMessage cmsg) Function that is called if a CAN message is received.
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.
static JLawicel	getPort(java.lang.String name) Creates singleton instances of the class.
CANMessageBuffer	getTxAcknowledgeBuffer() Accessor method for transmit acknowledge buffer.
boolean	goBusOff() Go bus off.
boolean	goBusOn() Go bus on.
boolean	open(int baudrate) Opens Opens CAN communication using CAN-USB adapter without configuring masks.
boolean	open(int baudrate, int ac01, int ac23, int am01, int am23) Opens CAN communication using CAN-USB adapter.
void	registerCallBack(CANCallBack canCB) Registers method to be called when CAN message is received.
boolean	sendMessage(CANMessage cmsg) Sends CAN message.
boolean	serialPortInputParser(int cin)
boolean	setAcceptanceFilter(int fid, int code, int mask, boolean isExt) Sets acceptance filter.
boolean	setBaudRate(int baud) Sets baud-rate.
boolean	setMasks(int ac01, int ac23, int am01, int am23) Sets CAN USB masks.
boolean	updateStatusRecord() Updates status record.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getMessageBuffer

public CANMessageBuffer getMessageBuffer()

Description copied from interface: CANDriver

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

Specified by:

getMessageBuffer in interface CANDriver

Returns:

true if successful

serialPortInputParser

public boolean serialPortInputParser(int cin)

Specified by:

serialPortInputParser in interface SerialPortClient

sendMessage

public boolean sendMessage(CANMessage cmsg)

Description copied from interface: CANDriver

Sends CAN message.

Specified by:

sendMessage in interface CANDriver

Parameters:

cmsg - Message

Returns:

true if successful

setBaudRate

public boolean setBaudRate(int baud)

Description copied from interface: CANDriver

Sets baud-rate.

Specified by:

setBaudRate in interface CANDriver

Parameters:

baud - baudrate

Returns:

true if successful

setMasks

public boolean setMasks(int ac01,
                        int ac23,
                        int am01,
                        int am23)

Sets CAN USB masks.

Parameters:

ac01 - Acceptance code 01 (see manual)

ac23 - Acceptance code 23 (see manual)

am01 - Acceptance mask 01 (see manual)

am23 - Acceptance mask 23 (see manual)

Returns:

true if successful

open

public boolean open(int baudrate)

Opens Opens CAN communication using CAN-USB adapter without configuring masks.

Parameters:

baudrate - baud-rate (bits/s)

Returns:

true if success

open

public boolean open(int baudrate,
                    int ac01,
                    int ac23,
                    int am01,
                    int am23)

Opens CAN communication using CAN-USB adapter.

Parameters:

baudrate - baud-rate (bits/s)

ac01 - Acceptance code 01 (see manual)

ac23 - Acceptance code 23 (see manual)

am01 - Acceptance mask 01 (see manual)

am23 - Acceptance mask 23 (see manual)

Returns:

true if success

goBusOn

public boolean goBusOn()

Description copied from interface: CANDriver

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

Specified by:

goBusOn in interface CANDriver

Returns:

true if successful

goBusOff

public boolean goBusOff()

Description copied from interface: CANDriver

Go bus off.

Specified by:

goBusOff in interface CANDriver

Returns:

true if successful

getNumberOfFilters

public int getNumberOfFilters()

Description copied from interface: CANDriver

Returns the number of acceptance filters available.

Specified by:

getNumberOfFilters in interface CANDriver

Returns:

Number of available filters

setAcceptanceFilter

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

Description copied from interface: CANDriver

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.

Specified by:

setAcceptanceFilter in interface CANDriver

Parameters:

fid - filter id

code - acceptance code

mask - acceptance mask

isExt - true for extended message filter

Returns:

true if successful

close

public void close()

Description copied from interface: CANDriver

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

Specified by:

close in interface CANDriver

callBack

public void callBack(CANMessage cmsg)

Description copied from interface: CANCallBack

Function that is called if a CAN message is received.

Specified by:

callBack in interface CANCallBack

Parameters:

cmsg - CAN message

registerCallBack

public void registerCallBack(CANCallBack canCB)

Description copied from interface: CANDriver

Registers method to be called when CAN message is received.

Specified by:

registerCallBack in interface CANDriver

Parameters:

canCB - callback

getCANStatusRecord

public CANStatusRecord getCANStatusRecord()

Description copied from interface: CANDriver

Accessor method for status record.

Specified by:

getCANStatusRecord in interface CANDriver

Returns:

status record

getTxAcknowledgeBuffer

public CANMessageBuffer getTxAcknowledgeBuffer()

Description copied from interface: CANDriver

Accessor method for transmit acknowledge buffer.

Specified by:

getTxAcknowledgeBuffer in interface CANDriver

Returns:

CAN buffer

updateStatusRecord

public boolean updateStatusRecord()

Description copied from interface: CANDriver

Updates status record.

Specified by:

updateStatusRecord in interface CANDriver

Returns:

true for success

getPort

public static JLawicel getPort(java.lang.String name)

Creates singleton instances of the class.

Parameters:

name - port name

Returns:

instance of class