MiOS - User contributions [en]

Luup Scenes Events

2012-09-09T12:23:40Z

Solipsia: /* Switch on, and switch off 2 seconds later */

== Adding Lua code to scenes and events ==

[[Image:SceneFlowchart.png]]

You can add Lua script to scenes and events for simple tasks, like making a scene or event conditional. Conditional meaning "do something only '''if''' some condition is met", such as attaching a condition to your "Come Home" scene so it is only run '''if''' the temperature is over 70 degrees. Basic conditional expressions are easy, and, if that's all you're looking to do, skip to the walk-through below.

If you're more technically inclined you can also do very advanced things too. For an overview of all the advanced things you can do with Vera's Luup engine, and how scenes and events fit in, see the [[Luup Intro]] page.

To add Lua code to a scene, create the [[Scenes]] and click 'Luup scene'. Fill in your Lua code in the input box. To do a simple condition, see the sample below. Or if you want to do advanced scripting you can use any [[http://lua.org Lua]] commands as described in the [[http://www.lua.org/manual/5.1/ Lua reference manual]] as well as the variables and functions that the Luup engine adds to Lua documented here: [[Luup Lua extensions]]. The Lua code will be run every time the scene is activated either by the user or a scene or a timer. The Lua code is run before the commands that you included in the scene. If your Lua code ends with this: "return false" then the commands in the scene will not be run.

You can also add Lua code to an event by clicking 'Luup event'. Since events are attached to scenes anyway, there is usually little difference between adding the code to an event, or to the scene the event is part of. If the Lua code in an event returns false, then the event is aborted, meaning the scene that the event is attached to will not be triggered by the event. The main reason for attaching Lua code to an event is if you have multiple events to a scene. For example, you may have a scene called "Turn lights on in hallway" which is triggered by 2 events: 1) The front door opens, and 2) the motion sensor in the hallway is tripped. Perhaps whenever the front door opens you always want the scene to be activated, but you only want the motion sensor to activate the scene before 10:00. In this case, you would add Lua code to the motion sensor's event which does something like (pseudo-code): "if time>10:00 return false". That way the event from the motion sensor will be aborted if it's after 10:00, but the event from the front door will always activate the scene regardless.

When you edit the Lua code in a scene or event you must click 'Save' before the code is saved. Then you can activate the scene or trigger the event to see what happens when your code is run. If you're doing some advanced scripting that you'll need to debug this can be tedious, but there are easy ways to test your Lua script immediately without saving first as explained in [[Lua Debugging]].

If you're doing advanced Lua scripting, you should note that all the Lua code in your scenes and events run in a single Lua instance, which is separate from any Lua plugins. This means if you set a global variable in one scene, or create a function inside the Lua code in a scene, then in another scene's Lua code you can use that global variable or call that function. You do not need to worry about conflicting with a Luup plugin, though, since they have their own Lua instance, meaning they have their own global variables and functions.

== Walk-through #1 -- At 12 noon, turn off the interior lights if the temperature is over 80 degrees ==

Before you start, in Vera's setup interface go to 'Devices' and click the '+' button next to the thermostat. Make note of the Device #.

In this walkthrough we'll assume it's Device #3, but use the actual device number of''your'' thermostat. Next, visit [[Luup Variables]] to get a list of all the variables for devices. A variable is a piece of information about the current state of a device, such as whether it's on or off, it's current temperature, etc.

Look down at ''Thermostat'', and copy the name of the service/variable which corresponds to the current temperature, namely. In this case, it's

urn:upnp-org:serviceId:TemperatureSensor1 CurrentTemperature

Notice that it states the <tt>CurrentTemperature</tt> is in Celsius. So type in "80 degrees Fahrenheit to Celsius" in Google and you'll see that it's 26.6 degrees Celsius.

Now, the first step is to create the scene that turns off the lights. In Vera's setup interface, click 'Scenes', and click 'Add Scene' to add a new scene to one of the rooms. It's not important which room you choose. Scenes are categorized in rooms just to help you keep track of them if you have a lot of scenes. You can also put the scene in 'Global Scenes', or, you can create dummy rooms on the 'Rooms' tab if you want to have more "rooms" to organize your scenes with. After you click 'Add Scene', type in a description to remember your scene by, such as "Lights off 12:00 if 80". Under the 'Commands' area you'll see all the rooms. Click '+' next to the rooms that have lights you want to control, and choose "Off" in the pull-down. At this point, you have a normal scene, and, if you were to save your changes now, whenever you click the scene on the dashboard or on a remote control, the lights should turn off.

Second, next to the scene's description click 'add timer'. You can give the timer a description too so that if you have multiple timers you can see in the logs which one is activating the scene. Choose "Day of week based". If you want this scene to only run on certain days of the week, just check off which days you want this scene to run on. Otherwise, you can leave them all unchecked (or check them all) to do it every day. Leave the pull-down at "a certain time of day", and choose 12 : 00 : 00 from the pull-downs. At this point, if you were to save your changes, the lights would turn off automatically at 12 noon.

Third, the last step is to add the condition. To the right of the scene's description you'll see the button "Luup Scene". Click it and in the code box, copy and paste the following:

<source lang="lua">
local lul_temp = luup.variable_get("urn:upnp-org:serviceId:TemperatureSensor1","CurrentTemperature", 3)
if (tonumber(lul_temp) < 26.6) then
return false
end
</source>

Don't forget to change the "3" to whatever is the actual device number of your thermostat. Assign the result of <tt>luup.variable_get</tt> to a variable first, rather than putting it directly in the <tt>tonumber()</tt>, because <tt>luup.variable_get</tt> actually returns 2 values: the value of the variable, and the time when the variable was modified. The '<tt>tonumber</tt>' is needed because all of a device's variables are stored as plain text--not numbers--so if you want to do arithmetic or numeric comparison of a variable, you need to put <tt>tonumber()</tt> around <tt>luup.variable_get</tt>.

<tt>luup.variable_get</tt> is documented in [[Luup Lua extensions]].

Now click 'Update', and then click 'Save' to save everything. The "return false" means "don't run this scene". So if the current temperature is <26.6, the scene will be aborted and won't run. The timer will make it trigger every day at 12 noon.

To test it, you can click the scene button on the dashboard. The lights will turn off only if the temperature is over 80 degrees. If it's less than 80 degrees, the scene won't do anything. Since this scene is something that happens automatically and you probably won't execute manually, you can go to the scene again and check the "Hidden" box so the scene doesn't show up on Vera's 'Dashboard' and on your remote controls, like the iPhone. If you want to have a scene that turns off the lights which you can run whenever you want from 'Dashboard''or your remote control, you should create another scene that has the same commands and simply don't add the timers and Luup conditions, and don't check the "Hidden" box. ''

You can substitute other service/variables and device ID's to make other types of conditions. The "if" statement above also supports nesting with ( and ), as well as the keywords 'and' and 'or'. So the following means the scene would abort if the temperature is <26.6 and >25, unless it's <23:

<source lang="lua">
local lul_temp = luup.variable_get("urn:upnp-org:serviceId:TemperatureSensor1","CurrentTemperature", 3)
if ((tonumber(lul_temp) < 26.6
and tonumber(lul_temp) > 25)
or tonumber(lul_temp) < 23) then
return false
end
</source>

If the scene doesn't run, it's possible there is a syntax error. The easiest way to test this is to copy the Lua code from the scene, then go to Devices, Luup Plugins, and "Test Luup code". Paste the code in the box and click 'go'. If the info box above the 'go' button has a check and says "Message sent successful", your code is okay. If there's an error, it says: "Code failed".

To see if that's true, use putty, or telnet or ssh to log-in to Vera, as explained in detail in [[Logon_Vera_SSH]] and [[Lua Debugging]], and type:

cd /var/log/cmh
tail -f LuaUPnP.log | grep '^01'

Now click 'Save' in Vera's setup page, even if it's gray, as that will cause Vera to restart the Luup engine and log any syntax errors. See: [[Lua Debugging]] for in-depth details on how to debug.

== Walk-through #2 -- Only run the scene during the daytime ==

In the Luup tab for the scene paste this:

<source lang="lua">
return luup.is_night() == false
</source>

That works because if the return is 'true' the scene runs, and if it's 'false' it doesn't. So during the daytime the expression is true. Or, an alternative long form:

<source lang="lua">
if (luup.is_night()) then
return false
else
return true
end
</source>

== Samples ==

This page is a wiki which anyone can edit. If you have some Lua code you think other users might find useful, feel free to add it here.

=== Lighting and Switch Actions ===

Did you see the sample here already: http://wiki.micasaverde.com/index.php/Luup_Scenes_Events

==== Turn an appliance switch or a Danfoss thermostat on for device #5 ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:SwitchPower1", "SetTarget", {newTargetValue = "1"}, 5)
</source>

==== Turn an appliance switch or a Danfoss thermostat off ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:SwitchPower1", "SetTarget", {newTargetValue = "0"}, 5)
</source>

==== Do something if switch device #5 is on ====

<source lang="lua">
local lul_tmp = luup.variable_get("urn:upnp-org:serviceId:SwitchPower1", "Status", 5)
if (lul_tmp == "1") then
--something to do goes here
end
</source>

==== Dim switch #6 to 30% ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:Dimming1", "SetLoadLevelTarget", {newLoadlevelTarget = "30"}, 6)
</source>

====Switch on, and switch off 2 seconds later ====
<source lang="lua">
local device = 29
-- Switch on device 29:
luup.call_action("urn:upnp-org:serviceId:SwitchPower1","SetTarget",{ newTargetValue="1" },device)
luup.call_delay( 'switch_off', 2) -- Call the switch off function after a delay of 2 seconds
function switch_off()
luup.call_action("urn:upnp-org:serviceId:SwitchPower1","SetTarget",{ newTargetValue="0" },device)
end
</source>

==== Blinking lights (and how to delay for a number of seconds) ====

http://forum.micasaverde.com/index.php?topic=5127.0

=== Motion Sensor Actions ===

==== Arm motion sensor #7 ====

<source lang="lua">
luup.variable_set("urn:micasaverde-com:serviceId:SecuritySensor1", "Armed", "1", 7)
</source>

==== Disarm motion sensor #7 ====

<source lang="lua">
luup.variable_set("urn:micasaverde-com:serviceId:SecuritySensor1", "Armed", "0", 7)
</source>

Note, arming and disarming isn't a concept within UPnP or Z-Wave. It's just a flag that the Luup engine uses, and is stored in a variable we created called "Armed".

=== Scene Actions ===

==== Run Scene #5 ====

Thanks "denix" on the forum for the correct syntax. "Actually, the 4th parameter IS required, but it's not used. Otherwise the command fails with an error message"

<source lang="lua">
luup.call_action("urn:micasaverde-com:serviceId:HomeAutomationGateway1", "RunScene", {SceneNum = "5"}, 0)
</source>

In this case we left the device number off (the 4th parameter to <tt>luup.call_action</tt>), because the "<tt>RunScene</tt>" action is handled by the Luup engine itself--not by some device within Z-Wave, etc.

However, normally you don't need to <tt>luup.call_action</tt> in Lua code. Rather, whatever actions, or commands, you want to run, you put into the scene itself, and the only Lua code is to simply check if some condition is true and abort the scene if the condition isn't met.

=== Thermostat Actions ===

==== Change the Temperature on Thermostat (Cool) device #19 ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:TemperatureSetpoint1_Cool",
"SetCurrentSetpoint", {NewCurrentSetpoint = "68"},
19)
</source>

==== Change the Temperature on a Thermostat (Heat) device #19 ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:TemperatureSetpoint1_Heat",
"SetCurrentSetpoint", {NewCurrentSetpoint = "68"},
19)
</source>

==== Change the Thermostat Operating mode device #19 ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:HVAC_UserOperatingMode1",
"SetModeTarget", {NewModeTarget = "Off"},
19)
</source>

 

=== Camera Actions ===

==== 'Privacy' mode for Foscam FI8908[w] ====

<source lang="lua">
local IP_address = '<IP address of camera>'
local username = '<username>'
local password = '<password>'
local timeout = 5

function move_up()
luup.inet.wget('http://' .. IP_address .. '/decoder_control.cgi?command=0', timeout, username, password)
end

-- center the camera; takes some time, so we have to wait 2 minutes for the command to complete

luup.inet.wget('http://' .. IP_address .. '/decoder_control.cgi?command=25', timeout, username, password)

luup.call_delay('move_up', 120)
</source>

=== Misc Actions ===

==== Playing an announcement ====

http://forum.micasaverde.com/index.php?topic=5466.msg36405#msg36405

=== Calculate sunrise and sunset ===

See http://forum.micasaverde.com/index.php?topic=2073.msg8132#msg8132

... or use DAD: http://forum.micasaverde.com/index.php?topic=5466.0

=== Access the web ===

==== Invoke HTTP URL with <tt>GET</tt> request (Method 1) ====

<source lang="lua">
-- 5 Second timeout
local status, result = luup.inet.wget("http://www.yahoo.com", 5)
</source>

==== Invoke HTTP URL with <tt>GET</tt> request (Method 2) ====

Based on code by Jim/jgc94131 <source lang="lua">
require('ltn12')
local http = require('socket.http')

-- 5 Second timeout
socket.http.TIMEOUT = 5

local response_body = {}
local request_body = ''

local r, c, h = socket.http.request{
url = 'http://website/page?parameter1=value&parameter2=value',
method = "GET",
port = 80,
headers = {
["Content-Length"] = string.len(request_body),
["Content-Type"] = "application/x-www-form-urlencoded"
},
source = ltn12.source.string(request_body),
sink = ltn12.sink.table(response_body)
}
</source>

==== Invoke HTTP URL with <tt>POST</tt> request (Method 3) ====

<source lang="lua">
local http = require("socket.http")

-- 5 Second timeout
http.TIMEOUT = 5

-- The return parameters are in a different order from luup.inet.wget(...)
result, status = http.request("http://192.168.0.113/runprocess.htm", "run=run")
</source>

=== Access the current time ===

The Lua function

<source lang="lua">
os.date (format, time)
</source>

converts a time value `time` into a human readable date/time string, according to `format`. If you leave out the optional `time` parameter, it defaults to current time. The `format` parameter defaults to a fairly complete format. If you specify '*t' as the format, it will return a table instead of a formatted string.

<source lang="lua">
t = os.date('*t')
t = {year=2010, month=2, day=19, yday=50, wday=6, hour=22, min=45, sec=45, isdst=false}
</source>

The fields are year, month, day of month, day of year, day of week, hour in 24 hour clock, minutes, seconds and if it's Daylight Savings Time.

Current hour:

<source lang="lua">
os.date('*t').hour
</source>

Current minute:

<source lang="lua">
os.date('*t').min
</source>

Current second:

<source lang="lua">
os.date('*t').sec
</source>

Do something between 16:00 and 21:15:

<source lang="lua">
local t = os.date('*t')
local current_second = t.hour * 3600 + t.min * 60 + t.sec -- number of seconds since midnight
local min_time_in_seconds = 16 * 3600 + 0 * 60 -- 16:00
local max_time_in_seconds = 21 * 3600 + 15 * 60 -- 21:15

if (current_second > min_time_in_seconds) and (current_second < max_time_in_seconds) then
-- do something
else
return false
end
</source>

See http://forum.micasaverde.com/index.php?topic=2015.0 and http://www.lua.org/manual/5.1/manual.html#5.8.

=== Set Z-Wave parameters ===

See http://forum.micasaverde.com/index.php?topic=1937.msg7803#msg7803

=== a scene if the temperature is outside of a range ===

add snippets here...

=== Reload Luup at 3 AM every day ===

1. Create a scene and set it to run daily at 3 AM.

2. Add this code in the '''Luup code''' box:

<source lang="lua">luup.call_action("urn:micasaverde-com:serviceId:HomeAutomationGateway1", "Reload", {}, 0)</source>

3. Save.

=== Thermostat conditioned by door/window ===
Turn off the thermostat if the door/window is left open for 5 minutes or more and back on if the door/window is closed for 10 minutes or more.

'''1.''' Create a scene and set it to run when the door is opened.

'''2.''' Add this code in the '''Luup code''' box:
<source lang="lua">
local SENSOR = 17 -- The door/window sensor device number
local THERMOSTAT = 3 -- The thermostat device number
local DELAY = 300 -- Seconds

local SES_SID = "urn:micasaverde-com:serviceId:SecuritySensor1"
local HVACO_SID = "urn:upnp-org:serviceId:HVAC_UserOperatingMode1"

luup.call_delay( "turnOffAc", DELAY)

-- Turn off the thermostat if the sensor has been tripped for at least 5 minutes.
function turnOffAc()
local tripped = luup.variable_get( SES_SID, "Tripped", SENSOR) or "0"
local lastTrip = luup.variable_get( SES_SID, "LastTrip", SENSOR) or os.time()
if (tripped == "1" and (os.time() - lastTrip >= DELAY)) then
local modeStatus = luup.variable_get( HVACO_SID, "ModeStatus", THERMOSTAT) or "Off"
luup.variable_set( HVACO_SID, "LastModeStatus", modeStatus, THERMOSTAT)
luup.call_action( HVACO_SID, "SetModeTarget", {NewModeTarget = "Off"}, THERMOSTAT)
end
end
</source>

'''3.''' Create another scene and set it to run when the door is closed.

'''4.''' Add this code in the '''Luup code''' box:
<source lang="lua">
local SENSOR = 17 -- The door/window sensor device number
local THERMOSTAT = 3 -- The thermostat device number
local DELAY = 600 -- Seconds

local SES_SID = "urn:micasaverde-com:serviceId:SecuritySensor1"
local HVACO_SID = "urn:upnp-org:serviceId:HVAC_UserOperatingMode1"

luup.call_delay( "turnOnAc", DELAY)

-- Turn on the thermostat if the sensor hasn't been tripped in the past 10 minutes.
function turnOnAc()
local tripped = luup.variable_get( SES_SID, "Tripped", DOOR_SENSOR) or "0"
local lastTrip = luup.variable_get( SES_SID, "LastTrip", DOOR_SENSOR) or os.time()
if (tripped == "0" and (os.time() - lastTrip >= DELAY)) then
local lastModeStatus = luup.variable_get( HVACO_SID, "LastModeStatus", THERMOSTAT) or "Off"
luup.call_action( HVACO_SID, "SetModeTarget", {NewModeTarget = lastModeStatus}, THERMOSTAT)
end
end
</source>

'''5.''' Save.

[[Category:Development]]

Luup Scenes Events

2012-09-09T12:23:02Z

Solipsia: /* ==Switch on, and switch off 2 seconds later == */

== Adding Lua code to scenes and events ==

[[Image:SceneFlowchart.png]]

You can add Lua script to scenes and events for simple tasks, like making a scene or event conditional. Conditional meaning "do something only '''if''' some condition is met", such as attaching a condition to your "Come Home" scene so it is only run '''if''' the temperature is over 70 degrees. Basic conditional expressions are easy, and, if that's all you're looking to do, skip to the walk-through below.

If you're more technically inclined you can also do very advanced things too. For an overview of all the advanced things you can do with Vera's Luup engine, and how scenes and events fit in, see the [[Luup Intro]] page.

To add Lua code to a scene, create the [[Scenes]] and click 'Luup scene'. Fill in your Lua code in the input box. To do a simple condition, see the sample below. Or if you want to do advanced scripting you can use any [[http://lua.org Lua]] commands as described in the [[http://www.lua.org/manual/5.1/ Lua reference manual]] as well as the variables and functions that the Luup engine adds to Lua documented here: [[Luup Lua extensions]]. The Lua code will be run every time the scene is activated either by the user or a scene or a timer. The Lua code is run before the commands that you included in the scene. If your Lua code ends with this: "return false" then the commands in the scene will not be run.

You can also add Lua code to an event by clicking 'Luup event'. Since events are attached to scenes anyway, there is usually little difference between adding the code to an event, or to the scene the event is part of. If the Lua code in an event returns false, then the event is aborted, meaning the scene that the event is attached to will not be triggered by the event. The main reason for attaching Lua code to an event is if you have multiple events to a scene. For example, you may have a scene called "Turn lights on in hallway" which is triggered by 2 events: 1) The front door opens, and 2) the motion sensor in the hallway is tripped. Perhaps whenever the front door opens you always want the scene to be activated, but you only want the motion sensor to activate the scene before 10:00. In this case, you would add Lua code to the motion sensor's event which does something like (pseudo-code): "if time>10:00 return false". That way the event from the motion sensor will be aborted if it's after 10:00, but the event from the front door will always activate the scene regardless.

When you edit the Lua code in a scene or event you must click 'Save' before the code is saved. Then you can activate the scene or trigger the event to see what happens when your code is run. If you're doing some advanced scripting that you'll need to debug this can be tedious, but there are easy ways to test your Lua script immediately without saving first as explained in [[Lua Debugging]].

If you're doing advanced Lua scripting, you should note that all the Lua code in your scenes and events run in a single Lua instance, which is separate from any Lua plugins. This means if you set a global variable in one scene, or create a function inside the Lua code in a scene, then in another scene's Lua code you can use that global variable or call that function. You do not need to worry about conflicting with a Luup plugin, though, since they have their own Lua instance, meaning they have their own global variables and functions.

== Walk-through #1 -- At 12 noon, turn off the interior lights if the temperature is over 80 degrees ==

Before you start, in Vera's setup interface go to 'Devices' and click the '+' button next to the thermostat. Make note of the Device #.

In this walkthrough we'll assume it's Device #3, but use the actual device number of''your'' thermostat. Next, visit [[Luup Variables]] to get a list of all the variables for devices. A variable is a piece of information about the current state of a device, such as whether it's on or off, it's current temperature, etc.

Look down at ''Thermostat'', and copy the name of the service/variable which corresponds to the current temperature, namely. In this case, it's

urn:upnp-org:serviceId:TemperatureSensor1 CurrentTemperature

Notice that it states the <tt>CurrentTemperature</tt> is in Celsius. So type in "80 degrees Fahrenheit to Celsius" in Google and you'll see that it's 26.6 degrees Celsius.

Now, the first step is to create the scene that turns off the lights. In Vera's setup interface, click 'Scenes', and click 'Add Scene' to add a new scene to one of the rooms. It's not important which room you choose. Scenes are categorized in rooms just to help you keep track of them if you have a lot of scenes. You can also put the scene in 'Global Scenes', or, you can create dummy rooms on the 'Rooms' tab if you want to have more "rooms" to organize your scenes with. After you click 'Add Scene', type in a description to remember your scene by, such as "Lights off 12:00 if 80". Under the 'Commands' area you'll see all the rooms. Click '+' next to the rooms that have lights you want to control, and choose "Off" in the pull-down. At this point, you have a normal scene, and, if you were to save your changes now, whenever you click the scene on the dashboard or on a remote control, the lights should turn off.

Second, next to the scene's description click 'add timer'. You can give the timer a description too so that if you have multiple timers you can see in the logs which one is activating the scene. Choose "Day of week based". If you want this scene to only run on certain days of the week, just check off which days you want this scene to run on. Otherwise, you can leave them all unchecked (or check them all) to do it every day. Leave the pull-down at "a certain time of day", and choose 12 : 00 : 00 from the pull-downs. At this point, if you were to save your changes, the lights would turn off automatically at 12 noon.

Third, the last step is to add the condition. To the right of the scene's description you'll see the button "Luup Scene". Click it and in the code box, copy and paste the following:

<source lang="lua">
local lul_temp = luup.variable_get("urn:upnp-org:serviceId:TemperatureSensor1","CurrentTemperature", 3)
if (tonumber(lul_temp) < 26.6) then
return false
end
</source>

Don't forget to change the "3" to whatever is the actual device number of your thermostat. Assign the result of <tt>luup.variable_get</tt> to a variable first, rather than putting it directly in the <tt>tonumber()</tt>, because <tt>luup.variable_get</tt> actually returns 2 values: the value of the variable, and the time when the variable was modified. The '<tt>tonumber</tt>' is needed because all of a device's variables are stored as plain text--not numbers--so if you want to do arithmetic or numeric comparison of a variable, you need to put <tt>tonumber()</tt> around <tt>luup.variable_get</tt>.

<tt>luup.variable_get</tt> is documented in [[Luup Lua extensions]].

Now click 'Update', and then click 'Save' to save everything. The "return false" means "don't run this scene". So if the current temperature is <26.6, the scene will be aborted and won't run. The timer will make it trigger every day at 12 noon.

To test it, you can click the scene button on the dashboard. The lights will turn off only if the temperature is over 80 degrees. If it's less than 80 degrees, the scene won't do anything. Since this scene is something that happens automatically and you probably won't execute manually, you can go to the scene again and check the "Hidden" box so the scene doesn't show up on Vera's 'Dashboard' and on your remote controls, like the iPhone. If you want to have a scene that turns off the lights which you can run whenever you want from 'Dashboard''or your remote control, you should create another scene that has the same commands and simply don't add the timers and Luup conditions, and don't check the "Hidden" box. ''

You can substitute other service/variables and device ID's to make other types of conditions. The "if" statement above also supports nesting with ( and ), as well as the keywords 'and' and 'or'. So the following means the scene would abort if the temperature is <26.6 and >25, unless it's <23:

