Click or drag to resize

Thermostat Class

Base class for Crestron thermostats.
Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.Thermostats
Assembly: Crestron.SimplSharpPro.Thermostats (in Crestron.SimplSharpPro.Thermostats.dll) Version: 2.21.121
Syntax
C#
public class Thermostat : GenericDevice

The Thermostat type exposes the following members.

Properties
 NameDescription
Public propertyAuto1ptSetpoint 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.
Public propertyAuto1ptSetpointFeedback 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.

Public propertyAutoDeadbandFeedback 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.

Public propertyConnectedIpList 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)
Public propertyCoolCallFeedbacks Returns a collection of components that indicate when the system is calling for cooling.

The ClimateControlComponentCallChange event will trigger with ClimateControlComponent object.

Public propertyCoolSetpoint 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.
Public propertyCoolSetpointFeedback 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.

Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyHeatCallFeedbacks Returns a collection of components that indicate when the system is calling for heat.

The ClimateControlComponentCallChange event will trigger with ClimateControlComponent object.

Public propertyHeatSetpoint 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.
Public propertyHeatSetpointFeedback 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.

Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyLocalTemperatureFeedback 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.

Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyOutdoorTemperatureFeedback 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.

Public propertyOutdoorTemperatureInput 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.
Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyRegisterable Property to indicate that this device can be registered.
(Inherited from GenericDevice)
Public propertyRegistered Property to get the current registration state of the device.
(Inherited from GenericDevice)
Public propertyRegistrationFailureReason Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Inherited from GenericDevice)
Public propertyRegulationTemperatureFeedback 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.

Public propertyRemote1TemperatureFeedback Reports the temperature reported by the Remote 1 sensor. Only enabled when EnableSensorOutputs is enabled.

The TemperatureChange event will trigger with temperatureType and newTemperature.

Public propertyRemote2TemperatureFeedback 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.

Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertyType Property to determine to type of device this is.
(Inherited from GenericDevice)
Public propertyUnRegistrationFailureReason Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Inherited from GenericDevice)
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from GenericBase)
Protected propertyXioEndpointStubSIMPLDevice 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)
Top
Methods
 NameDescription
Protected method_CurrentSystemStateSlot_CueChange Method that handles CurrentSystemState slot events.
Protected method_HeatCoolControlSlot_CueChange Method that handles HeatCoolControl slot events.
Protected method_SystemConfigurationSlot_CueChange Method that handles SystemConfiguration slot events.
Public methodDispose Clean up of resources.
(Inherited from GenericBase)
Protected methodDispose(Boolean) Method to perform the actual disposing of the device.
(Inherited from GenericDevice)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Destructor of the device.
(Inherited from GenericDevice)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnBaseEvent(Int32) Protected member used to fire the BaseEvent with the default extended information.
(Inherited from GenericBase)
Protected methodOnBaseEvent(Int32, UInt16) Protected member used to fine the BaseEvent with extended event information.
(Inherited from GenericBase)
Protected methodOnClimateControlComponentEvent Method to fire the climate control component change event.
Protected methodOnFanCallEvent Method to fire the fan event.
Protected methodOnTemperatureChange Method to fire the temperature change event.
Public methodRegister Register this device with the system.
(Inherited from GenericDevice)
Public methodToString Return the name of the device.
(Inherited from GenericDevice)
Public methodUnRegister 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)
Top
Events
 NameDescription
Public eventBaseEvent Generic base event, triggered when the there are no other handlers available for a specific EventID.
(Inherited from GenericBase)
Public eventClimateControlComponentCallChange Event fired when a climate component change was received from the device.
Public eventFanCallChange Event fired when a fan change was received from the device.
Public eventIpInformationChange 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)
Public eventOnlineStatusChange Event triggered when the Online status of the device changes.
(Inherited from GenericDevice)
Public eventTemperatureChange Event fired when a temperature change was received from the device.
Top
Fields
 NameDescription
Protected field_CoolCallFeedbacks Returns a collection of components that indicate when the system is calling for cooling.
Protected field_CurrentSystemStateSlot Current system state slot device.
Protected field_HeatCallFeedbacks A collection of components that indicate when the system is calling for heat.
Protected field_HeatCoolControlSlot Heat/cool control slot device.
Protected field_SystemConfigurationSlot System configuration slot device.
Public fieldStatic memberAuto1ptSetpointFeedbackEventId The value of Auto1ptSetpointFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberAutoDeadbandFeedbackEventId The value of AutoDeadbandFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberCoolSetpointFeedbackEventId The value of CoolSetpointFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberHeatSetpointFeedbackEventId The value of HeatSetpointFeedback has changed.

The BaseEvent event will trigger for this event id.

Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also