Luup Variables
Micasaverde (Talk | contribs) (New page: 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 t...) |
Revision as of 19:02, 27 June 2009
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 lu_GetVariable, 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.
On/Off Switch
Device category: 3, UPnP device id: urn:schemas-upnp-org:device:BinaryLight:1
Variables:
Service: urn:upnp-org:serviceId:SwitchPower1 Variable name: Status
If the device is on, the value is 1, otherwise it's 0.
Dimmable Light
Device category: 2, UPnP device id: urn:schemas-upnp-org:device:DimmableLight:1
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.
Service: urn:upnp-org:serviceId:Dimming1 Variable name: 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.
Thermostat
Device category: 5, UPnP device id: urn:schemas-upnp-org:device:HVAC_ZoneThermostat:1
Variables:
Service: urn:upnp-org:serviceId:HVAC_UserOperatingMode1 Variable name: ModeStatus
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
Service: urn:upnp-org:serviceId:TemperatureSetpoint1_Heat Variable name: CurrentSetpoint
Service: urn:upnp-org:serviceId:TemperatureSetpoint1_Cool Variable name: CurrentSetpoint
These indicate the current heat/cool set points.
Service: urn:upnp-org:serviceId:TemperatureSensor1 Variable name: CurrentTemperature
This indicates the current ambient temperature.
