ZWave proxy points are recognizable by their default name, which corresponds to a particular Z-Wave command class. Table 4 alphabetically lists current proxy points for ZWaveDevices by default name.
Table 4. Alphabetical listing (by default name) of possible ZWaveDevice proxy points
| Proxy point default name | Z-Wave “Command Class” and reference link |
|---|---|
| alarm | Alarm Sensor |
| autoChangeoverSetpoint | Thermostat Setpoint |
| awayHeatSetpoint | Thermostat Setpoint |
| batteryLevel | Battery |
| batterySensor | Battery Sensor |
| bypass | “HRV Control” (CcHrvControl) |
| co2Alarm | Alarm Sensor |
| coAlarm | Alarm Sensor |
| coolSetpoint | Thermostat Setpoint |
| coolSetupSetpoint | Thermostat Setpoint |
| dischargeTemp | “HRV Status” (CcHrvStatus) |
| dryAirSetpoint | Thermostat Setpoint |
| e2rateConsumption | “Basic Tariff Information” (CcBasicTariffInfo) |
| exhaustTemp | “HRV Status” (CcHrvStatus) |
| fanMode | Thermostat Fan Mode |
| fanState | Thermostat Fan State |
| heatAlarm | Alarm Sensor |
| heatSetbackSetpoint | Thermostat Setpoint |
| heatSetpoint | Thermostat Setpoint |
| hrvControl | “HRV Control” (CcHrvControl) |
| instantEnergy | Energy Production |
| lock | Lock |
| lowBattery | Battery |
| meterValue | Meter |
| mode | Thermostat Mode |
| mtpWindowCovering | Move To Position Window Covering |
| multilevelSensor | Multilevel Sensor |
| outsideTemp | “HRV Status” (CcHrvStatus) |
| pulseCount | Pulse Meter |
| rateConsumption | “Basic Tariff Information” (CcBasicTariffInfo) |
| remainingFilterLife | “HRV Status” (CcHrvStatus) |
| roomTemp | “HRV Status” (CcHrvStatus) |
| roomRelHum | “HRV Status” (CcHrvStatus) |
| sensorBattery | Battery Sensor |
| smokeAlarm | Alarm Sensor |
| state | Thermostat Operating State |
| supplyTemp | “HRV Status” (CcHrvStatus) |
| switch | Binary Switch |
| switch | Multilevel Switch |
| switchToggle | Binary Toggle |
| todaysEnergy | Energy Production |
| totalEnergy | Energy Production |
| totalTime | Energy Production |
| ventilationRate | “HRV Control” (CcHrvControl) |
| waterLeakAlarm | Alarm Sensor |
A device that supports the Alarm Sensor command class supports one or more sensor types. For each supported sensor type, a BooleanPoint is created in the device’s
Points container. Table 5 lists different Z-Wave alarm sensor types to the default names of corresponding BooleanPoints.
Alarm extensions are not added (by default) to these BooleanPoints. You must add an alarm extension to any point that you want integrated into the
station’s NiagaraAX alarming subsystem.
Table 5. Z-Wave sensor type to default name of ZWave proxy BooleanPoint for alarming
| Default Point Name | Z-Wave Sensor Type | Point type, note |
|---|---|---|
| alarm | General Purpose Alarm | BooleanPoint |
| smokeAlarm | Smoke Alarm | |
| coAlarm | CO Alarm | |
| co2Alarm | CO2 Alarm | |
| heatAlarm | Heat Alarm | |
| waterLeakAlarm | Water Leak Alarm |
A “silenceAlarm” action is available on any of the points above if the device supports the Alarm Silence command class.
A device that supports the Alarm Sensor command class may also support the Alarm Silence command class. For each alarm sensor BooleanPoint added by the Alarm Sensor command class, this command class adds a “silenceAlarm” action. When invoked, it sends a message to the device to silence the device’s local sounding of an alarm.
If the Battery command class is supported, two points are created in the device’s Points (Table 6).
Table 6. Battery default name of ZWave proxy point with description and point type
| Default Point Name | Description | Point type |
|---|---|---|
| batteryLevel | Percentage of full battery | NumericPoint |
| lowBattery | Low battery warning | BooleanPoint |
If the Battery Sensor command class is supported, a BooleanPoint with the default name of “sensorBattery” is added to Points. This point indicates if the sensor has detected an event.
If the Binary Switch command class is supported, a BooleanWritable with the default name of “switch” is added to Points. This point can be used to both control and indicate the current state of the switch.
If the Binary Toggle command class is supported, a BooleanPoint with the default name of “switchToggle” is added to Points. A dynamic action named “Toggle” is added to this point. This proxy point indicates the current state of the switch, and its action is used
to command the device to toggle the current state of the switch.
A device that supports the Energy Production command class retrieves energy production data from an energy production device (e.g. generator). If the device supports
this command class, four NumericPoints are added to Points, as described in Table 7.
Table 7. Energy Production default ZWave proxy point names to parameters, units, point types
| Default Point Name | Production Parameter | Units | Point type |
|---|---|---|---|
| instantEnergy | Instant energy production | Watts | NumericPoint |
| totalEnergy | Total energy production | Watt-Hours | |
| todaysEnergy | Energy production today | Watt-Hours | |
| totalTime | Total production time | Hours or Seconds |
A device that supports the Hail command class fires the “hail” topic of its corresponding ZWaveDevice component whenever a Z-Wave “Hail” message is received from another device. Usage
of the Hail command class is application-specific.
If the Lock command class is supported, a BooleanWritable with the default name of “lock” is added to Points. This point can be used to both control and indicate the current lock state of a lockable device.
If the Meter command class is supported, a NumericPoint with the default name of “meterValue” is added to Points. This point reads the accumulated values from an electric, gas, or water meter. The point’s units are automatically set to
match the units reported by the Z-Wave device.
If the Move To Position Window Covering command class is supported, a NumericWritable with the default name of “mtpWindowCovering” is added to Points. This point can indicate the current position of the window covering, and can move the window covering to a given position.
If the Multilevel Sensor command class is supported, a NumericPoint with the default name of “multiLevelSensor” is added to Points. This point indicates the current value of the multilevel sensor, in the units reported by the Z-Wave device.
If the Multilevel Switch command class is supported, a NumericWritable with the default name of “switch” is added to Points. This point indicates the current value of the multilevel switch, in the units reported by the Z-Wave device, and can be
commanded to change the value.
If the Pulse Meter command class is supported, a NumericPoint with the default name of “pulseCount” is added to Points. This point indicates the current accumulated pulse counts reported by a pulse counting utility meter device.
If the Thermostat Fan Mode command class is supported, an EnumWritable with the default name of “fanMode” is added to Points. This point monitors, and can be used to control, the current fan mode of the HVAC system.
The driver queries the Z-Wave device to determine the fan modes supported. If the fan is single-speed, mode choices are “Auto” and “On”. If a two-speed fan, mode choices are “auto”, “onLow”, “autoHigh”, and “onHigh”.
If the Thermostat Fan State command class is supported, an EnumPoint with the default name of “fanState” is added to Points. This point monitors the current fan state of the HVAC system. Valid fan states include “idle”, “on”, and “onHigh”.
If the Thermostat Mode command class is supported, an EnumWritable with the default name of “mode” is added to Points. This point monitors, and can be used to control, the thermostat operation mode of the HVAC system.
The driver queries the Z-Wave device to determine the thermostat modes supported. Supported modes are added as enumerations to the EnumWritable, with possible enum tags shown in Table 8.
Table 8. Possible Enum Tag values and descriptions for Thermostat “mode” ZWave proxy point
| Enum Tag | Description |
|---|---|
| off | Off — System is off. No heating or cooling will come on. |
| heat | Heat — Only heating will occur. |
| cool | Cool — Only cooling will occur. |
| auto | Auto — Heating or cooling will come on according, to the heating and cooling setpoints. The system automatically switches between heating and cooling when the temperature exceeds (or drops below) the setpoints. |
| aux | Auxiliary/Emergency Heat — A heat pump, especially an exchange type, is not efficient when outside temperature is below 35 degrees Fahrenheit (close to 0 degrees Celsius). Thus, the thermostat may be put into an “Aux heat mode” simply to use a more efficient secondary heat source, when there are no failures with the heat pump or its compressor. |
| resume | Resume — The system resumes from last active mode. |
| fan | Fan Only — Only cycle fan to circulate air. |
| furnace | Furnace — Only cycle fan to circulate air. |
| dry | Dry Air — The system cycles cooling in relation to the room and setpoint temperatures, in order to remove ambient moisture. (Dehumidification) |
| moist | Moist Air — Humidification. |
| autochange | Auto Changeover — Heating or cooling comes on according to the auto changeover setpoint. |
| heatEnergySave | Energy Save Heat — Energy Save Mode Heating will occur (usually lower than normal setpoint). |
| coolEnergySave | Energy Save Cool — Energy Save Mode Cooling will occur (usually higher than normal setpoint). |
| away | AWAY — Special heating mode, to prevent water from freezing in forced water systems. |
If the Thermostat Operating State command class is supported, an EnumPoint with the default name of “state” is added to Points. This point monitors the HVAC system’s operating state.
Possible HVAC system operating states are shown in Table 9.
Table 9. Possible operating states for Thermostat “state” ZWave proxy point
| Enum Tag | Description |
|---|---|
| idle | System is idle. |
| heat | Heating. |
| cool | Cooling. |
| fan | Fan Only. |
| heatPend | Short cycle prevention feature used in heat pump applications to protect the compressor. |
| coolPend | Short cycle prevention feature used in heat pump applications to protect the compressor. |
| vend | Vent / Economizer. |
If the Thermostat Setpoint command class is supported, one or more NumericWritable points are added to Points, for setpoint handling. These points are used to monitor and control the setpoints supported by the device. Table 10 provides a list of possible proxy points that may be added.
Table 10. Default ZWave proxy point names associated with Thermostat Setpoints
| Default Point Name | Setpoint | Point type |
|---|---|---|
| heatSetpoint | Heating | NumericWritable |
| coolSetpoint | Cooling | |
| furnaceSetpoint | Furnace | |
| dryAirSetpoint | Dry Air | |
| moistAirSetpoint | Moist Air | |
| autoChangeoverSetpoint | Auto Changeover | |
| heatSetbackSetpoint | Energy Save Heating | |
| coolSetupSetpoint | Energy Save Cooling | |
| awayHeatSetpoint | Away Heating |
Typically, a device does not have all 9 setpoints.