Codecore Logo
Quick Search
»
Advanced Search »

Global Caché Driver

RSS
Image
The Global Caché GC-100 is a network device allowing for sending, receiving and learning infrared (IR) signals and carrying them over a network. The optional GC-IRE and GC-IRL peripherals are used to receive infrared signals and are supported when connected to a GC-100.

Important: If connecting a GC-IRL or GC-IRE to the serial port on the GC100, select 9600 baud, no parity, and no flow control in the GC100's web setup interface.

Example uses of this driver:

  • Send infrared commands as the result of an event.
    • Turn on your stereo at a certain time
    • Turn off your stereo when when you arm your burglar alarm to away mode.
  • Use received infrared commands as a rule trigger.
    • Turn off your lights when a designated infrared signal is received.
  • Build up your infrared command library by learning new commands.

For a detailed look at managing your infrared library click here.

Tip: The recommended practice for sending an infrared command (invoking an IR code sequence) from a script is to reference the code sequence stored in the Infrared Library as follows (See Dynamic Instance Properties for details):

gc100.SonyTV.PowerOn();

Manufacturer: Global Caché


Driver Parameters

  • HostName: The host name or ip address of the Global Caché GC-100.
  • Port: (optional) The port. Defaults to 4998.

Events

ReceivedIR

Occurs when an infrared command is received.

Parameters:

InfraredCommandName: The infrared device and infrared command name to filter on using the following format: irdevicename.ircommandname

Example:
SonyTV.PowerOn

ProntoIRSequence: The Pronto CCF ir code sequence to filter on.

InfraredCommandName and ProntoIRSequence are mutually exclusive, so only use one of them.

EventArgs Properties:

>
Property NameTypeRead/WriteDescription
FrequencyNumberRead OnlyGets the IR carrier frequency.
OnOffCodeSequenceNumberRead OnlyGets the on/off code sequence values as a comma delimited list.
ProntoIRSequenceNumberRead OnlyGets the complete Pronto format IR Code Sequence.

SensorStateChanged

Occurs when a sensor port state changes.

Parameters:

none

EventArgs Properties:

>
Property NameTypeRead/WriteDescription
StateBooleanRead OnlyGets the new state of the sensor.
ModuleIDNumberRead OnlyGets the module id that the sensor belongs to.
PortIndexNumberRead OnlyGets the port index of the sensor (1-3).

Instance Properties

Property NameTypeRead/WriteDescription
FirmwareStringRead OnlyGets the firmware version.
OutputNamesArray of String elementsArray: Read Only
Elements: Read Only
Gets an array of output/relay names.
OutputStatesArray of Boolean elementsArray: Read Only
Elements: Read/Write
Gets an array output/relay states.
ModuleCountNumberRead OnlyGets the # of modules.
OutputCountNumberRead OnlyGets the # of output/relays.
SerialPortCountNumberRead OnlyGets the # of serial ports.
IRPortCountNumberRead OnlyGets the # of ir/sensor ports.
ConnectedBooleanRead OnlyGets a value indicating if a the driver is connected to the Global Cache hardware.

Dynamic Instance Properties

During configuration infrared devices can be associated with the Global Caché GC-100. Each infrared device associated with the Global Caché Device can be referenced as a property and used to send IR code sequences. This is a simpler alternative to using the Send..IR instance methods.

For example if you have assigned a Sony XB1 TV to the Global Caché device and named it "SonyTV", you can reference it as a property of the Global Caché device as follows:

gc100.SonyTV

Each IR Device also contains a method for each IR Code Sequence. So for example the "SonyTV" may contain "PowerOn" and "ChannelUp" IR Code sequences. To send IR code sequence for the "SonyTV" "PowerOn", run the following script:

gc100.SonyTV.PowerOn();

More Examples:


gc100.SonyTV.PowerOn();
gc100.SonyTV.ChannelUp();
gc100.SonyTV.Menu();

gc100.CDPlayer.PowerOn();
gc100.CDPlayer.Next();

Instance Methods

SendNativeIR(Number, String)

Sends a native Global Caché IR command to the Nth IR/Sensor port.

