User Guide

131
Standard NetLinx API (SNAPI) R 1.8.0
HVAC
IHVACComponent
IHVACComponentListener
IModuleComponent
IModuleComponentListener
Name: HVAC
Interface: IHVAC
HVAC Functions
Name Component Channel Level Command Constant Notes
addHVACComponent(index,hvacAddress) IHVACComponent HVACADD-
<index>,<hvacAd-
dress>
Add a thermostat at a given index, where
<index> is 1-x and <address> is a thermo-
stat address and x is the maximum sup-
ported thermostat index (see specific
module documentation)
cycleFanState() IHVACComponent 213 HVAC_FAN Momentary Function Channel: Cycle the
fan state when channel is activated
cycleHumidifyState() IHVACComponent 217 HVAC_HUMIDIFY_STATE Momentary Function Channel: Cycle the
humidify state when channel is activated
cycleHVACState() IHVACComponent 218 HVAC_STATE Momentary Function Channel: Cycle the
HVAC state when channel is activated
decrementCoolSetpoint() IHVACComponent 141 HVAC_COOL_DN Momentary Function Channel: Decrement
the cool setpoint when channel is activated
decrementDehumidifySetpoint() IHVACComponent 151 HVAC_DEHUMIDIFY_DN Momentary Function Channel: Decrement
the dehumidify setpoint when channel is
activated
decrementHeatSetpoint() IHVACComponent 144 HVAC_HEAT_DN Momentary Function Channel: Decrement
the heat setpoint when channel is activated
decrementHumidifySetpoint() IHVACComponent 149 HVAC_HUMIDIFY_DN Momentary Function Channel: Decrement
the humidify setpoint when channel is acti-
vated
getHumidifyState() IHVACComponent ?HVACHUMID Query for the humidify state, responds with
HVACHUMID-<state> where <state> is
OFF,HUMIDIFY,DEHUMIDIFY,AUTO
getHumidifyStatus() IHVACComponent ?HVACHUMIDSTA-
TUS
Query for the humidify status, responds
with HVACHUMIDSTATUS-<status>
where <status> is OFF,HUMIDIFY,DEHU-
MIDIFY
getHVACComponentAddress(index) IHVACComponent ?HVACADDR-<index> Query for the address of the thermostat at
index <index>, responds with HVACADDR-
<index>,<hvacAddress>
getHVACComponentIndex(hvacAddress) IHVACComponent ?HVACIDX-<hvacAd-
dress>
Query for the index of the thermostat with
address <hvacAddress>, responds with
HVACADDR-<index>,<hvacAddress>