org.harctoolbox.harchardware.ir

Class LircMode2

java.lang.Object

org.harctoolbox.harchardware.ir.LircMode2

All Implemented Interfaces:

Closeable, AutoCloseable, IHarcHardware, ICapture, IReceive

public final class LircMode2
extends Object
implements IHarcHardware, ICapture, IReceive

This class runs an external program, for example mode2 of LIRC, in a separate process, and evaluates its output, which is assumed to be in the LIRC mode2 format.

Constructor Summary

Constructors

Constructor and Description
LircMode2(String[] cmdArray, boolean verbose, int beginTimeout, int maxLearnLength, int endTimeout)
LircMode2(String cmd, boolean verbose, int beginTimeout, int maxLearnLength, int endTimeout)

Method Summary

Modifier and Type	Method and Description
ModulatedIrSequence	capture() Listens to the device and returns a sequence.
void	close()
String	getVersion() Returns the hardware version (not the version of the driver software).
boolean	isAlive()
boolean	isValid() Tries to identify instances that are not valid.
static void	main(String[] args)
void	open() Opens the device with previously set parameters.
IrSequence	receive() Listens to the device and returns a sequence.
void	reset()
void	setCommand(String command)
void	setDebug(int debug) Sets a debug parameter.
void	setTimeout(int timeout) Set timeout in milliseconds.
void	setTimeout(int beginTimeout, int maxLearnedLength, int endTimeout)
void	setVerbosity(boolean verbose) Sets a verbosity flag, causing commands to be executed verbosely.
boolean	stopCapture() Signals the capturing device that it should stop capturing.
boolean	stopReceive() Signals the receiving device that it should stop receiving.

Methods inherited from class java.lang.Object

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

Constructor Detail

LircMode2

public LircMode2(String cmd,
                 boolean verbose,
                 int beginTimeout,
                 int maxLearnLength,
                 int endTimeout)

Parameters:

cmd -

verbose -

beginTimeout -

maxLearnLength -

endTimeout -

LircMode2

public LircMode2(String[] cmdArray,
                 boolean verbose,
                 int beginTimeout,
                 int maxLearnLength,
                 int endTimeout)

Parameters:

cmdArray -

verbose -

beginTimeout -

maxLearnLength -

endTimeout -

Method Detail

getVersion

public String getVersion()

Description copied from interface: IHarcHardware

Returns the hardware version (not the version of the driver software). May be null if no relevant information available.

Specified by:

getVersion in interface IHarcHardware

Returns:

Version string. Semantics can vary.

setVerbosity

public void setVerbosity(boolean verbose)

Description copied from interface: IHarcHardware

Sets a verbosity flag, causing commands to be executed verbosely. Exact semantic depends on the implementation.

Specified by:

setVerbosity in interface IHarcHardware

Parameters:

verbose - on or off

setDebug

public void setDebug(int debug)

Description copied from interface: IHarcHardware

Sets a debug parameter. Exact semantic depends on the implementation.

Specified by:

setDebug in interface IHarcHardware

setCommand

public void setCommand(String command)

isValid

public boolean isValid()

Description copied from interface: IHarcHardware

Tries to identify instances that are not valid. Exact meaning can vary.

Specified by:

isValid in interface IHarcHardware

Returns:

validity of the instance.

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

open

public void open()
          throws IOException

Description copied from interface: IHarcHardware

Opens the device with previously set parameters.

Specified by:

open in interface IHarcHardware

Throws:

IOException

capture

public ModulatedIrSequence capture()
                            throws HarcHardwareException,
                                   IOException,
                                   IrpMasterException

Description copied from interface: ICapture

Listens to the device and returns a sequence. Requires the device to be previously opened. Should itself neither open or close the device.

Specified by:

capture in interface ICapture

Returns:

Captured sequence, or null by timeout.

Throws:

HarcHardwareException - if the device is not in valid/open state.

IOException

IrpMasterException

stopCapture

public boolean stopCapture()

Description copied from interface: ICapture

Signals the capturing device that it should stop capturing. May not be implemented in all hardware.

Specified by:

stopCapture in interface ICapture

Returns:

status

isAlive

public boolean isAlive()

setTimeout

public void setTimeout(int beginTimeout,
                       int maxLearnedLength,
                       int endTimeout)

Specified by:

setTimeout in interface ICapture

setTimeout

public void setTimeout(int timeout)

Description copied from interface: IHarcHardware

Set timeout in milliseconds. Exact semantics may be dependent on the hardware.

Specified by:

setTimeout in interface IHarcHardware

Specified by:

setTimeout in interface IReceive

Parameters:

timeout - Timeout in milliseconds.

receive

public IrSequence receive()
                   throws HarcHardwareException

Description copied from interface: IReceive

Listens to the device and returns a sequence. Requires the device to be previously opened. Should itself neither open or close the device.

Specified by:

receive in interface IReceive

Returns:

Captured sequence, or null by timeout.

Throws:

HarcHardwareException - if the device is not in valid/open state.

reset

public void reset()

stopReceive

public boolean stopReceive()

Description copied from interface: IReceive

Signals the receiving device that it should stop receiving. May not be implemented in all hardware.

Specified by:

stopReceive in interface IReceive

Returns:

status

main

public static void main(String[] args)