Codecore Logo
Quick Search
»
Advanced Search »

Climate Control Simulator Driver

RSS
This driver simulates a real climate control system and is helpful for demonstrating the system and viewing/designing touch screen interfaces when a real climate control system is not available. If your Elve system came preconfigured with an instance of this driver in the device list, you will likely want to replace this with the appropriate device driver for your system.

Manufacturer: Codecore Technologies, LLC


Configuration Settings

Events

Thermostat Current Temperature Changed

Occurs when a thermostat current temperature changes.

Whenever Filter:

  • PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

  • Number Index : The index within the property array.
  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Thermostat Fan Mode Changed

Occurs when a thermostat fan mode changes.

Whenever Filter:

  • PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

  • Number Index : The index within the property array.
  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Thermostat Cool Set Point Changed

Occurs when a thermostat cool set point changes.

Whenever Filter:

  • PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

  • Number Index : The index within the property array.
  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Thermostat Heat Set Point Changed

Occurs when a thermostat heat set point changes.

Whenever Filter:

  • PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

  • Number Index : The index within the property array.
  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Thermostat Hold State Changed

Occurs when a thermostat hold state changes.

Whenever Filter:

  • PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

  • Number Index : The index within the property array.
  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Thermostat Mode Changed

Occurs when a thermostat mode changes.

Whenever Filter:

  • PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

  • Number Index : The index within the property array.
  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Thermostat Current Humidity Changed

Occurs when a thermostat current humidity changes.

Whenever Filter:

  • PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

  • Number Index : The index within the property array.
  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Ready State Changed

The device's running and ready state changed.

Whenever Filter:

none

EventArgs:

  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Instance Properties

Connected

Gets a value indicating if a connection is established with the thermostat device.

Accessibility : Read Only

Type: Boolean

ThermostatNames

Gets the names or all thermostats.

Accessibility : Read Only

Type: Array

ThermostatCurrentTemperatures

Gets the current thermostat temperatures.

Accessibility : Read Only

Type: Array

ThermostatFanModes

Gets the current thermostat fan modes.

Accessibility : Read Only

Type: Array

ThermostatFanModeTexts

Gets the current thermostat fan modes as displayable text.

Accessibility : Read Only

Type: Array

ThermostatCoolSetPoints

Gets the current thermostat cool set point temperatures.

Accessibility : Read Only

Type: Array

ThermostatHeatSetPoints

Gets the current thermostat heat set point temperatures.

Accessibility : Read Only

Type: Array

ThermostatHolds

Gets the current thermostat hold states.

Accessibility : Read Only

Type: Array

ThermostatModes

Gets the current thermostat modes.

Accessibility : Read Only

Type: Array

ThermostatModeTexts

Gets the current thermostat modes as displayable text.

Accessibility : Read Only

Type: Array

ThermostatCurrentHumidities

Gets the current thermostat humidities.

Accessibility : Read Only

Type: Array

DeviceDisplayName

The display name for this device.

Accessibility : Read Only

Type: String

DeviceStartTime

The date and time when this device was started.

Accessibility : Read Only

Type: DateTime

DeviceLifecycleStage

The current lifecycle stage of the device. The stages in order are: Pending Start, Starting, Running, Stopping

Accessibility : Read Only

Type: Number

DeviceIsRunningAndReady

Indicates if the device is ready for use, ie it is in the Running lifecycle stage and all properties are valid and all methods are ready to be used.

Accessibility : Read Only

Type: Boolean

Instance Methods

SetThermostatFanMode ( Number, Number )

Sets a thermostat's fan mode.

Syntax

void SetThermostatFanMode( Number thermostatID, Number fanMode )

Parameters

thermostatID : The ID of the thermostat.
fanMode : The fan mode: 0=auto, 1=on.

0 = Auto
1 = On

SetThermostatCoolSetPoint ( Number, Number )

Sets the cool set point temperature of a thermostat.

Syntax

void SetThermostatCoolSetPoint( Number thermostatID, Number setPoint )

Parameters

thermostatID : The ID of the thermostat. (1-16)
setPoint : The cool set point temperature. (0-99)

SetThermostatHeatSetPoint ( Number, Number )

Sets the heat set point temperature of a thermostat.

Syntax

void SetThermostatHeatSetPoint( Number thermostatID, Number setPoint )

Parameters

thermostatID : The ID of the thermostat. (1-16)
setPoint : The heat set point temperature. (0-99)

SetThermostatHold ( Number, Boolean )

Sets the hold state of a thermostat.

Syntax

void SetThermostatHold( Number thermostatID, Boolean hold )

Parameters

thermostatID : The ID of the thermostat. (1-16)
hold : The hold state. true=hold is on, false=hold is off.

SetThermostatMode ( Number, Number )

Sets the cooling/heating mode of a thermostat.

Syntax

void SetThermostatMode( Number thermostatID, Number mode )

Parameters

thermostatID : The ID of the thermostat. (1-16)
mode : The mode. 0=Off, 1=Heat, 2=Cool, 3=Auto, 4=Emergency Heat

0 = Off
1 = Heat
2 = Cool
3 = Auto
4 = Emergency Heat

SetPropertyForDuration ( String, TimeSpan, Object, Object )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax

void SetPropertyForDuration( String propertyName, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.
duration : The amount of time to wait after setting the initial value to set the subsequent value.
initialValue : The value to set the property to initially.
finalValue : The value to set the property to after the duration of time has passed.

SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax

void SetPropertyForDuration( String propertyName, Number arrayIndex, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.
arrayIndex : The property's array index to set.
duration : The amount of time to wait after setting the initial value to set the subsequent value.
initialValue : The value to set the property to initially.
finalValue : The value to set the property to after the duration of time has passed.

Privacy Policy | Conditions Of Use

Copyright ©2014 Codecore Technologies, All rights reserved.