<source lang="lua">
local lul_temp = luup.variable_get("urn:upnp-org:serviceId:TemperatureSensor1","CurrentTemperature", 3)
if ((tonumber(lul_temp) < 26.6
and tonumber(lul_temp) > 25)
or tonumber(lul_temp) < 23) then
return false
end
</source>

If the scene doesn't run, it's possible there is a syntax error. The easiest way to test this is to copy the Lua code from the scene, then go to Devices, Luup Plugins, and "Test Luup code". Paste the code in the box and click 'go'. If the info box above the 'go' button has a check and says "Message sent successful", your code is okay. If there's an error, it says: "Code failed".

To see if that's true, use putty, or telnet or ssh to log-in to Vera, as explained in detail in [[Logon_Vera_SSH]] and [[Lua Debugging]], and type:

cd /var/log/cmh
tail -f LuaUPnP.log | grep '^01'

Now click 'Save' in Vera's setup page, even if it's gray, as that will cause Vera to restart the Luup engine and log any syntax errors. See: [[Lua Debugging]] for in-depth details on how to debug.

== Walk-through #2 -- Only run the scene during the daytime ==

In the Luup tab for the scene paste this:

<source lang="lua">
return luup.is_night() == false
</source>

That works because if the return is 'true' the scene runs, and if it's 'false' it doesn't. So during the daytime the expression is true. Or, an alternative long form:

<source lang="lua">
if (luup.is_night()) then
return false
else
return true
end
</source>

== Samples ==

This page is a wiki which anyone can edit. If you have some Lua code you think other users might find useful, feel free to add it here.

=== Lighting and Switch Actions ===

Did you see the sample here already: http://wiki.micasaverde.com/index.php/Luup_Scenes_Events

==== Turn an appliance switch or a Danfoss thermostat on for device #5 ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:SwitchPower1", "SetTarget", {newTargetValue = "1"}, 5)
</source>

==== Turn an appliance switch or a Danfoss thermostat off ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:SwitchPower1", "SetTarget", {newTargetValue = "0"}, 5)
</source>

==== Do something if switch device #5 is on ====

<source lang="lua">
local lul_tmp = luup.variable_get("urn:upnp-org:serviceId:SwitchPower1", "Status", 5)
if (lul_tmp == "1") then
--something to do goes here
end
</source>

==== Dim switch #6 to 30% ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:Dimming1", "SetLoadLevelTarget", {newLoadlevelTarget = "30"}, 6)
</source>

====Switch on, and switch off 2 seconds later ====
<source lang="lua">
local device = 29
luup.call_action("urn:upnp-org:serviceId:SwitchPower1","SetTarget",{ newTargetValue="1" },device)
luup.call_delay( 'switch_off', 2) -- Call this function after a delay of 2 seconds
function switch_off()
luup.call_action("urn:upnp-org:serviceId:SwitchPower1","SetTarget",{ newTargetValue="0" },device)
end
</source>

==== Blinking lights (and how to delay for a number of seconds) ====

http://forum.micasaverde.com/index.php?topic=5127.0

=== Motion Sensor Actions ===

==== Arm motion sensor #7 ====

<source lang="lua">
luup.variable_set("urn:micasaverde-com:serviceId:SecuritySensor1", "Armed", "1", 7)
</source>

==== Disarm motion sensor #7 ====

<source lang="lua">
luup.variable_set("urn:micasaverde-com:serviceId:SecuritySensor1", "Armed", "0", 7)
</source>

Note, arming and disarming isn't a concept within UPnP or Z-Wave. It's just a flag that the Luup engine uses, and is stored in a variable we created called "Armed".

=== Scene Actions ===

==== Run Scene #5 ====

Thanks "denix" on the forum for the correct syntax. "Actually, the 4th parameter IS required, but it's not used. Otherwise the command fails with an error message"

<source lang="lua">
luup.call_action("urn:micasaverde-com:serviceId:HomeAutomationGateway1", "RunScene", {SceneNum = "5"}, 0)
</source>

In this case we left the device number off (the 4th parameter to <tt>luup.call_action</tt>), because the "<tt>RunScene</tt>" action is handled by the Luup engine itself--not by some device within Z-Wave, etc.

However, normally you don't need to <tt>luup.call_action</tt> in Lua code. Rather, whatever actions, or commands, you want to run, you put into the scene itself, and the only Lua code is to simply check if some condition is true and abort the scene if the condition isn't met.

=== Thermostat Actions ===

==== Change the Temperature on Thermostat (Cool) device #19 ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:TemperatureSetpoint1_Cool",
"SetCurrentSetpoint", {NewCurrentSetpoint = "68"},
19)
</source>

==== Change the Temperature on a Thermostat (Heat) device #19 ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:TemperatureSetpoint1_Heat",
"SetCurrentSetpoint", {NewCurrentSetpoint = "68"},
19)
</source>

==== Change the Thermostat Operating mode device #19 ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:HVAC_UserOperatingMode1",
"SetModeTarget", {NewModeTarget = "Off"},
19)
</source>

 

=== Camera Actions ===

==== 'Privacy' mode for Foscam FI8908[w] ====

<source lang="lua">
local IP_address = '<IP address of camera>'
local username = '<username>'
local password = '<password>'
local timeout = 5

function move_up()
luup.inet.wget('http://' .. IP_address .. '/decoder_control.cgi?command=0', timeout, username, password)
end

-- center the camera; takes some time, so we have to wait 2 minutes for the command to complete

luup.inet.wget('http://' .. IP_address .. '/decoder_control.cgi?command=25', timeout, username, password)

luup.call_delay('move_up', 120)
</source>

=== Misc Actions ===

==== Playing an announcement ====

http://forum.micasaverde.com/index.php?topic=5466.msg36405#msg36405

=== Calculate sunrise and sunset ===

See http://forum.micasaverde.com/index.php?topic=2073.msg8132#msg8132

... or use DAD: http://forum.micasaverde.com/index.php?topic=5466.0

=== Access the web ===

==== Invoke HTTP URL with <tt>GET</tt> request (Method 1) ====

<source lang="lua">
-- 5 Second timeout
local status, result = luup.inet.wget("http://www.yahoo.com", 5)
</source>

==== Invoke HTTP URL with <tt>GET</tt> request (Method 2) ====

Based on code by Jim/jgc94131 <source lang="lua">
require('ltn12')
local http = require('socket.http')

-- 5 Second timeout
socket.http.TIMEOUT = 5

local response_body = {}
local request_body = ''

local r, c, h = socket.http.request{
url = 'http://website/page?parameter1=value&parameter2=value',
method = "GET",
port = 80,
headers = {
["Content-Length"] = string.len(request_body),
["Content-Type"] = "application/x-www-form-urlencoded"
},
source = ltn12.source.string(request_body),
sink = ltn12.sink.table(response_body)
}
</source>

==== Invoke HTTP URL with <tt>POST</tt> request (Method 3) ====

<source lang="lua">
local http = require("socket.http")

-- 5 Second timeout
http.TIMEOUT = 5

-- The return parameters are in a different order from luup.inet.wget(...)
result, status = http.request("http://192.168.0.113/runprocess.htm", "run=run")
</source>

=== Access the current time ===

The Lua function

<source lang="lua">
os.date (format, time)
</source>

converts a time value `time` into a human readable date/time string, according to `format`. If you leave out the optional `time` parameter, it defaults to current time. The `format` parameter defaults to a fairly complete format. If you specify '*t' as the format, it will return a table instead of a formatted string.

<source lang="lua">
t = os.date('*t')
t = {year=2010, month=2, day=19, yday=50, wday=6, hour=22, min=45, sec=45, isdst=false}
</source>

The fields are year, month, day of month, day of year, day of week, hour in 24 hour clock, minutes, seconds and if it's Daylight Savings Time.

Current hour:

<source lang="lua">
os.date('*t').hour
</source>

Current minute:

<source lang="lua">
os.date('*t').min
</source>

Current second:

<source lang="lua">
os.date('*t').sec
</source>

Do something between 16:00 and 21:15:

<source lang="lua">
local t = os.date('*t')
local current_second = t.hour * 3600 + t.min * 60 + t.sec -- number of seconds since midnight
local min_time_in_seconds = 16 * 3600 + 0 * 60 -- 16:00
local max_time_in_seconds = 21 * 3600 + 15 * 60 -- 21:15

if (current_second > min_time_in_seconds) and (current_second < max_time_in_seconds) then
-- do something
else
return false
end
</source>

See http://forum.micasaverde.com/index.php?topic=2015.0 and http://www.lua.org/manual/5.1/manual.html#5.8.

=== Set Z-Wave parameters ===

See http://forum.micasaverde.com/index.php?topic=1937.msg7803#msg7803

=== a scene if the temperature is outside of a range ===

add snippets here...

=== Reload Luup at 3 AM every day ===

1. Create a scene and set it to run daily at 3 AM.

2. Add this code in the '''Luup code''' box:

<source lang="lua">luup.call_action("urn:micasaverde-com:serviceId:HomeAutomationGateway1", "Reload", {}, 0)</source>

3. Save.

=== Thermostat conditioned by door/window ===
Turn off the thermostat if the door/window is left open for 5 minutes or more and back on if the door/window is closed for 10 minutes or more.

'''1.''' Create a scene and set it to run when the door is opened.

'''2.''' Add this code in the '''Luup code''' box:
<source lang="lua">
local SENSOR = 17 -- The door/window sensor device number
local THERMOSTAT = 3 -- The thermostat device number
local DELAY = 300 -- Seconds

local SES_SID = "urn:micasaverde-com:serviceId:SecuritySensor1"
local HVACO_SID = "urn:upnp-org:serviceId:HVAC_UserOperatingMode1"

luup.call_delay( "turnOffAc", DELAY)

-- Turn off the thermostat if the sensor has been tripped for at least 5 minutes.
function turnOffAc()
local tripped = luup.variable_get( SES_SID, "Tripped", SENSOR) or "0"
local lastTrip = luup.variable_get( SES_SID, "LastTrip", SENSOR) or os.time()
if (tripped == "1" and (os.time() - lastTrip >= DELAY)) then
local modeStatus = luup.variable_get( HVACO_SID, "ModeStatus", THERMOSTAT) or "Off"
luup.variable_set( HVACO_SID, "LastModeStatus", modeStatus, THERMOSTAT)
luup.call_action( HVACO_SID, "SetModeTarget", {NewModeTarget = "Off"}, THERMOSTAT)
end
end
</source>

'''3.''' Create another scene and set it to run when the door is closed.

'''4.''' Add this code in the '''Luup code''' box:
<source lang="lua">
local SENSOR = 17 -- The door/window sensor device number
local THERMOSTAT = 3 -- The thermostat device number
local DELAY = 600 -- Seconds

local SES_SID = "urn:micasaverde-com:serviceId:SecuritySensor1"
local HVACO_SID = "urn:upnp-org:serviceId:HVAC_UserOperatingMode1"

luup.call_delay( "turnOnAc", DELAY)

-- Turn on the thermostat if the sensor hasn't been tripped in the past 10 minutes.
function turnOnAc()
local tripped = luup.variable_get( SES_SID, "Tripped", DOOR_SENSOR) or "0"
local lastTrip = luup.variable_get( SES_SID, "LastTrip", DOOR_SENSOR) or os.time()
if (tripped == "0" and (os.time() - lastTrip >= DELAY)) then
local lastModeStatus = luup.variable_get( HVACO_SID, "LastModeStatus", THERMOSTAT) or "Off"
luup.call_action( HVACO_SID, "SetModeTarget", {NewModeTarget = lastModeStatus}, THERMOSTAT)
end
end
</source>

'''5.''' Save.

[[Category:Development]]

Luup Scenes Events

2012-09-09T12:22:49Z

Solipsia: /* Switch on, and switch off 2 seconds later */

== Adding Lua code to scenes and events ==

[[Image:SceneFlowchart.png]]

You can add Lua script to scenes and events for simple tasks, like making a scene or event conditional. Conditional meaning "do something only '''if''' some condition is met", such as attaching a condition to your "Come Home" scene so it is only run '''if''' the temperature is over 70 degrees. Basic conditional expressions are easy, and, if that's all you're looking to do, skip to the walk-through below.

If you're more technically inclined you can also do very advanced things too. For an overview of all the advanced things you can do with Vera's Luup engine, and how scenes and events fit in, see the [[Luup Intro]] page.

To add Lua code to a scene, create the [[Scenes]] and click 'Luup scene'. Fill in your Lua code in the input box. To do a simple condition, see the sample below. Or if you want to do advanced scripting you can use any [[http://lua.org Lua]] commands as described in the [[http://www.lua.org/manual/5.1/ Lua reference manual]] as well as the variables and functions that the Luup engine adds to Lua documented here: [[Luup Lua extensions]]. The Lua code will be run every time the scene is activated either by the user or a scene or a timer. The Lua code is run before the commands that you included in the scene. If your Lua code ends with this: "return false" then the commands in the scene will not be run.

You can also add Lua code to an event by clicking 'Luup event'. Since events are attached to scenes anyway, there is usually little difference between adding the code to an event, or to the scene the event is part of. If the Lua code in an event returns false, then the event is aborted, meaning the scene that the event is attached to will not be triggered by the event. The main reason for attaching Lua code to an event is if you have multiple events to a scene. For example, you may have a scene called "Turn lights on in hallway" which is triggered by 2 events: 1) The front door opens, and 2) the motion sensor in the hallway is tripped. Perhaps whenever the front door opens you always want the scene to be activated, but you only want the motion sensor to activate the scene before 10:00. In this case, you would add Lua code to the motion sensor's event which does something like (pseudo-code): "if time>10:00 return false". That way the event from the motion sensor will be aborted if it's after 10:00, but the event from the front door will always activate the scene regardless.

When you edit the Lua code in a scene or event you must click 'Save' before the code is saved. Then you can activate the scene or trigger the event to see what happens when your code is run. If you're doing some advanced scripting that you'll need to debug this can be tedious, but there are easy ways to test your Lua script immediately without saving first as explained in [[Lua Debugging]].

If you're doing advanced Lua scripting, you should note that all the Lua code in your scenes and events run in a single Lua instance, which is separate from any Lua plugins. This means if you set a global variable in one scene, or create a function inside the Lua code in a scene, then in another scene's Lua code you can use that global variable or call that function. You do not need to worry about conflicting with a Luup plugin, though, since they have their own Lua instance, meaning they have their own global variables and functions.

== Walk-through #1 -- At 12 noon, turn off the interior lights if the temperature is over 80 degrees ==

Before you start, in Vera's setup interface go to 'Devices' and click the '+' button next to the thermostat. Make note of the Device #.

In this walkthrough we'll assume it's Device #3, but use the actual device number of''your'' thermostat. Next, visit [[Luup Variables]] to get a list of all the variables for devices. A variable is a piece of information about the current state of a device, such as whether it's on or off, it's current temperature, etc.

Look down at ''Thermostat'', and copy the name of the service/variable which corresponds to the current temperature, namely. In this case, it's

urn:upnp-org:serviceId:TemperatureSensor1 CurrentTemperature

Notice that it states the <tt>CurrentTemperature</tt> is in Celsius. So type in "80 degrees Fahrenheit to Celsius" in Google and you'll see that it's 26.6 degrees Celsius.

Now, the first step is to create the scene that turns off the lights. In Vera's setup interface, click 'Scenes', and click 'Add Scene' to add a new scene to one of the rooms. It's not important which room you choose. Scenes are categorized in rooms just to help you keep track of them if you have a lot of scenes. You can also put the scene in 'Global Scenes', or, you can create dummy rooms on the 'Rooms' tab if you want to have more "rooms" to organize your scenes with. After you click 'Add Scene', type in a description to remember your scene by, such as "Lights off 12:00 if 80". Under the 'Commands' area you'll see all the rooms. Click '+' next to the rooms that have lights you want to control, and choose "Off" in the pull-down. At this point, you have a normal scene, and, if you were to save your changes now, whenever you click the scene on the dashboard or on a remote control, the lights should turn off.

Second, next to the scene's description click 'add timer'. You can give the timer a description too so that if you have multiple timers you can see in the logs which one is activating the scene. Choose "Day of week based". If you want this scene to only run on certain days of the week, just check off which days you want this scene to run on. Otherwise, you can leave them all unchecked (or check them all) to do it every day. Leave the pull-down at "a certain time of day", and choose 12 : 00 : 00 from the pull-downs. At this point, if you were to save your changes, the lights would turn off automatically at 12 noon.

Third, the last step is to add the condition. To the right of the scene's description you'll see the button "Luup Scene". Click it and in the code box, copy and paste the following:

<source lang="lua">
local lul_temp = luup.variable_get("urn:upnp-org:serviceId:TemperatureSensor1","CurrentTemperature", 3)
if (tonumber(lul_temp) < 26.6) then
return false
end
</source>

Don't forget to change the "3" to whatever is the actual device number of your thermostat. Assign the result of <tt>luup.variable_get</tt> to a variable first, rather than putting it directly in the <tt>tonumber()</tt>, because <tt>luup.variable_get</tt> actually returns 2 values: the value of the variable, and the time when the variable was modified. The '<tt>tonumber</tt>' is needed because all of a device's variables are stored as plain text--not numbers--so if you want to do arithmetic or numeric comparison of a variable, you need to put <tt>tonumber()</tt> around <tt>luup.variable_get</tt>.

<tt>luup.variable_get</tt> is documented in [[Luup Lua extensions]].

Now click 'Update', and then click 'Save' to save everything. The "return false" means "don't run this scene". So if the current temperature is <26.6, the scene will be aborted and won't run. The timer will make it trigger every day at 12 noon.

To test it, you can click the scene button on the dashboard. The lights will turn off only if the temperature is over 80 degrees. If it's less than 80 degrees, the scene won't do anything. Since this scene is something that happens automatically and you probably won't execute manually, you can go to the scene again and check the "Hidden" box so the scene doesn't show up on Vera's 'Dashboard' and on your remote controls, like the iPhone. If you want to have a scene that turns off the lights which you can run whenever you want from 'Dashboard''or your remote control, you should create another scene that has the same commands and simply don't add the timers and Luup conditions, and don't check the "Hidden" box. ''

You can substitute other service/variables and device ID's to make other types of conditions. The "if" statement above also supports nesting with ( and ), as well as the keywords 'and' and 'or'. So the following means the scene would abort if the temperature is <26.6 and >25, unless it's <23:

<source lang="lua">
local lul_temp = luup.variable_get("urn:upnp-org:serviceId:TemperatureSensor1","CurrentTemperature", 3)
if ((tonumber(lul_temp) < 26.6
and tonumber(lul_temp) > 25)
or tonumber(lul_temp) < 23) then
return false
end
</source>

If the scene doesn't run, it's possible there is a syntax error. The easiest way to test this is to copy the Lua code from the scene, then go to Devices, Luup Plugins, and "Test Luup code". Paste the code in the box and click 'go'. If the info box above the 'go' button has a check and says "Message sent successful", your code is okay. If there's an error, it says: "Code failed".

To see if that's true, use putty, or telnet or ssh to log-in to Vera, as explained in detail in [[Logon_Vera_SSH]] and [[Lua Debugging]], and type:

cd /var/log/cmh
tail -f LuaUPnP.log | grep '^01'

Now click 'Save' in Vera's setup page, even if it's gray, as that will cause Vera to restart the Luup engine and log any syntax errors. See: [[Lua Debugging]] for in-depth details on how to debug.

== Walk-through #2 -- Only run the scene during the daytime ==

In the Luup tab for the scene paste this:

<source lang="lua">
return luup.is_night() == false
</source>

That works because if the return is 'true' the scene runs, and if it's 'false' it doesn't. So during the daytime the expression is true. Or, an alternative long form:

<source lang="lua">
if (luup.is_night()) then
return false
else
return true
end
</source>

== Samples ==

This page is a wiki which anyone can edit. If you have some Lua code you think other users might find useful, feel free to add it here.

=== Lighting and Switch Actions ===

Did you see the sample here already: http://wiki.micasaverde.com/index.php/Luup_Scenes_Events

==== Turn an appliance switch or a Danfoss thermostat on for device #5 ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:SwitchPower1", "SetTarget", {newTargetValue = "1"}, 5)
</source>

==== Turn an appliance switch or a Danfoss thermostat off ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:SwitchPower1", "SetTarget", {newTargetValue = "0"}, 5)
</source>

==== Do something if switch device #5 is on ====

<source lang="lua">
local lul_tmp = luup.variable_get("urn:upnp-org:serviceId:SwitchPower1", "Status", 5)
if (lul_tmp == "1") then
--something to do goes here
end
</source>

==== Dim switch #6 to 30% ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:Dimming1", "SetLoadLevelTarget", {newLoadlevelTarget = "30"}, 6)
</source>

== ==Switch on, and switch off 2 seconds later ====
<source lang="lua">
local device = 29
luup.call_action("urn:upnp-org:serviceId:SwitchPower1","SetTarget",{ newTargetValue="1" },device)
luup.call_delay( 'switch_off', 2) -- Call this function after a delay of 2 seconds
function switch_off()
luup.call_action("urn:upnp-org:serviceId:SwitchPower1","SetTarget",{ newTargetValue="0" },device)
end
</source>

==== Blinking lights (and how to delay for a number of seconds) ====

http://forum.micasaverde.com/index.php?topic=5127.0

=== Motion Sensor Actions ===

==== Arm motion sensor #7 ====

<source lang="lua">
luup.variable_set("urn:micasaverde-com:serviceId:SecuritySensor1", "Armed", "1", 7)
</source>

==== Disarm motion sensor #7 ====

<source lang="lua">
luup.variable_set("urn:micasaverde-com:serviceId:SecuritySensor1", "Armed", "0", 7)
</source>

Note, arming and disarming isn't a concept within UPnP or Z-Wave. It's just a flag that the Luup engine uses, and is stored in a variable we created called "Armed".

=== Scene Actions ===

==== Run Scene #5 ====

Thanks "denix" on the forum for the correct syntax. "Actually, the 4th parameter IS required, but it's not used. Otherwise the command fails with an error message"

<source lang="lua">
luup.call_action("urn:micasaverde-com:serviceId:HomeAutomationGateway1", "RunScene", {SceneNum = "5"}, 0)
</source>

In this case we left the device number off (the 4th parameter to <tt>luup.call_action</tt>), because the "<tt>RunScene</tt>" action is handled by the Luup engine itself--not by some device within Z-Wave, etc.

However, normally you don't need to <tt>luup.call_action</tt> in Lua code. Rather, whatever actions, or commands, you want to run, you put into the scene itself, and the only Lua code is to simply check if some condition is true and abort the scene if the condition isn't met.

=== Thermostat Actions ===

==== Change the Temperature on Thermostat (Cool) device #19 ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:TemperatureSetpoint1_Cool",
"SetCurrentSetpoint", {NewCurrentSetpoint = "68"},
19)
</source>

==== Change the Temperature on a Thermostat (Heat) device #19 ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:TemperatureSetpoint1_Heat",
"SetCurrentSetpoint", {NewCurrentSetpoint = "68"},
19)
</source>

==== Change the Thermostat Operating mode device #19 ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:HVAC_UserOperatingMode1",
"SetModeTarget", {NewModeTarget = "Off"},
19)
</source>

 

=== Camera Actions ===

==== 'Privacy' mode for Foscam FI8908[w] ====

<source lang="lua">
local IP_address = '<IP address of camera>'
local username = '<username>'
local password = '<password>'
local timeout = 5

function move_up()
luup.inet.wget('http://' .. IP_address .. '/decoder_control.cgi?command=0', timeout, username, password)
end

-- center the camera; takes some time, so we have to wait 2 minutes for the command to complete

luup.inet.wget('http://' .. IP_address .. '/decoder_control.cgi?command=25', timeout, username, password)

luup.call_delay('move_up', 120)
</source>

=== Misc Actions ===

==== Playing an announcement ====

http://forum.micasaverde.com/index.php?topic=5466.msg36405#msg36405

=== Calculate sunrise and sunset ===

See http://forum.micasaverde.com/index.php?topic=2073.msg8132#msg8132

... or use DAD: http://forum.micasaverde.com/index.php?topic=5466.0

=== Access the web ===

==== Invoke HTTP URL with <tt>GET</tt> request (Method 1) ====

<source lang="lua">
-- 5 Second timeout
local status, result = luup.inet.wget("http://www.yahoo.com", 5)
</source>

==== Invoke HTTP URL with <tt>GET</tt> request (Method 2) ====

Based on code by Jim/jgc94131 <source lang="lua">
require('ltn12')
local http = require('socket.http')

-- 5 Second timeout
socket.http.TIMEOUT = 5

local response_body = {}
local request_body = ''

local r, c, h = socket.http.request{
url = 'http://website/page?parameter1=value&parameter2=value',
method = "GET",
port = 80,
headers = {
["Content-Length"] = string.len(request_body),
["Content-Type"] = "application/x-www-form-urlencoded"
},
source = ltn12.source.string(request_body),
sink = ltn12.sink.table(response_body)
}
</source>

