com.digi.android.can

Class CAN

java.lang.Object

com.digi.android.can.CAN

public class CAN
extends java.lang.Object

This class allows the user to manage CAN devices. This interaction is performed via the corresponding native library that interfaces directly with the kernel.

To obtain an instance of the CAN interface you have to use the CANManager.createCAN(int) method.

To receive frames you have to register an ICANListener and then start reading for the interface using the startRead method.

To send frames use the write method.

Method Summary

Modifier and Type	Method and Description
void	close() Attempts to close the CAN interface.
int	getInterfaceNumber() Retrieves the CAN interface number.
boolean	isInterfaceOpen() Gets the status of the CAN interface.
boolean	isReading() Gets the status of the read process.
void	open() Opens the CAN interface.
void	registerListener(ICANListener listener) Registers a listener to detect when a CAN message has been received.
void	setBitrate(int bitrate) Changes the bitrate of this CAN interface.
void	startRead(java.util.List<CANFilter> filters) Starts the reception procedure of CAN messages according to the specified IDs and masks.
void	stopRead() Stops the reception procedure of CAN messages.
void	unregisterListener(ICANListener listener) Unregisters a listener to stop detecting when a CAN message has been received.
void	write(CANFrame frame) Sends the given CANFrame.

Methods inherited from class java.lang.Object

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

Method Detail

open

public void open()
          throws NoSuchInterfaceException,
                 java.io.IOException

Opens the CAN interface.

It does nothing if the interface is already open.

Throws:

java.io.IOException - If there is an error opening the CAN interface.

NoSuchInterfaceException - If the configured interface does not exist.

See Also:

close(), isInterfaceOpen()

close

public void close()
           throws java.io.IOException

Attempts to close the CAN interface.

If the read process is running, this method stops it.

Throws:

java.io.IOException - If there is an error closing the CAN interface.

See Also:

isInterfaceOpen(), open(), stopRead()

isInterfaceOpen

public boolean isInterfaceOpen()

Gets the status of the CAN interface.

Returns:

true if interface is open, false if not.

See Also:

close(), open()

getInterfaceNumber

public int getInterfaceNumber()

Retrieves the CAN interface number.

Returns:

The CAN interface number.

isReading

public boolean isReading()

Gets the status of the read process.

Returns:

true if the read process is running, false otherwise.

startRead

public void startRead(java.util.List<CANFilter> filters)
               throws java.io.IOException

Starts the reception procedure of CAN messages according to the specified IDs and masks.

This method is supposed to be called once the listener is already registered.

To change the filters, use stopRead() and then call this method with the new list of filters to use.

This method does nothing if the read process is already running. Use isReading() to know the status of the process.

Parameters:

filters - Array containing the desired reception IDs.

Throws:

java.lang.IllegalArgumentException - If any filter in the list is null.

java.io.IOException - If the interface is closed.

java.lang.NullPointerException - If filters == null.

See Also:

isReading(), registerListener(ICANListener), stopRead()

stopRead

public void stopRead()
              throws java.io.IOException

Stops the reception procedure of CAN messages.

Throws:

java.io.IOException - If the interface is closed.

See Also:

isReading(), startRead(List)

registerListener

public void registerListener(ICANListener listener)

Registers a listener to detect when a CAN message has been received.

If the given listener is already registered, this method does nothing.

To start receiving CAN frames, the method startRead must be called.

Parameters:

listener - The listener to be registered.

Throws:

java.lang.NullPointerException - If listener == null.

See Also:

isReading(), startRead(List), unregisterListener(ICANListener)

unregisterListener

public void unregisterListener(ICANListener listener)

Unregisters a listener to stop detecting when a CAN message has been received.

If the given listener is not registered, this method does nothing.

Parameters:

listener - The listener to be unregistered.

Throws:

java.lang.NullPointerException - If listener == null.

See Also:

registerListener(ICANListener)

write

public void write(CANFrame frame)
           throws java.io.IOException

Sends the given CANFrame.

Parameters:

frame - The CAN frame to be written.

Throws:

java.io.IOException - If the interface is closed or there is an error writing data.

java.lang.NullPointerException - If frame == null.

See Also:

isInterfaceOpen()

setBitrate

public void setBitrate(int bitrate)
                throws java.lang.IllegalArgumentException,
                       java.lang.UnsupportedOperationException,
                       java.io.IOException

Changes the bitrate of this CAN interface.

Parameters:

bitrate - New interface bitrate in Hz.

Throws:

java.lang.IllegalArgumentException - If bitrate < 1

java.io.IOException - If there is an error setting the bitrate.

java.lang.UnsupportedOperationException - If the interface does not support bitrate changes.