Package org.harctoolbox.harchardware.ir

Class LircClient

java.lang.Object

org.harctoolbox.harchardware.ir.LircClient

All Implemented Interfaces:

Closeable, AutoCloseable, IHarcHardware, IIrSenderStop, IRemoteCommandIrSender, ITransmitter

Direct Known Subclasses:

LircCcfClient

public class LircClient
extends Object
implements IHarcHardware, IRemoteCommandIrSender, IIrSenderStop, ITransmitter

A LIRC client, talking to a remote LIRC server through a TCP port. Functionally, it resembles the command line program irsend.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	LircClient.CommandList
static final class	LircClient.CommandSendOnce
static final class	LircClient.CommandSendStart
static final class	LircClient.CommandSendStop
static final class	LircClient.CommandSetTransmitters
static final class	LircClient.CommandSimulate
static final class	LircClient.CommandVersion

Field Summary

Fields

Modifier and Type	Field	Description
static final String	defaultLircIP
static final int	defaultTimeout
static final int	lircDefaultPort

Fields inherited from interface org.harctoolbox.harchardware.ir.IRemoteCommandIrSender

repeatMax

Constructor Summary

Constructors

Constructor	Description
LircClient(String hostname)
LircClient(String hostname, Integer port, boolean verbose, Integer timeout)
LircClient(InetAddress hostname)
LircClient(InetAddress hostname, boolean verbose)
LircClient(InetAddress hostname, boolean verbose, Integer timeout)
LircClient(InetAddress hostname, Integer port, boolean verbose, Integer timeout)

Method Summary

Modifier and Type	Method	Description
void	close()
String[]	getCommands(String remote)	Returns an array of command names for the remote given in the argument.
String[]	getRemotes()	Returns an array of "remote" names.
LircTransmitter	getTransmitter()	Returns a default Transmitter for the device.
LircTransmitter	getTransmitter(int portNo)
LircTransmitter	getTransmitter(String port)	Parses the String argument, and returns a transmitter accordingly.
String[]	getTransmitterNames()	Return possible name of transmitters, that are guaranteed to work with the getTransmitter(String).
String	getVersion()	Returns the hardware version (not the version of the driver software).
boolean	isValid()	Dummy implementation, always returns true
static void	main(String[] args)
void	open()	Opens the device with previously set parameters.
protected void	readLoop()
protected final String[]	sendCommand(String packet, boolean oneWord)
boolean	sendIrCommand(String remote, String command, int count, int connector)
boolean	sendIrCommand(String remote, String command, int count, Transmitter transmitter)	Sends the command to the hardware, to be sent count number of times.
boolean	sendIrCommandRepeat(String remote, String command, Transmitter transmitter)	Like sendIr, but sends the IR signal until stopped by stopIr.
void	setDebug(int debug)	Sets a debug parameter.
void	setTimeout(int timeout)	Set timeout in milliseconds.
boolean	setTransmitters(boolean[] ports)
boolean	setTransmitters(int port)
boolean	setTransmitters(Transmitter transmitter)	Sends the SET_TRANSMITTER command to the LIRC server.
void	setVerbose(boolean verbose)	Sets a verbosity flag, causing commands to be executed verbosely.
boolean	stopIr(String remote, String command, int port)
boolean	stopIr(String remote, String command, Transmitter transmitter)
boolean	stopIr(Transmitter transmitter)	Stops ongoing IR transmission.

Methods inherited from class java.lang.Object

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

Field Details

lircDefaultPort

public static final int lircDefaultPort

See Also:

• Constant Field Values

defaultLircIP

public static final String defaultLircIP

See Also:

• Constant Field Values

defaultTimeout

public static final int defaultTimeout

See Also:

• Constant Field Values

Constructor Details

LircClient

public LircClient(InetAddress hostname,
 Integer port,
 boolean verbose,
 Integer timeout)
           throws IOException

Throws:

IOException

LircClient

public LircClient(String hostname,
 Integer port,
 boolean verbose,
 Integer timeout)
           throws UnknownHostException,
IOException

Throws:

UnknownHostException

IOException

LircClient

public LircClient(InetAddress hostname,
 boolean verbose,
 Integer timeout)
           throws IOException

Throws:

IOException

LircClient

public LircClient(InetAddress hostname,
 boolean verbose)
           throws IOException

Throws:

IOException

LircClient

public LircClient(InetAddress hostname)
           throws IOException

Throws:

IOException

LircClient

public LircClient(String hostname)
           throws UnknownHostException,
IOException

Throws:

UnknownHostException

IOException

Method Details

main

public static void main(String[] args)

Parameters:

args - the command line arguments.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

open

public void open()

Description copied from interface: IHarcHardware

Opens the device with previously set parameters.

Specified by:

open in interface IHarcHardware

getTransmitter

public LircTransmitter getTransmitter()

Description copied from interface: IRemoteCommandIrSender

Returns a default Transmitter for the device. May be null if the device ignores the Transmitter argument in sendIr.

