Pool Control (HG) HTTP Command Reference

From Autelis

Jump to: navigation, search

HTTP Commands

Pool Control uses simple HTTP GET commands to pass status information and commands back and forth to clients. You can use these commands to integrate Pool Control into other network-enabled controllers and software packages. Access to these resources requires you to pass the username 'admin' and your password via HTTP Basic Authentication in the HTTP header for all requests.

Status Information

Status information can be retrieved from 'http://poolcontrol/status.xml' or 'http://your.ip.address/status.xml'.


This XML document contains all the status information available from Pool Control and can be easily parsed for individual values.


The document root node is <response>. It has three child nodes which contain the status values. They are: <system>, <equipment>, and <temp>. They are enumerated below along with their child nodes and possible values. NOTE: If a child node has a null value then it is not available because it is not supported by the specific Aqualink® model or configuration.

<response>

<system>
<model>
Definition: A number representing the model of the controller
Possible values: integer
</model>
<opmode>
Definition: The current state of the controller
Possible values: 0-2
0 = Auto
1 = Service
2 = Timeout
</opmode>
<err>
Definition: The error status of the controller (0 = no errors, 1 = errors)
Possible values: 0,1
</err>
<version>
Definition: The firmware version of the Pool Control device
Possible values: string
</version>
<time>
Definition: The time as kept by the Pool Control device
Possible values: Unix timestamp
</time>
</system>
<equipment>
<pump>
Definition: The current state of the filter pump
Possible values: 0-1
0 = Off
1 = On
</pump>
<spa>
Definition: The current state of the spa
Possible values: 0-1
0 = Off
1 = On
</spa>
<waterfall>
Definition: The current state of the waterfall
Possible values: 0-1
0 = Off
1 = On
</waterfall>
<valve3>
Definition: The current state of the Valve3
Possible values: 0-1
0 = Off
1 = On
</valve3>
<poolht>
Definition: The current state of the Heater
Possible values: 0-1
0 = Off
1 = On
</poolht>
<valve4>
Definition: The current state of Heat2/Valve4
Possible values: 0-1
0 = Off
1 = On
</valve4>
<aux1>
Definition: The current state of aux1 (NOTE: aux1 = lights, aux2 = aux1, etc...)
Possible values: 0-1
0 = Off
1 = On
</aux1>
...
<aux15>
Definition: The current state of aux15
Possible values: 0-1
0 = Off
1 = On
</aux15>
<schlor>
Definition: The current state of the super chlorinate mode
Possible values: 0-1
0 = Off
1 = On
</schlor>
</equipment>
<temp>
<pooltemp>
Definition: The current pool temperature
Possible values: positive integer
Note: Only accurate when filter pump is running
</pooltemp>
<spatemp>
Definition: The current spa temperature
Possible values: positive integer
Note: Only accurate when spa is running
</spatemp>
<airtemp>
Definition: The current air temperature
Possible values: positive integer
</airtemp>
<solartemp>
Definition: The current solar temperature
Possible values: positive integer
Note: Only accurate when filter pump is running
</solartemp>
<tempunits>
Definition: The selected units for temperature
Possible values: one character
F = Fahrenheit
C = Celsius
</tempunits>
</temp>

</response>

Control Commands

Control commands can be sent through a HTTP GET request to 'http://poolcontrol/set.cgi' or 'http://your.ip.address/set.cgi'. A set command will return the text '1' indicating that the command was received. However you must check the status.xml information to see if the command was successful. Depending on the type of command, there may be a small delay in updating the status information. New commands should only be sent when Pool Control is in the 'Connected and Ready' runstate.


To change the value of something in the equipment listing, send a command similar to the following:

http://poolcontrol/set.cgi?name=pump&value=1
name = the XML node name of the equipment you want to adjust
value = the value you want to assign to the equipment


The following commands are also available:

Note: Spa mode can be activated by turning on spa. Pool mode can be activated by turning off spa. You cannot send set commands the waterfall node. To change the value of the intake/return valves use the command to cycle through them:
Pool/Spa/Waterfall Mode Toggle: /keypad.cgi?key=7
Note: To toggle the heater setting use:
Heater Toggle: /keypad.cgi?key=19
Personal tools