==== Invoke HTTP URL with <tt>POST</tt> request (Method 3) ====

<source lang="lua">
local http = require("socket.http")

-- 5 Second timeout
http.TIMEOUT = 5

-- The return parameters are in a different order from luup.inet.wget(...)
result, status = http.request("http://192.168.0.113/runprocess.htm", "run=run")
</source>

=== Access the current time ===

The Lua function

<source lang="lua">
os.date (format, time)
</source>

converts a time value `time` into a human readable date/time string, according to `format`. If you leave out the optional `time` parameter, it defaults to current time. The `format` parameter defaults to a fairly complete format. If you specify '*t' as the format, it will return a table instead of a formatted string.

<source lang="lua">
t = os.date('*t')
t = {year=2010, month=2, day=19, yday=50, wday=6, hour=22, min=45, sec=45, isdst=false}
</source>

The fields are year, month, day of month, day of year, day of week, hour in 24 hour clock, minutes, seconds and if it's Daylight Savings Time.

Current hour:

<source lang="lua">
os.date('*t').hour
</source>

Current minute:

<source lang="lua">
os.date('*t').min
</source>

Current second:

<source lang="lua">
os.date('*t').sec
</source>

Do something between 16:00 and 21:15:

<source lang="lua">
local t = os.date('*t')
local current_second = t.hour * 3600 + t.min * 60 + t.sec -- number of seconds since midnight
local min_time_in_seconds = 16 * 3600 + 0 * 60 -- 16:00
local max_time_in_seconds = 21 * 3600 + 15 * 60 -- 21:15

if (current_second > min_time_in_seconds) and (current_second < max_time_in_seconds) then
-- do something
else
return false
end
</source>

See http://forum.micasaverde.com/index.php?topic=2015.0 and http://www.lua.org/manual/5.1/manual.html#5.8.

=== Set Z-Wave parameters ===

See http://forum.micasaverde.com/index.php?topic=1937.msg7803#msg7803

=== a scene if the temperature is outside of a range ===

add snippets here...

=== Reload Luup at 3 AM every day ===

1. Create a scene and set it to run daily at 3 AM.

2. Add this code in the '''Luup code''' box:

<source lang="lua">luup.call_action("urn:micasaverde-com:serviceId:HomeAutomationGateway1", "Reload", {}, 0)</source>

3. Save.

=== Thermostat conditioned by door/window ===
Turn off the thermostat if the door/window is left open for 5 minutes or more and back on if the door/window is closed for 10 minutes or more.

'''1.''' Create a scene and set it to run when the door is opened.

'''2.''' Add this code in the '''Luup code''' box:
<source lang="lua">
local SENSOR = 17 -- The door/window sensor device number
local THERMOSTAT = 3 -- The thermostat device number
local DELAY = 300 -- Seconds

local SES_SID = "urn:micasaverde-com:serviceId:SecuritySensor1"
local HVACO_SID = "urn:upnp-org:serviceId:HVAC_UserOperatingMode1"

luup.call_delay( "turnOffAc", DELAY)

-- Turn off the thermostat if the sensor has been tripped for at least 5 minutes.
function turnOffAc()
local tripped = luup.variable_get( SES_SID, "Tripped", SENSOR) or "0"
local lastTrip = luup.variable_get( SES_SID, "LastTrip", SENSOR) or os.time()
if (tripped == "1" and (os.time() - lastTrip >= DELAY)) then
local modeStatus = luup.variable_get( HVACO_SID, "ModeStatus", THERMOSTAT) or "Off"
luup.variable_set( HVACO_SID, "LastModeStatus", modeStatus, THERMOSTAT)
luup.call_action( HVACO_SID, "SetModeTarget", {NewModeTarget = "Off"}, THERMOSTAT)
end
end
</source>

'''3.''' Create another scene and set it to run when the door is closed.

'''4.''' Add this code in the '''Luup code''' box:
<source lang="lua">
local SENSOR = 17 -- The door/window sensor device number
local THERMOSTAT = 3 -- The thermostat device number
local DELAY = 600 -- Seconds

local SES_SID = "urn:micasaverde-com:serviceId:SecuritySensor1"
local HVACO_SID = "urn:upnp-org:serviceId:HVAC_UserOperatingMode1"

luup.call_delay( "turnOnAc", DELAY)

-- Turn on the thermostat if the sensor hasn't been tripped in the past 10 minutes.
function turnOnAc()
local tripped = luup.variable_get( SES_SID, "Tripped", DOOR_SENSOR) or "0"
local lastTrip = luup.variable_get( SES_SID, "LastTrip", DOOR_SENSOR) or os.time()
if (tripped == "0" and (os.time() - lastTrip >= DELAY)) then
local lastModeStatus = luup.variable_get( HVACO_SID, "LastModeStatus", THERMOSTAT) or "Off"
luup.call_action( HVACO_SID, "SetModeTarget", {NewModeTarget = lastModeStatus}, THERMOSTAT)
end
end
</source>

'''5.''' Save.

[[Category:Development]]

Luup Scenes Events

2012-09-09T12:22:11Z

Solipsia: /* Samples */ Added delay code

== Adding Lua code to scenes and events ==

[[Image:SceneFlowchart.png]]

You can add Lua script to scenes and events for simple tasks, like making a scene or event conditional. Conditional meaning "do something only '''if''' some condition is met", such as attaching a condition to your "Come Home" scene so it is only run '''if''' the temperature is over 70 degrees. Basic conditional expressions are easy, and, if that's all you're looking to do, skip to the walk-through below.

If you're more technically inclined you can also do very advanced things too. For an overview of all the advanced things you can do with Vera's Luup engine, and how scenes and events fit in, see the [[Luup Intro]] page.

To add Lua code to a scene, create the [[Scenes]] and click 'Luup scene'. Fill in your Lua code in the input box. To do a simple condition, see the sample below. Or if you want to do advanced scripting you can use any [[http://lua.org Lua]] commands as described in the [[http://www.lua.org/manual/5.1/ Lua reference manual]] as well as the variables and functions that the Luup engine adds to Lua documented here: [[Luup Lua extensions]]. The Lua code will be run every time the scene is activated either by the user or a scene or a timer. The Lua code is run before the commands that you included in the scene. If your Lua code ends with this: "return false" then the commands in the scene will not be run.

You can also add Lua code to an event by clicking 'Luup event'. Since events are attached to scenes anyway, there is usually little difference between adding the code to an event, or to the scene the event is part of. If the Lua code in an event returns false, then the event is aborted, meaning the scene that the event is attached to will not be triggered by the event. The main reason for attaching Lua code to an event is if you have multiple events to a scene. For example, you may have a scene called "Turn lights on in hallway" which is triggered by 2 events: 1) The front door opens, and 2) the motion sensor in the hallway is tripped. Perhaps whenever the front door opens you always want the scene to be activated, but you only want the motion sensor to activate the scene before 10:00. In this case, you would add Lua code to the motion sensor's event which does something like (pseudo-code): "if time>10:00 return false". That way the event from the motion sensor will be aborted if it's after 10:00, but the event from the front door will always activate the scene regardless.

When you edit the Lua code in a scene or event you must click 'Save' before the code is saved. Then you can activate the scene or trigger the event to see what happens when your code is run. If you're doing some advanced scripting that you'll need to debug this can be tedious, but there are easy ways to test your Lua script immediately without saving first as explained in [[Lua Debugging]].

If you're doing advanced Lua scripting, you should note that all the Lua code in your scenes and events run in a single Lua instance, which is separate from any Lua plugins. This means if you set a global variable in one scene, or create a function inside the Lua code in a scene, then in another scene's Lua code you can use that global variable or call that function. You do not need to worry about conflicting with a Luup plugin, though, since they have their own Lua instance, meaning they have their own global variables and functions.

== Walk-through #1 -- At 12 noon, turn off the interior lights if the temperature is over 80 degrees ==

Before you start, in Vera's setup interface go to 'Devices' and click the '+' button next to the thermostat. Make note of the Device #.

In this walkthrough we'll assume it's Device #3, but use the actual device number of''your'' thermostat. Next, visit [[Luup Variables]] to get a list of all the variables for devices. A variable is a piece of information about the current state of a device, such as whether it's on or off, it's current temperature, etc.

Look down at ''Thermostat'', and copy the name of the service/variable which corresponds to the current temperature, namely. In this case, it's

urn:upnp-org:serviceId:TemperatureSensor1 CurrentTemperature

Notice that it states the <tt>CurrentTemperature</tt> is in Celsius. So type in "80 degrees Fahrenheit to Celsius" in Google and you'll see that it's 26.6 degrees Celsius.

Now, the first step is to create the scene that turns off the lights. In Vera's setup interface, click 'Scenes', and click 'Add Scene' to add a new scene to one of the rooms. It's not important which room you choose. Scenes are categorized in rooms just to help you keep track of them if you have a lot of scenes. You can also put the scene in 'Global Scenes', or, you can create dummy rooms on the 'Rooms' tab if you want to have more "rooms" to organize your scenes with. After you click 'Add Scene', type in a description to remember your scene by, such as "Lights off 12:00 if 80". Under the 'Commands' area you'll see all the rooms. Click '+' next to the rooms that have lights you want to control, and choose "Off" in the pull-down. At this point, you have a normal scene, and, if you were to save your changes now, whenever you click the scene on the dashboard or on a remote control, the lights should turn off.

Second, next to the scene's description click 'add timer'. You can give the timer a description too so that if you have multiple timers you can see in the logs which one is activating the scene. Choose "Day of week based". If you want this scene to only run on certain days of the week, just check off which days you want this scene to run on. Otherwise, you can leave them all unchecked (or check them all) to do it every day. Leave the pull-down at "a certain time of day", and choose 12 : 00 : 00 from the pull-downs. At this point, if you were to save your changes, the lights would turn off automatically at 12 noon.

Third, the last step is to add the condition. To the right of the scene's description you'll see the button "Luup Scene". Click it and in the code box, copy and paste the following:

<source lang="lua">
local lul_temp = luup.variable_get("urn:upnp-org:serviceId:TemperatureSensor1","CurrentTemperature", 3)
if (tonumber(lul_temp) < 26.6) then
return false
end
</source>

Don't forget to change the "3" to whatever is the actual device number of your thermostat. Assign the result of <tt>luup.variable_get</tt> to a variable first, rather than putting it directly in the <tt>tonumber()</tt>, because <tt>luup.variable_get</tt> actually returns 2 values: the value of the variable, and the time when the variable was modified. The '<tt>tonumber</tt>' is needed because all of a device's variables are stored as plain text--not numbers--so if you want to do arithmetic or numeric comparison of a variable, you need to put <tt>tonumber()</tt> around <tt>luup.variable_get</tt>.

<tt>luup.variable_get</tt> is documented in [[Luup Lua extensions]].

Now click 'Update', and then click 'Save' to save everything. The "return false" means "don't run this scene". So if the current temperature is <26.6, the scene will be aborted and won't run. The timer will make it trigger every day at 12 noon.

To test it, you can click the scene button on the dashboard. The lights will turn off only if the temperature is over 80 degrees. If it's less than 80 degrees, the scene won't do anything. Since this scene is something that happens automatically and you probably won't execute manually, you can go to the scene again and check the "Hidden" box so the scene doesn't show up on Vera's 'Dashboard' and on your remote controls, like the iPhone. If you want to have a scene that turns off the lights which you can run whenever you want from 'Dashboard''or your remote control, you should create another scene that has the same commands and simply don't add the timers and Luup conditions, and don't check the "Hidden" box. ''

You can substitute other service/variables and device ID's to make other types of conditions. The "if" statement above also supports nesting with ( and ), as well as the keywords 'and' and 'or'. So the following means the scene would abort if the temperature is <26.6 and >25, unless it's <23:

<source lang="lua">
local lul_temp = luup.variable_get("urn:upnp-org:serviceId:TemperatureSensor1","CurrentTemperature", 3)
if ((tonumber(lul_temp) < 26.6
and tonumber(lul_temp) > 25)
or tonumber(lul_temp) < 23) then
return false
end
</source>

If the scene doesn't run, it's possible there is a syntax error. The easiest way to test this is to copy the Lua code from the scene, then go to Devices, Luup Plugins, and "Test Luup code". Paste the code in the box and click 'go'. If the info box above the 'go' button has a check and says "Message sent successful", your code is okay. If there's an error, it says: "Code failed".

To see if that's true, use putty, or telnet or ssh to log-in to Vera, as explained in detail in [[Logon_Vera_SSH]] and [[Lua Debugging]], and type:

cd /var/log/cmh
tail -f LuaUPnP.log | grep '^01'

Now click 'Save' in Vera's setup page, even if it's gray, as that will cause Vera to restart the Luup engine and log any syntax errors. See: [[Lua Debugging]] for in-depth details on how to debug.

== Walk-through #2 -- Only run the scene during the daytime ==

In the Luup tab for the scene paste this:

<source lang="lua">
return luup.is_night() == false
</source>

That works because if the return is 'true' the scene runs, and if it's 'false' it doesn't. So during the daytime the expression is true. Or, an alternative long form:

<source lang="lua">
if (luup.is_night()) then
return false
else
return true
end
</source>

== Samples ==

This page is a wiki which anyone can edit. If you have some Lua code you think other users might find useful, feel free to add it here.

=== Lighting and Switch Actions ===

Did you see the sample here already: http://wiki.micasaverde.com/index.php/Luup_Scenes_Events

==== Turn an appliance switch or a Danfoss thermostat on for device #5 ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:SwitchPower1", "SetTarget", {newTargetValue = "1"}, 5)
</source>

==== Turn an appliance switch or a Danfoss thermostat off ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:SwitchPower1", "SetTarget", {newTargetValue = "0"}, 5)
</source>

==== Do something if switch device #5 is on ====

<source lang="lua">
local lul_tmp = luup.variable_get("urn:upnp-org:serviceId:SwitchPower1", "Status", 5)
if (lul_tmp == "1") then
--something to do goes here
end
</source>

==== Dim switch #6 to 30% ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:Dimming1", "SetLoadLevelTarget", {newLoadlevelTarget = "30"}, 6)
</source>

== Switch on, and switch off 2 seconds later ==
<source lang="lua">
local device = 29
luup.call_action("urn:upnp-org:serviceId:SwitchPower1","SetTarget",{ newTargetValue="1" },device)
luup.call_delay( 'switch_off', 2) -- Call this function after a delay of 2 seconds
function switch_off()
luup.call_action("urn:upnp-org:serviceId:SwitchPower1","SetTarget",{ newTargetValue="0" },device)
end
</source>

==== Blinking lights (and how to delay for a number of seconds) ====

http://forum.micasaverde.com/index.php?topic=5127.0

=== Motion Sensor Actions ===

==== Arm motion sensor #7 ====

<source lang="lua">
luup.variable_set("urn:micasaverde-com:serviceId:SecuritySensor1", "Armed", "1", 7)
</source>

==== Disarm motion sensor #7 ====

<source lang="lua">
luup.variable_set("urn:micasaverde-com:serviceId:SecuritySensor1", "Armed", "0", 7)
</source>

Note, arming and disarming isn't a concept within UPnP or Z-Wave. It's just a flag that the Luup engine uses, and is stored in a variable we created called "Armed".

=== Scene Actions ===

==== Run Scene #5 ====

Thanks "denix" on the forum for the correct syntax. "Actually, the 4th parameter IS required, but it's not used. Otherwise the command fails with an error message"

<source lang="lua">
luup.call_action("urn:micasaverde-com:serviceId:HomeAutomationGateway1", "RunScene", {SceneNum = "5"}, 0)
</source>

In this case we left the device number off (the 4th parameter to <tt>luup.call_action</tt>), because the "<tt>RunScene</tt>" action is handled by the Luup engine itself--not by some device within Z-Wave, etc.

However, normally you don't need to <tt>luup.call_action</tt> in Lua code. Rather, whatever actions, or commands, you want to run, you put into the scene itself, and the only Lua code is to simply check if some condition is true and abort the scene if the condition isn't met.

=== Thermostat Actions ===

==== Change the Temperature on Thermostat (Cool) device #19 ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:TemperatureSetpoint1_Cool",
"SetCurrentSetpoint", {NewCurrentSetpoint = "68"},
19)
</source>

==== Change the Temperature on a Thermostat (Heat) device #19 ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:TemperatureSetpoint1_Heat",
"SetCurrentSetpoint", {NewCurrentSetpoint = "68"},
19)
</source>

==== Change the Thermostat Operating mode device #19 ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:HVAC_UserOperatingMode1",
"SetModeTarget", {NewModeTarget = "Off"},
19)
</source>

 

=== Camera Actions ===

==== 'Privacy' mode for Foscam FI8908[w] ====

<source lang="lua">
local IP_address = '<IP address of camera>'
local username = '<username>'
local password = '<password>'
local timeout = 5

function move_up()
luup.inet.wget('http://' .. IP_address .. '/decoder_control.cgi?command=0', timeout, username, password)
end

-- center the camera; takes some time, so we have to wait 2 minutes for the command to complete

luup.inet.wget('http://' .. IP_address .. '/decoder_control.cgi?command=25', timeout, username, password)

luup.call_delay('move_up', 120)
</source>

=== Misc Actions ===

==== Playing an announcement ====

http://forum.micasaverde.com/index.php?topic=5466.msg36405#msg36405

=== Calculate sunrise and sunset ===

See http://forum.micasaverde.com/index.php?topic=2073.msg8132#msg8132

... or use DAD: http://forum.micasaverde.com/index.php?topic=5466.0

=== Access the web ===

==== Invoke HTTP URL with <tt>GET</tt> request (Method 1) ====

<source lang="lua">
-- 5 Second timeout
local status, result = luup.inet.wget("http://www.yahoo.com", 5)
</source>

==== Invoke HTTP URL with <tt>GET</tt> request (Method 2) ====

Based on code by Jim/jgc94131 <source lang="lua">
require('ltn12')
local http = require('socket.http')

-- 5 Second timeout
socket.http.TIMEOUT = 5

local response_body = {}
local request_body = ''

local r, c, h = socket.http.request{
url = 'http://website/page?parameter1=value&parameter2=value',
method = "GET",
port = 80,
headers = {
["Content-Length"] = string.len(request_body),
["Content-Type"] = "application/x-www-form-urlencoded"
},
source = ltn12.source.string(request_body),
sink = ltn12.sink.table(response_body)
}
</source>

==== Invoke HTTP URL with <tt>POST</tt> request (Method 3) ====

<source lang="lua">
local http = require("socket.http")

-- 5 Second timeout
http.TIMEOUT = 5

-- The return parameters are in a different order from luup.inet.wget(...)
result, status = http.request("http://192.168.0.113/runprocess.htm", "run=run")
</source>

=== Access the current time ===

The Lua function

<source lang="lua">
os.date (format, time)
</source>

converts a time value `time` into a human readable date/time string, according to `format`. If you leave out the optional `time` parameter, it defaults to current time. The `format` parameter defaults to a fairly complete format. If you specify '*t' as the format, it will return a table instead of a formatted string.

<source lang="lua">
t = os.date('*t')
t = {year=2010, month=2, day=19, yday=50, wday=6, hour=22, min=45, sec=45, isdst=false}
</source>

The fields are year, month, day of month, day of year, day of week, hour in 24 hour clock, minutes, seconds and if it's Daylight Savings Time.

Current hour:

<source lang="lua">
os.date('*t').hour
</source>

Current minute:

<source lang="lua">
os.date('*t').min
</source>

Current second:

<source lang="lua">
os.date('*t').sec
</source>

Do something between 16:00 and 21:15:

<source lang="lua">
local t = os.date('*t')
local current_second = t.hour * 3600 + t.min * 60 + t.sec -- number of seconds since midnight
local min_time_in_seconds = 16 * 3600 + 0 * 60 -- 16:00
local max_time_in_seconds = 21 * 3600 + 15 * 60 -- 21:15

if (current_second > min_time_in_seconds) and (current_second < max_time_in_seconds) then
-- do something
else
return false
end
</source>

See http://forum.micasaverde.com/index.php?topic=2015.0 and http://www.lua.org/manual/5.1/manual.html#5.8.

=== Set Z-Wave parameters ===

See http://forum.micasaverde.com/index.php?topic=1937.msg7803#msg7803

=== a scene if the temperature is outside of a range ===

add snippets here...

=== Reload Luup at 3 AM every day ===

1. Create a scene and set it to run daily at 3 AM.

2. Add this code in the '''Luup code''' box:

<source lang="lua">luup.call_action("urn:micasaverde-com:serviceId:HomeAutomationGateway1", "Reload", {}, 0)</source>

3. Save.

=== Thermostat conditioned by door/window ===
Turn off the thermostat if the door/window is left open for 5 minutes or more and back on if the door/window is closed for 10 minutes or more.

'''1.''' Create a scene and set it to run when the door is opened.

'''2.''' Add this code in the '''Luup code''' box:
<source lang="lua">
local SENSOR = 17 -- The door/window sensor device number
local THERMOSTAT = 3 -- The thermostat device number
local DELAY = 300 -- Seconds

local SES_SID = "urn:micasaverde-com:serviceId:SecuritySensor1"
local HVACO_SID = "urn:upnp-org:serviceId:HVAC_UserOperatingMode1"

luup.call_delay( "turnOffAc", DELAY)

-- Turn off the thermostat if the sensor has been tripped for at least 5 minutes.
function turnOffAc()
local tripped = luup.variable_get( SES_SID, "Tripped", SENSOR) or "0"
local lastTrip = luup.variable_get( SES_SID, "LastTrip", SENSOR) or os.time()
if (tripped == "1" and (os.time() - lastTrip >= DELAY)) then
local modeStatus = luup.variable_get( HVACO_SID, "ModeStatus", THERMOSTAT) or "Off"
luup.variable_set( HVACO_SID, "LastModeStatus", modeStatus, THERMOSTAT)
luup.call_action( HVACO_SID, "SetModeTarget", {NewModeTarget = "Off"}, THERMOSTAT)
end
end
</source>

'''3.''' Create another scene and set it to run when the door is closed.

'''4.''' Add this code in the '''Luup code''' box:
<source lang="lua">
local SENSOR = 17 -- The door/window sensor device number
local THERMOSTAT = 3 -- The thermostat device number
local DELAY = 600 -- Seconds

local SES_SID = "urn:micasaverde-com:serviceId:SecuritySensor1"
local HVACO_SID = "urn:upnp-org:serviceId:HVAC_UserOperatingMode1"

luup.call_delay( "turnOnAc", DELAY)

-- Turn on the thermostat if the sensor hasn't been tripped in the past 10 minutes.
function turnOnAc()
local tripped = luup.variable_get( SES_SID, "Tripped", DOOR_SENSOR) or "0"
local lastTrip = luup.variable_get( SES_SID, "LastTrip", DOOR_SENSOR) or os.time()
if (tripped == "0" and (os.time() - lastTrip >= DELAY)) then
local lastModeStatus = luup.variable_get( HVACO_SID, "LastModeStatus", THERMOSTAT) or "Off"
luup.call_action( HVACO_SID, "SetModeTarget", {NewModeTarget = lastModeStatus}, THERMOSTAT)
end
end
</source>

'''5.''' Save.

[[Category:Development]]

Luup Scenes Events

2012-09-09T12:17:07Z

Solipsia: /* Blinking lights */

== Adding Lua code to scenes and events ==

[[Image:SceneFlowchart.png]]

You can add Lua script to scenes and events for simple tasks, like making a scene or event conditional. Conditional meaning "do something only '''if''' some condition is met", such as attaching a condition to your "Come Home" scene so it is only run '''if''' the temperature is over 70 degrees. Basic conditional expressions are easy, and, if that's all you're looking to do, skip to the walk-through below.

If you're more technically inclined you can also do very advanced things too. For an overview of all the advanced things you can do with Vera's Luup engine, and how scenes and events fit in, see the [[Luup Intro]] page.

To add Lua code to a scene, create the [[Scenes]] and click 'Luup scene'. Fill in your Lua code in the input box. To do a simple condition, see the sample below. Or if you want to do advanced scripting you can use any [[http://lua.org Lua]] commands as described in the [[http://www.lua.org/manual/5.1/ Lua reference manual]] as well as the variables and functions that the Luup engine adds to Lua documented here: [[Luup Lua extensions]]. The Lua code will be run every time the scene is activated either by the user or a scene or a timer. The Lua code is run before the commands that you included in the scene. If your Lua code ends with this: "return false" then the commands in the scene will not be run.

You can also add Lua code to an event by clicking 'Luup event'. Since events are attached to scenes anyway, there is usually little difference between adding the code to an event, or to the scene the event is part of. If the Lua code in an event returns false, then the event is aborted, meaning the scene that the event is attached to will not be triggered by the event. The main reason for attaching Lua code to an event is if you have multiple events to a scene. For example, you may have a scene called "Turn lights on in hallway" which is triggered by 2 events: 1) The front door opens, and 2) the motion sensor in the hallway is tripped. Perhaps whenever the front door opens you always want the scene to be activated, but you only want the motion sensor to activate the scene before 10:00. In this case, you would add Lua code to the motion sensor's event which does something like (pseudo-code): "if time>10:00 return false". That way the event from the motion sensor will be aborted if it's after 10:00, but the event from the front door will always activate the scene regardless.

