Click or drag to resize

DinThstat Properties

The DinThstat type exposes the following members.

Properties
 NameDescription
Public propertyAnyFloorHeatSystemTypeFeedback Property to indicate if any system type using floor radiant heat is defined (can be both floor warming and space heating via floor radiant). true = A system type using floor radiant heat is defined; false = No system type using floor radiant heat is defined

The BaseEvent event will trigger with AnyFloorHeatSystemTypeFeedbackEventId.

Public propertyAnyHeatpumpSystemTypeFeedback Property to indicate if any heat pump control logic is used. true = A heat pump control logic is used; false = No heat pump control logic is used

The BaseEvent event will trigger with AnyHeatpumpSystemTypeFeedbackEventId.

Public propertyAnySpaceSystemTypeFeedback Property to indicate that if any space system type defined. true = A space system is defined; false = No space system is defined

The BaseEvent event will trigger with AnySpaceSystemTypeFeedbackEventId.

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.
(Inherited from Thermostat)
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.


(Inherited from Thermostat)
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.


(Inherited from Thermostat)
Public propertyAuxHeatCallFeedbacks Returns a collection of components that indicate when the system is calling for auxiliary heat.

The ClimateControlComponentCallChange event will trigger with ClimateControlComponent object.

Public propertyAuxInputActiveFeedback Indicates that the general-purpose opto-isolated input has voltage applied. This property is not supported by HZ-THSTAT.

The BaseEvent event will trigger with AuxInputActiveFeedbackEventId object.

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.


(Inherited from Thermostat)
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.
(Inherited from Thermostat)
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.


(Inherited from Thermostat)
Public propertyDehumidityCallFeedbacks Returns a collection of components that indicate when the system is making a dehumidity call.

The ClimateControlComponentCallChange event will trigger with ClimateControlComponent object.

Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDinUnitUiLockout Property to lock out operation of the UI on the DIN-THSTAT unit.
Public propertyDisplayMessage Property to set a string for displaying brief messages on remote UI.
Public propertyDisplayUnit Property to accept an enumeration for defining temperature unit format.
Public propertyDisplayUnitFeedback Property to report the enumeration for defining temperature unit format.

The BaseEvent event will trigger with DisplayUnitFeedbackEventId for this property.

Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyDualSetpointsAutoModeFeedback Property to indicate if auto mode uses separate heat and cool SP’s (instead of the single SP format).

The BaseEvent event will trigger with DualSetpointsAutoModeFeedbackEventId for this property.

Public propertyFanCallFeedback Indicates that the fan is running.

The FanCallChange event will trigger with ThermostatFanSpeed and ThermostatFanState.

Public propertyFanCirculationCallFeedback Indicates that the fan is circulating.

The FanCallChange event will trigger with ThermostatFanSpeed and ThermostatFanState.

Public propertyFanMode Sets the fan mode.
Public propertyFanModeFeedback Reports the commanded/current fan mode.

The BaseEvent event will trigger with FanModeFeedbackEventId.

Public propertyFloorTemperatureFeedback Reports the current floor temperature in tenths of current unit. This is like the “regulation” values from other slots, which can be an average of more than one floor sensor.  However, it is reported for any floor radiant system configuration, even if the type does not control the floor temperature.

The TemperatureChange event will trigger with temperatureType and newTemperature.

Public propertyFloorWarmingCallFeedbacks Returns a collection of components that indicate when the system is making a floor warming call.

The ClimateControlComponentCallChange event will trigger with ClimateControlComponent object.

Public propertyFloorWarmingMode Property to set the floor warming mode.
Public propertyFloorWarmingModeFeedback Property to report the floor warming system mode.

The BaseEvent event will trigger with FloorWarmingModeFeedbackEventId.

Public propertyFloorWarmingSetpoint Property to set the floor warming setpoint value in tenths of the current unit.
Public propertyFloorWarmingSetpointFeedback Reports the current floor warming setpoint value in tenths of the current unit.

The BaseEvent event will trigger with FloorWarmingSetpointFeedbackEventId.

Public propertyFloorWarmingSystemTypeFeedback Property to indicate if a floor warming system type is defined (independent signal; floor warming can be controlled separately from space). true = A floor warming system type is defined; false = No floor warming system type is defined

The BaseEvent event will trigger with FloorWarmingSystemTypeFeedbackEventId.

Public propertyFullSetupData Property to store full setup configuration for advanced debug or remote configuration.
Public propertyFullSetupDataFeedback Property to read full setup configuration for advanced debug or remote configuration.

FullSetupDataFeedback will trigger the event FullSetupDataFeedbackEventId.

Public propertyHeatCallFeedbacks 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)
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.
(Inherited from Thermostat)
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.


(Inherited from Thermostat)
Public propertyHumidistatEnabledFeedback Property to indicate if the humidistat operation is available. This is the humidistat feature enable, not the on/off mode control signal.

