When working with relays it is often useful to test relay commands and control directly through iTest (available on our Downloads Page).
Setstate commands
Global Caché Relay products respond to setstate commands. Setstate commands have the following format:
`setstate,<module>:<connector>,<state>`
Where <module>, <connector>, and <state> are replaced with their appropriate values as defined below (please proceed to the heading that matches your relay product).
Global Connect Relay Module
On the Global Connect relay module the <module> is always 1. There are 6 relays, so <connector> can be any value 1 through 6. The <state> value can either be 1 (on), or 0 (off).
This gives us the following possible setstate commands:
On Commands | Off Commands |
setstate,1:1,1 | setstate,1:1,0 |
setstate,1:2,1 | setstate,1:2,0 |
setstate,1:3,1 | setstate,1:3,0 |
setstate,1:4,1 | setstate,1:4,0 |
setstate,1:5,1 | setstate,1:5,0 |
setstate,1:6,1 | setstate,1:6,0 |
iTach Flex - Flex Link Relay and Sensor Cable
On the Flex the relay <module> is always 1. There are 4 relays, so <connector> can be 1, 2, 3, or 4. The <state> value can either be 1 (on), or 0 (off) if the relays are configured for SPST mode, or 0 (off), 1 (1st throw), or 2 (2nd throw) if the relays are configured for SPDT or DPDT relay types.
The relay types can be configured in the web interface.
This gives us the following possible setstate commands:
Relay Type | On/1st throw commands | NA/2nd throw commands | Off commands |
SPST | setstate,1:1,1 | setstate,1:1,0 | |
SPST | setstate,1:2,1 | setstate,1:2,0 | |
SPST | setstate,1:3,1 | setstate,1:3,0 | |
SPST | setstate,1:4,1 | setstate,1:4,0 | |
SPDT/DPDT | setstate,1:1,1 | setstate,1:1,2 | setstate,1:1,0 |
SPDT/DPDT | setstate,1:2,1 | setstate,1:2,2 | setstate,1:2,0 |
SPDT/DPDT | setstate,1:3,1 | setstate,1:3,2 | setstate,1:3,0 |
SPDT/DPDT | setstate,1:4,1 | setstate,1:4,2 | setstate,1:4,0 |
Note: Most users will be using relays in SPST configuration in which cases the bottom half of the above table can be ignored.
iTach IP2CC/WF2CC
On the iTach relay products the <module> is always 1. There are 3 relays, so <connector> can be 1, 2, or 3. The <state> value can either be 1 (on), or 0 (off).
This gives us the following possible setstate commands:
On Commands | Off Commands |
setstate,1:1,1 | setstate,1:1,0 |
setstate,1:2,1 | setstate,1:2,0 |
setstate,1:3,1 | setstate,1:3,0 |
GC-100-12/18/18R
On the GC-100 family of products the relays are on <module> 2. There are 3 relays, so <connector> can be 1, 2, or 3. The <state> value can either be 1 (on), or 0 (off).
This gives us the following possible setstate commands:
On Commands | Off Commands |
setstate,3:1,1 | setstate,3:1,0 |
setstate,3:2,1 | setstate,3:2,0 |
setstate,3:3,1 | setstate,3:3,0 |
Testing relays using iTest
To test relays through iTest perform the following steps with iTest open:
- Enter the unit's IP address in the IP Address field.
- Select the "Command (4998)" radio button.
- Click "Connect".
- Paste or type the desired setstate command (as defined above) in the Command String field.
- Click "Send".
After sending a setstate command the ASCII response field should display a `state,...` response confirming the set state. If the unit has LEDs above the relays those will also light up or turn off to follow the state of the relay.
0 Comments