User Guide

97
Standard NetLinx API (SNAPI) R 1.8.0
Pool Spa
Component
Name: Pool Spa
Interface: IPoolSpaComponent
IPoolSpaComponent
Component Functions:
Name: Channel: Level: Command: Constant: Notes:
cyclePoolHeatState() 123 POOL_HEAT Momentary Function Channel: Cycle Pool heat state when channel is activated
cycleSpaHeatState() 124 SPA_HEAT Momentary Function Channel: Cycle Spa heat state when channel is activated
cycleSpaJets() 125 SPA_JETS Momentary Function Channel: Cycle Spa jets when channel is activated
decrementPoolSetpoint() 153 POOL_HEAT_DN Momentary Function Channel: Pool setpoint is decremented when channel is activated
decrementSpaSetpoint() 155 SPA_HEAT_DN Momentary Function Channel: Spa setpoint is decremented when channel is activated
getPoolSpaTempera-
tureScale()
?POOLSCALE Query for the Pool/Spa temperature scale, responds with POOLSCALE-<scale> where
<scale> is FAHRENHEIT, CELSIUS
incrementPoolSetpoint() 152 POOL_HEAT_UP Momentary Function Channel: Pool setpoint is incremented when channel is activated
incrementSpaSetpoint() 154 SPA_HEAT_UP Momentary Function Channel: Spa setpoint is incremented when channel is activated
isPoolSpaAuxOn(aux) ?POOLAUX-<aux number> Query for Pool/Spa Aux state, responds with POOLAUX-<aux number>,<state> where
<state> is 0 (false) or 1 (true)
setPoolHeat-
State(HEATER)
175 POOL_HEATER Momentary Function Channel: Set Pool heat state to heater
setPoolHeatState(OFF) 174 POOL_HEAT_OFF Momentary Function Channel: Set Pool heat state to off
setPoolHeat-
State(SOLAR)
176 POOL_SOLAR Momentary Function Channel: Set Pool heat state to solar
setPoolHeat-
State(SOLAR_PREFER
RED)
177 POOL_SOLAR_PREF Momentary Function Channel: Set Pool heat state to solar preferred
setPoolLightOn(state) 172 POOL_LIGHT_ON Discrete Function Channel: Pool light is on while channel is active
setPoolPumpOn(state) 170 POOL_PUMP_ON Discrete Function Channel: Pool pump is on while channel is active
setPoolSetpoint(nTem-
perature)
39 POOL_HEAT_LVL Set Pool setpoint, value is in degrees C or F depending on temperature scale
setPool-
SpaAuxOn(aux,state)
POOLAUX-<aux number>,<state> Set Pool/Spa Aux state where <aux number> is the number of the aux relay 1 to x
where x is the maximum supported aux relay and <state> is 1 (on) or 0 (off) (see spe-
cific module documentation)
setPoolSpaTempera-
tureScale(ts)
POOLSCALE-<ts> Set the Pool/Spa temperature scale, where <ts> is FAHRENHEIT, CELSIUS
setSpaBlowerOn(state) 186 SPA_BLOWER_ON Discrete Function Channel: Spa blower is on while channel is active
setSpaHeat-
State(HEATER)
179 SPA_HEATER Momentary Function Channel: Set Spa heat state to heater
setSpaHeatState(OFF) 178 SPA_HEAT_OFF Momentary Function Channel: Set Spa heat state to off