Codecore Logo
Quick Search
»
Advanced Search »

Mi Casa Verde - Vera

RSS
Image
This driver supports the Mi Casa Verde Vera device.

Manufacturer: Mi Casa Verde

Primary Communications Port: Network

Table of Contents [Hide/Show]


Configuration Settings
Events
   Light Level Changed
   Light On/Off State Changed
   Thermostat Current Temperature Changed
   Thermostat Cool Set Point Changed
   Thermostat Fan Mode Changed
   Thermostat Heat Set Point Changed
   Thermostate Hold State Changed
   Thermostat Mode Changed
   Ready State Changed
Instance Properties
   LightLevels
   LightOnOffs
   LightNames
   FirmwareVersion
   BuildVersion
   Longitude
   Latitude
   City
   ThermostatNames
   ThermostatCurrentTemperatures
   ThermostatCoolSetPoints
   ThermostatFanModes
   ThermostatFanModeTexts
   ThermostatHeatSetPoints
   ThermostatHolds
   ThermostatModes
   ThermostatModeTexts
   DeviceDisplayName
   DeviceStartTime
   DeviceLifecycleStage
   DeviceIsRunningAndReady
Instance Methods
   TurnOnLight ( Number )
   TurnOffLight ( Number )
   SetLightLevel ( Number, Number )
   TurnOnAllLights
   TurnOffAllLights
   TurnOnLightByName ( String )
   TurnOffLightByName ( String )
   SetLightLevelByName ( String, Number )
   SetLightLevelForDuration ( Number, TimeSpan, Number, Number )
   TurnOnLightForDuration ( Number, TimeSpan )
   SetThermostatCoolSetPoint ( Number, Number )
   SetThermostatHeatSetPoint ( Number, Number )
   SetThermostatHold ( Number, Boolean )
   SetThermostatMode ( Number, Number )
   SetThermostatFanMode ( Number, Number )
   SetPropertyForDuration ( String, TimeSpan, Object, Object )
   SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )


Configuration Settings

  • Host Name : The host name or IP address of the Vera unit.
  • Temperature Scale : The temperature scale to use.

Events

Light Level Changed

Occurs when a light's level changes.

Whenever Filter:

  • PropertyIndex : The ID of the light level that changed.

EventArgs:

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

Light On/Off State Changed

Occurs when the light changes from on to off or off to on. Any level greater than zero is considered on.

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

Thermostate 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.

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

LightLevels

Gets the percent on level of the lights. 0-99

Accessibility : Read Only

Type: Array

LightOnOffs

Gets or sets the light to a fully on state or fully off.

Accessibility : Read Only

Type: Array

LightNames

Gets the names of the lights.

Accessibility : Read Only

Type: Array

FirmwareVersion

Gets the firmware version.

Accessibility : Read Only

Type: String

BuildVersion

Gets the build version.

Accessibility : Read Only

Type: String

Longitude

Gets the longitude setting.

Accessibility : Read Only

Type: Number

Latitude

Gets the latitude setting.

Accessibility : Read Only

Type: Number

City

Gets the city setting.

Accessibility : Read Only

Type: String

ThermostatNames

Gets the names or all thermostats.

Accessibility : Read Only

Type: Array

ThermostatCurrentTemperatures

Gets the current thermostat temperatures.

Accessibility : Read Only

Type: Array

ThermostatCoolSetPoints

Gets the current thermostat cool set point 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

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

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

TurnOnLight ( Number )

Turns on the specified node.

Syntax

void TurnOnLight( Number nodeID )

Parameters

nodeID : The id of the light.

TurnOffLight ( Number )

Turns off the specified node.

Syntax

void TurnOffLight( Number nodeID )

Parameters

nodeID : The id of the light.

SetLightLevel ( Number, Number )

Sets the specified node's level to the specified percent.

Syntax

void SetLightLevel( Number nodeID, Number percentOn )

Parameters

nodeID : The id of the light.
percentOn : The percent level to set the light to. Valid values: 0 to 99 where 0 is typically off and 99 is fully on.

TurnOnAllLights

Turns all lights on.

Syntax

void TurnOnAllLights( )

Parameters

none

TurnOffAllLights

Turns all lights off.

Syntax

void TurnOffAllLights( )

Parameters

none

TurnOnLightByName ( String )

Turns on the specified node.

Syntax

void TurnOnLightByName( String name )

Parameters

name : The name of the light.

TurnOffLightByName ( String )

Turns off the specified node.

Syntax

void TurnOffLightByName( String name )

Parameters

name : The name of the light.

SetLightLevelByName ( String, Number )

Sets the specified node's level to the specified percent.

Syntax

void SetLightLevelByName( String name, Number percentOn )

Parameters

name : The name of the light.
percentOn : The percent level to set the light to. Valid values: 0 to 99 where 0 is typically off and 99 is fully on.

SetLightLevelForDuration ( Number, TimeSpan, Number, Number )

Sets a light's level for a duration of time and then sets the light to a subsequent level.

Syntax

void SetLightLevelForDuration( Number iD, unknown duration, Number initialPercentOn, Number finalPercentOn )

Parameters

iD : The id of the light.
duration : The amount of time to wait before setting the light level to the specified subsequent light level.
initialPercentOn : The percent level to set the light to.
finalPercentOn : The percent level to set the light to after the duration has passed.

TurnOnLightForDuration ( Number, TimeSpan )

Turns a light fully on for a duration of time and then turns the light off.

Syntax

void TurnOnLightForDuration( Number iD, unknown duration )

Parameters

iD : The id of the light.
duration : The amount of time to wait before turning off the light.

SetThermostatCoolSetPoint ( Number, Number )

Sets the cool set point temperature of a thermostat.

Syntax

void SetThermostatCoolSetPoint( Number deviceID, Number setPoint )

Parameters

deviceID : The ID of the thermostat.
setPoint : The cool set point temperature.

SetThermostatHeatSetPoint ( Number, Number )

Sets the heat set point temperature of a thermostat.

Syntax

void SetThermostatHeatSetPoint( Number deviceID, Number setPoint )

Parameters

deviceID : The ID of the thermostat.
setPoint : The heat set point temperature.

SetThermostatHold ( Number, Boolean )

Sets the hold state of a thermostat. VERA DOES NOT SUPPORT THIS COMMAND.

Syntax

void SetThermostatHold( Number deviceID, Boolean hold )

Parameters

deviceID : The ID of the thermostat.
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 deviceID, Number mode )

Parameters

deviceID : The ID of the thermostat.
mode : The mode. 0=Off, 1=Heat, 2=Cool, 3=Auto,

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

SetThermostatFanMode ( Number, Number )

Sets a thermostat's fan mode.

Syntax

void SetThermostatFanMode( Number deviceID, Number fanMode )

Parameters

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

0 = Auto
1 = On

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.