MiOS - User contributions [en]

Luup Requests

2010-06-24T14:08:03Z

Javier: added RunSene to the lu_action part

[[Category:Development]]
In addition to sending requests using standard UPnP, you can also do most things using a simple HTTP requests. Use the built-in URL <tt>data_request</tt>, and pass the following on the URL:
*<tt>id</tt> the id of the request,
*<tt>output_format</tt> the format in which you want a response as <tt>json</tt>, <tt>xml</tt> or <tt>text</tt>.

Not all requests support all <tt>output_format</tt> options. Here is a list of requests:

==user_data==

Example: http://ipaddress:49451/data_request?id=user_data&output_format=xml

This returns the configuration data for Vera, which is a list of all devices and the UPnP variables which are persisted between resets as well as rooms, names, and other data the user sets as part of the configuration.

==user_data2==

Example: http://ipaddress:49451/data_request?id=user_data2&output_format=xml

Similar to <tt>user_data</tt>.

==lu_status==

Example: http://ipaddress:49451/data_request?id=lu_status&output_format=xml

Or for a specific device: http://ipaddress:49451/data_request?id=lu_status&output_format=xml&UDN=uuid:4d494342-5342-5645-0002-000000000002 or http://ipaddress:49451/data_request?id=lu_status&output_format=xml&DeviceNum=6

This returns the current status for all devices including all the current upnp variables and the status of any active jobs.

==lu_actions==

==lu_device==

This returns all the XML with all the UPNP device description documents. Use: http://ipaddress:49451/data_request?id=lu_device&output_format=xml&DeviceNum=x or &UDN=y to narrow it down. Then when you see the service URL's, like <SCPDURL>/luvd/S_HVAC_UserOperatingMode1.xml</SCPDURL>, you can view them with: http://ipaddress:49451/luvd/S_HVAC_UserOperatingMode1.xml

==lu_file==

==lu_lua==

==lu_action==

Example: http://ipaddress:49451/data_request?id=lu_action&output_format=xml&DeviceNum=6&serviceId=urn:upnp-org:serviceId:SwitchPower1&action=SetTarget&newTargetValue=1

Sends a UPnP action.