It is recommended that the Dynamic Instance Properties which take advantage of the IR Library be used to send infrared commands, as opposed to this function.

Syntax:

void SendNativeIR(Number irPortIndex, String irCommandData)

Parameters:

irPortIndex: The index of th IR/Sensor port (base 1).

irCommandData: The IR command data to send. <frequency>,<count>,<offset>,<on1>,<off1>,<on2>,<off2>,...,onN,offN. (where N is less than 128 or a total of 256 numbers)

Example:

gc100.SendNativeIR(1, "...");

SendNativeIR(Number, Number, String)

Sends a native Global Caché IR command to the Nth IR/Sensor port.

It is recommended that the Dynamic Instance Properties which take advantage of the IR Library be used to send infrared commands, as opposed to this function.

Syntax:

void SendNativeIR(Number moduleID, Number moduleIRPortID, String irCommandData)

Parameters:

moduleID: The index of the moduleID.

moduleIRPortID: The index of th IR/Sensor port in the specified module. 1-N

irCommandData: The IR command data to send. <frequency>,<count>,<offset>,<on1>,<off1>,<on2>,<off2>,...,onN,offN. (where N is less than 128 or a total of 256 numbers)

Example:

gc100.SendNativeIR(1, 1, "...");

SendProntoIR(Number, String)

Sends a Pronto CCF IR code sequence to the Nth IR/Sensor port.

It is recommended that the Dynamic Instance Properties which take advantage of the IR Library be used to send infrared commands, as opposed to this function.

Syntax:

void SendProntoIR(String prontoCcfIRCodeSequence, String repeatCount)

Parameters:

irPortIndex: The index of th IR/Sensor port (base 1).

prontoCcfIRCodeSequence: The Pronto CCF IR code sequence to send. This should be in the format XXXX XXXX XXXX...

Example:

gc100.SendProntoIR(1, "...");

SendProntoIR(Number, Number, String)

Sends a Pronto CCF IR code sequence.

It is recommended that the Dynamic Instance Properties which take advantage of the IR Library be used to send infrared commands, as opposed to this function.

Syntax:

void SendProntoIR(Number zoneID, String prontoCcfIRCodeSequence, Number repeatCount)

Parameters:

moduleID: The index of the moduleID.

moduleIRPortID: The index of th IR/Sensor port in the specified module. 1-N

prontoCcfIRCodeSequence: The Pronto CCF IR code sequence to send. This should be in the format XXXX XXXX XXXX...

Example:

gc100.SendProntoIR(1, 1, "...");

SendRawCommand

Sends a command that may otherwise not be supported by the driver.

Syntax:

void SendRawCommand(String command)

Parameters:

command: The command data to send (without the <cr> terminator.)

Example:

gc100.SendRawCommand("...");

SendRawSerialCommand

Sends a command that may otherwise not be supported by the driver to a serial port on the GC-100.

Syntax:

void SendRawSerialCommand(String command, Number serialPortIndex)

Parameters:

command: The command data to send (without the <cr> terminator.)

serialPortIndex: The index of the serial port. Base 1 index.

Example:

gc100.SendRawSerialCommand("gv", 1); // get GR-IRE version

TurnOnOutput

Turns on an output/relay.

Syntax:

void TurnOnOutput(Number outputID)

Parameters:

outputID: The ID of the output/relay to turn on.

Example:

gc100.TurnOnOutput(1);

TurnOffOutput

Turns off an output/relay.

Syntax:

void TurnOffOutput(Number outputID)

Parameters:

outputID: The ID of the output/relay to turn off.

Example:

gc100.TurnOffOutput(1);

TurnOnBlink

Starts blinking the power LED. This is especially helpful in a rack mount situation where the installer may need to positively identify a particular GC-100.

Syntax:

void TurnOnBlink( )

Example:

gc100.TurnOnBlink();

TurnOffBlink

Stops blinking the power LED.

Syntax:

void TurnOffBlink( )

Example:

gc100.TurnOffBlink();
Privacy Policy | Conditions Of Use

Copyright ©2014 Codecore Technologies, All rights reserved.