org.harctoolbox.devslashlirc

Interface IMode2

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

Mode2LircDevice

public interface IMode2
extends Closeable

This interface specifies the commands of "mode2" Lirc hardware, device or driver.

Method Summary

Modifier and Type	Method and Description
boolean	canGetRecResolution()
boolean	canRec()
boolean	canSend()
boolean	canSetSendCarrier()
boolean	canSetTransmitterMask()
int	getNumberTransmitters() Returns the number of transmitters, as reported from the device.
int	getRecResolution()
String	getVersion() Returns version of underlying C++ driver.
boolean	isValid() Returns true if the hardware is open and ready.
void	open() Opens the hardware using the previously given device name.
int[]	receive() Reads an IR signal as a sequence of durations.
void	send(int[] data) Sends the provided data as a sequence of durations.
void	send(int[] data, int frequency) Sends the provided data as a sequence of durations.
void	setEndingTimeout(int timeout)
void	setMaxCaptureLength(int maxCaptureLength)
void	setSendCarrier(int frequency)
void	setTransmitterMask(int mask)
String	toString()

Methods inherited from interface java.io.Closeable

close

Method Detail

canGetRecResolution

boolean canGetRecResolution()

canSetSendCarrier

boolean canSetSendCarrier()

getRecResolution

int getRecResolution()
              throws NotSupportedException

Throws:

NotSupportedException

open

void open()
   throws LircDeviceException

Opens the hardware using the previously given device name.

Throws:

LircDeviceException - Error occured.

receive

int[] receive()
       throws NotSupportedException

Reads an IR signal as a sequence of durations.

Returns:

durations as an integer array, all positive.

Throws:

NotSupportedException - if the hardwared does not support receiving.

send

void send(int[] data)
   throws NotSupportedException

Sends the provided data as a sequence of durations. The data is send without setting the modulation frequency, so the exact outcome may depend on the hardware, or on previously sent commands.

Parameters:

data - interger array of durations.

Throws:

NotSupportedException - if the hardware does not support sending.

send

void send(int[] data,
          int frequency)
   throws NotSupportedException

Sends the provided data as a sequence of durations. The data is send without setting the modulation frequency, so the exact outcome may depend on the hardware, or on previously sent commands.

Parameters:

data - interger array of durations.

frequency - Frequency in Hz.

Throws:

NotSupportedException - if the hardware does not support sending, or setting of the modulation frequency.

setSendCarrier

void setSendCarrier(int frequency)
             throws NotSupportedException

Throws:

NotSupportedException

canRec

boolean canRec()

canSend

boolean canSend()

canSetTransmitterMask

boolean canSetTransmitterMask()

getNumberTransmitters

int getNumberTransmitters()

Returns the number of transmitters, as reported from the device.

Returns:

integer

getVersion

String getVersion()

Returns version of underlying C++ driver.

Returns:

String

isValid

boolean isValid()

Returns true if the hardware is open and ready.

Returns:

boolean

setTransmitterMask

void setTransmitterMask(int mask)
                 throws NotSupportedException,
                        NonExistentTransmitterException,
                        LircDeviceException

Throws:

NotSupportedException

NonExistentTransmitterException

LircDeviceException

setMaxCaptureLength

void setMaxCaptureLength(int maxCaptureLength)

setEndingTimeout

void setEndingTimeout(int timeout)

toString

String toString()

Overrides:

toString in class Object