C# Mine
ContentsIndexHome
PreviousUpNext
MultiStageThermostatBase.SensorEdit Method

Allows the Editing of the sensor thresholds and configurations.

Syntax
C#
public static void SensorEdit(ISensor sens, double? heartBeat, int? SystemType, int? HeatCoolMode, double? OccupiedSetpoint, double? TempDelta, int? OccupiedTimeout, double? UnoccupiedHeatingSetpoint, double? UnoccupiedCoolingSetpoint, double? Stage2CoolingActivationTime, double? Stage2CoolingActivationThreshold, double? Stage2HeatingActivationTime, double? Stage2HeatingActivationThreshold, double? Stage3HeatingActivationTime, double? Stage3HeatingActivationThreshold, double? Stage4HeatingActivationTime, double? Stage4HeatingActivationThreshold, bool? EnableLoadBalancingHeater, bool? EnableLoadBalancingCooler, bool? AwareWhenOccupied, bool? AwareOnStateChange, int? ReversingValve, int? FanControl, int? FanPeriod, int? FanOnInterval, int? FanStartTimeForHeater, int? FanStopTimeForHeater, int? FanStartTimeForCooler, int? FanStopTimeForCooler, int? failedTransmissionsBeforeLinkMode);
Parameters 
Description 
ISensor sens 
sens the Sensor object to be updated  
double? heartBeat 
How often the sensor communicates with the gateway if no activity recorded. 
int? 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. 
int? HeatCoolMode 
Sets whether the thermostat controls heating, cooling, or both automtatically. 
double? OccupiedSetpoint 
Sets when to turn on and off Heating and Cooling when the building is occupied 
double? TempDelta 
Sets the amount of buffer for the heating and cooling. example: If the buffer is set to 5 degrees,The heat will turn on at 25 C and off at 30 C  
int? OccupiedTimeout 
The amount of time after the occupied state has been triggered that the system will revert back to the unoccuped temperature settings. 
double? UnoccupiedHeatingSetpoint 
Readings below the Heating System setpoint will turn on the Heater. (UnoccupiedHeatingSetpoint and UnoccupiedCoolingSetpoint must be set at the same time) 
double? UnoccupiedCoolingSetpoint 
Readings above the Cooling System setpoint will turn on the Cooling system.(UnoccupiedHeatingSetpoint and UnoccupiedCoolingSetpoint must be set at the same time) 
double? Stage2CoolingActivationTime 
Amount of time the 1st stage is allowed to run before activating the 2nd stage. 
double? Stage2CoolingActivationThreshold 
If the temperature goes above the setpoint by this amount the 2nd stage will be activated immediately. 
double? Stage2HeatingActivationTime 
Amount of time the 1st stage is allowed to run before activating the 2nd stage. 
double? Stage2HeatingActivationThreshold 
If the temperature goes beyond the setpoint by this amount the 2nd stage will be activated immediately. 
double? Stage3HeatingActivationTime 
Amount of time the 1st stage is allowed to run before activating the 3rd stage. The 3rd stage may be Aux or a Conventional stage.  
double? Stage3HeatingActivationThreshold 
If the temperature goes beyond the setpoint by this amount the 3rd stage will be activated immediately. 
double? Stage4HeatingActivationTime 
Amount of time the 1st stage is allowed to run before activating the 4th stage. The 4th stage may be Aux or a Conventional stage.  
double? Stage4HeatingActivationThreshold 
If the temperature goes beyond the setpoint by this amount the 4th stage will be activated immediately. 
bool? EnableLoadBalancingHeater 
When ON balances the load between the 1st and 2nd stage heaters ensuring they run approximately the same time overall. Only applies when the System Type has 2 or more stages for heating. When turning the heater on this checks the time tally for each stage and will turn on whichever stage has the lowest total runtime first. NOTE: Should only be enabled when the 1st and 2nd stages have close to the same heating capacity. If unsure about this setting leave it OFF. 
bool? EnableLoadBalancingCooler 
When ON balances the load between the 1st and 2nd stage coolers ensuring they run approximately the same time overall. Only applies when the System Type has 2 or more stages for cooling. When turning the cooler on this checks the time tally for each stage and will turn on whichever stage has the lowest total runtime. NOTE: Should only be enabled when the 1st and 2nd stages have close to the same cooling capacity. If unsure about this setting leave it OFF. 
bool? AwareWhenOccupied 
If turned on, the thermostat will report aware when motion is detected. "The Occupied Timeout" configuration acts as a rearm period for reporting motion. 
bool? AwareOnStateChange 
If On, when the Thermostat reports a state change it will mark that data message as aware. NOTE: The thermostat reports all state changes no matter what. If marked aware the message will force the gateway to send that data up to the server immediately. 
int? ReversingValve 
Indicates 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. 
int? FanControl 
Various control states for the fan. Auto: HVAC system not the thermostat control the fan. Auto+Periodic: Enable configuration to turn the fan of for a period of time at the beinning of a larger period of time. Meant to be used in conjunction with Fan On Period and Fan Auto Period configuration. If a cooling or heating event occurs, the Perodic Fan event time is reset. Active Fan Control: The thermostat actively controls when the fan turns on/off when the heating/cooling is started and stopped. Meant to be used in conjuction with the various Fan Start Time configurations.(Auto = 0, Auto+Periodic = 1, On = 2, Active Fan Control = 3) 
int? FanPeriod 
Amount of time the fan is forced on during the Fan Auto Period. Ex: Fan On Period = 10 minutes, Fan Auto Period = 120 minutes. At the beginning of the 120 minute Auto Period the fan will be forced on for 10 minutes. After 10 minutes the fan will turn off. 120 minutes after the fan was forced on the fan will be forced on again. Fan On Period must be less than Fan Auto Period. 
int? FanOnInterval 
Interval in which Fan On Period works. Fan Auto Period must be greater than Fan On Period. 
int? FanStartTimeForHeater 
Fan starts this amount of time after the heater starts. 
int? FanStopTimeForHeater 
Fan stops this amount of time after the heater stops. 
int? FanStartTimeForCooler 
Fan starts this amount of time after the cooler starts. 
int? FanStopTimeForCooler 
Fan stops this amount of time after the cooler starts. 
int? failedTransmissionsBeforeLinkMode 
The number of transmissions the sensor sends without response from a gateway before it goes to battery saving link mode. In link mode the sensor will scan for a new gateway and if not found will enter battery saving sleep mode for 2 hours before trying to scan again. Lower number will allow sensors to find new gateways with fewer missed readings. Higher numbers will cause the sensor to hold it setting in a noisy RF environment better. (Zero will cause the sensor to never enter link mode. to find a new gateway channel the battery will have to be cycled out of the sensor.) 
Copyright (c) 2022. All rights reserved.
What do you think about this topic? Send feedback!