org.harctoolbox.devslashlirc

Class LircDevice

java.lang.Object

org.harctoolbox.devslashlirc.LircHardware

org.harctoolbox.devslashlirc.LircDevice

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

LircCodeLircDevice, Mode2LircDevice

public abstract class LircDevice
extends LircHardware

This class is an abstract class for hardware communicating through /dev/lirc.

As opposed to standard C/Lirc, where a device is opened, and it "turns out" that it is "mode2" or "lirccode", here the user has to decide if he wants a mode2 or lirccode device, and open it with the appropriate class. This will fail if the connected hardware does not have the expected properties.

This class (and its derived classes) can be instantiated several times, but of course only one can open a particular device file.

Field Summary

Fields

Modifier and Type	Field and Description
static int	defaultBeginTimeout
static String	defaultDeviceName

Fields inherited from class org.harctoolbox.devslashlirc.LircHardware

deviceName, libraryName, nativePointer

Constructor Summary

Constructors

Constructor and Description
LircDevice(String deviceName, int beginTimeout, long nativePointer)

Method Summary

Modifier and Type	Method and Description
boolean	canRec()
boolean	canSend()
boolean	canSetTransmitterMask()
void	close()
void	delete() Invoke the destructor from Java.
protected void	finalize()
int	getNumberTransmitters()
String	getVersion() Returns the version string of the underlying C++ code, not the version of the hardware or the device driver.
boolean	isValid() Returns true if the device is opened and working.
void	setBeginTimeout(int timeout)
protected boolean	setTransmitterMaskNative(int mask)
String	toString()

Methods inherited from class org.harctoolbox.devslashlirc.LircHardware

isLibraryLoaded, loadLibrary, loadLibrary, open, openNative, setTransmitterMask

Methods inherited from class java.lang.Object

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

Field Detail

defaultDeviceName

public static final String defaultDeviceName

See Also:

Constant Field Values

defaultBeginTimeout

public static final int defaultBeginTimeout

See Also:

Constant Field Values

Constructor Detail

LircDevice

public LircDevice(String deviceName,
                  int beginTimeout,
                  long nativePointer)

Method Detail

setTransmitterMaskNative

protected boolean setTransmitterMaskNative(int mask)

Specified by:

setTransmitterMaskNative in class LircHardware

close

public void close()

getVersion

public String getVersion()

Description copied from class: LircHardware

Returns the version string of the underlying C++ code, not the version of the hardware or the device driver.

Specified by:

getVersion in class LircHardware

Returns:

String

getNumberTransmitters

public int getNumberTransmitters()

Specified by:

getNumberTransmitters in class LircHardware

canSend

public boolean canSend()

Specified by:

canSend in class LircHardware

canSetTransmitterMask

public boolean canSetTransmitterMask()

Specified by:

canSetTransmitterMask in class LircHardware

canRec

public boolean canRec()

Specified by:

canRec in class LircHardware

isValid

public boolean isValid()

Description copied from class: LircHardware

Returns true if the device is opened and working.

Specified by:

isValid in class LircHardware

Returns:

boolean

setBeginTimeout

public final void setBeginTimeout(int timeout)

Specified by:

setBeginTimeout in class LircHardware

toString

public String toString()

Specified by:

toString in class LircHardware

delete

public void delete()

Invoke the destructor from Java.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable