James: 1 revision

2021-01-13T17:25:01Z

1 revision

Jitterjames at 19:05, 20 April 2015

2015-04-20T19:05:25Z

New page

[[Vera Configuration|Click here for installation and configuration instructions for the Vera plugin.]]

Go to the main '''[[Plugins]]''' page.

Go to the complete '''[[Plugin List]]'''.

=Plugin Description=

Home automation for the VeraLite and Vera3 devices provided by http://getvera.com/

=Actions for the Vera plugin=
==Dim==
[[Vera.Dim]] 
Set the dim level of a dimmable device.

* Parameters: 2
#DeviceId : Device ID Assigned by Vera [''integer'']
#Level : Brightness level: 0-100 [''integer'']
==GenXML==
[[Vera.GenXML]] 
Generate payload xml for your vera devices and scenes.

* Parameters: 1
#Path : [''string'']
==Get==
Query a device for information about its current state. See available subcommands for details. Note that in order to work efficiently with Vera device ID numbers, you will likely want to use either payload XMLs or "maps" (to associate ID numbers with some kind of "friendly name" for your devices). These can be generated in the Vera plugin settings. 
===Armed===
[[Vera.Get.Armed]] 
Queries a device to find out if it is armed or not. Returns 1 if armed, 0 if not armed. Works with devices that support the service ID: urn:micasaverde-com:serviceId:SecuritySensor1

* Parameters: 1
#DeviceID : ID Assigned by Vera [''integer'']
===BatteryLevel===
[[Vera.Get.BatteryLevel]] 
For a given device ID, queries a device to determine the percentage of battery charge remaining. Returns a number from 0 to 100. Works with devices that support the service ID: urn:micasaverde-com:serviceId:HaDevice1

* Parameters: 1
#DeviceID : ID Assigned by Vera [''integer'']
===Dim===
[[Vera.Get.Dim]] 
Queries a device (e.g, a light) to get its brightness level. Returns a value from 0 to 100. If device is off, the brightness will be 0. Works with devices that support the service ID: urn:upnp-org:serviceId:Dimming1

* Parameters: 1
#DeviceID : ID Assigned by Vera [''integer'']
===HouseMode===
[[Vera.Get.HouseMode]] 
** Works with UI7 Only Returns the current house mode of the Vera unit. 1: Home 2: Away 3: Night 4: Vacation
===Humidity===
[[Vera.Get.Humidity]] 
Queries a device and returns the last humidity level reported by that sensor (a value from 0 to 100). Works with devices that support the service ID: urn:micasaverde-com:serviceId:HumiditySensor1

* Parameters: 1
#DeviceID : ID Assigned by Vera [''integer'']
===HVAC_FanOpMode===
[[Vera.Get.HVAC_FanOpMode]] 
Queries an HVAC device to find the status of the fan operating mode. (Auto, ContinuousOn, PeriodicOn) Works with devices that support the service ID: urn:upnp-org:serviceId:HVAC_FanOperatingMode1

* Parameters: 1
#DeviceID : ID Assigned by Vera [''integer'']
===HVAC_StPtCool===
[[Vera.Get.HVAC_StPtCool]] 
Queries an HVAC device to find the temperature setpoint for cooling. Works with devices that support the service ID: urn:upnp-org:serviceId:TemperatureSetpoint1_Cool

* Parameters: 1
#DeviceID : ID Assigned by Vera [''integer'']
===HVAC_StPtHeat===
[[Vera.Get.HVAC_StPtHeat]] 
Queries an HVAC device to find the temperature setpoint for heating. Works with devices that support the service ID: urn:upnp-org:serviceId:TemperatureSetpoint1_Heat

* Parameters: 1
#DeviceID : ID Assigned by Vera [''integer'']
===HVAC_UserOpMode===
[[Vera.Get.HVAC_UserOpMode]] 
Queries an HVAC device to find the mode status of the user operating mode. (Off, HeatOn, CoolOn, AutoChangeOver) Works with devices that support the service ID: urn:upnp-org:serviceId:HVAC_UserOperatingMode1

