Luup Requests
m (Undo revision 2496 by Jheena789 Jneena789 continues to be a spammer, now that's not nice behaviour now is it?) |
Micasaverde (Talk | contribs) |
||
| Line 8: | Line 8: | ||
==user_data== | ==user_data== | ||
| − | Example: http://ipaddress: | + | Example: http://ipaddress:3480/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. | 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== | ==lu_status== | ||
| − | Example: http://ipaddress: | + | Example: http://ipaddress:3480/data_request?id=lu_status&output_format=xml |
| − | Or for a specific device: http://ipaddress: | + | Or for a specific device: http://ipaddress:3480/data_request?id=lu_status&output_format=xml&UDN=uuid:4d494342-5342-5645-0002-000000000002 or http://ipaddress:3480/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. | This returns the current status for all devices including all the current upnp variables and the status of any active jobs. | ||
| Line 30: | Line 24: | ||
==lu_device== | ==lu_device== | ||
| − | This returns all the XML with all the UPNP device description documents. Use: http://ipaddress: | + | Example: http://ipaddress:3480/data_request?id=lu_device&action=rename&id=5&name=Chandalier&room=3 |
| + | |||
| + | Example: http://ipaddress:3480/data_request?id=lu_device&action=rename&id=5&name=Chandalier&room=Garage | ||
| + | |||
| + | Example: http://ipaddress:3480/data_request?id=lu_device&action=delete&id=5 | ||
| + | |||
| + | This renames or deletes a device. Use action=rename or action=delete. For rename, you can optionally assign a room by either passing either the ID or the name. | ||
| + | |||
| + | |||
| + | |||
| + | ---old--- | ||
| + | This returns all the XML with all the UPNP device description documents. Use: http://ipaddress:3480/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:3480/luvd/S_HVAC_UserOperatingMode1.xml | ||
| + | ---end old--- | ||
| + | |||
| + | ==lu_scene== | ||
| + | |||
| + | Example: http://ipaddress:3480/data_request?id=lu_scene&action=create&id=5,7,3,1&name=Wakeup&room=5 | ||
| + | |||
| + | Example: http://ipaddress:3480/data_request?id=lu_scene&action=rename&id=5&name=Chandalier&room=Garage | ||
| + | |||
| + | Example: http://ipaddress:3480/data_request?id=lu_scene&action=delete&id=5 | ||
| + | |||
| + | This creates, renames, or deletes a scene depending on the action. To create a scene, pass the id's of the device(s) to include in the scene comma delimited, and optionally pass a room by name or number. | ||
| + | |||
| + | ==lu_room== | ||
| + | |||
| + | Example: http://ipaddress:3480/data_request?id=lu_room&action=create&name=Kitchen | ||
| + | |||
| + | Example: http://ipaddress:3480/data_request?id=lu_room&action=rename&id=5&name=Garage | ||
| + | |||
| + | Example: http://ipaddress:3480/data_request?id=lu_scene&action=delete&id=5 | ||
| + | |||
| + | This creates, renames, or deletes a room depending on the action. To rename or delete a room you must pass the room id. | ||
==lu_file== | ==lu_file== | ||
| Line 38: | Line 64: | ||
==lu_action== | ==lu_action== | ||
| − | Example: http://ipaddress: | + | Example: http://ipaddress:3480/data_request?id=lu_action&output_format=xml&DeviceNum=6&serviceId=urn:upnp-org:serviceId:SwitchPower1&action=SetTarget&newTargetValue=1 |
Sends a UPnP action. | Sends a UPnP action. | ||
| Line 44: | Line 70: | ||
To run a scene, you send the action 'RunScene' to the internal 'Scene Manager' device (which has ID #2): | To run a scene, you send the action 'RunScene' to the internal 'Scene Manager' device (which has ID #2): | ||
| − | http://ipadress: | + | http://ipadress:3480/data_request?id=lu_action&output_format=xml&DeviceNum=2&serviceId=urn:micasaverde-com:serviceId:HomeAutomationGateway1&action=RunScene&SceneNum=<SceneNum> |
==lu_variableset== | ==lu_variableset== | ||
| − | http://ip: | + | http://ip:3480/data_request?id=lu_variableset&DeviceNum=6&serviceId=urn:micasaverde-com:serviceId:DoorLock1&Variable=Status&Value=1 |
==lu_variableget== | ==lu_variableget== | ||
| − | http://ip: | + | http://ip:3480/data_request?id=lu_variableget&DeviceNum=6&serviceId=urn:micasaverde-com:serviceId:DoorLock1&Variable=Status |
==lu_reload== | ==lu_reload== | ||
Revision as of 21:44, 29 September 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:
Contents |
user_data
Example: http://ipaddress:3480/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:3480/data_request?id=lu_status&output_format=xml
Or for a specific device: http://ipaddress:3480/data_request?id=lu_status&output_format=xml&UDN=uuid:4d494342-5342-5645-0002-000000000002 or http://ipaddress:3480/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
Example: http://ipaddress:3480/data_request?id=lu_device&action=rename&id=5&name=Chandalier&room=3
Example: http://ipaddress:3480/data_request?id=lu_device&action=rename&id=5&name=Chandalier&room=Garage
Example: http://ipaddress:3480/data_request?id=lu_device&action=delete&id=5
This renames or deletes a device. Use action=rename or action=delete. For rename, you can optionally assign a room by either passing either the ID or the name.
---old--- This returns all the XML with all the UPNP device description documents. Use: http://ipaddress:3480/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:3480/luvd/S_HVAC_UserOperatingMode1.xml ---end old---
lu_scene
Example: http://ipaddress:3480/data_request?id=lu_scene&action=create&id=5,7,3,1&name=Wakeup&room=5
Example: http://ipaddress:3480/data_request?id=lu_scene&action=rename&id=5&name=Chandalier&room=Garage
Example: http://ipaddress:3480/data_request?id=lu_scene&action=delete&id=5
This creates, renames, or deletes a scene depending on the action. To create a scene, pass the id's of the device(s) to include in the scene comma delimited, and optionally pass a room by name or number.
lu_room
Example: http://ipaddress:3480/data_request?id=lu_room&action=create&name=Kitchen
Example: http://ipaddress:3480/data_request?id=lu_room&action=rename&id=5&name=Garage
Example: http://ipaddress:3480/data_request?id=lu_scene&action=delete&id=5
This creates, renames, or deletes a room depending on the action. To rename or delete a room you must pass the room id.
lu_file
lu_lua
lu_action
Sends a UPnP action.
To run a scene, you send the action 'RunScene' to the internal 'Scene Manager' device (which has ID #2):
lu_variableset
lu_variableget
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
