Codecore Logo
Quick Search
»
Advanced Search »

Proliphix Thermostat Driver

RSS
The Proliphix Driver monitors and controls a Proliphix thermostat .

Manufacturer: Proliphix, Inc

Primary Communications Port: Network

Table of Contents [Hide/Show]


Configuration Settings
Events
   Thermostat Current Temperature Changed
   Thermostat High Temperature Alarm State Changed
   Thermostat Low Temperature Alarm State Changed
   Thermostat Current Humidity Changed
   Thermostat High Humidity Alarm State Changed
   Thermostat High Temperature Alarm State Changed
   Thermostat Internal temperature Changed
   Thermostat Remote Sensor 2 temperature Changed
   Thermostat Remote Sensor 3 temperature Changed
   Thermostat Fan Mode Changed
   Thermostat Fan State Changed
   Thermostat Cool Set Point Changed
   Thermostat Heat Set Point Changed
   Thermostat Hold State Changed
   Thermostat Name Changed
   Thermostat State Changed
   Ready State Changed
Instance Properties
   ThermostatNames
   ThermostatTypes
   ThermostatCurrentTemperatures
   ThermostatAlarmHTemp
   ThermostatAlarmLTemp
   ThermostatCurrentHumidity
   ThermostatAlarmHHum
   ThermostatAlarmFilter
   ThermostatTemperatureScales
   ThermostatLastUpdates
   ThermostatInternalTemperatures
   ThermostatRemoteSensor2Names
   ThermostatRemoteSensor2Temperatures
   ThermostatRemoteSensor3Names
   ThermostatRemoteSensor3Temperatures
   ThermostatFanModes
   ThermostatFanModeTexts
   ThermostatFanStates
   ThermostatCoolSetPoints
   ThermostatHeatSetPoints
   ThermostatHolds
   ThermostatDisplayText
   ThermostatModes
   ThermostatStates
   ThermostatModeTexts
   ThermostatUsageHeat1
   ThermostatUsageHeat2
   ThermostatUsageCool1
   ThermostatUsageCool2
   ThermostatUsageFan
   DeviceDisplayName
   DeviceStartTime
   DeviceLifecycleStage
   DeviceIsRunningAndReady
Instance Methods
   SetThermostatCoolSetPoint ( Number, Number )
   SetThermostatHeatSetPoint ( Number, Number )
   SetThermostatFanMode ( Number, Number )
   SetThermostatHold ( Number, Boolean )
   SetThermostatMode ( Number, Number )
   SetThermostatCoolSetPoint ( Number, String )
   SetPropertyForDuration ( String, TimeSpan, Object, Object )
   SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )


Configuration Settings

  • Host Name : The IP address of the Proliphix thermostat in the format 192.168.0.0.
  • Port Number : The port number used for communicating with the Proliphix thermostat. Default is 80.
  • Username : The username used to access the Proliphix thermostat. Default is 'admin'.
  • Password : The password used to access the Proliphix thermostat. Default is 'admin'.

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 High Temperature Alarm State Changed

Occurs when a thermostat high temperature alarm 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 Low Temperature Alarm State Changed

Occurs when a thermostat low temperature alarm 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 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.

Thermostat High Humidity Alarm State Changed

Occurs when a thermostat high humidity alarm 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 High Temperature Alarm State Changed

Occurs when a thermostat filter reminder alarm 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 Internal temperature Changed

Occurs when a thermostat internal 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 Remote Sensor 2 temperature Changed

Occurs when a thermostat remote sensor 2 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 Remote Sensor 3 temperature Changed

Occurs when a thermostat remote sensor 3 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 Fan State Changed

Occurs when a thermostat fan 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 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 Name 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 State Changed

Occurs when a thermostat 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.

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

ThermostatNames

Gets the names or all thermostats.

Accessibility : Read Only

Type: Array

ThermostatTypes

Gets the thermostat types.

Accessibility : Read Only

Type: Array

ThermostatCurrentTemperatures

Gets the current thermostat temperatures.

Accessibility : Read Only

Type: Array

ThermostatAlarmHTemp

Gets the thermostat high temperature alarm states.

Accessibility : Read Only

Type: Array

ThermostatAlarmLTemp

Gets the thermostat low temperature alarm states.

Accessibility : Read Only

Type: Array

ThermostatCurrentHumidity

Gets the current thermostat humidity.

Accessibility : Read Only

Type: Array

ThermostatAlarmHHum

Gets the thermostat high humidity alarm states.

Accessibility : Read Only

Type: Array

ThermostatAlarmFilter

Gets the thermostat filter reminder alarm states.

Accessibility : Read Only

Type: Array

ThermostatTemperatureScales

Gets the thermostat temperature scales.

Accessibility : Read Only

Type: Array

ThermostatLastUpdates

Gets the time of the last thermostat updates.

Accessibility : Read Only

Type: Array

ThermostatInternalTemperatures

Gets the internal thermostat temperatures.

Accessibility : Read Only

Type: Array

ThermostatRemoteSensor2Names

Gets the remote sensor 2 names.

Accessibility : Read Only

Type: Array

ThermostatRemoteSensor2Temperatures

Gets the remote sensor 2 temperatures.

Accessibility : Read Only

Type: Array

ThermostatRemoteSensor3Names

Gets the remote sensor 3 names.

Accessibility : Read Only

Type: Array

ThermostatRemoteSensor3Temperatures

Gets the remote sensor 3 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

ThermostatFanStates

Gets the current thermostat fan states.

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

ThermostatDisplayText

Gets the text displayed on the thermostat.

Accessibility : Read Only

Type: Array

ThermostatModes

Gets the current thermostat modes.

Accessibility : Read Only

Type: Array

ThermostatStates

Gets the current thermostat states.

Accessibility : Read Only

Type: Array

ThermostatModeTexts

Gets the current thermostat modes as displayable text.

Accessibility : Read Only

Type: Array

ThermostatUsageHeat1

Gets the current thermostat first stage heat usages.

Accessibility : Read Only

Type: Array

ThermostatUsageHeat2

Gets the current thermostat second stage heat usages.

Accessibility : Read Only

Type: Array

ThermostatUsageCool1

Gets the current thermostat first stage cool usages.

Accessibility : Read Only

Type: Array

ThermostatUsageCool2

Gets the current thermostat second stage cool usages.

Accessibility : Read Only

Type: Array

ThermostatUsageFan

Gets the current thermostat fan usages.

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

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)
setPoint : The cool set point temperature. (25-95)

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)
setPoint : The heat set point temperature. (25-95)

SetThermostatFanMode ( Number, Number )

Sets a thermostat's fan mode.

Syntax

void SetThermostatFanMode( Number thermostatID, Number fanMode )

Parameters

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

0 = Auto
1 = On

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)
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-1)
mode : The mode. 0=Off, 1=Heat, 2=Cool, 3=Auto

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

SetThermostatCoolSetPoint ( Number, String )

Sets the display text of a thermostat.

Syntax

void SetThermostatCoolSetPoint( Number thermostatID, String displayText )

Parameters

thermostatID : The ID of the thermostat. (1)
displayText : The display text.

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.