When you edit the Lua code in a scene or event you must click 'Save' before the code is saved. Then you can activate the scene or trigger the event to see what happens when your code is run. If you're doing some advanced scripting that you'll need to debug this can be tedious, but there are easy ways to test your Lua script immediately without saving first as explained in [[Lua Debugging]].

If you're doing advanced Lua scripting, you should note that all the Lua code in your scenes and events run in a single Lua instance, which is separate from any Lua plugins. This means if you set a global variable in one scene, or create a function inside the Lua code in a scene, then in another scene's Lua code you can use that global variable or call that function. You do not need to worry about conflicting with a Luup plugin, though, since they have their own Lua instance, meaning they have their own global variables and functions.

== Walk-through #1 -- At 12 noon, turn off the interior lights if the temperature is over 80 degrees ==

Before you start, in Vera's setup interface go to 'Devices' and click the '+' button next to the thermostat. Make note of the Device #.

In this walkthrough we'll assume it's Device #3, but use the actual device number of''your'' thermostat. Next, visit [[Luup Variables]] to get a list of all the variables for devices. A variable is a piece of information about the current state of a device, such as whether it's on or off, it's current temperature, etc.

Look down at ''Thermostat'', and copy the name of the service/variable which corresponds to the current temperature, namely. In this case, it's

urn:upnp-org:serviceId:TemperatureSensor1 CurrentTemperature

Notice that it states the <tt>CurrentTemperature</tt> is in Celsius. So type in "80 degrees Fahrenheit to Celsius" in Google and you'll see that it's 26.6 degrees Celsius.

Now, the first step is to create the scene that turns off the lights. In Vera's setup interface, click 'Scenes', and click 'Add Scene' to add a new scene to one of the rooms. It's not important which room you choose. Scenes are categorized in rooms just to help you keep track of them if you have a lot of scenes. You can also put the scene in 'Global Scenes', or, you can create dummy rooms on the 'Rooms' tab if you want to have more "rooms" to organize your scenes with. After you click 'Add Scene', type in a description to remember your scene by, such as "Lights off 12:00 if 80". Under the 'Commands' area you'll see all the rooms. Click '+' next to the rooms that have lights you want to control, and choose "Off" in the pull-down. At this point, you have a normal scene, and, if you were to save your changes now, whenever you click the scene on the dashboard or on a remote control, the lights should turn off.

Second, next to the scene's description click 'add timer'. You can give the timer a description too so that if you have multiple timers you can see in the logs which one is activating the scene. Choose "Day of week based". If you want this scene to only run on certain days of the week, just check off which days you want this scene to run on. Otherwise, you can leave them all unchecked (or check them all) to do it every day. Leave the pull-down at "a certain time of day", and choose 12 : 00 : 00 from the pull-downs. At this point, if you were to save your changes, the lights would turn off automatically at 12 noon.

Third, the last step is to add the condition. To the right of the scene's description you'll see the button "Luup Scene". Click it and in the code box, copy and paste the following:

<source lang="lua">
local lul_temp = luup.variable_get("urn:upnp-org:serviceId:TemperatureSensor1","CurrentTemperature", 3)
if (tonumber(lul_temp) < 26.6) then
return false
end
</source>

Don't forget to change the "3" to whatever is the actual device number of your thermostat. Assign the result of <tt>luup.variable_get</tt> to a variable first, rather than putting it directly in the <tt>tonumber()</tt>, because <tt>luup.variable_get</tt> actually returns 2 values: the value of the variable, and the time when the variable was modified. The '<tt>tonumber</tt>' is needed because all of a device's variables are stored as plain text--not numbers--so if you want to do arithmetic or numeric comparison of a variable, you need to put <tt>tonumber()</tt> around <tt>luup.variable_get</tt>.

<tt>luup.variable_get</tt> is documented in [[Luup Lua extensions]].

Now click 'Update', and then click 'Save' to save everything. The "return false" means "don't run this scene". So if the current temperature is <26.6, the scene will be aborted and won't run. The timer will make it trigger every day at 12 noon.

To test it, you can click the scene button on the dashboard. The lights will turn off only if the temperature is over 80 degrees. If it's less than 80 degrees, the scene won't do anything. Since this scene is something that happens automatically and you probably won't execute manually, you can go to the scene again and check the "Hidden" box so the scene doesn't show up on Vera's 'Dashboard' and on your remote controls, like the iPhone. If you want to have a scene that turns off the lights which you can run whenever you want from 'Dashboard''or your remote control, you should create another scene that has the same commands and simply don't add the timers and Luup conditions, and don't check the "Hidden" box. ''

You can substitute other service/variables and device ID's to make other types of conditions. The "if" statement above also supports nesting with ( and ), as well as the keywords 'and' and 'or'. So the following means the scene would abort if the temperature is <26.6 and >25, unless it's <23:

<source lang="lua">
local lul_temp = luup.variable_get("urn:upnp-org:serviceId:TemperatureSensor1","CurrentTemperature", 3)
if ((tonumber(lul_temp) < 26.6
and tonumber(lul_temp) > 25)
or tonumber(lul_temp) < 23) then
return false
end
</source>

If the scene doesn't run, it's possible there is a syntax error. The easiest way to test this is to copy the Lua code from the scene, then go to Devices, Luup Plugins, and "Test Luup code". Paste the code in the box and click 'go'. If the info box above the 'go' button has a check and says "Message sent successful", your code is okay. If there's an error, it says: "Code failed".

To see if that's true, use putty, or telnet or ssh to log-in to Vera, as explained in detail in [[Logon_Vera_SSH]] and [[Lua Debugging]], and type:

cd /var/log/cmh
tail -f LuaUPnP.log | grep '^01'

Now click 'Save' in Vera's setup page, even if it's gray, as that will cause Vera to restart the Luup engine and log any syntax errors. See: [[Lua Debugging]] for in-depth details on how to debug.

== Walk-through #2 -- Only run the scene during the daytime ==

In the Luup tab for the scene paste this:

<source lang="lua">
return luup.is_night() == false
</source>

That works because if the return is 'true' the scene runs, and if it's 'false' it doesn't. So during the daytime the expression is true. Or, an alternative long form:

<source lang="lua">
if (luup.is_night()) then
return false
else
return true
end
</source>

== Samples ==

This page is a wiki which anyone can edit. If you have some Lua code you think other users might find useful, feel free to add it here.

=== Lighting and Switch Actions ===

Did you see the sample here already: http://wiki.micasaverde.com/index.php/Luup_Scenes_Events

==== Turn an appliance switch or a Danfoss thermostat on for device #5 ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:SwitchPower1", "SetTarget", {newTargetValue = "1"}, 5)
</source>

==== Turn an appliance switch or a Danfoss thermostat off ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:SwitchPower1", "SetTarget", {newTargetValue = "0"}, 5)
</source>

==== Do something if switch device #5 is on ====

<source lang="lua">
local lul_tmp = luup.variable_get("urn:upnp-org:serviceId:SwitchPower1", "Status", 5)
if (lul_tmp == "1") then
--something to do goes here
end
</source>

==== Dim switch #6 to 30% ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:Dimming1", "SetLoadLevelTarget", {newLoadlevelTarget = "30"}, 6)
</source>

==== Blinking lights (and how to delay for a number of seconds) ====

http://forum.micasaverde.com/index.php?topic=5127.0

=== Motion Sensor Actions ===

==== Arm motion sensor #7 ====

<source lang="lua">
luup.variable_set("urn:micasaverde-com:serviceId:SecuritySensor1", "Armed", "1", 7)
</source>

==== Disarm motion sensor #7 ====

<source lang="lua">
luup.variable_set("urn:micasaverde-com:serviceId:SecuritySensor1", "Armed", "0", 7)
</source>

Note, arming and disarming isn't a concept within UPnP or Z-Wave. It's just a flag that the Luup engine uses, and is stored in a variable we created called "Armed".

=== Scene Actions ===

==== Run Scene #5 ====

Thanks "denix" on the forum for the correct syntax. "Actually, the 4th parameter IS required, but it's not used. Otherwise the command fails with an error message"

<source lang="lua">
luup.call_action("urn:micasaverde-com:serviceId:HomeAutomationGateway1", "RunScene", {SceneNum = "5"}, 0)
</source>

In this case we left the device number off (the 4th parameter to <tt>luup.call_action</tt>), because the "<tt>RunScene</tt>" action is handled by the Luup engine itself--not by some device within Z-Wave, etc.

However, normally you don't need to <tt>luup.call_action</tt> in Lua code. Rather, whatever actions, or commands, you want to run, you put into the scene itself, and the only Lua code is to simply check if some condition is true and abort the scene if the condition isn't met.

=== Thermostat Actions ===

==== Change the Temperature on Thermostat (Cool) device #19 ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:TemperatureSetpoint1_Cool",
"SetCurrentSetpoint", {NewCurrentSetpoint = "68"},
19)
</source>

==== Change the Temperature on a Thermostat (Heat) device #19 ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:TemperatureSetpoint1_Heat",
"SetCurrentSetpoint", {NewCurrentSetpoint = "68"},
19)
</source>

==== Change the Thermostat Operating mode device #19 ====

<source lang="lua">
luup.call_action("urn:upnp-org:serviceId:HVAC_UserOperatingMode1",
"SetModeTarget", {NewModeTarget = "Off"},
19)
</source>

 

=== Camera Actions ===

==== 'Privacy' mode for Foscam FI8908[w] ====

<source lang="lua">
local IP_address = '<IP address of camera>'
local username = '<username>'
local password = '<password>'
local timeout = 5

function move_up()
luup.inet.wget('http://' .. IP_address .. '/decoder_control.cgi?command=0', timeout, username, password)
end

-- center the camera; takes some time, so we have to wait 2 minutes for the command to complete

luup.inet.wget('http://' .. IP_address .. '/decoder_control.cgi?command=25', timeout, username, password)

luup.call_delay('move_up', 120)
</source>

=== Misc Actions ===

==== Playing an announcement ====

http://forum.micasaverde.com/index.php?topic=5466.msg36405#msg36405

=== Calculate sunrise and sunset ===

See http://forum.micasaverde.com/index.php?topic=2073.msg8132#msg8132

... or use DAD: http://forum.micasaverde.com/index.php?topic=5466.0

=== Access the web ===

==== Invoke HTTP URL with <tt>GET</tt> request (Method 1) ====

<source lang="lua">
-- 5 Second timeout
local status, result = luup.inet.wget("http://www.yahoo.com", 5)
</source>

==== Invoke HTTP URL with <tt>GET</tt> request (Method 2) ====

Based on code by Jim/jgc94131 <source lang="lua">
require('ltn12')
local http = require('socket.http')

-- 5 Second timeout
socket.http.TIMEOUT = 5

local response_body = {}
local request_body = ''

local r, c, h = socket.http.request{
url = 'http://website/page?parameter1=value&parameter2=value',
method = "GET",
port = 80,
headers = {
["Content-Length"] = string.len(request_body),
["Content-Type"] = "application/x-www-form-urlencoded"
},
source = ltn12.source.string(request_body),
sink = ltn12.sink.table(response_body)
}
</source>

==== Invoke HTTP URL with <tt>POST</tt> request (Method 3) ====

<source lang="lua">
local http = require("socket.http")

-- 5 Second timeout
http.TIMEOUT = 5

-- The return parameters are in a different order from luup.inet.wget(...)
result, status = http.request("http://192.168.0.113/runprocess.htm", "run=run")
</source>

=== Access the current time ===

The Lua function

<source lang="lua">
os.date (format, time)
</source>

converts a time value `time` into a human readable date/time string, according to `format`. If you leave out the optional `time` parameter, it defaults to current time. The `format` parameter defaults to a fairly complete format. If you specify '*t' as the format, it will return a table instead of a formatted string.

<source lang="lua">
t = os.date('*t')
t = {year=2010, month=2, day=19, yday=50, wday=6, hour=22, min=45, sec=45, isdst=false}
</source>

The fields are year, month, day of month, day of year, day of week, hour in 24 hour clock, minutes, seconds and if it's Daylight Savings Time.

Current hour:

<source lang="lua">
os.date('*t').hour
</source>

Current minute:

<source lang="lua">
os.date('*t').min
</source>

Current second:

<source lang="lua">
os.date('*t').sec
</source>

Do something between 16:00 and 21:15:

<source lang="lua">
local t = os.date('*t')
local current_second = t.hour * 3600 + t.min * 60 + t.sec -- number of seconds since midnight
local min_time_in_seconds = 16 * 3600 + 0 * 60 -- 16:00
local max_time_in_seconds = 21 * 3600 + 15 * 60 -- 21:15

if (current_second > min_time_in_seconds) and (current_second < max_time_in_seconds) then
-- do something
else
return false
end
</source>

See http://forum.micasaverde.com/index.php?topic=2015.0 and http://www.lua.org/manual/5.1/manual.html#5.8.

=== Set Z-Wave parameters ===

See http://forum.micasaverde.com/index.php?topic=1937.msg7803#msg7803

=== a scene if the temperature is outside of a range ===

add snippets here...

=== Reload Luup at 3 AM every day ===

1. Create a scene and set it to run daily at 3 AM.

2. Add this code in the '''Luup code''' box:

<source lang="lua">luup.call_action("urn:micasaverde-com:serviceId:HomeAutomationGateway1", "Reload", {}, 0)</source>

3. Save.

=== Thermostat conditioned by door/window ===
Turn off the thermostat if the door/window is left open for 5 minutes or more and back on if the door/window is closed for 10 minutes or more.

'''1.''' Create a scene and set it to run when the door is opened.

'''2.''' Add this code in the '''Luup code''' box:
<source lang="lua">
local SENSOR = 17 -- The door/window sensor device number
local THERMOSTAT = 3 -- The thermostat device number
local DELAY = 300 -- Seconds

local SES_SID = "urn:micasaverde-com:serviceId:SecuritySensor1"
local HVACO_SID = "urn:upnp-org:serviceId:HVAC_UserOperatingMode1"

luup.call_delay( "turnOffAc", DELAY)

-- Turn off the thermostat if the sensor has been tripped for at least 5 minutes.
function turnOffAc()
local tripped = luup.variable_get( SES_SID, "Tripped", SENSOR) or "0"
local lastTrip = luup.variable_get( SES_SID, "LastTrip", SENSOR) or os.time()
if (tripped == "1" and (os.time() - lastTrip >= DELAY)) then
local modeStatus = luup.variable_get( HVACO_SID, "ModeStatus", THERMOSTAT) or "Off"
luup.variable_set( HVACO_SID, "LastModeStatus", modeStatus, THERMOSTAT)
luup.call_action( HVACO_SID, "SetModeTarget", {NewModeTarget = "Off"}, THERMOSTAT)
end
end
</source>

'''3.''' Create another scene and set it to run when the door is closed.

'''4.''' Add this code in the '''Luup code''' box:
<source lang="lua">
local SENSOR = 17 -- The door/window sensor device number
local THERMOSTAT = 3 -- The thermostat device number
local DELAY = 600 -- Seconds

local SES_SID = "urn:micasaverde-com:serviceId:SecuritySensor1"
local HVACO_SID = "urn:upnp-org:serviceId:HVAC_UserOperatingMode1"

luup.call_delay( "turnOnAc", DELAY)

-- Turn on the thermostat if the sensor hasn't been tripped in the past 10 minutes.
function turnOnAc()
local tripped = luup.variable_get( SES_SID, "Tripped", DOOR_SENSOR) or "0"
local lastTrip = luup.variable_get( SES_SID, "LastTrip", DOOR_SENSOR) or os.time()
if (tripped == "0" and (os.time() - lastTrip >= DELAY)) then
local lastModeStatus = luup.variable_get( HVACO_SID, "LastModeStatus", THERMOSTAT) or "Off"
luup.call_action( HVACO_SID, "SetModeTarget", {NewModeTarget = lastModeStatus}, THERMOSTAT)
end
end
</source>

'''5.''' Save.

[[Category:Development]]

ExpressControls3in1

2012-09-08T13:28:53Z

Solipsia: /* Configure */

== Overview ==

The EZMotion Wireless 3-in-1 sensor is functionally identical to the HomeSeer HSM100 device. The user's manual is here: http://www.expresscontrols.com/pdf/EZMotionOwnerManual.pdf

=== Features ===

This unit is a contains three sensors that report values to the Vera:

*'''Motion Sensor''' with adjustable sensitivity and timeout
*'''Temperature Sensor'''
*'''Luminosity (Light Level) Sensor''' reporting level of light as a percentage between the brightest and darkest levels it has encountered since being switched on for the first time

 The temperature and light levels are reported when the device wakes up and reports back to Vera, but the motion sensor will report automatically whenever it has been tripped, wether the device is sleeping or not. The unit has a red LED which indicates when motion is detected and it can be disabled. It can also report its battery level as a percentage to the Vera. 

 

== Basic Configuration ==

For more information about Device Options, please visit: 

