User Guide

Standard NetLinx API (SNAPI) R 1.8.0
182
Pool Spa Functions (Cont.)
Name Component Channel Level Command Constant Notes
processPassbackEvent(byte[]) IModuleComponentListener When passback is on, each string received
form the device is sent to the NetLinx pro-
gram as a string. Use a DATA_EVENT
event with a STRING handler to caputre
the data from the device.
cyclePoolHeatState() IPoolSpaComponent 123 POOL_HEAT Momentary Function Channel: Cycle Pool
heat state when channel is activated
cycleSpaHeatState() IPoolSpaComponent 124 SPA_HEAT Momentary Function Channel: Cycle Spa
heat state when channel is activated
cycleSpaJets() IPoolSpaComponent 125 SPA_JETS Momentary Function Channel: Cycle Spa
jets when channel is activated
decrementPoolSetpoint() IPoolSpaComponent 153 POOL_HEAT_DN Momentary Function Channel: Pool set-
point is decremented when channel is acti-
vated
decrementSpaSetpoint() IPoolSpaComponent 155 SPA_HEAT_DN Momentary Function Channel: Spa set-
point is decremented when channel is acti-
vated
getPoolSpaTemperatureScale() IPoolSpaComponent ?POOLSCALE Query for the Pool/Spa temperature scale,
responds with POOLSCALE-<scale>
where <scale> is FAHRENHEIT, CELSIUS
incrementPoolSetpoint() IPoolSpaComponent 152 POOL_HEAT_UP Momentary Function Channel: Pool set-
point is incremented when channel is acti-
vated
incrementSpaSetpoint() IPoolSpaComponent 154 SPA_HEAT_UP Momentary Function Channel: Spa set-
point is incremented when channel is acti-
vated
isPoolSpaAuxOn(aux) IPoolSpaComponent ?POOLAUX-<aux num-
ber>
Query for Pool/Spa Aux state, responds
with POOLAUX-<aux number>,<state>
where <state> is 0 (false) or 1 (true)
setPoolHeatState(OFF) IPoolSpaComponent 174 POOL_HEAT_OFF Momentary Function Channel: Set Pool
heat state to off
setPoolHeatState(HEATER) IPoolSpaComponent 175 POOL_HEATER Momentary Function Channel: Set Pool
heat state to heater
setPoolHeatState(SOLAR) IPoolSpaComponent 176 POOL_SOLAR Momentary Function Channel: Set Pool
heat state to solar
setPoolHeatState(SOLAR_PREFERRED) IPoolSpaComponent 177 POOL_SOLAR_PREF Momentary Function Channel: Set Pool
heat state to solar preferred
setPoolLightOn(state) IPoolSpaComponent 172 POOL_LIGHT_ON Discrete Function Channel: Pool light is on
while channel is active
setPoolPumpOn(state) IPoolSpaComponent 170 POOL_PUMP_ON Discrete Function Channel: Pool pump is
on while channel is active
setPoolSetpoint(nTemperature) IPoolSpaComponent 39 POOL_HEAT_LVL Set Pool setpoint, value is in degrees C or
F depending on temperature scale