Name 

Description 

 

Calibration 

creates calibration byte array to be sent to the sensor
@param sensorID The ID of the sensor you want to send the message to @param subACTL the subACTL Denotes the type of control going to be sent down to the sensor, (4 fan Override, 6 Occupancy Override, 7 No Occupancy Override) @param minutes Duration in the amount of minutes used between 1 to 720 minutes @return 

 

Create 

 

 

GetAwareOnStateChange 

This is GetAwareOnStateChange, a member of class MultiStageThermostatBase. 

 

GetAwareWhenOccupied 

This is GetAwareWhenOccupied, a member of class MultiStageThermostatBase. 

 

GetBit 

This is the overview for the GetBit method overload. 

 

getData 

Data Generated: Temperature [double] Expressed as Celsius Humidity [double] Expressed as Percent Heating [boolean] Expressed as HvacStatus == 1 Cooling [boolean] Expressed as HvacStatus == 2 Fan [boolean] OccupancyState [boolean]  

 

GetDefaults 

Returns default configurations for the sensor
@param version The version of the Sensor @param platform The Firmware Generation of your device. i.e. Commercial, Alta, Wifi @return Default configurations for the sensor 

 

GetEnableLoadBalancingCooler 

This is GetEnableLoadBalancingCooler, a member of class MultiStageThermostatBase. 

 

GetEnableLoadBalancingHeater 

This is GetEnableLoadBalancingHeater, a member of class MultiStageThermostatBase. 

 

GetEnableOccupancyDetection 

This is GetEnableOccupancyDetection, a member of class MultiStageThermostatBase. 

 

GetFanControl 

This is GetFanControl, a member of class MultiStageThermostatBase. 

 

GetFanOnInterval 

This is GetFanOnInterval, a member of class MultiStageThermostatBase. 

 

GetFanOnPeriod 

This is GetFanOnPeriod, a member of class MultiStageThermostatBase. 

 

GetFanStartDelayForCooler 

This is GetFanStartDelayForCooler, a member of class MultiStageThermostatBase. 

 

GetFanStartTimeForHeater 

This is GetFanStartTimeForHeater, a member of class MultiStageThermostatBase. 

 

GetFanStopDelayForCooler 

This is GetFanStopDelayForCooler, a member of class MultiStageThermostatBase. 

 

GetFanStopTimeForHeater 

This is GetFanStopTimeForHeater, a member of class MultiStageThermostatBase. 

 

GetHeatCoolMode 

This is GetHeatCoolMode, a member of class MultiStageThermostatBase. 

 

getHumidity 

Humidity [double] Expressed as Percent  

 

GetHumidityOffset 

This is GetHumidityOffset, a member of class MultiStageThermostatBase. 

 

getHvacStatus 

HvacStatus [int] 0 = Off, 1 = Heating, 2 = Cooling.  

 

GetMinimumOffStateTime 

This is GetMinimumOffStateTime, a member of class MultiStageThermostatBase. 

 

getMode 

Mode [String]  

 

GetOccupiedSetPoint 

This is GetOccupiedSetPoint, a member of class MultiStageThermostatBase. 

 

GetOccupiedTimeout 

This is GetOccupiedTimeout, a member of class MultiStageThermostatBase. 

 

getProfileType 

This is getProfileType, a member of class MultiStageThermostatBase. 

 

getReversingValve 

ReversingValve [int] Expressed as integer  

 

GetReversingValve 

This is GetReversingValve, a member of class MultiStageThermostatBase. 

 

GetStage2CoolingActivationThreshold 

This is GetStage2CoolingActivationThreshold, a member of class MultiStageThermostatBase. 

 

GetStage2CoolingActivationTime 

This is GetStage2CoolingActivationTime, a member of class MultiStageThermostatBase. 

 

GetStage2HeatingActivationThreshold 

This is GetStage2HeatingActivationThreshold, a member of class MultiStageThermostatBase. 

 

GetStage2HeatingActivationTime 

This is GetStage2HeatingActivationTime, a member of class MultiStageThermostatBase. 

 

GetStage3HeatingActivationThreshold 

This is GetStage3HeatingActivationThreshold, a member of class MultiStageThermostatBase. 

 

