Luup Requests

Revision as of 00:44, 1 August 2010

In addition to sending requests using standard UPnP, you can also do most things using a simple HTTP requests. Use the built-in URL data_request, and pass the following on the URL:

• id the id of the request,
• output_format the format in which you want a response as json, xml or text.

Not all requests support all output_format options. Here is a list of requests:

user_data

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

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

user_data2

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

Similar to user_data.

lu_status

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

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

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

lu_actions

lu_device

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

lu_file

lu_lua

lu_action

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

Sends a UPnP action.

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

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

lu_variableset

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

lu_variableget

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

lu_reload

Resets the Luup engine with any new configuration settings.

lu_alive

Return OK if the engine is running.

lu_finddevice

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

lu_resync

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

lu_wget

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

lu_iprequests

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

lu_blacklistip

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

live_energy_usage

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