* Parameters: 1
#DeviceID : ID Assigned by Vera [''integer'']
===LightLevel===
[[Vera.Get.LightLevel]] 
Queries sensor device and returns perceived brightness of environment. Some devices return a value from 0 to 100, but not all devices use the same range. Check your device manual. Works with devices that support the service ID: urn:micasaverde-com:serviceId:LightSensor1

* Parameters: 1
#DeviceID : ID Assigned by Vera [''integer'']
===LockStatus===
[[Vera.Get.LockStatus]] 
Queries a device to find out if it is locked or unlocked. Returns 1 if device is locked, 0 if deviced is unlocked.

* Parameters: 1
#DeviceID : ID of lock, assinged by Vera ['''']
===LuVar===
[[Vera.Get.LuVar]] 
Requests the current value of any variable of a Vera device if you know the <DeviceID> <VarName> and <ServiceID>. Device IDs can be found in the Vera UI or by inspecting the map table generated by the plugin. Service IDs and Variables names can be found in the Vera UI or by clicking "Edit Known Variables" on the plugin settings window.

* Parameters: 3
#DeviceID : e.g. 3 [''integer'']
#VarName : e.g. Status [''string'']
#ServiceID : e.g. urn:upnp-org:serviceId:SwitchPower1 [''string'']
===MultiSwitch===
[[Vera.Get.MultiSwitch]] 

* Parameters: 2
#DeviceId : [''integer'']
#SwitchNum : [''integer'']
===Status===
[[Vera.Get.Status]] 
Queries a device to find out if it is on or off. May also work with window coverings. Lights return 1 for "on" and 0 for "off" Window coverings return 1 if "closed" , 0 if "open" (untested) Works with devices that support the service ID: urn:upnp-org:serviceId:SwitchPower1

* Parameters: 1
#DeviceID : ID Assigned by Vera [''integer'']
===Temperature===
[[Vera.Get.Temperature]] 
Queries a device and returns the last temperature level reported by that sensor. Value returned will depend on the device and how you have configured it. Check your device manual. Works with devices that support the service ID: urn:upnp-org:serviceId:TemperatureSensor1 

* Parameters: 1
#DeviceID : ID Assigned by Vera [''integer'']
===Tripped===
[[Vera.Get.Tripped]] 
Queries a sensor device to find out if it has been tripped. Returns 1 if true, 0 if false. Works with devices that support the service ID: urn:micasaverde-com:serviceId:SecuritySensor1

* Parameters: 1
#DeviceID : ID Assigned by Vera [''integer'']
==HVAC==
Set HVAC modes and variables such as fan mode and temperature setpoint.
===SetFanOpMode===
[[Vera.HVAC.SetFanOpMode]] 
Sets the fan operating mode of an HVAC device. <Mode> must be one of: Auto ContinuousOn PeriodicOn *Note: <Mode> is case sensitive.

* Parameters: 2
#DeviceID : Device ID Assigned by Vera [''integer'']
#Mode : Auto, ContinuousOn, PeriodicOn [''string'']
===SetUserOpMode===
[[Vera.HVAC.SetUserOpMode]] 
Sets the user operating mode of an HVAC device. <Mode> must be one of: Off HeatOn CoolOn AutoChangeOver *Note: <Mode> is case sensitive.

* Parameters: 2
#DeviceID : Device ID Assigned by Vera [''integer'']
#Mode : Off, HeatOn, CoolOn, AutoChangeOver [''string'']
===SetPtHeat===
[[Vera.HVAC.SetPtHeat]] 
Sets the heating setpoint of an HVAC device. *Note: <Mode> is case sensitive.

* Parameters: 2
#DeviceID : Device ID Assigned by Vera [''integer'']
#Temperature : New setpoint temperature to set [''integer'']
===SetPtCool===
[[Vera.HVAC.SetPtCool]] 
Sets the cooling setpoint of an HVAC device.

