RFThermostat Class |
public class RFThermostat : Thermostat, IBatteryDevice
The RFThermostat type exposes the following members.
| Name | Description | |
|---|---|---|
| RFThermostat | Base constructor for radio frequency thermostat devices. |
| Name | Description | |
|---|---|---|
| Auto1ptSetpoint |
Sets the auto1pt setpoint, where 1d = 0.1 degrees.
The value is based on the current temperature scale (Fahrenheit or Celsius).
The displayed value is rounded to whole or half degrees based on the setting.
(Inherited from Thermostat) | |
| Auto1ptSetpointFeedback |
Reports the active auto1pt setpoint value.
This output should be connected to the corresponding setpoint input; otherwise the output will not report the setpoint value.
The BaseEvent event will trigger with Auto1ptSetpointFeedbackEventId. (Inherited from Thermostat) | |
| AutoAsSingleSetpointFeedback | Indicates that single-setpoint auto mode is enabled (the "s" option for auto mode has been selected in the Setup menu). The output remains true for as long as single-setpoint auto mode is active. | |
| AutoDeadbandFeedback |
Reports the auto deadband value selected via the "db" option in the Setup menu, where 1d = 0.1 degrees.
In dual-setpoint auto mode, this value is the minimum separation between heat and cool setpoints,
which prevents the system from toggling back and forth due to overshoot.
In single-setpoint auto mode, this value sets the hysteresis used when changing from heat to cool.
For example, if the setpoint is 70°F with auto deadband of 2 degrees,
the temperature would have to rise to 72°F before running cool, and 68°F before running heat.
HZ-THSTAT reports auto mode deadband parameter in 10ths of current unit:
Fahrenheit : 20, 30, 40, 50, 60 (F).
Celsius : 10, 20, 30 (C).
The BaseEvent event will trigger with AutoDeadbandFeedbackEventId. (Inherited from Thermostat) | |
| AutoModeEnabledFeedback | Indicates that the auto mode has been enabled. The output remains true for as long as the mode is enabled. Note that this output only indicates that the unit has been configured to support the corresponding mode; it does not indicate whether or not the unit is actively in that mode. | |
| AuxHeatAvailableFeedback | Indicates that the system is capable of running an auxiliary heat system (heat pump systems only). The output remains true for as long as the system supports auxiliary heat. | |
| BatteryState | Returns the current battery state. | |
| ConnectedIpList |
A property containing the list of the ConnectedIpInformation objects which contain information about the devices that are connected to this IP ID.
This property is only valid for an ethernet device. If this is not an ethernet device, then this property will return null.
If this is an ethernet device, the list will be non-null. It will be empty if no devices are connected.
The order of items in this list is not guaranteed.
(Inherited from GenericDevice) | |
| CoolCallFeedbacks |
Returns a collection of components that indicate when the system is calling for cooling.
The ClimateControlComponentCallChange event will trigger with ClimateControlComponent object. (Inherited from Thermostat) | |
| CoolModeEnabledFeedback | Indicates that the cool mode has been enabled. The output remains true for as long as the mode is enabled. Note that this output only indicates that the unit has been configured to support the corresponding mode; it does not indicate whether or not the unit is actively in that mode. | |
| CoolSetpoint |
Sets the cool setpoint, where 1d = 0.1 degrees.
The value is based on the current temperature scale (Fahrenheit or Celsius).
The displayed value is rounded to whole or half degrees based on the setting.
(Inherited from Thermostat) | |
| CoolSetpointFeedback |
Reports the active cool setpoint value.
This output should be connected to the corresponding setpoint input; otherwise the output will not report the setpoint value.
The BaseEvent event will trigger with CoolSetpointFeedbackEventId. (Inherited from Thermostat) | |
| Description |
Get/Set the description of this device.
(Inherited from GenericBase) | |
| DisableBacklight | Disables the backlight from turning on under any condition, for as long as the input is true. This can be used to extend battery life. | |
| DisplayUnit | Reports the current temperature format. | |
| DisplayUnitFeedback | Reports the current temperature format. | |
| Disposed |
Property to indicate if the device has been disposed.
(Inherited from GenericDevice) | |
| EnableSensorOutputs | Enables temperature reporting on Slot 01 for the Local Remote 1 and Remote 2 sensors. | |
| FanMode | Sets the fan mode. | |
| FanModeFeedback | Reports the current fan mode. | |
| HeatCallFeedbacks |
Returns a collection of components that indicate when the system is calling for heat.
The ClimateControlComponentCallChange event will trigger with ClimateControlComponent object. (Inherited from Thermostat) | |
| HeatModeEnabledFeedback | Indicates that the heat mode has been enabled. The output remains true for as long as the mode is enabled. Note that this output only indicates that the unit has been configured to support the corresponding mode; it does not indicate whether or not the unit is actively in that mode. | |
| HeatSetpoint |
Sets the heat setpoint, where 1d = 0.1 degrees.
The value is based on the current temperature scale (Fahrenheit or Celsius).
The displayed value is rounded to whole or half degrees based on the setting.
(Inherited from Thermostat) | |
| HeatSetpointFeedback |
Reports the active heat setpoint value.
This output should be connected to the corresponding setpoint input; otherwise the output will not report the setpoint value.
The BaseEvent event will trigger with HeatSetpointFeedbackEventId. (Inherited from Thermostat) | |
| HoldMode | Sets the hold mode as follows: 1d = Hold mode ON 2d = Hold mode OFF (Run mode ON) When hold mode is active, the setpoint can be manually adjusted, either locally or via the Simpl#Pro program. All scheduled setpoints are ignored until the unit is taken out of hold mode. When the hold state changes from Hold (1d) to Run (2d), the unit will recall the last scheduled setpoint. | |
| HoldModeFeedback | Reports the current hold mode. | |
| ID |
Property to get the ID of the device.
(Inherited from GenericDevice) | |
| IsOnline |
Property to get the current online state of the device.
(Inherited from GenericDevice) | |
| LocalTemperatureFeedback |
Reports the local temperature reported by the Local sensor.
Only enabled when EnableSensorOutputs is enabled.
This property is supported by "HZThstat" not supported by "DinThstat".
The TemperatureChange event will trigger with temperatureType and newTemperature. (Inherited from Thermostat) | |
| MaxAuto1ptSetpointFeedback | Reports the maximum allowable single-point auto setpoint that the system supports, where 1d = 0.1 degrees. The value is based on the current temperature scale (Fahrenheit or Celsius), as reported by DisplayUnitFeedback. | |
| MaxCoolSetpointFeedback | Reports the maximum allowable cool that the system supports, where 1d = 0.1 degrees. The value is based on the current temperature scale (Fahrenheit or Celsius), as reported by DisplayUnitFeedback. | |
| MaxHeatSetpointFeedback | Reports the maximum allowable heat that the system supports, where 1d = 0.1 degrees. The value is based on the current temperature scale (Fahrenheit or Celsius), as reported by DisplayUnitFeedback. | |
| MinAuto1ptSetpointFeedback | Reports the minimum allowable single-point auto setpoint that the system supports, where 1d = 0.1 degrees. The value is based on the current temperature scale (Fahrenheit or Celsius), as reported by DisplayUnitFeedback. | |
| MinCoolSetpointFeedback | Reports the minimum allowable cool that the system supports, where 1d = 0.1 degrees. The value is based on the current temperature scale (Fahrenheit or Celsius), as reported by DisplayUnitFeedback. | |
| MinHeatSetpointFeedback | Reports the minimum allowable heat that the system supports, where 1d = 0.1 degrees. The value is based on the current temperature scale (Fahrenheit or Celsius), as reported by DisplayUnitFeedback. | |
| Name |
Get the name of this device.
(Inherited from GenericBase) | |
| OutdoorTemperatureFeedback |
Sends the current outdoor temperature to the thermostat.
This input should only be used for heatpump/dual fuel balance point systems, not heat/cool system types.
The value should be sent in tenths of a degree (1d = 0.1 degrees) based on the current temperature scale (Fahrenheit or Celsius).
For example, if the outdoor temperature is 45.3°F, the value should be 453.
The TemperatureChange event will trigger with temperatureType and newTemperature. (Inherited from Thermostat) | |
| OutdoorTemperatureInput |
Sends the current outdoor temperature to the thermostat.
This input should only be used for heatpump/dual fuel balance point systems, not heat/cool system types.
The value should be sent in tenths of a degree (1d = 0.1 degrees) based on the current temperature scale (Fahrenheit or Celsius).
For example, if the outdoor temperature is 45.3°F, the value should be 453d.
(Inherited from Thermostat) | |
| Parent |
The parent that a given object was added to.
(Inherited from GenericBase) | |
| Registerable |
Property to indicate that this device can be registered.
(Inherited from GenericDevice) | |
| Registered |
Property to get the current registration state of the device.
(Inherited from GenericDevice) | |
| RegistrationFailureReason |
Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Inherited from GenericDevice) | |
| RegulationTemperatureFeedback |
Reports displayed temperature, which can be the Local temperature or the Remote 1 temperature, or the average of Local and Remote 1,
based on the option selected in the Setup menu (Local = i; Remote 1 = r; Average = ir).
The TemperatureChange event will trigger with temperatureType and newTemperature. (Inherited from Thermostat) | |
| Remote1TemperatureFeedback |
Reports the temperature reported by the Remote 1 sensor.
Only enabled when EnableSensorOutputs is enabled.
The TemperatureChange event will trigger with temperatureType and newTemperature. (Inherited from Thermostat) | |
| Remote2TemperatureFeedback |
Reports the local temperature reported by the Remote 2 sensor.
Only enabled when EnableSensorOutputs is enabled.
The TemperatureChange event will trigger with temperatureType and newTemperature. (Inherited from Thermostat) | |
| SensorConfigurationFeedback | 16-bit analog value that reports sensor configuration information, as follows: bits 15 and 14: 2-bit version code, currently 00 bits 13 and 12: Reserved bit 11: RS2 temperature data valid (1) or invalid (0) bit 10: RS1 temperature data valid (1) or invalid (0) bit 9: Local temperature valid (1) or invalid (0) bit 8: RS2 sensor type digital (0) or analog/NTC (1) bit 7: RS1 sensor type digital (0) or analog/NTC (1) bit 6: Local sensor type digital (0) or analog/NTC (1) bits 5 and 4: RS2 usage code (see below) bits 3 and 2: RS1 usage code bits 1 and 0: Local usage code Usage code 00: Not used/averaged 01: For regulation temperature 10: For outdoor temperature 11: For specific sensing (i.e., FCU changeover) | |
| SetpointsSchedule | Returns a ScheduledSetpoints object that has all of the thermostats scheduled setpoints cues. | |
| SIMPLDeviceImplementation |
Internal protected member used for actual device control.
(Inherited from GenericDevice) | |
| SystemConfigurationFeedback | For internal Crestron use only. | |
| SystemMode | Sets the system mode, as follows: When the system mode changes the unit will recall the last scheduled setpoint for that new mode. This output should be connected to the HoldMode input; otherwise the output it will not track the value of HoldMode. | |
| SystemModeFeedback | Reports the current system mode. | |
| Type |
Property to determine to type of device this is.
(Inherited from GenericDevice) | |
| UnRegistrationFailureReason |
Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Inherited from GenericDevice) | |
| UserSpecifiedObject |
Can be assigned anything that user wants.
(Inherited from GenericBase) | |
| XioEndpointStubSIMPLDevice |
The SIMPL "stub" Device that the XiO Director creates for an endpoint to send the 1C/0E to the
correct place in hierarchy.
(Inherited from GenericDevice) |
| Name | Description | |
|---|---|---|
| _CurrentSystemStateSlot_CueChange |
Method that handles CurrentSystemState slot events.
(Inherited from Thermostat) | |
| _HeatCoolControlSlot_CueChange |
Subscription to the Heat Cool Control slot.
(Overrides Thermostat_HeatCoolControlSlot_CueChange(CrestronDeviceWithEvents, SigEventArgs)) | |
| _SystemConfigurationSlot_CueChange |
Method that handles SystemConfiguration slot events.
(Inherited from Thermostat) | |
| Dispose |
Clean up of resources.
(Inherited from GenericBase) | |
| Dispose(Boolean) |
Method to perform the actual disposing of the device.
(Inherited from GenericDevice) | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| Finalize |
Destructor of the device.
(Inherited from GenericDevice) | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| InitializeDevice | Method used to initialize RF thermostats. | |
| InitializeScheduleSetpoints | Method used to initialize schedule setpoints objects. | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) | |
| OnBaseEvent(Int32) |
Protected member used to fire the BaseEvent with the default extended information.
(Inherited from GenericBase) | |
| OnBaseEvent(Int32, UInt16) |
Protected member used to fine the BaseEvent with extended event information.
(Inherited from GenericBase) | |
| OnBatteryEvent | Method to fire the battery change event. | |
| OnClimateControlComponentEvent |
Method to fire the climate control component change event.
(Inherited from Thermostat) | |
| OnFanCallEvent |
Method to fire the fan event.
(Inherited from Thermostat) | |
| OnTemperatureChange |
Method to fire the temperature change event.
(Inherited from Thermostat) | |
| Register |
Register this device with the system.
(Inherited from GenericDevice) | |
| ToString |
Return the name of the device.
(Inherited from GenericDevice) | |
| UnRegister |
Unregister this device with the system. This function can not be called from the device's own SigChange event handler.
On successful unregistration, if this device supports the OnlineStatusChange event, it will trigger indicating the device when offline. (Inherited from GenericDevice) |
| Name | Description | |
|---|---|---|
| BaseEvent |
Generic base event, triggered when the there are no other handlers available
for a specific EventID.
(Inherited from GenericBase) | |
| BatteryEvent | Event fired when a battery state change was received from the device. | |
| ClimateControlComponentCallChange |
Event fired when a climate component change was received from the device.
(Inherited from Thermostat) | |
| FanCallChange |
Event fired when a fan change was received from the device.
(Inherited from Thermostat) | |
| IpInformationChange |
Event that tells what IP Address is connected/disconnected from an IP ID for a non-UDP device.
This is only valid for an Ethernet device. An exception will be thrown if it is not.
(Inherited from GenericDevice) | |
| OnlineStatusChange |
Event triggered when the Online status of the device changes.
(Inherited from GenericDevice) | |
| TemperatureChange |
Event fired when a temperature change was received from the device.
(Inherited from Thermostat) |
| Name | Description | |
|---|---|---|
| _CoolCallFeedbacks |
Returns a collection of components that indicate when the system is calling for cooling.
(Inherited from Thermostat) | |
| _CurrentSystemStateSlot |
Current system state slot device.
(Inherited from Thermostat) | |
| _HeatCallFeedbacks |
A collection of components that indicate when the system is calling for heat.
(Inherited from Thermostat) | |
| _HeatCoolControlSlot |
Heat/cool control slot device.
(Inherited from Thermostat) | |
| _SystemConfigurationSlot |
System configuration slot device.
(Inherited from Thermostat) | |
| AutoAsSingleSetpointFeedbackEventId | Event ID for the base event for indicating that single-setpoint auto mode is enabled. | |
| AutoModeEnabledFeedbackEventId | Event ID for the base event for reporting that auto mode has been enabled. | |
| AuxHeatAvailableFeedbackEventId | Event ID for the base event for indicating that the system is capable of running an auxiliary heat system (heat pump systems only). The output remains true for as long as the system supports auxiliary heat. | |
| CoolModeEnabledFeedbackEventId | Event ID for the base event for reporting that cool mode has been enabled. | |
| DisplayUnitFeedbackEventId | Event ID for the base event for reporting that the current temperature format has changed. | |
| FanModeFeedbackEventId | Event ID for the base event for reporting the current fan setting. | |
| HeatModeEnabledFeedbackEventId | Event ID for the base event for reporting that heat mode has been enabled. | |
| HoldModeFeedbackEventId | Event ID for the base event for reporting the current hold mode. | |
| MaxAuto1ptSetpointFeedbackEventId | Event ID for the base event for reporting that the maximum allowable auto1pt setpoint has changed. | |
| MaxCoolSetpointFeedbackEventId | Event ID for the base event for reporting that the maximum allowable cool setpoint has changed. | |
| MaxHeatSetpointFeedbackEventId | Event ID for the base event for reporting that the maximum allowable heat setpoint has changed. | |
| MinAuto1ptSetpointFeedbackEventId | Event ID for the base event for reporting that the minimum allowable auto1pt setpoint has changed. | |
| MinCoolSetpointFeedbackEventId | Event ID for the base event for reporting that the minimum allowable cool setpoint has changed. | |
| MinHeatSetpointFeedbackEventId | Event ID for the base event for reporting that the minimum allowable heat setpoint has changed. | |
| SensorConfigurationFeedbackEventId | Event ID for the base event for reporting that the sensor configuration has changed. | |
| SystemConfigurationFeedbackEventId | Event ID for the base event for reporting that the system configuration has changed. | |
| SystemModeFeedbackEventId | Event ID for the base event for reporting the current system mode. |