Package org.harctoolbox.harchardware.ir

Class IrTrans

java.lang.Object

org.harctoolbox.harchardware.ir.IrTrans

All Implemented Interfaces:

Closeable, AutoCloseable, IWeb, IHarcHardware, IRawIrSender, ITransmitter

Direct Known Subclasses:

IrTransIRDB

public class IrTrans
extends Object
implements IHarcHardware, IRawIrSender, ITransmitter, IWeb

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	IrTrans.Interface	Interface that can be used to command an IrTrans unit
static class	IrTrans.IrTransTransmitter
static enum	IrTrans.Led	IR LEDs on the IrTrans

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_IP
protected static final int	defaultTimeout
protected static final int	dummyDelay
protected InetAddress	inetAddress
protected IrTrans.Interface	interfaze
static final int	portNumber	port number, not possible to change.
protected int	timeout
protected boolean	verbose

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

repeatMax

Constructor Summary

Constructors

Constructor	Description
IrTrans(String hostname)
IrTrans(InetAddress hostname)
IrTrans(InetAddress hostname, boolean verbose)
IrTrans(InetAddress hostname, boolean verbose, Integer timeout)
IrTrans(InetAddress inetAddress, boolean verbose, Integer timeout, IrTrans.Interface interfaze)
IrTrans(InetAddress inetAddress, Integer port, boolean verbose, Integer timeout)

Method Summary

Modifier and Type	Method	Description
void	close()
static String	expandIP(String ip)
IrTrans.IrTransTransmitter	getTransmitter()	Returns a default Transmitter for the device.
IrTrans.IrTransTransmitter	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).
URI	getUri(String user, String password)	Returns an URI to be used for browsing the device, possibly containing user and password information.
protected boolean	getUrl(String url)
String	getVersion()	Returns the hardware version (not the version of the driver software).
boolean	isValid()	Checks validity of an instance.
static void	main(String[] args)
IrTrans.IrTransTransmitter	newTransmitter(IrTrans.Led led)
void	open()	Opens the device with previously set parameters.
boolean	sendCcf(String ccf, int count, IrTrans.Led led)
boolean	sendCcf(String ccf, int count, Transmitter transmitter)
boolean	sendCcfRepeat(String ccf, Transmitter transmitter)
protected String	sendCommand(String cmd)
protected boolean	sendCommandUdp(String cmd)
boolean	sendIr(org.harctoolbox.ircore.IrSignal code, int count, IrTrans.Led led)
boolean	sendIr(org.harctoolbox.ircore.IrSignal code, int count, Transmitter transmitter)
void	setDebug(int debug)	Sets a debug parameter.
void	setTimeout(int timeout)	Set timeout in milliseconds.
void	setVerbose(boolean verbose)	Sets a verbosity flag, causing commands to be executed verbosely.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_IP

public static final String DEFAULT_IP

See Also:

• Constant Field Values

dummyDelay

protected static final int dummyDelay

See Also:

• Constant Field Values

defaultTimeout

protected static final int defaultTimeout

See Also:

• Constant Field Values

portNumber

public static final int portNumber

port number, not possible to change.

See Also:

• Constant Field Values

timeout

protected int timeout

inetAddress

protected InetAddress inetAddress

verbose

protected boolean verbose

interfaze

protected IrTrans.Interface interfaze

Constructor Details

IrTrans

public IrTrans(InetAddress inetAddress,
 boolean verbose,
 Integer timeout,
 IrTrans.Interface interfaze)

Parameters:

inetAddress -

verbose -

timeout -

interfaze -

IrTrans

public IrTrans(InetAddress inetAddress,
 Integer port,
 boolean verbose,
 Integer timeout)

IrTrans

public IrTrans(InetAddress hostname,
 boolean verbose,
 Integer timeout)

IrTrans

public IrTrans(InetAddress hostname,
 boolean verbose)

IrTrans

public IrTrans(InetAddress hostname)

IrTrans

public IrTrans(String hostname)
        throws UnknownHostException

Throws:

UnknownHostException

Method Details

main

public static void main(String[] args)

expandIP

public static String expandIP(String ip)

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

getUri

public URI getUri(String user,
 String password)

Description copied from interface: IWeb

Returns an URI to be used for browsing the device, possibly containing user and password information.

Specified by:

getUri in interface IWeb

Returns:

open

public void open()

Description copied from interface: IHarcHardware

Opens the device with previously set parameters.

Specified by:

open in interface IHarcHardware

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

getTransmitter

public IrTrans.IrTransTransmitter getTransmitter()

Description copied from interface: IRawIrSender

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

Specified by:

getTransmitter in interface IRawIrSender

Specified by:

getTransmitter in interface ITransmitter

Returns:

Transmitter

newTransmitter

public IrTrans.IrTransTransmitter newTransmitter(IrTrans.Led led)

getTransmitter

public IrTrans.IrTransTransmitter 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)

isValid

public boolean isValid()

Description copied from interface: IHarcHardware

Checks validity of an instance. Exact meaning can vary.

Specified by:

isValid in interface IHarcHardware

Returns:

validity of the instance.

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

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.

sendCommand

protected String sendCommand(String cmd)
                      throws IOException

Throws:

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

getUrl

protected boolean getUrl(String url)
                  throws MalformedURLException,
IOException

Throws:

MalformedURLException

IOException

sendCommandUdp

protected boolean sendCommandUdp(String cmd)
                          throws IOException

Throws:

IOException

sendCcf

public boolean sendCcf(String ccf,
 int count,
 IrTrans.Led led)
                throws IOException

Throws:

IOException

sendCcf

public boolean sendCcf(String ccf,
 int count,
 Transmitter transmitter)
                throws IOException,
NoSuchTransmitterException

Throws:

IOException

NoSuchTransmitterException

sendCcfRepeat

public boolean sendCcfRepeat(String ccf,
 Transmitter transmitter)
                      throws IOException,
NoSuchTransmitterException

Throws:

IOException

NoSuchTransmitterException

sendIr

public boolean sendIr(org.harctoolbox.ircore.IrSignal code,
 int count,
 IrTrans.Led led)
               throws IOException

Throws:

IOException

sendIr

public boolean sendIr(org.harctoolbox.ircore.IrSignal code,
 int count,
 Transmitter transmitter)
               throws IOException,
NoSuchTransmitterException

Specified by:

sendIr in interface IRawIrSender

Returns:

if false, command failed.

Throws:

IOException

NoSuchTransmitterException