Luup Requests

2010-07-31T07:58:10Z

Jheena789:

[[Category:Development]]
In addition to sending requests using standard UPnP, you can also do most things using a simple HTTP requests. Use the built-in URL <tt>data_request</tt>, and pass the following on the URL:
*<tt>id</tt> the id of the request,
*<tt>output_format</tt> the format in which you want a response as <tt>json</tt>, <tt>xml</tt> or <tt>text</tt>.

Not all requests support all <tt>output_format</tt> 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 <tt>user_data</tt>.

==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: <tt>devtype</tt>, <tt>ip</tt>, <tt>id</tt>

==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

==Related Links==

[http://www.cellulite.co.uk/ '''cellulite''']

Dialer Plugin

2010-07-30T05:32:11Z

Jheena789:

[[Category:Plugins]]
[[Category:3rd Party]]
Dealer Plugin allows Vera to initiate an automatic phone call between two or more parties.

For example, a motion detector at home could make Vera connect you at mobile phone and the home phone - thus letting you reach someone who just entered home immediately.

Similarly, button on z-wave controller at home could programmed to initiate a call between a speakerphone at home and your mobile or office home - which could make a sort of Quick Dial button for children or elderly ([http://thinkvoip.wordpress.com keep in mind that residential VoIP solutions are '''not designed''' to be mission critical], and thus '''should not''' be trusted for real life and death matters).

Before starting with the setup, user should decide on ''primary'' and ''secondary'' phone numbers. Primary number is where the 'emergency' call goes (ex: user's mobile phone), secondary number is where the event happens.
To illustrate this we'll take a simplified scenario: user has an auto-answering speakerphone at home, and if something happens he wants the system to reach him on his mobile phone, connecting to the speakerphone at home so he can talk to whoever is there (at home) at the moment. In this case ''primary'' number would be the mobile phone, and the ''secondary'' number would be the home number. This is important because the system first calls the ''primary'' number, and only when it answered it connects the ''secondary'' one.

* Login into your [http://pbxes.com PBXes] account, and create a Classical (or SIP if relevant) extension that would represent the ''primary'' number as defined above. Put any unique value in URL field in Webcall section.

[[Image:Cl-ext.png‎‎]]

* Install the plugin on Vera, create a new Dialer device, Save

* Go to device settings, in field Alias put the value you used in URL @pbxes.com
Fill PhoneNumber field with the ''secondary'' number. Don't forget to save.

[[Image:Dealer.png‎]]

* Test setup by clicking on 'On' button would trigger the call. The device can now be used in scenes, events, and Luup scripts.

For those who would like to go deeper: both ''primary'' and ''secondary'' destinations can also be calling groups of various dialing strategies, or can even dial into a virtual conference rooms.

Download [http://www.box.net/shared/4vgsl5v2lr Dialer plugin] and enjoy!

Feel free to contact me with questions: dialer@edmidor.com

==Related Links==

[http://www.cellulite.co.uk/ '''cellulite''']

MiOS - User contributions [en]

Luup Requests

Dialer Plugin