Luup Variables - Revision history

A-lurker: /* Examples */

2015-05-28T21:09:17Z

‎Examples

Guessed: /* Weather Plugin */ Example now moved to the Wiki for the Weather plugin, since that Wiki is maintained, and secured correctly.

2012-09-26T15:34:44Z

‎Weather Plugin: Example now moved to the Wiki for the Weather plugin, since that Wiki is maintained, and secured correctly.

Guessed: /* Other Devices or Services */

2012-09-26T15:33:21Z

‎Other Devices or Services

Guessed: padding between some of the Devices to aid readability.

2012-02-11T05:19:03Z

padding between some of the Devices to aid readability.

Guessed: /* Dimmable Light */ Table-ize the display of variables

2012-02-11T05:12:24Z

‎Dimmable Light: Table-ize the display of variables

Guessed: /* On/Off Switch */ Table-ize the variable listings so it's easier to see.

2012-02-11T04:59:08Z

‎On/Off Switch: Table-ize the variable listings so it's easier to see.

Guessed: /* Thermostat */ Add an example section, table-ize the variables to make it clearer to users.

2012-02-11T04:54:53Z

‎Thermostat: Add an example section, table-ize the variables to make it clearer to users.

Guessed: /* On/Off Switch */ Add examples for SwitchPower1

2012-02-11T04:13:47Z

‎On/Off Switch: Add examples for SwitchPower1

Guessed: /* Dimmable Light */ Add examples for dealing with the DimmableLight:1

2012-02-11T04:06:10Z

‎Dimmable Light: Add examples for dealing with the DimmableLight:1

DaveL17: typo

2011-12-23T22:04:40Z

typo

@@ Line 24: / Line 24: @@
        -- Switch is on
        ...
-     end if
+     end -- if
 </source>
@@ Line 31: / Line 31: @@
      luup.call_action("urn:upnp-org:serviceId:SwitchPower1", "SetTarget", {newTargetValue = "1"}, 37)
 </source>
 =Dimmable Light=

← Older revision		Revision as of 15:34, 26 September 2012
Line 116:		Line 116:

	All we have to add is the device ID that Vera creates. In my case #''37''		All we have to add is the device ID that Vera creates. In my case #''37''
−
−	~~=Weather Plugin=~~
−
−	~~For my testing, I wanted to create a Luup scene that will turn on a light when the ''Condition'' is ''Showers''. So I create a new Scene and add the following to the Luup Scene: <source lang="lua">~~
−	~~local lul_tmp = luup.variable_get("urn:upnp-micasaverde-com:serviceId:Weather1", "Condition", 37)~~
−	~~if (lul_tmp == "Showers") then~~
−	~~luup.call_action("urn:upnp-org:serviceId:Dimming1", "SetLoadLevelTarget", {newLoadlevelTarget = "50"}, 19)~~
−	~~else~~
−	~~luup.call_action("urn:upnp-org:serviceId:Dimming1", "SetLoadLevelTarget", {newLoadlevelTarget = "0"}, 19)~~
−	~~end~~
−	~~</source>~~
−
−	To break this down, line 1 gets the variable ''Condition'' from the ''serviceID'' ''urn:upnp-micasaverde-com:serviceId:Weather1'' on Device #''37'' Line 2 compares the returned variable to ''Showers'' If the condition is true then it calls line 3 which turns on the lamp (Device #''19'' at ''50%'' level) Otherwise, it turns the lamp Off
−
−	~~What good is this? Nothing past testing but it would be a good method to close the garage door if it is raining.~~
−
−	*Be sure to set a timer to poll this scene every xx minutes or hours. Please edit if you know of a way to have it automatically poll.

@@ Line 107: / Line 107: @@
 <source lang="lua">
