Package org.harctoolbox.harchardware.ir

Class GlobalCache

java.lang.Object

org.harctoolbox.harchardware.ir.GlobalCache

All Implemented Interfaces:

Closeable, AutoCloseable, IWeb, IHarcHardware, ICapture, IIrReader, IIrSenderStop, IRawIrSender, ITransmitter

public class GlobalCache
extends Object
implements IHarcHardware, IRawIrSender, IIrSenderStop, ITransmitter, ICapture, IWeb

This class implements the GlobalCache TCP Unified TCP API (Version 1.1), according to the official API documentation. This covers the models GC-100, iTach, Flex and Global Connect.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GlobalCache.GlobalCacheIrTransmitter
static enum	GlobalCache.IrConfiguration	Possible arguments to the set_IR command.
static enum	GlobalCache.ModuleType
class	GlobalCache.SerialPort

Field Summary

Fields

Modifier and Type	Field	Description
static final int	connectorMin
static final int	connectorsPerModule
static final String	DEFAULT_IP
static final int	defaultGlobalCachePort
static final int	maxCompressedLetters
static final String	sendIrPrefix

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

DEFAULT_BEGIN_TIMEOUT, DEFAULT_CAPTURE_MAXSIZE, DEFAULT_ENDING_TIMEOUT

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

repeatMax

Constructor Summary

Constructors

Constructor	Description
GlobalCache(String hostname)
GlobalCache(String hostname, boolean verbose)
GlobalCache(String hostname, boolean verbose, boolean compressed)
GlobalCache(String hostIp, boolean verbose, Integer timeout)
GlobalCache(String hostIp, boolean verbose, Integer timeout, boolean compressed)
GlobalCache(InetAddress inetAddress, boolean verbose, Integer timeout, boolean compressed)
GlobalCache(InetAddress inetAddress, boolean verbose, Integer portNumber, Integer timeout)
GlobalCache(InetAddress inetAddress, Integer portIsNotUsed, boolean verbose, Integer timeout)

Method Summary

Modifier and Type	Method	Description
org.harctoolbox.ircore.ModulatedIrSequence	capture()	Listens to the device and returns a sequence.
void	close()
static String	expandIP(String IP)
String[]	getDevices()
String	getIp()
String	getIr(int module, int connector)
final List<Integer>	getIrModules()
int	getModuleSecondNumber(int moduleNumber)
String	getNet()
final List<Integer>	getRelayModules()
String	getSerial()
String	getSerial(int module)
final List<Integer>	getSerialModules()
GlobalCache.SerialPort	getSerialPort(int portNumber)	Returns a serial port from the GlobalCache.
int	getState(int connector)
int	getState(int module, int connector)
GlobalCache.GlobalCacheIrTransmitter	getTransmitter()	Returns a default Transmitter for the device.
GlobalCache.GlobalCacheIrTransmitter	getTransmitter(String str)	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.
String	getVersion()	Returns the hardware version (not the version of the driver software).
String	getVersion(int module)
boolean	isValid()	Checks validity of an instance.
static AmxBeaconListener.Node	listenBeacon()
static AmxBeaconListener.Node	listenBeacon(int timeout)
static void	main(String[] args)
static AmxBeaconListener	newListener(AmxBeaconListener.Callback callback)
GlobalCache.GlobalCacheIrTransmitter	newTransmitter(int cardinal)
GlobalCache.GlobalCacheIrTransmitter	newTransmitter(int module, int port)
final void	open()	Opens the device with previously set parameters.
static org.harctoolbox.ircore.IrSignal	parse(String gcString)	Parses a string intended as command to a GlobalCache and return it as a IrSignal.
boolean	pulseState(int connector)
boolean	pulseState(int module, int connector)
boolean	sendIr(String cmd)
boolean	sendIr(org.harctoolbox.ircore.IrSignal code)
boolean	sendIr(org.harctoolbox.ircore.IrSignal code, int connector)
boolean	sendIr(org.harctoolbox.ircore.IrSignal code, int count, int connector)
boolean	sendIr(org.harctoolbox.ircore.IrSignal code, int count, int module, int connector)
boolean	sendIr(org.harctoolbox.ircore.IrSignal code, int count, Transmitter transmitter)
String	sendIrString(org.harctoolbox.ircore.IrSignal code, int count, int module, int connector)
static String	sendIrString(org.harctoolbox.ircore.IrSignal code, int count, int module, int connector, int sendIndex, boolean compressed)	Formats a string suitable for sending to a GlobalCache.
void	setBeginTimeout(int timeout)
void	setBlink(int arg)
void	setCaptureMaxSize(int integer)
void	setCompressed(boolean compressed)
void	setDebug(int debug)	Sets a debug parameter.
void	setEndingTimeout(int integer)
String	setIr(int module, int connector, String modestr)
String	setIr(int module, int connector, GlobalCache.IrConfiguration mode)
String	setNet(String arg)
String	setSerial(int baudrate)
String	setSerial(int module, int baudrate)
String	setSerial(int module, String arg)
String	setSerial(String arg)
boolean	setState(int connector, boolean onOff)
boolean	setState(int connector, int state)
boolean	setState(int module, int connector, int state)
void	setTimeout(int timeout)	Set timeout in milliseconds.
void	setVerbose(boolean verbose)	Sets a verbosity flag, causing commands to be executed verbosely.
boolean	stopCapture()	Signals the capturing device that it should stop capturing.
boolean	stopIr(int module, int connector)
boolean	stopIr(Transmitter transmitter)	Stops ongoing IR transmission.
boolean	toggleState(int connector)
boolean	toggleState(int module, int connector)

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