The BaseEvent event will trigger with HumidifierEnableFeedbackEventId for this property.

Public propertyHumidistatMode Sets the Humidistat mode.
Public propertyHumidistatModeFeedback Reports the current Humidistat mode.

The BaseEvent event will trigger with HumidifierModeFeedbackEventId for this property.

Public propertyHumidityCallFeedbacks Returns a collection of components that indicate when the system is making a humidity call.

The ClimateControlComponentCallChange event will trigger with ClimateControlComponent object.

Public propertyHumiditySetpoint Reports the current Humidistat setpoint value in 1% RH ticks. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
Public propertyHumiditySetpointFeedback Reports the current Humidistat setpoint value in 1% RH ticks. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.

The BaseEvent event will trigger with HumiditySetpointFeedbackEventId.

Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIndoorHumidity Property to provide indoor humidity in 1%RH ticks. For UI display only. This property is not supported by "HzThstat" device class and returns NullUShortInputSig when read. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
Public propertyInvalidFloorTemperatureFeedback Property to report if the device does not have a valid sensor source for floor temperature regulation/max temperature limiting. true = no valid sensor present; false = valid sensor present

The BaseEvent event will trigger with InvalidFloorTemperatureFeedbackEventId object.

Public propertyInvalidOutdoorTemperatureFeedback Property to report when device requires outdoor temperature and no valid source is present. Outdoor temperature is required in heat pump systems for proper balance point operation. Device may operate sub-optimally with timing-based safeguards to ensure freeze out protection. Note for balance point operation, outdoor temperature may be sourced from control system via OutdoorTemperatureInput. true = no valid sensor present; false = valid sensor present

The BaseEvent event will trigger with InvalidOutdoorTemperatureFeedbackEventId object.

Public propertyInvalidRegulationHumidityFeedback Indicates if device does not have a valid sensor source for space humidity regulation. true = valid sensor not present; false = valid sensor present

The BaseEvent event will trigger with RegHumInvalidEventId.

Public propertyInvalidRegulationTemperatureFeedback Indicates that if device does not have a valid sensor source for space (air) temperature regulation. true = no valid sensor present; false = valid sensor present

The BaseEvent event will trigger with InvalidRegulationTemperatureFeedbackEventId object.

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.


(Inherited from Thermostat)
Public propertyMaximumAuto1ptSetpointFeedback Property to report maximum auto setpoint (single-SP format) in 10ths of current unit.

The BaseEvent event will trigger with MaximumAuto1ptSetpointFeedbackEventId for this property.

Public propertyMaximumCoolSetpointFeedback Property to report maximum cool setpoint in 10ths of the current unit.

The BaseEvent event will trigger with MaximumCoolSetpointFeedbackEventId for this property.

Public propertyMaximumFloorWarmingSetpointFeedback Property to report maximum floor warming setpoint in 10ths of the current unit.

The BaseEvent event will trigger with MaximumFloorWarmingSetpointFeedbackEventId for this property.

Public propertyMaximumHeatSetpointFeedback Property to report maximum heat setpoint in 10ths of the current unit (required for scheduler).

The BaseEvent event will trigger with MaximumHeatSetpointFeedbackEventId for this property.

Public propertyMaximumHumiditySetpointFeedback Reports the maximum humidistat setpoint in 1% RH ticks. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.

The BaseEvent event will trigger with MaximumHumiditySetpointFeedbackEventId.

Public propertyMinimumAuto1ptSetpointFeedback Property to report minimum auto setpoint (single-SP format) in 10ths of current unit.

The BaseEvent event will trigger with MinimumAuto1ptSetpointFeedbackEventId for this property.

Public propertyMinimumCoolSetpointFeedback Property to report minimum cool setpoint in 10ths of the current unit.

The BaseEvent event will trigger with MinimumCoolSetpointFeedbackEventId for this property.

Public propertyMinimumFloorWarmingSetpointFeedback Property to report minimum floor warming setpoint in 10ths of the current unit.

The BaseEvent event will trigger with MinimumFloorWarmingSetpointFeedbackEventId for this property.

Public propertyMinimumHeatSetpointFeedback Property to report minimum heat setpoint in 10ths of the current unit (required for scheduler).

The BaseEvent event will trigger with MinimumHeatSetpointFeedbackEventId for this property.

Public propertyMinimumHumiditySetpointFeedback Reports the minimum humidistat setpoint in 1% RH ticks. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.

The BaseEvent event will trigger with MinimumHumiditySetpointFeedbackEventId.

Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyNumberOfRelayPorts Number of relay ports this device supports on Current System State slot. HZ-THSTAT does not support this property and returns '0' when used.
Public propertyOutdoorHumidity Property to provide outdoor humidity in 1%RH ticks. For displaying OD conditions on UI. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
Public propertyOutdoorHumidityFeedback Property to report the outdoor humidity in 1%RH ticks. For displaying OD conditions on UI. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.