-   -- Store the current Condition (eg. "Sunny")
+   -- Store the current Condition (eg. "rain")
-   luup.variable_set("urn:upnp-micasaverde-com:serviceId:Weather1", "Condition",
+   luup.variable_set("urn:upnp-micasaverde-com:serviceId:Weather1", "ConditionGroup",
                      condition, PARENT_DEVICE)
 </source>
-From this we can get the Current Weather Condition using<br>
+From this we can get the Current Weather ConditionGroup using<br>
-Service: ''urn:upnp-micasaverde-com:serviceId:Weather1'' Variable name: ''Condition''
+Service: ''urn:upnp-micasaverde-com:serviceId:Weather1'' Variable name: ''ConditionGroup''
 All we have to add is the device ID that Vera creates. In my case #''37''
 =Weather Plugin=

@@ Line 2: / Line 2: @@
 The "Variables" for a device tell you it's current state, such as if it's on or off, what temperature it has, and so on.  Variables are given a name and a service ID, which is defined by the UPnP forum.  You can use this service ID/variable name pair to get the state of a device in the Luup engine by using the function luup.variable_get, as documented in [[Luup_Lua_extensions]].  You can also see the current value of a device's variables by going into Vera's setup page, click 'Devices', click + next to the device, then click 'Advanced'.  The name of every variable for the device is shown along with the current value, and if you move your mouse over the variable name, you will the corresponding service ID in a popup window.
-===Device category===
+=On/Off Switch=
 Device Category 3,
 UPnP device id: ''urn:schemas-upnp-org:device:BinaryLight:1''
-===Variables===
+==Variables==
 {|  width="85%" cellpadding="10%" cellspacing="0" border="1"
 |+
-! align="left"|Service!! align="left"|Variable!! align="left"|Description
+! align="left" width="30%"|Service!! align="left"|Variable!! align="left"|Description
 |-
 |''urn:upnp-org:serviceId:SwitchPower1''||''Status''||If the device is on, the value is ''1'', otherwise it's ''0''.
 |}
-===Examples===
+==Examples==
 * Getting whether the Switch/Light is on or off
 <source lang="lua">
@@ Line 31: / Line 32: @@
 </source>
-===Device category===
+=Dimmable Light=
 Device category 2,
 UPnP device id: ''urn:schemas-upnp-org:device:DimmableLight:1''
-===Variables===
+==Variables==
 Dimmable lights contain the same variable of an On/Off Switch to indicate the current on/off value, and, if it's on, ''LoadLevelStatus'' indicates the dim level.
 {|  width="85%" cellpadding="10%" cellspacing="0" border="1"
 |+
-! align="left"|Service!! align="left"|Variable!! align="left"|Description
+! align="left" width="30%"|Service!! align="left"|Variable!! align="left"|Description
 |-
 |''urn:upnp-org:serviceId:Dimming1''||''LoadLevelStatus''||If the device is off (see On/Off switch) this value indicates the last known dim level, if it's on, this value is the actual dim level.  The value is a number from ''0-100'' indicating a percentage of brightness.
 |}
-===Examples===
+==Examples==
 * Getting the current light/load level
 <source lang="lua">
@@ Line 58: / Line 60: @@
 </source>
-===Device category===
+=Thermostat=
 Device category 5,
 UPnP device id: ''urn:schemas-upnp-org:device:HVAC_ZoneThermostat:1''
-===Variables===
+==Variables==
 {|  width="85%" cellpadding="10%" cellspacing="0" border="1"
 |+
-! align="left"|Service!! align="left"|Variable!! align="left"|Description
+! align="left" width="30%"|Service!! align="left"|Variable!! align="left"|Description
 |-
 |''urn:upnp-org:serviceId:HVAC_UserOperatingMode1''||''ModeStatus''||This indicates the current operating mode and will be one of the following basic values:
@@ Line 93: / Line 96: @@
 |}
-===Examples===
+==Examples==
 * Getting the current temperature
 <source lang="lua">
@@ Line 99: / Line 102: @@
 </source>
-==Other Devices or Services==
 You can find other variables by looking at code.  For example, looking at the code for the LUUP Weather plugin, we can see where the "serviceID" for Current Conditions is ''urn:micasaverde-com:serviceId:Weather1'' (taken from the XML file):
@@ Line 113: / Line 117: @@
 All we have to add is the device ID that Vera creates. In my case #''37''
-=== Weather Plugin  ===
 For my testing, I wanted to create a Luup scene that will turn on a light when the ''Condition'' is ''Showers''. So I create a new Scene and add the following to the Luup Scene: <source lang="lua">

@@ Line 33: / Line 33: @@
 ==Dimmable Light==
-Device category: 2, UPnP device id: urn:schemas-upnp-org:device:DimmableLight:1
+===Device category===
-Variables:
+===Variables===
-Dimmable lights contain the same variable of an On/Off Switch to indicate the current on/off value, and, if it's on, LoadLevelStatus indicates the dim level.
+{|  width="85%" cellpadding="10%" cellspacing="0" border="1"
+|+
-Service: ''urn:upnp-org:serviceId:Dimming1''  Variable name: ''LoadLevelStatus''
+! align="left"|Service!! align="left"|Variable!! align="left"|Description
+|-
-If the device is off (see On/Off switch) this value indicates the last known dim level, if it's on, this value is the actual dim level.  The value is a number from 0-100 indicating a percentage of brightness.
+|''urn:upnp-org:serviceId:Dimming1''||''LoadLevelStatus''||If the device is off (see On/Off switch) this value indicates the last known dim level, if it's on, this value is the actual dim level.  The value is a number from ''0-100'' indicating a percentage of brightness.
 ===Examples===

@@ Line 52: / Line 52: @@
 ==Thermostat==
-Device category: 5, UPnP device id: urn:schemas-upnp-org:device:HVAC_ZoneThermostat:1
+===Device category===
-Variables:
+===Variables===
-Service: ''urn:upnp-org:serviceId:HVAC_UserOperatingMode1''  Variable name: ''ModeStatus''
+In addition to the basic modes, some thermostats may also support the following modes:
-This indicates the current operating mode and will be one of the following basic values: Off, HeatOn, CoolOn, AutoChangeOver.  In addition to the basic modes, some thermostats may also support the following modes: InDeadBand, AuxHeatOn, EconomyHeatOn, EmergencyHeatOn, AuxCoolOn, EconomyCoolOn, BuildingProtection, EnergySavingsHeating, EnergySavingsCooling
+===Examples===
+* Getting the current temperature
-Service: ''urn:upnp-org:serviceId:TemperatureSetpoint1_Heat''  Variable name: ''CurrentSetpoint''
+<source lang="lua">
+    local outsideTemp = luup.variable_get("urn:upnp-org:serviceId:TemperatureSensor1", "CurrentTemperature", 5)
-Service: ''urn:upnp-org:serviceId:TemperatureSetpoint1_Cool''  Variable name: ''CurrentSetpoint''
+</source>
-−
-These indicate the current heat/cool set points.
-−
-Service: ''urn:upnp-org:serviceId:TemperatureSensor1''  Variable name: ''CurrentTemperature''
-−
-This indicates the current ambient temperature.
 ==Other Devices or Services==

← Older revision		Revision as of 04:13, 11 February 2012
Line 11:		Line 11:

	If the device is on, the value is 1, otherwise it's 0.		If the device is on, the value is 1, otherwise it's 0.
		+
		+	===Examples===
		+	* Getting whether the Switch/Light is on or off
		+	<source lang="lua">
		+	local switchOnOff = luup.variable_get("urn:upnp-org:serviceId:SwitchPower1", "Status", 37)
		+	if (switchOnOff == "1") then
		+	-- Switch is on
		+	...
		+	end if
		+	</source>
		+
		+	* Request that the Switch be turned on. This will, eventually, set the variable after the device has responded to the request
		+	<source lang="lua">
		+	luup.call_action("urn:upnp-org:serviceId:SwitchPower1", "SetTarget", {newTargetValue = "1"}, 37)
		+	</source>

	==Dimmable Light==		==Dimmable Light==

← Older revision		Revision as of 04:06, 11 February 2012
Line 23:		Line 23:

	If the device is off (see On/Off switch) this value indicates the last known dim level, if it's on, this value is the actual dim level. The value is a number from 0-100 indicating a percentage of brightness.		If the device is off (see On/Off switch) this value indicates the last known dim level, if it's on, this value is the actual dim level. The value is a number from 0-100 indicating a percentage of brightness.
		+
		+	===Examples===
		+	* Getting the current light/load level
		+	<source lang="lua">
		+	local lightLevel = luup.variable_get("urn:upnp-org:serviceId:Dimming1", "LoadLevelStatus", 37)
		+	</source>
		+
		+	* Request that the Dimmer be set to 50% light/load level. This will, eventually, set the variable after the device has responded to the request
		+	<source lang="lua">
		+	luup.call_action("urn:upnp-org:serviceId:Dimming1", "SetLoadLevelTarget", {newLoadlevelTarget = "50"}, 19)
		+	</source>

	==Thermostat==		==Thermostat==

@@ Line 58: / Line 58: @@
 All we have to add is the device ID that Vera creates. In my case #''37''
-=== Weather Plugin ===
+=== Weather Plugin  ===
-For my testing, I wanted to create a Luup scene that will turn on a light when the ''Condition'' is ''Showers''.  So I create a new Scene and add the following to the Luup Scene:
-<source lang="lua">
+For my testing, I wanted to create a Luup scene that will turn on a light when the ''Condition'' is ''Showers''. So I create a new Scene and add the following to the Luup Scene: <source lang="lua">
    local lul_tmp = luup.variable_get("urn:upnp-micasaverde-com:serviceId:Weather1", "Condition", 37)
    if (lul_tmp == "Showers") then
@@ Line 67: / Line 67: @@
      luup.call_action("urn:upnp-org:serviceId:Dimming1", "SetLoadLevelTarget", {newLoadlevelTarget = "0"}, 19)
    end
 </source>
-To break this down, line 1 gets the variable ''Condition'' from the ''serviceID'' ''urn:upnp-micasaverde-com:serviceId:Weather1'' on Device #''37''
+To break this down, line 1 gets the variable ''Condition'' from the ''serviceID'' ''urn:upnp-micasaverde-com:serviceId:Weather1'' on Device #''37'' Line 2 compares the returned variable to ''Showers'' If the condition is true then it calls line 3 which turns on the lamp (Device #''19'' at ''50%'' level) Otherwise, it turns the lamp Off
 Line 2 compares the returned variable to ''Showers''
 If the condition is true then it calls line 3 which turns on the lamp (Device #''19'' at ''50%'' level)
 Otherwise, it turns the lamp Off
-What good is this?  Nothing past testing but it would be a good method to close the garage door if it is raining.
+What good is this? Nothing past testing but it would be a good method to close the garage door if it is raining.
-*Be sure to set a timer to poll this scene ever xx minutes or hours.  Please edit if you know of a way to have it automatically poll.
+*Be sure to set a timer to poll this scene every xx minutes or hours. Please edit if you know of a way to have it automatically poll.