Specified by:

getTransmitter in interface IRemoteCommandIrSender

Specified by:

getTransmitter in interface ITransmitter

Returns:

Transmitter

getTransmitter

public LircTransmitter getTransmitter(int portNo)
                               throws NoSuchTransmitterException

Throws:

NoSuchTransmitterException

getTransmitter

public LircTransmitter getTransmitter(String port)
                               throws NoSuchTransmitterException

Description copied from interface: ITransmitter

Parses the String argument, and returns a transmitter accordingly. Syntax and semantics may vary.

Specified by:

getTransmitter in interface ITransmitter

Parameters:

port - String describing desired port. Syntax is dependent on the implementing class.

Returns:

Transmitter

Throws:

NoSuchTransmitterException

getTransmitterNames

public String[] getTransmitterNames()

Description copied from interface: ITransmitter

Return possible name of transmitters, that are guaranteed to work with the getTransmitter(String). This may be generated by inquiring the device, producing correct result, or it may be some static function, describing transmitters not necessarily present on the actually deployed device.

Specified by:

getTransmitterNames in interface ITransmitter

Returns:

Array of strings that are guaranteed to work with the getTransmitter(String)

setVerbose

public void setVerbose(boolean verbose)

Description copied from interface: IHarcHardware

Sets a verbosity flag, causing commands to be executed verbosely. Exact semantic depends on the implementation. Typically, all communication with the device is echoed to stderr.

Specified by:

setVerbose 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

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

Parameters:

timeout - Timeout in milliseconds.

readLoop

protected void readLoop()
                 throws IOException

Throws:

IOException

sendCommand

protected final String[] sendCommand(String packet,
 boolean oneWord)
                              throws IOException

Throws:

IOException

sendIrCommand

public boolean sendIrCommand(String remote,
 String command,
 int count,
 Transmitter transmitter)
                      throws IOException,
NoSuchTransmitterException

Description copied from interface: IRemoteCommandIrSender

Sends the command to the hardware, to be sent count number of times.

Specified by:

sendIrCommand in interface IRemoteCommandIrSender

count - Number of times to repeat the command

Returns:

success

Throws:

IOException

NoSuchTransmitterException

sendIrCommand

public boolean sendIrCommand(String remote,
 String command,
 int count,
 int connector)
                      throws IOException,
NoSuchTransmitterException

Throws:

IOException

NoSuchTransmitterException

sendIrCommandRepeat

public boolean sendIrCommandRepeat(String remote,
 String command,
 Transmitter transmitter)
                            throws IOException,
NoSuchTransmitterException

Description copied from interface: IRemoteCommandIrSender

Like sendIr, but sends the IR signal until stopped by stopIr. An implementation, or a hardware, may limit the number of repeats though.

Specified by:

sendIrCommandRepeat in interface IRemoteCommandIrSender

Returns:

Throws:

IOException

NoSuchTransmitterException

stopIr

public boolean stopIr(String remote,
 String command,
 Transmitter transmitter)
               throws IOException,
NoSuchTransmitterException

Throws:

IOException

NoSuchTransmitterException

stopIr

public boolean stopIr(String remote,
 String command,
 int port)
               throws IOException,
NoSuchTransmitterException

Throws:

IOException

NoSuchTransmitterException

stopIr

public boolean stopIr(Transmitter transmitter)
               throws IOException,
NoSuchTransmitterException

Description copied from interface: IIrSenderStop

Stops ongoing IR transmission.

Specified by:

stopIr in interface IIrSenderStop

Returns:

if false, command failed.

Throws:

IOException

NoSuchTransmitterException

getRemotes

public String[] getRemotes()
                    throws IOException

Description copied from interface: IRemoteCommandIrSender

Returns an array of "remote" names.

Specified by:

getRemotes in interface IRemoteCommandIrSender

Returns:

Throws:

IOException

getCommands

public String[] getCommands(String remote)
                     throws IOException

Description copied from interface: IRemoteCommandIrSender

Returns an array of command names for the remote given in the argument.

Specified by:

getCommands in interface IRemoteCommandIrSender

Parameters:

remote - The "remote" to search in

Returns:

Throws:

IOException

setTransmitters

public boolean setTransmitters(Transmitter transmitter)
                        throws NoSuchTransmitterException,
IOException

Sends the SET_TRANSMITTER command to the LIRC server.

Parameters:

transmitter -

Returns:

Throws:

IOException

NoSuchTransmitterException

setTransmitters

public boolean setTransmitters(int port)
                        throws NoSuchTransmitterException,
IOException

Throws:

NoSuchTransmitterException

IOException

setTransmitters

public boolean setTransmitters(boolean[] ports)
                        throws NoSuchTransmitterException,
IOException

Throws:

NoSuchTransmitterException

IOException

getVersion

public String getVersion()
                  throws IOException

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.

Throws:

IOException

isValid

public boolean isValid()

Dummy implementation, always returns true

Specified by:

isValid in interface IHarcHardware

Returns:

true