Driver Details

SurgeX Squid

By: RTI
Updated: March 3, 2023
Version: 1.0

Description:

This driver supports the Squid line of SurgeX power controllers.

Version History:

Version 1.0: Initial Release

SurgeX Squid Driver

This driver controls the SurgeX Squid Range.

Update history

V1.0 initial realease

Driver Configuration

IP Address – Enter the IP Address of the squid here.

Port – Enter the port number here.

Use SSL – Select this if you are using SSL

Username – Enter the username here

Password – Enter the password here.

Poll Delay – Select the delay between polls to the squid for updates

Available Commands & Variables

Commands

All Outlets/Outlet Control

Power On – Power all outlets on (Uses “Power On” Tag)

Power Off - Power all outlets off (Uses “Power Off” Tag)

Power Toggle – Toggles power to all outlets (Uses “Power” Tag)

Reboot – Reboots all outlets (Uses “Reboot” Tag)

Outlet (Outlet number)/Outlet Control

Power On (Outlet Number) – Power all outlets on (Uses “Power On (Outlet Number)” Tag)

Power Off (Outlet Number) - Power all outlets off (Uses “Power Off (Outlet Number)” Tag)

Power Toggle (Outlet Number) – Toggles power to all outlets (Uses “Power (Outlet Number)” Tag)

Reboot (Outlet Number) – Reboots all outlets (Uses “Reboot (Outlet Number)” Tag)

(Outlet Number) Will be 1 – 6.

Sequences/Run Sequence

Sequence (Number) – Run the corresponding Sequence

Variables

Device Info

Name – Name of the Squid (Uses “Name” Tag)

Model – Model Number of the Squid (Uses “Model” Tag)

Firmware – Firmware Version of the Squid (Uses “Firmware” Tag)

Overall System – System Status of the Squid (Uses “System” Tag)

Name – Temperature Unit- Either c or f (Uses “Temperature Unit” Tag)

Name – Current Temperature of the Squid (Uses “Temperature” Tag)

Nominal Voltage – Nominal Voltage Value (Uses “Nominal Voltage” Tag)

Nominal Frequency – Nominal Frequency Value (Uses “Nominal Frequency” Tag)

Energy Usage – Energy Usage Value (Uses “Energy Usage” Tag)

Energy Usage Period – Date/Time Energy Usage Was last Updated (Uses “Energy Period” Tag)

Surge Protection – Shows the state of the Surge Protection (Uses “Surge” Tag)

Frequency – Shows the Line Frequency Value (Uses “Line Frequency” Tag)

Frequency Gauge – Integer Value for Line Frequency (Uses “Line Frequency Gauge” Tag)

Current (Amps) – Shows the Line Current Value (Uses “Line Current” Tag)

Current Gauge – Integer Value for Line Current (Uses “Line Current Gauge” Tag)

Power Factor – Shows the Power Factor Value (Uses “Power Factor” Tag)

Power Factor Gauge – Integer Value for Power Factor (Uses “Power Factor Gauge” Tag)

Power (Watts) – Shows the Average Power Value (Uses “Average Power” Tag)

Power Gauge – Integer Value for Average Power (Uses “Average Power Gauge” Tag)

Input Info

Neutral - Ground Voltage – Shows the N-G Voltage Value (Uses “NG Voltage” Tag)

Neutral - Ground Voltage Gauge – Integer Value for N-G Voltage (Uses “NG Voltage Gauge” Tag)

Neutral - Ground Crest Factor – Shows the N-G Crest Factor Value (Uses “NG Crest Factor” Tag)

Neutral - Ground Crest Factor Gauge – Integer Value for N-G Crest Factor (Uses “NG Crest Factor Gauge” Tag)

Line - Neutral Voltage – Shows the L-N Voltage Value (Uses “LN Voltage” Tag)

Line - Neutral Voltage Gauge – Integer Value for L-N Voltage (Uses “LN Voltage Gauge” Tag)

Line - Neutral Crest Factor – Shows the L-N Crest Factor Value (Uses “LN Crest Factor” Tag)

Line - Neutral Crest Factor Gauge – Integer Value for L-N Crest Factor (Uses “LN Crest Factor Gauge” Tag)

Crest Factor Current – Shows the Crest Factor Current Value (Uses “Crest Factor Current” Tag)

Crest Factor Current Gauge – Integer Value for Crest Factor Current (Uses “Crest Factor Current Gauge” Tag)

Input State – Shows the Input State Value (Uses “Input State” Tag)

All Outputs

Power – Shows the Power State (Uses “Power” Tag)

Power On – Shows the Power On State (Uses “Power On” Tag)

Power Off – Shows the Power Off State (Uses “Power Off” Tag)

Output (Outlet Number) Info

Name – Shows the Configured Name Value (Uses “Name (Outlet Number)” Tag)

Physical Name – Shows the Physical Name Value (Uses “Physical Name (Outlet Number)” Tag)

Power On – Shows the Power On State (Uses “Power On (Outlet Number)” & “Power (Outlet Number)” Tag)

Power Off – Shows the Power Off State (Uses “Power Off (Outlet Number)” Tag)

Rebooting – Shows if the Outlet is Rebooting (Uses “Reboot (Outlet Number)” Tag)

Start Up State – Shows the Start Up State Value (Uses “Start Up State (Outlet Number)” Tag)

Type – Shows the Outlet Plug Type (Uses “Type (Outlet Number)” Tag)

Reboot Delay – Shows the Reboot Delay (Uses “Reboot Delay (Outlet Number)” Tag)

Last State – Shows the Power State when start up state is set to Last (Uses “Last State (Outlet Number)” Tag)

Voltage Type – Shows the Outlet Voltage Type (Uses “Voltage Type (Outlet Number)” Tag)

Sequences

Sequence (Seq Number) Name – Shows the Sequence Name (Uses “Sequence Name (Seq Number)” Tag)

Sequence (Seq Number) Running – Shows the Sequence Running State (Uses “Sequence Running (Seq Number)” Tag)

Events

Device Events

Connected – Triggers when driver connects to the Squid

Disconnected – Triggers when driver disconnects from the Squid

Outlet (Outlet Number) Events

Power On – Triggers when the outlet state changes from off to on

Power Off – Triggers when the outlet state changes from on to off

Rebooting – Triggers when the outlet state reboots