The HumidityEvent event will trigger with eHumidityType and OutdoorHumidityFeedback value.

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.


(Inherited from Thermostat)
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.
(Inherited from Thermostat)
Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyRawRelayCallMaskFeedback Reports a mask of the actual relays being called. For debug only. Normal end user UI operation would not want to use this signal.

The BaseEvent event will trigger with RawRelayCallMaskFeedbackEventId.

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 propertyRegulationHumidityFeedback Reports the current value of the humidistat regulation humidity (as would be displayed on the thermostat UI, which can be an average of multiple sensors).

The HumidityEvent event will trigger with eHumidityType and RegulationHumidityFeedback value.

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.


(Inherited from Thermostat)
Public propertyRelayPorts Collection of relay ports on the device on Current System State slot. HZ-THSTAT does not support this property and returns an empty collection when used.
Public propertyRemote1HumidityFeedback

Reports the humidity reading of the Remote 1 humidity sensor in whole numbers. The Remote 1 humidity reading is reported regardless of the Use/Omit/OD designation.

The HumidityEvent event will trigger with eHumidityType and Remote1HumidityFeedback value.

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.


(Inherited from Thermostat)
Public propertyRemote2HumidityFeedback Reports the humidity reading of the Remote 2 humidity sensor in whole numbers. The Remote 2 humidity reading is reported regardless of the Use/Omit/OD designation.

The HumidityEvent event will trigger with eHumidityType and Remote2HumidityFeedback value.

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.


(Inherited from Thermostat)
Public propertyRemote3HumidityFeedback Reports the humidity reading of the Remote 3 humidity sensor in whole numbers. The Remote 3 humidity reading is reported regardless of the Use/Omit/OD designation. This property is not supported for HZ-THSTAT.

The HumidityEvent event will trigger with eHumidityType and Remote3HumidityFeedback value.

Public propertyRemote3TemperatureFeedback Reports the temperature from the remote sensor channel3 in tenths of the current unit, regardless of how sensor is configured. This property is not supported by HZ-THSTAT.

The TemperatureChange event will trigger with temperatureType and newTemperature.

Public propertySchedulerEnabledFeedback Property to indicate if Scheduler operation is available. Some installations may not require scheduler operation (not related to run/hold state).

The BaseEvent event will trigger with SchedulerEnabledFeedbackEventId for this property.

Public propertySchedulerOperation Scheduler Operation present on this device. This property will be 'null' when not supported. This Property is not supported by HZ-THSTAT.

This property will trigger BaseEvent with event IDs defined in DinThstat.

Public propertySchedulerRunHold Property to set the run/hold state of the scheduler.
Public propertySchedulerRunHoldFeedback Property to report the run/hold state of the scheduler.

The BaseEvent event will trigger with SchedulerRunHoldFeedbackEventId.

Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertySpaceAutoEnabledFeedback Property to indicate if the space auto system mode is available. Unsupported modes can be disabled in setup to reduce UI clutter.

The BaseEvent event will trigger with SpaceAutoEnabledFeedbackEventId for this property.

Public propertySpaceAuxHeatEnabledFeedback Property to indicate if aux-heat-only mode is available. Duplicates AnySpaceSystemTypeFeedback state. For clarity, may want to keep a dedicated signal.

The BaseEvent event will trigger with SpaceAuxHeatEnabledFeedbackEventId for this property.

Public propertySpaceCoolEnabledFeedback Property to indicate if the space cool system mode is available. Unsupported modes can be disabled in setup to reduce UI clutter.

The BaseEvent event will trigger with SpaceCoolEnabledFeedbackEventId.

Public propertySpaceHeatEnabledFeedback Property to indicate if the space heat system mode is available. Unsupported modes can be disabled in setup to reduce UI clutter.

The BaseEvent event will trigger with SpaceHeatEnabledFeedbackEventId.

Public propertySpaceSystemMode Sets the space system mode.
Public propertySpaceSystemModeFeedback Reports the commanded/current space system mode.

The BaseEvent event will trigger with SpaceSystemModeFeedbackEventId.

Public propertyType Property to determine to type of device this is.
(Inherited from GenericDevice)
Public propertyUiLanguage Property to set the HZ-THSTAT User Interface Language. Property not supported by DIN-TSTAT, returns '0' when used. Property not supported by HZ-TSTAT in the 1.000.XXXX firmware release. Reserved for future use.
Public propertyUiLanguageFeedback Property to report the current HZ-THSTAT User Interface Language. Property not supported by DIN-TSTAT, returns '0' when used. Property not supported by HZ-TSTAT in the 1.000.XXXX firmware release. Reserved for future use.

The BaseEvent event will trigger with UiLanguageFeedbackEventId.

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)
Public propertyZoneName Property for naming device zone/use.
Public propertyZoneNameFeedback Property to return the name of the device zone/use.

The BaseEvent event will trigger with ZoneNameFeedbackEventId.

Top
See Also