* Parameters: 2
#DeviceID : Device ID Assigned by Vera [''integer'']
#Temperature : New setpoint temperature to set [''integer'']
==ListDevices==
[[Vera.ListDevices]] 
Returns list of Vera rooms, devices, and scenes by ID number. This action is for reference/discovery purposes.
==PTZ==
[[Vera.PTZ]] 
Actions for Pan Tilt Zoom Camera control. <Action> can be one of: MoveLeft, MoveRight, MoveUp, MoveDown, ZoomIn, ZoomOut

* Parameters: 2
#DeviceID : Device ID Assigned by Vera [''integer'']
#Action : Moveup,MoveLeft etc. [''string'']
==Raw==
[[Vera.Raw]] 
Lets you send any HTTP Luup request to the Vera unit. Use this action if you need to extend functionality beyond what is already provided in VoxCommando's Vera plugin. Note that you only need to include the string that appears after the last slash (/) of the URL. e.g. data_request?id=variableget&... For more complete syntax reference see: http://wiki.micasaverde.com/index.php/Luup_Requests

* Parameters: 1
#Command : eg: data_request?id=variableget&... [''string'']
==Scene==
[[Vera.Scene]] 
Trigger a scene by specifying its ID.

* Parameters: 1
#SceneID : ID of scene, assigned by Vera [''string'']
==SelectVera==
[[Vera.SelectVera]] 
Select one of the two Vera devices defined in the plugin settings. All subsequent Vera actions will target this device.

* Parameters: 1
#VeraNum : 1 or 2 [''integer'']
==Set==
Set variables for a device. See available subcommands for details. Note that in order to work efficiently with Vera device ID numbers, you will likely want to use either payload XMLs or "maps" (to associate ID numbers with some kind of "friendly name" for your devices). These can be generated in the Vera plugin settings.
===LuVar===
[[Vera.Set.LuVar]] 
Sets the current value of any variable of a Vera device to <NewValue> if you know the <DeviceID> <VarName> and <ServiceID>. Device IDs can be found in the Vera UI or by inspecting the map table generated by the Vera plugin. Service IDs and variable names can be found in the Vera UI or by clicking "Edit Known Variables" on the Vera plugin settings window.

* Parameters: 4
#DeviceID : e.g. 3 [''integer'']
#VarName : e.g. Status [''string'']
#ServiceID : e.g. urn:upnp-org:serviceId:SwitchPower1 [''string'']
#NewValue : e.g. 0 [''string'']
===MultiSwitch===
[[Vera.Set.MultiSwitch]] 
Sets the current value of a MultiSwitch switch. <Device ID> can be found in the Vera UI or by inspecting the map table generated by the Vera plugin. <State> values of 0,1, or -1 respectively will turn the switch On, Off, or Toggle it.

* Parameters: 3
#DeviceID : ID number of the MultiSwitch device [''integer'']
#SwitchNum : 0 to 8 [''integer'']
#State : 0=Off, 1=On, -1=Toggle [''integer'']
==SetLockState==
[[Vera.SetLockState]] 
Lock or unlock a door lock device.

* Parameters: 2
#DeviceID : ID Assigned by Vera [''integer'']
#Lock State : 0: Unlocked, 1: Locked [''integer'']
==SetState==
[[Vera.SetState]] 
Turn a device on or off.

* Parameters: 2
#DeviceID : ID Assigned by Vera [''integer'']
#State : 0: Off, 1: On [''integer'']
==Toggle==
[[Vera.Toggle]] 
Toggles the device state between "on" and "off".

* Parameters: 1
#DeviceID : ID Assigned by Vera [''integer'']
==WinCovAction==
[[Vera.WinCovAction]] 
Actions for window coverings. <Action> can be one of: Up, Down, Stop

* Parameters: 2
#DeviceID : ID Assigned by Vera [''integer'']
#Action : Up, Down, or Stop [''string'']

← Older revision	Revision as of 17:25, 13 January 2021
(No difference)

Plugin Vera - Revision history

James: 1 revision

Jitterjames at 19:05, 20 April 2015