Luup UPnP Variables and Actions

• inUserData is the new UserData object which will be added to the UserData or will replace an existent UserData object.
• DataFormat must be json.
• If Reload is 1 the LuaUPnP engine will reload after the UserData is modified.

For more information read the ModifyUserData page.

• DeviceNum can be an UDN or a number.
• Service is the service ID of the variable.
• Variable is the variable name.
• Value is the new variable value.

• deviceType is the UPnP device type.
• internalID is the specific ID (also known as altid) of the device; for example, for Z-Wave devices this is the Node ID, and for Insteon device it is the Insteon ID.
• Description is the device name, which is shown to the user on the dashboard.
• UpnpDevFilename is the UPnP device description file name.
• UpnpImplFilename is the implementation file to use.
• If the device is IP based, IpAddress is the IP address and port of the device.
• If this should be the child of another device, DeviceNumParent is the device number of the parent device.
• RoomNum is the number of the room the device will be in.
• StateVariables is a string containing the variables you want set when the device is created. You can specify multiple variables by separating them with a line feed ('\n'), and use ',' and '=' to separate service, variable and value, like this: service,variable=value\nservice,variable=value\n...

• -3 = Configuration failed
• -2 = Configuration in process
• -1 = Device waiting to be configured
• 0 = Device not configured
• 1 = Device successfully configured
• 2 = Device partially configured

• 0 = Status not set
• 1 = OK
• 2 = Quiting
• 3 = Waiting to quit
• 4 = No dongle
• 5 = Configuring: still running init/configure scripts
• 6 = Failure
• 7 = Initializing

• ResetMode can be "SIS" or "SUC".
• HomeID is a 32 bit hex number representing the new HomeID. If this parameter doesn't exist or is 0, MiOS will generate the new HomeID.
• ZeroMemory: if this is "1", the memory will be zeroed before resetting.

• InclusionMode can be "FullPower" or anything else, in which case the exclusion will be low power.
• NodeType is the type of node to be excluded. The valid values are:
  • 1 = any
  • 2 = controller
  • 3 = slave
  • 4 = existing
  • 5 = stop
• Timeout is the number of seconds Vera will be in exclude mode.
• If Multiple is "0" then Vera will exit exclude mode after a node is excluded.
• If Reload is "1" the LuaUPnP engine will be restarted after Vera exits exclude mode.

• InclusionMode can be "FullPower" or anything else, in which case the inclusion will be low power.
• NodeType is the type of node to be included. The valid values are:
  • 1 = any
  • 2 = controller
  • 3 = slave
  • 4 = existing
  • 5 = stop
• Timeout is the number of seconds Vera will be in include mode.
• If Multiple is "0" then Vera will exit include mode after a node is included.
• ControllerShift must be "0".
• If Reload is "1" the LuaUPnP engine will be restarted after Vera exits include mode.

• BatteryMinutes: how many minutes to wait for battery operated devices to be discovered.
• If Node is not blank, then only this node will be repaired.
• StressCycles is the number of cycles to stress test each node.
• If Configure is "1", then all the devices will be re-configured when done.
• If ManualRoute is "1", then only update MiOS routing (overrides other settings).
• StartStage is the starting heal stage. The valid values are:
  • 1 = Request network update.
  • 2 = Request neighbor node update.
  • 3 = Update the routing tables and neighbor nodes.
  • 4 = Calculate the best routes.
  • 5 = Re-configure all nodes.
  • 6 = Wait BatteryMinutes to request neighbor node update and configure all battery operated nodes.
  • 7 = Do a stress test for StressCycles.
• StopStage: Same as StartStage.

• If IsTemporary is "1", then these polling settings will be lost when the LuaUPnP engine is reloaded.
• PollingEnabled: see the related variable.
• PollDelayInitial: see the related variable.
• PollDelayDeadTime: see the related variable.
• PollMinDelay: see the related variable.
• PollFrequency: see the related variable.

Info1:URL1:Info2:URL2:

The Info parameters are:

1. The protocol: can be rtsp or http