GetStage3HeatingActivationTime 

This is GetStage3HeatingActivationTime, a member of class MultiStageThermostatBase. 

 

GetStage4HeatingActivationThreshold 

This is GetStage4HeatingActivationThreshold, a member of class MultiStageThermostatBase. 

 

GetStage4HeatingActivationTime 

This is GetStage4HeatingActivationTime, a member of class MultiStageThermostatBase. 

 

getSystemType 

SystemType [int]  

 

GetSystemType 

This is GetSystemType, a member of class MultiStageThermostatBase. 

 

GetTempDelta 

This is GetTempDelta, a member of class MultiStageThermostatBase. 

 

getTemperature 

Temperature [double] Expressed as Celsius  

 

GetTemperatureOffset 

This is GetTemperatureOffset, a member of class MultiStageThermostatBase. 

 

GetUnoccupiedCoolingSetpoint 

This is GetUnoccupiedCoolingSetpoint, a member of class MultiStageThermostatBase. 

 

GetUnoccupiedHeatingSetpoint 

This is GetUnoccupiedHeatingSetpoint, a member of class MultiStageThermostatBase. 

 

isAuxHeat 

AuxHeat [boolean]  

 

isCool1 

Cool1 [boolean]  

 

isCool2 

Cool2 [boolean]  

 

isEmergencyHeatOverride 

EmergencyHeatOverride [boolean]  

 

isFan 

Fan [boolean]  

 

isFanOverrideMode 

FanOverrideMode [boolean]  

 

isHeat1 

Heat1 [boolean]  

 

isHeat2 

Heat2 [boolean]  

 

isHeat3 

Heat3 [boolean]  

 

isHeatPump1 

HeatPump1 [boolean]  

 

isHeatPump2 

HeatPump2 [boolean]  

 

isOccupancyState 

OccupancyState [boolean]  

 

isOccupiedOverride 

OccupiedOverride [boolean]  

 

isSettingsLockout 

SettingsLockout [boolean]  

 

isUnoccupiedOverride 

UnoccupiedOverride [boolean]  

 

ModeStringValue 

Converts mode to a readable status @param mode @return 

 

ReversingValveStringValue 

Converts Reversing Valve integer to a readable value.
@param mode @return 

 

SensorEdit 

Allows for the update of the specific type of sensor
@param sens sens the Sensor object to be updated @param heartBeat How often the sensor communicates with the gateway if no activity recorded. @param SystemType Sets the HVAC system type and what items are controlled. The HVAC system must be defined prior to using. If undefined none of the HVAC controls will turn on as a safety feature. @param HeatCoolMode Sets whether the thermostat controls heating, cooling, or both automatically. @param OccupiedSetpoint Sets when to turn on and off Heating and Cooling when the building is occupied @param TempDelta Sets... more 

 

setAuxHeat 

This is setAuxHeat, a member of class MultiStageThermostatBase. 

 

SetAwareOnStateChange 

This is SetAwareOnStateChange, a member of class MultiStageThermostatBase. 

 

SetAwareWhenOccupied 

This is SetAwareWhenOccupied, a member of class MultiStageThermostatBase. 

 

SetBit 

This is SetBit, a member of class MultiStageThermostatBase. 

 

setCool1 

This is setCool1, a member of class MultiStageThermostatBase. 

 

setCool2 

This is setCool2, a member of class MultiStageThermostatBase. 

 

setEmergencyHeatOverride 

This is setEmergencyHeatOverride, a member of class MultiStageThermostatBase. 

 

SetEnableLoadBalancingCooler 

This is SetEnableLoadBalancingCooler, a member of class MultiStageThermostatBase. 

 

SetEnableLoadBalancingHeater 

This is SetEnableLoadBalancingHeater, a member of class MultiStageThermostatBase. 

 

SetEnableOccupancyDetection 

This is SetEnableOccupancyDetection, a member of class MultiStageThermostatBase. 

 

setFan 

This is setFan, a member of class MultiStageThermostatBase. 

 

SetFanControl 

 

 

SetFanOnInterval 

This is SetFanOnInterval, a member of class MultiStageThermostatBase. 

 

SetFanOnPeriod 