defaultGlobalCachePort

public static final int defaultGlobalCachePort

See Also:

• Constant Field Values

sendIrPrefix

public static final String sendIrPrefix

See Also:

• Constant Field Values

connectorMin

public static final int connectorMin

See Also:

• Constant Field Values

connectorsPerModule

public static final int connectorsPerModule

See Also:

• Constant Field Values

maxCompressedLetters

public static final int maxCompressedLetters

See Also:

• Constant Field Values

Constructor Details

GlobalCache

public GlobalCache(InetAddress inetAddress,
 boolean verbose,
 Integer timeout,
 boolean compressed)
            throws IOException

Throws:

IOException

GlobalCache

public GlobalCache(String hostIp,
 boolean verbose,
 Integer timeout,
 boolean compressed)
            throws UnknownHostException,
IOException

Throws:

UnknownHostException

IOException

GlobalCache

public GlobalCache(InetAddress inetAddress,
 Integer portIsNotUsed,
 boolean verbose,
 Integer timeout)
            throws IOException

Throws:

IOException

GlobalCache

public GlobalCache(InetAddress inetAddress,
 boolean verbose,
 Integer portNumber,
 Integer timeout)
            throws IOException

Throws:

IOException

GlobalCache

public GlobalCache(String hostIp,
 boolean verbose,
 Integer timeout)
            throws UnknownHostException,
IOException

Throws:

UnknownHostException

IOException

GlobalCache

public GlobalCache(String hostname)
            throws UnknownHostException,
IOException

Throws:

UnknownHostException

IOException

GlobalCache

public GlobalCache(String hostname,
 boolean verbose,
 boolean compressed)
            throws UnknownHostException,
IOException

Throws:

UnknownHostException

IOException

GlobalCache

public GlobalCache(String hostname,
 boolean verbose)
            throws UnknownHostException,
IOException

Throws:

UnknownHostException

IOException

Method Details

expandIP

public static String expandIP(String IP)

sendIrString

public static String sendIrString(org.harctoolbox.ircore.IrSignal code,
 int count,
 int module,
 int connector,
 int sendIndex,
 boolean compressed)
                           throws NoSuchTransmitterException

Formats a string suitable for sending to a GlobalCache.

Parameters:

code -

count -

module -

connector -

sendIndex -

compressed -

Returns:

Throws:

NoSuchTransmitterException

listenBeacon

public static AmxBeaconListener.Node listenBeacon(int timeout)

listenBeacon

public static AmxBeaconListener.Node listenBeacon()

newListener

public static AmxBeaconListener newListener(AmxBeaconListener.Callback callback)

parse

public static org.harctoolbox.ircore.IrSignal parse(String gcString)
                                             throws org.harctoolbox.ircore.InvalidArgumentException

Parses a string intended as command to a GlobalCache and return it as a IrSignal. Presently only the uncompressed form is parsed.

Parameters:

gcString -

Returns:

IrSignal representing the signal, with begin and repeat part.

Throws:

org.harctoolbox.ircore.InvalidArgumentException

main

public static void main(String[] args)
                 throws org.harctoolbox.ircore.InvalidArgumentException

Throws:

org.harctoolbox.ircore.InvalidArgumentException

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:

getSerialPort

public GlobalCache.SerialPort getSerialPort(int portNumber)
                                     throws NoSuchTransmitterException

Returns a serial port from the GlobalCache.

Parameters:

portNumber - 1-based port number, i.e. use 1 for first, not 0.

Returns:

serial port implementing ICommandLineDevice

Throws:

NoSuchTransmitterException

getTransmitter

public GlobalCache.GlobalCacheIrTransmitter getTransmitter(String str)
                                                    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:

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

Returns:

Transmitter

Throws:

NoSuchTransmitterException

getTransmitter

public GlobalCache.GlobalCacheIrTransmitter 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 GlobalCache.GlobalCacheIrTransmitter newTransmitter(int module,
 int port)
                                                    throws NoSuchTransmitterException

Throws:

NoSuchTransmitterException

newTransmitter

public GlobalCache.GlobalCacheIrTransmitter newTransmitter(int cardinal)
                                                    throws NoSuchTransmitterException

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)

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.

open

public final void open()
                throws UnknownHostException,
IOException

Description copied from interface: IHarcHardware