[http://docs5.mios.com/doc.php?language=1&manual=1&platform=3Pro&page=add_device_zwave_properties_dev_option http://docs5.mios.com/doc.php?language=1&manual=1&platform=3Pro&page=add_device_zwave_properties_dev_option] 

=== Wake Up interval ===

The unit sleeps for the duration of the Wake Up interval, which defaults to 1800 seconds or 30 minutes. When the interval expires, it wakes up and reports Temperature and Luminosity to the Vera. Note that while all 4 devices in the Vera MIOS screen can be configured for Wake Up intervals, only the setting for the '3-in-1 Sensor' has any effect and controls both Temperature and Luminosity intervals. The Motion Sensor is unaffected by the Wakeup Interval (see On Time below)

To set the Wake Up Interval, click on the spanner (wrench) icon for the "3-in-1 sensor" device, click on Setting and set Wakeup Interval to the desired interval (in seconds, e.g. 1800(seconds) = 30 min before the sensor wakes up again). Reducing the wake up interval (causing the sensor to transmit radio signals more often) reduces battery life.

=== On Time ===

When the Motion Sensor is tripped, it transmits a tripped command and changes its state to Tripped=1 for the duration of the ON TIME variable. After this time has expired, it sends an Untripped command to the Vera and resets it state to Tripped=0. While the device is in a tripped state, any motion detected resets the interval timer but doesn't report a new trip event to the Vera. During the wait time the Motion Sensor device in the Vera will show Tripped=1 in the Advanced tab.

To set the ON TIME, click on the spanner (wrench) icon for the "3-in-1 sensor" device, click on Device Options and set variable 2 (On Time) to 5 (or the desired interval in minutes)

'''Direct Association:''' The unit can be associated directly with another device such as a light. If you've done this, the unit will turn the light on when motion is sensed, then turn it off after the ON TIME. According to the sensor's manual up to four associated devices are supported, but associating more than one device does not work (as of Vera's firmware 1.0.900, see http://bugs.micasaverde.com/view.php?id=705).

Leave Parameter #6, "OnValue", at the default if you want the sensor tripped events in Vera.

=== Polling Frequency ===

The unit can only be polled when it is either in Test mode or within 3 seconds after waking up (see Wake Up Interval above). Polling at any other time will fail since the unit will not respond. Also, every time the unit wakes up, it updates Vera with the temperature and luminosity. This means that polling is unnecessary and the polling frequency should be set to 0 (disabled) or a long interval to avoid unnecessary traffic on Vera, which could cause updates to be missed.

An exception to this rule is when Vera is set to Always Awake (see AC Power below). In that case, the unit is always awake, so never reports its values (which happens at wake-up) and must be polled at regular intervals.

=== Example ===

Consider the following example of how to configure the sensor and the Vera for a common application. Suppose you want to install a motion sensor in your garage to turn the lights on when you enter, keep them on for as long as you move around in the garage, then turn them off 5 minutes after you've left.

'''UI4''' 

#Put the unit in Test mode by pressing the button on the side
#Configure the On Time to 5 minutes
#Create two scenes in Vera:
##Turn on the light when the unit has tripped (New Scene, Events tab, Add Event, Device=Motion sensor, Type of Event=Armed sensor has tripped, Name=whatever, Tripped=Yes)
##Turn off the light when the unit sends an untrip command which happens after the On Time interval. (New Scene, Events tab, Add Event, Device=Motion sensor, Type of Event=Armed sensor has tripped, Name=whatever, Tripped=No)

'''UI5''' 

#Put the unit in Test mode by pressing the button on the side
#Configure the On Time to 5 minutes
#Create two scenes in Vera:
##Turn on the light when the unit has tripped (Automation -> Create Scene, Triggers tab, Add trigger, Device=Motion sensor, What type of event is the trigger?=An armed sensor is tripped, Name for this trigger=whatever, Device armed is tripped)
##Turn off the light when the unit sends an untrip command which happens after the On Time interval. (Automation -> Create Scene, Triggers tab, Add trigger, Device=Motion sensor, What type of event is the trigger?=An armed sensor is tripped, Name for this trigger=whatever, Device armed is not tripped)

 

== Advanced Configuration ==

=== Running from AC Power ===

==== Overview ====

It is possible to run the unit from AC power instead of batteries, which will have the following benefits:

*Allow you to keep the unit awake permanently, allowing you to poll it and customise it without being in Test mode
*Report continuously every time motion is sensed, as opposed to waiting for the ON TIME duration in between trips
*Set the unit to report temperature and light levels at higher frequencies up to 1 minute
*Let the unit act as a Z-Wave repeater, increasing the span of your network
*Never worry about running down batteries. All of the above options are possible on battery power, but will run your batteries down within a few days

==== Configure ====

To do this, you will need to connect a AC to DC transformer that supplies 4.5v to 5.5v at up to 1amp to the battery terminals directly. Ensure that you measure that actual output voltage of the transformer using a multi/voltage meter (don't rely on its advertised rating). Any over-voltage may fry the unit. Also make sure that the polarity is correct. It may be helpful to add a diode in series with the positive terminal to prevent accidentally frying the unit if the polarity is incorrect. It will drop the voltage by 0.6v though.

'''Setting ''Stay Awake'' to On''' By default, the unit is constantly asleep and only wakes up at regular intervals to report the luminosity and temperature, before sleeping again. This is to save batteries. While asleep, the unit cannot be programmed from the Vera and cannot be polled for information. To get around this, one normally activates the Test mode by pressing the button on the side of the unit, which keeps it awake for 10 minutes so that it can be programmed. By setting the unit to stay awake constantly, you can program, poll or configure it at any time. It also has the side effect of enabling the unit to become a repeater of Z Wave signals throughout the network.

To set it, click on the spanner (wrench) icon for the "3-in-1 sensor" device, click on Device Options and set variable 5 (Stay Awake) to 1 or any number greater than 0.

To activate this setting, you will need to power off and power back on the device. Remember to save your settings first.

'''Setting ''On Time'' to ''Always Fire''''' When the unit detects motion, it reports it by sending a Tripped command to the Vera. It then waits for the duration of the On Time and then sends un Untripped command to the Vera and waits for the next motion. Since battery life is not a consideration while on AC power, you can set it to 'Always Fire', which sends a Tripped command whenever motion is detected with no waiting period. Note, this will also prevent an Untripped command from being sent.

To set it, click on the spanner (wrench) icon for the "3-in-1 sensor" device, click on Device Options and set variable 2 (On Time) to 0.

'''Setting Poll frequency''' The unit usually only reports temperate and luminosity every time it wakes up, but since the unit is now constantly awake, you will have to configure a poll frequency to gather that information.

To set it, click on the spanner (wrench) icon for the "Motion Sensor" device, click on Settings and set "Poll this node at most every" to the required update frequency. The Wakeup interval setting on this same screen has no effect since it's been overridden by Always Awake setting.

== Known issues ==

[[Category:Hardware]] [[Category:Plugins]] [[Category:3rd_Party]]

ExpressControls3in1

2011-02-21T14:14:09Z

Solipsia:

[[Category:Hardware]]
[[Category:Plugins]]
[[Category:3rd Party]]

== Overview ==
The EZMotion Wireless 3-in-1 sensor is functionally identical to the HomeSeer HSM100 device. The user's manual is here: http://www.expresscontrols.com/pdf/EZMotionOwnerManual.pdf

=== Features ===

This unit is a contains three sensors that report values to the Vera:
* '''Motion Sensor''' with adjustable sensitivity and timeout
* '''Temperature Sensor'''
* '''Luminosity (Light Level) Sensor''' reporting level of light as a percentage between the brightest and darkest levels it has encountered since being switched on for the first time

The unit has a red LED which indicates when motion is detected and it can be disabled. It can also report its battery level as a percentage to the Vera.

== Basic Configuration ==
=== Wake Up interval ===
The unit sleeps for the duration of the Wake Up interval, which defaults to 1800 seconds or 30 minutes. When the interval expires, it wakes up and reports Temperature and Luminosity to the Vera. Note that while all 4 devices in the Vera MIOS screen can be configured for Wake Up intervals, only the setting for the '3-in-1 Sensor' has any effect and controls both Temperature and Luminosity intervals. The Motion Sensor is unaffected by the Wakeup Interval (see On Time below)

To set the Wake Up Interval, click on the spanner (wrench) icon for the "3-in-1 sensor" device, click on Setting and set Wakeup Interval to the desired interval.

=== On Time ===
When the Motion Sensor is tripped, it transmits a tripped command and changes its state to Tripped=1 for the duration of the ON TIME variable. After this time has expired, it sends an Untripped command to the Vera and resets it state to Tripped=0. While the device is in a tripped state, any motion detected resets the interval timer but doesn't report a new trip event to the Vera. During the wait time the Motion Sensor device in the Vera will show Tripped=1 in the Advanced tab.

To set the ON TIME, click on the spanner (wrench) icon for the "3-in-1 sensor" device, click on Device Options and set variable 2 (On Time) to 5 (or the desired interval in minutes)

'''Direct Association:''' The unit can be associated directly with another device such as a light. If you've done this, the unit will turn the light on when motion is sensed, then turn it off after the ON TIME. According to the sensor's manual up to four associated devices are supported, but associating more than one device does not work (as of Vera's firmware 1.0.900, see http://bugs.micasaverde.com/view.php?id=705).

Leave Parameter #6, "OnValue", at the default if you want the sensor tripped events in Vera.

=== Polling Frequency ===
The unit can only be polled when it is either in Test mode or within 3 seconds after waking up (see Wake Up Interval above). Polling at any other time will fail since the unit will not respond. Also, every time the unit wakes up, it updates Vera with the temperature and luminosity. This means that polling is unnecessary and the polling frequency should be set to 0 (disabled) or a long interval to avoid unnecessary traffic on Vera, which could cause updates to be missed.

An exception to this rule is when Vera is set to Always Awake (see AC Power below). In that case, the unit is always awake, so never reports its values (which happens at wake-up) and must be polled at regular intervals.

=== Example ===
Consider the following example of how to configure the sensor and the Vera for a common application. Suppose you want to install a motion sensor in your garage to turn the lights on when you enter, keep them on for as long as you move around in the garage, then turn them off 5 minutes after you've left.
# Put the unit in Test mode by pressing the button on the side
# Configure the On Time to 5 minutes
# Create two scenes in Vera:
## Turn on the light when the unit has tripped (New Scene, Events tab, Add Event, Device=Motion sensor, Type of Event=Armed sensor has tripped, Name=whatever, Tripped=Yes)
## Turn off the light when the unit sends an untrip command which happens after the On Time interval. (New Scene, Events tab, Add Event, Device=Motion sensor, Type of Event=Armed sensor has tripped, Name=whatever, Tripped=No)

== Advanced Configuration ==
=== Running from AC Power ===
==== Overview ====
It is possible to run the unit from AC power instead of batteries, which will have the following benefits:
* Allow you to keep the unit awake permanently, allowing you to poll it and customise it without being in Test mode
* Report continuously every time motion is sensed, as opposed to waiting for the ON TIME duration in between trips
* Set the unit to report temperature and light levels at higher frequencies up to 1 minute
* Let the unit act as a Z-Wave repeater, increasing the span of your network
* Never worry about running down batteries. All of the above options are possible on battery power, but will run your batteries down within a few days
==== Configure ====
To do this, you will need to connect a AC to DC transformer that supplies 4.5v to 5.5v at up to 1amp to the battery terminals directly. Ensure that you measure that actual output voltage of the transformer using a multi/voltage meter (don't rely on its advertised rating). Any over-voltage may fry the unit. Also make sure that the polarity is correct. It may be helpful to add a diode in series with the positive terminal to prevent accidentally frying the unit if the polarity is incorrect. It will drop the voltage by 0.6v though.

'''Setting ''Stay Awake'' to On'''
By default, the unit is constantly asleep and only wakes up at regular intervals to report the luminosity and temperature, before sleeping again. This is to save batteries. While asleep, the unit cannot be programmed from the Vera and cannot be polled for information. To get around this, one normally activates the Test mode by pressing the button on the side of the unit, which keeps it awake for 10 minutes so that it can be programmed. By setting the unit to stay awake constantly, you can program, poll or configure it at any time. It also has the side effect of enabling the unit to become a repeater of Z Wave signals throughout the network.

To set it, click on the spanner (wrench) icon for the "3-in-1 sensor" device, click on Device Options and set variable 5 (Stay Awake) to 1 or any number greater than 0.

To activate this setting, you will need to exclude and reinclude the unit using the standard Vera process. Remember to save your settings first.

'''Setting ''On Time'' to ''Always Fire'''''
When the unit detects motion, it reports it by sending a Tripped command to the Vera. It then waits for the duration of the On Time and then sends un Untripped command to the Vera and waits for the next motion. Since battery life is not a consideration while on AC power, you can set it to 'Always Fire', which sends a Tripped command whenever motion is detected with no waiting period. Note, this will also prevent an Untripped command from being sent.

To set it, click on the spanner (wrench) icon for the "3-in-1 sensor" device, click on Device Options and set variable 2 (On Time) to 0.

''' Setting Poll frequency'''
The unit usually only reports temperate and luminosity every time it wakes up, but since the unit is now constantly awake, you will have to configure a poll frequency to gather that information.

To set it, click on the spanner (wrench) icon for the "Motion Sensor" device, click on Settings and set "Poll this node at most every" to the required update frequency. The Wakeup interval setting on this same screen has no effect since it's been overridden by Always Awake setting.

== Known issues ==

Luup Scenes Events

2011-02-20T18:03:33Z

Solipsia: Added flowchart

[[Category:Development]]
== Adding Lua code to scenes and events ==
[[Image:SceneFlowchart.png]]

You can add Lua script to scenes and events for simple tasks, like making a scene or event conditional. Conditional meaning "do something only '''if''' some condition is met", such as attaching a condition to your "Come Home" scene so it is only run '''if''' the temperature is over 70 degrees. Basic conditional expressions are easy, and, if that's all you're looking to do, skip to the walk-through below.

If you're more technically inclined you can also do very advanced things too. For an overview of all the advanced things you can do with Vera's Luup engine, and how scenes and events fit in, see the [[Luup_Intro]] page.

To add Lua code to a scene, create the [[Scenes]] and click 'Luup scene'. Fill in your Lua code in the input box. To do a simple condition, see the sample below. Or if you want to do advanced scripting you can use any [[http://lua.org Lua]] commands as described in the [[http://www.lua.org/manual/5.1/ Lua reference manual]] as well as the variables and functions that the Luup engine adds to Lua documented here: [[Luup_Lua_extensions]]. The Lua code will be run every time the scene is activated either by the user or a scene or a timer. The Lua code is run before the commands that you included in the scene. If your Lua code ends with this: "return false" then the commands in the scene will not be run.

You can also add Lua code to an event by clicking 'Luup event'. Since events are attached to scenes anyway, there is usually little difference between adding the code to an event, or to the scene the event is part of. If the Lua code in an event returns false, then the event is aborted, meaning the scene that the event is attached to will not be triggered by the event. The main reason for attaching Lua code to an event is if you have multiple events to a scene. For example, you may have a scene called "Turn lights on in hallway" which is triggered by 2 events: 1) The front door opens, and 2) the motion sensor in the hallway is tripped. Perhaps whenever the front door opens you always want the scene to be activated, but you only want the motion sensor to activate the scene before 10:00. In this case, you would add Lua code to the motion sensor's event which does something like (pseudo-code): "if time>10:00 return false". That way the event from the motion sensor will be aborted if it's after 10:00, but the event from the front door will always activate the scene regardless.

When you edit the Lua code in a scene or event you must click 'Save' before the code is saved. Then you can activate the scene or trigger the event to see what happens when your code is run. If you're doing some advanced scripting that you'll need to debug this can be tedious, but there are easy ways to test your Lua script immediately without saving first as explained in [[Lua_Debugging]].

If you're doing advanced Lua scripting, you should note that all the Lua code in your scenes and events run in a single Lua instance, which is separate from any Lua plugins. This means if you set a global variable in one scene, or create a function inside the Lua code in a scene, then in another scene's Lua code you can use that global variable or call that function. You do not need to worry about conflicting with a Luup plugin, though, since they have their own Lua instance, meaning they have their own global variables and functions.

== Walk-through #1 -- At 12 noon, turn off the interior lights if the temperature is over 80 degrees ==

Before you start, in Vera's setup interface go to 'Devices' and click the '+' button next to the thermostat. Make note of the Device #.

In this walkthrough we'll assume it's Device #3, but use the actual device number of''your'' thermostat. Next, visit [[Luup Variables]] to get a list of all the variables for devices. A variable is a piece of information about the current state of a device, such as whether it's on or off, it's current temperature, etc.

Look down at ''Thermostat'', and copy the name of the service/variable which corresponds to the current temperature, namely. In this case, it's

urn:upnp-org:serviceId:TemperatureSensor1 CurrentTemperature

Notice that it states the <tt>CurrentTemperature</tt> is in Celsius. So type in "80 degrees Fahrenheit to Celsius" in Google and you'll see that it's 26.6 degrees Celsius.

Now, the first step is to create the scene that turns off the lights. In Vera's setup interface, click 'Scenes', and click 'Add Scene' to add a new scene to one of the rooms. It's not important which room you choose. Scenes are categorized in rooms just to help you keep track of them if you have a lot of scenes. You can also put the scene in 'Global Scenes', or, you can create dummy rooms on the 'Rooms' tab if you want to have more "rooms" to organize your scenes with. After you click 'Add Scene', type in a description to remember your scene by, such as "Lights off 12:00 if 80". Under the 'Commands' area you'll see all the rooms. Click '+' next to the rooms that have lights you want to control, and choose "Off" in the pull-down. At this point, you have a normal scene, and, if you were to save your changes now, whenever you click the scene on the dashboard or on a remote control, the lights should turn off.

Second, next to the scene's description click 'add timer'. You can give the timer a description too so that if you have multiple timers you can see in the logs which one is activating the scene. Choose "Day of week based". If you want this scene to only run on certain days of the week, just check off which days you want this scene to run on. Otherwise, you can leave them all unchecked (or check them all) to do it every day. Leave the pull-down at "a certain time of day", and choose 12 : 00 : 00 from the pull-downs. At this point, if you were to save your changes, the lights would turn off automatically at 12 noon.

Third, the last step is to add the condition. To the right of the scene's description you'll see the button "Luup Scene". Click it and in the code box, copy and paste the following:

local lul_temp=luup.variable_get("urn:upnp-org:serviceId:TemperatureSensor1","CurrentTemperature",3)
if( tonumber(lul_temp)<26.6 ) then
return false
end

Don't forget to change the "3" to whatever is the actual device number of your thermostat. Assign the result of <tt>luup.variable_get</tt> to a variable first, rather than putting it directly in the <tt>tonumber()</tt>, because <tt>luup.variable_get</tt> actually returns 2 values: the value of the variable, and the time when the variable was modified. The '<tt>tonumber</tt>' is needed because all of a device's variables are stored as plain text--not numbers--so if you want to do arithmetic or numeric comparison of a variable, you need to put <tt>tonumber()</tt> around <tt>luup.variable_get</tt>.

<tt>luup.variable_get</tt> is documented in [[Luup Lua extensions]].

Now click 'Update', and then click 'Save' to save everything. The "return false" means "don't run this scene". So if the current temperature is <26.6, the scene will be aborted and won't run. The timer will make it trigger every day at 12 noon.

To test it, you can click the scene button on the dashboard. The lights will turn off only if the temperature is over 80 degrees. If it's less than 80 degrees, the scene won't do anything. Since this scene is something that happens automatically and you probably won't execute manually, you can go to the scene again and check the "Hidden" box so the scene doesn't show up on Vera's 'Dashboard' and on your remote controls, like the iPhone. If you want to have a scene that turns off the lights which you can run whenever you want from 'Dashboard'' or your remote control, you should create another scene that has the same commands and simply don't add the timers and Luup conditions, and don't check the "Hidden" box.

You can substitute other service/variables and device ID's to make other types of conditions. The "if" statement above also supports nesting with ( and ), as well as the keywords 'and' and 'or'. So the following means the scene would abort if the temperature is <26.6 and >25, unless it's <23:

local lul_temp=luup.variable_get("urn:upnp-org:serviceId:TemperatureSensor1","CurrentTemperature",3)
if( (tonumber(lul_temp)<26.6
and tonumber(lul_temp)>25)
or tonumber(lul_temp)<23 ) then
return false
end

If the scene doesn't run, it's possible there is a syntax error. The easiest way to test this is to copy the Lua code from the scene, then go to Devices, Luup Plugins, and "Test Luup code". Paste the code in the box and click 'go'. If the info box above the 'go' button has a check and says "Message sent successful", your code is okay. If there's an error, it says: "Code failed".

To see if that's true, use putty, or telnet or ssh to log-in to Vera, as explained in detail in [[Lua Debugging]], and type:

cd /var/log/cmh
tail -f LuaUPnP.log | grep '^01'

Now click 'Save' in Vera's setup page, even if it's gray, as that will cause Vera to restart the Luup engine and log any syntax errors. See: [[Lua Debugging]] for in-depth details on how to debug.

== Samples ==

This page is a wiki which anyone can edit. If you have some Lua code you think other users might find useful, feel free to add it here.

=== Misc actions ===

Did you see the sample here already: http://wiki.micasaverde.com/index.php/Luup_Scenes_Events

====Turn an appliance switch or a Danfoss thermostat on for device #5====

luup.call_action("urn:upnp-org:serviceId:SwitchPower1","SetTarget",{ newTargetValue="1" },5)

====Turn an appliance switch or a Danfoss thermostat off====

luup.call_action("urn:upnp-org:serviceId:SwitchPower1","SetTarget",{ newTargetValue="0" },5)

====Do something if switch device #5 is on====

local lul_tmp = luup.variable_get("urn:upnp-org:serviceId:SwitchPower1","Status",5)
if( lul_tmp=="1" ) then
--something to do goes here
end

====Dim switch #6 to 30%====

luup.call_action("urn:upnp-org:serviceId:Dimming1","SetLoadLevelTarget",{ newLoadlevelTarget="30" },6)

====Arm motion sensor #7====

luup.variable_set("urn:micasaverde-com:serviceId:SecuritySensor1","Armed","1",7)

====Disarm motion sensor #7====

luup.variable_set("urn:micasaverde-com:serviceId:SecuritySensor1","Armed","0",7)

Note, arming and disarming isn't a concept within UPnP or Z-Wave. It's just a flag that the Luup engine uses, and is stored in a variable we created called "Armed".

====Run Scene #5====

Thanks "denix" on the forum for the correct syntax.
"Actually, the 4th parameter IS required, but it's not used. Otherwise the command fails with an error message"

luup.call_action("urn:micasaverde-com:serviceId:HomeAutomationGateway1","RunScene",{ SceneNum="5" }, 0)

In this case we left the device number off (the 4th parameter to <tt>luup.call_action</tt>), because the "<tt>RunScene</tt>" action is handled by the Luup engine itself--not by some device within Z-Wave, etc.

However, normally you don't need to <tt>luup.call_action</tt> in Lua code. Rather, whatever actions, or commands, you want to run, you put into the scene itself, and the only Lua code is to simply check if some condition is true and abort the scene if the condition isn't met.

====Change the Temperature on Thermostat (Cool) device #19====
luup.call_action("urn:upnp-org:serviceId:TemperatureSetpoint1_Cool",
"SetCurrentSetpoint", { NewCurrentSetpoint="68" },
19)

====Change the Temperature on a Thermostat (Heat) device #19====
luup.call_action("urn:upnp-org:serviceId:TemperatureSetpoint1_Heat",
"SetCurrentSetpoint",{ NewCurrentSetpoint="68" },
19)

===='Privacy' mode for Foscam FI8908[w]====

local IP_address = '<IP address of camera>'
local username = '<username>'
local password = '<password>'
local timeout = 5

function move_up()

luup.inet.wget( 'http://'..IP_address..'/decoder_control.cgi?command=0' , timeout, username, password )

end

-- center the camera; takes some time, so we have to wait 2 minutes for the command to complete

luup.inet.wget( 'http://'..IP_address..'/decoder_control.cgi?command=25', timeout, username, password )

luup.call_delay( 'move_up', 120 )

====Blinking lights====

http://forum.micasaverde.com/index.php?topic=5127.0

=== Calculate sunrise and sunset ===

See http://forum.micasaverde.com/index.php?topic=2073.msg8132#msg8132

=== Access the web ===
==== Invoke URL by GET request ====
Based on code by Jim/jgc94131
require('ltn12')
local http=require('socket.http')
local response_body = {}
local request_body = ''
socket.http.TIMEOUT = 4
local r, c, h = socket.http.request{
url = 'http://website/page?parameter1=value&parameter2=value',
method = "GET",
port = 80,
headers = {
["Content-Length"] = string.len(request_body),
["Content-Type"] = "application/x-www-form-urlencoded"
},
source = ltn12.source.string(request_body),
sink = ltn12.sink.table(response_body)
}

=== Access the current time ===

The Lua function

os.date (format, time)

converts a time value `time` into a human readable date/time string, according to `format`. If you leave out the optional `time` parameter, it defaults to current time. The `format` parameter defaults to a fairly complete format. If you specify '*t' as the format, it will return a table instead of a formatted string.

t = os.date('*t')
t => {year=2010, month=2, day=19, yday=50, wday=6, hour=22, min=45, sec=45, isdst=false}

The fields are year, month, day of month, day of year, day of week, hour in 24 hour clock, minutes, seconds and if it's Daylight Savings Time.

Current hour:

os.date('*t').hour

Current minute:

os.date('*t').min

Current second:

os.date('*t').sec

Do something between 16:00 and 21:15:

local t = os.date('*t')
local current_second = t.hour * 3600 + t.min * 60 + t.sec -- number of seconds since midnight
local min_time_in_seconds = 16 * 3600 + 0 * 60 -- 16:00
local max_time_in_seconds = 21 * 3600 + 15 * 60 -- 21:15

if (current_second > min_time_in_seconds) and (current_second < max_time_in_seconds)
then
-- do something
else
return false
end

See http://forum.micasaverde.com/index.php?topic=2015.0 and http://www.lua.org/manual/5.1/manual.html#5.8.

=== Set Z-Wave parameters ===

See http://forum.micasaverde.com/index.php?topic=1937.msg7803#msg7803

=== a scene if the temperature is outside of a range ===

add snippets here...

File:SceneFlowchart.png

2011-02-20T18:02:24Z

Solipsia:

ExpressControls3in1

2011-02-20T15:10:26Z

Solipsia: /* Usage */

[[Category:Hardware]]
[[Category:Plugins]]
[[Category:3rd Party]]

== Overview ==
The EZMotion Wireless 3-in-1 sensor is functionally identical to the HomeSeer HSM100 device. The user's manual is here: http://www.expresscontrols.com/pdf/EZMotionOwnerManual.pdf

=== Features ===

This unit is a contains three sensors that report values to the Vera:
* '''Motion Sensor''' with adjustable sensitivity and timeout
* '''Temperature Sensor'''
* '''Luminosity (Light Level) Sensor''' reporting level of light as a percentage between the brightest and darkest levels it has encountered since being switched on for the first time

The unit has a red LED which indicates when motion is detected and it can be disabled. It can also report its battery level as a percentage to the Vera.

== Basic Configuration ==
=== Wake Up interval ===
The unit sleeps for the duration of the Wake Up interval, which defaults to 1800 seconds or 30 minutes. When the interval expires, it wakes up and reports Temperature and Luminosity to the Vera. Note that while all 4 devices in the Vera MIOS screen can be configured for Wake Up intervals, only the setting for the '3-in-1 Sensor' has any effect and controls both Temperature and Luminosity intervals. The Motion Sensor is unaffected by the Wakeup Interval (see On Time below)

To set the Wake Up Interval, click on the spanner for the "3-in-1 sensor" device, click on Setting and set Wakeup Interval to the desired interval.

=== On Time ===
When the Motion Sensor is tripped, it transmits a tripped command and changes its state to Tripped=1 for the duration of the ON TIME variable. After this time has expired, it sends an Untripped command to the Vera and resets it state to Tripped=0. While the device is in a tripped state, any motion detected resets the interval timer but doesn't report a new trip event to the Vera. During the wait time the Motion Sensor device in the Vera will show Tripped=1 in the Advanced tab.

To set the ON TIME, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 2 (On Time) to 5 (or the desired interval in minutes)

'''Direct Association:''' The unit can be associated directly with another device such as a light. If you've done this, the unit will turn the light on when motion is sensed, then turn it off after the ON TIME. According to the sensor's manual up to four associated devices are supported, but associating more than one device does not work (as of Vera's firmware 1.0.900, see http://bugs.micasaverde.com/view.php?id=705).

Leave Parameter #6, "OnValue", at the default if you want the sensor tripped events in Vera.

=== Polling Frequency ===
The unit can only be polled when it is either in Test mode or within 3 seconds after waking up (see Wake Up Interval above). Polling at any other time will fail since the unit will not respond. Also, every time the unit wakes up, it updates Vera with the temperature and luminosity. This means that polling is unnecessary and the polling frequency should be set to 0 (disabled) or a long interval to avoid unnecessary traffic on Vera, which could cause updates to be missed.

An exception to this rule is when Vera is set to Always Awake (see AC Power below). In that case, the unit never wakes up, so never reports its values and must be polled at regular intervals.

=== Example ===
Consider the following example of how to configure the sensor and the Vera for a common application. Suppose you want to install a motion sensor in your garage to turn the lights on when you enter, keep them on for as long as you move around in the garage, then turn them off 5 minutes after you've left.
# Put the unit in Test mode by pressing the button on the side
# Configure the On Time to 5 minutes
# Create two scenes in Vera:
## Turn on the light when the unit has tripped (New Scene, Events tab, Add Event, Device=Motion sensor, Type of Event=Armed sensor has tripped, Name=whatever, Tripped=Yes)
## Turn off the light when the unit sends an untrip command which happens after the On Time interval. (New Scene, Events tab, Add Event, Device=Motion sensor, Type of Event=Armed sensor has tripped, Name=whatever, Tripped=No)

== Advanced Configuration ==
=== Running from AC Power ===
==== Overview ====
It is possible to run the unit from AC power instead of batteries, which will have the following benefits:
* Allow you to keep the unit awake permanently, allowing you to poll it and customise it without being in Test mode
* Report continuously every time motion is sensed, as opposed to waiting for the ON TIME duration in between trips
* Set the unit to report temperature and light levels at higher frequencies up to 1 minute
* Let the unit act as a Z-Wave repeater, increasing the span of your network
* Never worry about running down batteries. All of the above options are possible on battery power, but will run your batteries down within a few days
==== Configure ====
To do this, you will need to connect a AC to DC transformer that supplies 4.5v to 5.5v at up to 1amp to the battery terminals directly. Ensure that you measure that actual output voltage of the transformer using a multi/voltage meter (don't rely on its advertised rating). Any over-voltage may fry the unit. Also make sure that the polarity is correct. It may be helpful to add a diode in series with the positive terminal to prevent accidentally frying the unit if the polarity is incorrect. It will drop the voltage by 0.6v though.

'''Setting ''Stay Awake'' to On'''
By default, the unit is constantly asleep and only wakes up at regular intervals to report the luminosity and temperature, before sleeping again. This is to save batteries. While asleep, the unit cannot be programmed from the Vera and cannot be polled for information. To get around this, one normally activates the Test mode by pressing the button on the side of the unit, which keeps it awake for 10 minutes so that it can be programmed. By setting the unit to stay awake constantly, you can program, poll or configure it at any time. It also has the side effect of enabling the unit to become a repeater of Z Wave signals throughout the network.

To set it, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 5 (Stay Awake) to 1 or any number greater than 0.

'''Setting ''On Time'' to ''Always Fire'''''
When the unit detects motion, it reports it by sending a Tripped command to the Vera. It then waits for the duration of the On Time and then sends un Untripped command to the Vera and waits for the next motion. Since battery life is not a consideration while on AC power, you can set it to 'Always Fire', which sends a Tripped command whenever motion is detected with no waiting period. Note, this will also prevent an Untripped command from being sent.

To set it, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 2 (On Time) to 0.

'''Excluding and Reincluding the unit'''
To activate these new settings, you will need to exclude and reinclude the unit using the standard Vera process. Remember to save your settings first.

''' Setting Poll frequency'''
The unit usually only reports temperate and luminosity every time it wakes up, but since the unit is now constantly awake, you will have to configure a poll frequency to gather that information.

To set it, click on the spanner for the "Motion Sensor" device, click on Settings and set "Poll this node at most every" to the required update frequency. The Wakeup interval setting on this same screen has no effect since it's been overridden by Always Awake setting.

== Known issues ==

ExpressControls3in1

2011-02-20T15:08:20Z

Solipsia: /* Overview */

[[Category:Hardware]]
[[Category:Plugins]]
[[Category:3rd Party]]

== Overview ==
The EZMotion Wireless 3-in-1 sensor is functionally identical to the HomeSeer HSM100 device. The user's manual is here: http://www.expresscontrols.com/pdf/EZMotionOwnerManual.pdf

=== Features ===

This unit is a contains three sensors that report values to the Vera:
* '''Motion Sensor''' with adjustable sensitivity and timeout
* '''Temperature Sensor'''
* '''Luminosity (Light Level) Sensor''' reporting level of light as a percentage between the brightest and darkest levels it has encountered since being switched on for the first time

The unit has a red LED which indicates when motion is detected and it can be disabled. It can also report its battery level as a percentage to the Vera.

=== Usage ===

You can add an [[Event]] to your [[Scenes]] 'sensor tripped' or 'armed sensor is tripped' so the scene is executed when the motion sensor is tripped. (See also [[Intro Security]].) You can see the current temperature and light level on Vera's dashboard or on the mobile phone interface.

To pair the sensor with Vera (i.e. add it to Vera's Z-Wave network), bring Vera's dongle near the sensor as you would pair any device, and press the blue button on the 3-in-1 sensor. Reconnect Vera's Z-Wave dongle.

Vera needs to communicate with the sensor to identify what type of device it is and configure it. But the sensor will only talk to Vera within a minute of pressing the blue button. After re-connecting Vera's Z-Wave dongle, wait 60 seconds, and if the sensor shows up as 'Generic IO', go press the blue button again, and again wait 60 seconds. Vera should show it as an 'Express Controls' with 3 embedded devices. Assign it to a room like any other device.

If you want Vera to be able to use the sensor, click the '+' button next to the device. Check the box "Let Vera manage the associations". Fill in the 'wakeup interval' box. The sensor is normally asleep to conserve the batteries and will only report the temperature and light reading when it periodically wakes up. This is the frequency of the wakeup. The minimum number you can put in is 360, which means 6 minutes (i.e. 6 minutes * 60 seconds/minute = 360 seconds). At 360, you will get a new light/temperature reading every 6 minutes. However, at this rate, the batteries may only last a couple months. You can instead put in a wakeup interval of, for example, 3600 (i.e. 1 hour) and the batteries will last a lot longer, but the reading Vera has for the current temperature and light may be up to 1 hour old.

When you have specified those settings, save your changes. Wait a minute for Vera to configure the Z-Wave devices and check the color of the cog wheel next to the sensor as explained [[Device Control Status|here]]. If it's green, everything is okay and the sensor will work. If it's red, Vera was not able to configure the sensor because it probably went to sleep already by the time you saved your changes. Go to the sensor and press the blue button. Within a minute or so it should turn green.

If you have difficulty getting the green cog icon, try pressing the blue button on the sensor, then in Vera's device page, click the '+' button for the device and click 'configure right now'.

There are also a few custom configuration settings for the sensor for things like Sensitivity, Timeout Delay, LED Enabled, Light Threshold, and so on. To set them, click the + button next to the device, choose 'Custom Z-Wave Settings', then 'Add configuration setting', put in the variable number that corresponds to the setting you want to change, choose a data size of '1 byte dec' and enter the desired value, as shown below. Then click 'Save'. Vera will attempt to re-configure the sensor. If it fails, probably because the sensor is asleep, you will see the red cog. Press the blue button on the sensor and you should get a green cog meaning the sensor has been configured with your new settings. (See also: [[ZWave Options]])

== Basic Configuration ==
=== Wake Up interval ===
The unit sleeps for the duration of the Wake Up interval, which defaults to 1800 seconds or 30 minutes. When the interval expires, it wakes up and reports Temperature and Luminosity to the Vera. Note that while all 4 devices in the Vera MIOS screen can be configured for Wake Up intervals, only the setting for the '3-in-1 Sensor' has any effect and controls both Temperature and Luminosity intervals. The Motion Sensor is unaffected by the Wakeup Interval (see On Time below)

To set the Wake Up Interval, click on the spanner for the "3-in-1 sensor" device, click on Setting and set Wakeup Interval to the desired interval.

=== On Time ===
When the Motion Sensor is tripped, it transmits a tripped command and changes its state to Tripped=1 for the duration of the ON TIME variable. After this time has expired, it sends an Untripped command to the Vera and resets it state to Tripped=0. While the device is in a tripped state, any motion detected resets the interval timer but doesn't report a new trip event to the Vera. During the wait time the Motion Sensor device in the Vera will show Tripped=1 in the Advanced tab.

To set the ON TIME, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 2 (On Time) to 5 (or the desired interval in minutes)

'''Direct Association:''' The unit can be associated directly with another device such as a light. If you've done this, the unit will turn the light on when motion is sensed, then turn it off after the ON TIME. According to the sensor's manual up to four associated devices are supported, but associating more than one device does not work (as of Vera's firmware 1.0.900, see http://bugs.micasaverde.com/view.php?id=705).

Leave Parameter #6, "OnValue", at the default if you want the sensor tripped events in Vera.

=== Polling Frequency ===
The unit can only be polled when it is either in Test mode or within 3 seconds after waking up (see Wake Up Interval above). Polling at any other time will fail since the unit will not respond. Also, every time the unit wakes up, it updates Vera with the temperature and luminosity. This means that polling is unnecessary and the polling frequency should be set to 0 (disabled) or a long interval to avoid unnecessary traffic on Vera, which could cause updates to be missed.

An exception to this rule is when Vera is set to Always Awake (see AC Power below). In that case, the unit never wakes up, so never reports its values and must be polled at regular intervals.

=== Example ===
Consider the following example of how to configure the sensor and the Vera for a common application. Suppose you want to install a motion sensor in your garage to turn the lights on when you enter, keep them on for as long as you move around in the garage, then turn them off 5 minutes after you've left.
# Put the unit in Test mode by pressing the button on the side
# Configure the On Time to 5 minutes
# Create two scenes in Vera:
## Turn on the light when the unit has tripped (New Scene, Events tab, Add Event, Device=Motion sensor, Type of Event=Armed sensor has tripped, Name=whatever, Tripped=Yes)
## Turn off the light when the unit sends an untrip command which happens after the On Time interval. (New Scene, Events tab, Add Event, Device=Motion sensor, Type of Event=Armed sensor has tripped, Name=whatever, Tripped=No)

== Advanced Configuration ==
=== Running from AC Power ===
==== Overview ====
It is possible to run the unit from AC power instead of batteries, which will have the following benefits:
* Allow you to keep the unit awake permanently, allowing you to poll it and customise it without being in Test mode
* Report continuously every time motion is sensed, as opposed to waiting for the ON TIME duration in between trips
* Set the unit to report temperature and light levels at higher frequencies up to 1 minute
* Let the unit act as a Z-Wave repeater, increasing the span of your network
* Never worry about running down batteries. All of the above options are possible on battery power, but will run your batteries down within a few days
==== Configure ====
To do this, you will need to connect a AC to DC transformer that supplies 4.5v to 5.5v at up to 1amp to the battery terminals directly. Ensure that you measure that actual output voltage of the transformer using a multi/voltage meter (don't rely on its advertised rating). Any over-voltage may fry the unit. Also make sure that the polarity is correct. It may be helpful to add a diode in series with the positive terminal to prevent accidentally frying the unit if the polarity is incorrect. It will drop the voltage by 0.6v though.

'''Setting ''Stay Awake'' to On'''
By default, the unit is constantly asleep and only wakes up at regular intervals to report the luminosity and temperature, before sleeping again. This is to save batteries. While asleep, the unit cannot be programmed from the Vera and cannot be polled for information. To get around this, one normally activates the Test mode by pressing the button on the side of the unit, which keeps it awake for 10 minutes so that it can be programmed. By setting the unit to stay awake constantly, you can program, poll or configure it at any time. It also has the side effect of enabling the unit to become a repeater of Z Wave signals throughout the network.

To set it, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 5 (Stay Awake) to 1 or any number greater than 0.

'''Setting ''On Time'' to ''Always Fire'''''
When the unit detects motion, it reports it by sending a Tripped command to the Vera. It then waits for the duration of the On Time and then sends un Untripped command to the Vera and waits for the next motion. Since battery life is not a consideration while on AC power, you can set it to 'Always Fire', which sends a Tripped command whenever motion is detected with no waiting period. Note, this will also prevent an Untripped command from being sent.

To set it, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 2 (On Time) to 0.

'''Excluding and Reincluding the unit'''
To activate these new settings, you will need to exclude and reinclude the unit using the standard Vera process. Remember to save your settings first.

''' Setting Poll frequency'''
The unit usually only reports temperate and luminosity every time it wakes up, but since the unit is now constantly awake, you will have to configure a poll frequency to gather that information.

To set it, click on the spanner for the "Motion Sensor" device, click on Settings and set "Poll this node at most every" to the required update frequency. The Wakeup interval setting on this same screen has no effect since it's been overridden by Always Awake setting.

== Known issues ==

ExpressControls3in1

2011-02-20T14:58:32Z

Solipsia: /* Configure */

[[Category:Hardware]]
[[Category:Plugins]]
[[Category:3rd Party]]

== Overview ==
This unit is functionally identical to the HomeSeer HSM100 device. The user's manual is here: http://www.expresscontrols.com/pdf/EZMotionOwnerManual.pdf

You can add an [[Event]] to your [[Scenes]] 'sensor tripped' or 'armed sensor is tripped' so the scene is executed when the motion sensor is tripped. (See also [[Intro Security]].) You can see the current temperature and light level on Vera's dashboard or on the mobile phone interface.

To pair the sensor with Vera (i.e. add it to Vera's Z-Wave network), bring Vera's dongle near the sensor as you would pair any device, and press the blue button on the 3-in-1 sensor. Reconnect Vera's Z-Wave dongle.

Vera needs to communicate with the sensor to identify what type of device it is and configure it. But the sensor will only talk to Vera within a minute of pressing the blue button. After re-connecting Vera's Z-Wave dongle, wait 60 seconds, and if the sensor shows up as 'Generic IO', go press the blue button again, and again wait 60 seconds. Vera should show it as an 'Express Controls' with 3 embedded devices. Assign it to a room like any other device.

If you want Vera to be able to use the sensor, click the '+' button next to the device. Check the box "Let Vera manage the associations". Fill in the 'wakeup interval' box. The sensor is normally asleep to conserve the batteries and will only report the temperature and light reading when it periodically wakes up. This is the frequency of the wakeup. The minimum number you can put in is 360, which means 6 minutes (i.e. 6 minutes * 60 seconds/minute = 360 seconds). At 360, you will get a new light/temperature reading every 6 minutes. However, at this rate, the batteries may only last a couple months. You can instead put in a wakeup interval of, for example, 3600 (i.e. 1 hour) and the batteries will last a lot longer, but the reading Vera has for the current temperature and light may be up to 1 hour old.

When you have specified those settings, save your changes. Wait a minute for Vera to configure the Z-Wave devices and check the color of the cog wheel next to the sensor as explained [[Device Control Status|here]]. If it's green, everything is okay and the sensor will work. If it's red, Vera was not able to configure the sensor because it probably went to sleep already by the time you saved your changes. Go to the sensor and press the blue button. Within a minute or so it should turn green.

If you have difficulty getting the green cog icon, try pressing the blue button on the sensor, then in Vera's device page, click the '+' button for the device and click 'configure right now'.

There are also a few custom configuration settings for the sensor for things like Sensitivity, Timeout Delay, LED Enabled, Light Threshold, and so on. To set them, click the + button next to the device, choose 'Custom Z-Wave Settings', then 'Add configuration setting', put in the variable number that corresponds to the setting you want to change, choose a data size of '1 byte dec' and enter the desired value, as shown below. Then click 'Save'. Vera will attempt to re-configure the sensor. If it fails, probably because the sensor is asleep, you will see the red cog. Press the blue button on the sensor and you should get a green cog meaning the sensor has been configured with your new settings. (See also: [[ZWave Options]])
== Basic Configuration ==
=== Wake Up interval ===
The unit sleeps for the duration of the Wake Up interval, which defaults to 1800 seconds or 30 minutes. When the interval expires, it wakes up and reports Temperature and Luminosity to the Vera. Note that while all 4 devices in the Vera MIOS screen can be configured for Wake Up intervals, only the setting for the '3-in-1 Sensor' has any effect and controls both Temperature and Luminosity intervals. The Motion Sensor is unaffected by the Wakeup Interval (see On Time below)

To set the Wake Up Interval, click on the spanner for the "3-in-1 sensor" device, click on Setting and set Wakeup Interval to the desired interval.

=== On Time ===
When the Motion Sensor is tripped, it transmits a tripped command and changes its state to Tripped=1 for the duration of the ON TIME variable. After this time has expired, it sends an Untripped command to the Vera and resets it state to Tripped=0. While the device is in a tripped state, any motion detected resets the interval timer but doesn't report a new trip event to the Vera. During the wait time the Motion Sensor device in the Vera will show Tripped=1 in the Advanced tab.

To set the ON TIME, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 2 (On Time) to 5 (or the desired interval in minutes)

'''Direct Association:''' The unit can be associated directly with another device such as a light. If you've done this, the unit will turn the light on when motion is sensed, then turn it off after the ON TIME. According to the sensor's manual up to four associated devices are supported, but associating more than one device does not work (as of Vera's firmware 1.0.900, see http://bugs.micasaverde.com/view.php?id=705).

Leave Parameter #6, "OnValue", at the default if you want the sensor tripped events in Vera.

=== Polling Frequency ===
The unit can only be polled when it is either in Test mode or within 3 seconds after waking up (see Wake Up Interval above). Polling at any other time will fail since the unit will not respond. Also, every time the unit wakes up, it updates Vera with the temperature and luminosity. This means that polling is unnecessary and the polling frequency should be set to 0 (disabled) or a long interval to avoid unnecessary traffic on Vera, which could cause updates to be missed.

An exception to this rule is when Vera is set to Always Awake (see AC Power below). In that case, the unit never wakes up, so never reports its values and must be polled at regular intervals.

=== Example ===
Consider the following example of how to configure the sensor and the Vera for a common application. Suppose you want to install a motion sensor in your garage to turn the lights on when you enter, keep them on for as long as you move around in the garage, then turn them off 5 minutes after you've left.
# Put the unit in Test mode by pressing the button on the side
# Configure the On Time to 5 minutes
# Create two scenes in Vera:
## Turn on the light when the unit has tripped (New Scene, Events tab, Add Event, Device=Motion sensor, Type of Event=Armed sensor has tripped, Name=whatever, Tripped=Yes)
## Turn off the light when the unit sends an untrip command which happens after the On Time interval. (New Scene, Events tab, Add Event, Device=Motion sensor, Type of Event=Armed sensor has tripped, Name=whatever, Tripped=No)

== Advanced Configuration ==
=== Running from AC Power ===
==== Overview ====
It is possible to run the unit from AC power instead of batteries, which will have the following benefits:
* Allow you to keep the unit awake permanently, allowing you to poll it and customise it without being in Test mode
* Report continuously every time motion is sensed, as opposed to waiting for the ON TIME duration in between trips
* Set the unit to report temperature and light levels at higher frequencies up to 1 minute
* Let the unit act as a Z-Wave repeater, increasing the span of your network
* Never worry about running down batteries. All of the above options are possible on battery power, but will run your batteries down within a few days
==== Configure ====
To do this, you will need to connect a AC to DC transformer that supplies 4.5v to 5.5v at up to 1amp to the battery terminals directly. Ensure that you measure that actual output voltage of the transformer using a multi/voltage meter (don't rely on its advertised rating). Any over-voltage may fry the unit. Also make sure that the polarity is correct. It may be helpful to add a diode in series with the positive terminal to prevent accidentally frying the unit if the polarity is incorrect. It will drop the voltage by 0.6v though.

'''Setting ''Stay Awake'' to On'''
By default, the unit is constantly asleep and only wakes up at regular intervals to report the luminosity and temperature, before sleeping again. This is to save batteries. While asleep, the unit cannot be programmed from the Vera and cannot be polled for information. To get around this, one normally activates the Test mode by pressing the button on the side of the unit, which keeps it awake for 10 minutes so that it can be programmed. By setting the unit to stay awake constantly, you can program, poll or configure it at any time. It also has the side effect of enabling the unit to become a repeater of Z Wave signals throughout the network.

To set it, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 5 (Stay Awake) to 1 or any number greater than 0.

'''Setting ''On Time'' to ''Always Fire'''''
When the unit detects motion, it reports it by sending a Tripped command to the Vera. It then waits for the duration of the On Time and then sends un Untripped command to the Vera and waits for the next motion. Since battery life is not a consideration while on AC power, you can set it to 'Always Fire', which sends a Tripped command whenever motion is detected with no waiting period. Note, this will also prevent an Untripped command from being sent.

To set it, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 2 (On Time) to 0.

'''Excluding and Reincluding the unit'''
To activate these new settings, you will need to exclude and reinclude the unit using the standard Vera process. Remember to save your settings first.

''' Setting Poll frequency'''
The unit usually only reports temperate and luminosity every time it wakes up, but since the unit is now constantly awake, you will have to configure a poll frequency to gather that information.

To set it, click on the spanner for the "Motion Sensor" device, click on Settings and set "Poll this node at most every" to the required update frequency. The Wakeup interval setting on this same screen has no effect since it's been overridden by Always Awake setting.

== Known issues ==

ExpressControls3in1

2011-02-20T14:56:36Z

Solipsia: /* Basic Configuration */

[[Category:Hardware]]
[[Category:Plugins]]
[[Category:3rd Party]]

== Overview ==
This unit is functionally identical to the HomeSeer HSM100 device. The user's manual is here: http://www.expresscontrols.com/pdf/EZMotionOwnerManual.pdf

You can add an [[Event]] to your [[Scenes]] 'sensor tripped' or 'armed sensor is tripped' so the scene is executed when the motion sensor is tripped. (See also [[Intro Security]].) You can see the current temperature and light level on Vera's dashboard or on the mobile phone interface.

To pair the sensor with Vera (i.e. add it to Vera's Z-Wave network), bring Vera's dongle near the sensor as you would pair any device, and press the blue button on the 3-in-1 sensor. Reconnect Vera's Z-Wave dongle.

Vera needs to communicate with the sensor to identify what type of device it is and configure it. But the sensor will only talk to Vera within a minute of pressing the blue button. After re-connecting Vera's Z-Wave dongle, wait 60 seconds, and if the sensor shows up as 'Generic IO', go press the blue button again, and again wait 60 seconds. Vera should show it as an 'Express Controls' with 3 embedded devices. Assign it to a room like any other device.

If you want Vera to be able to use the sensor, click the '+' button next to the device. Check the box "Let Vera manage the associations". Fill in the 'wakeup interval' box. The sensor is normally asleep to conserve the batteries and will only report the temperature and light reading when it periodically wakes up. This is the frequency of the wakeup. The minimum number you can put in is 360, which means 6 minutes (i.e. 6 minutes * 60 seconds/minute = 360 seconds). At 360, you will get a new light/temperature reading every 6 minutes. However, at this rate, the batteries may only last a couple months. You can instead put in a wakeup interval of, for example, 3600 (i.e. 1 hour) and the batteries will last a lot longer, but the reading Vera has for the current temperature and light may be up to 1 hour old.

When you have specified those settings, save your changes. Wait a minute for Vera to configure the Z-Wave devices and check the color of the cog wheel next to the sensor as explained [[Device Control Status|here]]. If it's green, everything is okay and the sensor will work. If it's red, Vera was not able to configure the sensor because it probably went to sleep already by the time you saved your changes. Go to the sensor and press the blue button. Within a minute or so it should turn green.

If you have difficulty getting the green cog icon, try pressing the blue button on the sensor, then in Vera's device page, click the '+' button for the device and click 'configure right now'.

There are also a few custom configuration settings for the sensor for things like Sensitivity, Timeout Delay, LED Enabled, Light Threshold, and so on. To set them, click the + button next to the device, choose 'Custom Z-Wave Settings', then 'Add configuration setting', put in the variable number that corresponds to the setting you want to change, choose a data size of '1 byte dec' and enter the desired value, as shown below. Then click 'Save'. Vera will attempt to re-configure the sensor. If it fails, probably because the sensor is asleep, you will see the red cog. Press the blue button on the sensor and you should get a green cog meaning the sensor has been configured with your new settings. (See also: [[ZWave Options]])
== Basic Configuration ==
=== Wake Up interval ===
The unit sleeps for the duration of the Wake Up interval, which defaults to 1800 seconds or 30 minutes. When the interval expires, it wakes up and reports Temperature and Luminosity to the Vera. Note that while all 4 devices in the Vera MIOS screen can be configured for Wake Up intervals, only the setting for the '3-in-1 Sensor' has any effect and controls both Temperature and Luminosity intervals. The Motion Sensor is unaffected by the Wakeup Interval (see On Time below)

To set the Wake Up Interval, click on the spanner for the "3-in-1 sensor" device, click on Setting and set Wakeup Interval to the desired interval.

=== On Time ===
When the Motion Sensor is tripped, it transmits a tripped command and changes its state to Tripped=1 for the duration of the ON TIME variable. After this time has expired, it sends an Untripped command to the Vera and resets it state to Tripped=0. While the device is in a tripped state, any motion detected resets the interval timer but doesn't report a new trip event to the Vera. During the wait time the Motion Sensor device in the Vera will show Tripped=1 in the Advanced tab.

To set the ON TIME, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 2 (On Time) to 5 (or the desired interval in minutes)

'''Direct Association:''' The unit can be associated directly with another device such as a light. If you've done this, the unit will turn the light on when motion is sensed, then turn it off after the ON TIME. According to the sensor's manual up to four associated devices are supported, but associating more than one device does not work (as of Vera's firmware 1.0.900, see http://bugs.micasaverde.com/view.php?id=705).

Leave Parameter #6, "OnValue", at the default if you want the sensor tripped events in Vera.

=== Polling Frequency ===
The unit can only be polled when it is either in Test mode or within 3 seconds after waking up (see Wake Up Interval above). Polling at any other time will fail since the unit will not respond. Also, every time the unit wakes up, it updates Vera with the temperature and luminosity. This means that polling is unnecessary and the polling frequency should be set to 0 (disabled) or a long interval to avoid unnecessary traffic on Vera, which could cause updates to be missed.

An exception to this rule is when Vera is set to Always Awake (see AC Power below). In that case, the unit never wakes up, so never reports its values and must be polled at regular intervals.

=== Example ===
Consider the following example of how to configure the sensor and the Vera for a common application. Suppose you want to install a motion sensor in your garage to turn the lights on when you enter, keep them on for as long as you move around in the garage, then turn them off 5 minutes after you've left.
# Put the unit in Test mode by pressing the button on the side
# Configure the On Time to 5 minutes
# Create two scenes in Vera:
## Turn on the light when the unit has tripped (New Scene, Events tab, Add Event, Device=Motion sensor, Type of Event=Armed sensor has tripped, Name=whatever, Tripped=Yes)
## Turn off the light when the unit sends an untrip command which happens after the On Time interval. (New Scene, Events tab, Add Event, Device=Motion sensor, Type of Event=Armed sensor has tripped, Name=whatever, Tripped=No)

== Advanced Configuration ==
=== Running from AC Power ===
==== Overview ====
It is possible to run the unit from AC power instead of batteries, which will have the following benefits:
* Allow you to keep the unit awake permanently, allowing you to poll it and customise it without being in Test mode
* Report continuously every time motion is sensed, as opposed to waiting for the ON TIME duration in between trips
* Set the unit to report temperature and light levels at higher frequencies up to 1 minute
* Let the unit act as a Z-Wave repeater, increasing the span of your network
* Never worry about running down batteries. All of the above options are possible on battery power, but will run your batteries down within a few days
==== Configure ====
To do this, you will need to connect a AC to DC transformer that supplies 4.5v to 5v at up to 1amp to the battery terminals directly. Ensure that you measure that actual output voltage of the transformer using a multi/voltage meter (don't rely on its advertised rating). Any over-voltage may fry the unit. Also make sure that the polarity is correct.

'''Setting ''Stay Awake'' to On'''
By default, the unit is constantly asleep and only wakes up at regular intervals to report the luminosity and temperature, before sleeping again. This is to save batteries. While asleep, the unit cannot be programmed from the Vera and cannot be polled for information. To get around this, one normally activates the Test mode by pressing the button on the side of the unit, which keeps it awake for 10 minutes so that it can be programmed. By setting the unit to stay awake constantly, you can program, poll or configure it at any time. It also has the side effect of enabling the unit to become a repeater of Z Wave signals throughout the network.

To set it, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 5 (Stay Awake) to 1 or any number greater than 0.

'''Setting ''On Time'' to ''Always Fire'''''
When the unit detects motion, it reports it by sending a Tripped command to the Vera. It then waits for the duration of the On Time and then sends un Untripped command to the Vera and waits for the next motion. Since battery life is not a consideration while on AC power, you can set it to 'Always Fire', which sends a Tripped command whenever motion is detected with no waiting period. Note, this will also prevent an Untripped command from being sent.

To set it, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 2 (On Time) to 0.

'''Excluding and Reincluding the unit'''
To activate these new settings, you will need to exclude and reinclude the unit using the standard Vera process. Remember to save your settings first.

''' Setting Poll frequency'''
The unit usually only reports temperate and luminosity every time it wakes up, but since the unit is now constantly awake, you will have to configure a poll frequency to gather that information.

To set it, click on the spanner for the "Motion Sensor" device, click on Settings and set "Poll this node at most every" to the required update frequency. The Wakeup interval setting on this same screen has no effect since it's been overridden by Always Awake setting.

== Known issues ==

ExpressControls3in1

2011-02-19T15:12:48Z

Solipsia: /* Configure */

[[Category:Hardware]]
[[Category:Plugins]]
[[Category:3rd Party]]

== Overview ==
This unit is functionally identical to the HomeSeer HSM100 device. The user's manual is here: http://www.expresscontrols.com/pdf/EZMotionOwnerManual.pdf

You can add an [[Event]] to your [[Scenes]] 'sensor tripped' or 'armed sensor is tripped' so the scene is executed when the motion sensor is tripped. (See also [[Intro Security]].) You can see the current temperature and light level on Vera's dashboard or on the mobile phone interface.

To pair the sensor with Vera (i.e. add it to Vera's Z-Wave network), bring Vera's dongle near the sensor as you would pair any device, and press the blue button on the 3-in-1 sensor. Reconnect Vera's Z-Wave dongle.

Vera needs to communicate with the sensor to identify what type of device it is and configure it. But the sensor will only talk to Vera within a minute of pressing the blue button. After re-connecting Vera's Z-Wave dongle, wait 60 seconds, and if the sensor shows up as 'Generic IO', go press the blue button again, and again wait 60 seconds. Vera should show it as an 'Express Controls' with 3 embedded devices. Assign it to a room like any other device.

If you want Vera to be able to use the sensor, click the '+' button next to the device. Check the box "Let Vera manage the associations". Fill in the 'wakeup interval' box. The sensor is normally asleep to conserve the batteries and will only report the temperature and light reading when it periodically wakes up. This is the frequency of the wakeup. The minimum number you can put in is 360, which means 6 minutes (i.e. 6 minutes * 60 seconds/minute = 360 seconds). At 360, you will get a new light/temperature reading every 6 minutes. However, at this rate, the batteries may only last a couple months. You can instead put in a wakeup interval of, for example, 3600 (i.e. 1 hour) and the batteries will last a lot longer, but the reading Vera has for the current temperature and light may be up to 1 hour old.

When you have specified those settings, save your changes. Wait a minute for Vera to configure the Z-Wave devices and check the color of the cog wheel next to the sensor as explained [[Device Control Status|here]]. If it's green, everything is okay and the sensor will work. If it's red, Vera was not able to configure the sensor because it probably went to sleep already by the time you saved your changes. Go to the sensor and press the blue button. Within a minute or so it should turn green.

If you have difficulty getting the green cog icon, try pressing the blue button on the sensor, then in Vera's device page, click the '+' button for the device and click 'configure right now'.

There are also a few custom configuration settings for the sensor for things like Sensitivity, Timeout Delay, LED Enabled, Light Threshold, and so on. To set them, click the + button next to the device, choose 'Custom Z-Wave Settings', then 'Add configuration setting', put in the variable number that corresponds to the setting you want to change, choose a data size of '1 byte dec' and enter the desired value, as shown below. Then click 'Save'. Vera will attempt to re-configure the sensor. If it fails, probably because the sensor is asleep, you will see the red cog. Press the blue button on the sensor and you should get a green cog meaning the sensor has been configured with your new settings. (See also: [[ZWave Options]])
== Basic Configuration ==
=== Wake Up interval ===
The unit sleeps for the duration of the Wake Up interval, which defaults to 1800 seconds or 30 minutes. When the interval expires, it wakes up and reports Temperature and Luminosity to the Vera. Note that while all 4 devices in the Vera MIOS screen can be configured for Wake Up intervals, only the setting for the '3-in-1 Sensor' has any effect and controls both Temperature and Luminosity intervals. The Motion Sensor is unaffected by the Wakeup Interval (see On Time below)

To set the Wake Up Interval, click on the spanner for the "3-in-1 sensor" device, click on Setting and set Wakeup Interval to the desired interval.

=== On Time ===
When the Motion Sensor is tripped, it transmits a tripped command and changes its state to Tripped=1 for the duration of the ON TIME variable. After this time has expired, it sends an Untripped command to the Vera and resets it state to Tripped=0. While the device is in a tripped state, any motion detected resets the interval timer but doesn't report a new trip event to the Vera. During the wait time the Motion Sensor device in the Vera will show Tripped=1 in the Advanced tab.

To set the ON TIME, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 2 (On Time) to 5 (or the desired interval in minutes)

'''Direct Association:''' The unit can be associated directly with another device such as a light. If you've done this, the unit will turn the light on when motion is sensed, then turn it off after the ON TIME. According to the sensor's manual up to four associated devices are supported, but associating more than one device does not work (as of Vera's firmware 1.0.900, see http://bugs.micasaverde.com/view.php?id=705).

Leave Parameter #6, "OnValue", at the default if you want the sensor tripped events in Vera.

=== Example ===
Consider the following example of how to configure the sensor and the Vera for a common application. Suppose you want to install a motion sensor in your garage to turn the lights on when you enter, keep them on for as long as you move around in the garage, then turn them off 5 minutes after you've left.
# Put the unit in Test mode by pressing the button on the side
# Configure the On Time to 5 minutes
# Create two scenes in Vera:
## Turn on the light when the unit has tripped (New Scene, Events tab, Add Event, Device=Motion sensor, Type of Event=Armed sensor has tripped, Name=whatever, Tripped=Yes)
## Turn off the light when the unit sends an untrip command which happens after the On Time interval. (New Scene, Events tab, Add Event, Device=Motion sensor, Type of Event=Armed sensor has tripped, Name=whatever, Tripped=No)

== Advanced Configuration ==
=== Running from AC Power ===
==== Overview ====
It is possible to run the unit from AC power instead of batteries, which will have the following benefits:
* Allow you to keep the unit awake permanently, allowing you to poll it and customise it without being in Test mode
* Report continuously every time motion is sensed, as opposed to waiting for the ON TIME duration in between trips
* Set the unit to report temperature and light levels at higher frequencies up to 1 minute
* Let the unit act as a Z-Wave repeater, increasing the span of your network
* Never worry about running down batteries. All of the above options are possible on battery power, but will run your batteries down within a few days
==== Configure ====
To do this, you will need to connect a AC to DC transformer that supplies 4.5v to 5v at up to 1amp to the battery terminals directly. Ensure that you measure that actual output voltage of the transformer using a multi/voltage meter (don't rely on its advertised rating). Any over-voltage may fry the unit. Also make sure that the polarity is correct.

'''Setting ''Stay Awake'' to On'''
By default, the unit is constantly asleep and only wakes up at regular intervals to report the luminosity and temperature, before sleeping again. This is to save batteries. While asleep, the unit cannot be programmed from the Vera and cannot be polled for information. To get around this, one normally activates the Test mode by pressing the button on the side of the unit, which keeps it awake for 10 minutes so that it can be programmed. By setting the unit to stay awake constantly, you can program, poll or configure it at any time. It also has the side effect of enabling the unit to become a repeater of Z Wave signals throughout the network.

To set it, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 5 (Stay Awake) to 1 or any number greater than 0.

'''Setting ''On Time'' to ''Always Fire'''''
When the unit detects motion, it reports it by sending a Tripped command to the Vera. It then waits for the duration of the On Time and then sends un Untripped command to the Vera and waits for the next motion. Since battery life is not a consideration while on AC power, you can set it to 'Always Fire', which sends a Tripped command whenever motion is detected with no waiting period. Note, this will also prevent an Untripped command from being sent.

To set it, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 2 (On Time) to 0.

'''Excluding and Reincluding the unit'''
To activate these new settings, you will need to exclude and reinclude the unit using the standard Vera process. Remember to save your settings first.

''' Setting Poll frequency'''
The unit usually only reports temperate and luminosity every time it wakes up, but since the unit is now constantly awake, you will have to configure a poll frequency to gather that information.

To set it, click on the spanner for the "Motion Sensor" device, click on Settings and set "Poll this node at most every" to the required update frequency. The Wakeup interval setting on this same screen has no effect since it's been overridden by Always Awake setting.

== Known issues ==

ExpressControls3in1

2011-02-19T15:11:44Z

Solipsia: /* On Time */

[[Category:Hardware]]
[[Category:Plugins]]
[[Category:3rd Party]]

== Overview ==
This unit is functionally identical to the HomeSeer HSM100 device. The user's manual is here: http://www.expresscontrols.com/pdf/EZMotionOwnerManual.pdf

You can add an [[Event]] to your [[Scenes]] 'sensor tripped' or 'armed sensor is tripped' so the scene is executed when the motion sensor is tripped. (See also [[Intro Security]].) You can see the current temperature and light level on Vera's dashboard or on the mobile phone interface.

To pair the sensor with Vera (i.e. add it to Vera's Z-Wave network), bring Vera's dongle near the sensor as you would pair any device, and press the blue button on the 3-in-1 sensor. Reconnect Vera's Z-Wave dongle.

Vera needs to communicate with the sensor to identify what type of device it is and configure it. But the sensor will only talk to Vera within a minute of pressing the blue button. After re-connecting Vera's Z-Wave dongle, wait 60 seconds, and if the sensor shows up as 'Generic IO', go press the blue button again, and again wait 60 seconds. Vera should show it as an 'Express Controls' with 3 embedded devices. Assign it to a room like any other device.

If you want Vera to be able to use the sensor, click the '+' button next to the device. Check the box "Let Vera manage the associations". Fill in the 'wakeup interval' box. The sensor is normally asleep to conserve the batteries and will only report the temperature and light reading when it periodically wakes up. This is the frequency of the wakeup. The minimum number you can put in is 360, which means 6 minutes (i.e. 6 minutes * 60 seconds/minute = 360 seconds). At 360, you will get a new light/temperature reading every 6 minutes. However, at this rate, the batteries may only last a couple months. You can instead put in a wakeup interval of, for example, 3600 (i.e. 1 hour) and the batteries will last a lot longer, but the reading Vera has for the current temperature and light may be up to 1 hour old.

When you have specified those settings, save your changes. Wait a minute for Vera to configure the Z-Wave devices and check the color of the cog wheel next to the sensor as explained [[Device Control Status|here]]. If it's green, everything is okay and the sensor will work. If it's red, Vera was not able to configure the sensor because it probably went to sleep already by the time you saved your changes. Go to the sensor and press the blue button. Within a minute or so it should turn green.

If you have difficulty getting the green cog icon, try pressing the blue button on the sensor, then in Vera's device page, click the '+' button for the device and click 'configure right now'.

There are also a few custom configuration settings for the sensor for things like Sensitivity, Timeout Delay, LED Enabled, Light Threshold, and so on. To set them, click the + button next to the device, choose 'Custom Z-Wave Settings', then 'Add configuration setting', put in the variable number that corresponds to the setting you want to change, choose a data size of '1 byte dec' and enter the desired value, as shown below. Then click 'Save'. Vera will attempt to re-configure the sensor. If it fails, probably because the sensor is asleep, you will see the red cog. Press the blue button on the sensor and you should get a green cog meaning the sensor has been configured with your new settings. (See also: [[ZWave Options]])
== Basic Configuration ==
=== Wake Up interval ===
The unit sleeps for the duration of the Wake Up interval, which defaults to 1800 seconds or 30 minutes. When the interval expires, it wakes up and reports Temperature and Luminosity to the Vera. Note that while all 4 devices in the Vera MIOS screen can be configured for Wake Up intervals, only the setting for the '3-in-1 Sensor' has any effect and controls both Temperature and Luminosity intervals. The Motion Sensor is unaffected by the Wakeup Interval (see On Time below)

To set the Wake Up Interval, click on the spanner for the "3-in-1 sensor" device, click on Setting and set Wakeup Interval to the desired interval.

=== On Time ===
When the Motion Sensor is tripped, it transmits a tripped command and changes its state to Tripped=1 for the duration of the ON TIME variable. After this time has expired, it sends an Untripped command to the Vera and resets it state to Tripped=0. While the device is in a tripped state, any motion detected resets the interval timer but doesn't report a new trip event to the Vera. During the wait time the Motion Sensor device in the Vera will show Tripped=1 in the Advanced tab.

To set the ON TIME, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 2 (On Time) to 5 (or the desired interval in minutes)

'''Direct Association:''' The unit can be associated directly with another device such as a light. If you've done this, the unit will turn the light on when motion is sensed, then turn it off after the ON TIME. According to the sensor's manual up to four associated devices are supported, but associating more than one device does not work (as of Vera's firmware 1.0.900, see http://bugs.micasaverde.com/view.php?id=705).

Leave Parameter #6, "OnValue", at the default if you want the sensor tripped events in Vera.

=== Example ===
Consider the following example of how to configure the sensor and the Vera for a common application. Suppose you want to install a motion sensor in your garage to turn the lights on when you enter, keep them on for as long as you move around in the garage, then turn them off 5 minutes after you've left.
# Put the unit in Test mode by pressing the button on the side
# Configure the On Time to 5 minutes
# Create two scenes in Vera:
## Turn on the light when the unit has tripped (New Scene, Events tab, Add Event, Device=Motion sensor, Type of Event=Armed sensor has tripped, Name=whatever, Tripped=Yes)
## Turn off the light when the unit sends an untrip command which happens after the On Time interval. (New Scene, Events tab, Add Event, Device=Motion sensor, Type of Event=Armed sensor has tripped, Name=whatever, Tripped=No)

== Advanced Configuration ==
=== Running from AC Power ===
==== Overview ====
It is possible to run the unit from AC power instead of batteries, which will have the following benefits:
* Allow you to keep the unit awake permanently, allowing you to poll it and customise it without being in Test mode
* Report continuously every time motion is sensed, as opposed to waiting for the ON TIME duration in between trips
* Set the unit to report temperature and light levels at higher frequencies up to 1 minute
* Let the unit act as a Z-Wave repeater, increasing the span of your network
* Never worry about running down batteries. All of the above options are possible on battery power, but will run your batteries down within a few days
==== Configure ====
To do this, you will need to connect a AC to DC transformer that supplies 4.5v to 5v at up to 1amp to the battery terminals directly. Ensure that you measure that actual output voltage of the transformer using a multi/voltage meter (don't rely on its advertised rating). Any over-voltage may fry the unit. Also make sure that the polarity is correct.

'''Setting ''Stay Awake'' to On'''
By default, the unit is constantly asleep and only wakes up at regular intervals to report the luminosity and temperature, before sleeping again. This is to save batteries. While asleep, the unit cannot be programmed from the Vera and cannot be polled for information. To get around this, one normally activates the Test mode by pressing the button on the side of the unit, which keeps it awake for 10 minutes so that it can be programmed. By setting the unit to stay awake constantly, you can program, poll or configure it at any time. It also has the side effect of enabling the unit to become a repeater of Z Wave signals throughout the network.

To set it, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 5 (Stay Awake) to 1 or any number greater than 0.

'''Setting ''On Time'' to ''Always Fire'''''
When the unit detects motion, it reports it by sending a Tripped command to the Vera. It then ignores any motion for the duration of the 'On Time' variable, after which it sends un Untripped command to the Vera and waits for the next motion. Since battery life is not a consideration while on AC power, you can set it to 'Always Fire', which sends a Tripped command whenever motion is detected with no waiting period. Note, this will also prevent an Untripped command from being sent.

To set it, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 2 (On Time) to 0.

'''Excluding and Reincluding the unit'''
To activate these new settings, you will need to exclude and reinclude the unit using the standard Vera process. Remember to save your settings first.

''' Setting Poll frequency'''
The unit usually only reports temperate and luminosity every time it wakes up, but since the unit is now constantly awake, you will have to configure a poll frequency to gather that information.

To set it, click on the spanner for the "Motion Sensor" device, click on Settings and set "Poll this node at most every" to the required update frequency. The Wakeup interval setting on this same screen has no effect since it's been overridden by Always Awake setting.

== Known issues ==

ExpressControls3in1

2011-02-19T15:10:03Z

Solipsia: /* Basic Configuration */

[[Category:Hardware]]
[[Category:Plugins]]
[[Category:3rd Party]]

== Overview ==
This unit is functionally identical to the HomeSeer HSM100 device. The user's manual is here: http://www.expresscontrols.com/pdf/EZMotionOwnerManual.pdf

You can add an [[Event]] to your [[Scenes]] 'sensor tripped' or 'armed sensor is tripped' so the scene is executed when the motion sensor is tripped. (See also [[Intro Security]].) You can see the current temperature and light level on Vera's dashboard or on the mobile phone interface.

To pair the sensor with Vera (i.e. add it to Vera's Z-Wave network), bring Vera's dongle near the sensor as you would pair any device, and press the blue button on the 3-in-1 sensor. Reconnect Vera's Z-Wave dongle.

Vera needs to communicate with the sensor to identify what type of device it is and configure it. But the sensor will only talk to Vera within a minute of pressing the blue button. After re-connecting Vera's Z-Wave dongle, wait 60 seconds, and if the sensor shows up as 'Generic IO', go press the blue button again, and again wait 60 seconds. Vera should show it as an 'Express Controls' with 3 embedded devices. Assign it to a room like any other device.

If you want Vera to be able to use the sensor, click the '+' button next to the device. Check the box "Let Vera manage the associations". Fill in the 'wakeup interval' box. The sensor is normally asleep to conserve the batteries and will only report the temperature and light reading when it periodically wakes up. This is the frequency of the wakeup. The minimum number you can put in is 360, which means 6 minutes (i.e. 6 minutes * 60 seconds/minute = 360 seconds). At 360, you will get a new light/temperature reading every 6 minutes. However, at this rate, the batteries may only last a couple months. You can instead put in a wakeup interval of, for example, 3600 (i.e. 1 hour) and the batteries will last a lot longer, but the reading Vera has for the current temperature and light may be up to 1 hour old.

When you have specified those settings, save your changes. Wait a minute for Vera to configure the Z-Wave devices and check the color of the cog wheel next to the sensor as explained [[Device Control Status|here]]. If it's green, everything is okay and the sensor will work. If it's red, Vera was not able to configure the sensor because it probably went to sleep already by the time you saved your changes. Go to the sensor and press the blue button. Within a minute or so it should turn green.

If you have difficulty getting the green cog icon, try pressing the blue button on the sensor, then in Vera's device page, click the '+' button for the device and click 'configure right now'.

There are also a few custom configuration settings for the sensor for things like Sensitivity, Timeout Delay, LED Enabled, Light Threshold, and so on. To set them, click the + button next to the device, choose 'Custom Z-Wave Settings', then 'Add configuration setting', put in the variable number that corresponds to the setting you want to change, choose a data size of '1 byte dec' and enter the desired value, as shown below. Then click 'Save'. Vera will attempt to re-configure the sensor. If it fails, probably because the sensor is asleep, you will see the red cog. Press the blue button on the sensor and you should get a green cog meaning the sensor has been configured with your new settings. (See also: [[ZWave Options]])
== Basic Configuration ==
=== Wake Up interval ===
The unit sleeps for the duration of the Wake Up interval, which defaults to 1800 seconds or 30 minutes. When the interval expires, it wakes up and reports Temperature and Luminosity to the Vera. Note that while all 4 devices in the Vera MIOS screen can be configured for Wake Up intervals, only the setting for the '3-in-1 Sensor' has any effect and controls both Temperature and Luminosity intervals. The Motion Sensor is unaffected by the Wakeup Interval (see On Time below)

To set the Wake Up Interval, click on the spanner for the "3-in-1 sensor" device, click on Setting and set Wakeup Interval to the desired interval.

=== On Time ===
When the Motion Sensor is tripped, it transmits a tripped command and changes its state to Tripped=1 for the duration of the ON TIME variable. After this time has expired, it sends an Untripped command to the Vera and resets it state to Tripped=0. While it is Tripped=1, it ignores any motion. During this wait time the Motion Sensor device in the Vera will show Tripped=1 in the Advanced tab.

To set the ON TIME, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 2 (On Time) to 5 (or the desired interval in minutes)

'''Direct Association:''' The unit can be associated directly with another device such as a light. If you've done this, the unit will turn the light on when motion is sensed, then turn it off after the ON TIME. According to the sensor's manual up to four associated devices are supported, but associating more than one device does not work (as of Vera's firmware 1.0.900, see http://bugs.micasaverde.com/view.php?id=705).

Leave Parameter #6, "OnValue", at the default if you want the sensor tripped events in Vera.

=== Example ===
Consider the following example of how to configure the sensor and the Vera for a common application. Suppose you want to install a motion sensor in your garage to turn the lights on when you enter, keep them on for as long as you move around in the garage, then turn them off 5 minutes after you've left.
# Put the unit in Test mode by pressing the button on the side
# Configure the On Time to 5 minutes
# Create two scenes in Vera:
## Turn on the light when the unit has tripped (New Scene, Events tab, Add Event, Device=Motion sensor, Type of Event=Armed sensor has tripped, Name=whatever, Tripped=Yes)
## Turn off the light when the unit sends an untrip command which happens after the On Time interval. (New Scene, Events tab, Add Event, Device=Motion sensor, Type of Event=Armed sensor has tripped, Name=whatever, Tripped=No)

== Advanced Configuration ==
=== Running from AC Power ===
==== Overview ====
It is possible to run the unit from AC power instead of batteries, which will have the following benefits:
* Allow you to keep the unit awake permanently, allowing you to poll it and customise it without being in Test mode
* Report continuously every time motion is sensed, as opposed to waiting for the ON TIME duration in between trips
* Set the unit to report temperature and light levels at higher frequencies up to 1 minute
* Let the unit act as a Z-Wave repeater, increasing the span of your network
* Never worry about running down batteries. All of the above options are possible on battery power, but will run your batteries down within a few days
==== Configure ====
To do this, you will need to connect a AC to DC transformer that supplies 4.5v to 5v at up to 1amp to the battery terminals directly. Ensure that you measure that actual output voltage of the transformer using a multi/voltage meter (don't rely on its advertised rating). Any over-voltage may fry the unit. Also make sure that the polarity is correct.

'''Setting ''Stay Awake'' to On'''
By default, the unit is constantly asleep and only wakes up at regular intervals to report the luminosity and temperature, before sleeping again. This is to save batteries. While asleep, the unit cannot be programmed from the Vera and cannot be polled for information. To get around this, one normally activates the Test mode by pressing the button on the side of the unit, which keeps it awake for 10 minutes so that it can be programmed. By setting the unit to stay awake constantly, you can program, poll or configure it at any time. It also has the side effect of enabling the unit to become a repeater of Z Wave signals throughout the network.

To set it, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 5 (Stay Awake) to 1 or any number greater than 0.

'''Setting ''On Time'' to ''Always Fire'''''
When the unit detects motion, it reports it by sending a Tripped command to the Vera. It then ignores any motion for the duration of the 'On Time' variable, after which it sends un Untripped command to the Vera and waits for the next motion. Since battery life is not a consideration while on AC power, you can set it to 'Always Fire', which sends a Tripped command whenever motion is detected with no waiting period. Note, this will also prevent an Untripped command from being sent.

To set it, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 2 (On Time) to 0.

'''Excluding and Reincluding the unit'''
To activate these new settings, you will need to exclude and reinclude the unit using the standard Vera process. Remember to save your settings first.

''' Setting Poll frequency'''
The unit usually only reports temperate and luminosity every time it wakes up, but since the unit is now constantly awake, you will have to configure a poll frequency to gather that information.

To set it, click on the spanner for the "Motion Sensor" device, click on Settings and set "Poll this node at most every" to the required update frequency. The Wakeup interval setting on this same screen has no effect since it's been overridden by Always Awake setting.

== Known issues ==

ExpressControls3in1

2011-02-19T14:56:07Z

Solipsia: /* Basic Configuration */

[[Category:Hardware]]
[[Category:Plugins]]
[[Category:3rd Party]]

== Overview ==
This unit is functionally identical to the HomeSeer HSM100 device. The user's manual is here: http://www.expresscontrols.com/pdf/EZMotionOwnerManual.pdf

You can add an [[Event]] to your [[Scenes]] 'sensor tripped' or 'armed sensor is tripped' so the scene is executed when the motion sensor is tripped. (See also [[Intro Security]].) You can see the current temperature and light level on Vera's dashboard or on the mobile phone interface.

To pair the sensor with Vera (i.e. add it to Vera's Z-Wave network), bring Vera's dongle near the sensor as you would pair any device, and press the blue button on the 3-in-1 sensor. Reconnect Vera's Z-Wave dongle.

Vera needs to communicate with the sensor to identify what type of device it is and configure it. But the sensor will only talk to Vera within a minute of pressing the blue button. After re-connecting Vera's Z-Wave dongle, wait 60 seconds, and if the sensor shows up as 'Generic IO', go press the blue button again, and again wait 60 seconds. Vera should show it as an 'Express Controls' with 3 embedded devices. Assign it to a room like any other device.

If you want Vera to be able to use the sensor, click the '+' button next to the device. Check the box "Let Vera manage the associations". Fill in the 'wakeup interval' box. The sensor is normally asleep to conserve the batteries and will only report the temperature and light reading when it periodically wakes up. This is the frequency of the wakeup. The minimum number you can put in is 360, which means 6 minutes (i.e. 6 minutes * 60 seconds/minute = 360 seconds). At 360, you will get a new light/temperature reading every 6 minutes. However, at this rate, the batteries may only last a couple months. You can instead put in a wakeup interval of, for example, 3600 (i.e. 1 hour) and the batteries will last a lot longer, but the reading Vera has for the current temperature and light may be up to 1 hour old.

When you have specified those settings, save your changes. Wait a minute for Vera to configure the Z-Wave devices and check the color of the cog wheel next to the sensor as explained [[Device Control Status|here]]. If it's green, everything is okay and the sensor will work. If it's red, Vera was not able to configure the sensor because it probably went to sleep already by the time you saved your changes. Go to the sensor and press the blue button. Within a minute or so it should turn green.

If you have difficulty getting the green cog icon, try pressing the blue button on the sensor, then in Vera's device page, click the '+' button for the device and click 'configure right now'.

There are also a few custom configuration settings for the sensor for things like Sensitivity, Timeout Delay, LED Enabled, Light Threshold, and so on. To set them, click the + button next to the device, choose 'Custom Z-Wave Settings', then 'Add configuration setting', put in the variable number that corresponds to the setting you want to change, choose a data size of '1 byte dec' and enter the desired value, as shown below. Then click 'Save'. Vera will attempt to re-configure the sensor. If it fails, probably because the sensor is asleep, you will see the red cog. Press the blue button on the sensor and you should get a green cog meaning the sensor has been configured with your new settings. (See also: [[ZWave Options]])
== Basic Configuration ==
=== Wake Up interval ===
The unit sleeps for the duration of the Wake Up interval, which defaults to 1800 seconds or 30 minutes. When the interval expires, it wakes up and reports Temperature and Luminosity to the Vera. Note that while all 4 devices in the Vera MIOS screen can be configured for Wake Up intervals, only the setting for the '3-in-1 Sensor' has any effect and controls both Temperature and Luminosity intervals. The Motion Sensor is unaffected by the Wakeup Interval (see On Time below)

To set the Wake Up Interval, click on the spanner for the "3-in-1 sensor" device, click on Setting and set Wakeup Interval to the desired interval.

=== On Time ===
When the Motion Sensor is tripped, it transmits a tripped command and changes its state to Tripped=1 for the duration of the ON TIME variable. After this time has expired, it sends an Untripped command to the Vera and resets it state to Tripped=0. While it is Tripped=1, it ignores any motion. During this wait time the Motion Sensor device in the Vera will show Tripped=1 in the Advanced tab.

To set the ON TIME, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 2 (On Time) to 5 (or the desired interval in minutes)

'''Direct Association:''' The unit can be associated directly with another device such as a light. If you've done this, the unit will turn the light on when motion is sensed, then turn it off after the ON TIME. According to the sensor's manual up to four associated devices are supported, but associating more than one device does not work (as of Vera's firmware 1.0.900, see http://bugs.micasaverde.com/view.php?id=705).

Leave Parameter #6, "OnValue", at the default if you want the sensor tripped events in Vera.

== Advanced Configuration ==
=== Running from AC Power ===
==== Overview ====
It is possible to run the unit from AC power instead of batteries, which will have the following benefits:
* Allow you to keep the unit awake permanently, allowing you to poll it and customise it without being in Test mode
* Report continuously every time motion is sensed, as opposed to waiting for the ON TIME duration in between trips
* Set the unit to report temperature and light levels at higher frequencies up to 1 minute
* Let the unit act as a Z-Wave repeater, increasing the span of your network
* Never worry about running down batteries. All of the above options are possible on battery power, but will run your batteries down within a few days
==== Configure ====
To do this, you will need to connect a AC to DC transformer that supplies 4.5v to 5v at up to 1amp to the battery terminals directly. Ensure that you measure that actual output voltage of the transformer using a multi/voltage meter (don't rely on its advertised rating). Any over-voltage may fry the unit. Also make sure that the polarity is correct.

'''Setting ''Stay Awake'' to On'''
By default, the unit is constantly asleep and only wakes up at regular intervals to report the luminosity and temperature, before sleeping again. This is to save batteries. While asleep, the unit cannot be programmed from the Vera and cannot be polled for information. To get around this, one normally activates the Test mode by pressing the button on the side of the unit, which keeps it awake for 10 minutes so that it can be programmed. By setting the unit to stay awake constantly, you can program, poll or configure it at any time. It also has the side effect of enabling the unit to become a repeater of Z Wave signals throughout the network.

To set it, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 5 (Stay Awake) to 1 or any number greater than 0.

'''Setting ''On Time'' to ''Always Fire'''''
When the unit detects motion, it reports it by sending a Tripped command to the Vera. It then ignores any motion for the duration of the 'On Time' variable, after which it sends un Untripped command to the Vera and waits for the next motion. Since battery life is not a consideration while on AC power, you can set it to 'Always Fire', which sends a Tripped command whenever motion is detected with no waiting period. Note, this will also prevent an Untripped command from being sent.

To set it, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 2 (On Time) to 0.

'''Excluding and Reincluding the unit'''
To activate these new settings, you will need to exclude and reinclude the unit using the standard Vera process. Remember to save your settings first.

''' Setting Poll frequency'''
The unit usually only reports temperate and luminosity every time it wakes up, but since the unit is now constantly awake, you will have to configure a poll frequency to gather that information.

To set it, click on the spanner for the "Motion Sensor" device, click on Settings and set "Poll this node at most every" to the required update frequency. The Wakeup interval setting on this same screen has no effect since it's been overridden by Always Awake setting.

== Known issues ==

ExpressControls3in1

2011-02-19T14:47:20Z

Solipsia: Major work on the AC Power section and minor rework elsewhere

[[Category:Hardware]]
[[Category:Plugins]]
[[Category:3rd Party]]

== Overview ==
This unit is functionally identical to the HomeSeer HSM100 device. The user's manual is here: http://www.expresscontrols.com/pdf/EZMotionOwnerManual.pdf

You can add an [[Event]] to your [[Scenes]] 'sensor tripped' or 'armed sensor is tripped' so the scene is executed when the motion sensor is tripped. (See also [[Intro Security]].) You can see the current temperature and light level on Vera's dashboard or on the mobile phone interface.

To pair the sensor with Vera (i.e. add it to Vera's Z-Wave network), bring Vera's dongle near the sensor as you would pair any device, and press the blue button on the 3-in-1 sensor. Reconnect Vera's Z-Wave dongle.

Vera needs to communicate with the sensor to identify what type of device it is and configure it. But the sensor will only talk to Vera within a minute of pressing the blue button. After re-connecting Vera's Z-Wave dongle, wait 60 seconds, and if the sensor shows up as 'Generic IO', go press the blue button again, and again wait 60 seconds. Vera should show it as an 'Express Controls' with 3 embedded devices. Assign it to a room like any other device.

If you want Vera to be able to use the sensor, click the '+' button next to the device. Check the box "Let Vera manage the associations". Fill in the 'wakeup interval' box. The sensor is normally asleep to conserve the batteries and will only report the temperature and light reading when it periodically wakes up. This is the frequency of the wakeup. The minimum number you can put in is 360, which means 6 minutes (i.e. 6 minutes * 60 seconds/minute = 360 seconds). At 360, you will get a new light/temperature reading every 6 minutes. However, at this rate, the batteries may only last a couple months. You can instead put in a wakeup interval of, for example, 3600 (i.e. 1 hour) and the batteries will last a lot longer, but the reading Vera has for the current temperature and light may be up to 1 hour old.

When you have specified those settings, save your changes. Wait a minute for Vera to configure the Z-Wave devices and check the color of the cog wheel next to the sensor as explained [[Device Control Status|here]]. If it's green, everything is okay and the sensor will work. If it's red, Vera was not able to configure the sensor because it probably went to sleep already by the time you saved your changes. Go to the sensor and press the blue button. Within a minute or so it should turn green.

If you have difficulty getting the green cog icon, try pressing the blue button on the sensor, then in Vera's device page, click the '+' button for the device and click 'configure right now'.

There are also a few custom configuration settings for the sensor for things like Sensitivity, Timeout Delay, LED Enabled, Light Threshold, and so on. To set them, click the + button next to the device, choose 'Custom Z-Wave Settings', then 'Add configuration setting', put in the variable number that corresponds to the setting you want to change, choose a data size of '1 byte dec' and enter the desired value, as shown below. Then click 'Save'. Vera will attempt to re-configure the sensor. If it fails, probably because the sensor is asleep, you will see the red cog. Press the blue button on the sensor and you should get a green cog meaning the sensor has been configured with your new settings. (See also: [[ZWave Options]])
== Basic Configuration ==

=== On Time ===
When the Motion Sensor is tripped, it transmits a tripped command and changes its state to Tripped=1 for the duration of the ON TIME variable. After this time has expired, it sends an Untripped command to the Vera and resets it state to Tripped=0. While it is Tripped=1, it ignores any motion. During this wait time the Motion Sensor device in the Vera will show Tripped=1 in the Advanced tab.

To set the ON TIME, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 2 (On Time) to 5 (or the desired interval in minutes)

'''Direct Association:''' The unit can be associated directly with another device such as a light. If you've done this, the unit will turn the light on when motion is sensed, then turn it off after the ON TIME. According to the sensor's manual up to four associated devices are supported, but associating more than one device does not work (as of Vera's firmware 1.0.900, see http://bugs.micasaverde.com/view.php?id=705).

Leave Parameter #6, "OnValue", at the default if you want the sensor tripped events in Vera.

== Advanced Configuration ==
=== Running from AC Power ===
==== Overview ====
It is possible to run the unit from AC power instead of batteries, which will have the following benefits:
* Allow you to keep the unit awake permanently, allowing you to poll it and customise it without being in Test mode
* Report continuously every time motion is sensed, as opposed to waiting for the ON TIME duration in between trips
* Set the unit to report temperature and light levels at higher frequencies up to 1 minute
* Let the unit act as a Z-Wave repeater, increasing the span of your network
* Never worry about running down batteries. All of the above options are possible on battery power, but will run your batteries down within a few days
==== Configure ====
To do this, you will need to connect a AC to DC transformer that supplies 4.5v to 5v at up to 1amp to the battery terminals directly. Ensure that you measure that actual output voltage of the transformer using a multi/voltage meter (don't rely on its advertised rating). Any over-voltage may fry the unit. Also make sure that the polarity is correct.

'''Setting ''Stay Awake'' to On'''
By default, the unit is constantly asleep and only wakes up at regular intervals to report the luminosity and temperature, before sleeping again. This is to save batteries. While asleep, the unit cannot be programmed from the Vera and cannot be polled for information. To get around this, one normally activates the Test mode by pressing the button on the side of the unit, which keeps it awake for 10 minutes so that it can be programmed. By setting the unit to stay awake constantly, you can program, poll or configure it at any time. It also has the side effect of enabling the unit to become a repeater of Z Wave signals throughout the network.

To set it, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 5 (Stay Awake) to 1 or any number greater than 0.

'''Setting ''On Time'' to ''Always Fire'''''
When the unit detects motion, it reports it by sending a Tripped command to the Vera. It then ignores any motion for the duration of the 'On Time' variable, after which it sends un Untripped command to the Vera and waits for the next motion. Since battery life is not a consideration while on AC power, you can set it to 'Always Fire', which sends a Tripped command whenever motion is detected with no waiting period. Note, this will also prevent an Untripped command from being sent.

To set it, click on the spanner for the "3-in-1 sensor" device, click on Device Options and set variable 2 (On Time) to 0.

'''Excluding and Reincluding the unit'''
To activate these new settings, you will need to exclude and reinclude the unit using the standard Vera process. Remember to save your settings first.

''' Setting Poll frequency'''
The unit usually only reports temperate and luminosity every time it wakes up, but since the unit is now constantly awake, you will have to configure a poll frequency to gather that information.

To set it, click on the spanner for the "Motion Sensor" device, click on Settings and set "Poll this node at most every" to the required update frequency. The Wakeup interval setting on this same screen has no effect since it's been overridden by Always Awake setting.

== Known issues ==

Luup Scenes Events

2011-01-16T17:23:41Z

Solipsia: /* Samples */

[[Category:Development]]
== Adding Lua code to scenes and events ==

You can add Lua script to scenes and events for simple tasks, like making a scene or event conditional. Conditional meaning "do something only '''if''' some condition is met", such as attaching a condition to your "Come Home" scene so it is only run '''if''' the temperature is over 70 degrees. Basic conditional expressions are easy, and, if that's all you're looking to do, skip to the walk-through below.

If you're more technically inclined you can also do very advanced things too. For an overview of all the advanced things you can do with Vera's Luup engine, and how scenes and events fit in, see the [[Luup_Intro]] page.

To add Lua code to a scene, create the [[Scenes]] and click 'Luup scene'. Fill in your Lua code in the input box. To do a simple condition, see the sample below. Or if you want to do advanced scripting you can use any [[http://lua.org Lua]] commands as described in the [[http://www.lua.org/manual/5.1/ Lua reference manual]] as well as the variables and functions that the Luup engine adds to Lua documented here: [[Luup_Lua_extensions]]. The Lua code will be run every time the scene is activated either by the user or a scene or a timer. The Lua code is run before the commands that you included in the scene. If your Lua code ends with this: "return false" then the commands in the scene will not be run.

You can also add Lua code to an event by clicking 'Luup event'. Since events are attached to scenes anyway, there is usually little difference between adding the code to an event, or to the scene the event is part of. If the Lua code in an event returns false, then the event is aborted, meaning the scene that the event is attached to will not be triggered by the event. The main reason for attaching Lua code to an event is if you have multiple events to a scene. For example, you may have a scene called "Turn lights on in hallway" which is triggered by 2 events: 1) The front door opens, and 2) the motion sensor in the hallway is tripped. Perhaps whenever the front door opens you always want the scene to be activated, but you only want the motion sensor to activate the scene before 10:00. In this case, you would add Lua code to the motion sensor's event which does something like (pseudo-code): "if time>10:00 return false". That way the event from the motion sensor will be aborted if it's after 10:00, but the event from the front door will always activate the scene regardless.

When you edit the Lua code in a scene or event you must click 'Save' before the code is saved. Then you can activate the scene or trigger the event to see what happens when your code is run. If you're doing some advanced scripting that you'll need to debug this can be tedious, but there are easy ways to test your Lua script immediately without saving first as explained in [[Lua_Debugging]].

If you're doing advanced Lua scripting, you should note that all the Lua code in your scenes and events run in a single Lua instance, which is separate from any Lua plugins. This means if you set a global variable in one scene, or create a function inside the Lua code in a scene, then in another scene's Lua code you can use that global variable or call that function. You do not need to worry about conflicting with a Luup plugin, though, since they have their own Lua instance, meaning they have their own global variables and functions.

== Walk-through #1 -- At 12 noon, turn off the interior lights if the temperature is over 80 degrees ==

Before you start, in Vera's setup interface go to 'Devices' and click the '+' button next to the thermostat. Make note of the Device #.

In this walkthrough we'll assume it's Device #3, but use the actual device number of''your'' thermostat. Next, visit [[Luup Variables]] to get a list of all the variables for devices. A variable is a piece of information about the current state of a device, such as whether it's on or off, it's current temperature, etc.

Look down at ''Thermostat'', and copy the name of the service/variable which corresponds to the current temperature, namely. In this case, it's

urn:upnp-org:serviceId:TemperatureSensor1 CurrentTemperature

Notice that it states the <tt>CurrentTemperature</tt> is in Celsius. So type in "80 degrees Fahrenheit to Celsius" in Google and you'll see that it's 26.6 degrees Celsius.

Now, the first step is to create the scene that turns off the lights. In Vera's setup interface, click 'Scenes', and click 'Add Scene' to add a new scene to one of the rooms. It's not important which room you choose. Scenes are categorized in rooms just to help you keep track of them if you have a lot of scenes. You can also put the scene in 'Global Scenes', or, you can create dummy rooms on the 'Rooms' tab if you want to have more "rooms" to organize your scenes with. After you click 'Add Scene', type in a description to remember your scene by, such as "Lights off 12:00 if 80". Under the 'Commands' area you'll see all the rooms. Click '+' next to the rooms that have lights you want to control, and choose "Off" in the pull-down. At this point, you have a normal scene, and, if you were to save your changes now, whenever you click the scene on the dashboard or on a remote control, the lights should turn off.

Second, next to the scene's description click 'add timer'. You can give the timer a description too so that if you have multiple timers you can see in the logs which one is activating the scene. Choose "Day of week based". If you want this scene to only run on certain days of the week, just check off which days you want this scene to run on. Otherwise, you can leave them all unchecked (or check them all) to do it every day. Leave the pull-down at "a certain time of day", and choose 12 : 00 : 00 from the pull-downs. At this point, if you were to save your changes, the lights would turn off automatically at 12 noon.

Third, the last step is to add the condition. To the right of the scene's description you'll see the button "Luup Scene". Click it and in the code box, copy and paste the following:

local lul_temp=luup.variable_get("urn:upnp-org:serviceId:TemperatureSensor1","CurrentTemperature",3)
if( tonumber(lul_temp)<26.6 ) then
return false
end

Don't forget to change the "3" to whatever is the actual device number of your thermostat. Assign the result of <tt>luup.variable_get</tt> to a variable first, rather than putting it directly in the <tt>tonumber()</tt>, because <tt>luup.variable_get</tt> actually returns 2 values: the value of the variable, and the time when the variable was modified. The '<tt>tonumber</tt>' is needed because all of a device's variables are stored as plain text--not numbers--so if you want to do arithmetic or numeric comparison of a variable, you need to put <tt>tonumber()</tt> around <tt>luup.variable_get</tt>.

<tt>luup.variable_get</tt> is documented in [[Luup Lua extensions]].

Now click 'Update', and then click 'Save' to save everything. The "return false" means "don't run this scene". So if the current temperature is <26.6, the scene will be aborted and won't run. The timer will make it trigger every day at 12 noon.

To test it, you can click the scene button on the dashboard. The lights will turn off only if the temperature is over 80 degrees. If it's less than 80 degrees, the scene won't do anything. Since this scene is something that happens automatically and you probably won't execute manually, you can go to the scene again and check the "Hidden" box so the scene doesn't show up on Vera's 'Dashboard' and on your remote controls, like the iPhone. If you want to have a scene that turns off the lights which you can run whenever you want from 'Dashboard'' or your remote control, you should create another scene that has the same commands and simply don't add the timers and Luup conditions, and don't check the "Hidden" box.

You can substitute other service/variables and device ID's to make other types of conditions. The "if" statement above also supports nesting with ( and ), as well as the keywords 'and' and 'or'. So the following means the scene would abort if the temperature is <26.6 and >25, unless it's <23:

local lul_temp=luup.variable_get("urn:upnp-org:serviceId:TemperatureSensor1","CurrentTemperature",3)
if( (tonumber(lul_temp)<26.6
and tonumber(lul_temp)>25)
or tonumber(lul_temp)<23 ) then
return false
end

If the scene doesn't run, it's possible there is a syntax error. The easiest way to test this is to copy the Lua code from the scene, then go to Devices, Luup Plugins, and "Test Luup code". Paste the code in the box and click 'go'. If the info box above the 'go' button has a check and says "Message sent successful", your code is okay. If there's an error, it says: "Code failed".

To see if that's true, use putty, or telnet or ssh to log-in to Vera, as explained in detail in [[Lua Debugging]], and type:

cd /var/log/cmh
tail -f LuaUPnP.log | grep '^01'

Now click 'Save' in Vera's setup page, even if it's gray, as that will cause Vera to restart the Luup engine and log any syntax errors. See: [[Lua Debugging]] for in-depth details on how to debug.

== Samples ==

This page is a wiki which anyone can edit. If you have some Lua code you think other users might find useful, feel free to add it here.

=== Misc actions ===

Did you see the sample here already: http://wiki.micasaverde.com/index.php/Luup_Scenes_Events

====Turn an appliance switch or a Danfoss thermostat on for device #5====

luup.call_action("urn:upnp-org:serviceId:SwitchPower1","SetTarget",{ newTargetValue="1" },5)

====Turn an appliance switch or a Danfoss thermostat off====

luup.call_action("urn:upnp-org:serviceId:SwitchPower1","SetTarget",{ newTargetValue="0" },5)

====Do something if switch device #5 is on====

local lul_tmp = luup.variable_get("urn:upnp-org:serviceId:SwitchPower1","Status",5)
if( lul_tmp=="1" ) then
--something to do goes here
end

====Dim switch #6 to 30%====

luup.call_action("urn:upnp-org:serviceId:Dimming1","SetLoadLevelTarget",{ newLoadlevelTarget="30" },6)

====Arm motion sensor #7====

luup.variable_set("urn:micasaverde-com:serviceId:SecuritySensor1","Armed","1",7)

====Disarm motion sensor #7====

luup.variable_set("urn:micasaverde-com:serviceId:SecuritySensor1","Armed","0",7)

Note, arming and disarming isn't a concept within UPnP or Z-Wave. It's just a flag that the Luup engine uses, and is stored in a variable we created called "Armed".

====Run Scene #5====

Thanks "denix" on the forum for the correct syntax.
"Actually, the 4th parameter IS required, but it's not used. Otherwise the command fails with an error message"

luup.call_action("urn:micasaverde-com:serviceId:HomeAutomationGateway1","RunScene",{ SceneNum="5" }, 0)

In this case we left the device number off (the 4th parameter to <tt>luup.call_action</tt>), because the "<tt>RunScene</tt>" action is handled by the Luup engine itself--not by some device within Z-Wave, etc.

However, normally you don't need to <tt>luup.call_action</tt> in Lua code. Rather, whatever actions, or commands, you want to run, you put into the scene itself, and the only Lua code is to simply check if some condition is true and abort the scene if the condition isn't met.

====Change the Temperature on Thermostat (Cool) device #19====
luup.call_action("urn:upnp-org:serviceId:TemperatureSetpoint1_Cool",
"SetCurrentSetpoint", { NewCurrentSetpoint="68" },
19)

====Change the Temperature on a Thermostat (Heat) device #19====
luup.call_action("urn:upnp-org:serviceId:TemperatureSetpoint1_Heat",
"SetCurrentSetpoint",{ NewCurrentSetpoint="68" },
19)

===='Privacy' mode for Foscam FI8908[w]====

local IP_address = '<IP address of camera>'
local username = '<username>'
local password = '<password>'
local timeout = 5

function move_up()

luup.inet.wget( 'http://'..IP_address..'/decoder_control.cgi?command=0' , timeout, username, password )

end

-- center the camera; takes some time, so we have to wait 2 minutes for the command to complete

luup.inet.wget( 'http://'..IP_address..'/decoder_control.cgi?command=25', timeout, username, password )

luup.call_delay( 'move_up', 120 )

====Blinking lights====

http://forum.micasaverde.com/index.php?topic=5127.0

=== Calculate sunrise and sunset ===

See http://forum.micasaverde.com/index.php?topic=2073.msg8132#msg8132

=== Access the web ===
==== Invoke URL by GET request ====
Based on code by Jim/jgc94131
require('ltn12')
local http=require('socket.http')
local response_body = {}
local request_body = ''
socket.http.TIMEOUT = 4
local r, c, h = socket.http.request{
url = 'http://website/page?parameter1=value&parameter2=value',
method = "GET",
port = 80,
headers = {
["Content-Length"] = string.len(request_body),
["Content-Type"] = "application/x-www-form-urlencoded"
},
source = ltn12.source.string(request_body),
sink = ltn12.sink.table(response_body)
}

=== Access the current time ===

The Lua function

os.date (format, time)

converts a time value `time` into a human readable date/time string, according to `format`. If you leave out the optional `time` parameter, it defaults to current time. The `format` parameter defaults to a fairly complete format. If you specify '*t' as the format, it will return a table instead of a formatted string.

t = os.date('*t')
t => {year=2010, month=2, day=19, yday=50, wday=6, hour=22, min=45, sec=45, isdst=false}

The fields are year, month, day of month, day of year, day of week, hour in 24 hour clock, minutes, seconds and if it's Daylight Savings Time.

Current hour:

os.date('*t').hour

Current minute:

os.date('*t').min

Current second:

os.date('*t').sec

Do something between 16:00 and 21:15:

local t = os.date('*t')
local current_second = t.hour * 3600 + t.min * 60 + t.sec -- number of seconds since midnight
local min_time_in_seconds = 16 * 3600 + 0 * 60 -- 16:00
local max_time_in_seconds = 21 * 3600 + 15 * 60 -- 21:15

if (current_second > min_time_in_seconds) and (current_second < max_time_in_seconds)
then
-- do something
else
return false
end

See http://forum.micasaverde.com/index.php?topic=2015.0 and http://www.lua.org/manual/5.1/manual.html#5.8.

=== Set Z-Wave parameters ===

See http://forum.micasaverde.com/index.php?topic=1937.msg7803#msg7803

=== a scene if the temperature is outside of a range ===

add snippets here...