This is SetFanOnPeriod, a member of class MultiStageThermostatBase. 

 

setFanOverrideMode 

This is setFanOverrideMode, a member of class MultiStageThermostatBase. 

 

SetFanStartDelayForCooler 

This is SetFanStartDelayForCooler, a member of class MultiStageThermostatBase. 

 

SetFanStartTimeForHeater 

 

 

SetFanStopDelayForCooler 

This is SetFanStopDelayForCooler, a member of class MultiStageThermostatBase. 

 

SetFanStopTimeForHeater 

This is SetFanStopTimeForHeater, a member of class MultiStageThermostatBase. 

 

setHeat1 

This is setHeat1, a member of class MultiStageThermostatBase. 

 

setHeat2 

This is setHeat2, a member of class MultiStageThermostatBase. 

 

setHeat3 

This is setHeat3, a member of class MultiStageThermostatBase. 

 

SetHeatCoolMode 

This is SetHeatCoolMode, a member of class MultiStageThermostatBase. 

 

setHeatPump1 

This is setHeatPump1, a member of class MultiStageThermostatBase. 

 

setHeatPump2 

This is setHeatPump2, a member of class MultiStageThermostatBase. 

 

setHumidity 

This is setHumidity, a member of class MultiStageThermostatBase. 

 

SetHumidityOffset 

This is SetHumidityOffset, a member of class MultiStageThermostatBase. 

 

setHvacStatus 

This is setHvacStatus, a member of class MultiStageThermostatBase. 

 

SetMinimumOffStateTime 

This is SetMinimumOffStateTime, a member of class MultiStageThermostatBase. 

 

setMode 

This is setMode, a member of class MultiStageThermostatBase. 

 

setOccupancyState 

This is setOccupancyState, a member of class MultiStageThermostatBase. 

 

setOccupiedOverride 

This is setOccupiedOverride, a member of class MultiStageThermostatBase. 

 

SetOccupiedSetPoint 

 

 

SetOccupiedTimeout 

 

 

setReversingValve 

This is setReversingValve, a member of class MultiStageThermostatBase. 

 

SetReversingValve 

This is SetReversingValve, a member of class MultiStageThermostatBase. 

 

setSettingsLockout 

This is setSettingsLockout, a member of class MultiStageThermostatBase. 

 

SetStage2CoolingActivationThreshold 

This is SetStage2CoolingActivationThreshold, a member of class MultiStageThermostatBase. 

 

SetStage2CoolingActivationTime 

 

 

SetStage2HeatingActivationThreshold 

This is SetStage2HeatingActivationThreshold, a member of class MultiStageThermostatBase. 

 

SetStage2HeatingActivationTime 

This is SetStage2HeatingActivationTime, a member of class MultiStageThermostatBase. 

 

SetStage3HeatingActivationThreshold 

This is SetStage3HeatingActivationThreshold, a member of class MultiStageThermostatBase. 

 

SetStage3HeatingActivationTime 

 

 

SetStage4HeatingActivationThreshold 

This is SetStage4HeatingActivationThreshold, a member of class MultiStageThermostatBase. 

 

SetStage4HeatingActivationTime 

This is SetStage4HeatingActivationTime, a member of class MultiStageThermostatBase. 

 

setSystemType 

This is setSystemType, a member of class MultiStageThermostatBase. 

 

SetSystemType 

This is SetSystemType, a member of class MultiStageThermostatBase. 

 

SetTempDelta 

This is SetTempDelta, a member of class MultiStageThermostatBase. 

 

setTemperature 

This is setTemperature, a member of class MultiStageThermostatBase. 

 

SetTemperatureOffset 

 

 

SetUnoccupiedCoolingSetpoint 

This is SetUnoccupiedCoolingSetpoint, a member of class MultiStageThermostatBase. 

 

SetUnoccupiedHeatingSetpoint 

This is SetUnoccupiedHeatingSetpoint, a member of class MultiStageThermostatBase. 

 

setUnoccupiedOverride 

This is setUnoccupiedOverride, a member of class MultiStageThermostatBase. 

 

systemTypeDefinitions 

System Type Definitions 

 

SystemTypeStringValue 

Converts system type to a readable value. @param mode @return