User Guide

ManualsBrandsAMX ManualsOtherCAFE DUET STANDARD NETLINX API (SNAPI) COMPONENTS AND LISTENERS

Standard NetLinx API (SNAPI) R 1.8.0

HVAC

Component

Name: HVAC

Interface: IHVACComponent

IHVACComponent

Component Functions:

Name: Channel: Level: Command: Constant: Notes:

addHVACCompo-

nent(index,hvacAddress)

HVACADD-<index>,<hvacAddress> Add a thermostat at a given index, where <index> is 1-x and <address> is a thermostat

address and x is the maximum supported thermostat index (see specific module docu-

mentation)

cycleFanState() 213 HVAC_FAN Momentary Function Channel: Cycle the fan state when channel is activated

cycleHumidifyState() 217 HVAC_HUMIDIFY_STATE Momentary Function Channel: Cycle the humidify state when channel is activated

cycleHVACState() 218 HVAC_STATE Momentary Function Channel: Cycle the HVAC state when channel is activated

decrementCoolSetpoint() 141 HVAC_COOL_DN Momentary Function Channel: Decrement the cool setpoint when channel is activated

decrementDehumidify-

Setpoint()

151 HVAC_DEHUMIDIFY_DN Momentary Function Channel: Decrement the dehumidify setpoint when channel is acti-

vated

decrementHeatSetpoint() 144 HVAC_HEAT_DN Momentary Function Channel: Decrement the heat setpoint when channel is activated

decrementHumidifySet-

point()

149 HVAC_HUMIDIFY_DN Momentary Function Channel: Decrement the humidify setpoint when channel is acti-

vated

getHumidifyState() ?HVACHUMID Query for the humidify state, responds with HVACHUMID-<state> where <state> is

OFF,HUMIDIFY,DEHUMIDIFY,AUTO

getHumidifyStatus() ?HVACHUMIDSTATUS Query for the humidify status, responds with HVACHUMIDSTATUS-<status> where

<status> is OFF,HUMIDIFY,DEHUMIDIFY

getHVACComponentAd-

dress(index)

?HVACADDR-<index> Query for the address of the thermostat at index <index>, responds with HVACADDR-

getHVACComponentIn-

dex(hvacAddress)

?HVACIDX-<hvacAddress> Query for the index of the thermostat with address <hvacAddress>, responds with

HVACADDR-<index>,<hvacAddress>

getTemperatureScale() ?HVACSCALE Query for the temperature scale, responds with HVACSCALE-<scale> where <scale>

is FAHRENHEIT,CELSIUS

incrementCoolSetpoint() 140 HVAC_COOL_UP Momentary Function Channel: Increment the cool setpoint when channel is activated

incrementDehumidify-

Setpoint()

150 HVAC_DEHUMIDIFY_UP Momentary Function Channel: Increment the dehumidify setpoint when channel is acti-

vated

incrementHeatSetpoint() 143 HVAC_HEAT_UP Momentary Function Channel: Increment the heat setpoint when channel is activated

incrementHumidifySet-

point()

148 HVAC_HUMIDIFY_UP Momentary Function Channel: Increment the humidify setpoint when channel is acti-

vated

removeHVACCompo-

nent(hvacAddress)

HVACREMOVEADDR-<hvacAd-

dress>

Remove the thermostat with address <hvacAddress>, where <hvacAddress> is a ther-

mostat address

removeHVACCompo-

nent(index)

HVACREMOVEIDX-<index> Remove the thermostat at index <index>, where <index> is 1-x and x is the maximum

supported thermostat index (see specific module documentation)

setCoolSetpoint(set-

point)

31 HVAC_COOL_LVL Set the cool setpoint, value is in degrees C or F depending on temperature scale