2. HTTP authentication required: 1 = yes, send the username and password in the request, 0 = no, don't send the username and password

3. Video codec: mpeg4 | mjpeg | etc.

4. Audio codec: blank = no audio

5. Resolution: t = thumbnail, s = small, m = medium, l = large

6. Width: 640

7. Height: 480

8. Players: q|a|i|w, a string of characters indicating known good players. q = Quicktime plugin, a = Android, i = iPhone, w = normal web browser.

The URL is the streaming URL compatible with the players specified in Info.

Currently only the protocol, players and URL parameters are used. The rest of the parameters are ignored.

VideoURLs example for VistaCam:

rtsp,0,mpeg4,,m,640,480,qai:img/media.sav:http,0,mjpeg,,m,640,480,w:img/video.mjpeg:

• V: when I view the camera from the web or phone;
• S: when the sensor(s) above are tripped and they are armed;
• B: when the sensors above are tripped and they are *not* armed;
• A: when you take an automatic picture for the archive;

So VSBA means do them all.

Syntax:

<VERSION=2>user_code_index_number,active,PIN_code(encrypted),name(a-z,0-9);
slotid,slotid_lock,w,[d|s],dow,hour_start,minute_start,hour_stop,minute_stop;
slotid,slotid_lock,t,[d|s],start,stop;\t

Where:

• VERSION is used to track syntax changes.
• active can be one of the following values:
  • 1 = The code is permanently programmed into the lock, which doesn't support hardware-based scheduling.
  • 2 = The code is permanently programmed into the lock, which does support hardware-based scheduling.
  • 3 = The code is programmed into the lock and will be removed by software later.
  • 4 = The code is not programmed into the lock, but will be later by the software.
  • 5 = The code is programmed into the lock which supports hardware-based scheduling and will enable/disable it automatically.
• The slotid is an auto-incrementing number.
• The slotid_lock is the ID in the lock.
• The restriction type: w (weekly) or d (daily repeating) = day of week based, t = time based (yearly)
• [d|s]: internal stuff.

Syntax:

max_weekly,max_yearly,max_daily_repeating

Where:

• max_weekly is the number of weekly restrictions slots.
• max_yearly is the number of yearly restrictions slots.
• max_daily_repeating is the number of daily repeating restrictions slots.

• UserCodeName is the PIN code name.
• newPin is the new PIN code.

• UserCode is the PIN code index number. The starting index is 1.
• StartDate and StopDate are strings representing the dates, formatted like this: year-month-day hour:minute
• Replace: If this parameter is "1" the current restriction is replaced with the new one. Otherwise a new restriction is added, unless there are no more available restriction slots.

Example: http://192.168.81.1:3480/data_request?id=action&DeviceNum=6&serviceId=urn:micasaverde-com:serviceId:DoorLock1&action=SetPinValidityDate&UserCode=1&StartDate=2012-09-03+14:00&StopDate=2012-09-03+15:00&Replace=1

• UserCode is the PIN code index number. The starting index is 1.
• DayOfWeek contains the days of week numbers when the PIN code is restricted. Monday is '1' and Sunday is '7'.

Example: 1367 means Monday, Wednesday, Saturday and Sunday.

• StartHour is the hour the restriction starts at.
• StartMinute is the minute the restriction starts at.
• StopHour is the hour the restriction stops at.
• StopMinute is the minute the restriction stops at.
• Replace: If this parameter is "1" the current restriction is replaced with the new one. Otherwise a new restriction is added, unless there are no more available restriction slots.

Example: http://192.168.81.1:3480/data_request?id=action&DeviceNum=6&serviceId=urn:micasaverde-com:serviceId:DoorLock1&action=SetPinValidityWeekly&UserCode=1&DayOfWeek=1367&StartHour=15&StartMinute=31&StopHour=16&StopMinute=42&Replace=1

• UserCode is the PIN code index number. The starting index is 1.
• slotID is the slot number. The starting index is 1.

• Off
• HeatOn
• CoolOn
• AutoChangeOver

• Idle
• Heating
• Cooling

• Auto
• ContinuousOn
• PeriodicOn