Luup Requests

Revision as of 02:15, 28 June 2009

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" is the id of the request, "output_format" is the format in which you want a response as "json", "xml" or "text". Not all requests support all output_formats. 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.

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

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.

lu_variable

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

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