To run a scene, you send the action 'RunScene' to the internal 'Scene Manager' device (which has ID #2):

http://ipadress:49451/data_request?id=lu_action&output_format=xml&DeviceNum=2&serviceId=urn:micasaverde-com:serviceId:HomeAutomationGateway1&action=RunScene&SceneNum=<SceneNum>

==lu_variableset==

http://ip:49451/data_request?id=lu_variableset&DeviceNum=6&serviceId=urn:micasaverde-com:serviceId:DoorLock1&Variable=Status&Value=1

==lu_variableget==

http://ip:49451/data_request?id=lu_variableget&DeviceNum=6&serviceId=urn:micasaverde-com:serviceId:DoorLock1&Variable=Status

==lu_reload==

Resets the Luup engine with any new configuration settings.

==lu_alive==

Return OK if the engine is running.

==lu_finddevice==

Return the device id, UDN, device type of the first device that matches all the parameters passed on the URL: <tt>devtype</tt>, <tt>ip</tt>, <tt>id</tt>

==lu_resync==

ReSync's all the devices, rooms, users, sections with event servers and returns OK

==lu_wget==

Returns the contents of the URL you pass in the "url" argument. Optionally append "user" and "pass" arguments for http authentication, and "timeout" to specify the maximum time to wait in seconds.

==lu_iprequests==

Returns the recent IP requests in order by most recent first, including information about devices in use and if the IP is blacklisted (ignored by the plug and play mechanism). Optionally append "oldest" to specify the oldest IP request in seconds.

==lu_blacklistip==

Append "ip" to the URL, and optionally "remove=1" to add (or remove) the IP to the blacklist so plug and play IP devices won't be added.

==live_energy_usage==

For backward compatibility it reports current energy usage in a tab delimited format

Luup Lua extensions

2010-06-22T22:04:16Z

Javier: reformatted the luup.register_handler example

In addition to the [[http://lua.org Lua]] commands described in the [[http://www.lua.org/manual/5.1/ Lua reference manual]], you can also reference in your Lua code variables and functions from modules which the Luup engine provides as follows:

== Module: luup ==

These are general purpose functions and variables. Call them by using the luup. module, such as:

luup.log('Now running version: ' .. luup.version)

=== variable: version, version_branch, version_major, version_minor ===

''version'' contains the version of the luup engine, such as "1.0.843", as a string. The version consists of 3 numbers separated by a period: the branch, the major version, and the minor version. To make it easier to compare against a minimum acceptable version, ''version_branch, version_major and version_minor'' return each component as a number. You can put a comparison in the startup function in your Luup plugin and return false if the minimum version isn't met. The user will then see that the Luup device's startup check failed:

if( version_branch~=1 or version_major~=0 or version_minor<843 ) then
luup.log("I need version 1.0.843 minimum to run")
return false
end

=== variable: longitude ===

Contains the longitude as a number, as found on the location tab in the setup UI.

=== variable: latitude ===

Contains the latitude as a number, as found on the location tab in the setup UI.

=== variable: timezone ===

Contains the timezone as a number, as found on the location tab in the setup UI.

=== variable: city ===

Contains the city as a string, as found on the location tab in the setup UI.

=== variable: devices ===

Contains all the devices in the system as a table indexed by the device number. The members are: room_num (number), device_type (string), category_num (number), device_num_parent (number), ip (string), mac (string), id (string), description (string), udn (string). [See also: [[Lua Device Structure]].] Example to log device #5's IP addess and its internal ID:

luup.log('Device #5 ip: ' .. luup.devices[5].ip .. ' id: ' .. luup.devices[5].id)

room_num: This is the number of the room the device is in.

device_type: This is a number representing the type of device. See: [[Luup Device Types Categories]] for a list.

category_num: This is a category for the device. [See: [[Luup Device Types Categories]]]

device_num_parent: This is the number of the parent device. See: [[Lua Device Structure]] for details.

ip: If this device is IP based, this is the IP address.

mac: If this device is IP based, this is the MAC address.

id: If this device has an internal ID that is specific to the device, it is contained here. For example, for Z-Wave devices this is the Node ID, and for Insteon device it is the Insteon ID.

embedded: (boolean) If this device is embedded, it means that it doesn't have its own room or exist as a separate device. It should be considered part of its parent. Like a 3-in-1 sensor is a device with 3 embedded child devices.

hidden: (boolean) If true the user checked the 'hidden' box and doesn't want to see the device on the dashboard.

invisible: (boolean) If true the device is 'for internal use only' and shouldn't be presented to the user.

description: This is the text description for the device as supplied by the user in the web UI.

udn: This is the UDN for the UPnP device.

This code will log all the attributes from all the devices:

for k,v in pairs(lug_device) do
for k2,v2 in v
luup.log("Device #" .. k .. ":" .. k2 .. "=" .. "v2")
end
end

=== variable: rooms ===

Contains all the rooms as a table of strings indexed by the room number. Example:

luup.log('Room #1 is called: ' .. luup.rooms[1])

=== variable: scenes ===

Contains all the scenes in the system as a table indexed by the device number. The members are: room_num (number), description(string), hidden(boolean)

=== variable: remotes ===

Contains all the remotes in the system as a table indexed by the remote id. The members are: remote_file (string), room_num (number), description(string)

=== function: log ===

parameters: what_to_log (string), log_level (optional, number)

return: nothing

Writes what_to_log to the log, /var/log/cmh/LuaUPnP.log, with the given log_level, which is 50 by default. See: [[Luup Loglevels]]

=== function: task ===

parameters: message (string), status (number), description (string), handle (number)

return: handle (number)

When the Luup engine is starting status messages are displayed for the various modules as they're initialized. Normally each device, including Luup devices, automatically log their status and the user is shown an error if the device doesn't start, such as if the 'startup' function returns an error.

If you have other startup sequences which you want the user to see to know that startup hasn't finished yet, call this function passing in a handle of -1 for the first call. The status should be: 1=Busy, 2=Error, 4=Successful. Message is the current state, such as 'downloading', and description describes the module, like 'Smartphone UI'. After the first call, store the handle and pass it on future calls to update the status rather than add a new one.

=== function: call_delay ===

parameters: function_name (string), seconds (number), data (string)

returns: result (number)

The function 'function_name', which must be passed as a string, will be called in 'seconds' seconds, and will be passed the string 'data'. The function returns 0 if successful. See: [[Luup Declarations#timed_function_callback]] for the names and syntax of the parameters that will be passed to function_name. function_name will only be called once and you must call call_delay again if you want it called again, or use call_timer instead.

=== function: call_timer ===

parameters: function_name (string), type (number), time (string), days (string), data (string)

returns: result (number)

The function 'function_name', which must be passed as a string, will be called when the timer is triggered, and will be passed the string 'data'. The function returns 0 if successful. See: [[Luup Declarations#timed_function_callback]] for the names and syntax of the parameters that will be passed to function_name.

Type is 1=Interval timer, 2=Day of week timer, 3=Day of month timer, 4=Absolute timer. For an interval timer, days is not used, and Time should be a number of seconds, minutes, or hours using an optional 'h' or 'm' suffix. Example: 30=call in 30 seconds, 5m=call in 5 minutes, 2h=call in 2 hours. For a day of week timer, Days is a comma separated list with the days of the week where 1=Monday and 7=Sunday. Time is the time of day in hh:mm:ss format. Time can also include an 'r' at the end for Sunrise or a 't' for Sunset and the time is relative to sunrise/sunset. For example: Days="3,5" Time="20:30:00" means your function will be called on the next Wed or Fri at 8:30pm. Days="1,7" Time="-3:00:00r" means your function will be called on the next Monday or Sunday 3 hours before sunrise. Day of month works the same way except Days is a comma separated list of days of the month, such as "15,20,30". For an absolute timer, Days is not used, and Time should be in the format: "yyyy-mm-dd hh:mm:ss"

Data can be a string passed back to the function. The function should be declared so it takes a single argument, which is this data.
<pre>function refreshCache(stuff)
....
end

function startup()
--
-- Setup an interval-based timer to call refreshCache after 30 minutes.
-- Note that if you want it to "recur" then you need to call this function again
-- at the end of the refreshCache() implementation.
--
luup.call_timer("refreshCache", 1, "30m", "", "SomeStuff")
end
</pre>
=== function: is_ready ===

parameters: device (string or number)

returns: ready (boolean)

Checks whether device - which, if it's a string, is interpreted as a udn, and if it's a number, as the device number - is ready and has successfully completed the startup sequence. If so, ready is true. If your device shouldn't process incoming data until the startup sequence is finished, you may want to add a check to the incoming function handler that ignores any data if is_ready(lul_device) isn't true.

=== function: call_action ===

parameters: service (string), action (string), arguments (table), device (string or number)

returns: error (number), error_msg (string), job (number), arguments (table)

Invokes the UPnP service + action, passing in the arguments (table of string->string pairs) to the device, which, if it's a string, is interpreted as a udn, and if it's a number, is the device number. If the invocation could not be made, only error will be returned with a value of -1. Otherwise, all 4 values are returned. error is 0 if the UPnP device reported the action was successful. arguments is a table of string->string pairs with the return arguments from the action. If the action is handled asynchronously by a Luup job, then the job number will be returned as a positive integer.

Example to dim device #5 to 50%:

local lul_arguments = {}
lul_arguments["newLoadlevelTarget"]=50
lul_resultcode,lul_resultstring,lul_job,lul_returnarguments = luup.call_action("urn:upnp-org:serviceId:Dimming1","SetLoadLevelTarget",lul_arguments,5)

=== function: variable_set ===

parameters: service (string), variable (string), value (string), device (string or number)

returns: nothing

The UPnP service+variable will be set to value for device, which if it's a string, is interpreted as a udn, and if it's a number, as a device id. If there are events or notifications tied to the variable they will be fired.

=== function: variable_get ===

parameters: service (string), variable (string), device (string or number)

returns: value (string), time (number)

If the service+variable or device does not exist, it returns nothing. Otherwise it returns the value of the UPnP service+variable and the time when the variable was last modified, as a unix time stamp (number of seconds since 1/1/1970). You can assign just the value to a variable, as follows:

local value = luup.variable_get("urn:upnp-org:serviceId:Dimming1","LoadLevelTarget",5)
luup.log("Dim level for device #5 is: " .. value)

=== function: register_handler ===

parameters: function_name (string), request_name (string)

returns: nothing

When a certain URL is requested from a web browser or other HTTP get, function_name will be called and whatever string it returns will be returned.

See the WAP mobile phone plugin as an example:

luup.register_handler("lug_WapRequest","wap")

function lug_WapRequest (lul_request, lul_parameters, lul_outputformat)
local lul_html = "<head>\n" ..
"<title>Main</title>\n" ..
"</head>\n" ..
"<body>\n" ..
"Choose a room: \n"
return lul_html
end

The request is made with the URL: data_request?id=lr_[the registered name] on port 49451. So: http://192.168.1.1:49451/data_request?id=lr_wap will return the web page defined in the function lug_WapRequest in the example above.

=== function: variable_watch ===

parameters: function_name (string), service (string), variable (string or nill), device (string or number)

returns: nothing

Whenever the UPnP variable is changed for the specified device, which if a string is interpreted as a udn and if a number as a device id, function_name will be called. See [[Luup Declarations#watch_callback]] for the values that will be passed to function_name. If variable is nill, function_name will be called whenever any variable in the service is changed.

 

=== function: devices_by_service ===

parameters:

returns:

=== function: device_supports_service ===

parameters:

returns:

=== function: set_failure ===

parameters: value (boolean), device (string or number)

returns:

Luup maintains a 'failure' flag for every device to indicate if it is not functioning. You can set the flag to true if the device is failing. If device is a string it is interpreted as a udn, if it's a number, as a device id.

=== function: is_night ===

parameters: none

returns: boolean

Returns true if it's past sunset and before sunrise.

== Module: luup.inet ==

=== function: wget ===

parameters: URL (String), Timeout (Number), Username (String), Password (String)

returns httpStatusCode (Number), content (String)

This reads the URL and returns 2 variables: The first is a numeric error code which is 0 if successful, and the second is a string containing the contents of the page. If Timeout is specified, the function will timeout after that many seconds. If Username and Password are specified, they will be used for HTTP Basic Authentication.

 

== Module: luup.chdev ==

Contains functions for a parent to synchronize its child devices. Whenever a device has multiple end-points, the devices are represented in a parent/child fashion where the parent device is responsible for reporting what child devices it has and giving each one a unique id. For example in the sample [[Luup Somfy Walkthrough]] there is a parent device, which is the interface module that controls up to 16 blinds, and up to 16 child devices, one for each blind. As shown in that sample, the parent calls start, then enumerates each child device with append, and finally calls sync. You will need to pass the same value for device to append and sync that you passed to start.

=== function: start ===

parameters: device (string or number)

returns: ptr (binary object)

Tells Luup you will start enumerating the children of device. If device is a string it is interpreted as a udn, if it's a number, as a device id. The return value is a binary object which you cannot do anything with in Lua, but you do pass it to the append and sync functions.

=== function: append ===

parameters: device (string or number), ptr (binary object), id (string), description (string), device_type (string), device_filename (string), implementation_filename (string), parameters (string), embedded (boolean)

returns: nothing

Enumerates one child of device. If device is a string it is interpreted as a udn, if it's a number, as a device id. Pass in the ptr which you received from the start function. Give each child a unique id so you can keep track of which is which. You can optionally provide a description which the user sees in the user interface. device_type is the UPnP device type, such as urn:schemas-upnp-org:device:BinaryLight:1. If device_filename is specified, that is the name of the XML file with the UPnP device specification. The deviceType from the filename will override any device_type you set manually. If the device_file contains the implementation file for this child device you do not need to specify it in implementation_filename. Otherwise, if there is a Luup implementation for this child device and it's not being handled by the parent device, you can specify it in implementation_filename. If embedded is true, the 'embedded' flag is set for the device which generally means that the parent and all the children will be displayed as one compound device, or group, rather than as separate devices which you can put in their own rooms.

The parameters are UPnP service+variables you want set when the device is created. You can specify multiple variables by separating them with a line feed (\n) and use a , and = to separate service, variable and value, like this: service,variable=value \n service...

=== function: sync ===

parameters: device (string or number), ptr (binary object),

returns: nothing

If device is a string it is interpreted as a udn, if it's a number, as a device id. Pass in the ptr which you received from the start function. Tells the Luup engine you have finished enumerating the child devices. If the child devices have changed in any way, the new device tree will be written to the configuration file and the Luup engine is reset.

== module: io ==

=== function: open ===

parameters: device (string or number), ip (string) port (number),

returns: nothing

If 'device' is a string it is interpreted as a UDN; if it's a number, as a device ID. This opens a socket on 'port' to 'ip' and stores the handle to the socket in 'device'. The opening of a socket can take time depending on the network, and a Luup function should return quickly whenever possible because each top-level device's Lua implementation runs in a single thread. So the actual opening of the socket occurs asynchronously and this function returns nothing. You will know that the socket opening failed if your subsequent call to write fails.

Generally you do not need to call the open function because the socket is usually started automatically when the Luup engine starts. This is because the user typically either (a) associates a device with the destination io device, such as selecting an RS232 port for an alarm panel, where the RS232 is proxied by a socket, or (b) because the configuration settings for the device already include an IP address and port.

=== function: write ===

parameters: data (string), device (string or number)

returns: result (boolean)

In Lua a string can contain binary data, so data may be a binary block. If 'device' is a string it is interpreted as a UDN; if it's a number, as a device ID. This sends data on the socket that was opened automatically or with the open function above, and associated to 'device'. If the socket is not already open, write will wait up to 5 seconds for the socket before it returns an error. Result is 'true' if the data was sent successfully, and is 'false' or nill if an error occurred.

=== function: intercept ===

parameters: device (string or number)

returns: nothing

Normally when data comes in on a socket (I/O Port), the block of data is first passed to any pending jobs that are running for the device and are marked as 'waiting for data'. If there are none, or if none of the jobs' incoming data handlers report that they consumed (i.e. processed) the data, then the block of data is passed to the general 'incoming' function handler for the device. If you want to bypass this normal mechanism and read data directly from the socket, call intercept first to tell Luup you want to read incoming data with the read function. This is generally used during the initialization or startup sequences for devices. For example, you may need to send some data (a), receive some response (b), send some more data (c), receive another response (d), etc. In this case you would call 'intercept' first, then send a, then call read and confirm you got b, then call intercept again, then send c, then read d, and so on.

You can call the read function without calling intercept and any incoming data will be returned by that function after it's called. The reason why you generally must call intercept is because normally you want to send some data and get a response. If you write the code like this ''send(data) data=read()'' then it's possible the response will arrive in the brief moment between the execution of send() and read(), and therefore get sent to the incoming data handler for the device. Intercept tells Luup to buffer any incoming data until the next read, bypassing the normal incoming data handler. So ''intercept() send(data) data=read()'' ensures that read will always get the response. If the device you're communicating with sends unsolicited data then there's the risk that the data you read is not the response you're looking for. If so, you can manually pass the response packet to the incoming data handler.

**TBD: Add a function to do this**

=== function: read ===

parameters: timeout (number), device (string or number)

returns: data (string)

This reads a block of data from the socket. You must have called intercept previously so the data is passed.

=== function: is_connected ===

parameters: device (string or number)

returns: connected (boolean)

This function returns true if there is a valid IO port connected, otherwise returns false

=== Job Handling ===

lu_job_set

lu_job_get

[[Category:Development]]

DscAlarmPanel

2010-06-11T04:00:25Z

Javier:

= DSC Alarm Panel =

This Plugin connects a DSC Alarm Panel with MiOS system, via an IT-100 interface board or compatible interface.

== how it works ==

To make it easy to handle different panel features, the plugin defines three different devices on the MiOS system:

'''main device'''[[Image(main panel1.png, align=right)|[[Image:DSC_Main_panel.png|right]]]]

This represents the panel itself. The main tab contains:

 

*A display with any message shown by the panel's LCD screen.
*A text entry box to set the access code used by the plugin to access the panel.
*A button to synchronize the panel's clock with Vera's.

 

There are four 'global' alarms on the panel:

*Fire Key
*Auxiliary Key
*Panic Key
*Auxiliary Input

Each of these can generate an event when triggered or cleared.

'''partition subdevices[[Image:DSC_Partition_panel.png|right]]'''

On the main tab the device shows the partition status ('Ready', 'In Alarm', 'Disarmed', etc), and has five buttons to send commands to the partition: 'Away', 'Stay', 'Armed no Entry Delay', 'Arm with Code', 'Disarm'.

Events are generated on status changes.

'''zones or sensors'''

Each zone is represented as a sensor device. Currently you can select which appears as 'Smoke sensors' and which as 'Motion sensors'. There's no functional difference between them, but a UI can list them apart, or show different icons.

Events are generated on status changes.

== Setup ==

If the IT-100 interface is connected to Vera with an USB-Serial adapter, there should appear a serial port device. The MiOS Marketplace should let you create the main alarm panel device; then you have to associate the serial port with the main panel device.

Partitions and zones are configured on the panel itself. Note the number of each one (partitions are numbered 1-8, zones are 1-64) and open the main panel device. Go to the 'Advanced' tab, and set three variables, all with the service ID "urn:micasaverde-com:serviceId:AlarmPanel1":

''''ActivePartitions' ''': A comma-separated list of the partition numbers configured on the panel.

''''MotionSensors' ''': A comma-separated list of the zone numbers that represent motion sensors.

''''SmokeSensors' ''': A comma-separated list of the zone numbers that represent smoke sensors.

After setting these variables, close the dialog and hit the 'Save' icon. Luup will restart and the plugin will create one subdevice for each parition and zone.

File:DSC Partition panel.png

2010-06-11T03:57:18Z

Javier:

File:DSC Main panel.png

2010-06-11T03:56:29Z

Javier:

DscAlarmPanel

2010-06-11T03:53:59Z

Javier: New page: = DSC Alarm Panel = This Plugin connects a DSC Alarm Panel with MiOS system, via an IT-100 interface board or compatible interface. == how it works == To make it easy to handle diffe...

= DSC Alarm Panel =

This Plugin connects a DSC Alarm Panel with MiOS system, via an IT-100 interface board or compatible interface.

== how it works ==

To make it easy to handle different panel features, the plugin defines three different devices on the MiOS system:

'''main device'''[[Image(main panel1.png, align=right)]] This represents the panel itself. The main tab contains:

*A display with any message shown by the panel's LCD screen.
*A text entry box to set the access code used by the plugin to access the panel.
*A button to synchronize the panel's clock with Vera's.

There are four 'global' alarms on the panel:

*Fire Key
*Auxiliary Key
*Panic Key
*Auxiliary Input

Each of these can generate an event when triggered or cleared.

'''partition subdevices'''[[Image(partition panel.png, align=right)]]

On the main tab the device shows the partition status ('Ready', 'In Alarm', 'Disarmed', etc), and has five buttons to send commands to the partition: 'Away', 'Stay', 'Armed no Entry Delay', 'Arm with Code', 'Disarm'.

Events are generated on status changes.

'''zones or sensors'''

Each zone is represented as a sensor device. Currently you can select which appears as 'Smoke sensors' and which as 'Motion sensors'. There's no functional difference between them, but a UI can list them apart, or show different icons.

Events are generated on status changes.

== Setup ==

If the IT-100 interface is connected to Vera with an USB-Serial adapter, there should appear a serial port device. The MiOS Marketplace should let you create the main alarm panel device; then you have to associate the serial port with the main panel device.

Partitions and zones are configured on the panel itself. Note the number of each one (partitions are numbered 1-8, zones are 1-64) and open the main panel device. Go to the 'Advanced' tab, and set three variables, all with the service ID "urn:micasaverde-com:serviceId:AlarmPanel1":

''''ActivePartitions' ''': A comma-separated list of the partition numbers configured on the panel.

''''MotionSensors' ''': A comma-separated list of the zone numbers that represent motion sensors.

''''SmokeSensors' ''': A comma-separated list of the zone numbers that represent smoke sensors.

After setting these variables, close the dialog and hit the 'Save' icon. Luup will restart and the plugin will create one subdevice for each parition and zone.

Luup UPNP Files

2010-04-20T21:32:36Z

Javier:

[[Category:Development]]
The following is the contents of the file "Constant.h" which defines the strings used for file device types, services, actions, variables, etc.

/*
Copyright (C) 2008 Mi Casa Verde, Inc., a Nevada Corporation

All rights reserved. This software may not be used or distributed without express consent

*/

#ifndef Constants_h
#define Constants_h
// Device Types
#define DEVICETYPE_BINARY_LIGHT "urn:schemas-upnp-org:device:BinaryLight:1"
#define DEVICETYPE_DIMMABLE_LIGHT "urn:schemas-upnp-org:device:DimmableLight:1"
#define DEVICETYPE_THERMOSTAT "urn:schemas-upnp-org:device:HVAC_ZoneThermostat:1"
#define DEVICETYPE_HUMIDITY_SENSOR "urn:schemas-micasaverde-com:device:HumiditySensor:1"
#define DEVICETYPE_MULTI_IO "urn:schemas-micasaverde-com:device:MultiIO:1"
#define DEVICETYPE_DOOR_LOCK "urn:schemas-micasaverde-com:device:DoorLock:1"
#define DEVICETYPE_DOOR_SENSOR "urn:schemas-micasaverde-com:device:DoorSensor:1"
#define DEVICETYPE_ZWAVE_NETWORK "urn:schemas-micasaverde-com:device:ZWaveNetwork:1"
#define DEVICETYPE_INSTEON_NETWORK "urn:schemas-micasaverde-com:device:InsteonNetwork:1"
#define DEVICETYPE_USB_UIRT "urn:schemas-micasaverde-com:device:USBUIRT:1"
#define DEVICETYPE_TEMPERATURE_SENSOR "urn:schemas-micasaverde-com:device:TemperatureSensor:1"
#define DEVICETYPE_MOTION_SENSOR "urn:schemas-micasaverde-com:device:MotionSensor:1"
#define DEVICETYPE_LIGHT_SENSOR "urn:schemas-micasaverde-com:device:LightSensor:1"
#define DEVICETYPE_IR_TRANSMITTER "urn:schemas-micasaverde-com:device:IrTransmitter:1"
#define DEVICETYPE_WINDOW_COVERING "urn:schemas-micasaverde-com:device:WindowCovering:1"
#define DEVICETYPE_GENERIC_IO "urn:schemas-micasaverde-com:device:GenericIO:1"
#define DEVICETYPE_REMOTE_CONTROL "urn:schemas-micasaverde-com:device:RemoteControl:1"
#define DEVICETYPE_COMBO_DEVICE "urn:schemas-micasaverde-com:device:ComboDevice:1"
#define DEVICETYPE_CAMERA "urn:schemas-upnp-org:device:DigitalSecurityCamera:1"
#define DEVICETYPE_SERIALPORT "urn:micasaverde-org:device:SerialPort:1"
#define DEVICETYPE_SCENE_CONTROLLER "urn:schemas-micasaverde-com:device:SceneController:1"
#define DEVICETYPE_ENERGY_CALCULATOR "urn:schemas-micasaverde-com:device:EnergyCalculator:1"
// IR Device Types
#define DEVICETYPE_TV "urn:schemas-micasaverde-com:device:tv:1"
#define DEVICETYPE_CABLE "urn:schemas-micasaverde-com:device:cable:1"
#define DEVICETYPE_SATELLITE "urn:schemas-micasaverde-com:device:satellite:1"
#define DEVICETYPE_VIDEO_ACCESSORY "urn:schemas-micasaverde-com:device:videoaccessory:1"
#define DEVICETYPE_VCR_DVR "urn:schemas-micasaverde-com:device:vcrdvd:1"
#define DEVICETYPE_DVD_BLURAY "urn:schemas-micasaverde-com:device:dvdbluray:1"
#define DEVICETYPE_RECEIVER "urn:schemas-micasaverde-com:device:receiver:1"
#define DEVICETYPE_AMP "urn:schemas-micasaverde-com:device:amp:1"
#define DEVICETYPE_CD "urn:schemas-micasaverde-com:device:cd:1"
#define DEVICETYPE_MISC_HOME_CONTROL "urn:schemas-micasaverde-com:device:mischomecontrol:1"
#define DEVICETYPE_AV_MISC "urn:schemas-micasaverde-com:device:avmisc:1"
#define DEVICETYPE_VIRTUAL_DEVICE "urn:schemas-micasaverde-com:device:VirtualDevice:1"

// Device Files
#define DEVICEFILE_BINARY_LIGHT "D_BinaryLight1.xml"
#define DEVICEFILE_DIMMABLE_LIGHT "D_DimmableLight1.xml"
#define DEVICEFILE_THERMOSTAT "D_HVAC_ZoneThermostat1.xml"
#define DEVICEFILE_HUMIDITY_SENSOR "D_HumiditySensor1.xml"
#define DEVICEFILE_MULTI_IO "D_GC100.xml"
#define DEVICEFILE_DOOR_LOCK "D_DoorLock1.xml"
#define DEVICEFILE_DOOR_SENSOR "D_MotionSensor1.xml"
#define DEVICEFILE_ZWAVE_NETWORK "D_ZWaveNetwork.xml"
#define DEVICEFILE_USB_UIRT "D_USB_UIRT.xml"
#define DEVICEFILE_TEMPERATURE_SENSOR "D_TemperatureSensor1.xml"
#define DEVICEFILE_MOTION_SENSOR "D_MotionSensor1.xml"
#define DEVICEFILE_LIGHT_SENSOR "D_LightSensor1.xml"
#define DEVICEFILE_IR_TRANSMITTER "D_IrTransmitter1.xml"
#define DEVICEFILE_WINDOW_COVERING "D_WindowCovering1.xml"
#define DEVICEFILE_GENERIC_IO "D_GenericIO1.xml"
#define DEVICEFILE_REMOTE_CONTROL "D_RemoteControl1.xml"
#define DEVICEFILE_COMBO_DEVICE "D_ComboDevice1.xml"
#define DEVICEFILE_CAMERA "D_DigitalSecurityCamera1.xml"
#define DEVICEFILE_SCENE_CONTROLLER "D_SceneController1.xml"
#define DEVICEFILE_ENERGY_CALCULATOR "D_EnergyCalculator1.xml"
#define DEVICEFILE_AV_MISC "D_AvMisc1.xml"

// Device Categories
#define DEVICE_CATEGORY_INTERFACE 1
#define DEVICE_CATEGORY_DIMMABLE_LIGHT 2
#define DEVICE_CATEGORY_SWITCH 3
#define DEVICE_CATEGORY_SECURITY_SENSOR 4
#define DEVICE_CATEGORY_HVAC 5
#define DEVICE_CATEGORY_CAMERA 6
#define DEVICE_CATEGORY_DOOR_LOCK 7
#define DEVICE_CATEGORY_WINDOW_COV 8
#define DEVICE_CATEGORY_REMOTE_CONTROL 9
#define DEVICE_CATEGORY_IR_TX 10
#define DEVICE_CATEGORY_GENERIC_IO 11
#define DEVICE_CATEGORY_GENERIC_SENSOR 12
#define DEVICE_CATEGORY_SERIAL_PORT 13
#define DEVICE_CATEGORY_SCENE_CONTROLLER 14
#define DEVICE_CATEGORY_AV 15
#define DEVICE_CATEGORY_HUMIDITY 16
#define DEVICE_CATEGORY_TEMPERATURE 17
#define DEVICE_CATEGORY_LIGHT 18
#define DEVICE_CATEGORY_ZWAVE_INT 19
#define DEVICE_CATEGORY_INSTEON_INT 20

// Cast the second one between int and char * so we can use a simple
// array that's fast to iterate and not use an stl map
extern const char *g_DeviceCategories[];
extern const char *g_DeviceDescriptions[]; // Default descriptions

#define MINIMUM_TIME 1230811200 // If the time is < this, we'll assume the clock isn't set

// This is a special argument which, if 1, means this action is 'temporary' and the system must note the current settings with Device_Action::CreateRestorePoint and restore them with GotoRestorePoint
#define TEMPORARY_UPNP_ARGUMENT "TEMPORARY_UPNP_ARGUMENT"

#define SAFE_DEVICE_ID(pDevice_LuaUPnP) (pDevice_LuaUPnP ? pDevice_LuaUPnP->m_pDevice_Basic_get()->m_iDevice_Num_get() : 0)

// These are stored in the json file for the device itself and not part of the UPNP variables:

/*
Device_Num
FK_DevType
Device_Num_Parent
FK_Device_Category
Room_Num

Description
InternalID // DEVICEDATA_PortChannel_Number_CONST
Manufacturer// DEVICEDATA_Manufacturer_Desc_CONST
Model // DEVICEDATA_Model_Desc_CONST
IPAddress
MacAddress
UPnPDeviceFile // DEVICEDATA_UPnP_Dev_File_CONST
*/

// ============ HaGateway ============
// Basic functionality for the gateway itself

#define HAGEVICE_FILE "S_HomeAutomationGateway1.xml"
#define HAGEVICE_SID "urn:micasaverde-com:serviceId:HomeAutomationGateway1"
#define HAGEVICE_STYPE "urn:schemas-micasaverde-org:service:HomeAutomationGateway:1"

// Variables
#define HAG_ACTIVE_SCENES "ActiveScenes"

/*
#define HAG_ENERGY_DOW "EnergyDOW"
#define HAG_ENERGY_TIME_OF_DAY "GetUserData"
#define HAG_NUM_LIGHTS "GetUserData"
#define HAG_THERMOSTAT_ON "GetUserData"
#define HAG_ENERGY_DOW "GetUserData"
*/

// Actions
#define HAG_GET_USER_DATA "GetUserData"
#define HAG_MODIFY_USER_DATA "ModifyUserData"
#define HAG_MODIFY_GET_VARIABLE "GetVariable"
#define HAG_MODIFY_SET_VARIABLE "SetVariable"
#define HAG_MODIFY_GET_STATUS "GetStatus"
#define HAG_MODIFY_GET_ACTIONS "GetActions"
#define HAG_MODIFY_CREATE_DEVICE "CreateDevice"
#define HAG_MODIFY_DELETE_DEVICE "DeleteDevice"
#define HAG_PROCESS_CHILD "ProcessChildDevices"
#define HAG_RELOAD "Reload"
#define HAG_RUN_SCENE "RunScene"
#define HAG_RUN_LUA "RunLua"

// ============ HaDevice ============
// Basic functionality for all home automation devices

#define HADEVICE_FILE "S_HaDevice1.xml"
#define HADEVICE_SID "urn:micasaverde-com:serviceId:HaDevice1"
#define HADEVICE_STYPE "urn:schemas-micasaverde-com:service:HaDevice:1"

// Variables
#define HAD_ENERGY_LOG "EnergyLog" // DEVICEDATA_Energy_Log_CONST
#define HAD_WATTS "Watts" // DEVICEDATA_Wattage_CONST
#define HAD_IOPORT_DEVICE "IODevice" // The device number to connect to for IO (this is on the master device)
#define HAD_IOPORT_PORT "IOPort" // The port to receive connections on from HAD_IOPORT_DEVICE (this is on the serial port)
#define HAD_IGNORE_ROOM "IgnoreRoom" // DEVICEDATA_Room_Not_Required_CONST
#define HAD_COMM_FAILURE "CommFailure"
#define HAD_POLLING_ENABLED "PollingEnabled"
#define HAD_POLL_MIN_DELAY "PollMinDelay"
#define HAD_CONFIGURED "Configured"
#define HAD_JOBID "JobID"
#define HAD_REVERSE "ReverseOnOff" // DEVICEDATA_Reverse_CONST
#define HAD_LAST_UPDATE "LastUpdate" // DEVICEDATA_LastUpdate_CONST
#define HAD_AUTO_CONFIGURE "AutoConfigure" // DEVICEDATA_Auto_Configure_CONST

#define HAD_RECONFIGURE "Reconfigure"
#define HAD_REMOVE "Remove"
#define HAD_POLL "Poll"
#define HAD_SET_POLL_FREQUENCY "SetPollFrequency"
#define HAD_STRESS_TEST "StressTest"

// ============ ZWaveNetwork ============
// Basic functionality for all ZWave devices

#define ZWN_FILE "S_ZWaveNetwork1.xml"
#define ZWN_SID "urn:micasaverde-com:serviceId:ZWaveNetwork1"
#define ZWN_STYPE "urn:schemas-micasaverde-org:service:ZWaveNetwork:1"

#define ZWN_RESET_NETWORK "ResetNetwork"
#define ZWN_REMOVE_NODES "RemoveNodes"
#define ZWN_ADD_NODES "AddNodes"
#define ZWN_DOWNLOAD "DownloadNetwork"
#define ZWN_HEAL_NETWORK "HealNetwork"
#define ZWN_SET_POLLING "SetPolling"
#define ZWN_SEND_DATA "SendData"
#define ZWN_POLL_ALL_NODES "PollAllNodes"
#define ZWN_SOFT_RESET "SoftReset"
#define ZWN_BACKUP_DONGLE "BackupDongle"

// Variables
#define ZWN_LAST_UPDATE "LastUpdate" // DEVICEDATA_LastUpdate_CONST
#define ZWN_LAST_DONGLE_BACKUP "LastDongleBackup"
#define ZWN_AUTO_CONFIGURE "AutoConfigure" // DEVICEDATA_Auto_Configure_CONST
#define ZWN_NET_STATUS_ID "NetStatusID"
#define ZWN_NET_STATUS_TEXT "NetStatusText"
#define ZWN_COM_PORT "ComPort" // DEVICEDATA_COM_Port_on_PC_CONST
#define ZWN_NODE_ID "NodeID" // The dongle's id
#define ZWN_VERSION_INFO "VersionInfo"
#define ZWN_HOME_ID "HomeID"
#define ZWN_ROLE "Role"
#define ZWN_RESET_MODE "ResetMode"
#define ZWN_INCLUSION_MODE "InclusionMode"
#define ZWN_NODETYPE "NodeType"
#define ZWN_TIMEOUT "Timeout"
#define ZWN_MULTIPLE "Multiple"
#define ZWN_SIMULATE_INCOMING "SimulateIncomingData"
#define ZWN_POLL_ENABLED "PollingEnabled"
#define ZWN_POLL_DELAY_INITIAL "PollDelayInitial"
#define ZWN_POLL_DELAY_DEADTIME "PollDelayDeadTime"
#define ZWN_POLL_MINDELAY "PollMinDelay"
#define ZWN_POLL_FREQUENCY "PollFrequency"
#define ZWN_LAST_ERROR "LastError"
#define ZWN_DELAY_PROCESSING "DelayProcessing" implement this

// ============ ZWaveDevice ============
// Basic functionality for all ZWave devices

#define ZWDEVICE_FILE "S_ZWaveDevice1.xml"
#define ZWDEVICE_SID "urn:micasaverde-com:serviceId:ZWaveDevice1"
#define ZWDEVICE_STYPE "urn:schemas-micasaverde-com:service:ZWaveDevice:1"

// Variables
#define ZWD_POLL_SETTINGS "PollSettings" // DEVICEDATA_Polling_Settings_CONST
#define ZWD_MULTCH_ENDPOINT "MultiChEndpoint" // DEVICEDATA_Multi_Channel_End_Point_CONST
#define ZWD_MULTCH_CAPABIL "MultiChCapabilities" // DEVICEDATA_Multi_Channel_Capabilities_CONST

// ZWD_MULTCH_ENDPOINT string m_sMultiChannelList, // If m_cProtocolVersion>=2 (multi channel), then If this has embedded devices, Format: [number of end points] , [0/1 end points are dynamic], [0/1 end points are identical]
// If m_cProtocolVersion<2 (multi instance), then the total number of instances
// ZWD_MULTCH_CAPABIL m_sMultiChannelCapability; // m_cProtocolVersion>=2, if this has devices, Format: [end point #], Generic device class, Specific device class, command class 1, command class 2.... \n repeat next end point
// If m_cProtocolVersion<2, command class, # of instances \n repeat command class

#define ZWD_NEIGHBORS "Neighbors" // DEVICEDATA_Neighbors_to_Call_CONST
#define ZWD_CAPABILITIES "Capabilities" // DEVICEDATA_Capabilities_CONST
#define ZWD_CONFIG "Configuration" // DEVICEDATA_Configuration_CONST
#define ZWD_LAST_RESET "LastReset" // DEVICEDATA_Last_Reset_CONST
#define ZWD_SCENES_AS_EVENTS "ScenesAsEvents" // DEVICEDATA_Scenes_As_Events_CONST
#define ZWD_SCENES "Scenes" // DEVICEDATA_Scenes_CONST
#define ZWD_SCENES_TIMESTAMPS "ScenesTimestamp" // DEVICEDATA_Scenes_CONST
#define ZWD_WAKEUP_INTERVAL "WakeupInterval" // DEVICEDATA_Wakeup_Interval_CONST
#define ZWD_BATTERY_LEVEL "BatteryLevel" // DEVICEDATA_Battery_Level_CONST
#define ZWD_BATTERY_ALARM "BatteryAlarm" // DEVICEDATA_Battery_Alarm_CONST
#define ZWD_LAST_WAKEUP "LastWakeup" // DEVICEDATA_Last_Wakeup_CONST
#define ZWD_LAST_ROUTE_UPD "LastRouteUpdate" // DEVICEDATA_Last_Route_Update_CONST
#define ZWD_VARIABLES_GET "VariablesGet" // DEVICEDATA_Variables_Get_CONST
#define ZWD_VARIABLES_SET "VariablesSet" // DEVICEDATA_Variables_Set_CONST
#define ZWD_ASSOCIATION_GET "AssociationGet" // DEVICEDATA_Association_Get_CONST
#define ZWD_ASSOCIATION_SET "AssociationSet" // DEVICEDATA_Association_Set_CONST
#define ZWD_MANUF_INFO "ManufacturerInfo" // DEVICEDATA_Model_CONST
#define ZWD_VERSION_INFO "VersionInfo" // DEVICEDATA_Configuration_CONST
#define ZWD_UPDATED_NAME "UpdatedName" // DEVICEDATA_Update_Name_CONST

// ============ InsteonNetwork ============
// Basic functionality for all Insteon devices

#define INN_FILE "S_InsteonNetwork1.xml"
#define INN_SID "urn:micasaverde-com:serviceId:InsteonNetwork1"
#define INN_STYPE "urn:schemas-micasaverde-org:service:InsteonNetwork:1"

#define INN_RESET_NETWORK "ResetNetwork"
#define INN_REMOVE_NODES "RemoveNodes"
#define INN_ADD_NODES "AddNodes"
#define INN_SEND_DATA "SendData"

// Variables
#define INN_COM_PORT "ComPort" // DEVICEDATA_COM_Port_on_PC_CONST
#define INN_LAST_ERROR "LastError"
#define INN_AUTO_CONFIGURE "AutoConfigure" // DEVICEDATA_Auto_Configure_CONST
#define INN_LAST_UPDATE "LastUpdate" // DEVICEDATA_LastUpdate_CONST
#define INN_NET_STATUS_ID "NetStatusID"
#define INN_NET_STATUS_TEXT "NetStatusText"
#define INN_POLL_ENABLED "PollingEnabled"
#define INN_POLL_DELAY_INITIAL "PollDelayInitial"
#define INN_POLL_DELAY_DEADTIME "PollDelayDeadTime"
#define INN_POLL_MINDELAY "PollMinDelay"
#define INN_POLL_FREQUENCY "PollFrequency"
#define INN_NODE_ID "NodeID" // The dongle's id

/*
#define INN_VERSION_INFO "VersionInfo"
#define INN_HOME_ID "HomeID"
#define INN_ROLE "Role"
#define INN_RESET_MODE "ResetMode"
#define INN_INCLUSION_MODE "InclusionMode"
#define INN_NODETYPE "NodeType"
#define INN_TIMEOUT "Timeout"
#define INN_MULTIPLE "Multiple"
#define INN_SIMULATE_INCOMING "SimulateIncomingData"
*/

// ============ InsteonDevice ============
// Basic functionality for all Insteon devices

#define INDEVICE_FILE "S_InsteonDevice1.xml"
#define INDEVICE_SID "urn:micasaverde-com:serviceId:InsteonDevice1"
#define INDEVICE_STYPE "urn:schemas-micasaverde-com:service:InsteonDevice:1"

// Variables
#define IND_POLL_SETTINGS "PollSettings" // DEVICEDATA_Polling_Settings_CONST
#define IND_MULTCH_ENDPOINT "MultiChEndpoint" // DEVICEDATA_Multi_Channel_End_Point_CONST
#define IND_MULTCH_CAPABIL "MultiChCapabilities" // DEVICEDATA_Multi_Channel_Capabilities_CONST

// IND_MULTCH_ENDPOINT string m_sMultiChannelList, // If m_cProtocolVersion>=2 (multi channel), then If this has embedded devices, Format: [number of end points] , [0/1 end points are dynamic], [0/1 end points are identical]
// If m_cProtocolVersion<2 (multi instance), then the total number of instances
// IND_MULTCH_CAPABIL m_sMultiChannelCapability; // m_cProtocolVersion>=2, if this has devices, Format: [end point #], Generic device class, Specific device class, command class 1, command class 2.... \n repeat next end point
// If m_cProtocolVersion<2, command class, # of instances \n repeat command class

#define IND_NEIGHBORS "Neighbors" // DEVICEDATA_Neighbors_to_Call_CONST
#define IND_CAPABILITIES "Capabilities" // DEVICEDATA_Capabilities_CONST
#define IND_CONFIG "Configuration" // DEVICEDATA_Configuration_CONST
#define IND_LAST_RESET "LastReset" // DEVICEDATA_Last_Reset_CONST
#define IND_SCENES_AS_EVENTS "ScenesAsEvents" // DEVICEDATA_Scenes_As_Events_CONST
#define IND_SCENES "Scenes" // DEVICEDATA_Scenes_CONST
#define IND_WAKEUP_INTERVAL "WakeupInterval" // DEVICEDATA_Wakeup_Interval_CONST
#define IND_BATTERY_LEVEL "BatteryLevel" // DEVICEDATA_Battery_Level_CONST
#define IND_BATTERY_ALARM "BatteryAlarm" // DEVICEDATA_Battery_Alarm_CONST
#define IND_LAST_WAKEUP "LastWakeup" // DEVICEDATA_Last_Wakeup_CONST
#define IND_LAST_ROUTE_UPD "LastRouteUpdate" // DEVICEDATA_Last_Route_Update_CONST
#define IND_VARIABLES_GET "VariablesGet" // DEVICEDATA_Variables_Get_CONST
#define IND_VARIABLES_SET "VariablesSet" // DEVICEDATA_Variables_Set_CONST
#define IND_ASSOCIATION_GET "AssociationGet" // DEVICEDATA_Association_Get_CONST
#define IND_ASSOCIATION_SET "AssociationSet" // DEVICEDATA_Association_Set_CONST
#define IND_MANUF_INFO "ManufacturerInfo" // DEVICEDATA_Model_CONST
#define IND_VERSION_INFO "VersionInfo" // DEVICEDATA_Configuration_CONST
#define IND_UPDATED_NAME "UpdatedName" // DEVICEDATA_Update_Name_CONST

// ============ USB UIRT ============
// Basic functionality for USB UIRT

#define UIRT_FILE "S_USBUIRT.xml"
#define UIRT_SID "urn:micasaverde-com:serviceId:USBUIRT1"
#define UIRT_TYPE "urn:schemas-micasaverde-com:service:USBUIRT:1"

// Variables

// Actions
#define UIRT_COM_PORT "ComPort"

// ============ Camera ============
// Basic functionality for all Cameras

#define CAMDEVICE_FILE "S_Camera1.xml"
#define CAMDEVICE_SID "urn:micasaverde-com:serviceId:Camera1"
#define CAMDEVICE_STYPE "urn:schemas-micasaverde-com:service:Camera:1"

// Variables
#define CAM_USERNAME "Username" // DEVICEDATA_AuthUser_CONST
#define CAM_PASSWORD "Password" // DEVICEDATA_AuthPassword_CONST

#define CAM_RELATED_SENSORS "RelatedSensors" // Comma separated list: Archive a photo whenever the following sensors are tripped or doors are opened:
#define CAM_SENSOR_ARCHIVE_SEC "SensorArchiveSeconds" // Integer: And after the sensor(s) are tripped archive the video for seconds.
#define CAM_RELATED_LIGHTS "RelatedLights" // Comma separated list: Which lights should be turned on when viewing this camera:
#define CAM_LIGHT_OPTIONS "LightOptions" // V=When I view the camera from the web or phone.
// S=When the sensor(s) above are tripped and they are armed
// B=When the sensors above are tripped and they are *not* armed
// A=When you take an automatic picture for the archive
// So: VSBA means do them all

#define CAM_AUTO_ARCH_SEC "AutoArchiveSeconds" // For archival purposes, take a picture from the camera every x seconds
#define CAM_AUTO_PRES_DAYS "AutoArchivePreserveDays" // and keep the pictures x days
#define CAM_URL "URL" // DEVICEDATA_Path_CONST

// ============ PanTiltZoom ============
// For Cameras

#define PTZ_FILE "S_PanTiltZoom1.xml"
#define PTZ_SID "urn:micasaverde-com:serviceId:PanTiltZoom1"
#define PTZ_STYPE "urn:schemas-micasaverde-com:service:PanTiltZoom:1"

// Actions
#define PTZ_LEFT "MoveLeft"
#define PTZ_RIGHT "MoveRight"
#define PTZ_UP "MoveUp"
#define PTZ_DOWN "MoveDown"
#define PTZ_IN "ZoomIn"
#define PTZ_OUT "ZoomOut"

// ============ SwitchPower1 ============
#define SWP_SID "urn:upnp-org:serviceId:SwitchPower1"

// Actions
#define SWP_SET_TARGET "SetTarget"

// Variables
#define SWP_STATUS "Status"
#define SWP_TARGET "Target"

// ============ S_WindowCovering1 ============
#define WC_SID "urn:upnp-org:serviceId:WindowCovering1"

// Actions
#define WC_UP "Up"
#define WC_DOWN "Down"
#define WC_STOP "Stop"

// Variables

// ============ Dimming1 ============
#define SWD_SID "urn:upnp-org:serviceId:Dimming1"

// Actions
#define SWD_SET_LOAD_LEVEL "SetLoadLevelTarget"

// Variables
#define SWD_LOAD_LEVEL_STATUS "LoadLevelStatus"
#define SWD_LOAD_LEVEL_TARGET "LoadLevelTarget"

// ============ DoorLock1 ============
#define DL_SID "urn:micasaverde-com:serviceId:DoorLock1"

// Actions
#define DL_SET_TARGET "SetTarget"
#define DL_SET_PIN "SetPin"
#define DL_CLEAR_PIN "ClearPin"

// Variables
#define DL_STATUS "Status"
#define DL_TARGET "Target"
#define DL_SL_USER_CODE "sl_UserCode"
#define DL_SL_PIN_FAILED "sl_PinFailed"

// Syntax: CodeID, Pin Code (only if start date is not empty), start date, stop date, Name \t
#define DL_PIN_CODES "PinCodes" // DEVICEDATA_PIN_Codes_CONST

// ============ HVAC_UserOperatingMode1 ============
#define HVACO_SID "urn:upnp-org:serviceId:HVAC_UserOperatingMode1"

// Actions
#define HVACO_SET_MODE "SetModeTarget"

// Variables
#define HVACO_STATUS "ModeStatus"

// ============ HVAC_FanOperatingMode1 ============
#define HVACF_SID "urn:upnp-org:serviceId:HVAC_FanOperatingMode1"

// Actions
#define HVACF_SET_MODE "SetMode"

// Variables
#define HVACF_STATUS "ModeStatus"

// ============ TemperatureSetpoint1_Heat/Cool ============
#define HVACHEAT_SID "urn:upnp-org:serviceId:TemperatureSetpoint1_Heat"
#define HVACCOOL_SID "urn:upnp-org:serviceId:TemperatureSetpoint1_Cool"

// Variables
#define HVACHC_SETPOINT "SetCurrentSetpoint"

// Variables
#define HVACHC_CURRENTSP "CurrentSetpoint"

// ============ TemperatureSensor1 ============
#define TEMP_SID "urn:upnp-org:serviceId:TemperatureSensor1"

// Variables
#define TEMP_CURRENT "CurrentTemperature"

// ============ LightSensor1 ============
#define LIGHT_SID "urn:micasaverde-com:serviceId:LightSensor1"

// Variables
#define LIGHT_CURRENT "CurrentLevel"

// ============ HumiditySensor1 ============
#define HUM_SID "urn:micasaverde-com:serviceId:HumiditySensor1"

// Variables
#define HUM_CURRENT "CurrentLevel"

// ============ SecuritySensor1 ============
#define SES_SID "urn:micasaverde-com:serviceId:SecuritySensor1"

// Variables
#define SES_ARMED "Armed"
#define SES_TRIPPED "Tripped"

// Action
#define SES_SET_ARMED "SetArmed"

// ============ EnergyMetering1 ============
#define ENE_SID "urn:micasaverde-com:serviceId:EnergyMetering1"

// Variables
#define ENE_KWH "KWH"
#define ENE_WATT "Watt"
#define ENE_ACTUAL "ActualUsage"
#define ENE_USER_SUPPLIED "UserSuppliedWattage"

// ============ IrTransmitter1 ============
#define IRT_SID "urn:micasaverde-com:serviceId:IrTransmitter1"

// Variables
#define IRT_SENDPRONTO "SendProntoCode"

// ============ SerialPort1 ============
#define SPT_SID "urn:micasaverde-org:serviceId:SerialPort1"

// Variables
#define SPT_BAUD "baud"

// ============ SceneController1 ============
#define SCR_SID "urn:micasaverde-com:serviceId:SceneController1"

// Variables
#define SCR_SL_SCENE_ACTIVATED "sl_SceneActivated"
#define SCR_SL_SCENE_DEACTIVATED "sl_SceneDeactivated"

// ============ GenericIO ============
#define GIO_SID "urn:micasaverde-com:serviceId:GenericIO"

// Variables
#define GIO_IS_INPUT "IsInput" // DEVICEDATA_InputOrOutput_CONST, 1 if it's input
#define GIO_DEFAULT_STATE "DefaultState"// DEVICEDATA_Default_State_CONST, 0 is 'normal', 1 if it's reversed

#endif

Dialer Plugin

2010-04-17T21:46:47Z

Javier:

[[Category:Plugins]]
[[Category:3rd Party]]
Dealer Plugin allows Vera to initiate an automatic phone call between two or more parties.

For example, a motion detector at home could make Vera connect you at mobile phone and the home phone - thus letting you reach someone who just entered home immediately.

Similarly, button on z-wave controller at home could programmed to initiate a call between a speakerphone at home and your mobile or office home - which could make a sort of Quick Dial button for children or elderly ([http://thinkvoip.wordpress.com keep in mind that residential VoIP solutions are '''not designed''' to be mission critical], and thus '''should not''' be trusted for real life and death matters).

Before starting with the setup, user should decide on ''primary'' and ''secondary'' phone numbers. Primary number is where the 'emergency' call goes (ex: user's mobile phone), secondary number is where the event happens.
To illustrate this we'll take a simplified scenario: user has an auto-answering speakerphone at home, and if something happens he wants the system to reach him on his mobile phone, connecting to the speakerphone at home so he can talk to whoever is there (at home) at the moment. In this case ''primary'' number would be the mobile phone, and the ''secondary'' number would be the home number. This is important because the system first calls the ''primary'' number, and only when it answered it connects the ''secondary'' one.

* Login into your [http://pbxes.com PBXes] account, and create a Classical (or SIP if relevant) extension that would represent the ''primary'' number as defined above. Put any unique value in URL field in Webcall section.

[[Image:Cl-ext.png‎‎]]

* Install the plugin on Vera, create a new Dialer device, Save

* Go to device settings, in field Alias put the value you used in URL @pbxes.com
Fill PhoneNumber field with the ''secondary'' number. Don't forget to save.

[[Image:Dealer.png‎]]

* Test setup by clicking on 'On' button would trigger the call. The device can now be used in scenes, events, and Luup scripts.

For those who would like to go deeper: both ''primary'' and ''secondary'' destinations can also be calling groups of various dialing strategies, or can even dial into a virtual conference rooms.

Download [http://www.box.net/shared/4vgsl5v2lr Dialer plugin] and enjoy!

Feel free to contact me with questions: dialer@edmidor.com

ZWave Versions

2010-04-17T21:45:54Z

Javier:

[[Category:Development]]
ZWave 4.27 - Serial API 2.40: 2008-06-02 stable, but no security

ZWave 5.02 - Serial API 2.48: 2008-08-15 first support for security, not stable

ZWave 5.02 sp2 - Serial API 2.64: 2009-01-13 fixed most bugs, but still had problem with tx buffer dying

ZWave 5.02 sp3 - Serial API 2.78: 2009-07-10 stable version that supports security

ZWave Status

2010-04-17T21:45:19Z

Javier:

[[Category:Development]]
You can see the status of the Z-Wave network and all devices with the data request '''zwave_status'''. See: [[Data Provider Catalog Plugin]] and [[Data Provider Catalog Plugin Requests]]

http://192.168.81.1:3451/data_request?id=zwave_status returns something like this (note: add &output_format=json to the URL to get the same data in JSON format):

1 2 Waiting for controller 11 0 0 5 1 0 12 0 0 5 1 0 13 FAILED 0 1 5 5 0 14 0 1 5 5 Job ending in error: Failed with TXStatus: 1 0 15 FAILED 0 1 5 5 Job ending in error: Failed with TXStatus: 1 0 16 FAILED 0 1 5 5 Job ending in error: Failed with TXStatus: 1 0 17 0 0 5 1 0 

The format is like this. The first line has: ZWaveNetworkStatus [tab] JobStatus_TransferJobs [tab] Text description for transfer jobs.

The network status is this: 

enum ZWaveStatus // Make the enumerator public 

{

zws_NotSet=0,

zws_OK=1,

zws_Quiting=2,

zws_WaitingToQuit=3,

zws_NoDongle=4,

zws_Configuring=5, // Still running init/configure scripts

zws_Failure=6

};

The network status is 1 (OK) then you don't need to warn the user to wait. If it is anything other than 1, you can display a 'wait' icon and some text like: ZWaveStatus[0]="Please wait for the Z-Wave network"; #zws_NotSet ZWaveStatus[2]="The Z-Wave network is being reset" ZWaveStatus[3]="Waiting to reset the Z-Wave network" ZWaveStatus[4]="The Z-Wave dongle has been removed" ZWaveStatus[5]="Configuring Z-Wave devices" ZWaveStatus[6]="The Z-Wave network is not functioning" 

*NOTE: If you do not get a response to the data request (i.e. if the poll fails), then that means the Z-Wave software module is busy resetting itself, which happens periodically when devices change. Just try the request again.

The rest of the lines in the result look like this:

5 FAILED 0 1 5 5 Job ending in error: Failed with TXStatus: 1 0

and have this format: PK_Device State Status Configured(0/1) LastContactFailed(0/1) ConfigStatus DescriptionOfConfigStatus PollStatus DescriptionOfPollStatus NumOfActiveJobs Job#1 Job#2 Job#3 etc.

All are separated by tabs. The ConfigStatus and PollStatus have this:

enum ZWaveJobStatus { 

ejs_NoJob=1,

ejs_WaitingToStart=2,

ejs_Running=3,

ejs_JobSuccessful=4,

ejs_JobFailed=5

};

The Job#1/2/3/etc. have this format:

icon_name,JobStatus,DescriptionOfJobStatus

so a job could look like this: ON,3,Waiting for reply

In our UI, ConfigStatus, PollStatus, and each JobStatus will be an icon in the 'device info box'. If the status is ejs_NoJob=1, then that means don't show an icon. If it is >1, then you will show the icon. Here are the icons: 

CONFIG, POLL, ON, OFF, LEVEL, MISC

The first 2 icons correspond to ConfigStatus and PollStatus. The other 4 are possible icon_name's in JobStatus. Each job can have 4 possible states:

{

ejs_WaitingToStart=2, (gray)

ejs_Running=3, (blue)

ejs_JobSuccessful=4, (green)

ejs_JobFailed=5, (red)

};

So, you've got 24 different icons: 6 types (CONFIG, POLL, ON, OFF, LEVEL, MISC) and each one has 4 possible states. Daniel will do the icons. For now, just create 24 solid squares with the gray/blue/green/red. I propose icon names of:

CONFIG_3.gif (config icon, blue) LEVEL_2.gif (level icon, gray) etc.

ZWave Options

2010-04-17T21:44:44Z

Javier:

[[Category:User Instructions]]
[[Category:UI2]]
[[Image:Z-wave Optionn.jpg|thumb|center|512px|Z-Wave Options]]

Here you have various advanced Z-Wave options. Use these options only if you understand what they mean. Most users will not need these options.

'''Reset Z-Wave network''' purges all data in Vera's black Z-Wave dongle, which also clears out the list of Z-Wave devices paired to Vera. You will then need to [[Reset Node|reset any devices]] you previously paired, and pair them again. If you also want to get rid of your scenes, network settings, users, network devices, etc., you can do a full [[Factory Reset|factory reset]].

'''WARNING''': This process is '''IRREVERSIBLE''', you cannot restore your devices from a backup, you have to pair each of them again.
Before proceeding you have to manually unpair all the devices, otherwise you will create duplicate nodes which will compromise your Z-Wave network.

If you already have another Z-Wave controller that you want to be the master, and you want Vera to be the secondary controller, bring the master controller and Vera close to each other, tell the current master controller to start sending network data or to add another Z-Wave controller, and then click '''Copy Z-Wave network from a master controller'''. You will see the status of the transfer in blue at the top of the page, and Vera will tell you if it was successful. The "Role" shown on this page will then also change a minute or so later.

Rather than carrying around the dongle and using the dongle's built-in include/exclude, you can manually include/exclude devices by setting your options and clicking '''Go'''. Excluding a device is the same thing as resetting it, as explained [[Reset Node|here]]. Also read how to use this to do [[Full Power Inclusion|full power inclusion]] to add, or pair, Z-Wave devices to Vera without bringing the device in proximity to Vera's ZWave dongle.

'''Controller shift''' tells Vera to transfer the role of primary controller to another Z-Wave controller. After you click 'Controller Shift,' proceed to add the other Z-Wave controller the same way you normally would, as explained [[ZWave Add Controller|here]]. The difference between adding the controller by clicking 'Controller Shift' versus adding the controller the normal way by clicking 'Add ZWave controller', is that if you choose 'Controller Shift', at the end when the other Z-Wave controller gets added, that other ZWave controller will become the 'Master controller', and Vera will be a secondary controller. This means the other Z-Wave controller will then be responsible for healing the networking and being the SIS/SUC (a technical Z-Wave term). Normally, by default, Vera is the master controller and is SIS/SUC.

ZWave Dongle

2010-04-17T21:43:36Z

Javier:

[[Category:User Instructions]]
Your Vera purchase includes a Z-Wave dongle, which must remain plugged into the back of Vera for her Z-Wave functions to work. You do not need to do anything for the dongle to work with Vera.

If you want to use the dongle separately from Vera, or purchased an extra dongle on its own, you will need the appropriate CP210x USB-RS232 drivers for your operating system. They are available here: https://www.silabs.com/products/interface/usbtouart/Pages/default.aspx

1. Download the Windows drivers for the Zwave Stick:
2.1. Go to: https://www.silabs.com/products/mcu/Pages/USBtoUARTBridgeVCPDrivers.aspx
2.2. Download [b]VCP Driver Kit [/b] https://www.silabs.com/Support%20Documents/Software/CP210x_VCP_Win2K_XP_S2K3.zip
2.3. If you don't have an unzip program (a program to extrac the zip archive) grab 7zip from here: http://www.7-zip.org/
2.3.1. Download [b]7-Zip 4.65 [/b] http://downloads.sourceforge.net/sevenzip/7z465.exe
2.4. Extract the CP210x_VCP_Win2K_XP_S2K3.zip archive and run CP210x_VCP_Win2K_XP_S2K3.exe
2.4.1. Install the Drivers.
3. Plug the black Zwave dongle in your PC USB PORT

Once the drivers are installed, the dongle should show up as a COM port or serial device. Then any software designed to work with the Z-Wave serial API, such as ControlThink, HomeSeer, etc., should work fine. Windows users may need to edit the port settings and set them as follows: Bits per second: 115200 Data bits: 8 Parity: None Stop bits: 1 Flow Control: none

To add devices to the dongle, tap the button so the blue light is blinking slowly. Then activate your nearby Z-Wave devices. To remove devices, press and hold the button until it blinks quickly, then activate your nearby Z-Wave devices. You can also add/remove devices while the dongle is attached to the PC's USB interface using your Z-Wave software's add/remove device function. Use your Z-Wave software to replicate the Z-Wave network.

'''Z-Wave Dongle Versions:'''

* ''2.40'' = Zensys Firmware ''4.27'';
* ''2.48'' = Zensys Firmware ''5.02'';
* ''2.60'' = Zensys Firmware ''5.02 Service Pack 2'';
* ''2.78'' = Zensys Firmware ''5.02 Service Pack 3''.

You can determine the dongle version looking at the Version: line on the More Z-Wave Options page (Devices -> Z-Wave -> More Z-Wave Options).

ZWave Debugging

2010-04-17T21:43:07Z

Javier:

[[Category:Development]]
== Easy Z-Wave Debugging ==

== Z-Wave specifics ==

Vera maps the command class BASIC to COMMAND_CLASS_SENSOR_BINARY, and responds to BASIC_GET or SENSOR_BINARY_GET with a _REPORT that has a value of 1 if Vera is running (ie it's always 1).

== Advanced debugging for developers ==

Here are some hints for debugging Z-Wave protocol issues. You can access Vera by telnet, or if you already set a password, by ssh.

First, be sure you check the box "verbose logs" under 'Advanced', 'Logging', or, from a console run /usr/bin/VerboseLogging.sh enable.

The logs are in the directory /var/log/cmh. The first 2 digits are the 'log level'. The file: DCERouter.log contains the logging information from the core message router. The file: x-ZWave.log (where x is usually 9) contains all the logs from the Z-Wave module.

Log levels for data sent to the Z-Wave dongle: 40 = data sent to the Z-Wave dongle 41 = data received from the Z-Wave dongle 01 = critical errors 04 = jobs 05 = warnings 06 = variables (which indicates state changes) 07 = events 08 = commands 10 = status messages
 

For commands runed in a scene, the logs won't be getting data from the user, but from a scene, so to see this requests, you should grep for RunScene .

 

So, if you want to watch the router's logs and see what commands are being sent to the various devices, do this:

'''cd /var/log/cmh tail -f DCERouter.log | grep '^08''''

Now from Vera's dashboard, send commands to the devices and you'll see them in the log. The | grep '^08' means to filter only lines that start with 08, meaning log level 08 ("Commands"). tail -f means "follow the log". To stop the tail and get back to the console, if you used ssh to login, you just press Ctrl+C. Unfortunately, often times telnet doesn't forward Ctrl+C, so, when using telnet you need to press Ctrl+Z and then type this to kill the tail command: killall tail; fg

To watch the traffic on the Z-Wave serial bus, type:

'''cd /var/log/cmh tail -f 9-ZWave.log | grep '^40\|^41''''

which means show log level 40 or 41. Normally Vera is polling all the nodes every few seconds, so the logs fill up quickly with Z-Wave traffic from the polling. If you want to turn off automatic polling temporarily for this session so the logs aren't cluttered with polling traffic, type:

'''/usr/bin/MessageSend localhost 0 9 1 966 5 0''' (assuming the Z-Wave device is #9, as default, add 225 1 to make the change permanent)

To force a poll of device 13, type: '''/usr/bin/MessageSend localhost 0 9 1 966 2 13 5 UPDATE'''

Next you can send "COMMAND: #191 - Send Code" to either a Z-Wave Node and the parameter 9 (Text) is a command, or send it to the Z-Wave device and it is a frame. The contents of text are a string of hex or decimal numbers separated with spaces, dashes or underscores, and hex values are preceded with 0x or x. So assuming a dimmable light is device 20 in node 15, either command below will dim it to 50%:

'''/usr/bin/MessageSend localhost 0 9 1 191 9 "0 x13 15 0x3 0x26 0x1 50 4 1"''' #send data (func id x13) to node 15 command class 0x26 command 0x1 (set multi level) to 10% (size=3) with transmit options=4 and funcid=1

'''/usr/bin/MessageSend localhost 0 20 1 191 9 "x26 x1 50"''' #send the message directly to device 20 (the node, not 9 the Z-Wave dongle), so the node id and 'send data' frame are assumed

--Luup update: wget "http://127.0.0.1:49451/data_request?id=lu_action&DeviceNum=1&serviceId=urn:micasaverde-com:serviceId:ZWaveNetwork1&action=SendData&Node=7&Data=x26-x1-20" node 7 to 20%

--Luup update: wget "http://127.0.0.1:49451/data_request?id=lu_action&DeviceNum=1&serviceId=urn:micasaverde-com:serviceId:ZWaveNetwork1&action=SendData&Data=0-x13-7-0x3-0x26-0x1-50-4-1" node 7 to 20%

'''/usr/bin/MessageSend localhost 0 14 1 191 9 "x85 2 1"''' #Tell device 14 to report its association group 1

Ask node 4 (a thermostat) to report its temperature: "0 0x13 0x4 0x2 0x40 0x2 5 1"

You can also put an R in front of the binary data, and include the full frame, and it simulates a received frame on the serial api, rather than sending a frame. So to simulate receiving a FUNC_ID_ZW_APPLICATION_UPDATE from node 1 run: '''/usr/bin/MessageSend localhost 0 9 1 191 9 "R0x1 0x9 0x0 0x49 0x84 0x1 0x3 0x2 0x2 0x1 0x38"''' or an encrypted message from node 29 with FUNC_ID_APPLICATION_COMMAND_HANDLER, COMMAND_CLASS_SECURITY: '''"R0x01 0x1C 0x00 0x04 0x00 29 0x16 0x98 0x81 0xEC 0xE1 0x10 0x56 0xFC 0x13 0xDF 0x04 0x45 0x60 0x24 0xA8 0x43 0x89 0xE8 0x22 0x36 0x15 0xA9 0xB1 0x1C"'''

--Luup update: wget "http://127.0.0.1:49451/data_request?id=lu_action&DeviceNum=1&serviceId=urn:micasaverde-com:serviceId:ZWaveNetwork1&action=SendData&Data=R0x1-0x16-0x0-0x4-0x0-0x4-0x10-0x8f-0x1-0x4-0x3-0x80-0x3-0x64-0x2-0x46-0x4-0x2-0x46-0x7-0x2-0x84-0x7-0x15"

Note that the logs will rotate regularly, meaning the DCERouter.log is archived as DCERouter.log.1.gz, and the old DCERouter.log.1.gz becomes DCERouter.log.2.gz. This is handled by the root cron process that runs /usr/bin/Rotate_Logs.sh.

Every time you do something with Vera this results in a "job". So let's assume you want to see what Vera is doing to configure a device. Type 'date' to see the date/time. Click the 'configure right now' button for the device. Type ''grep AddJob 9-ZWave.log'' to see all the log entries with 'AddJob' in them. Each one is given a number, and an abbreviated description. Say the first job after the 'date' is ''10 01/26/09 16:35:51.640 JobHandler::AddJob job#6 :conf_jh#9 (0x00DD7390) P:40 S:0 <00DD7390> conf_jh#9 type ZWJob_ConfigureNode first 0'' This means it's job#6, the name 'conf_jh#9' means it's a configure job from the main job handler for node #9. You may see lots of other jobs right after #6 to do things like set the Version/Manufacturer, set Associations, etc., because the main configure job (#6) may spawn many other jobs. To see all the log entries for job #6, type ''grep "job#6" 9-ZWave.log''. Pay attention to the lines with m_eJobStatus which indicate the status, such as ''m_eJobStatus Job completed ok''. Let's say you want to see what data is being sent/received as part of job#6, you could do this: ''grep 'job#6\|^40\|^41\|^01\|^05' 9-ZWave.log'' so you see all log entries for job #6, all incoming/outgoing data, plus critical errors (1) and warnings (5). Look for the line 'ready to run' in the logs, which will indicate where job #6 is starting. The logs are color coded, and the less that comes with busybox in Vera doesn't support the -R parameter to view the logs in color, which is much easier to read. So, you can set a root password if you haven't already (type ''passwd''), and then use scp to copy the log files from Vera to another Linux/Mac/Windows with cygwin pc, and then run: ''grep 'job#6\|^40\|^41\|^01\|^05' 9-ZWave.log | less -R'' to see just the filtered portion of the logs in color.

 You can also use MessageSend to send Vera's normal DCE commands directly to devices. The ID's are the same as LinuxMCE. You can also '''tail -f DCERouter.log | grep '^08''''

From the console, if you want to see if a device is configured, enable verbose logging: '''/usr/bin/VerboseLogging.sh enable''', restart the Z-Wave device: '''/usr/bin/MessageSend localhost 0 9 7 1''' then wait for it to finish checking all the devices and '''grep UpdateNode 9-ZWave.log'''. You'll see: '''ZWaveJobHandler::UpdateNodes node 13 PK_DeviceTemplate 37 type ZWaveNonDimmableLight PK_Device 19 cap 0xc9 sec 0xc res 0x0 bas 0x4 gen 0x10 spe 0x3 config 1 LS (on/off)-45W-IPCAM classes 25,27,2b,2c,72,73,77,82,85,86,91,ef,''' config 1 means the device is configured. To reconfigure a device from the command line, send it command 776. For this device it would be: '''/usr/bin/MessageSend localhost 0 19 1 776'''.

Reset the Z-Wave network: '''/usr/bin/MessageSend localhost 0 9 1 776 51 SIS'''

Do a 'soft reset' that doesn't lose any devices, but resets the dongle: '''/usr/bin/MessageSend localhost 0 9 1 776 51 SOFT'''

== Z-Wave Log Messages ==

=== Z-Wave LastNote ===

'''Status="Aborted" LastNote="Timed out waiting for the node to reply"'''

'''Status="Aborted" LastNote="Node is not configured"'''

'''Status="Aborted" LastNote="Unable to get any information on node"'''

'''Status="Aborted" LastNote="Transmit failed with code: 1"'''

== Remote Upgrade with preserve settings ==

curl -k -s -S --fail --retry 3 -o /tmp/firmware.img http://download.controlmyhouse.net/betafirmware/ftp/wl500gP-1.0.543.trx

/usr/bin/cmh-upgrade.sh

== Z-Wave routing matrix ==

See http://forum.micasaverde.com/index.php?topic=2099.msg8292#msg8292

== Z-Wave stress test ==

Start a stress test of the Z-Wave network with this command. Stop by doing a /usr/bin/Reload.sh

wget "http://127.0.0.1:49451/data_request?id=lu_action&DeviceNum=1&serviceId=urn:micasaverde-com:serviceId:ZWaveNetwork1&action=SendData&Stress=X"

where X is:

#define STRESS_TEST_CONSTANT 1 // Constant BASIC_SET's
#define STRESS_TEST_NEIGHBOR_UPDATE 2 // Constant Neighbor updates
#define STRESS_TEST_WATCHDOG 3 // Constant Watchdog checks -- bugs in the Z-Wave serial API cause this to crash
#define STRESS_TEST_SOFT_RESET 4 // Constant soft resets

ZWave Configuration Options

2010-04-17T21:42:28Z

Javier:

[[Category:User Instructions]]
= Options under the '+' button =

When you go to the [[Devices|'Devices']] tab on Vera's [[Quick Start|setup site]] and click '+' next to a Z-Wave device, you will see Z-Wave specific options for that particular device.

The node ID is the identification number Vera assigned to the device on the Z-Wave network.

Z-Wave devices are normally polled to see if the device is working and if the status has changed, such as the device having been turned off, etc. Normally leave this blank to let Vera do the default polling, or see [[Polling Settings|polling settings]] to learn how to change Vera's polling behavior.

== Wattage ==

Very few Z-Wave devices are actually able to report how much energy they are using, so Vera generally estimates this based on the device's wattage. By default each light will have 100 watts. If the light really is a 100 watt light, you can leave it. If not, put in the actual wattage, which is usually printed on the bulb. Remember that if multiple lights are on the same Z-Wave switch you should add their wattages. You can also specify the wattages for appliance modules; for example, if you have a 200-watt fan plugged into an appliance module, you would type "200" for this device's wattage. Vera will constantly poll all the Z-Wave devices in your home to see if they are on, off or dimmed to a certain level, and Vera will use this to estimate the electricity being used. Also see: [[Energy]]

== Automatically configure ==

Normally you should leave the default behavior, as specified on the 'Z-Wave options' page, by leaving 'By default Vera should automatically configure devices' checked, with all your devices set to 'Use the default'. This way Vera will automatically configure all your devices. In many cases, the devices will not work unless Vera configures them, and generally you will always want Vera to do this for you. The only exception is when you have another Z-Wave controller configuring your devices, and you've made some special settings there, and you don't want Vera to change them.

Even you do have have another Z-Wave controller, it's still okay to let Vera configure your Z-Wave devices. The only problem may arise when it comes to associations. If you don't know what Z-Wave associations are, just accept the default settings, which are necessary if you want certain types of devices, like sensors, to work with Vera.

For those interested in an explanation of what this means, read on...

In a Z-Wave network, some of your devices support what are called "Associations" (also called the Z-Wave command class association). This is how a device that sends messages knows where to send those messages. For example, motion sensors send messages when the sensor is tripped, thermometers may send messages when the temperature changes, and so on. Often times these devices have their own proprietary mechanism for setting associations, which is not standardized. For example, a motion sensor may provide instructions in the user's manual for how to associate it with a light switch so it turns the light switch on when the sensor is tripped. Generally, it's much easier to let Vera manage the associations for you. If you let Vera do this, Vera will associate all devices that send messages with Vera, telling them all to send the messages to Vera so Vera can process them for you. For example, Vera can tell any motion sensors and thermometers to send all messages to Vera, and that way, you can attach events to your scenes so Vera will run a scene, like turning on a light, when a motion sensor is tripped, or closing the blinds when the temperature is over 90 degrees to save energy. If these devices are not associated with Vera, Vera will never get the messages. The catch is that if you have previously set up associations, those associations will be lost when Vera configures the device, because Vera will manage the associations. The recommended solution is still to let Vera handle the configuring, but just tell Vera what extra associations you want as explained in the 'Associations' section below. Then Vera will set her own associations, and will also add whatever associations you specify. You can also disable automatic configuration, either for an individual device or globally, with this check box, and then Vera won't do anything with the device's associations.

When you have added new devices and they appear on the 'Unassigned Devices' page, you have the option of turning off Vera's configuration in case you have already set up the associations before getting Vera, and you don't want Vera to take over this and change the associations you previously set up.

== Configure node right now ==

This causes Vera to attempt to configure the device immediately. After clicking this button you see the job icon for 'Configuring the Device' next to the device description and it will turn green if Vera was able to configure the device, or red if Vera was not. (See [[Device Control Status#Job_icons|diagram of job icons]]) Some devices, like motion/door/window sensors, are generally not functional until they are configured. If they are not configured, you will see the configure job icon in red. But if the device is battery operated, it's quite possible that, in order to conserve battery life, the device goes into a 'sleep mode' during which the Z-Wave radio is turned off, and Vera cannot configure it. These battery operated devices typically wake up every few hours and announce that they're going to be awake for a few seconds. When this happens, Vera will use that opportunity to configure the device. So, if you added a battery operated device and you see the red 'Configure Job' icon, indicating the device is not configured and is not usable, you can check back the next day and it probably will be configured. Often times, the sensors allow you to remove and reinsert the batteries, or to press a button, and this will force them to listen to the Z-Wave network for a minute or two. (See [[Supported Hardware]] for a list of some popular Z-Wave sensors and an explanation of how they work.) If you have a sensor like this, you can then manually 'wake it up', and then you can promptly click the 'Configure Node Right Now' button to make Vera try to configure the device. This button is also useful if you have changed specific Z-Wave configuration and association settings and want to see them applied right away, as explained below.

== Poll now ==

This causes Vera to attempt to poll the device immediately. After clicking it you see a poll job icon as shown in the [[Device Control Status#Job_icons|diagram of job icons]], and it will be green if Vera successfully polled the node, and red if not. To learn what polling is, why it's done, and how to change Vera's polling behavior, see [[Polling Settings|Polling Settings]].

== Permanently remove dead node ==

The list of Z-Wave devices which have been paired with Vera's black Z-Wave dongle is stored within the dongle itself. This means that even if you do a factory reset of Vera - which wipes out all of Vera's memory - once Vera comes back up, you'll still see the same list of Z-Wave devices. If there's a node in your home you want to remove from the Z-Wave network, the best way to do this is to exclude the Z-Wave device, also known as resetting the device. ([[Reset Node|Click here]] for an explanation) If the Z-Wave device is broken or gone, then you won't be able to exclude it the normal way. In this case, there are two alternative ways to permanently remove the paired Z-Wave device from Vera's Z-Wave dongle. One option is to choose 'Reset Z-Wave network' from Vera's [[ZWave Options|Z-Wave options]] page. But that removes '''all''' nodes and resets the dongle. The other option is to click the 'Permanently remove dead node' button to remove one particular node. You may not be able to remove a node this way if it is still powered and still responds. Power the unit off first. You may need to do this if you've added a Z-Wave controller, then later reset the Z-Wave controller, then added it again, as explained [[ZWave Add Controller|here]].

= Custom Z-Wave Settings =

todoal: show custom z-wave settings

Click this button to see more Z-Wave specific options for this device. Click the 'Back to Devices' link when are you done making these changes to go back to the devices page.

== Configuration settings ==

Some Z-Wave devices allow you to manually set configuration variables to do things like adjust ramp rate and so on. This is unique for each device, and each manufacturer handles this differently. If the manual for your Z-Wave device indicates that you can set a configuration variable or setting to change the default behavior, do it by clicking the 'Add Configuration Setting' button. Indicate which variable number to set, and what value to set it to. The value can be a '1 byte hex', '1 byte dec', '2 byte hex', '2 byte dec', '4 byte hex' or '4 byte dec'. If you do not know what this means and the manufacturer did not tell you which one they want you to choose, then choose '4 byte dec'. Put the setting you want in 'Desired Value'. Vera will attempt to configure the node after you click the red 'Save' button, and if successful, you'll see the [[Device_Control_Status#Job_icons|green 'Configure Job' OK icon]. If it's a battery operated device and Vera can't configure it right away, read the comments above about the '''Configure node right now'''. Once Vera has configured the Z-Wave device, Vera will ask the device again for the value of the configuration setting and show it under 'Current Value'. If you set a value, configured the device, and the current value is something other than your desired value, that means the Z-Wave device did not accept the 'Desired Value' you gave it, and you may need to contact the manufacturer for clarification. If you change the 'Data Size' option to say 'Monitor only', then when the device is next configured Vera will not change the value, but Vera will ask the device for the current value and show it in the 'Current Value' column. If you change it to 'Default', then the next time Vera configures the device, Vera will tell the device to go back to the default value for this setting, and you'll see the value in the 'Current Value' column.

== Associations ==

'''Note:''' Leave ''By default Vera should automatically configure devices'' checked as explained above, and leave each device's ''Automatically configure'' set to 'Default Behavior'. If you tell Vera not to configure the device, Vera will leave the device alone and will not set the associations for you.

These are also unique for each device according to the manufacturer. Associations are commonly used to tell sensors to turn on lights, and to associate devices. Refer to the manufacturer's users manual that came with the Z-Wave device to learn how they handle associations. Associations are given an ID or group ID. To add an association, type in the group ID, which is a number, click 'Add Group' and then check off the Z-Wave devices you want to be associated. Vera will attempt to configure the node after you click the red 'Save' button, and if successful, you'll see the [[Device_Control_Status#Job_icons|green 'configure job' ok icon]. If it's a battery operated device and Vera can't configure it right away, read the comments above about the '''Configure node right now'''.

== Scene Assignments ==

If this is a Z-Wave controller, then you will have another section on this page to assign scenes to the controller's buttons, as explained [[ZWave Add Controller#Scene_Assignments_for_controllers|here]]. You won't see this for other types of Z-Wave devices.

ZWave Command Classes

2010-04-17T21:41:45Z

Javier:

[[Category:Development]]
Here are the command classes Vera supports:

==Alphabetical==
{| border="1" cellpadding="2"
! Name !! Hex !! Dec
|-
|| COMMAND_CLASS_ALARM || 0x71 || 113
|-
|| COMMAND_CLASS_APPLICATION_STATUS || 0x22 || 34
|-
|| COMMAND_CLASS_ASSOCIATION_COMMAND_CONFIGURATION || 0x9B || 155
|-
|| COMMAND_CLASS_ASSOCIATION || 0x85 || 133
|-
|| COMMAND_CLASS_ASSOCIATION_V2 || 0x85 || 133
|-
|| COMMAND_CLASS_AV_CONTENT_DIRECTORY_MD || 0x95 || 149
|-
|| COMMAND_CLASS_AV_CONTENT_SEARCH_MD || 0x97 || 151
|-
|| COMMAND_CLASS_AV_RENDERER_STATUS || 0x96 || 150
|-
|| COMMAND_CLASS_AV_TAGGING_MD || 0x99 || 153
|-
|| COMMAND_CLASS_BASIC_WINDOW_COVERING || 0x50 || 80
|-
|| COMMAND_CLASS_BASIC || 0x20 || 32
|-
|| COMMAND_CLASS_BATTERY || 0x80 || 128
|-
|| COMMAND_CLASS_CHIMNEY_FAN || 0x2A || 42
|-
|| COMMAND_CLASS_CLIMATE_CONTROL_SCHEDULE || 0x46 || 70
|-
|| COMMAND_CLASS_CLOCK || 0x81 || 129
|-
|| COMMAND_CLASS_COMPOSITE || 0x8D || 141
|-
|| COMMAND_CLASS_CONFIGURATION || 0x70 || 112
|-
|| COMMAND_CLASS_CONFIGURATION_V2 || 0x70 || 112
|-
|| COMMAND_CLASS_CONTROLLER_REPLICATION || 0x21 || 33
|-
|| COMMAND_CLASS_DOOR_LOCK || 0x62 || 98
|-
|| COMMAND_CLASS_DOOR_LOCK_LOGGING || 0x4C || 76
|-
|| COMMAND_CLASS_ENERGY_PRODUCTION || 0x90 || 144
|-
|| COMMAND_CLASS_FIRMWARE_UPDATE_MD || 0x7A || 122
|-
|| COMMAND_CLASS_GEOGRAPHIC_LOCATION || 0x8C || 140
|-
|| COMMAND_CLASS_GROUPING_NAME || 0x7B || 123
|-
|| COMMAND_CLASS_HAIL || 0x82 || 130
|-
|| COMMAND_CLASS_INDICATOR || 0x87 || 135
|-
|| COMMAND_CLASS_IP_CONFIGURATION || 0x9A || 154
|-
|| COMMAND_CLASS_LANGUAGE || 0x89 || 137
|-
|| COMMAND_CLASS_LOCK || 0x76 || 118
|-
|| COMMAND_CLASS_MANUFACTURER_PROPRIETARY || 0x91 || 145
|-
|| COMMAND_CLASS_MANUFACTURER_SPECIFIC || 0x72 || 114
|-
|| COMMAND_CLASS_MARK || 0xEF || 239
|-
|| COMMAND_CLASS_METER_PULSE || 0x35 || 53
|-
|| COMMAND_CLASS_METER || 0x32 || 50
|-
|| COMMAND_CLASS_MTP_WINDOW_COVERING || 0x51 || 81
|-
|| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V2 || 0x8E || 142
|-
|| COMMAND_CLASS_MULTI_CHANNEL_V2 || 0x60 || 96
|-
|| COMMAND_CLASS_MULTI_CMD || 0x8F || 143
|-
|| COMMAND_CLASS_MULTI_INSTANCE_ASSOCIATION || 0x8E || 142
|-
|| COMMAND_CLASS_MULTI_INSTANCE || 0x60 || 96
|-
|| COMMAND_CLASS_NO_OPERATION || 0x00 || 0
|-
|| COMMAND_CLASS_NODE_NAMING || 0x77 || 119
|-
|| COMMAND_CLASS_NON_INTEROPERABLE || 0xF0 || 240
|-
|| COMMAND_CLASS_POWERLEVEL || 0x73 || 115
|-
|| COMMAND_CLASS_PROPRIETARY || 0x88 || 136
|-
|| COMMAND_CLASS_PROTECTION || 0x75 || 117
|-
|| COMMAND_CLASS_PROTECTION_V2 || 0x75 || 117
|-
|| COMMAND_CLASS_REMOTE_ASSOCIATION_ACTIVATE || 0x7C || 124
|-
|| COMMAND_CLASS_REMOTE_ASSOCIATION || 0x7D || 125
|-
|| COMMAND_CLASS_SCENE_ACTIVATION || 0x2B || 43
|-
|| COMMAND_CLASS_SCENE_ACTUATOR_CONF || 0x2C || 44
|-
|| COMMAND_CLASS_SCENE_CONTROLLER_CONF || 0x2D || 45
|-
|| COMMAND_CLASS_SCHEDULE_ENTRY_LOCK || 0x4E || 78
|-
|| COMMAND_CLASS_SCREEN_ATTRIBUTES || 0x93 || 147
|-
|| COMMAND_CLASS_SCREEN_ATTRIBUTES_V2 || 0x93 || 147
|-
|| COMMAND_CLASS_SCREEN_MD || 0x92 || 146
|-
|| COMMAND_CLASS_SCREEN_MD_V2 || 0x92 || 146
|-
|| COMMAND_CLASS_SECURITY || 0x98 || 152
|-
|| COMMAND_CLASS_SENSOR_ALARM || 0x9C || 156
|-
|| COMMAND_CLASS_SENSOR_BINARY || 0x30 || 48
|-
|| COMMAND_CLASS_SENSOR_CONFIGURATION || 0x9E || 158
|-
|| COMMAND_CLASS_SENSOR_MULTILEVEL || 0x31 || 49
|-
|| COMMAND_CLASS_SENSOR_MULTILEVEL_V2 || 0x31 || 49
|-
|| COMMAND_CLASS_SILENCE_ALARM || 0x9D || 157
|-
|| COMMAND_CLASS_SIMPLE_AV_CONTROL || 0x94 || 148
|-
|| COMMAND_CLASS_SWITCH_ALL || 0x27 || 39
|-
|| COMMAND_CLASS_SWITCH_BINARY || 0x25 || 37
|-
|| COMMAND_CLASS_SWITCH_MULTILEVEL || 0x26 || 38
|-
|| COMMAND_CLASS_SWITCH_MULTILEVEL_V2 || 0x26 || 38
|-
|| COMMAND_CLASS_SWITCH_TOGGLE_BINARY || 0x28 || 40
|-
|| COMMAND_CLASS_SWITCH_TOGGLE_MULTILEVEL || 0x29 || 41
|-
|| COMMAND_CLASS_THERMOSTAT_FAN_MODE || 0x44 || 68
|-
|| COMMAND_CLASS_THERMOSTAT_FAN_STATE || 0x45 || 69
|-
|| COMMAND_CLASS_THERMOSTAT_HEATING || 0x38 || 56
|-
|| COMMAND_CLASS_THERMOSTAT_MODE || 0x40 || 64
|-
|| COMMAND_CLASS_THERMOSTAT_OPERATING_STATE || 0x42 || 66
|-
|| COMMAND_CLASS_THERMOSTAT_SETBACK || 0x47 || 71
|-
|| COMMAND_CLASS_THERMOSTAT_SETPOINT || 0x43 || 67
|-
|| COMMAND_CLASS_TIME_PARAMETERS || 0x8B || 139
|-
|| COMMAND_CLASS_TIME || 0x8A || 138
|-
|| COMMAND_CLASS_USER_CODE || 0x63 || 99
|-
|| COMMAND_CLASS_VERSION || 0x86 || 134
|-
|| COMMAND_CLASS_WAKE_UP || 0x84 || 132
|-
|| COMMAND_CLASS_WAKE_UP_V2 || 0x84 || 132
|-
|| COMMAND_CLASS_ZIP_ADV_CLIENT || 0x34 || 52
|-
|| COMMAND_CLASS_ZIP_ADV_SERVER || 0x33 || 51
|-
|| COMMAND_CLASS_ZIP_ADV_SERVICES || 0x2F || 47
|-
|| COMMAND_CLASS_ZIP_CLIENT || 0x2E || 46
|-
|| COMMAND_CLASS_ZIP_SERVER || 0x24 || 36
|-
|| COMMAND_CLASS_ZIP_SERVICES || 0x23 || 35
|}

==Numeric==
{| border="1" cellpadding="2"
! Name !! Hex !! Dec
|-
|| COMMAND_CLASS_NO_OPERATION || 0x00 || 0
|-
|| COMMAND_CLASS_BASIC || 0x20 || 32
|-
|| COMMAND_CLASS_CONTROLLER_REPLICATION || 0x21 || 33
|-
|| COMMAND_CLASS_APPLICATION_STATUS || 0x22 || 34
|-
|| COMMAND_CLASS_ZIP_SERVICES || 0x23 || 35
|-
|| COMMAND_CLASS_ZIP_SERVER || 0x24 || 36
|-
|| COMMAND_CLASS_SWITCH_BINARY || 0x25 || 37
|-
|| COMMAND_CLASS_SWITCH_MULTILEVEL || 0x26 || 38
|-
|| COMMAND_CLASS_SWITCH_MULTILEVEL_V2 || 0x26 || 38
|-
|| COMMAND_CLASS_SWITCH_ALL || 0x27 || 39
|-
|| COMMAND_CLASS_SWITCH_TOGGLE_BINARY || 0x28 || 40
|-
|| COMMAND_CLASS_SWITCH_TOGGLE_MULTILEVEL || 0x29 || 41
|-
|| COMMAND_CLASS_CHIMNEY_FAN || 0x2A || 42
|-
|| COMMAND_CLASS_SCENE_ACTIVATION || 0x2B || 43
|-
|| COMMAND_CLASS_SCENE_ACTUATOR_CONF || 0x2C || 44
|-
|| COMMAND_CLASS_SCENE_CONTROLLER_CONF || 0x2D || 45
|-
|| COMMAND_CLASS_ZIP_CLIENT || 0x2E || 46
|-
|| COMMAND_CLASS_ZIP_ADV_SERVICES || 0x2F || 47
|-
|| COMMAND_CLASS_SENSOR_BINARY || 0x30 || 48
|-
|| COMMAND_CLASS_SENSOR_MULTILEVEL || 0x31 || 49
|-
|| COMMAND_CLASS_SENSOR_MULTILEVEL_V2 || 0x31 || 49
|-
|| COMMAND_CLASS_METER || 0x32 || 50
|-
|| COMMAND_CLASS_ZIP_ADV_SERVER || 0x33 || 51
|-
|| COMMAND_CLASS_ZIP_ADV_CLIENT || 0x34 || 52
|-
|| COMMAND_CLASS_METER_PULSE || 0x35 || 53
|-
|| COMMAND_CLASS_THERMOSTAT_HEATING || 0x38 || 56
|-
|| COMMAND_CLASS_THERMOSTAT_MODE || 0x40 || 64
|-
|| COMMAND_CLASS_THERMOSTAT_OPERATING_STATE || 0x42 || 66
|-
|| COMMAND_CLASS_THERMOSTAT_SETPOINT || 0x43 || 67
|-
|| COMMAND_CLASS_THERMOSTAT_FAN_MODE || 0x44 || 68
|-
|| COMMAND_CLASS_THERMOSTAT_FAN_STATE || 0x45 || 69
|-
|| COMMAND_CLASS_CLIMATE_CONTROL_SCHEDULE || 0x46 || 70
|-
|| COMMAND_CLASS_THERMOSTAT_SETBACK || 0x47 || 71
|-
|| COMMAND_CLASS_DOOR_LOCK_LOGGING || 0x4C || 76
|-
|| COMMAND_CLASS_SCHEDULE_ENTRY_LOCK || 0x4E || 78
|-
|| COMMAND_CLASS_BASIC_WINDOW_COVERING || 0x50 || 80
|-
|| COMMAND_CLASS_MTP_WINDOW_COVERING || 0x51 || 81
|-
|| COMMAND_CLASS_MULTI_CHANNEL_V2 || 0x60 || 96
|-
|| COMMAND_CLASS_MULTI_INSTANCE || 0x60 || 96
|-
|| COMMAND_CLASS_DOOR_LOCK || 0x62 || 98
|-
|| COMMAND_CLASS_USER_CODE || 0x63 || 99
|-
|| COMMAND_CLASS_CONFIGURATION || 0x70 || 112
|-
|| COMMAND_CLASS_CONFIGURATION_V2 || 0x70 || 112
|-
|| COMMAND_CLASS_ALARM || 0x71 || 113
|-
|| COMMAND_CLASS_MANUFACTURER_SPECIFIC || 0x72 || 114
|-
|| COMMAND_CLASS_POWERLEVEL || 0x73 || 115
|-
|| COMMAND_CLASS_PROTECTION || 0x75 || 117
|-
|| COMMAND_CLASS_PROTECTION_V2 || 0x75 || 117
|-
|| COMMAND_CLASS_LOCK || 0x76 || 118
|-
|| COMMAND_CLASS_NODE_NAMING || 0x77 || 119
|-
|| COMMAND_CLASS_FIRMWARE_UPDATE_MD || 0x7A || 122
|-
|| COMMAND_CLASS_GROUPING_NAME || 0x7B || 123
|-
|| COMMAND_CLASS_REMOTE_ASSOCIATION_ACTIVATE || 0x7C || 124
|-
|| COMMAND_CLASS_REMOTE_ASSOCIATION || 0x7D || 125
|-
|| COMMAND_CLASS_BATTERY || 0x80 || 128
|-
|| COMMAND_CLASS_CLOCK || 0x81 || 129
|-
|| COMMAND_CLASS_HAIL || 0x82 || 130
|-
|| COMMAND_CLASS_WAKE_UP || 0x84 || 132
|-
|| COMMAND_CLASS_WAKE_UP_V2 || 0x84 || 132
|-
|| COMMAND_CLASS_ASSOCIATION || 0x85 || 133
|-
|| COMMAND_CLASS_ASSOCIATION_V2 || 0x85 || 133
|-
|| COMMAND_CLASS_VERSION || 0x86 || 134
|-
|| COMMAND_CLASS_INDICATOR || 0x87 || 135
|-
|| COMMAND_CLASS_PROPRIETARY || 0x88 || 136
|-
|| COMMAND_CLASS_LANGUAGE || 0x89 || 137
|-
|| COMMAND_CLASS_TIME || 0x8A || 138
|-
|| COMMAND_CLASS_TIME_PARAMETERS || 0x8B || 139
|-
|| COMMAND_CLASS_GEOGRAPHIC_LOCATION || 0x8C || 140
|-
|| COMMAND_CLASS_COMPOSITE || 0x8D || 141
|-
|| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V2 || 0x8E || 142
|-
|| COMMAND_CLASS_MULTI_INSTANCE_ASSOCIATION || 0x8E || 142
|-
|| COMMAND_CLASS_MULTI_CMD || 0x8F || 143
|-
|| COMMAND_CLASS_ENERGY_PRODUCTION || 0x90 || 144
|-
|| COMMAND_CLASS_MANUFACTURER_PROPRIETARY || 0x91 || 145
|-
|| COMMAND_CLASS_SCREEN_MD || 0x92 || 146
|-
|| COMMAND_CLASS_SCREEN_MD_V2 || 0x92 || 146
|-
|| COMMAND_CLASS_SCREEN_ATTRIBUTES || 0x93 || 147
|-
|| COMMAND_CLASS_SCREEN_ATTRIBUTES_V2 || 0x93 || 147
|-
|| COMMAND_CLASS_SIMPLE_AV_CONTROL || 0x94 || 148
|-
|| COMMAND_CLASS_AV_CONTENT_DIRECTORY_MD || 0x95 || 149
|-
|| COMMAND_CLASS_AV_RENDERER_STATUS || 0x96 || 150
|-
|| COMMAND_CLASS_AV_CONTENT_SEARCH_MD || 0x97 || 151
|-
|| COMMAND_CLASS_SECURITY || 0x98 || 152
|-
|| COMMAND_CLASS_AV_TAGGING_MD || 0x99 || 153
|-
|| COMMAND_CLASS_IP_CONFIGURATION || 0x9A || 154
|-
|| COMMAND_CLASS_ASSOCIATION_COMMAND_CONFIGURATION || 0x9B || 155
|-
|| COMMAND_CLASS_SENSOR_ALARM || 0x9C || 156
|-
|| COMMAND_CLASS_SILENCE_ALARM || 0x9D || 157
|-
|| COMMAND_CLASS_SENSOR_CONFIGURATION || 0x9E || 158
|-
|| COMMAND_CLASS_MARK || 0xEF || 239
|-
|| COMMAND_CLASS_NON_INTEROPERABLE || 0xF0 || 240

ZWave Add Device

2010-04-17T21:41:18Z

Javier:

[[Category:User Instructions]]
If the '''SAVE button''' in the upper left is '''red''', click it to save your changes before you add new devices. 
1. To add Z-Wave devices, first remove the Z-Wave dongle from the Home Gateway as shown. 
[[Image:zwave_remove_dongle.jpg]] 
2. Tap the button on the Z-Wave dongle to put it in 'Include' Mode. 
{| border="0" cellpadding="5" cellspacing="1" align="center" width="90%"
| align="center" width="30%" | [[Image:zwave_dongle_off.jpg]] || align="center" width="30%" | [[Image:zwave_dongle_include_mode.gif]] || align="center" width="30%" | [[Image:zwave_dongle_reset_mode.gif]]
|-
| '''OFF - no light''' If the dongle is in include or reset mode tap the button to turn it off. || '''INCLUDE - slow blinking''' When the dongle is off tap the button to put it in include mode so you can add devices. || '''RESET - fast blinking''' When the dongle is off hold the button for 3 seconds until it starts blinking fast then release the button. This will reset devices.
|}

3. Carry the dongle with you as you activate all your Z-Wave devices. For lights, you generally activate them by turning the light on or off. Other Z-Wave devices will have an activate button. When you have successfully added a new Z-Wave device, the blue light on the dongle will stay on solid for 2 seconds. If you cannot add a Z-Wave device, then device was probably already added to another Z-Wave network and needs to be reset first, as explained [[Reset_Node | here]]. 
4. Once you have included all your Z-Wave devices, then reconnect the dongle to the Z-Wave Home Gateway. 
5. When you reconnect the dongle, I will show you any new devices you added in the order you added them. You need to give them a descriptive name, like 'Black table lamp' and pick the room they are in. If you have a lot of Z-Wave devices to add, you can add them a few at a time so that when you go to give them names you do not have too many new devices at once. You can click the 'Add Z-Wave devices' button at any time to add new Z-Wave devices. 
'''Note:''' If you're having trouble adding devices, those devices probably need to be [[Reset_Node | reset]], as here: troubleshooting. Also, if you have unsaved changes, meaning the save button in the upper left is RED, you won't see your new devices until you first save your changes.

ZWave Add Controller

2010-04-17T21:40:46Z

Javier:

[[Category:User Instructions]]
[[Category:Hardware]]
[[Category:UI2]]
With most Z-Wave devices, you add them to Vera's Z-Wave network by clicking the 'Add other Z-Wave devices' on the 'Devices' tab in Vera's menu and following the instructions where you remove Vera's black Z-Wave dongle and carry it to your Z-Wave device. But, battery-operated handheld controllers are special cases. To add them you leave Vera's black dongle connected, bring them to Vera, and chose the 'Add Z-Wave Controller' option instead. In general, when adding these handheld controllers, there are a few more steps, as explained below. Most in-wall controllers that are connected to your house's electricity (i.e. ''not'' battery operated) can be added like any other Z-Wave device and do not need to be treated like the battery operated controllers. (See '''Supported controllers/gateways''' below for a list.)

To assign the scene to a button on a handheld remote or scene controller, create the scene, click 'Add Event' next to the scene, choose the scene controller or handheld remote, choose the event 'A Scene is Activated', and pick the scene or button ID, such as 3 for button 3 on a scene controller. In a traditional Z-Wave network, handheld remotes and scene controllers can only control certain scene-capable light switches and lamp modules. But Vera automatically extends the capabilities of Z-Wave so all the commands in your scene will be activated when you press the button.

For any commands in the scene that go to scene capable devices, namely Z-Wave scene capable light switches and lamp modules, Vera will program the scene controller or remote to talk directly to those scene capable devices. And, if the remote or scene controller has Up/Down or Off buttons, they will be sent directly to the scene capable devices. For any commands you assign to the scene which are not for scene-capable devices, like door locks, thermostats, non-scene capable lamp modules, etc., Vera will monitor the button pushes on your scene controller or handheld remote and automatically take care of the rest of the commands.

The first step is to add the controller into Vera.

== Adding battery operated handheld controllers to Vera ==

[[Image:AddZ-Wave.jpg|thumb|center|512px|Add Z-Wave Controller Screen]]

When you want to add a handheld Z-Wave controller, go to Vera's [[Quick Start|setup page]], choose the "Devices" tab, and click the "Add Z-Wave controller" link or button. You will have 60 seconds to add the controller to an existing Z-Wave network, by bringing the handheld controller within 3 feet (1 meter) of Vera and pressing the buttons on the handheld controller. This process is different for each handheld controller, and is often given different names. A chart of some popular Z-Wave handheld controllers is shown below, along with the steps to add the controller to Vera, and what the process is called. Vera shows the status and progress in blue at the top of the page, starting with: "''Running: Job is waiting: Ready...''", which means Vera is waiting for your handheld controller to start.

If you cannot add the controller to Vera, it's possible the controller is already part of another Z-Wave network. In this case, you must first reset the controller before you can add it to Vera. Instructions for resetting some popular controllers are shown below.

== Adding in-wall scene controllers to Vera ==

As mentioned above, in general you can add these devices like any other Z-Wave device and don't need to use the 'Add Z-Wave Controller' link.

== '''Supported controllers/gateways''' ==

'''These devices are added by bringing the controller near Vera and choosing 'Add Z-Wave Controller'.'''

The 'Add Sequence' is how you tell the controller to add to Vera. The 'Reset Sequence' is how you clear the controller if it's already been added to another Z-Wave network and can't be added to Vera.

{| cellpadding="2" border="1"
|-
! Manufacturer
! Device Type
! Model no.
! Version
! Specs
! Product Review
! Add Sequence
! Reset Sequence
! Notes
|-
| Cooper Wiring Devices
| Handheld Controller
| RFHDCSG
| 
| [http://store.homeseer.com/store/RFHDCSG---Z-Wave-Handheld-Controller-Cooper-Aspire-RF-P477C56.aspx Link]
| [http://store.homeseer.com/store/RFHDCSG---Z-Wave-Handheld-Controller-Cooper-Aspire-RF-P477C56.aspx Link]
| Menu, Settings, Replicate, Receive, From Unknown Controller
| Menu, Settings, Reset
| Works well with Vera. Can transfer devices from Vera to the handheld but doesn't transfer device names. Also very expensive.
|-
| Intermatic
| Handheld Controller
| HA07
| 
| [http://www.intermatic.com/images/instruction_sheets/158ha11645-art.pdf Link]
| 
| 
| 
| Read [[Intermatic Handheld Remotes]]
|-
| Intermatic/Wayne Dalton
| Handheld Controller
| HA09
| 
| [http://www.waynedaltonstore.com/product/741714108824.html Link]
| 
| 
| 
| Read [[Intermatic Handheld Remotes]]
|-
| GE/Jasco Products
| Handheld Controller
| Z-Wave Home Theater Remote-45608
| 
| [http://www.jascoproducts.com/z-wave/Z-Wave-Products.asp Link]
| [http://www.myhomeserver.com/?page_id=236 Link]
| Read the detailed instructions here: [[GE_Home_Theater_45608]]
| RESET: Z-Wave Setup mode, scroll to NETWORK, press OK and displays RESET. Click OK to reset the Z-wave on remote. This will not remove the remote from Vera's network. So if it's already been added to Vera's network follow the instructions here: [[GE_Home_Theater_45608]]
| Works well with Vera, Also controls A/V devices and includes X10 IR codes and Logitech Squeezebox IR codes, blue blacklit buttons, LCD screen allows editing labels of scenes, devices, etc. Can also control Z-Wave and A/V devices using macros so you can "play DVD" and the lights will dim with this command. VERY NICE REMOTE!
|-
| Wayne Dalton
| Gateway
| WDHA-12R
|  ??
| [http://www.waynedaltonstore.com/product/74171410873.html Link]
| [http://www.zwaveworld.com/prodrevs/091406/reviews-pg4.php Link]
| See detailed instructions here: [[Wayne-Dalton_WDHA-12]]
| 
| Shows as Z-Wave controller and enables use of Homelink car remote, so can now turn on/off All Z-wave devices from car. '''This gateway is required for the 3-button remote sold by them.''' Translates commands to Z-Wave Scenes. As of firmware 1.0.602 it's working with Vera, it's seen as a secondary controller.
|-
| Wayne Dalton
| Handheld Controller
| WDHC-20
|  
|  
|  
| Add Zwave Controller in Vera, on remote; HOME, hold SETUP until HOME blinks twice, enter 967, HOME blinks twice if successful. Create the scenes and assign them to the scene controller as described earlier. Click 'Save', and then go to the device and click Configure node right now on Vera, and repeat on remote.
|  
| I added this about a week ago, and typed this from memory, so it may not work 100%, but I know it does have to be programmed on the remote twice. Only On works, couldn't find setting for Off, don't have a dimmer to test Bright/Dim.
|-
| Innovus
| Handheld Controller
| SmoothRemote
|
| [http://www.innovus.eu/fileadmin/user_upload/manual/z-wave/smoothremote-00120001-tech.pdf Link]
|
|
1. Add Z-Wave Controller on Vera 2. Press 3 times shift (Button 9) 3. Configure device on Vera (Associations) 4. To transfer your config settings, repeat step 1 & 2 

|
| Device can be configured using Vera. Has no scene buttons, so you can not trigger scenes with it (V1.0.616) which hopefully will be changed in further versions. Button 8 is always "ALL ON / ALL OFF"
|}

 

 '''These devices are added like normal Z-Wave devices by choosing 'Add other Z-Wave devices' on Vera's menu and bringing Vera's Z-Wave dongle to the device'''

{| cellpadding="2" border="1"
|-
! Manufacturer
! Device Type
! Model no.
! Version
! Specs
! Product Review
! Add Sequence
! Reset Sequence
! Notes
|-
| Cooper
| 5 Scene Controller
| RFWDC
| 
| 
| 
| 
| 
| Read [[Cooper Scene Controller]]
|-
| Leviton
| 4 Scene Controller
| RZCS4
| 
| 
| 
| 
| 
| Read [[Leviton Scene Controller]]
|-
| Leviton
| 1 Scene Controller
| RZCZ1-1LX
| Unknown
| [http://shop.micasaverde.com/index.php?main_page=product_info&cPath=106&products_id=116 Link]
| [http://shop.micasaverde.com/index.php?main_page=product_info&cPath=106&products_id=116 Link]
| [http://www.leviton.com/OA_HTML/ibcGetAttachment.jsp?cItemId=4K.TQNnHt8AaVpmZu8gZrg&label=IBE&appName=IBE&LC12RP=qKakohvv7vJh2mB6bpElERJ8:S&LC12RP_pses=ZG4A2E9F82D5405FB0AA12ACDF90AC2545B909744B9ED50C8FDF1E42E5DDB0DBDAA696B9BE833B1E5A5FAF3CD3DD6FEF48EE84A0FF16567733 Link]
| 
| Read [[Leviton Scene Controller]]
|}

== '''Unsupported / Partially supported controllers/gateways''' ==

Not working as of firmware version wl500gP-1.0.584.trx

{| cellpadding="2" border="1"
|-
! Manufacturer
! Model
! Specs
! Product Review
! Notes
|-
| Sylvania
| SH50201
|  
|  
| '''"all on" and "all off" buttons work but scene buttons are not supported at this time. (3/28/2009)'''
To program this controller put vera in add controller mode and then hit "menu", then press right arrow until you see setup. Press ok. Righ arrow to copy remote control. Press ok. Right arrow to receive information and click ok. Wait for vera to confirm the controller was added.

|-
| ACT HomePro
| ZTH100
|  
|  
| Sylvania is a rebranded ACT Homepro '''"all on" and "all off" buttons work but scene buttons are not supported at this time. (3/28/2009)'''
|-
| Merten
| 1-gang radio push button 5051.., 5061.., 5071..
| [http://www.merten.de/download/DL_doku/V5051_581_01_web.pdf Link]
|  
| Use scene no. 0 for button 0 and scene no. 255 for button 1 (2009-09-30, firmware 1.0.900)
|-
| Merten
| 2-gang radio push button 5052.., 5062.., 5072..
| [http://www.merten.de/download/DL_doku/V5051_581_01_web.pdf Link]
|  
| Only buttons 0 and 1 work; use scene no. 0 for button 0 and scene no. 255 for button 1 (2009-09-30, firmware 1.0.900)
|}

== '''Troubleshooting''' ==

In case your controller it's not working please follow this steps before submitting a trouble report.

1. Open Vera's Dashboard 
2. Go to Advanced and enable Verbose Logging 
3. Go to Location choose your timezone and synchronize your watch 
4. Go to Devices->Zwave->More Zwave Options tab and where it says 
"House/Node", make note of the node ID of your dongle (node x.y where x is the node id). 
5. Go to Devices->Zwave tab, if you have any devices called "ZWave Controller/Scene Controller" besides the built-in one, be sure to rename them so you can tell which is which.
Also be sure 'scenes as events' is not checked for this controller. 
6. Go to Devices->Zwave, expand your controller properties by clicking on the "+" sign near it and then press 'Custom Zwave Settings'. 
Under Associations add group 2 and when you click 'set', add 2 associations: both the device you want to control *and* the 
"ZWave Controller" (ie Vera's dongle), which is probably in the 'unassigned' area. 
Press SAVE and wait until the 'Please wait.... configuring' is done. 
7. Press every button on your controller and note the exact time at which you've press it. 
8. Go to Advanced->Tech Support and submit a trouble report in which you have to indicate 
- the controller make and model and a link to its user manual 
- the controller's NodeID 
- the time when you hit 'configure right now' and when you hit each button

Z-Wave Devices

2010-04-17T21:39:50Z

Javier:

[[Category:Hardware]]
= Z-Wave Devices =
This is a comprehensive list of Z-Wave devices and their associated WiKi Pages. If you have experience with a device and would like to contribute to others working with the same device, please add your experience.
 
== Controllers (Secondary) ==
[[Logitech 890Pro]] 
[[Leviton Scene Controller]]
 
== Door Locks ==
[[Schlage_Lock|Schlage LiNK]]
 

== Thermostats ==
[[Wayne Dalton WDTC-20]] 
[[Danfoss Thermostat]]

Z-Wave

2010-04-17T21:36:58Z

Javier:

[[Category:Glossary]]
'''Z-Wave''' is a [[wireless]] communications standard designed for [[home automation]], specifically to remote control applications in residential and light commercial environments. The technology, which is developed by Danish company Zensys, uses a low-power RF radio embedded or retrofitted into home electronics devices and systems, such as lighting, home access control, entertainment systems and household appliances. The technology has been standardized by the Z-Wave Alliance, an international consortium of manufacturers that oversees interoperability between Z-Wave products and enabled devices.

== Overview ==

Z-Wave is a low-power wireless technology designed specifically for remote control applications. Unlike [[Wi-Fi]] and other [[IEEE 802.11]]-based [[wireless LAN]] systems that are designed primarily for high-bandwidth data flow, the Z-Wave RF system operates in the sub Gigahertz frequency range and is optimized for low-overhead commands such as on-off (as in a light switch or an appliance) and raise-lower (as in a thermostat or volume control), with the ability to include device metadata in the communications. Because Z-Wave operates apart from the 2.4 GHz frequency of 802.11 based wireless systems, it is largely impervious to interference from common household wireless electronics, such as Wi-Fi [[router]]s, cordless telephones and [[Bluetooth]] devices that work in the same frequency range. This freedom from household interference allows for a standardized low-bandwidth control medium that can be reliable alongside common wireless devices. On other hand, 2.4GHz frequency usage allows unlicensed devices usage in most countries, this is convenient to customers and allows wider technology adoption and reduced deployment costs. This could be not true for other frequencies and could easily turn into a strong drawback if licensing is required or frequency is occupied. That's one of reason why competing 2.4GHz technologies became so popular.

As a result of its low power consumption and low cost of manufacture, Z-Wave is easily embedded in consumer electronics products, including battery operated devices such as remote controls, smoke alarms and security sensors. Z-Wave is currently supported by over 200 manufacturers worldwide and appears in a broad range of consumer products in the U.S. and Europe.

The standard itself is not [[Open standard|open]] and is available only to Zensys customers under [[non-disclosure agreement]].<ref>http://www.zwaveworld.com/ask/ask26.php</ref> Some Z-Wave product vendors have embraced the [[open source]] and hobbyist communities.<ref>http://www.zwaveworld.com/ask/ask8.php</ref>

== Product And Brand Interoperability ==

Z-Wave is a broadly accepted technical standard that ensures interoperability between all Z-Wave devices, no matter what the brand. This is a dramatic leap forward from legacy home control and automation systems, which typically used proprietary protocols, and also separates Z-Wave from other current wireless systems, which are largely brand-specific and frequently incompatible with products outside their own brand.

The interoperable Z-Wave ecosystem allows both manufacturers and consumers the security of knowing that Z-Wave certified products will work together in any home environment.

Manufacturing devices with Z-Wave capabilities is simple and cost-effective, thanks to tool sets, proven designs and tested market experience from Sigma Designs and the members of the Z-Wave Alliance. For consumers, adding devices to a Z-Wave mesh network is simple enough for do-it-yourself home improvement, yet powerful enough to control even the largest household systems. And because Z-Wave mesh networks are modular, Z-Wave capabilities can be added to one device at a time, or a single room, or floor, or the entire household at once.

Only the Z-Wave ecosystem offers all these advantages -- simplicity, affordability, scalability and an interoperable ecosystem where incompatibilities are a thing of the past.
http://www.zen-sys.com/modules/Ecosystem/?id=27&chk=773bd1d88e867a46540cfeaa2c4c7a8c

== Applications ==

Z-Wave is a [[mesh networking]] technology where each node or device on the network is capable of sending and receiving control commands through walls or floors and around household obstacles or radio dead spots that might occur in the home. Z-Wave devices can work singly or in groups, and can be programmed into scenes or events that trigger multiple devices, either automatically or via remote control. Some common applications for Z-Wave include:

'''Remote Home Control And Management'''

By adding Z-Wave to home electronics such as lighting, climate and security systems, it is possible to control and monitor these household functions via remote control, based on manual or automated decisions. The control can be applied to a single device or group of devices, in a single room or zone or throughout the entire home. One of the benefits of Z-Wave over powerline communication technologies is the ability to function in older houses lacking a neutral wire. Z-Wave devices can also be monitored and controlled from outside of the home by way of a gateway that combines Z-Wave with broadband Internet access.

'''Energy Conservation'''

Z-Wave is envisioned as a key enabling technology for energy management in the green home. As an example, Z-Wave enabled thermostats are able to raise or lower automatically based on commands from Z-Wave enabled daylight sensors. Grouped scene controls can ensure that unnecessary energy consumption is minimized by various all-off states for systems throughout the home such as lighting, appliances and home entertainment systems.

'''Home Safety And Security Systems'''

Because Z-Wave can transceive commands based on real time conditions, and is able to control devices in intelligent groupings, it allows novel extensions of traditional home security concepts. As an example, the opening of a Z-Wave enabled door lock can de-activate a security system and turn on lights when children arrive home from school, and send a notification to a parent's PC or cell phone via the Internet. Opening a Z-Wave enabled garage door can trigger exterior and interior home lights, while a Z-Wave motion detector can trigger an outdoor security light and a [[webcam]], which would allow the end user to monitor the home while away.

'''Home Entertainment'''

Z-Wave’s ability to command multiple devices as a unified event makes it well suited for home audio and video applications. For example, a simple “Play DVD” command on the remote control could turn on the needed components, set them to the correct inputs and even lower motorized shades and dim the room lights. Z-Wave’s RF technology is also well suited as an evolution of conventional infrared (IR) based remote controls for home electronics, as it is not constrained by IR’s line of sight and distance limitations. In January of 2008, Zensys announced a single-chip solution that pairs Z-Wave with IR control, positioning the technology as an all encompassing solution for home remote controls.

== Setting Up A Z-Wave network ==

Z-Wave mesh networks can begin with a single controllable device and a controller. Additional devices can be added at any time, as can multiple controllers, including traditional hand-held controllers, key-fob controllers, wall-switch controllers and PC applications designed for management and control of a Z-Wave network.

A device must be “included” to the Z-Wave network before it can be controlled via Z-Wave. This process (also known as “pairing” and “adding”) is usually achieved by pressing a sequence of buttons on the controller and the device being added to the network. This sequence only needs to be performed once, after which the device is always recognized by the controller. Devices can be removed from the Z-Wave network by a similar process of button strokes.

This inclusion process is repeated for each device in the system. Because the controller is learning the signal strength between the devices during the inclusion process, the devices themselves should be in their intended final location before they are added to the system.

However, once a device has been introduced into a network, it can become troublesome to remove the unit without actually having the functional unit present. A number of zwave users have complained that a zwave controller can be functionally destroyed by the bulb that it controls blowing and any controlling units then report errors every time a command that would affect that unit is sent (i.e. group commands / scene commands / all-on / all-off etc). The only way to restore the service to a non-error reporting state is to factory reset all controllers and then relearn all zwave devices. <ref>http://board.homeseer.com/showthread.php?t=100212</ref>

== Z-Wave Alliance ==
The [http://www.z-wavealliance.com Z-Wave Alliance] is a consortium of over 160 independent manufacturers who have agreed to build wireless home control products based on the Z-Wave standard. Principal members include [http://www.cooperwiringdevices.com Cooper Wiring Devices], [http://www.danfoss.com Danfoss], [http://www.fakro.com Fakro], [http://www.ingersollrand.com Ingersoll-Rand], [http://www.intel.com Intel], [http://www.intermatic.com Intermatic], [http://www.leviton.com Leviton], [http://www.uei.com/ Universal Electronics], [http://www.wayne-dalton.com Wayne-Dalton], [http://www.z-wave.com Z-Wave]
and [http://www.zen-sys.com Zensys].

Products and applications from the Z-Wave Alliance fall into all major market sectors for residential and light commercial control applications. These include lighting, HVAC and security control, as well as home theaters, automated window treatments, pool and spa controls, garage and access controls and more.

== Radio specifications ==
Bandwidth: 9,600 bit/s or 40 [[Kilobit per second|Kbit/s]], fully interoperable

[[Modulation]]: [[GFSK]]

Range: Approximately 100 feet (or 30 meters) assuming "open air" conditions, with reduced range indoors depending on building materials, etc.

Frequency band: The Z-Wave Radio uses the 900 MHz [[ISM band]]: 908.42MHz (USA); 868.42MHz (Europe); 919.82MHz (Hong Kong); 921.42MHz (Australia/New Zealand).

== Radio specifics ==
In Europe, the 868 MHz band has a 1% duty cycle limitation, meaning that a Z-wave unit can only transmit 1% of the time. This limitation is not present in the US 908 MHz band, but US legislation imposes a 1 mW transmission power limit (as opposed to 25 mW in Europe).
Z-wave units can be in power-save mode and only be active 0.1% of the time, thus reducing power consumption dramatically.

== Topology and routing ==
Z-wave uses an intelligent mesh network topology and has no master node. Devices can communicate to another around household obstacles or radio dead spots that might occur. A message from node A to node C can be successfully delivered even if the two nodes are not within range, providing that a third node B can communicate with nodes A and C. If the preferred route is unavailable, the message originator will attempt other routes until a path is found to the "C" node. Therefore a Z-Wave network can span much further than the radio range of a single unit, however with several of these hops a delay may be introduced between the control command and the desired result. In order for Z-Wave units to be able to route unsolicited messages, they cannot be in sleep mode. Therefore, most battery-operated devices are not designed as repeater units. A Z-wave network can consist of up to 232 devices with the option of bridging networks if more devices are required.

==See also==
*[[Insteon]] - dual-mesh technology from [[SmartLabs]]
*[[ZigBee]] - standards-based protocol based on IEEE 802.15.4.
*[[EnOcean]] - an alternative to Zigbee, mostly for battery-less switches.
*[[ONE-NET]] - An open source alternative

==External links==
*[http://www.z-wavealliance.org Z-Wave Alliance], open consortium of over 160 manufacturers of Z-Wave products
*[http://www.zen-sys.com Zensys], the creator of Z-Wave
*[http://www.z-wave-europe.org Z-wave European Portal]
*[http://www.zwaveproducts.com Z-wave United States Portal]
*[http://www.liveautomatic.com/reviews/insteon-vs-x10-zigbee-and-zwave Z-wave vs Insteon]
*[http://www.pcworld.com/article/123856/first_look_catch_the_home_automation_zwave.html First Look: Catch the Home Automation Z-Wave]
*[http://www.euroxten.com/Products/ZWave.htm Information and Z-Wave products for 230V]

==Z-Wave FAQ==
*[http://www.z-wave.com/modules/xoopsfaq/index.php?cat_id=2], External FAQ1
*[http://www.tomsguide.com/us/the-next-wave-in-home-control-systems,review-859-2.html], ZWave Mesh Network Diagram and Explanation
*[http://en.wikipedia.org/wiki/Mesh_networking], Wikipedia about Mesh Network

WiFiClientMode

2010-04-17T21:35:51Z

Javier:

[[Category:User Instructions]]
Normally Vera you connect the WAN port on Vera to your modem or home network to give Vera an internet connection. This method, using a physical network wired connection, is best. However, if you need to position Vera in a location where there is no hardwired internet connection, but you have an existing wi-fi network, you can tell Vera to go into 'Wi-Fi client mode'. This means that instead of Vera providing wi-fi to other devices, Vera will instead connect to your existing wi-fi network for internet. Vera will also bridge the 4 LAN ports marked LAN1-LAN4 so you can connect devices to those ports, and they will have internet access through Vera over the wi-fi.

'''VERY IMPORTANT:''' Once you put Vera in wi-fi client mode you must immediately disconnect any cable which connects Vera back to your home network. Presumably this means disconnecting the cable in Vera's WAN port if that's what you initially connected to your home network. If there is a network cable connected to Vera's WAN or LAN port while Vera is in wi-fi client mode which connects to your home's access point, it can cause problems on your entire home network and make the access point go down since it will see the same device connected with both LAN and Wi-Fi. So once you put Vera in wi-fi client mode, disconnect the cables.

To put Vera in wi-fi client mode, click Advanced, Net & Wi-fi from Vera's setup menu and choose the option "Through a wi-fi access point. Vera is a bridge." You will need to choose the existing wi-fi network and provide any password for it, if any. After you click 'save', be sure to disconnect the cables as mentioned above.

'''TROUBLESHOOTING:''' If Vera is unable to connect to your wi-fi network and you want to modify Vera's network settings, you have 2 options. First you can double click the red button on the back of Vera. That will reset Vera's network settings to the default, without losing your other changes, like rooms, users, etc. You can then connect Vera with the WAN port like normal and re-configure the network. The second option is to connect your PC to one of Vera's LAN ports and give your PC the static IP address 192.168.81.2. Then you can go to http://192.168.81.1 to modify Vera's network settings without resetting them.

'''BRIDGING:''' Although you cannot connect Vera's WAN or LAN ports back into your access point, you can plug other network devices, like a GC100 or a laptop, into Vera's WAN or LAN ports and Vera will bridge them over wi-fi so they have an internet connection from your main access point.

Weather Plugin

2010-04-17T21:34:56Z

Javier:

[[Category:Plugins]]
[[Category:3rd Party]]
This page has moved to the MIOS Code Respository:

http://code.mios.com/trac/mios_weather/wiki

Wayne-Dalton WDHA-12

2010-04-17T21:33:40Z

Javier:

[[Category:User Instructions]]
[[Category:Hardware]]
== '''How to Configure Vera with Wayne-Dalton WDHA-12 Gateway''' ==

(written Jan-2010 based on Vera firmware 1.0.979) 

 

The Wayne-Dalton WDHA-12 Gateway funnels commands from HomeLink devices and WD keychain remote controls into Vera.  Neither can speak directly to Vera (even though the WD keychain device is a Z-wave device of a sort).

 

The Gateway is configured as a secondary Z-wave controller which means that its only role is to forward commands to Vera.  Once configured as a secondary controller, it no longer speaks directly to devices, rather it only forwards commands to Vera (the primary controller in the configuration below) which in turn sends on the commands to devices.  The Gateway has 3 scene buttons and each can be attached to a different scene in Vera.

 

[[Image:Co1b.jpg]] 

 

'''Step 1 – Set up Vera.'''

Make sure you already have Vera working with at least one scene so that you have one less variable to be concerned with.

 

'''Step 2 – Turn Gateway into secondary controller and link to Vera.'''

Make sure you’re logged in to Vera.

 

On the Gateway, press copy button AND THEN press Scene 1 button (despite what the Gateway instructions say, if you press copy and Scene 1 at the same time the process doesn’t seem to work).  Hold both buttons until all three LEDs light up and then release both.

 

Immediately after above, go to Vera Dashboard, click '''Setup''', then click '''Devices''' and then click '''Z-Wave'''.  Now click “'''Add Z-Wave controller'''”.  Within 60 seconds you will see “device detected. 
Added Node n”

 

For some reason, it appears that you need to perform this step 2 a second time for it to work properly. 
The second time you do this, Vera will recognize that the device has previously been detected and will display the node number again.

 

The Gateway is now configured as a secondary controller.  Note: In the Devices list, Vera will show the “red gear” status (as below) indicating that the device is not properly configured.  This does not seem to matter.

[[Image:Co2a.jpg]] ''''''

 

''''''

''''''

'''Step 3 – Assign Gateway scene buttons to Vera scenes.''' Click '''Scenes'''.  Click '''Add scene'''.  Then click '''Add event''', select your scene controller in the '''Devices''' popup and then select Event type “'''A scene is activated'''”.  Then name the event and type in the digit 1, 2 or 3 in “'''scene number'''” corresponding to the Gateway scene number/button you want to use.  Finally, choose among the commands available for your device.  

 

[[Image:Co3a.jpg]]

 

'''Step 4 – Test.'''

On the Gateway, press the scene number/button that you assigned in Step 3 and confirm that the proper commands are executed.  

 

As a double check, you can look at Vera’s logs.  Click '''Advanced''', then click '''Logs '''and then '''Show Z-Wave jobs'''.

 

'''Optional – Step 5 – Connect to HomeLink.'''

To configure a HomeLink controller so that HomeLink triggers the Gateway which in turn triggers a Vera scene, follow the instructions in the WDHA-12 manual.  One thing to know that the Gateway manual doesn’t tell you:  To “pair” (the HomeLink term is “teach”) the HomeLink controller with the Gateway, the Gateway must be unplugged from the AC. 
However it will only work as a gateway once you plug it back into the AC, so you can’t test it while it’s still unplugged.  It turns out that when the Gateway is unplugged it works as a handheld controller (meaning the buttons work but it doesn't pass thru HomeLink commands) and only works as a Gateway when it’s plugged in.

(if the directions in the WDHA-12 manual for pairing your car don't work- try [http://www.homelink.com homelink.com] and select the programming tab. Choose "program a garage door opener" from wayne dalton and pick your vehicle. It will provide you the proper sequence of things to do in your vehicle while following the WDHA instructions for the button presses on the gateway)

Watts

2010-04-17T21:32:54Z

Javier:

[[Category:Glossary]]
For an overview of energy conservation with Vera see [[Intro Energy Conservation]].

A few Z-Wave devices are able to tell Vera exactly how much energy they are using. Then Vera can log the devices' real, live energy usage. But, most Z-Wave devices, like light switches, do ''not'' measure energy usage. So, on the 'Devices' tab in Vera's 'Setup' page, you can click the '+' button next to each device and tell Vera how much energy each device uses when it's ''On'' by putting its energy usage in the "Watts" field. (Lights default to 100.)

Most devices have the number of watts they use printed on them. For example, a 60W light bulb uses 60 watts. If you put '60' in the "Watts" field, then Vera will assume the device is using 60 watts at full brightness, and a percentage of 60 watts when dimmed to a lower level. Note that you may have a Z-Wave switch that controls several lights. The value you put in the "Watts" field should be the sum of all the lights controlled by a switch. So if a switch controls four 60W overhead lights, in the "Watts" field for that switch, put in 240. 

For thermostats, the "Watts" field consists of 3 numbers separated by commas. The default is 1500,1500,300. The first number is how many watts are used when the thermostat is in 'heat' mode; the second is how many watts are used when the thermostat is in 'cool' mode; and the third number is for the 'fan only' mode.

Users

2010-04-17T21:32:08Z

Javier:

[[Category:User Instructions]]
[[Category:Glossary]]
Providing a list of the users, or family members, who will use the system is optional. The two main reasons for defining users are:

1. You want to be notified of events at home, such as security breaches, sensors being tripped, and so on. Add each user who you want to be notified, and for each user specify how he should be notified: by SMS text message, email, or a voice call. Then when you add an event to a scene, you can specify for each event which users should be notified. Vera will use the contact info you provide here on the Users tab.

2. The other reason to supply users is if you want to require a username and password to login when you are at home, from a web browser on your home network. By default anybody on the home network can control or configure Vera. This isn't necessarily a security issue; Vera by default turns on a firewall if you don't have one, so only people within the home, on your home network can access Vera's web page. If you want to restrict this so a username and password is required, add the users and their passwords and check the box "Require a username and password to access this from within my home network". Note that these usernames and passwords are unrelated to the one you use for FindVera.com. The FindVera.com is for accessing the system remotely. The users and passwords you setup here are for accessing Vera on the local netowrk.

NOTE: If you want to access Vera remotely '''without''' using the [[Find Vera Service|FindVera.com service]] you can do this by setting up a port forward in your home network and specifying "No Firewall" on Vera's 'Net & Wi-Fi' tab. In this case you should always check the "Require a username and password" box to prevent unauthorized access from the internet.

Unassigned devices

2010-04-17T21:30:33Z

Javier:

UI Notes Replacement

2010-04-17T21:29:55Z

Javier:

[[Category:Development]]
This page is outdated since it doesn't use the new Luup architecture.

== Building a replacement UI for Vera ==

Here are some notes on other tags that might be of interest, particularly
when creating a full replacement for Vera's built-in web user interface.

The unassigned devices and automation devices in the '''user_data''' JSON request are just counters. You can probably ignore them. Automation devices is just the count of all the devices that are children of 'zwave' (i.e. the count of your light switches, thermostats, etc.). Unassigned devices is the count of devices that haven't yet been assigned a room (i.e. FK_Room=0). It's your responsibility, in the UI, to be sure that every device which does *NOT* have the tag "Hidden"=1 or the variable '''urn:micasaverde-com:serviceId:HaDevice1/IgnoreRoom''' set to 1. You don't have to, actually; the devices work fine if they're not in a room. It's just a convention in our user paradigm that all devices have to be put in rooms as a way of cataloging. And our web developer said that since JavaScript is slow, rather than him parsing the whole device tree in order to figure out if there are any devices not yet assigned to a room, he asked us to put a counter in the JSON (UnassignedDevices). If it's 0, he doesn't need to display the popup "Tell me what rooms these new devices are in". If it's >0, then he goes ahead and parses the device tree to figure out what devices are already assigned to rooms and displays the popup for those that are not yet in a room.

He also wanted an 'automation devices' counter, again, so he doesn't need to parse the JSON tree unnecessarily. If the counter is 0, then the user has no Z-Wave devices and he doesn't bother rendering the devices tab.

The counters and data in the '''user_data''' are the 'master database' of all the devices in the home and their parameters. The database is updated whenever the list of devices changes, or the user makes changes to the configuration.

The way our UI works is there's a background thread that polls '''user_data''' every 60 seconds or so. Each time it polls '''user_data''', it passes in the DataVersion from the last '''user_data''' it got. This way if there are no changes, rather than returning an identical JSON tree for you to parse all over again, you just get back an empty tree meaning "that DataVersion is still current". When the '''user_data''' changes, the UI needs to update all the devices/trees/etc. because that means something has changed.

Separately, there's another background poll of '''lu_status''' (explained later) to get the realtime info on the devices. This is used to determine which action button to highlight (on/off/etc.), what color code to use for the config cog wheel, what job icons to display, and so on. The way we implemented it is that when the user does something in the UI, we start polling '''zwave_status''' every 2 seconds. This is because things are changing quickly (i.e. the job may be succeeding/failing/etc.). Then after 15 seconds, the polling is reduced to once every 15 seconds. Then after 1 minute, the polling is reduced to 1 minute intervals. This way, when the UI is idle, and the user turns off a light, you won't see the change immediately in the UI because it can be 1 minute before the next '''zwave_status '''poll. But, you're not generating constant network traffic to keep polling the devices over and over again when there's nothing going on.

If you use the binary socket layer, you don't need to poll since you can register to receive events when things change. But for web based UI's and engines like JavaScript, implementing raw socket transfers isn't as easy as simple HTTP GETs, so it just uses polling of the HTTP GETs.

== Saving configuration settings ==

This doesn't apply when creating a UI for control only, like a cell phone.

All the configuration data is stored in the user_data json file. The UI should allow the user to modify this data, set configuration parameters, and so on. Refer to the user_data request on [[Data_Provider_Catalog_Plugin_Requests]] for instructions on how to submit the user's changes to the json files. You can add your own tags to the JSON file to store your own information about devices. Vera will simply ignore json tags that it doesn't recognize.

== Current state of devices ==

The state variables in user_data are not necessarily up to date. They are just what was last saved in the database. To get the up to date values, along with a list of the active jobs for a device, use the UPnP action GetStatus, or call: http://ipaddress:49451/data_request?id=lu_status&output_format=xml

The job status will be one of the following:

job_None=-1, // no icon
job_WaitingToStart=0, // gray icon
job_InProgress=1, // blue icon
job_Error=2, // red icon
job_Aborted=3, // red icon
job_Done=4, // green icon
job_WaitingForCallback=5 // blue icon - Special case used in certain derived classes

== Configuration parameters for devices ==

--- this section is not current ---

Here are configuration settings the UI should prompt the user for and store in the "DeviceData" section.

'''Global'''

'''DEVICEDATA_Manage_Associations_CONST 300:''' Some Z-Wave devices report information about their state (ie fire events), such as motion sensors, remote controls which fire 'button pressed' events, and so on. Generally you tell the device where to send the events by assigning them 'associations'. For example, a motion sensor can be associated with a light switch and it will turn the light on/off automatically, or it can be associated with Vera so Vera gets 'sensor tripped' events. If this is the sort of device that Vera would normally want to set associations for, Vera adds this configuration parameter to the device, with an empty value. If the UI sees this parameter in "DeviceData", display a check box that says something like "Allow Vera to manage associations" and, if checked, store a 1, otherwise a 0.

'''DEVICEDATA_Scenes_As_Events_CONST 298:''' Normally ZWave handheld remote controls work with light switches only, and you can't receive events in Vera to allow them to execute Vera's scenes, which can do anything. If this is a handheld remote control that Vera can "trick" into sending scene commands to Vera, which Vera can in turn translate into events, Vera will add this configuration parameter to the device, with an empty value. If the UI sees this parameter in "DeviceData", display a check box that says something like "Treat Scenes as events" and, if checked, store a 1, otherwise a 0. See: [[ZWave_Add_Controller]] method #2

'''DEVICEDATA_Wakeup_Interval_CONST 299:''' If this is a battery operated device, that is not a FLiRS (see Zensys definition), it is normally 'sleeping' and cannot be communicated with except when it periodically wakes up and broadcasts a wakeup message. If Vera detects this type of device, Vera will add this configuration parameter to the device, with an empty value. If the UI sees this parameter in "DeviceData", prompt the user for the wakeup interval and store the value, as # of seconds, in this parameter.

'''DEVICEDATA_Manufacturer_Desc_CONST 294/DEVICEDATA_Model_Desc_CONST 295:''' This is a read-only setting with the name of the manufacturer/name of the model of the device, if known. Do not overwrite these values.

'''DEVICEDATA_Battery_Level_CONST 292:''' This is a read-only setting with the percentage of battery life left, from 0-100.

'''DEVICEDATA_Battery_Alarm_CONST 293:''' If DEVICEDATA_Battery_Level_CONST 292 is specified, you can display an input box asking the user for the minimum battery life before firing an event (0-99) and store it in this setting. When the battery level drops below this level an event will be fire, which can be attached to a scene to notify a user.

'''DEVICEDATA_Capabilities_CONST 207:''' This may be of interest to more advanced users. It has the device classes followed by a | and the supported command classes. An S at the end means its a 'secure' command class.

'''DEVICEDATA_PortChannel_Number_CONST 12:''' This is read-only, and it's the ZWave Node id.

'''DEVICEDATA_Multi_Channel_End_Point_CONST 296/DEVICEDATA_Multi_Channel_Capabilities_CONST 297/#define DEVICEDATA_Model_CONST 233/DEVICEDATA_Configuration_CONST 59/DEVICEDATA_Update_Name_CONST 41/DEVICEDATA_Only_One_Per_PC_CONST 162/DEVICEDATA_Energy_Log_CONST 286:''' Internal use only. Do not modify or present to the user.

'''DEVICEDATA_LastUpdate_CONST 234:''' This is the unix time stamp indicating when the device was successfully configured. Vera sets this when configuration is done. If this is not empty or 0, Vera will not attempt to configure the device. Whenever the user makes any change to a device, such as changing the settings in the UI, the UI must reset this to 0 when saving so Vera will re-configurate the device.

'''DEVICEDATA_Polling_Settings_CONST 283:''' This is the maximum frequency, in seconds, to poll the device. If set to empty, the default values will be used. 0 means the device will not be pulled. 60, for example, means poll the device at most once per 60 seconds.

'''DEVICEDATA_PK_FloorplanObjectType_CONST 11:''' Vera has no use for this value, but it is traditionally used to indicate which type of icon the user wants to see this device represented with on the floorplan. It is made available to any controllers.

'''DEVICEDATA_InputOrOutput_CONST 18/DEVICEDATA_Default_State_CONST 19/DEVICEDATA_EK_AlertType_CONST 45:''' These are for sensors indicating if they are input/output, normally open/close, and what type of alert they fire. You should not need to modify these because the default values pulled from template_data.json, which are set when the device is created, should be correct.

'''DEVICEDATA_Wattage_CONST 285:''' This is how many watts the device uses at full power. The user should be allowed to edit this so the estimated energy usage is accurate.

'''Device specific notes:'''

'''Light switches/lamp & appliance modules/Sensors:''' There are no special settings. Just follow the general settings above.

'''Thermostats:''' Note the syntax of Wattage here: [[Watts]] Otherwise no special settings.

'''IP Cameras:''' There are special json tags for the IP address and MAC address. Store the username/password for http authentication in: DEVICEDATA_AuthUser_CONST 114/DEVICEDATA_AuthPassword_CONST 115 and the URL to retrieve a JPEG image in DEVICEDATA_Path_CONST 2. Store information about archiving images and association with lights/motion sensors in DEVICEDATA_sPK_Device_Relations_For_Creat_CONST 184,DEVICEDATA_Video_settings_CONST 89.

DEVICEDATA_sPK_Device_Relations_For_Creat_CONST 184 = comma separated list of associated lights, dash, comma separated list of associated sensors.

DEVICEDATA_Video_settings_CONST 89 = comma separated values: # of seconds to archive, # of minutes/seconds to take automatic picture as a # followed by m or s, # of days to keep archives, [1|0] for 'turn on lights when viewing camera', [1|0] for 'turn on lights when the sensors are tripped and armed', [1|0] for 'turn on lights when the sensors are tripped and not armed', [1|0] for 'turn on lights for automatic picture'. So, the following is data is stored for the following configuration:

"FK_DeviceData_184": "13,14,17-20" 
"FK_DeviceData_89": "98,97m,96,1,1,0,0"

Archive a photo whenever the following sensors are tripped: 
(20) 
And after the sensor(s) are tripped archive the video for 98 seconds. 
Which lights should be turned on when viewing this camera: 
(13,14,17) 
For archival purposes, take a picture from the camera every 97 minutes, and keep the pictures 96 days. 
Turn on the lights: 
[x] When I view the camera from the web or phone. 
[x] When the sensor(s) above are tripped and they are armed 
[ ] When the sensors above are tripped and they are *not* armed 
[ ] When you take an automatic picture for the archive 

== Configuration parameters for the Z-Wave device ==

-- this section is not current --

The Z-Wave device, the parent of all Z-Wave nodes, has configuration parameters as well:

'''DEVICEDATA_COM_Port_on_PC_CONST 37:''' The com port/linux device for the Z-Wave dongle.

'''DEVICEDATA_Polling_Settings_CONST 283:''' The default poll settings, comma separated: [0|1] polling enabled, seconds to wait after startup before polling, seconds of idle time on the network before doing a poll, how many seconds to wait between polling nodes, seconds to wait between polling each node. 
So, "FK_DeviceData_283": "1,20,10,10,60" is displayed as: 
[x] Poll nodes 
Wait 20 seconds to start polling. 
Only poll a node if the Z-Wave network is idle at least 10 seconds. 
Poll a node every 10 seconds. 
Unless specified otherwise, poll each node at most once every 60 seconds. 

'''DEVICEDATA_Configuration_CONST 59:''' Firmware version of the dongle. Read only

'''DEVICEDATA_PortChannel_Number_CONST 12:''' House code and node id of the dongle. Read only.

'''DEVICEDATA_Capabilities_CONST 207:''' Read only status if the device is SUC/SIS and primary or not, such as: "Suc SIS:YES PRI:YES"

== Creating scenes in the user_data.json ==

--this section is not current--

A scene is just a list of commands to send to various devices. The Scenes section of user_data contains the pre-defined scenes. For example:
{
"scenes": {
"scene_10": {
"Description": "leave home",
"FK_Room": "5",
"commands_ids": [
1,
2,
3,
4,
5
],
"commands": {
"command_1": {
"Device_To": 5,
"FK_Command": "972",
"params": {
"FK_CommandParameter_2": 24,
"FK_CommandParameter_5": "ARMED"
}
},
"command_2": {
"Device_To": 14,
"FK_Command": "184",
"params": {
"FK_CommandParameter_76": 75
}
},
"command_3": {
"Device_To": 14,
"FK_Command": "193",
"Delay": 60
},
"command_4": {
"Device_To": 21,
"FK_Command": "280",
"params": {
"FK_CommandParameter_8": "C"
}
},
"command_5": {
"Device_To": 21,
"FK_Command": "278",
"params": {
"FK_CommandParameter_5": 20
}
}
}
}
}
}

This defines a scene called "leave home" which is in room. It sets a thermostat (device #21) to 'cool' mode (command #280) and to 20 degrees celsius (command #278). It also arms a motion detector (command #972). As explained below, ZWave motion detectors themselves don't have an arm/disarm command. It's just a flag which the security plugin keeps so that when a sensor is tripped, it knows if it's an "armed sensor tripped event" or a normal "sensor tripped event". So the command goes to device #5 (the security plugin), and the device id of the motion sensor (24) is a parameter to it. It also sets device #14 (a light) to 75% (command #184) and after 60 seconds turns it off (command #193). The list of device #'s is found in user_data Devices section. The command and parameters and how to use them are explained below.

To add this scene, you would submit the following JSON in the POST data for the user_data request. Note that if you do a POST with an existing scene ID, the entire scene is replaced. Changes are not merged. For example, if you want to add a timer to an existing scene, send the entire scene again, with command, and include the timer. We did this because it was difficult in the java script UI to keep track of all the changes and was easier to have the UI just re-send the whole scene each time. See: [[Data_Provider_Catalog_Plugin_Requests]]

{
"scenes": {
"scene_1000010": {
"Description": "leave home",
"FK_Room": "5",
"commands_ids": [
1,
2,
3,
4,
5
],
"commands": {
"command_1": {
"Device_To": 5,
"FK_Command": "972",
"params": {
"FK_CommandParameter_2": 24,
"FK_CommandParameter_5": "ARMED"
}
},
"command_2": {
"Device_To": 14,
"FK_Command": "184",
"params": {
"FK_CommandParameter_76": 75
}
},
"command_3": {
"Device_To": 14,
"FK_Command": "193",
"Delay": 60
},
"command_4": {
"Device_To": 21,
"FK_Command": "280",
"params": {
"FK_CommandParameter_8": "C"
}
},
"command_5": {
"Device_To": 21,
"FK_Command": "278",
"params": {
"FK_CommandParameter_5": 80
}
}
},
"json_action": "add"
}
}
}

Note the tag "json_action": "add" within the scene. This tells the data provider handler to add this scene. Also note that the scene id number is 1000010. The convention is that when adding new devices, scenes, rooms, sections or users you should use an id number > 1,000,000. When the data provider handler sees an id number >1m, it automatically changes it to be the next available id #. This is because all devices, scenes, rooms, sections and users need a unique id #. Since there could be multiple web ui's submitting user changes at once, you don't want the web ui to assign the id # as there may be a collision. If there were, the plugin would merge the data from the 2 post's. By using an id# > 1m, you are ensured there will be no conflicts as the id # will be changed when it's processed. Note that the same user_data you POST to with the new data, will also return the resulting user_data after the POST. So after POST'ing the data, you should parse and use the user_data that is returned, and discard any copy of the user_data you posted, as the id #'s may be different.

POST'ing the commands_ids is purely optional. The Vera back-end doesn't ever use any of the _ids parameters in the json file. They are there purely for the convenience of the web engine if it makes it easier to parse the json files.

== List of commands and parameters to send to devices ==

The complete list of all commands and parameters is in the '''template_data''' JSON file explained [[Data Provider Catalog Plugin|here]]. There are over 1,000 commands in the full LinuxMCE command set. But the common ones used in Vera are:

'''#184 Set Level:''' Sets a device to a certain level. For dimmable lights this sets the level Parameters: #76 Level: a number between 0 and 100

'''#192 On/#193 Off:''' Turns a device on or off. This is also used for unlock/lock door locks Parameters: #76 Level: a number between 0 and 100

'''#278 Set Temperature:''' Sets a thermostat's set point to a given temperature Parameters: #5 Value_To_Assign: The temperature in degrees celsius. The number may be preceded with a - or a + to decrease/increase the temperature relative to its current setting, and may be followed by an H or C to set only heat or cool set point. If H or C is not specified, both heat/cool set points will be set for those thermostats that support dual set points

'''#279 Set Fan:''' Sets the fan of a thermostat to always on or to automatic Parameters: #8 On/Off: Set this value to 1 to put the thermostat in 'on' mode, and 0 to put it in 'auto' mode.

'''#280 Set Heat/Cool:''' Sets the thermostat to heat/cool Parameters: #8 On/Off: Set this value to H for heat mode, C for cool. To turn the thermostat off, send command #193 (off), and to put it in full 'auto' mode, send command #192 (on)

'''#370 Execute Command Group:''' In the user_data, find the device with the template "FK_DeviceTemplate": "27" (General_Info_Plugin) and send it this command to execute a scene. By including this command within a scene, you can have one scene execute or embed another scene. Parameters: #28 PK_CommandGroup: This is the ID of the scene (i.e. the number following scene_). Parameters: #9 Text: If you want to test a scene that you have not yet created, instead of passing the command group parameter above, you put send the raw string of commands in this format: PK_Device,PK_DeviceGroup,PK_Command,Delay,CancelIfOther,IsTemporary,"PK_CommandParameter","Description" where each command is separated with a new line (\n). In Vera's UI, when you execute a scene from the Dashboard (i.e. a scene that's already saved), it passes the scene # in parameter #28. When the user clicks 'Test' next to a scene in the scene editor, and you want to test a scene that you have not yet saved, it is sent as parameter #9. You can grep DCERouter.log for '^08' (lines starting with 08 are commands) after clicking 'Test' to see the syntax.

'''#684 Zoom In/#685 Zoom Out/#200 Move Up/#201 Move Down/#202 Move Left/#203 Move Right:''' Send these commands to a camera for pan/tilt/zoom. Parameters: None

'''#84 Get_Video_Frame:''' Send this command to a camera to retrieve the current image as a JPEG file: Parameters: #19 Data: This is an output parameter that is returned, not an input parameter. It contains the actual image. The parameter type is 'Data', so it contains a block of binary data. Parameters: #20 Format: This is the format of the data. Presently all the cameras return 'JPEG'.

'''#776 Reset (when sent to a Z-Wave node):''' When sent to a Z-Wave node (i.e. a child of the device Z-Wave interface), it resets that node and causes it to be reconfigured. This is what's sent with Vera's "configure node right now" button. A configuration job is immediately added to the queue. Parameters: none

'''#776 Reset (when sent to the Z-Wave interface):''' When sent to the parent Z-Wave device, the interface which is often device #9, it resets the Z-Wave pairing in dongle. This is the only way to restore the black dongle to a clean state. If you do a hardware reset of Vera, without sending this command, the pairings will remain because they're stored in the dongle itself. This command is sent from Vera's Devices, Z-Wave options, 'reset zwave network' button explained here: [[ZWave Options]]. Parameters: #51 Arguments: This parameter can be: SUC or SIS (i.e. send either of those 3 character strings, or leave the parameter blank). The default is to send it with SIS. This is a Z-Wave term, meaning the dongle will report new nodes to slave controllers.

'''#967 Add Node:''' When sent to the parent Z-Wave device, the interface which is often device #9, it causes the dongle to go into 'pairing' mode to add new devices. See [[ZWave Options|Z-Wave Options]] Parameters: #39 Options: This parameter can be the single character H to use high power inclusion. Or it can be the word CANCEL to stop any current add/remove going on. Parameters: #48 Value: If empty or set to 1, any type of node can be added. You can also send one of the following values to restrict what type of node is added: 2=node controller, 3=node slave, 4=node existing, 5=node stop, 6=node stop failed Parameters: #182 Timeout: Number of seconds to timeout. If not specified default is 60 seconds. This is how long to wait for the new node. Parameters: #259 Multiple: If true (i.e. 1) then multiple devices can be added and the dongle will stay in include mode until the timeout is reached. Otherwise, the dongle will only add 1 device and exit add mode.

'''#968 Remove Node:''' When sent to the parent Z-Wave device, the interface which is often device #9, it causes the dongle to go into 'reset' mode to remove devices. See [[ZWave Options|Z-Wave Options]] Parameters: #39 Options: This parameter can be the single character H to use high power inclusion. Parameters: #48 Value: If empty or set to 1, any type of node can be removed. You can also send one of the following values to restrict what type of node is removed: 2=node controller, 3=node slave, 4=node existing, 5=node stop, 6=node stop failed Parameters: #182 Timeout: Number of seconds to timeout. If not specified default is 60 seconds. This is how long to wait for the node to be removed. Parameters: #259 Multiple: If true (i.e. 1) then multiple devices can be removed and the dongle will stay in remove mode until the timeout is reached. Otherwise, the dongle will only remove 1 device and exit remove mode.

'''#972 Set Sensor State:''' In the user_data, find the device with the template "FK_DeviceTemplate": "33" (Security_Plugin) and send it this command to change the arm/unarmed state of a sensor. Z-Wave doesn't have the concept of armed/unarmed sensors. But the security plugin keeps a flag for all sensors so when a sensor is tripped, it can fire the normal 'sensor tripped' only, or also a 'armed sensor is tripped' event. Parameters: #2 PK_Device: This is the device ID of the sensors Parameters: #5 Value To Assign: Can be either: ARMED or UNARMED

'''#974 Set PIN:''' For door locks, this sets a user code or pin. Parameters: #17 PK_Users: This is user code to set Parameters: #99 Password: This is the pin code. Leave it blank to clear the pin code for the given user.

== Timer ==

If you want to have a scene executed automatically at a certain time, add a [[Timer]]. As explained above, you must re-send the whole scene with the timer. Add a JSON block like this to a scene to make it a timer:

"Timer": {
"PK_Timer_1": {
"Description": "T_on30m",
"Type": "1",
"Enabled": "1",
"Criteria": {
"param_1": {
"PK_CriteriaParmList": 11,
"Operator": 1,
"Parm": "",
"Value": "30m"
}
}
}
}

The Timer ID # (1 in this case) can be whatever you want, as well as the description. If Enabled is set to "0", the timer will not execute. Type can be: INTERVAL_EVENT=1 (ie does something every x minutes/seconds), DAY_OF_WEEK=2, DAY_OF_MONTH=3, ABSOLUTE_TIME=4. In all cases, the parameters for the type are specified in the Criteria section. The operator is OPERATOR_EQUALS=1, OPERATOR_NOTEQUALS=2, OPERATOR_GREATERTHAN=3, OPERATOR_LESSTHAN=4, OPERATOR_CONTAINS=5.

For interval timers, leave parm blank, use "PK_CriteriaParmList": 11 (per LinuxMCE this is: #define CRITERIAPARMLIST_Time_of_day_CONST 11), and set the value to a number followed by m or h (minutes/hours). The above is a timer that will go off every 30 minutes.

For Day of Week timers, set CRITERIAPARMLIST_Day_Of_Week_CONST 17 with a comma separated list of days of week (ie 1=Sunday), and CRITERIAPARMLIST_Time_of_day_CONST 11 is the time of day. Multiple times are comma separated. Times can be in 12 hour (with an optional am/pm) or 24 hour. All the following are acceptable ways of saying 3:15pm: 3:15pm 3:15 p.m., 3:15p, 15:15. Generally we use 24 hour time since it's simpler. Here is a day of week timer that goes off every day at 6pm and 8pm:

"Criteria": {
"param_1": {
"PK_CriteriaParmList": 17,
"Operator": 1,
"Parm": "",
"Value": "1,2,3,4,5,6,7"
},
"param_2": {
"PK_CriteriaParmList": 11,
"Operator": 1,
"Parm": "",
"Value": "6:00pm ,20:00"
}
}

For day of month timers, type 3, set CRITERIAPARMLIST_Day_Of_Month_CONST 18 to the days of the month, and CRITERIAPARMLIST_Time_of_day_CONST 11 to the time(s) of day. The following goes off on the 2nd and 7th of each month, at midnight, and 9:30:35pm

"Criteria": {
"param_1": {
"PK_CriteriaParmList": 18,
"Operator": 1,
"Parm": "",
"Value": "2,7"
},
"param_2": {
"PK_CriteriaParmList": 11,
"Operator": 1,
"Parm": "",
"Value": "0:00,21:30:35"
}
}

For absolute timers, set "PK_CriteriaParmList": 19 (CRITERIAPARMLIST_Specific_Date_CONST 19) and set the Value to the actual date/time. The following timer will go off on Feb 15, 2009 at 14:30:30

"PK_Timer_2": {
"Description": "New timer",
"Type": "4",
"Enabled": "1",
"commands_ids": [

],
"commands": {

},
"Criteria": {
"param_1": {
"PK_CriteriaParmList": 19,
"Operator": 1,
"Parm": "",
"Value": "2009-2-15 14:30:30"
}
}
}
},

== Event ==

To make a scene happen automatically, add an [[Event]]. Note that any device in the system can fire any event. The event ID numbers and the parameters for each are defined in'''template_data'''. Therefore, when you add an event, this is a free-form template that can be used for any type of event. '''PK_CriteriaParmList''' is one of the following:

1=CRITERIAPARMLIST_System_CONST 2=CRITERIAPARMLIST_PK_Installation_CONST 3=CRITERIAPARMLIST_PK_Skin_CONST 5=CRITERIAPARMLIST_Month_CONST 8=CRITERIAPARMLIST_PK_Device_CONST 10=CRITERIAPARMLIST_PK_DeviceTemplate_CONST 11=CRITERIAPARMLIST_Time_of_day_CONST 12=CRITERIAPARMLIST_PK_DeviceCategory_CONST 13=CRITERIAPARMLIST_PK_Room_CONST 14=CRITERIAPARMLIST_PK_DeviceGroup_CONST 15=CRITERIAPARMLIST_House_Mode_CONST 16=CRITERIAPARMLIST_Room_Mode_CONST 17=CRITERIAPARMLIST_Day_Of_Week_CONST 18=CRITERIAPARMLIST_Day_Of_Month_CONST 19=CRITERIAPARMLIST_Specific_Date_CONST 20=CRITERIAPARMLIST_PK_RoomType_CONST 22=CRITERIAPARMLIST_PK_EventList_CONST 23=CRITERIAPARMLIST_PK_EventHandler_CONST 24=CRITERIAPARMLIST_PK_EventParameter_CONST 25=CRITERIAPARMLIST_User_Mode_CONST 26=CRITERIAPARMLIST_State_CONST 

The operator is OPERATOR_EQUALS=1, OPERATOR_NOTEQUALS=2, OPERATOR_GREATERTHAN=3, OPERATOR_LESSTHAN=4, OPERATOR_CONTAINS=5.

Only CRITERIAPARMLIST_PK_EventParameter_CONST uses the "Parm" field for the criteria, and in this case, the "Parm" field is the ID of the EventParameter and Value is the value of the event parameter.

The following event will be evaluated TRUE when the device #21 (see 8=CRITERIAPARMLIST_PK_Device_CONST, operator 1 is 1) fires the event #25 (EVENT_Temperature_Changed_CONST 25) and the parameter #30 for the event EVENTPARAMETER_Value_CONST 30 is >32 -- that is, (24=CRITERIAPARMLIST_PK_EventParameter_CONST parameter #30 operator 3=> and value is 32). In other words, when the thermostat says the temperature is > 32 degrees celsius the event will fire and the scene the event is attached to will be executed.

"PK_Event_2": {
"Description": "temp reached",
"FK_CannedEvents": "101",
"PK_Event": "25",
"Enabled": "1",
"Criteria": {
"param_42": {
"Operator": "1",
"Value": "21",
"Parm": "",
"PK_CriteriaParmList": "8"
},
"param_43": {
"Operator": "3",
"Value": "32",
"PK_ParameterType": 2,
"Parm": "30",
"PK_CriteriaParmList": "24"
}
}
}

Rather than presenting the user a free-form form to fill out to specify his event, Vera uses "Canned Events", which are defined in template_data. These are basically event templates that define some common events and what parameters to prompt the user for. In the example above, note the canned event is 101. In template data:

"PK_CannedEvents_101": { "Description":"Temperature is reached", "FK_Event":"25", "bIsAnd":"1", "bIsNot":"0" },

So it's an event handler for event #25, which is:

"PK_Event_25": { "FK_EventCategory":"10", "Description":"Temperature Changed" },

'''bIsAnd''' means all the parameters are AND'd together and must all match. If bIsAnd were 0, it would be an OR. bIsNot means the negative, that is, trip the event if all the criteria are false. You also see:

"PK_CannedEvents_CriteriaParmList_102": { "FK_CannedEvents":"101", "FK_CriteriaParmList":"8", "Description":"Which device?", "Comments":"", "Operator":"1", "Parm":"", "DefaultValue":"1", "ExtraInfo":"", "Required":"0" }, "PK_CannedEvents_CriteriaParmList_103": { "FK_CannedEvents":"101", "FK_CriteriaParmList":"24", "Description":"What temperature?", "Comments":"", "Operator":"1", "Parm":"30", "DefaultValue":"", "ExtraInfo":"", "Required":"0" },

So, when prompting the user for a "Temperature changed" event, we will want to get 2 things: the device, and the temperature. Notice that in Vera's UI, the user is prompted for both, and they become part of the event that is attached to the scene. (See '''template_data''' for the complete list of events.)

You do not necessarily need to parse '''template_data''' in your own UI implementation. The cleanest UI has a custom "hardcoded" panel for the user to fill out. But, '''template_data''' explains all the events Vera's UI prompts for and what values are used.

== Sending Commands ==

The UI should always send commands with a return response (type r or o), as explained in [[Data Provider Catalog Plugin]]. The response will be "OK x" where x is the optional job #. For most Z-Wave activities, a job is created and the ID is returned. Some types of commands don't have job numbers, like controlling a camera. However, you must always check for an OK. It is normal that when you send a command it might not get through because the router is reloading the data, or the Z-Wave device is reset. After you submit new data with a user_data post, the router will reload, which takes a couple seconds, and then the Z-Wave device will also reload and re-configure any devices. So when sending a command, you should do this in a loop that tries to re-send the command every 5 seconds, for up to 30 seconds, until it gets an OK. During this time the UI should display some hourglass or something so the user knows his command hasn't been received or acknowledged yet. If the router and the Z-Wave module are already running, which is normally the case if you haven't just saved, you should get back the OK in less than 1 second. In the case of Z-Wave, the OK just means the command has been queued. It does not mean it's actually been sent on the Z-Wave network. Under normal circumstance the command will be sent right away. But, sometimes, the Z-Wave network may be busy. Or if the device is flaky, or if needs a lot of hops, or if it's a secure device which causes key exchange, the command can take a while to be processed. And, the command may fail. The initial OK just tells you the job was queued, not that it was successful.

To find out if the job was successful and monitor its progress, you can do 3 things:

1) you can use the '''zwave_status''' request (see [[ZWave Status|Z-Wave Status]]). This shows you all the jobs that are currently active or were completed within the last 30 seconds. It is broken down by device, and will contain the job ID.

2) use '''job_status''' passing in the device ID only, such as '''http://127.0.0.1:3451/data_request?id=job_status&parameters=13''' (for the parameter, you can pass either the device id of the Z-Wave device itself, or any of its children). This will return all jobs that are currently active. Jobs that are completed are not on the list. (See [[Data Provider Catalog Plugin Requests]])

3) use the same request, but add [job #]. This will return just the information on the requested job, and you can get information on the job up to 3 minutes after the job has ended. ( See [[Data Provider Catalog Plugin Requests]])

The reason for the 30 second timeout in option #1 is to make the UI presentation easier. The assumption is that if you're going to show all devices and icons representing the active jobs, after a job is completed and 30 seconds has passed, you probably don't want it on the list. But, if you're requesting specific information on a particular job, as in #3, you want the job info to be available as long as possible, and 3 minutes is how long a job is kept in the memory after completion before it's dumped.

== Miscellaneous Test Tips ==

If you want to create some sample devices, run:

'''/usr/bin/MessageSend localhost 0 9 1 776 51 MANYNODES 88 xxx'''

where '''xxx''' is the number of sets of test devices. This will create a set of dummy devices that don't actually exist, but that you can see how they work in the UI. Such as a thermostat, light switch, etc. So if you run it with xxx=1, it will create 1 set. If you want to see how the UI looks with lots of creates, run it with 15. Run it with 0 to return to normal.

UI Notes

2010-04-17T21:29:29Z

Javier:

[[Category:Development]]
Here is some general information about getting information to display in a user interface:

== UPnP messaging system ==

Vera uses UPnP for all the messaging, such as turning lights on and off. So Vera translates Z-Wave, Insteon, infrared codes, etc., into UPnP actions. If you have already implemented a UPnP stack and can send properly formated UPnP SOAP/XML requests, you can control everything using standard UPnP action invocation. If you did not, Vera provides a simple HTTP GET interface as well, which is discussed below.

In a nutshell UPnP works like this: You have UPnP devices, which are things that can be controlled and can report their state, like a light switch. And you have UPnP Control Points, which are the things that let a user control UPnP devices, like a touch-screen web pad. The Control Point does this by a) reading the device and descriptions for the UPnP device to see what it can do, and b) invoking actions on the UPnP device (ie telling it to do something), and c) reading and setting variables for the device which describe the current state and/or configuration settings for the device.

A UPnP device is defined in an XML document called a device description document. To see one, in Vera's setup UI, go to Devices, Luup plugins, Luup Files, and click 'view' file next to D_BinaryLight1.xml. Use Firefox since it has a built-in XML viewer. Notice the tag: <deviceType>urn:schemas-upnp-org:device:BinaryLight:1</deviceType>. This defines the type of device, namely an on/off light switch, which is what you use to know how to represent this device to a user. A device optionally implements one or more services. In this case the services: urn:upnp-org:serviceId:SwitchPower1, urn:micasaverde-com:serviceId:EnergyMetering1 and urn:micasaverde-com:serviceId:HaDevice1.

A service is a collection of actions which a device implement and which you can invoke from a UPnP Control Point, as well as a collection of variables which always have a current value. The variables describe the current state of the device and/or configuration settings. View the file S_SwitchPower1.xml to see a service. For example, the device urn:schemas-upnp-org:device:BinaryLight:1 implements the service urn:upnp-org:serviceId:SwitchPower1, which has the action SetTarget, which is how you turn the light on and off. The action takes a single argument newTargetValue which can be 0 to turn the light off and 1 to turn it on. The service also has the variable Status which is 0 or 1 depending on whether the light is currently on or off.

If you open the device description for a dimmable light D_DimmableLight1.xml you'll see that it implements the same service S_SwitchPower1.xml, since you can still turn it on and off, and it also implements the service urn:upnp-org:serviceId:Dimming1, which has an action to set the dim level (SetLoadLevelTarget).

To test UPnP calls you can use the Intel Device Spy utility available [http://www.intel.com/cd/ids/developer/asmo-na/eng/downloads/upnp/tools/218896.htm?desturl=http://softwarecommunity.intel.com/isn/downloads/zips/IntelToolsForUPnPTechnology_v2.zip here]. It should pick up Vera, show you all the devices, like light switches, thermostats, etc., let you expand the services and see the actions and variables. Click an action, like SetTarget, to specify the arguments and click 'Invoke' to run the action, such as turning on and off the light.

== JSON vs. XML ==

The native UPnP protocol uses XML/SOAP. But there are also several times you will request data from Vera that has nothing to do with the UPnP spec. These will be done with data_request's as explained below, such as user_data, lu_status, etc. Internally Vera uses JSON as the native format, but Vera can convert to XML (details follow). In general when you want to view data in a human readable format, such as the device list, it's easiest to use the Firefox browser, and request Vera convert the data to XML. Firefox has a nice browser to display XML in human readable format. If you want to make the JSON data nicely formatted, you can use the web site jsonlint.com. In a UI application which will request data regularly from Vera we recommend retrieving everything in JSON format, not XML, because Vera's CPU is not that powerful and so continuous requests of data in XML format will cause a lot of CPU time to be devoted to converting JSON into XML.

== Finding Vera on the local network ==

You can find Vera by using the traditional UPnP discovery process, or you can retrieve this URL: '''http://findvera.com/locator.php'''

Each Vera, when it boots up, reports its internal IP address to the central findvera.com server, which tracks this along with the external IP address. '''locator.php''' shows all serial numbers and internal network IP addresses on the same external IP. For example, if '''http://findvera.com/locator.php''' returns the following:

 

7300 192.168.1.114
6907 192.168.1.102
7618 192.168.1.117

Then there are 3 Vera's on the same internal network (i.e. sharing the same external IP as your browser), with serial numbers 7300, 6907 and 7618, with the 3 IP internal (LAN) addresses shown.

You can also pass a FindVera username to '''locator.php''' and it will return the serial number and IP associated with it, such as:

http://findvera.com/locator.php?username=demovera

== The HTTP interface ==

Vera listens on port 3480. Vera responds to UPnP actions the normal way, or by making simple HTTP requests. For example, to turn on a light you can either send the UPnP action "SetTarget" to the device using the normal UPnP mechanism, or you can simply put this URL in your web browser, or with wget, or similar:

http://[ipadress]:3480/data_request?id=lu_action&output_format=xml&DeviceNum=10&serviceId=urn:upnp-org:serviceId:SwitchPower1&action=SetTarget&newTargetValue=1

That URL will return the same results of the action as using the normal UPnP architecture. The '''output_format=xml''' on the URL means the data returned should be in XML format. You can instead use '''output_format=json'''

The service ID's, actions, and arguments are all defined by the UPnP forum. A list of ratified UPnP devices and services is available on the [http://www.upnp.org UPnP Forum]. Mi Casa Verde added its own custom devices and services when there was no existing UPnP standard. A list of these can be found in the [[Luup_UPNP_Files]] header files.

== Getting the system configuration ==

Either use the UPnP service/action: '''urn:micasaverde-com:serviceId:HomeAutomationGateway1/GetUserData'''

or use the built-in request:

'''http://ipaddress:3480/data_request?id=user_data2&output_format=json''' (or xml)

This returns the system configuration file for Vera. It's assumed you understand the way Vera categorizes devices with Rooms, Devices, Scenes, etc. When creating a user interface for controlling Vera only, like on a mobile phone, most of the tags can be ignored, since usually you just need the list of rooms and devices.

== Accessing Vera remotely through the findvera server ==

Native UPnP only works on a local area home network, and cannot be used over the Internet. The FindVera server provides a secure way to remotely access and control your Vera system using the HTTP interface without having to make any substantial changes to the UI. Everything you can do locally with Vera on port 3480, you can do remotely with findvera using the exact same syntax. You only need to ask the user for his username and password and pass them on the URL to the remote access server. For example, the above user_data is the syntax for local access on a home network. To retrieve the same URL over the internet with findvera use:

https://ra1.findvera.com/demovera/myvera123/3480/data_request?id=lu_status&output_format=json

assuming demovera is the username and myvera123 is the password that the user chose on the 'findvera' tab in his Vera setup page. Note that since the request is https, the username and password are encrypted because https encrypts the URL's as well as the contents of the page.

== Building a control-only UI for Vera ==

If you just want to control Vera, and not modify the configuration, such as with a cell phone interface or web pad, the flow might possibly work like this:

1. For the initial setup, you need to ask whether the user wants to (a) access Vera remotely with the FindVera service, and if so, get the user's username/password; or (b) access Vera directly on the home network. You can use locator.php to show the Vera on the home network. You might want to do an auto-detect. For example, you could use locator.php to see if Vera exists locally, and if not, prompt the user for a FindVera username and password. You can use locator.php and pass the username to get the serial number and internal IP, and then automatically switch to direct access if locator.php (without the username) indicates that serial number is found on the local network. This would allow the user to automatically switch between local access with Wi-Fi (which is much faster of course) and remote access with FindVera and the mobile phone network.

2. Once the connection is established, retrieve the list of rooms, scenes, and devices from Vera (see '''user_data''' below). You can cache this data locally so you don't need to retrieve it and parse it over and over.

3. Present the user with the rooms, scenes, devices. In Vera's UI's we show first the rooms and then let the user pick a device or scene in the room. However this data could be presented graphically, such as on a floorplan. Your UI can have Vera store extra tags and data in the configuration database (ie user_data) to store things like coordinates for icons, outlines or rooms and so on.

4. If the user picks a scene you can run the scene with the following URL, passing the scene number as '''x''', and it will return an OK if it went okay:

http://127.0.0.1:3480/data_request?id=lu_action&serviceId=urn:micasaverde-com:serviceId:HomeAutomationGateway1&action=RunScene&SceneNum=x

5. If the user picks a device, you use the category which is contained in the user_data to determine what type of controls to present the user. (See [[Luup UPNP Files]] for a list of the categories.) When the user chooses an action, you can send it like this:

http://ipadress:3480/data_request?id=lu_action&output_format=xml&DeviceNum=10&serviceId=urn:upnp-org:serviceId:SwitchPower1&action=SetTarget&newTargetValue=1

For a list of common actions and device types see: [[Luup CP Mandatory Types]]

Some actions return immediately with an 'OK'. Other jobs may take time to complete and are processed asynchronously. For these asynchronous jobs you will get a job ID back. There are several ways to present this to the user. One possibility is to do what Vera does in the UI, namely to use '''lu_status '''(explained next) to find all active jobs and to put a 'job' icon next to each device to indicate the progress of the job. In this way the user isn't tracking a particular job ''per se'', but just has visual feedback that a device is busy, and if the job icon(s) turn green, that everything went through okay. You could instead track the action individually using the job number that is returned, or use some other method, like making the icon for the device appear animated while it's busy, and turn green or red if the last command succeeded or failed.

6. Periodically poll the system with '''lu_status''' (explained below), like this:

http://ipaddress:3480/data_request?id=lu_status2&output_format=json

That returns the current values of the UPnP variables, which you can use to show the user current status. For example, if the variable Status is 1 for a switch, you can show the 'on' button in a selected state, while 0 shows it in an 'off' state. '''lu_status''' also shows any active jobs for a device.

== user_data and lu_status ==

NOTE: On UI3 builds, user_data2 and user_data are the same, and so is lu_status2 and lu_status. However, on UI2 builds, user_data and lu_status have been deprecated, and you should user_data2 and lu_status2. Therefore, it's best to simply always use user_data2 instead of user_data, and lu_status2 instead of lu_status.

The user_data is the main configuration file that Vera uses to store all the rooms, devices, scenes, timers, events, users, and any other data about the system. You should request the user_data to get whatever data you need to present to the user, at a minimum, for example, you'll need the list of devices, their descriptions, and the categories (light switch, thermostat, etc.). You'll also want the list of scenes to present the user. To fetch the current user_data from Vera use the user_data2 request, like this:

http://[ip address]:3480/data_request?id=user_data2

That returns the data in JSON format, the native format Vera uses. To format it nicely for reading copy and paste it into jsonlint.com. You can also use the Firefox browser and append &output_format=xml to have Vera convert it to XML format so it shows up nicely in Firefox's xml viewer: http://[ip address]:3480/data_request?id=user_data2&output_format=xml

Although XML is easier to view with Firefox's human-readable viewer, for production use, use the JSON format because otherwise Vera has to convert JSON to XML for each request.

Notice there is a tag, like this: DataVersion="315587159" This is a timestamp of the last time the user_data was modified. If you pass the DataVersion which you have on the URL, Vera will return a page with the text NO_CHANGES if that is still the current version of user_data, like:

http://[ip address]:3480/data_request?id=user_data2&DataVersion=315587159

The user_data contains the state for all the devices. For example this indicates that the device id #17, called "Switch" is turned off (ie service SwitchPower1, variable Status is 0)

{
"devices": [
{
"id": 17,
"category": 3,
"room": 1,
"name": "Switch",
"ip": "",
"mac": "",
{
"service": "urn:upnp-org:serviceId:SwitchPower1",
"variable": "Status",
"value": "0"
}
}
]
}

These are the UPnP variables, which describe the state of the device according to the UPnP specs. When the variables change that information needs to be shown to the user, such as changing the icon for the Switch from off to on. If you are interfacing with Vera using the UPnP stack, you can subscribe to the device's events to receive notifications automatically when a device's state changes. However if you're using the web interface you will need to poll. You don't want to request and parse the full user_data each time you just want to see if devices states have changed. So there is also a lu_status request you can use like this:

http://[ip address]:3480/data_request?id=lu_status2

Again add &output_format=xml to see it in XML. This document contains only 3 pieces of information, which constantly change: 1) The state, or UPnP variables, for the device to indicate the device's current state. 2) The status of any active or recent jobs, such as if a light was successfully turned off. 3) The state of the system initialization, such as initialization of the plugin modules.

For #1, the UPnP variables, are simply a subset of the data in user_data. #2, the jobs, and #3, the system initialization, are generated live and are not stored in user_data. Thus lu_status is the appropriate request to poll Vera to get the up to date information about what's going on so it can be presented to the user.

The first tag is DataVersion. This is also essentially a timestamp for the device variables. If you call lu_status without passing a DataVersion on the URL, you will get the current value of all the UPnP variables for a device. Note that most of the UPnP variables do not ever change. For example, with a light switch, only the variable "SwitchPower:Status" changes, as the switch is turned off and on. There are many other variables, like "Capabilities" which are simply configuration data or settings the user modified. If you pass &DataVersion=1 on the URL, you will only see the UPnP variables which have changed since the Luup engine started. So, if you parse the initial UPnP variables when you first call user_data, you can call lu_status with DataVersion=1. Once you call lu_status the first time, store the DataVersion and on subsequent calls pass it on the URL and you will only get the UPnP variables which have changed since that last DataVersion. Regardless, you will also get the current state of jobs and system initialization.

On subsequent calls to lu_status2, you should also pass back in the LoadTime which you received on the prior call. You can also pass in a Timeout value, which means the call will block for up to that many seconds if nothing has changed, and will return immediately when something does. This way you can have infrequent polling, say every 60 seconds by putting a Timeout value of 60, but your UI will be immediately responsive since, when something changes, it returns immediately. You can also add a MinimumDelay, which means that the call will wait for at least that many millseconds. This is advisable so that in the event there are lots of continuous changes, such as a scene turning off many lights, you won't have lu_status2 calls returning non-stop consuming all the resources on both the Vera and the UI.

The jobs for a device will look like this:

"devices": [
{
"id": 1,
"Jobs": [
{
"id": "1",
"name": "job#1 :getnodes (0x00D068F0) P:10 S:4",
"icon": "",
"comments": "",
"status": "4"
}
]
},

The id is the job id number. When you run an action, like turning on a light, if it happens asynchronously, you'll get a job id number. All pending jobs for a device are shown by their id number. The name is just an internal name for the job. Icon is an optional keyword to indicate what sort of icon should be shown to the user. For example, 'getnodes' has no icon, meaning this type of job is generally not of interest to a user. If the icon was 'ON' or 'OFF' that would mean this job is busy turning on or off a light. Comments is notes about the job, if any. This may be shown to a user in a tool tip or similar, but is generally more technical than users would care to know. The status indicates the current state of the job, as shown:

job_None=-1, // no icon
job_WaitingToStart=0, // gray icon
job_InProgress=1, // blue icon
job_Error=2, // red icon
job_Aborted=3, // red icon
job_Done=4, // green icon
job_WaitingForCallback=5 // blue icon - Special case used in certain derived classes

If the status is 0, this means the job is queued but hasn't started. If it's 1 or 5 the job is being executed right now. Generally both 1 and 5 are presented to the user the same way as a 'busy', although technically 1 means Vera is actively talking to the device, and 5 means Vera is waiting for a reply from the device. Status codes 2, 3 and 4 mean the job has finished. 4 means the job went ok, and both 2 and 3 mean it failed. Technically 3 means the job was aborted by another job or an external process, like a user cancelling it, while 2 means it failed due to a problem talking to the device. In both cases this is usually presented the user the same way, as a failure.

The section with the initialization tasks is shown in the startup tag as shown:

"startup": {
"tasks": [
{
"id": 0,
"status": 2,
"type": "ZWave",
"comments": "No Z-Wave"
},

The startup tasks begin whenever the Luup engine is reset, such as after the user makes a configuration change. Ever plugin and module in the Luup engine does a startup sequence. The id is not really important. The status numbers are the same as for jobs, so 2 means the module failed to startup. The 'Type' is what you can use to key off of to know which module is being reported, such as "ZWave", and comments are just notes indicating the current state. For example, "No Z-Wave" means there's no Z-Wave dongle connected.

Once all the plugins have been initialized successfully the startup section will disappear completely from lu_status.

Note that lu_status2 also returns UserData_DataVersion, which is the dataversion from user_data. That way you don't need to poll user_data in parallel. Simply retrieve the user_data one time at startup, then poll lu_status, and, if UserData_DataVersion is different from the previous user_data you retrieved, then download user_data again.

Some notes on building a full replacement, including configuration, are available here [[UI_Notes_Replacement]], however the syntax is not up to date with the Luup architecture.

== Categories and device types ==

The following values are used in user_data to determine the types of devices. In general you can use the category instead of the devicetype since it's an integer and is thus faster to compare:

// Device Types

#define DEVICETYPE_HOME_AUTO_GATEWAY "urn:schemas-micasaverde-com:device:HomeAutomationGateway:1"
#define DEVICETYPE_BINARY_LIGHT "urn:schemas-upnp-org:device:BinaryLight:1"
#define DEVICETYPE_DIMMABLE_LIGHT "urn:schemas-upnp-org:device:DimmableLight:1"
#define DEVICETYPE_THERMOSTAT "urn:schemas-upnp-org:device:HVAC_ZoneThermostat:1"
#define DEVICETYPE_HUMIDITY_SENSOR "urn:schemas-micasaverde-com:device:HumiditySensor:1"
#define DEVICETYPE_MULTI_IO "urn:schemas-micasaverde-com:device:MultiIO:1"
#define DEVICETYPE_DOOR_LOCK "urn:schemas-micasaverde-com:device:DoorLock:1"
#define DEVICETYPE_DOOR_SENSOR "urn:schemas-micasaverde-com:device:DoorSensor:1"
#define DEVICETYPE_ZWAVE_NETWORK "urn:schemas-micasaverde-com:device:ZWaveNetwork:1"
#define DEVICETYPE_INSTEON_NETWORK "urn:schemas-micasaverde-com:device:InsteonNetwork:1"
#define DEVICETYPE_USB_UIRT "urn:schemas-micasaverde-com:device:USBUIRT:1"
#define DEVICETYPE_TEMPERATURE_SENSOR "urn:schemas-micasaverde-com:device:TemperatureSensor:1"
#define DEVICETYPE_POWER_METER "urn:schemas-micasaverde-com:device:PowerMeter:1"
#define DEVICETYPE_MOTION_SENSOR "urn:schemas-micasaverde-com:device:MotionSensor:1"
#define DEVICETYPE_LIGHT_SENSOR "urn:schemas-micasaverde-com:device:LightSensor:1"
#define DEVICETYPE_IR_TRANSMITTER "urn:schemas-micasaverde-com:device:IrTransmitter:1"
#define DEVICETYPE_WINDOW_COVERING "urn:schemas-micasaverde-com:device:WindowCovering:1"
#define DEVICETYPE_GENERIC_IO "urn:schemas-micasaverde-com:device:GenericIO:1"
#define DEVICETYPE_REMOTE_CONTROL "urn:schemas-micasaverde-com:device:RemoteControl:1"
#define DEVICETYPE_COMBO_DEVICE "urn:schemas-micasaverde-com:device:ComboDevice:1"
#define DEVICETYPE_CAMERA "urn:schemas-upnp-org:device:DigitalSecurityCamera:1"
#define DEVICETYPE_SERIALPORT "urn:micasaverde-org:device:SerialPort:1"
#define DEVICETYPE_SCENE_CONTROLLER "urn:schemas-micasaverde-com:device:SceneController:1"
#define DEVICETYPE_ENERGY_CALCULATOR "urn:schemas-micasaverde-com:device:EnergyCalculator:1"

// IR Device Types

#define DEVICETYPE_TV "urn:schemas-micasaverde-com:device:tv:1"
#define DEVICETYPE_CABLE "urn:schemas-micasaverde-com:device:cable:1"
#define DEVICETYPE_SATELLITE "urn:schemas-micasaverde-com:device:satellite:1"
#define DEVICETYPE_VIDEO_ACCESSORY "urn:schemas-micasaverde-com:device:videoaccessory:1"
#define DEVICETYPE_VCR_DVR "urn:schemas-micasaverde-com:device:vcrdvd:1"
#define DEVICETYPE_DVD_BLURAY "urn:schemas-micasaverde-com:device:dvdbluray:1"
#define DEVICETYPE_RECEIVER "urn:schemas-micasaverde-com:device:receiver:1"
#define DEVICETYPE_AMP "urn:schemas-micasaverde-com:device:amp:1"
#define DEVICETYPE_CD "urn:schemas-micasaverde-com:device:cd:1"
#define DEVICETYPE_MISC_HOME_CONTROL "urn:schemas-micasaverde-com:device:mischomecontrol:1"
#define DEVICETYPE_AV_MISC "urn:schemas-micasaverde-com:device:avmisc:1"
#define DEVICETYPE_VIRTUAL_DEVICE "urn:schemas-micasaverde-com:device:VirtualDevice:1"

// Device Categories

#define DEVICE_CATEGORY_INTERFACE 1
#define DEVICE_CATEGORY_DIMMABLE_LIGHT 2
#define DEVICE_CATEGORY_SWITCH 3
#define DEVICE_CATEGORY_SECURITY_SENSOR 4
#define DEVICE_CATEGORY_HVAC 5
#define DEVICE_CATEGORY_CAMERA 6
#define DEVICE_CATEGORY_DOOR_LOCK 7
#define DEVICE_CATEGORY_WINDOW_COV 8
#define DEVICE_CATEGORY_REMOTE_CONTROL 9
#define DEVICE_CATEGORY_IR_TX 10
#define DEVICE_CATEGORY_GENERIC_IO 11
#define DEVICE_CATEGORY_GENERIC_SENSOR 12
#define DEVICE_CATEGORY_SERIAL_PORT 13
#define DEVICE_CATEGORY_SCENE_CONTROLLER 14
#define DEVICE_CATEGORY_AV 15
#define DEVICE_CATEGORY_HUMIDITY 16
#define DEVICE_CATEGORY_TEMPERATURE 17
#define DEVICE_CATEGORY_LIGHT 18
#define DEVICE_CATEGORY_ZWAVE_INT 19
#define DEVICE_CATEGORY_INSTEON_INT 20
#define DEVICE_CATEGORY_POWER_METER 21

== pseudo-code for a UI ==

Here is some pseudo code to show how the polling mechanism should be properly implemented. The parsing code is, of course, unique to your UI, so placeholder function names are shown here, like FetchAndParse. This shows the flow for handling the polling so you know you get the changes reported correctly.

variable int DataVersion_lustatus=0
variable int LoadTime=0
variable int DataVersion_userdata=0

:START
variable boolean FetchUserData=false;
if( DataVersion_userdata==0 ) // If we're on the first loop and haven't retrieved user_data, do it and don't do an lu_status
FetchUserData=true;
else
{
while(true)
{
newdata = FetchAndParse("lu_status2&DataVersion="+DataVersion_lustatus+"&LoadTime="+LoadTime);
if( newdata.IsEmpty()==false && newdata.isError()==false )
break; // If we got data, continue on and process it
else
Sleep 1; // If we didn't get anything, or if lu_status failed, just sleep 1 second and stay in the loop to try again
} // End of while loop

if( newdata.UserData_DataVersion!=DataVersion_userdata )
{
FetchUserData=true;
}
else // Only Parse if userdata is the same, otherwise we're going to reload user_data
{
ParseLuStatus(); // This won't run if user_data has changed
DataVersion_lustatus=newdata.DataVersion
}
} // end of else loop

if( FetchUserData==true )
{
UI.HourglassAndSuspend(true); // Put a 'busy' hourglass in the UI, display a message in the info panel "Updating data" and suspend all UI stuff since this may take a moment
newdata = FetchAndParse("user_data2");
if( newdata.IsEmpty()==false && newdata.isError()==false )
{
ParseUserData();
DataVersion_lustatus=newdata.DataVersion
LoadTime=newdata.LoadTime
DataVersion_userdata=newdata.DataVersion
}
else
UI.DisplayError("Failed to update data"); // Display in the info panel an error message that the user will see for 10 seconds or so

UI.HourglassAndSuspend(false); // Put a 'busy' hourglass in the UI, display a message in the info panel "Updating data" and suspend all UI stuff since this may take a moment
}

Sleep 1; // We know we just parsed user_data or lu_status, so sleep before looping
goto START; // Loop again and start over

Troubleshooting

2010-04-17T21:28:29Z

Javier:

[[Category:User Instructions]]
[[Category:Troubleshooting]]
Read this for troubleshooting before you send a ticket to tech support.

= Verify Logs / Notifications =

In order to ask us to check if the Notifications System is working either on your Vera box or on our server you can check yourself some things first:

*'''Advanced/Logs''' Check here to see if the events appears or not. If not, then check that:

#You have added a user under the '''Users''' tab, added and activated a phone number and an email address;
#The event that you've added has checked a user to send notifications to;
#Enable findvera service from '''findvera.com''' tab;
#You have Internet Connection and no firewall/proxy is blocking the access to findvera.com;

If no log/notification appears under Advanced/Logs then there is a problem with the notification service on your Vera. If some entries with the "track on findvera" will appear it means that Vera is working.

*'''track on findvera''' If you set it as a notifications by email or SMS, the event will be listed like a green link to findvera.com, if not, is listed in gray without hyperlink. Click that link and you will be redirected to findvera.com at that notification. The you can see a full description of that event and if the notification was successful or not.
*'''click "Luup notifications"''' and you see all the notifications that your Vera is trying to send. You'll see there the status of the Notifications ('''Success''' or '''Failure''').
*If the status is '''Failure''' report the problem to us by sending a ticket to tech support.

= Find Vera Service =

*;Issue
*:

:If you've just upgraded the firmware with "Restore to factory defaults"

**;Resolution
**:

:Login directly to your Vera and go to Setup->FindVera.Com and re-enter your username and password then enable the service

*;Issue
*:

:If you've just upgraded the firmware with "Keep settings"

**;Resolution
**:

:It is possible that your Vera unit is still upgrading please wait a few minutes then try again

*;Issue
*:

:If the internet connection at Vera's side dropped or Vera doesn't have internet access anymore, you won't be able to access it through findvera.com 

**;Resolution
**:

:Check Vera's power led to be solid. If it's blinking go to Setup->Advanced->Net&Wi-Fi and configure your [[Networking Setup:Troubleshooting|Network settings]] then click 'Troubleshoot Network' and observe if it can reach Google and our servers.

= Identifying Device number(#) and NodeID =

=== Device number (Device #x) ===

Under the Devices tab, you select any of the devices and press the '''+''' button and you'll see a field like: 'Device #xx'. That's the device number.

=== NodeID ===

The NodeID cand be found under a Z-Wave device. Under the Devices tab, you select a Z-Wave devices and press the '''+''' button and you'll see a field like: 'NodeID xx '

[[Image:Identify dev node.JPG|thumb|center|500px|Identify Device number and NodeID]]

= Problems adding new Controller =

   - go to Advanced->Logs and enable Verbose logging     - Reset your controller, then go to Devices->Zwave and press Remove dead node if you still see it.     - confirm that you can't see anymore your controller in Devices->Zwave and that the controller buttons don't do anything     - go to Devices->Zwave->press Add Zwave Controller then " '''Include the Remote to another Controller and/or Replicating Network Information from another Controller" ''' on your remote     - confirm that your controller is added and assign it into a room.     - confirm that the All OFF/All ON function on your controller isn't activated     - create a Scene on Vera and confirm that it's working ( a simple scene: turn on an on/off appliance module)     - create an event on that scene for the  Scene Controller with Event Type "a scene is activated" and put 0 in the scene number. '''Note: - set a descriptive unique name for the scene and for the event'''     - save the scene     - since the Controller is battery operated you'll have to re-add it to the network in order to it's configuration to update, so     go to Devices->Zwave->Add Zwave Controller and on your Controller follow again the " '''Include the Remote to another Controller and/or Replicating Network Information from another Controller" ''' procedure     - synchronize your clock with Vera's clock (you can see the clock in Location tab)     - press the ON button on your controller and '''note the time     - ''' if it's not working edit the scene and put 1 in the scene number, save then re-add your controller and test it by noting down the time when you've pressed the on button. At the end submit a trouble report from Advanced->Tech Support and mention     - the name of the scene and event     - time when you've pressed the on button with 0 in scene number     - time when you've pressed the on button with 1 in scene number After we receive your ticket we'll try to see what we have to in order to successfully program your remote. For the other remote you'll have to follow the same procedure and send us also the complete make and model along with it's user manual. '''Clearing Group Association''' Devices which are Associated to the Group Buttons can be cleared by: 1. Put the Configuration Switch in “Configuration Mode”. 2. Press-and-hold “Up” Operation button for 2 seconds to enter Configuration Mode. LED Indicator will illuminate Green. 3. Short-press the “Up” Operation Button three times within 1.5sec to put the device into Clear Group Associations Mode. LED Indicator on the Remote will illuminate Green when Group Associations are cleared successfully and illuminate Red if the operation is unsuccessful. '''Enabling All On / Off Functionality''' The Remote control can act as an All On / All Off Controller, which allows all the devices in the Network to be turned On or Off at the same time. 1. Put the Configuration Switch in “Configuration Mode”. 2. Press-and-hold “Up” Operation button for 2 seconds to enter Configuration Mode. LED Indicator will illuminate Green. 3. Short-press the “Up” Operation Button five times within 2.5sec to configure the device to become an All On/Off Controller. Note 1: All Associations which have previously been made to the Operation Buttons will be deleted. Note 2: If one or more Associations are made as described in “Associating Devices to Remote Operation Bottons” the All On/Off functionality will automatically be disabled. '''Resetting the Controller''' 1. Put the Configuration Switch in “Configuration Mode”. 2. Press-and-hold “Up” Operation button for 2 seconds to enter Configuration Mode. LED Indicator will illuminate Green. 3. Press-and-hold “Up” Operation button for 10 seconds - this will initiate a reset of the Controller. LED Indicator will alternate Red, Yellow and Green while remote is being reset. 4. LED Indicator on the Remote will illuminate Green when Reset is successfully completed and illuminate Red if the operation is unsuccessful. '''Include the Remote to another Controller and/or Replicating Network Information from another Controller''' When Including the remote to another Controller the remote automatically becomes a Secondary Controller. To Replicate the Network Information to the Remote Control (if Secondary) from another Controller (Primary) following steps should be followed: 1. Put the Switch in “Configuration Mode”. 2. Press-and-hold “Up” Operation button for 2 seconds to enter Configuration Mode. LED Indicator will illuminate Green. 3. Short-press the “Up” Operation Button four time within 2sec to put the device into Replication Transmit Mode. 4. Press the Controller Replication Transmit initiator on the Primary Controller. 5. Replication will start and Remote Control LED Indicator will blink Green when transferring Network Information. 6. LED Indicator on the Remote will illuminate Green for 3 sec when Replication is completed successfully and illuminate Red if the operation is unsuccessful.

= Networking Setup =

In general most people who have Vera don't need to know anything about networking and don't need to change any network settings. If you are experiencing difficulties or want to know how Vera's networking works, here is some information.

=== Getting Vera an internet connection ===

Within 2 minutes after you plug Vera in, Vera will try to obtain an IP address (i.e. Internet Connection) automatically through the WAN port on the back of Vera.  If Vera succeeds in getting an IP address and connects to the network, the power light on the front of Vera comes on solid.  If Vera cannot get an internet connection, the power light will blink.  Note that you can still use Vera without an internet connection, but certain features, like remote access over cell phones and video archiving, will not work without an internet connection.

If you connected Vera directly to your DSL or cable modem, but Vera's power light is blinking, first try unplugging the DSL or cable modem for 2 minutes, then plug it in and wait a few minutes.   If Vera's power light is still blinking that probably means you have a special network setup, such as PPPoE or a static IP address.  These types of connections require special information from your internet service provider.   To specify these settings, follow the "Getting to Vera's Setup Page Without an Internet Connection" and then "Manually Configure Vera's Network" instructions below.  Then fill in the Setup Page's top section "How Can I Connect to the Internet" with the settings furnished by your internet service provider.   Also, under Firewall choose "Firewall Active", and under DHCP choose "DHCP Server ON".  Then click 'Save & Apply'.   (See the IMPORTANT NOTE below.)

=== Getting to Vera's Setup Page if Vera already has an internet connection ===

Once Vera has an internet connection (the power light is on solid), you can open any web browser from anywhere on the home network and go to [http://findvera.com http://findvera.com] and click the green 'Setup' button.  The computer with your web browser can be connected directly to one of Vera's LAN ports, or it can connect to Vera wirelessly, or be anywhere else on the home network that Vera is connected to through the WAN port.

=== Getting to Vera's Setup Page without an internet connection ===

If Vera does not have an internet connection, then you must connect the computer with your web browser to one of Vera's four LAN ports, or connect to Vera wirelessly using the network name (SSID) and password shown on the bottom of Vera and on on the front of the Quick Start Guide.  Then open your web browser and go to:  '''http://local.findvera.com''' If that fails, try:   '''http://192.168.81.1''' Vera's setup page should appear.

=== Manually configuring your network ===

Normally Vera will automatically configure the network for you.   If you want to configure the network manually, click the Advanced button in Vera's setup page and choose the 'Net & Wi-Fi' option.  Set the network the way you want and click 'Save & Apply' at the bottom of the page.  Note that once you click 'Save & Apply,' Vera's automatic network configuration will be bypassed and Vera will use the network settings you provide.   (See the IMPORTANT NOTE below if you want to do this.)

==== On PC (Windows) ====

#Click Start
#Click Control Panel
#Double Click Network Connections
#Under LAN or High-Speed Internet Doubleclick the enabled device (the Local Area Connection or the Wireless Network Connestion)
#On the Status Box Window that opens Click the Properties button
#Drag the Properties window beside the Status window
#Click the SUpport tab on the Status window
#Click the Details button--this window provides the information you will need to manually configure your IP
#In the Properties window that you have open beside the Status windows scroll down through the devices until you get to Internet Protocol TCP/IP
#Select Internet Protocol TCP/IP and click the properties button
#In the Properties window that opens select "Use the following IP address"
#If you have a number of machines begin by setting the IP address to 192.168.1.100 then go to 192.168.1.101 and so forth giving each machine a unique IP on the network
#The subnet mask has a default value of 255.255.255.0 in most cases
#Copy the Default Gateway from the Network Connection Details window information (192.168.1.1 is common)
#Copy the DNS Server info from the Details window--there will likely be two adresses to copy.
#Close all the windows and test your internet connection

 

==== On MAC ====

#Select the network configuration that has the green dot next to it, from the "TCP/IP" screen you opened before. This is your active connection and will probably be the "Built-In-Ethernet" option in the drop-down box. Then click the "Configure" button at the bottom of the dialog box.
#Click the "Configure IPV4" drop down menu next and choose "Manually."
#Type in your new IP address in the box under the TCP/IP menu. Simply delete the number that is in there and enter your new one.
#Click "Save." Your address has now been changed.

=== Common problem: Vera isn't sharing the network connection ===

When Vera gets an internet connection through the WAN port, Vera decides automatically if you already have a home network setup with another device (a router) that is sharing your internet connection.  If Vera decides that you connected Vera directly to your DSL or cable modem, and don't already have a home network setup, then Vera will automatically create a home network for you and share the internet connection that Vera got from your DSL or cable modem.  Some DSL or cable modems "trick" Vera into thinking you already have a home network, when in fact you do not.  This happens when all of the following are true: 1) You connected Vera's WAN to your DSL or cable modem and do not already have a router. 2) Vera got an internet connection from your DSL or cable modem and you can tell this because Vera's power light is on solid. 3) Other computers in the home that you connect to Vera's 4 LAN ports, or connect to Vera wirelessly, are not able to get an internet connection.

If those 3 things are all true, then that probably means Vera is not sharing your internet connection because Vera thinks you already have a home network.   This happens when your DSL or modem "tricks" Vera by acting like a router.   This problem is easy to solve.  First, unplug the cable going into Vera's WAN port.  Wait a few seconds for Vera's power light to start blinking.  Now try again to connect your computer to Vera using the 4 LAN ports or with the wireless connection.   Open your web browser and go to: http://local.findvera.com, or to http://192.168.81.1. Click the 'Advanced' button, choose 'Net & Wi-Fi'.

Set the following settings:

How can I connect to the Internet? '''DHCP'''

Firewall: '''Firewall active'''

DHCP server: '''On'''

Then click 'Save & Apply'.  Reconnect the cable to the WAN port.  Wait 30 seconds.  Then Vera should share the internet connection with any other PC's and devices connected to Vera's 4 LAN ports, or that connect to Vera wirelessly.  (See the IMPORTANT NOTE below.)

=== I already have a home router (i.e. DHCP server) and don't want Vera to replace my router ===

Normally this should be handled automatically.   You simply connect Vera's WAN port to your existing home network and Vera should automatically detect that you already have a router, and then Vera will automatically turn off Vera's built-in router functions, like firewall and DHCP server, thus becoming a normal network device.  You can still find Vera on your home network using the [http://findvera.com findvera.com] web site, and you can connect any network devices to Vera's 4 LAN ports or to Vera's Wi-Fi network, and they will work just fine on your home network, getting an IP address from your existing home router. When you go to the 'Net & Wi-Fi' tab on Vera, you will see the DHCP server is set to "OFF", and the firewall is set to "No Firewall".  (See the IMPORTANT NOTE below.)

=== IMPORTANT NOTE: Vera's automatic network configuration may be disabled ===

To make Vera as easy as possible for the novice user, Vera will attempt to configure the network automatically for you.  This means if you have an existing home router, Vera will work well with it.  And if you do not, Vera will assume the role of your primary home router automatically.  But, once you go to Vera's 'Net & Wi-Fi' tab and make any changes, then Vera assumes you know what you're doing, and Vera will not again attempt to automatically configure the network unless you [[Factory Reset|reset Vera to the factory default]].  This means, for example, that if you manually turn off Vera's firewall, and you then put Vera directly on the internet, other people may be able to access your Vera.  For most users, we recommend you just leave the network settings alone and let Vera handle everything automatically.

=== Technical Explanation: How Vera's auto networking works ===

This paragraph is for advanced users who understand networking concepts.  Vera tries to obtain an IP address on the WAN port using DHCP.  If Vera gets an internal IP address from another router, namely an address that starts with 192.168., or 172., or 10., then Vera assumes you already have a network router sharing your network connection and a DHCP server giving out IP addresses.   So Vera goes into 'switch' mode.  This means the WAN port and the 4 LAN ports are bridged, like a normal switch, and Vera's firewall and DHCP server are disabled.   If Vera gets a routable IP address (not a 192.168., 172., or 10. address), Vera assumes she is connected directly to your Cable/DSL modem and that Vera should share the network connection for you.  In this case, Vera turns on her DHCP server and gives out IP addresses in the 192.168.81.xx range on the four LAN ports.  Vera's firewall is enabled and Vera only accepts connections from the 4 lan ports.

=== Advanced Network Settings ===

[[Networking Setup:Advanced Network Setup]]

=== Troubleshoot Network Settings ===

[[Networking Setup:Troubleshooting]]

= Schlage Lock Troubleshooting =

[[Schlage_Lock_Troubleshooting]]

Set Up Timers

2010-04-17T21:27:22Z

Javier:

[[Category:User Instructions]]
[[Category:Glossary]]
A timer is how you tell Vera to do certain things by running scenes either at fixed intervals, like every 15 minutes, or at certain times, like Wednesdays and Fridays at 8:30, or on December 20 at 11:00. For more on scenes, see [[Scenes]].

To add a timer, click the [[Scenes|'Scenes']] tab, add a new scene, and click 'Add Timer' to define when the scene should be triggered.

Next choose the type of timer. Your choices are:

'''Interval based''': For example, do something every x minutes, or every other hour. The minimum interval is 1 minute. There is no maximum. Specify the interval in hours or minutes.

'''Day of week based''': For example, do something at 7:00 and 9:00 on Monday, Wednesday and Friday. You can check off what day(s) of the week you want this occur, and tell Vera what time(s) of day. You can specify multiple times, separated by commas. For example, check off Monday and Wednesday and put in 7:00, 9:00, 21:00 to do this at those three times on Monday and Wednesday. You can specify the time in either 12-hour or 24-hour format, so you could also put in: 7:00am, 9:00am, 9:00pm.

'''Day of month based''': For example, do something at 8:00 on the 1st and 15th of each month. As explained above in "Day of week based", you can enter multiple times, in 12- or 24-hour format.

'''Absolute''': For example, do something on 5 Mar 2005 at 11:15. Use this timer to do something one time, at a certain time.

After you specify the options for the timer, you can tell Vera what you want her to do at those times, in exactly the same way you do when creating a [[Scenes|scene]]. As explained in the [[Scenes|scene]] instructions, you can tell Vera to do something with a device and then after a period of time, do something else, such as: turn on the garage light and 30 seconds later turn it off again.

Tech Support Back Door

2010-04-17T21:13:48Z

Javier:

[[Category:User Instructions]]
To have your Vera open a back door for our tech support staff to look at your system, choose Advanced, Tech Support, and 'Enable it'. Then give tech support the code on the screen, which is in the format: xxxx-yyyyyy. Click 'Disable it' to close the back door.

If you cannot get the web site to load, you can telnet or ssh (use Putty for Windows) to Vera and type: '''''  /usr/bin/RA-handler.sh --enable''''' 

Then, type: '''''  cat /etc/cmh/PK_AccessPoint'' ''' for your serial number and '' '''''  cat /etc/cmh/ra_password''' for the backdoor password.

Tech Info

2010-04-17T21:12:53Z

Javier:

[[Category:Obsolete]]
Vera is built on OpenWRT, adds the DCE messaging protocol libraries from LinuxMCE, and the rest is our own in-house software as well as commercially licensed 3rd party. The architecture is extensible, and we document the protocols for controlling Vera from another application, and provide access to a build server for developers who want to write their own modules to run inside Vera. Vera has a consumer-friendly front-end and self-configuring network setup, a socket-based messaging architecture for devices similar to and binary-compatible with LinuxMCE, an easy-to-use HTTP server for interrogating and controlling devices, and a secure online remote access / remote control gateway.

We've also put a Vera system online, at testvera.micasaverde.com, complete with a camera, Z-Wave accessories, and the secure remote access activated, so developers can play around with it and test having their own applications talk to it. (Learn more [[Testvera|here]].) Also see upcoming features in the [[Roadmap]].

== For OpenWRT users ==

To make Vera appealing to a mainstream audience we added a self-configuring networking module that automatically determines whether you have another DHCP server on the network and if Vera can get an internal (192.168., 10., 172.) or routable IP address, then automatically configures the firewall, DHCP server, and other network settings. To make Wi-Fi setup easy for a novice, each Vera comes pre-configured with Wi-Fi enabled with WPA2 encryption and a unique, strong password printed on the bottom of each unit, along with a unique SSID. We pre-configure the wireless accessories on our web shop to each particular customer's SSID and password. However, under the 'Net & Wi-Fi' tab, when you click 'Advanced Configuration' it bypasses our simplified network setup and takes you directly into to the OpenWRT (Kamikaze) site. So you don't lose any of the advanced functionality in OpenWRT; we just add an extra layer on top to make it more consumer friendly.

== For LinuxMCE users ==

Vera does not use any of LinuxMCE's code except for the open source DCE/util libraries. However, Vera's architecture will look quite familiar since the messaging layer is the same DCE protocol. Vera includes a message router that is compatible with LinuxMCE's DCERouter, although Vera's was re-written to use JSON files for storing device information, rather than a MySQL database, since Vera can't run MySQL. The device numbers, categories, etc., are the same, and your existing LinuxMCE devices can connect to Vera's message router and send/receive commands the same. If you have developed your own DCE Devices, they should work fine with Vera, although if you made devices that use the MySQL database, that database will need to be hosted on a PC, not on Vera.

A bridge between Vera and LinuxMCE could make LinuxMCE more usable too. Vera has plenty of power to handle message routing. So, a Vera unit could be left on all the time to handle home control, security and remote access, using only 6 watts of electricity (or zero net additional watts if you wanted an access point anyway), and then the LinuxMCE core/media directors would only be running when you need media. Vera is also designed to be far simpler, with a higher WAF, than LinuxMCE. We're also developing a lightweight media plugin + media catalog + rip/identify software suite that runs inside a low-cost NAS device, and a front-end that runs on the Sigma 8634-based DMA's (same chip that's in Blu-Ray drives). They both use Vera as the Core. When this is done, you'll have a comparable media solution to LinuxMCE, but at a fraction of the cost with a tiny amount of energy consumption; the NAS/DMA units go into standby mode when you're not watching media, so you've only got Vera running at 6 watts most of the time. A normal PC running LinuxMCE uses up to $92/month in electricity ''vs'' $1.50 for Vera. (See: [[Energy Savings]]) This new media catalog will also compliment MythTV users well, since, like a LinuxMCE Core, our NAS device stores all your MythTV recordings, and you can watch them not only on a MythTV PC, but also on the DMA's. The NAS unit also has simplified ripping; attach a USB CD/DVD drive, and anytime you insert a disc it's automatically id'd, ripped and ejected, so it's really easy for everyone in the family to use.

We also built our own data provider plugin for retrieving data. It is a lot more flexible than the DataGrid system in LinuxMCE, and returns data in XML and JSON format. We also built a request server that listens on port 3451 to accept messages and data requests as simple html requests. This makes it a lot easier to integrate Vera with other devices. [[Data Provider Catalog Plugin|more on the Data Provider Catalog Plugin]] We also have secure, remote access with SSL encryption.

We are also working on Vera's own version of "Generic Serial Device". But instead of Ruby we're developing a Lua version, because Lua is more lightweight and can run on Vera, and for GSD devices, people didn't really need the full power that Ruby offered anyway.

== For Mr. House users ==

We have not tried integrating Vera with Mr. House. However, there have been attempts at integrating Mr. House with LinuxMCE, and as mentioned above, any LinuxMCE->Mr. House bridge devices should work fine with Vera. There are a few benefits that Mr. House users would find to having a Vera->Mr. House bridge: First, leaving a PC running 24/7 uses a lot of electricity. (See: [[Energy Savings]]); having a way for Vera to provide the basic home control while the PC is off would save quite a bit. Second, Vera should do well with the WAF. There's an iPhone and Java (Blackberry/Nokia) front-end and it's easy to configure. So a bridge would allow a simple, stable front end for the non-technical user, while the geeky Mr. House stuff runs elsewhere. Also, there's automatic secure, remote access with SSL encryption.

== Build environment ==

One of the issues with building custom modules for an OpenWRT platform is that it's not as easy to compile C/C++ code as for an x86 because you need to set up the correct kernel header, tool chain, etc. To make it easier for developers, we've established a dedicated build server with virtual machines. So, when a developer wants to do some custom stuff, we'll provide a VM on our build server which is pre-configured with everything needed. Just run one script to build a new firmware image with your custom changes. And, we've forked our svn so the developers and FOSS community have their own branch where they can add the "geeky" stuff, and we periodically merge in the fixes/changes from our consumer branch. The source code is here: [[Source Code]]

Supported Hardware

2010-04-17T21:12:20Z

Javier:

[[Category:User Instructions]]
[[Category:Hardware]]
This is a page for Supported Z-Wave devices.

Alternative hardware pages exist for

*[[ZWave Add Controller|Z-Wave Handheld Remote Controls, Gateways and Scene Controllers]]
*[[IP Cameras|IP Enabled Cameras]]
*[[Insteon Supported Hardware|Insteon/X10 devices]]
*USB, or USB-Serial, [[Serial Supported Hardware|Interface devices]]

In general, any device with the Z-Wave logo should work with Vera. A list of tested Z-Wave devices is below, with specific notes for each type of device. This is a wiki, so feel free to add to the page.

== Hardware Reported to Work ==

*We strongly encourage users to list any and all products they tested and installed.
*If a product works but you did not like it, please list it anyway. It may be the only product available to some users.

 

----

'''IMPORTANT! The devices listed here have been added by installers, technicians and users like yourself. Results may vary upon installations. MiCasaVerde does not guarantee operation and compatibility with your installation. The listed devices were found to work with their specific installation. Mixing different series and brands of equipment is not guaranteed in any way to work with other series and brands. It is very likely that users have not fully tested all features of the devices, so it is possible that a device listed here as compatible, will not prove compatible with your hardware. If you are editing this wiki DO NOT REMOVE a listed working device if it hasn't worked for you. Seek help to get the device to work under your individual circumstance. If you are adding to this wiki, please provide links to data for the device and add any tips you feel may benefit someone wanting to implement the device into an installation.'''

----

 

=== '''Lighting Devices''' ===

{| cellpadding="2" border="1" style="width: 1220px; height: 491px;"
|-
! Manufacturer
! Device Type
! Model no.
! Version
! Date Purchased
! Location (indoor/outdoor)
! Specs
! Product Review
! Added by User
! Notes
|-
| Leviton
| Dimmer Switch
| VRM10-1LX
| 1
| Nov 2008
| Indoor
| [http://shop.micasaverde.com/index.php?main_page=product_info&cPath=104&products_id=170 Link]
| [http://www.amazon.com/review/product/B000ZKM7I8/ref=dp_top_cm_cr_acr_txt?_encoding=UTF8&showViewpoints=1 Link]
| [http://forum.micasaverde.com/index.php?action=profile;u=65 mark-hc]
| This is a high quality dimmer geared towards high-end installations
|-
| Intermatic
| 300 watt dimmer
| HA06
| 
| July 2007
| Indoor
| [http://www.homesettings.com/products/modules/ha06.aspx Link]
| 
| 
| Affordable Dimmer Switch. incandescent/halogen only. Loads for 300 watts or less no neutral required. Great for dimming one bulb.
|-
| Cooper
| Accessory (3-way slave)
|
|
|
| Indoor
|
| 
|
| See [[Cooper_Accessory_Slave]]
|-
| Intermatic
| 3-way Switch
| HA18
| 
| Dec 2008
| Indoor
| [http://www.homesettings.com/products/new%20products/ha18.aspx Link]
| 
| [http://forum.micasaverde.com/index.php?action=profile;u=66 Kozanator]
| Affordable 3-way Switch
|-
| Intermatic
| 3-way Dimmer Switch
| HA20
| 
| Nov 2008
| Indoor
| [http://www.homesettings.com/products/new%20products/ha20.aspx Link]
| [http://www.smarthome-products.com/p-460-intermatic-homesettings-ha20c-3-way-in-wall-switch-dimmer.aspx Link]
| 
| Affordable 3-way 600W dimmer
|-
| ACT
| 2-way Dimmer Switch
| ZDW120
| 
| Nov 2008
| Indoor
| [http://store.homeseer.com/store/ZDW120---Z-Wave-600-Watt-2-Wire-Dimmer-ACT-HomePro-P17C64.aspx Link]
| [http://store.homeseer.com/store/ZDW120---Z-Wave-600-Watt-2-Wire-Dimmer-ACT-HomePro-P17C64.aspx Link]
| [http://forum.micasaverde.com/index.php?action=profile;u=49 WSeverino]
| Works well, easy to install, LED is a very bright blue....can be programmed to be off when the light is off or on.
|-
| ACT
| 3-way Dimmer Switch
| ZDW103
| 
| Nov 2008
| Indoor
| [http://store.homeseer.com/store/ZDW103---Z-Wave-500-Watt-3-way-Dimmer-ACT-HomePro-P19C64.aspx Link]
| [http://store.homeseer.com/store/ZDW103---Z-Wave-500-Watt-3-way-Dimmer-ACT-HomePro-P19C64.aspx Link]
| [http://forum.micasaverde.com/index.php?action=profile;u=49 WSeverino]
| Works well, can be tricky to install due to the different combination of 3 way circuits, LED is a very bright blue....can be programmed to be off when the light is off or on.
|-
| ACT
| 2-way Relay Switch
| ZRW113
| 
| Nov 2008
| Indoor
| [http://store.homeseer.com/store/ZRW113---Z-Wave-20-Amp-3-way-ISO-Relay-ACT-HomePro-P491C63.aspx Link]
| [http://store.homeseer.com/store/ZRW113---Z-Wave-20-Amp-3-way-ISO-Relay-ACT-HomePro-P491C63.aspx Link]
| [http://forum.micasaverde.com/index.php?action=profile;u=49 WSeverino]
| Controls Florescent Lamps very well! No humming at all.
|-
| ACT
| Companion Switch
| AS101
| 
| Nov 2008
| Indoor
| [http://store.homeseer.com/store/AS101---Z-Wave-3-Way-Companion-Switch-ACT-HomePro-P10C63.aspx Link]
| [http://store.homeseer.com/store/AS101---Z-Wave-3-Way-Companion-Switch-ACT-HomePro-P10C63.aspx Link]
| [http://forum.micasaverde.com/index.php?action=profile;u=49 WSeverino]
| Works well, can be tricky to install due to the different combination of 3 way circuits, The trick here is to install this device where the power comes in.
|-
| ACT 
| 3-way Dimmer Switch, 2 rocker 
| ZDM230 
| 1.1 
| Aug 2009 
| Indoor 
| [http://www.act-solutions.com/HomePro/pdfs/HomePro/Specs/ZDM230_spec.pdf Link] 
| 
| [http://forum.micasaverde.com/index.php?action=profile;u=3015 TedStriker] 
| Dimmer, Wall-mount, 230v, 500W, 3-way, 3 Wire, 2 rocker 
|-
| ACT
| 3-way Relay Switch, 2 rocker
| ZRM230 
| 1.1 
| Aug 2009 
| Indoor 
| [http://www.act-solutions.com/HomePro/pdfs/HomePro/Specs/ZRM230_spec.pdf Link] 
| 
| [http://forum.micasaverde.com/index.php?action=profile;u=3015 TedStriker] 
| Relay, Wall-mount, 230v, 6A, 3-way, 3 Wire, 2 rocker - '''Status polling does not work with Vera''' 
|-
| Innovus
| Relay Switch Adapter
| RAone SmartPower
|  
| Aug 2009
| Indoor
| [http://www.innovus.eu/fileadmin/user_upload/manual/z-wave/smartpower_zw_tech_doc.pdf Link]
|  
| [http://forum.micasaverde.com/index.php?action=profile;u=3015 TedStriker]
| Works very well + it has a build in powermeter which works perfect with Vera
|-
| Innovus
| Dimmer Switch Adapter
| RAone SmartDimmer
|  
| Aug 2009
| Indoor
| [http://www.innovus.eu/fileadmin/user_upload/manual/z-wave/smartdimmer-00110001-tech.pdf Link]
|  
| [http://forum.micasaverde.com/index.php?action=profile;u=3015 TedStriker]
| Works very well + it has a build in powermeter which works perfect with Vera
|-
| Intermatic
| Screw-in Module
| HA05C
| 
| Nov 2008
| Outdoor
| [http://store.homeseer.com/store/HA05C---Z-Wave-IndoorOutdoor-Screw-in-Module-Intermatic-HomeSettings-P1C62.aspx Link]
| [http://store.homeseer.com/store/HA05C---Z-Wave-IndoorOutdoor-Screw-in-Module-Intermatic-HomeSettings-P1C62.aspx Link]
| [http://forum.micasaverde.com/index.php?action=profile;u=49 WSeverino]
| Easy install, easy to pair with Vera!
|-
| Merten
| Radio sensor cover for dimmer inserts
| 5026xx, 5036xx, 5046xx
| 6,2,7,1,5
| Apr 2009
| Indoor
| [http://www.merten.de/download/DL_doku/V5026_581_01_web.pdf Link]
|  
| Ap15e
| Works well
|-
| Merten
| Radio sensor cover for switch inserts
| 5024xx, 5034xx, 5044xx
| 6,2,27,2,2
|  
| Indoor
| [http://www.merten.de/download/DL_doku/5024xx_5034xx_5044xx_Sensorflaeche4pin_CONNECT_INT.pdf Link]
|  
| Ap15e
| Works well
|-
| Merten
| Single Radio flush-mounted receiver
| 507001
| 6,2,27,2,2
| Apr 2009
| Indoor
| [http://www.merten.de/download/DL_doku/V5070_581_01_web.pdf Link]
|  
| Ap15e
| Works well
|-
| Merten
| switch, flush-mounted
| 507501, 507601
|  
|  
| Indoor
| [http://www.merten.de/download/DL_doku/V5075_581_00_web.pdf Link]
|  
| Ap15e
| Works well (according to [http://forum.micasaverde.com/index.php?topic=276.15 Link])
|-
| Merten
| 1-gang universal dimmer, flush-mounted
| 507900
|  
|  
| Indoor
| [http://www.merten.de/download/DL_doku/V5079_581_01_web.pdf Link]
|  
| Ap15e
| Works well (according to [http://forum.micasaverde.com/index.php?topic=276.15 Link])
|-
| Schlage
| Lamp Module
| RP200
| 1.0
| Aug 2009
| Indoor
| [http://consumer.schlage.com/products/Productdetail3.asp?StyleID=139&FinishID=12&FunctionID=77 Link]
| 
| [http://forum.micasaverde.com/index.php?action=profile;u=2870 LibraSun]
| Works well Sold with Schlage LiNK lock system
|-
| Leviton
| Dimmer Switch
| VRI06-1LX
|  
| Aug 2009
| Indoor
| [http://www.leviton.com/OA_HTML/ibeCCtpItmDspRte.jsp?item=305784&section=25501 Link]
| 
| [http://forum.micasaverde.com/index.php?action=profile;u=2618 guessed]
| Works well
|-
| Leviton
| 4-Scene Controller with Switch
| VRCS4-MRX
| 7,2,67,0,2
| Aug 2009
| Indoor
| [http://www.leviton.com/OA_HTML/ibeCCtpItmDspRte.jsp?item=433270&section=28563 Link]
| 
| [http://forum.micasaverde.com/index.php?action=profile;u=2618 guessed]
| Works well, pair as per [http://wiki.micasaverde.com/index.php/Leviton_Scene_Controller Leviton 4-Scene Controller], then again holding "2" and "4" to pair the Switch ("Load") itself.
|}

=== '''Plug & Receptacle Devices''' ===

{| cellpadding="2" border="1"
|-
! Manufacturer
! Device Type
! Model no.
! Version
! Frequency
! Date Purchased
! Location (indoor/outdoor)
! Specs
! Product Review
! Added by User
! Notes
|-
| Intermatic
| In-Wall Receptacle
| CA3500
| 1
|  
| Nov 2008
| Indoor
| [http://shop.micasaverde.com/index.php?main_page=product_info&cPath=105&products_id=97 Link]
| [http://www.amazon.com/review/product/B000U3XYPA/ref=dp_top_cm_cr_acr_txt?_encoding=UTF8&showViewpoints=1 Link]
| 
| This is a decent, but expensive solution for in-wall receptacles. One receptacle RF controlled, the other is hot
|-
| Intermatic
| Appliance Module
| HA02C
| 1
|  
| Nov 2008
| Indoor
| [http://shop.micasaverde.com/index.php?main_page=product_info&cPath=108&products_id=98 Link]
| [http://www.amazon.com/Intermatic-HA02C-Settings-Heavy-Duty-Appliance/dp/B000BJSDZO/ref=sr_1_3?ie=UTF8&qid=1227467418&sr=8-3 Link]
| 
| Seems to work well
|-
| ACT
| In-Wall Receptacle
| ZRR150W
| 2.2
|  
| Nov 2008
| Indoor
| [http://www.smarthome-products.com/p-527-homepro-zrr150-wall-receptacle.aspx Link]
| [http://www.smarthome-products.com/p-527-homepro-zrr150-wall-receptacle.aspx Link]
| 
| Works like a champ! Easy to Install. One receptacle RF controlled, the other is hot
|-
| Cooper Wiring Devices
| In-Wall Receptacle
| RFTR9505-T
|  
|  
|  
| Indoor
| [http://solutions.cooperwiringdevices.com/common/brands.cfm?pg=Detail&brandName=CWD%20Technology&category=Aspire%20RF%20Lighting%20Control%20System%3A%20Receptacles&id=16772 Link]
|
| 
| One receptacle is RF controlled, the other is hot
|-
| Intermatic
| Outdoor Module
| HA04C
| 1
|  
| Dec 2008
| Outdoor
| [http://store.homeseer.com/store/HA04C---Z-Wave-Outdoor-Module-Intermatic-HomeSettings-P6C62.aspx Link]
| [http://store.homeseer.com/store/HA04C---Z-Wave-Outdoor-Module-Intermatic-HomeSettings-P6C62.aspx Link]
| [http://forum.micasaverde.com/index.php?action=profile;u=66 Kozanator]
| Easy to Install.
|-
| Monster Central
| 1800W Appliance Module
| ML-LAS1000
| 1
|  
| Jan 2009
| Indoor
| [http://www.monstercable.com/productdisplay.asp?pin=3164 Link]
| 
| [http://forum.micasaverde.com/index.php?action=profile;u=2618 guessed]
| Easy to Install. I use this as a ZWave signal repeater. Appears to be a badge-engineering of [http://www.leviton.com/OA_HTML/ibeCCtpItmDspRte.jsp?item=309748&section=25542 Leviton VRP15-1LW]
|-
| Duwi
| Z-Wave switch 3500 W
| 05437
|  
| EU
| Feb 2009
| Indoor
| [http://www.duewi.com/ Link]
|
| ezhome
| High quality Plug-in switch, Easy install and works well
|-
| Merten
| switch, plug adapter, 2000 W
| 508519
| 6,2,7,1,5
| EU
|  
| Indoor
| [http://www.merten.de/download/DL_doku/V5085_581_01_web.pdf Link]
|  
| Ap15e
| Works well.
|}

=== '''Thermostat Devices''' ===

{| border="1" cellpadding="2"
|-
! Manufacturer
! Device Type
! Model no.
! Version
! Frequency
! Date Purchased
! Location (indoor/outdoor)
! Specs
! Product Review
! Added By User
! Notes
|-
| Wayne Dalton
| Wall Stat
| WDTC-20
|  ??
|  
| Nov 2008
| Indoor
| [http://store.homeseer.com/store/WDTC-20---Z-Wave-Thermostat-Wayne-Dalton-P599C38.aspx Link]
| [http://www.amazon.com/Wayne-Dalton-Corporation-Z-Wave-Thermostat/dp/B001F8QKYQ Link]
| 
| Has 2 inclusion modes: 1) press and release the bind button and the STAT will be included as a thermostat and works with Vera, 2) press and hold the bind button and it will be added as a binary switch for compatibility with old, non-compliant remotes. If it's added in the wrong mode, remove it and re-add it. Works great simple to use!
|-
| HAI
| Wall Stat
| RC-80BZ
|  ??
|  
| Nov 2007
| Indoor
| [http://www.homeauto.com Link]
| [http://www.homeauto.com/Downloads/Products/Omnistat/rcr80.pdf Link]
| 
| Shows up as Standard Thermostat in Vera, Hold button feature not able to control by Vera at this time. Priced above 200.00. Has internal setback programs. Works great.
|-
| RCS
| Wall Stat
| TZ43
|  ??
|  
| Nov 2008
| Indoor
| [http://store.homeseer.com/store/TZ43---Z-Wave-Thermostat-RCS-P627C67.aspx Link]
| [http://store.homeseer.com/store/TZ43---Z-Wave-Thermostat-RCS-P627C67.aspx Link]
| 
| Shows up as Standard Thermostat in Vera, much more feature rich the the WDTC-20 but comes with a hefty price tag ($214.95). Wish Vera could use all the features in this Thermostat! '''Note:'''''You need to set the thermostat to show the temperature, on its display, in Celsius degree in order to be able to receive "Set Temp" commands from Vera. This is no longer required in firmwares above '''''1.0.862 (luup)'''
|-
| Schlage/Trane
| Wall Stat
| Trane
|  ??
|  
|  ??
| Indoor
| [http://www.link.schlage.com/Products/Pages/Thermostat.aspx Link]
| [http://www.trane.com/Residential/Products/Thermostats Link]
| 
| It's the same thermostat as the RCS TZ43 and it has the same issue: it's accepting "Set Temp Point" commands only in the measurement unit that is displayed on its screen. '''Note:'''''You need to set the thermostat to show the temperature, on its screen, in Celsius degree in order to be able to receive "Set Temp" commands from Vera. This is no longer required in firmwares above '''''1.0.862 (luup)'''
|-
| Intermatic
| InTouch
| CA8900
| 
|  
| Nov 2008
| Indoor
| [http://www.smarthome-products.com/p-663-intermatic-intouch-ca8900-z-wave-digital-thermostat.aspx Link]
| 
| 
| Looks very similar to the Wayne Dalton WDTC-20 listed here. works great, simple to use
|-
| Danfoss
| Radiator thermostat
| RA PLUS-w
| 
| EU
| 
| Indoor
| [http://raplusw.com/Content/E962FC0B-6461-4319-82FE-3E1E765142CF.html Link] [http://raplusw.com/PCMPDF/Data%20sheet%20RA-PLUS-w_02.pdf Link]
| [http://www.eurox10.com/Product/ZWave/Actuators/ZWDNF_RA_PLUS-W.htm Link] [http://www.eurox10.com]
| 
| See: [[Danfoss Thermostat]] for installation instructions If the device cannot be configured at the final location, move the device closer to Vera and try again (this device might require a direct connection to Vera for configuration).
|}

=== '''Sensors''' ===

{| cellpadding="2" border="1"
|-
! Manufacturer
! Device Type
! Model no.
! Version
! Frequency
! Date Purchased
! Location (indoor/outdoor)
! Specs
! Product Review
! Added by User
! Notes
|-
| ACT
| Motion Sensor
| ZIR000 / ZIR010
| 
| EU (ZIR010) or US (ZIR000)
| 
| Indoor
| [http://www.act-solutions.com/HomePro/pdfs/HomePro/Specs/ZIR000_spec.pdf Link] [http://www.act-solutions.com/HomePro/pdfs/HomePro/Inst/ZIR000_instr.pdf Link] [http://www.act-solutions.com/HomePro/pdfs/HomePro/Specs/ZIR010_spec.pdf Link] [http://www.act-solutions.com/HomePro/pdfs/HomePro/Inst/ZIR010_instr.pdf Link]
| 
| 
| Remove the cover, pair to Vera's dongle by using the push-button on the left of the circuit board. Vera must configure it to work, and it can only be configured within less of a minute (30 sec best) of inserting the batteries. With Vera's dongle removed, remove/reinsert the batteries, and within 30 seconds insert Vera's dongle. Within a few minutes confirm the "configure" icon for the device is green on Vera's setup page
|-
| Express Controls aka HomeSeer
| 3-in-1 sensor (light/temperature/motion)
| HSM100 / EZMotion
| 
| EU or US
| 
| 
| [http://www.expresscontrols.com/pdf/EZMotionOwnerManual.pdf Link]
| 
| 
| See [[ExpressControls3in1]] If the motion sensor does not work right after inclusion and configuration, remove the batteries for a few seconds.
|-
| EverSpring/Hawking/Home Manageables
| Door/window sensor
| SM103
| 6,2,9,1,0
| EU or US
| Apr 2009
| Indoor
| [http://www.everspring.com/Products/Home_Automation_Detail.asp?parentUID=83&UID=355&CateUIDList=0,83 Link] [http://www.everspring.com/Archive/Image/File/A501110873R01_SM103_-ECR.pdf Link]
|  
| Ap15e
| Pair using the intrusion button. The sensor will accept configuration within a few minutes of the initial pairing, or of pressing the intrusion button on the back even after it's paired. Pair the device, or if it's already paired, press the intrusion button, and within 30 seconds insert Vera's dongle. Within a few minutes confirm the "configure" icon for the device is green on Vera's setup page. NOTE: There is some confusion about the orientation of the sensor. The main sensor body has a back (where the intrusion is), a front (where the logo and LED is), and the 2 other surfaces, one of which has a curved edge, and the other is flat. The magnet needs to go against the flat surface. And the flat surface on the magnet should be as close as possible to the flat surface on the sensor, lined up in the middle so the line which passes through the LED lines up with the sensor.
|-
| EverSpring/Home Manageables
| Humidity + Temperature sensor
| HM-TS001
|
|
| Jan 2010 (requires version 1.1.0 or greater)
| Indoor
| [http://www.asihome.com/ASIshop/product_info.php?products_id=3946 Link] [http://www.homeseer.com/pdfs/guides/HM_TD001.pdf Link]
|  
| micasaverde
| Pair or unpair the device by tapping the CF button 3 times very quickly. Once it's paired and shows up in the UI as a generic device, press the CF button 3 times again quickly to make it wakeup and get configured. Then it will correctly be identified as 3 devices (combo device + temperature + humidity).
|-
| Everspring
| Motion Detector
| SP103
| 6,2,9,1,0
| EU or US
| Apr 2009
| Indoor
| [http://www.everspring.com/Products/Home_Automation_Detail.asp?parentUID=83&UID=354&CateUIDList=0,83 Link] [http://www.everspring.com/Archive/Image/File/A501110874R01_SP103_%20-%20ECR.pdf Link]
|  
| Ap15e
| Works well
|-
| Fortrezz
| Water /Freeze
| WWA-001
|  ??????
| US
| Apr 2009
| Indoor
| [http://www.Fortrezz.com Link] [http://www.fortrezz.com/resources/WWA_manual_01May2009.pdf Link]
| 
| Zmistro
| Works great I would place a few in your house. Bathrooms, laundry , kitchen , basement. Great product!
|-
| Merten
| 4-gang radio transmitter, flush-mounted
| 506004
| 2,2,27,1,4
| EU
|  
| Indoor
| [http://www.merten.de/download/DL_doku/V5060_581_02_web.pdf Link]
|  
| Ap15e
| Note: There is proprietary functionality here. Support will be added soon.
Quite complex device; partially supported by Vera; can be used as a window/door sensor (as of firmware 1.0.900) ...
|}

=== '''Door Locks''' ===

{| cellpadding="2" border="1"
|-
! Manufacturer
! Device Type
! Model no.
! Version
! Date Purchased
! Location (indoor/outdoor)
! Specs
! Product Review
! Added By User
! Notes
|-
| Schlage
| Door lock and deadbolt
| BE369 (deadbolt)
| 
| Mid 2009
| Indoor
| [http://consumer.schlage.com/link/product_tour/ Link]
| 
| [http://forum.micasaverde.com/index.php?action=profile;u=2870 LibraSun]
| Read the instructions here: [[Schlage Lock]]
|}

=== '''Drapes/Blinds''' ===

{| cellpadding="2" border="1"
|-
! Manufacturer
! Device Type
! Model no.
! Version
! Date Purchased
! Location (indoor/outdoor)
! Specs
! Product Review
! Added By User
! Notes
|-
| Electronic Solutions
| Drape/Blind Motor Controller
| DBMZ
| V2+1
| 
| Indoor
| For 12-24VDC Motors
| [http://www.elec-solutions.com/products/dc_mot_ctrls/z-wave/dbmz/dbmz.html Link]
| Shady
| 2-Wire Motors
|-
| Electronic Solutions
| Drape/Blind Motor Controller
| ABMHZ
| V2+1
| 
| Indoor
| For 110-230VAC Motors
| [http://www.elec-solutions.com/products/int_ac_mot_ctrls/z-wave/abmhz/abmhz.html Link]
| Shady
| 4-Wire Motors
|-
| Lagotek / RSSceneAutomation
| Drape/Blind Motor Controller
| DC1-ZW
| 
| 
| Indoor
| For 12-24VDC Motors
| [http://www.lagotek.com/blindspdf/AC1-ZW%20Cut%20Sheet.pdf Link]
| Shady
| 2-Wire Motors
|-
| Lagotek / RSSceneAutomation
| Drape/Blind Motor Controller
| AC1-ZW
| 
| 
| Indoor
| For 110-230VAC Motors
| [http://www.lagotek.com/blindspdf/DC1-ZW%20Cut%20Sheet.pdf Link]
| Shady
| 4-Wire Motors
|}

=== '''Relay controls''' ===

{| cellpadding="2" border="1"
|-
! Manufacturer
! Device Type
! Model no.
! Version
! Date Purchased
! Location (indoor/outdoor)
! Specs
! Product Review
! Added By User
! Notes
|-
| Intermatic
| Contactor control box
| CA3750
| 
| Nov 2007
| Indoor/Outdoor
| [http://www.intouchcontrols.com/~/media/Files/InTouchControls/Products/Spec%20Sheets/CA3750.ashx Link]
| 
| 
| Multi-instance class supported for this device. Vera is able to control each of the 2 relays independently if desired. please note unit shows as three switches this is a bug with Intermatic not a real issue.You can check the box in devices to not show the second listing of the first relay in "Dasboard" You can control heavy loads like a water heater ,pool pump motor/s. great device
|}

=== '''Window Coverings''' ===

{| cellpadding="2" border="1"
|-
! Manufacturer
! Device Type
! Model no.
! Version
! Frequency
! Date Purchased
! Location (indoor/outdoor)
! Specs
! Product Review
! Added by User
! Notes
|-
| Merten
| Radio roller shutter push-button
| 5025xx, 5035xx, 5045xx
| 6,2,27,2,3 and 6,2,27,2,4
| EU
| Apr 2009
| Indoor
| [http://www.merten.de/download/DL_doku/V5025_581_01_web.pdf Link]
|  
| Ap15e
| Open/Close buttons work well, but slide bar does not work. GUI buttons do not work with Luup release 1.0.843 and 1.0.862 (fixed with Luup release 1.0.879). Workaround: Use a Luup Scene with the following code:<tt></tt>
<tt>local lul_arguments = {}</tt>

<tt>lul_arguments["newTargetValue"]="0"</tt>

<tt>lul_resultcode,lul_resultstring,lul_job,lul_returnarguments = luup.call_action("urn:upnp-org:serviceId:SwitchPower1","SetTarget",lul_arguments,6) </tt> Replace "6" with your device number, replace "0" with "1" for inverse action.

|-
| Duewi
| Radio roller shutter push-button
| 054368
| 6,2,51,1,0
| EU
| Jun 2009
| Indoor
| [http://www.duewi.de/index.php?productid=37344 Link]
|  
| Lutz
| Open/Close buttons work well, but slide bar does not work. Some additional observations by Ap15e (Vera V1, firmware 1.0.979):<UL><LI>GUI button 'Stop' and corresponding UPnP service does not work.</LI><LI>GUI button 'Up' moves the shutter down, GUI button 'Down' moves the shutter up ...</LI><LI>After adjusting the running times even the slide bar seems to work!</LI><LI>I got a report from a user that the düwi device may fail due to interference from the shutter motor. In this case an additional filter is required (costs about 25 €/direction).</LI><LI>More information is available at [http://forum.micasaverde.com/index.php?topic=3359.msg16142#msg16142 Link]</LI></UL>
|}

=== '''Cameras that work''' ===

{| cellpadding="2" border="1"
|-
! Manufacturer
! Device Type
! Model no.
! Version
! Date Purchased
! Location (indoor/outdoor)
! Path for JPEG image
! Product Review
! Notes
|-
| Linksys
| IP Camera
| WVC54GCA
| all
| 2009
| Indoor
| img/snapshot.cgi
| 
| An inexpensive camera with moderate image quality. Use the Linksys setup wizard for initial setup, then copy IP address and path into Vera setup fields. Use a static IP address.
|-
| Linksys
| IP Camera
| WVC210
| all
| 2009
| Indoor
| img/snapshot.cgi
| 
| A more expensive camera with good image quality and pan/tilt ability. Use the Linksys setup wizard for initial setup, then copy IP address and path into Vera setup fields. Use a static IP address. Pan/tilt controls will not work with Vera.
|-
| Linksys
| IP Camera
| WVC80N
| all
| 2009
| Indoor
| img/snapshot.cgi?size=2&quality=1
| 
| A more expensive camera with good image quality and wireless N. Use the Linksys setup wizard for initial setup, then copy IP address and path into Vera setup fields. Use a static IP address. Pan/tilt controls will not work with Vera.
Size can be (160 x 120 = 1,320 x 240 = 2,640 x 480 = 3) and Quality can be (Very High= 1,High= 2,Normal= 3,Low= 4,Very Low= 5)
|-
| iCamView
| IP Camera Server
| iCV-22, iCV-32
| all
| 2009 
| Indoor/Outdoor
| pda.cgi?user=admin&password=1234&page=image&cam=1 pda.cgi?user=admin&password=1234&page=image&cam=2 
| 
| Feature-rich IP camera server, suports up to two compatible USB cameras, optional WiFi support, USB storage, USB hubs, motion; works with range of cameras, see icamview.co.uk. Excellent modular solution. They do ship to North America.
|-
| SmartHome.com.au
| IP Camera
| Z~Series Wireless Camera
| all
| 2009 
| Indoor
| tmpfs/auto.jpg
| 
| Inexpensive IP security camera designed for the Australian and New Zealand Z-Wave users, but shipping world wide.
|-
| [http://global.level1.com LevelOne]
| IP Camera
| WCS-2030
| all
| 2010
| Indoor
| cgi-bin/video.jpg
| [http://reviews.cnet.com/search-results/levelone-camcon-wcs-2030/1707-5_7-31972011.html CNET review]
| An inexpensive IP camera with good image quality. Can be connected wired or wirelessly. Most LevelOne cameras use the same path for the JPEG image, so most of their line (both low and high end) should be compatible. Video and audio also stream over RTSP, which can be customized through the camera's web interface.
|}

Source Code

2010-04-17T21:11:51Z

Javier:

[[Category:Development]]
[[Category:Obsolete]]
Vera is based on OpenWRT KAMIKAZE. The full source tree for OpenWRT is available at openwrt.org.

The source code for Vera's applications, as of version 1.0.602, is available here: http://download.findvera.com/source-1.0.602.tar.gz

This includes DCERouter and some other libraries. The source code for Vera's Z-Wave stack and the router plugins are not included as they include licensed code and were created under NDA's. However these are not needed to extend the functionality of Vera because it is a plugin architecture so the proper way to add new functionality is to create another plugin or DCE device, rather than to add it into one of our existing devices. The binaries with the .602 release match the code, so you should be able to build a new firmware with the OpenWRT source tree + this source code, and add back in the non-open source Vera binaries. Note that the Z-Wave device (/usr/bin/ZWave) is not free or open source; license fees are paid per unit sold.

The exciting part is that our new [[LuaUPnP]] module will largely replace the need for developers to use the C/C++ code. This is a collaborative environment that makes it much easier to extend the functionality of Vera and will facilitate making more powerful applications than building DCE devices. You will be able to do virtually anything you want to extend Vera with the [[LuaUPnP]] module. And any devices created with LuaUPnP will be automatically UPnP devices. Plus you can specify if you want to make the devices available to the community for use, for development, or private.

Originally our plan to help facilitate developers wanting to add-on to Vera was to setup a build server with virtual machines. However we ran into some bugs and performance problems in the virtual machine emulators that made cross-compiling within a VM very difficult. So, we figured our developers' time is better spent on LuaUPnP since that will be a lot more useful tool for developers who want to make their own customizations and add-ons to Vera.

Source Code

2010-04-17T21:11:14Z

Javier:

[[Category:Development]]
Vera is based on OpenWRT KAMIKAZE. The full source tree for OpenWRT is available at openwrt.org.

The source code for Vera's applications, as of version 1.0.602, is available here: http://download.findvera.com/source-1.0.602.tar.gz

This includes DCERouter and some other libraries. The source code for Vera's Z-Wave stack and the router plugins are not included as they include licensed code and were created under NDA's. However these are not needed to extend the functionality of Vera because it is a plugin architecture so the proper way to add new functionality is to create another plugin or DCE device, rather than to add it into one of our existing devices. The binaries with the .602 release match the code, so you should be able to build a new firmware with the OpenWRT source tree + this source code, and add back in the non-open source Vera binaries. Note that the Z-Wave device (/usr/bin/ZWave) is not free or open source; license fees are paid per unit sold.

The exciting part is that our new [[LuaUPnP]] module will largely replace the need for developers to use the C/C++ code. This is a collaborative environment that makes it much easier to extend the functionality of Vera and will facilitate making more powerful applications than building DCE devices. You will be able to do virtually anything you want to extend Vera with the [[LuaUPnP]] module. And any devices created with LuaUPnP will be automatically UPnP devices. Plus you can specify if you want to make the devices available to the community for use, for development, or private.

Originally our plan to help facilitate developers wanting to add-on to Vera was to setup a build server with virtual machines. However we ran into some bugs and performance problems in the virtual machine emulators that made cross-compiling within a VM very difficult. So, we figured our developers' time is better spent on LuaUPnP since that will be a lot more useful tool for developers who want to make their own customizations and add-ons to Vera.

Somfy Plugin

2010-04-17T21:10:29Z

Javier:

[[Category:Plugins]]
[[Category:Hardware]]
To use the Somfy plugin, follow these steps:

1. Click Devices, Luup Plugins. Then 'install/uninstall plugins'. Find the 'Somfy plugin', click 'install', then click 'save'.

2. When the data is saved wait for the 'continue' to appear, then click it. Then click 'Devices' you will be asked to specify the room the Somfy Blind Interface is in.

3. Go to Devices, Luup Plugins, click 'Serial Port Configuration'. Find the serial port which you connected the Somfy interface to. Set the Baud to 9600, Parity to None, Data Bits to 8, Stop Bits to 1, and in the 'used by device', choose 'Somfy Blinds'.

4. Go to Devices, Luup Plugins, find the Somfy blind interface, click the '+' button. In the box marked 'BlindIds' put in a list of all the blind numbers which are active. The Somfy interface supports 16 blinds, and Vera cannot know which of those 16 ports are actually connected to blinds. So rather than just displaying 16 blinds when you probably only have a couple hooked up, Vera expects you to enter in the "ID" field which ports actually have blinds. Each number must be 2 digits, padded with a 0, and separated with a comma, with no spaces. So if you have blinds connected to ports 5, 9 and 12, enter in the ID box: 05,09,12. By default you will have blinds 01 and 02.

5. In the box UrtsiId, change the 01 to a single exclamation point, ie the ! character, if you are using an URTSI version 1. For version 2, you can normally leave the 01 as the default, unless it's set to a different house id.

6. Click 'Save'. Wait for the 'continue' button appear, click it. Wait about 30 seconds for the Somfy interface to startup up, then click 'Devices'. You will see the new blinds that you specified in #3. Pick the rooms they are in, and you're done.

Serial Supported Hardware

2010-04-17T21:09:39Z

Javier:

[[Category:User Instructions]]
[[Category:Hardware]]
This page is not yet complete...

=Introduction=
This is a page for Supported USB, or USB-Serial, interface devices.

USB, and USB-Serial, devices need to be recognized by Vera's platform before they can be used to interface with the target device (through a Luup Module). There are many USB-Serial devices out there, and not all will work out of the gate.

This page is intended to capture the list of known USB Devices that have been ''tried'' with Vera, along with their current status, and any information required to get them working.

This is a wiki, so feel free to add to the page.

=Disclaimer=
'''IMPORTANT! The devices listed here have been added by installers, technicians and users like yourself. Results may vary upon installations. MiCasaVerde does not guarantee operation and compatibility with your installation. The listed devices were found to work with their specific installation. Mixing different series and brands of equipment is not guaranteed in any way to work with other series and brands. It is very likely that users have not fully tested all features of the devices, so it is possible that a device listed here as compatible, will not prove compatible with your hardware. If you are editing this wiki DO NOT REMOVE a listed working device if it hasn't worked for you. Seek help to get the device to work under your individual circumstance. If you are adding to this wiki, please provide links to data for the device and add any tips you feel may benefit someone wanting to implement the device into an installation.'''

=USB Devices=
{| cellpadding="2" border="1" style="width: 1220px;"
|-
! Manufacturer
! Model #
! Status
! Date Purchased
! Chipset
! Specs
! Purchased from
! Added by User
! Notes
|-
| USB-UIRT
| USB-UIRT
| Working (1.0.918)
|
|
| http://www.usbuirt.com/
| http://www.usbuirt.com/
| [http://forum.micasaverde.com/index.php?action=profile;u=2 micasaverde]
| This one is listed in micasaverde's posting [http://forum.micasaverde.com/index.php?topic=1993.0]
|-
| APC
| Back-UPS ES 750
| Not Working
|
| APC HID
|
|
| [http://forum.micasaverde.com/index.php?action=profile;u=2618 guessed]
| Doesn't work in Vera 1.0.900. Requires installation of Kernel/OpenWRT modules to support USB-HID Interface for UPS. This one is listed in guessed's posting [http://forum.micasaverde.com/index.php?topic=1471.msg5570#msg5570]
|}

= USB-Serial Devices =

{| border="1" cellpadding="2" width="1220"
|-
! Manufacturer
! Model #
! Status
! Date Purchased
! #RS-232 Ports
! Chipset
! Specs
! Purchased from
! Added by User
! Notes
|-
| Future Electronics
| UC232R-10
| Working
|
| 1
| FTDI
| [http://www.ftdichip.com/Documents/DataSheets/Modules/DS_UC232R.pdf Link]
| [http://www.futureelectronics.com/en/Technologies/Product.aspx?ProductID=UC232R10FUTURETECHNOLOGYDEVICES2297802 futureelectronics.com]
| [http://forum.micasaverde.com/index.php?action=profile;u=2 micasaverde]
| This one is listed in MiCasaVerde's posting [http://forum.micasaverde.com/index.php?topic=1170.msg4500#msg4500]
|-
| SerialGear
| 8XDB9-USB
| Unknown
|
| 8
| FTDI - FT8U232AM
| [http://www.ftdichip.com/Documents/DataSheets/ft232r08.pdf Link]
| [http://www.usbgear.com/computer_cable_details.cfm?sku=8XDB9-USB&cats=199&catid=199%2C478%2C474 usbgear.com]
| [http://forum.micasaverde.com/index.php?action=profile;u=525 nanckekr]
| This one is listed in nanckekr's posting [http://forum.micasaverde.com/index.php?topic=1170.msg4484#msg4484]
|-
| Bytecc
| BT-DB925
| Manual
|
| 1
| Prolific - PL-2303
|
| [http://www.monoprice.com/products/product.asp?c_id=103&cp_id=10311&cs_id=1031104&p_id=2067&seq=1&format=2 monoprice.com]
| [http://forum.micasaverde.com/index.php?action=profile;u=2618 guessed]
| This one is listed in guessed's posting [http://forum.micasaverde.com/index.php?topic=1471.msg5512#msg5512]. It requires a series of manual configuration steps, and OS-Level access to Vera, to get it working.
|-
| BAFO
| DX SKU 5947
| Manual
|
| 1
| Prolific - PL-2303
| N/A
| [http://www.dealextreme.com/details.dx/sku.5947 dealextreme.com]
| [http://forum.micasaverde.com/index.php?action=profile;u=7 325xi]
| Well built, recognized by OpenWrt, Ubuntu, Windows, etc. On Vera it will require manual edits made through SSH. See details on nanckekr's post: [http://forum.micasaverde.com/index.php?topic=3025.msg12329#msg12329]
|-
| N/A
| DX SKU 22407
| Not working
|
| 1
| Prolific - PL-2303
| N/A
| [http://www.dealextreme.com/details.dx/sku.22407 dealextreme.com]
| [http://forum.micasaverde.com/index.php?action=profile;u=7 325xi]
| Intermittent USB recognition errors on Vera; but does work on Kamikaze
|-
|
SYBA

| N/A
| Not working
|
| 1
| Prolific - PL-2303
| N/A
| [http://www.monoprice.com/products/product.asp?c_id=103&cp_id=10311&cs_id=1031104&p_id=2276&seq=1&format=2 monoprice.com]
| [http://forum.micasaverde.com/index.php?action=profile;u=7 325xi]
| USB recognition errors on Linux distros and OpenWRT
|-
|  SerialStuff*
|  USBG-4FTDI*
| Working
| 11/2006
| 4
| FTDI FT232BL*
|  ?
| [http://www.mcmelectronics.com/product/83-10137 mcmelectronics.com]
| [http://forum.micasaverde.com/index.php?action=profile;u=4678 michaelk]
| 4 serial ports. Just plugged it in and it worked. There's also a 2-port model from the same place- that MIGHT work also. I assume it's FTDI becasue vera names the ports "ftdi_sio".  Fires right up from vera1's u sb port- but in case power is an issue it has a 5v input on the back so you can make it self powered. It's pretty generic- no name- etc. but feels solid- metal case and never had a problem with it over the years on a pc.   '''NOTE''':  *=I think it's the same as this page [http://www.usbgear.com/USBG-4FTDI.html usbgear.com] where I found that info
|}

=Ethernet-Serial Devices=
{| cellpadding="2" border="1" style="width: 1220px;"
|-
! Manufacturer
! Model #
! Status
! Date Purchased
! #RS-232 Ports
! Chipset
! Specs
! Purchased from
! Added by User
! Notes
|-
| WizNet
| WIZ110SR
| Working
| Jan 2010
| 1
| WIZnet
| [http://wiznet.co.kr/en/pro02.php?&page=1&num=20 Link]
| [http://www.sparkfun.com/commerce/product_info.php?products_id=9476 sparkfun.com]
| [http://forum.micasaverde.com/index.php?action=profile;u=2618 guessed]
| This is a stripped down Ethernet-enabled Serial/RS-232 Port. It's useful in situations where you might otherwise need a GC-100 to get "just a serial port" to connect to a TV, Amplifier etc. Don't forget to get yourself a 5V Power supply to drive it, or alternatively use a USB-5V Power code (as I do). Initial configuration of the device requires a Windows machine to run the configuration tool (DHCP, Baud Rate/Parity etc). Note that getting this "connected" to Vera is a manual process at this time. http://forum.micasaverde.com/index.php?topic=2989.0 . I use [http://www.sparkfun.com/commerce/product_info.php?products_id=8639 USB-5v] to power mine from an existing USB Power source.
|-
|}

=Discussions=
*Forum Posting - [http://forum.micasaverde.com/index.php?topic=1471.0 How to make Vera recognize your USB-to-Serial Adapter]
*Forum Posting - [http://forum.micasaverde.com/index.php?topic=1170.0 Serial port:]
*Forum Posting - [http://forum.micasaverde.com/index.php?topic=1703.0 Attempts to get ser2net Proxy working on a remote router device]

Sensor State

2010-04-17T21:09:13Z

Javier:

[[Category:User Instructions]]
[[Image:sensor-state.png]]

The green/red dot next to Arm/Bypass buttons IS NOT the indication whether the sensor is armed or not! It shows the current tripped state of the sensor - Green=Idle, Red=Tripped.

The only indication whether the sensor is armed or not is to check which button (Arm or Bypass) is highlighted in blue.

Pretty much all sensors go from green to red (i.e. tripped) almost instantly - motion detected, door/window open, water leak detected etc.

But going back from red to green (i.e. "untripped", reset or go back to idle) is another story. Some sensors need to be manually reset (water leak sensors, like FortrezZ), some get untripped instantly (door/window closed) or some take time to idle-out (motion sensor when it does not detect motion for some period of time, like 20 minutes by default in HSM100).

Note: The default idle value of 20 minutes in HSM100 can be changed, see [[ExpressControls3in1]])

Security Concerns

2010-04-17T21:07:40Z

Javier:

[[Category:User Instructions]]
If, when setting up Vera, on the FindVera tab, after creating a username and password for the FindVera service, you check the boxes "Only allow access through the secure FindVera service" and "Disable terminal login", then Vera will be a secure device that you can access only using our secure [http://FindVera.com FindVera.com] service, similar to some competing Z-Wave bridges and gateways that mandate you use their remote access service. In that case, the rest of this document may not interest you.

However, we believe that since you already paid for Vera, you own it, and you should have the freedom to choose if you want to use our service or not. Therefore we recommend you read this document to understand your choices and the implications.

There are 2 aspects to the security of your Z-Wave network. The first is the security of the Z-Wave network itself, and the second is the security of the internet connection Vera uses to allow remote control.

= Z-Wave Security =

Mi Casa Verde did not have any role in implementing the Z-Wave security. This was done by Zensys and the Z-Wave alliance, who assert the system is robust and secure, and who certify secure devices. Z-Wave security is designed to prevent unauthorized Z-Wave devices from communicating with secure Z-Wave devices.

= Internet Security =

If you turn off Vera's Wi-Fi, and don't connect Vera to your home network or to the internet, then internet security will not be an issue. However, you likely do want to connect Vera to the network so you can access Vera from your web browsers, cell phones, and such.

One solution to internet security would be to mandate that you must only access Vera through our secure service. This is the approach that some competing Z-Wave gateways or bridges have taken. The drawback with this approach is that you cannot use the product, which you already paid for, unless you continually pay the manufacturer for use of their secure server. If you stop paying them, or if they stop providing the service, your Z-Wave gateway becomes useless. Also, if the internet connection goes down in your home, such as a cable/DSL outage, you lose any access to your Z-Wave gateway as well.

'''Note: We give you the option of only allowing access to Vera using our secure service''', just like our competitors' product. However, being an open company and basing our products on open standards and a spirit of transparency, we feel that should be an option, not a mandate. You have the freedom to choose our secure services if you want to, but the functionality of Vera is not crippled if you choose otherwise. Vera functions without any internet connection at all. And, if you choose to disable the firewall, you can expose Vera to the internet and remotely access Vera over the internet and cell phone with limited security.

Therefore, take a moment to read about the security issues so you can make an informed decision what security measures you would like to take.

== Find Vera service ==

The FindVera service is designed to allow you to access your system remotely when you are away from home, by using our secure server as a gateway. With this service, Vera makes a secure, encrypted connection to the FindVera server, and you can remotely connect to the FindVera server over the internet or with your mobile phone. The FindVera server uses the same type of security as online banking, known as SSL.

Naturally even secure servers can be compromised, and even major banks and credit card companies have had their servers hacked into and their databases stolen. Therefore, we believe the best protection is for us to be honest and direct in explaining the security measures that we have implemented so that technical users and security experts can provide peer review and uncensored, open critique. One important thing to note is that at no time during the sign up or setup of your system are you asked for your address. Even if you purchase Vera from our online shop, that is handled by a separate, unrelated online shopping system and your credit card and address verification are handled by third parties, like Google and Paypal. Therefore, even if the FindVera service were compromised, the hacker would not know your address. To learn more about the measures we have implemented to safeguard this service, see [[FindVera Security Measures]]. We also have an uncensored forum at [http://forum.micasaverde.com http://forum.micasaverde.com] dedicated to security concerns.

On the FindVera tab, after you activate the FindVera service, you can check the box "Only allow access through the secure FindVera service", and "Disable terminal login". By doing this, Vera then has comparable security to our competitors' products, and you can only access Vera when your home network is up and you connect securely through https://findvera.com. Unlike our competitor's products, though, if you later change your mind and don't want to use our service, you can do a [[Factory Reset|factory reset]] of Vera and go back to using Vera without our service (requires firmware version 530 or later).

== Wi-Fi security ==

If you check the box "Only allow access through the secure FindVera service", that means that even if your Wi-Fi network is compromised, the intruder will not have access to Vera.

Vera includes a built-in Wi-Fi access point, which is manufactured by a third party, and the Wi-Fi security is the same as any other access point. The original Wi-Fi security, WEP, was shown to have vulnerabilities and has been hacked. The newer Wi-Fi security, WPA2, which is what Vera uses by default, is considered to be more secure. However, Mi Casa Verde makes no guarantees about the security of Wi-Fi, and, if you are concerned about the possibility of hackers, you can go to 'Advanced', 'Net & Wi-Fi' on Vera's 'Setup' page, and click 'Wi-Fi' ''Off''. Note that if you do that, and then you add another Wi-Fi access point to your home network, or leave Wi-Fi on in your computer, you may be exposing your home network to the same security risk.

== Local web access over your home network ==

Again, if you check the box "Only allow access through the secure FindVera service", this is not an issue, and you may skip this topic.

By default, Vera comes with no security on your home's local network. That means that any other computers within your home, on your local network, or connected to your home network with Wi-Fi, can access and control Vera. So, if someone comes into your home and connects to your home network, or if they hack into your Wi-Fi network, or if you have another router acting as a firewall and it becomes compromised, users can control Vera.

If this is a concern, there are a couple preventive measures you can take besides only allowing access through the FindVera service.

On the Users tab, you can create user names and passwords and check the box "Require a username and password to access Vera from within my home network." This means that even for people within the home, a username and password will be required. This makes Vera as secure as most any other IP device on your home network that requires a username or password. But that is not truly secure. Unlike the FindVera service which uses special encryption like online banking (SSL), you don't have any special encryption on your home network. So, if somebody hacked into your home network and was able to monitor your network traffic while you logged into Vera, someone who knew about network protocols could get your user username and password to Vera.

== Local terminal login ==

If you check the box "Disable terminal login" on the FindVera tab, you don't need to worry about this. If you're not a technical person, you can just check this box. You don't have to sign up for the FindVera service to check this option.

For the technical users out there, in addition to allowing you to connect to Vera from a web browser, Vera allows you to connect directly using what's called ssh or telnet. Vera is, after all, an open system, running the Linux operating system. By default, Vera allows anybody on your local home network to login without any password at all. If you want to set a password, go to 'Advanced', 'Net & Wi-Fi', and click 'Advanced Configuration'. You can then set a password. At that point, you can no longer log in with telnet, which is insecure, but must thereafter login with SSH, which is secure. Or just check the "Disable terminal login" box and all login is blocked. You can uncheck it later if you change your mind.

Secure Remote Access TechInfo

2010-04-17T21:06:46Z

Javier: Undo revision 2342 by Javier (Talk)

We have made it a top priority to provide customers a safe way to remotely control their Vera that is easy for the customer, but at the same time is secure and does not expose the customer to hackers and other security risks. This page provides technical details about the security measures we have implemented so we are subject to peer review. We have provided a 'Security concerns' forum at [http://forum.micasaverde.com forum.micasaverde.com] for uncensored discussion about security concerns.

Vera listens on two network ports: port 80 is the normal web interface, and port 3451 is for a special control protocol. When Vera boots up, if the network settings have not been changed manually, Vera first checks if the IP address is an internal IP address (i.e. starts with 192.168, 10. or 172.x), and whether there is a valid internet connection. Vera does this by pinging a couple of common servers, such as google, youtube, and micasaverde, to confirm that it gets unique addresses for each domain name and that at least 2 of the 3 servers respond. If Vera has an internal IP address and a valid internet connection, all 5 ports on Vera go into 'switch' mode, meaning they're effective bridged, and there is no firewall. Thus Vera is open for access from another system on the same home network. If Vera has an external, or routable IP address, Vera goes into 'gateway' mode: The WAN and LAN ports are separated, a firewall is setup, a DHCP server runs on the LAN ports providing addresses in the 192.168.81.x range, and Vera only accepts incoming connections on ports 80 and 3451 from the LAN ports. Thus, only PC's within the home would be able to access Vera, and nothing external, unless the homeowner changes the network settings or sets up a port forward through the main router's firewall. Vera's built-in Wi-Fi is enabled by default, which allows users into the system wirelessly. So we ship Vera with WPA2 encryption turned on, and a random Wi-Fi password consisting of two dictionary words plus a number, which is printed on the bottom of Vera.

Each Vera has two unique hardware keys which are stored in the NVRAM (non-volatile memory) and assigned at the factory along with the serial number and the domain name for the remote access server that Vera will use. Only the remote access server for a particular Vera has a database with the serial numbers and hardware keys. When the user goes to the [http://findvera.com FindVera.com] tab on his setup page (i.e. from within the home) and activates the service, his username and an MD5 hash (security checksum) of the password, along with the serial number and hardware key, are sent to the remote access server using the https: (SSL encryption) protocol. The remote access server validates the connection by checking whether the serial number and hardware key match, and if so, replies with a port number that the Vera unit can use for remote access.

The Vera then uses ssh with a pre-defined ssh username and shared key to make a connection to the remote access server. The remote access server only accepts incoming ssh connections from that username with that shared key. And ssh is configured on the server so that when a connection comes in, rather than giving the ssh user a console (i.e. bash), it runs a script that requires the serial number and hardware key be sent in within 10 seconds. If they are, and they match, and the right port number was used, the ssh connection is authorized. If there is a mis-match, a log is filed with the incoming external IP address so we can add a block to this IP in the firewall in case this is a DOS (denial of service) or similar attack. The SSH connection includes a port forward of ports 80 and 3451 using the standard ssh port forward mechanism. This port forward does not allow 'gateway', that is, the ports are only accessible from within the remote access server.

NetworkMonitor runs on Vera and calls a php page on the remote access server using https, passing in the serial number and hardware key, which does a loop back test to ensure the ssh tunnel is active. If it's not, NetworkMonitor shuts it down and re-opens it.

When first logging on through [http://FindVera.com FindVera.com], the user is redirected to the remote access server, which only accepts secure (https) connections. Once the remote access server validates the username and password, then the php page on the control tab effectively acts as a gateway to the customer's Vera. It passes requests between the SSL connection and port 80 and port 3451 that are forwarded from the ssh connection on Vera by looking up the ports that are associated with that username.

It should also be noted that we purposely never ask users for their home address so that if the remote access server ever were compromised, nobody would know the address of the Vera units.

Secure Remote Access TechInfo

2010-04-17T21:04:14Z

Javier:

[[Category:User Instructions]]
We have made it a top priority to provide customers a safe way to remotely control their Vera that is easy for the customer, but at the same time is secure and does not expose the customer to hackers and other security risks. This page provides technical details about the security measures we have implemented so we are subject to peer review. We have provided a 'Security concerns' forum at [http://forum.micasaverde.com forum.micasaverde.com] for uncensored discussion about security concerns.

Vera listens on two network ports: port 80 is the normal web interface, and port 3451 is for a special control protocol. When Vera boots up, if the network settings have not been changed manually, Vera first checks if the IP address is an internal IP address (i.e. starts with 192.168, 10. or 172.x), and whether there is a valid internet connection. Vera does this by pinging a couple of common servers, such as google, youtube, and micasaverde, to confirm that it gets unique addresses for each domain name and that at least 2 of the 3 servers respond. If Vera has an internal IP address and a valid internet connection, all 5 ports on Vera go into 'switch' mode, meaning they're effective bridged, and there is no firewall. Thus Vera is open for access from another system on the same home network. If Vera has an external, or routable IP address, Vera goes into 'gateway' mode: The WAN and LAN ports are separated, a firewall is setup, a DHCP server runs on the LAN ports providing addresses in the 192.168.81.x range, and Vera only accepts incoming connections on ports 80 and 3451 from the LAN ports. Thus, only PC's within the home would be able to access Vera, and nothing external, unless the homeowner changes the network settings or sets up a port forward through the main router's firewall. Vera's built-in Wi-Fi is enabled by default, which allows users into the system wirelessly. So we ship Vera with WPA2 encryption turned on, and a random Wi-Fi password consisting of two dictionary words plus a number, which is printed on the bottom of Vera.

Each Vera has two unique hardware keys which are stored in the NVRAM (non-volatile memory) and assigned at the factory along with the serial number and the domain name for the remote access server that Vera will use. Only the remote access server for a particular Vera has a database with the serial numbers and hardware keys. When the user goes to the [http://findvera.com FindVera.com] tab on his setup page (i.e. from within the home) and activates the service, his username and an MD5 hash (security checksum) of the password, along with the serial number and hardware key, are sent to the remote access server using the https: (SSL encryption) protocol. The remote access server validates the connection by checking whether the serial number and hardware key match, and if so, replies with a port number that the Vera unit can use for remote access.

The Vera then uses ssh with a pre-defined ssh username and shared key to make a connection to the remote access server. The remote access server only accepts incoming ssh connections from that username with that shared key. And ssh is configured on the server so that when a connection comes in, rather than giving the ssh user a console (i.e. bash), it runs a script that requires the serial number and hardware key be sent in within 10 seconds. If they are, and they match, and the right port number was used, the ssh connection is authorized. If there is a mis-match, a log is filed with the incoming external IP address so we can add a block to this IP in the firewall in case this is a DOS (denial of service) or similar attack. The SSH connection includes a port forward of ports 80 and 3451 using the standard ssh port forward mechanism. This port forward does not allow 'gateway', that is, the ports are only accessible from within the remote access server.

NetworkMonitor runs on Vera and calls a php page on the remote access server using https, passing in the serial number and hardware key, which does a loop back test to ensure the ssh tunnel is active. If it's not, NetworkMonitor shuts it down and re-opens it.

When first logging on through [http://FindVera.com FindVera.com], the user is redirected to the remote access server, which only accepts secure (https) connections. Once the remote access server validates the username and password, then the php page on the control tab effectively acts as a gateway to the customer's Vera. It passes requests between the SSL connection and port 80 and port 3451 that are forwarded from the ssh connection on Vera by looking up the ports that are associated with that username.

It should also be noted that we purposely never ask users for their home address so that if the remote access server ever were compromised, nobody would know the address of the Vera units.

Secure Remote Access

2010-04-17T21:03:41Z

Javier:

[[Category:User Instructions]]
[[Category:Glossary]]
Normally if you add a home networking device, like an IP camera, or a home control system, and you want to view or control that device from the internet, you will not be able to do this securely. This is because, even though the device may ask for a username and password, that username and password is transmitted all over the internet, and it's very easy to hack in.

The reason it's safe to use on-line banking and secure e-commerce is because the company's that run those sites have set up "secure servers". This is a complex process that involves creating encryption keys and getting your identification verified by an on-line security house, like Verisign, and setting up a secure server. A normal home user will never go through this process, and therefore, before Vera, there as no easy way to remotely and safely view your home's security cameras or control your home.

You can tell which companies have set up secure networks because when you to their web site, your web browser will show the web site in a special color, usually yellow, and the web site will start with https://, instead of http://, and your web browser will show you a padlock. When you see that, then you know you are on a secure network. You web browser has established a secure, protected connection directly to the company's server. You can type in your username and password and view pictures and be assured that whatever you are typing or doing cannot be seen by outsiders.

Mi Casa Verde has solved all these issues. We set up a secure server, [http://findvera.com FindVera.com], which only accepts secure connections.

When you first set up Vera you are asked for a username and password for the [http://findvera.com FindVera.com] site. From then on, whenever you turn Vera on and she finds the internet, Vera makes a secure connection to [http://findvera.com FindVera.com] automatically. Now when you are away from the home and want to connect to Vera, you also go to [http://findvera.com FindVera.com]. The [http://findvera.com FindVera.com] secure server then acts like a "patch" for you. So when you tell Vera to do something, it goes through the secure [http://findvera.com FindVera.com] server. And when you want to view your cameras, [http://findvera.com FindVera.com] gets the image from Vera using the secure connection and gives it back to you.

So the end result is that there is nothing to configure or setup. All you do is pick a username and password, and then you can access Vera to control your home and view cameras from anywhere, on any web browser or mobile phone, and it's a secure connection.

What's more, Mi Casa Verde has isolated the [http://findvera.com FindVera.com] secure server and put in place special measures and software that keeps your password encrypted, so that not even the Mi Casa Verde staff to can get in.

Schlage Lock Troubleshooting

2010-04-17T21:03:05Z

Javier:

[[Category:User Instructions]]
[[Category:Hardware]]
[[Category:Troubleshooting]]
<div lang="x-western" class="moz-text-html">'''In order to pair your lock please follow this step by step instructions carefully: ''' - place Vera near the lock (under 10ft) and keep Vera connected to the internet and the black zwave dongle in it's usb port !!! - open Vera's dashboard - go to Setup->Advanced->Logs and enable verbose logging - locate your Schlage 6 digit programing code     ( more infos about schlage lock pairing are on this manual page: [[Schlage Lock|http://wiki.micasaverde.com/index.php/Schlage_Lock]]  ) - go to Devices->Zwave Options and '''exclude''' your lock by:     ( more infos about full power inclusion are on this manual page:  [[Full Power Inclusion|http://wiki.micasaverde.com/index.php?title=Full_Power_Inclusion]] )     +changing INCLUDE to EXCLUDE     +low power to FULL POWER     +and timeout from 30 to 120 seconds then press GO button and go to your lock and:     +type the programing code, wait for the schlage led to blink ORANGE     + press Schlage button then 0 key and confirm that the led blinks ''GREEN'' --- '''if the lock led blinks RED then repeat the exclude procedure''' --- - go to Devices and confirm that your lock doesn't appear there anymore, if it's there repeat the exclude procedure - go to the lock and reset it to factory defaults as it says on its user manual on page 4: [http://part2.schlage.com/docs/lock_user_guide.pdf http://part2.schlage.com/docs/lock_user_guide.pdf]     *Note: Restoring factory settings WILL NOT exclude the lock from the bridge.                 DO NOT reset your lock unless you are able to locate the original programming code. Customer service cannot retrieve a lost programming code.         +1. For FE599, disconnect the batteries. For BE369, disconnect the 9V battery.         +2. On the lock keypad, press and release the Schlage button.         +3. Reconnect the battery and wait until the Schlage button is no longer lit.         +4. Within ten (10) seconds, press and hold the Schlage button '''until it lights green and the lock beeps.''' - go  to Devices->Zwave Options and  '''include''' your lock by:     +set to INCLUDE     +low power to FULL POWER     +and timeout from 30 to 120 seconds then press GO button and go to your lock and:     +type the programing code, wait for the schlage led to blink ORANGE     + press Schlage button then 0 key and confirm that the led blinks ''GREEN'' --- '''if the lock led blinks RED then repeat the include procedure''' --- * you can see the progress written in blue text at the top of the page, bellow "Z-Wave options" page title - wait for the lock to be added and the zwave network to be restarted then - go to Devices and observe the lock configuration progress by going with the mouse pointer over its BLUE COG WHEEL     ( more infos about device status are on this manual page:  [[Device_Control_Status|http://wiki.micasaverde.com/index.php/Device_Control_Status]] ) ''* during the lock configuration time you should not unplug Vera from the power cord or change / save other settings on it * - assign the lock into a Room, press Continue and the press the Red SAVE button. Vera will continue the lock configuration. '' - after the cog wheel turns green test your lock: send lock/unlock commands, then add an user code     ''- confirm that you can control your lock when Vera it's near it, then move Vera at it's initial place'' - after you've put back Vera at it's initial place you have to update the zwave network routing table by running "Repair my Network" from     Device->Zwave Options with 5 minute stress time. More informations can be found here: [[Heal Network|http://wiki.micasaverde.com/index.php/Heal_Network]]     ''- wait for the Heal Network process to finish then test again your lock ''- if the cog wheel turns RED or your lock doesn't respond to commands and you are sure that you've followed the above steps carefully and at every step you've seen the lock schlage led blinking GREEN then go to Advanced->Tech Support: enable it and submit a trouble report with your logs attached and tell us at what step the configuration stage failed.</div>

Schlage Lock

2010-04-17T21:01:46Z

Javier:

[[Category:User Instructions]]
[[Category:Hardware]]
= Secure Z-Wave Devices Explained =

Door locks are a special breed of Z-Wave devices which require an exchange of security keys with Vera during the 'Include' ("pairing") process.  Accordingly, the normal 'Include' procedure - carrying Vera's black Z-Wave dongle to the device - will not work with Schlage locks.  Instead, Schlage locks must be paired with Vera using a special procedure (see 'Adding/Pairing a Lock', below).

In order for Vera to interoperate successfully with a Schlage lock or other secure Z-Wave device, the following conditions must all be met: '''1)''' Vera's Z-Wave dongle must have a built-in security class: '''Go to Setup -> Devices -> Z-Wave Options''', and look at the ''''Version''''. If the '''version is 2.40 ''''''your dongle does not have the security class implemented.'''  Request a replacement dongle by sending us a support request at the [http://www.micasaverde.com micasaverde.com] website (click 'Support'), including your serial number, name, address and email. 

'''2)''' Vera's firmware must be '''version 1.0.602 or later''': '''Go to Setup -> Advanced -> Download''' and confirm the version of your firmware. 

'''3)''' The range for the Schlage lock is much less than for other devices because the antenna is inside a metal housing. The distance (in open air) between Vera and your lock should not exceed 30 feet (if you have two walls between them, the distance should be much lower). You can use a [http://www.newegg.com/Product/Product.aspx?Item=N82E16812191054 USB Cable extender] to place Vera's Z-Wave dongle closer to the lock. (If you change the dongle position, don't forget to do a [[Heal Network]] after.) Otherwise you will need to add lamp modules to act as Z-Wave relays, as explained in #4.

'''4)''' Schlage locks work with Zensys' "Zensor Net Technology" which prolongs battery life for battery-powered Z-Wave devices. If the Schlage lock cannot be in direct communication to Vera and its signal must be routed through other Z-Wave devices, the last node in the route must be capable of "Zensor Net Beam" (ZNB). Currently, the only Z-Wave devices on the market known to support ZNB are the Homepro ZDP100 lamp module (must be firmware version 3.3 or later) and the Schlage RP200 light module. After you've added lamp modules, you must do a [[Heal Network]] before they will effectively act as relays. [[Heal Network]] will also give you a report to confirm that Vera can talk to all your Z-Wave devices. 

= Setting Up a Schlage Lock with Vera =

== Adding/Pairing a Lock ==

Adding ("pairing") a secure device like the Schlage lock takes longer than adding a normal, non-secure device because Vera needs to share encryption keys with a secure device.  IMPORTANT: Leave Vera's black Z-Wave dongle inserted when pairing a lock with Vera.

Choose one of the following methods for adding a lock to Vera's network:

=== Method 1 - Vera is located FAR from the lock you are adding ===

These are the steps typically used to pair secure Z-Wave devices with Vera.  Note beforehand that this method involves Vera being disconnected from the internet as well as your home network.  However, because Vera's Wi-Fi remains active throughout, you can perform Steps 7-9 by connecting your computer wirelessly to Vera.

1. Disconnect Vera and move Vera close to the Schlage lock. Plug Vera into an electrical outlet near the lock.

2. After 60 seconds, Vera's power light comes on and starts double flashing - meaning Vera is operational but has no internet connection.

3. Press-and-hold the black button on the back of Vera, then tap the red button once. (Be careful not to press the black ('restore') button twice in a row, as this will reset Vera to the [[Factory Reset|factory default]] configuration!) Vera's power light will begin blinking steadily once per second - meaning Vera is in 'Add' mode. (Wait up to 30 seconds for Vera's power light to start blinking like this, and if it does not, repeat Step 3 until it does.)

4. On the Schlage lock's keypad, enter its 6-digit programming code.  The light will blink orange. ''    (Note: You can find the lock's program code on the back of the lock or in its manual.)''

5. Wait the lock to flash 3 times and to tone 3 times, then press the [Schlage] button, and then '0'.

6. If Vera's power light flutters briefly, and the lock's [Schlage] button blinks green twice, pairing was successful. Otherwise, you must follow the steps below for 'Resetting a Schlage Lock' and then repeat Steps 1-5 to try pairing the lock again

7. Reconnect Vera back where it belongs (or connect to Vera wirelessly) and access Vera through your web browser.

8. On Vera's 'Devices' page, assign the lock to a room and give it a name, and set any other options, then click 'Save'.

9. Try activating (locking or unlocking) the door lock using Vera.

NOTE: If the lock fails to pair with Vera despite repeated attempts, try resetting the lock (see 'Resetting a Schlage Lock'), then attempt Steps 1-5 once again.

(For more information on the method described here, read the 'Adding/Removing Z-Wave Devices' section of [[Buttons Indicators#Adding.2FRemoving_Z-Wave_devices|Adding/Removing Z-Wave Devices with the Red/Black Buttons]].)

=== Method 2 - Vera is located CLOSE to the lock you're adding ===

This method works best if your Vera unit is already positioned close enough to communicate with the Schlage door lock.

1) Log in to Vera's interface by directing your computer's web browser to Vera's IP address (e.g. 192.168.81.1).     (Note: You can also log in using [http://FindVera.com FindVera.com], but the IP login works a bit faster.)

2) Click 'SETUP' in the top right hand corner of the Dashboard.

3) Click 'Devices'.

4) Click 'Z-Wave Options'.

5) From the pull-down menus, choose: "''Include''" "''one''" node "''any''" with "''high power''" and timeout after "''30''" seconds.

6) Before proceeding, have your lock's programming code handy and have a clear walking path to your lock.

7) Click 'Go' and immediately walk to the lock. (''You must complete Steps 6-8 within 30 seconds''.)

8) On the lock's keypad, enter the 6-digit programming code, then press the [Schlage] button.

9) After the [Schlage] button stops blinking amber and the 3 tones finishes, press '0'.  The [Schlage] button should light up green, indicating that pairing with Vera was successful.     NOTE: If the [Schlage] button instead blinks red, the lock may need to be reset first. Repeat Steps 1-9, but choose "''Exclude''" in Step 5, to reset the lock. Then try to pair the lock again.

10) On Vera's 'Devices' page, assign the lock to a room and give it a name, and set any other desired options, then click 'Save'.

11) Try activating (locking or unlocking) the door lock using Vera.

NOTE: If the lock fails to pair with Vera despite repeated attemps with either method shown here, you may need to reset the lock to its factory default state before trying again (see 'Resetting a Schlage Lock to Factory Default', below).

Once pairing has succeeded, Vera will begin configuring the lock you just added.  During the configuration process, Vera will display a spinning blue cog icon next to the lock on Vera's 'Devices' page (see [[Device Control Status|Device Control Status]] for more details). It can take as long as 10 minutes for Vera to configure the lock completely, because a lot of encrypted data is being exchanged in the process. Be patient, and don't use Vera for other tasks until the green cog icon appears.  Whenever you rename the lock, change its room, or otherwise change its configuration settings (other than assigning PIN codes), Vera will need to re-configure the lock again.

== Resetting a Schlage Lock ==

A. Disconnect Vera and move Vera close to the Schlage lock. Plug Vera into an electrical outlet near the lock.

B. Vera's power light comes on and starts double flashing - meaning Vera is operational but has no internet connection.

C. Press-and-hold the red button on the back of Vera, then tap the black button once. Vera's power light will begin blinking fast, about 3 times per second - meaning Vera is in 'Remove' mode. (Wait up to 30 seconds for Vera's power light to start blinking like this, and if it does not, repeat Steps A-C until it does.) 

D. On the Schlage lock's keypad, enter the lock's programming code.

E. Press the [Schlage] button and then '0'. The lock should beep and the 'Schlage' button should blink twice, indicating the lock is now reset and ready to be paired with your Vera (see 'Adding/Pairing a Schlage Lock,' above).

If the lock fails to reset as described in Step E, try repeating Steps C-E until it does.

== Excluding a Schlage Lock From Previous Network ==

Before adding a lock to your Z-Wave network, you may have to [http://wiki.micasaverde.com/index.php/Reset_Node exclude] it first from a previous network. Even if the lock is new, it could have come from the factory already paired with a Z-Wave network. To resolve this issue:

#Unplug the black Z-Wave dongle from the back of Vera.
#Keep the dongle's button pressed for 5 seconds, until the blue light starts blinking fast.
#On the lock's keypad, enter the programming code and wait for the light to blink orange.
#Press the [Schlage] button and then '0'. 

== Removing/Unpairing a Lock ==

If your Schlage lock was mistakenly paired using Vera's normal (dongle-based) 'Include' procedure, the lock will have a red cog icon displayed next to it on Vera's 'Devices' page, and you won't be able to control it. To use the lock with Vera, you must first remove ("unpair") the lock from the Z-Wave network.

Remove the lock the same way as any other Z-Wave device:

(1) Remove Vera's black dongle, then hold the dongle near the lock.

(2) Press and hold the button on the dongle for 3 seconds until the light starts blinking fast, which indicates it's in 'Remove' mode.

(2) On the lock's keypad, enter the 6-digit programming code.  The lock will beep audibly.

(3) Press the [Schlage] button followed by '0'.

(4) Re-insert the dongle in Vera, wait 60 seconds, and refresh the browser page.

The lock should now be gone from Vera's 'Devices' list, indicating the lock has been successfully removed from the network, and you can proceed to pair, or include, the lock the right way (see Method 1 or Method 2, above).

= Resetting a Schlage Lock to Factory Default =

It is sometimes necessary to reset a Schlage lock to its factory default, in order to enable the lock to pair properly with Vera, or to resolve other lock malfunctions: 

1) Remove the batteries from the lock.

2) On the lock's keypad, press and release the [Schlage] button.

3) Reconnect the lock's battery(s).

4) Wait until the [Schlage] button is no longer lit.

5) ''Within 10 seconds'', press and hold the [Schlage] button until it lights green and the lock beeps.

Your Schlage lock is now reset to its factory default, and you may proceed to add it to Vera's network.

= Other Notes =

Any time Vera configures a secure Z-Wave device such as a Schlage lock - either immediately after pairing the lock with Vera, or when subsequent changes are made to the lock's settings on Vera's 'Devices' page - Vera needs to poll all 19 of the lock's user codes, even ones that are not set yet!  Accordingly, it may take Vera a while to display the green cog icon.  Be patient, and do not use Vera for any other tasks during the configuration process.

You can see Vera's event log by choosing the 'Advanced' tab -> 'Logs' -> 'Verbose' -> 'Show Z-Wave Jobs'.  If Vera's communication with the lock has been successful, the list will show all completed events.  Refresh the page using your web browser to see subsequent events as they are added to Vera's event log. 

= Using a Schlage Lock with Vera =

== Lock/Unlock ==

You can lock/unlock door locks and deadbolts with Vera the same way you turn a light On or Off. A door lock can be locked and unlocked remotely. '''But Schlage deadbolts are designed so someone has to physically turn the deadbolt knob to engage/disengage the deadbolt. When Vera tells the deadbolt to unlock, the deadbolt knob is engaged for 10 seconds so someone can turn it, and then after 10 seconds, it's disengaged again. '''(This behavior is identical to when you enter your PIN on the deadbolt's keypad.) Schlage locks contain no motor to lock/unlock the deadbolt. Thus, Vera cannot remotely lock or unlock a deadbolt for you. Instead, you can wait until someone is at the door, then click 'Lock' or 'Unlock' using Vera's interface, and tell the person to turn the deadbolt knob.

Vera offers three ways to control a door lock or deadbolt:

1) Use your PC's or PDA's web browser to click the lock/unlock buttons on Vera's 'Dashboard'. To allow remote access, you can click 'Unlock' when a person is in front of the door, giving the person a few seconds to manually turn the latch;

2) Use a cellphone application to activate the lock remotely; or, 

3) Issue a PIN to each authorized user (see 'Setting a User PIN,' below).

== Controlling the lock with handheld remotes and scene controllers ==

You can add handheld remotes and scene controllers to Vera and choose the option "Manage scenes as events". Then you can create a scene which locks a door, as well as doing other tasks, and associate the scene to a button on the remote or in-wall scene controller. (See [[ZWave Add Controller|Z-Wave Add Controller]] method #2.) So you can create a 'Go to Bed' scene, for example, which may be button 1 on your scene controller, and which locks all the doors and turns off the lights and thermostats. For your security, we only allow you to 'lock' the doors using a handheld remote or scene controller. You cannot 'unlock' them with this technique because remotes and scene controllers are not secure devices and, therefore, there is the risk that an intruder could impersonate you using your handheld remote or scene controller. To unlock the doors, you must use Vera's web interface or mobile phone interface.

== Scenes and Events ==

Door locks initiate events (a) when the door is locked/unlocked, (b) when a user enters a PIN, and (c) when someone enters the wrong PIN three times in a row. You can create a scene, associate one or more of these events with the scene, and check one of the 'Notify User' boxes if you want to be notified when an event (and a corresponding scene) happens.

== Setting a User PIN ==

You can create a PIN for each authorized user to use when locking/unlocking the door:

=== Adding a new PIN ===

#Navigate to Vera's 'Control' (or 'Dashboard' or 'Devices') page
#Select an empty slot for the new user
#Give the user a descriptive name (e.g. "Pool Service")
#Type the user's new PIN
#Click 'Set'.
#Each user's PIN will remain active until you remove it.

It may take up to 60 seconds for Vera to confirm the new code was set, whereupon you will see the new user listed next to the lock, along with a 'Remove' button.  If the lock already contained user PINs - which you added manually or through a different Z-Wave controller - Vera will display them as "Code 1", "Code 2", etc.

NOTE: For your security, Vera does not keep a copy of the codes; they are only stored in the lock itself.

=== Changing an existing PIN ===

#Navigate to Vera's 'Control' (or 'Dashboard' or 'Devices') page
#Remove an existing user's slot (see below) 
#Add the user again with a different PIN (see above) 
#Click 'Set'. 
#The user's PIN will remain active until you remove it. 

=== Removing a PIN ===

#Navigate to Vera's 'Control' (or 'Dashboard' or 'Devices') page
#From the list, find the user whose PIN you wish to de-activate
#Click the 'Remove' button next to that user
#Click 'Set'.
#The user's PIN will be removed from Vera's list.

NOTE: If Vera does not confirm the removal after 60 seconds, simply try again. 

SPECIAL NOTE: If you add, change or remove many users/PINs in rapid succession, Vera will display a 'job icon' for each addition/change/deletion. You do not need to wait for each one to complete. For example, you can add 10 users in rapid succession, and you will see 10 gray 'job icons'. Gray indicates Vera hasn't started yet, as explained [[Device Control Status|here]]. Since it takes several seconds for Vera to program a new PIN into the lock, as each job is being processed (in order), the corresponding icon turns blue, then becomes green when it is successful. In this way, you can quickly queue up several new users, and then just let Vera process them one at a time. When Vera is finished, you will see the list of all users, along with a 'Remove' button next to each. Similarly, you can click several 'Remove' buttons in rapid succession without waiting for each removal to complete.

== Reversing the Lock/Unlock Status ==

If the lock/unlock status of your door lock is backwards, meaning Vera's 'Dashboard' shows it is locked when it's really unlocked and vice-versa, it's possible the lock was oriented upside-down when mounted. To solve this issue, go to Vera's 'Setup' page, click the 'Devices' tab and click the '+' button next to the door lock, and then the 'Advanced' button. If you see a parameter "#305 Reverse", enter a value of '''1'''.  Save this change. Vera will now reverse the lock/unlock status.

If parameter #305 is not in the list, then at the bottom of the page, type '''305''' in the "New Device Data ID" field, and type '''1''' in the "New Device Data Value" field. Click 'Add'. Then save your changes. Vera will now reverse the lock/unlock status.

== Logging and Camera Links ==

When you log in to [http://FindVera.com FindVera.com] and click 'Events', you can select the door lock to see all the times someone entered a user code at the door or locked/unlocked the door.

On the 'Devices' tab, click '+' next to your security camera(s), and you will have a check box for this lock. Then, whenever the door is locked/unlocked, Vera will also take a picture with the camera(s). You will see the pictures associated with an Event when you click the event on the [http://FindVera.com FindVera.com] site.

= Security Concerns =

See: [[Security Concerns]]

= External Links =

*[http://part2.schlage.com/docs/manual_lock_programming-beta.pdf Schlage Lock User Manual]
*[http://part2.schlage.com/docs/lock_user_guide.pdf Schlage Lock User Guide]

Set up Scenes

2010-04-17T21:01:07Z

Javier:

[[Category:User Instructions]]
[[Category:Glossary]]
A scene is a group of commands or settings that you can do all at once, rather than one at a time. For example, when you leave your home, you may want to turn off 5 lights, turn on the porch light, ARM your motion detector so the alarm is active, turn on the garage light for 5 minutes so you have time to leave, and then turn it off again. You could do this using the [[Dashboard|dashboard]] by clicking on the control buttons for each of the lights and devices, and then waiting 5 minutes and turning off the garage light. But this is a lot of work. So, instead, you can create a scene, give it a descriptive name, like "Leave your home", and then put all the settings for those lights and the motion detector in the scene. This way, when you leave, you just choose the one scene "Leave your home", and Vera does the rest.

When you create a scene you must first decide what room to put the scene in. This is just to make it easier for you to keep track of your scenes. Generally pick the room where you are most likely to use the scene. Often this is the same room where you want to control the devices. For example, if you create a scene called "Watch TV", which turns off all the lights in the living room so you can watch TV in that room. In this case, the "Watch TV" scene would probably go in the living room, since that's where you'll most likely use it. But this isn't necessarily the case. Maybe, for example, you have a young child, "Sarah", and you want a scene that turns off the lights in Sarah's room, but you usually do this from your own bedroom. In this case, you would put the scene in the "Master Bedroom" because, even though it controls the lights in Sarah's room, you will generally use the scene in the Master Bedroom. Similarly, scenes like "Leave for Work" or "Come Home" would typically go in whatever room you normally enter and leave the home from, like the Garage, Kitchen, Patio, etc.

By organizing your scenes according to the room you use them, you can leave a remote control in that room, like an iPod Touch, and have it just show the scenes for that room, so it's easy to find what you're looking for. For example, you could leave an iPod on the coffee table in the Living Room, set to the room "Living Room", and you'll see just the scenes for that room, like "Watch TV", without having to scroll through lots of scenes in other rooms you won't use. You can also give scenes the same name if they're in different rooms. For example, you may have 3 scenes called "Go to bed"; 1 in the master bedroom, 1 in Sarah's room, and 1 in the guest bedroom. Each scene does something different, as appropriate for that room.

To add a scene, click the 'Scenes' button on Vera's [[Quick Start|setup page]]. All the rooms are listed, as shown here. Click the 'Add Scene' button next to the room you want to add the scene to.

Then, a new scene will be added. Change the name from "New Scene" to whatever name you want. Underneath that scene are all the devices in your home organized by room. Next to each device is a pull-down menu where you indicate what you want to happen to that device when you choose the scene. So in the first example, "Leave your home", you would find the 5 lights you want to be turned off and, next to each light, select the pull down and choose "Off". You would also choose the pull down next to the motion detector and choose "ARM". Remember in the "Leave your home" example we wanted the garage light to come on for 5 minutes and then turn off. So, next to the garage light choose the pull-down, select "On", and then in the next pull-down change "and leave it" to "after 5 minutes" and then another pull down will appear where you can choose "Set a new setting" and "Off". This means the garage light will come on for 5 minutes, and then turn off, regardless whether the light was already on before you chose the scene. If instead you want the garage light to come on for 5 minutes, but after the 5 minutes have passed, you only want it to turn off if it was already off before you chose the scene, then leave the pull down to say "Go back to the prior setting". Note that this works for dim levels as well. If you said you wanted to dim the light to 70% for 5 minutes and then "Go back to the prior setting", that means if the light was at 30% brightness before you started the scene, then, when you chose the scene the light would go to 70% and after the 5 minutes had passed, it would return to 30%.

Scenes can also adjust your thermostat, and any other type of device.

One device you can set in a scene that may not be so intuitive are motion detectors and other security alarm sensors. The reason for this is that you may want to be notified when a sensor is tripped because it might mean there is an intruder. But, when you are at home and passing in front of the sensors all the time, then you probably do not want to be notified every time the sensor is tripped; only when you are away. The solution is to create a scene which you choose when you leave the house and which changes the sensors to "ARM" and then another scene when you return home which changes them to "BYPASS". Then you can create an [[Event|event]] which notifies when the sensor is tripped while it is armed. For more information on setting up a security system with Vera, see [[Intro Security|Security Introduction]].

 [[Image:Scene1.jpg|thumb|center|512px]] [[Image:Scene2.jpg|thumb|center|512px|The Scenes]]

== Adding timers & Events ==

Vera can also run your scenes for you at certain times, such as every Wednesday at 6pm, or every 30 minutes, or 10 minutes after Sunrise. These are called 'Timers'. Learn [[Timer|How to create timers]]. Vera can also run your scenes automatically in response to some event from another device, for example "When a motion sensor is tripped" or "When a door is locked". These are called 'Events'. Learn [[Event|How to create events]].

Rooms

2010-04-17T21:00:40Z

Javier:

[[Category:User Instructions]]
[[Category:Glossary]]
All the devices and scenes in Vera are grouped by room. So you must list the rooms in your house, and then on the 'Devices' page, you need to specify which rooms your devices are in. Some devices, like handheld controllers, may be used throughout the house. In this case, just pick the room where the device is most commonly used or kept. The sole purpose of rooms is to help organize your devices and scenes so you can find them easily and and keep track of which is which. So you don't have to take the term "Room" too literally. You could, for example, create a "Room" called "Back yard" or "Outdoors", or even a room called "John's stuff".

When you create a scene you generally add the scene to a room as well, namely whatever room you are most likely to want to use the scene in. Again, this is just to help organize your scenes and remember which scene is which. Note that what room you add a scene to does not have any effect on which devices it can control. For example, you can create a scene in the "Living Room" that turns on bedroom lights. Create the scene in whatever room you are most likely to want to use that scene. The reason for putting scenes in rooms is just to make it easier to keep track of which scene is which and to quickly find the scenes for the room you are in. For example, on remote controls like iPhone and mobile phones, when you enter a room you need only pick the room once. Then you will see all the scenes in that room without being distracted by all the other scenes in other rooms. This also means you can create multiple scenes with the same name in different rooms. For example, you may have 3 scenes called "go to bed" in 3 different bedrooms. Each scene may do something different.

There may be a couple scenes that are not really tied to a room, or are used throughout the home or in different rooms. For example, you may have a scene called "Entertaining Mode" which you use when guests arrive. You could put this scene in any room that will allow you to easily find it, remember the purpose of putting scenes in rooms is solely to make it easier for you to find the scenes. In a case like this, "Entertaining Mode" would probably be put in the "Entry Room" or "Living Room" if that's where you usually greet your guests. If you truly want a "global scene", meaning a scene that you would normally use from anywhere in the home, then you will note on the 'Scenes' tab there is a special place called "Global Scenes" to add those scenes. If you add a scene to "Global Scenes", then it's like adding to every room. For example, say you create a global scene called "Energy savings mode" that turns off all the lights in the home. And, say you have an iPhone you use as a remote control. The iPhone will let you pick the room it's in, but no matter what room you pick, you'll see the global scene "Energy savings mode". If the iPhone is showing the Living Room, you'll see the global scene ''plus'' the scenes in the Living Room. The global scenes appear in every room. On the [[Dashboard]] the global scenes appear at the top.

For more advanced users, if you have a very large house, or if you want to create graphical floorplans to control the devices with icons, you can also create "Sections", and organize the rooms by section. Examples of sections may be: "First Floor" and "Second Floor", or "Main House", "Guest House" and "Grounds". Create sections by clicking the "Advanced" tab and choosing the sub-tab "Sections". You can create a floorplan for each section using your favorite paint or draw program and upload them to Vera on that page. You can also position the devices on the floorplan. Before you do this, go back to the 'Rooms' tab and be sure to indicate which section each room is in. Since most users don't create sections, by default Vera has only one section "My Home" and all rooms are put there.

Rooms

2010-04-17T21:00:06Z

Javier:

[[Category:User Instructions]]
All the devices and scenes in Vera are grouped by room. So you must list the rooms in your house, and then on the 'Devices' page, you need to specify which rooms your devices are in. Some devices, like handheld controllers, may be used throughout the house. In this case, just pick the room where the device is most commonly used or kept. The sole purpose of rooms is to help organize your devices and scenes so you can find them easily and and keep track of which is which. So you don't have to take the term "Room" too literally. You could, for example, create a "Room" called "Back yard" or "Outdoors", or even a room called "John's stuff".

When you create a scene you generally add the scene to a room as well, namely whatever room you are most likely to want to use the scene in. Again, this is just to help organize your scenes and remember which scene is which. Note that what room you add a scene to does not have any effect on which devices it can control. For example, you can create a scene in the "Living Room" that turns on bedroom lights. Create the scene in whatever room you are most likely to want to use that scene. The reason for putting scenes in rooms is just to make it easier to keep track of which scene is which and to quickly find the scenes for the room you are in. For example, on remote controls like iPhone and mobile phones, when you enter a room you need only pick the room once. Then you will see all the scenes in that room without being distracted by all the other scenes in other rooms. This also means you can create multiple scenes with the same name in different rooms. For example, you may have 3 scenes called "go to bed" in 3 different bedrooms. Each scene may do something different.

There may be a couple scenes that are not really tied to a room, or are used throughout the home or in different rooms. For example, you may have a scene called "Entertaining Mode" which you use when guests arrive. You could put this scene in any room that will allow you to easily find it, remember the purpose of putting scenes in rooms is solely to make it easier for you to find the scenes. In a case like this, "Entertaining Mode" would probably be put in the "Entry Room" or "Living Room" if that's where you usually greet your guests. If you truly want a "global scene", meaning a scene that you would normally use from anywhere in the home, then you will note on the 'Scenes' tab there is a special place called "Global Scenes" to add those scenes. If you add a scene to "Global Scenes", then it's like adding to every room. For example, say you create a global scene called "Energy savings mode" that turns off all the lights in the home. And, say you have an iPhone you use as a remote control. The iPhone will let you pick the room it's in, but no matter what room you pick, you'll see the global scene "Energy savings mode". If the iPhone is showing the Living Room, you'll see the global scene ''plus'' the scenes in the Living Room. The global scenes appear in every room. On the [[Dashboard]] the global scenes appear at the top.

For more advanced users, if you have a very large house, or if you want to create graphical floorplans to control the devices with icons, you can also create "Sections", and organize the rooms by section. Examples of sections may be: "First Floor" and "Second Floor", or "Main House", "Guest House" and "Grounds". Create sections by clicking the "Advanced" tab and choosing the sub-tab "Sections". You can create a floorplan for each section using your favorite paint or draw program and upload them to Vera on that page. You can also position the devices on the floorplan. Before you do this, go back to the 'Rooms' tab and be sure to indicate which section each room is in. Since most users don't create sections, by default Vera has only one section "My Home" and all rooms are put there.

Reset Node

2010-04-17T20:59:31Z

Javier:

[[Category:User Instructions]]
=== Reset / Exclude / Un-pair / Remove Node from ZWave Network ===

Z-Wave devices, like lamp modules, light switches, sensors, and so on, can only be added to one Z-Wave network. If you experience difficulty adding a device to Vera's Z-Wave network by carrying the black Z-Wave dongle to it, this may be a sign that the Z-Wave device was already paired with another Z-Wave controller, and needs to be reset. You can reset the Z-Wave device using Vera's black Z-Wave dongle. First, remove Vera's Z-Wave dongle and be sure the dongle is 'Off', meaning the blue light is off. If the blue light is on or blinking, tap the button on the dongle to turn it off. Now, press and hold the button on Vera's Z-Wave dongle for 3 seconds until the blue light starts blinking rapidly. When you see the blue light blinking rapidly, then you can carry the dongle with you and it will reset any Z-Wave that you activate while that device is within 3 feet (1 meter) of the dongle. You typically activate Z-Wave devices, like lamp modules, by turning them on or off. Some Z-Wave devices, like sensors and thermostats, may have an 'Active' or 'Include' button, as explained in their manuals. If you activate a Z-Wave device while Vera's Z-Wave dongle is in the 'Reset' mode, meaning the blue light is blinking fast, then the Z-Wave device will be reset. After resetting a device, the blue light on Vera's Z-Wave dongle will momentarily stop blinking. If you have several devices to reset, just leave the Z-Wave dongle in this 'Reset' mode while you carry it around and activate all the devices you want to reset.

Once a Z-Wave device has been reset, you may want to use it with Vera.  To do so, simply tap the button on Vera's Z-Wave dongle to stop the reset mode and turn the dongle off, meaning the blue light goes out. Then, tap the button again briefly so that the blue light is blinking slowly. This means the dongle is now in 'Include' mode. Now when you activate a Z-Wave device within 3 feet (1 meter) of the dongle, you will see the blue light on the dongle stop blinking and come on solid momentarily, to let you know that it was successfully added to Vera's Z-Wave network.

When you are finished, insert the black Z-Wave dongle back into the port on the back of Vera and leave it there. Go to the 'Devices' tab on Vera's setup web page, within about 30 seconds of inserting the dongle, to see any new devices you have included.

'''Note: If you have made changes to Vera's setup page, and have not saved those changes, you will not see your new devices. Instead you will see a red message that says: ''This data has changed and is not up to date. Click "SAVE" to save your changes and refresh the page.'' You need to click 'SAVE' before seeing your devices.'''

Repair My Network

2010-04-17T20:59:10Z

Javier:

[[Category:User Instructions]]
Please follow this link for Repairing Z-Wave Network: [[Heal_Network]]

RemoteLinc

2010-04-17T20:58:19Z

Javier:

[[Category:User Instructions]]
[[Category:Hardware]]
To add the SmartHome.com RemoteLinc to Vera, go to Devices, INSTEON & X10, click 'Add/Remove INSTEON device'. In the box "If you know the INSTEON id", enter the id of the RemoteLinc and click 'Add an INSTEON device' beneath it. Then click 'Save'. Wait 60 seconds or until the configuration has stopped and when you click on 'Devices' you will see your new device as a Generic I/O. Press the 'All On' button on the RemoteLinc to wake it up so Vera can figure out that it's a RemoteLinc. Wait a minute or so and click on devices again. It should now appear as a Scene Controller. Assign it to a room, give it a name, click 'continue' and then 'Save'. After Vera finishes configuring again press the 'All On' button again to wake it up again so Vera can complete the configuration of the RemoteLinc. When it's all done you will see a green cog wheel next to the device to indicate that it's configured and ready to go.

Quick Start Hardware

2010-04-17T20:57:38Z

Javier:

[[Category:User Instructions]]
1. Insert the black Z-Wave dongle into either of the matching ports on the back of Vera.

2. Screw the antenna to the gold 'antenna' port on the back of Vera and leave the antenna pointed up.

3. Use a standard network cable (included) to connect the network port on the back of Vera marked '''''WAN''''' into either your DSL or cable modem, or into your existing home network. Vera will use this port to connect to the internet.

4. Connect the power cord and plug Vera in. '''Wait 2 minutes after plugging Vera in before continuing.'''

[[Image:VeraBackQSG.png|thumb|512px|center|caption text| The Back of Vera]]

5. After you have waited 2 minutes, look at the power light on the front of Vera. If it is on solid that means Vera was able to connect to the Internet. Proceed to step 6. Otherwise, read the network troubleshooting section before proceeding.

[[Image:VeraFrontQSG.png|thumb|512px|center|caption text| The Front of Vera with the Power Light On]]

'''Note: To setup Vera you will need an internet web browser. The web browser can be anywhere on the same home network as Vera. Or connect your computer to one of Vera's 4 ports marked LAN. Or, connect to the wireless home network Vera setup for you automatically using the network name and password on the front of this guide.
'''

6. Open your web browser and go to: http://findvera.com. Click the green "Setup Vera" button as shown below (left). If you don't see that button, read the network troubleshooting section.

--todoal: Update the screen shot in the adobe illustrator quick start guide, and put both pics here so it matches

7. You should now see Vera's setup page in your web browser (above right). Vera has helpful videos to guide you and links to online documentation with detailed instructions. You should be up and running in just a few minutes. If you do not see Vera's setup page, read the [[Networking_Setup | network troubleshooting]] section. If you don't have an internet connection you can still use Vera, but you will not see the videos or online documents.

'''Note: Vera will share your internet connection automatically. Connect other network devices to Vera's LAN1-LAN4 ports or to Vera's wireless network. Vera will automatically detect compatible devices, like security cameras, and let you control or view them from outside the home using Vera's secure network. If you purchased wireless devices from Mi Casa Verde, like wireless security cameras, they were shipped to you pre-configured to work with Vera's wireless network. Just plug them in; there is nothing to configure.
'''

Quick Start

2010-04-17T20:57:04Z

Javier:

[[Category:User Instructions]]
[[Category:UI2]]
The Quick Start Guide that comes in Vera's box explains how to physically connect Vera and get to Vera's setup site in your web browser. If you've already done this, including inserting Vera's black Z-Wave dongle, confirming Vera's power light is on solid, and you see the Vera's setup site in your web browser, continue to setup Vera as explained below. If not, [[Quick Start Hardware|click here]].

 [[Image:Setup1.jpg|thumb|left|512px]] [[Image:Setup2.jpg|thumb|left|512px|This explains the basic things]]

== Setting up Vera ==

Vera's setup page is shown above. You only need to use the setup page when you first setup Vera, or if you want to make changes later on. Once Vera is setup, you will see the [[Dashboard]] page instead, but you can always return to the setup page by clicking the "Setup" button.

Technically, the only two steps that are required are 'Rooms' and 'Devices'. You can be up and running in just a couple minutes. However, to get the full benefit of Vera we recommend you go through all 9 steps in order. Note that once you have made changes you will see this red 'Save' button. [[Image:RedButton.JPG|RedButton.JPG]] Your changes are not saved until you click it.

The 9 steps are:

'''[[Intro|Intro]]''' This explains the basic things Vera can do for you and shows you what accessories you'll need.

'''[[Find Vera Service|FindVera.com]]''' This explains the FindVera.com service and lets you pick a username and password for that service.

'''[[Rooms|Rooms]]''' Here you list the rooms in your house.

'''[[Users|Users]]''' Add all the people in your home who will be able to use the system and who you want to be notified of events, like a security breach or a sensor being tripped. Also tell Vera how to notify each user, such as with Email or SMS text.

'''[[Devices|Devices]]''' Here you add the devices you want to control, like Z-Wave lamp modules and IP cameras.

'''[[Scenes|Scenes]]''' You can create scenes, which are really just a set of actions for your devices. For example, the "Go to Work" scene may turn off all the lights and the thermostat. This way you can press just one button, "Go to Work", to control a lot of devices at once. You can also add timers and events to make scenes happen at certain intervals, or in response to events such a motion detector being tripped or the sun going down.

'''[[Location|Location]]''' If you tell Vera where you live, then Vera can set the time and calculate sunrise and sunset for that location. This is needed if you want to add timers and events to your scenes.

'''[[Energy]]''' Tell Vera to notify you if you forgot to turn the lights off after you left for work, or if energy usage is higher than it should be. Also, tell Vera how to handle an energy alert from your local government or utility, such as the Flex Alert in California.

'''[[Advanced|Advanced]]''' Most people don't need to use this. It has advanced settings, such as manually configuring your network settings.

'''Note: Don't forget to click the 'Save' button to save your changes. If you close your web browser without clicking 'Save', your changes will be lost.'''

Also, once you complete the setup page, then you won't see the setup page anymore when you access Vera. Instead, you will see the [[Dashboard|Dashboard]]. If you want to change your setup later, just click the 'Setup' button on the dashboard to get back to this setup page, jump directly to the setup step you want to change, make your changes, and click 'Save'.

[[Image:Dashboard1.jpg|thumb|center|512px|The Dashboard]]