Opens the device with previously set parameters.

Specified by:

open in interface IHarcHardware

Throws:

IOException

UnknownHostException

getIp

public String getIp()

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

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

setCompressed

public void setCompressed(boolean compressed)

stopIr

public boolean stopIr(int module,
 int connector)
               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

sendIr

public boolean sendIr(String cmd)
               throws IOException

Throws:

IOException

sendIrString

public String sendIrString(org.harctoolbox.ircore.IrSignal code,
 int count,
 int module,
 int connector)
                    throws NoSuchTransmitterException

Throws:

NoSuchTransmitterException

sendIr

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

Throws:

NoSuchTransmitterException

IOException

sendIr

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

Throws:

IOException

NoSuchTransmitterException

sendIr

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

Throws:

IOException

NoSuchTransmitterException

sendIr

public boolean sendIr(org.harctoolbox.ircore.IrSignal code)
               throws IOException,
NoSuchTransmitterException

Throws:

IOException

NoSuchTransmitterException

sendIr

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

Specified by:

sendIr in interface IRawIrSender

Returns:

if false, command failed.

Throws:

NoSuchTransmitterException

IOException

getDevices

public String[] getDevices()

getVersion

public String getVersion(int module)
                  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

getNet

public String getNet()
              throws IOException

Throws:

IOException

setNet

public String setNet(String arg)
              throws IOException

Throws:

IOException

getIr

public String getIr(int module,
 int connector)
             throws IOException,
NoSuchTransmitterException

Throws:

IOException

NoSuchTransmitterException

getModuleSecondNumber

public int getModuleSecondNumber(int moduleNumber)

getIrModules

public final List<Integer> getIrModules()

getSerialModules

public final List<Integer> getSerialModules()

getRelayModules

public final List<Integer> getRelayModules()

setIr

public String setIr(int module,
 int connector,
 String modestr)
             throws IOException,
NoSuchTransmitterException

Throws:

IOException

NoSuchTransmitterException

setIr

public String setIr(int module,
 int connector,
 GlobalCache.IrConfiguration mode)
             throws IOException,
NoSuchTransmitterException

Throws:

IOException

NoSuchTransmitterException

getSerial

public String getSerial(int module)
                 throws IOException

Throws:

IOException

getSerial

public String getSerial()
                 throws IOException

Throws:

IOException

setSerial

public String setSerial(int module,
 String arg)
                 throws IOException

Throws:

IOException

setSerial

public String setSerial(String arg)
                 throws IOException

Throws:

IOException

setSerial

public String setSerial(int module,
 int baudrate)
                 throws IOException

Throws:

IOException

setSerial

public String setSerial(int baudrate)
                 throws IOException

Throws:

IOException

getState

public int getState(int module,
 int connector)
             throws IOException,
NoSuchTransmitterException

Throws:

IOException

NoSuchTransmitterException

getState

public int getState(int connector)
             throws IOException,
NoSuchTransmitterException

Throws:

IOException

NoSuchTransmitterException

toggleState

public boolean toggleState(int module,
 int connector)
                    throws IOException,
NoSuchTransmitterException

Throws:

IOException

NoSuchTransmitterException

toggleState

public boolean toggleState(int connector)
                    throws IOException,
NoSuchTransmitterException

Throws:

IOException

NoSuchTransmitterException

setState

public boolean setState(int module,
 int connector,
 int state)
                 throws IOException,
NoSuchTransmitterException

Throws:

IOException

NoSuchTransmitterException

setState

public boolean setState(int connector,
 int state)
                 throws IOException,
NoSuchTransmitterException

Throws:

IOException

NoSuchTransmitterException

setState

public boolean setState(int connector,
 boolean onOff)
                 throws IOException,
NoSuchTransmitterException

Throws:

IOException

NoSuchTransmitterException

pulseState

public boolean pulseState(int module,
 int connector)
                   throws NoSuchTransmitterException,
IOException

Parameters:

module -

connector -

Returns:

Throws:

IOException

NoSuchTransmitterException

pulseState

public boolean pulseState(int connector)
                   throws NoSuchTransmitterException,
IOException

Parameters:

connector -

Returns:

Throws:

IOException

NoSuchTransmitterException

setBlink

public void setBlink(int arg)
              throws IOException

Throws:

IOException

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.

capture

public org.harctoolbox.ircore.ModulatedIrSequence capture()
                                                   throws org.harctoolbox.ircore.InvalidArgumentException

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:

org.harctoolbox.ircore.OddSequenceLengthException

org.harctoolbox.ircore.InvalidArgumentException

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

setBeginTimeout

public void setBeginTimeout(int timeout)
                     throws IOException

Specified by:

setBeginTimeout in interface IIrReader

Throws:

IOException

setCaptureMaxSize

public void setCaptureMaxSize(int integer)

Specified by:

setCaptureMaxSize in interface IIrReader

setEndingTimeout

public void setEndingTimeout(int integer)

Specified by:

setEndingTimeout in interface IIrReader