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.
• PluginNum tells the device which plugin to use. The plugin will be installed automatically if it's not already installed.
• 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...
• If Reload is 1, the Luup engine will be restarted after the device is created.

Mode can be:

• 1 = Home
• 2 = Away
• 3 = Night
• 4 = Vacation

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

The format is:

<house mode>:<state>;<house mode>:<state>;...

• If state is empty, the sensor is disarmed/bypassed.
• If state is "A", the sensor is armed.

Example:

1:;2:A;3:A;4:A

• In Home(1) mode the sensor is disarmed;
• in Away(2), Night(3) and Vacation(4) modes the sensor is armed.

LuaUPnP will create a child device for every item in the list, with the specified KitDevice properties.

Can be used to add children to devices which don't have MultiChannel support.

Format:

<mode code>;<mode name>;<upnp_action>[|<mode code>;<mode name>;<upnp_action>]

where:

• <upnp_action> = <service>/<action>/<parameters>
• <parameters> = <paramName>=<value>[&<paramName>=<value>]

If the value is '?', it means that it's a wildcard and the ModeSettings variable should contain a comma separated list of values in order to substitute this '?' wildcard. If the value is not '?', then the value is fixed and it should be URL encoded.

Example:

h;h code;urn:upnp-org:serviceId:SwitchPower1/SetTarget/newTargetValue=?&otherParameter=45&another=?|s;s code;urn:upnp-org:serviceId:Dimming1/SetTargetLevel/newLevel=34&other=?&another=4

The format is:

variable1_number,variable1_value,variable2_number,variable2_value,...

The format is:

variable1_number-variable1_description,variable1_data_type,variable1_value,variable2_number-variable2_description,variable2_data_type,variable2_value,...

ManufacturerID,ProductType,ProductID

• H1 = Heating
• C1 = Cooling
• F1 = Furnace
• D1 = Dry Air
• MA = Moist Air
• AC = Auto changeover
• H2 = Energy Save Heating
• C2 = Energy Save Cooling
• AH = Away Heating

• 1 = electric
• 2 = gas
• 3 = water

Format:

route1_node1.route1_node2...-route1_score[x],route2_node1.route2_node2...-route2_score[x],...

The score is a measure of latency and accuracy, the lower the number, the better. 'x' means that the last attempt to use this route failed, so it won't be used anymore.

Format:

<Value>=<Action><Endpoint>

where:

• Value  : the BASIC_SET Value; if Value is "XX", it means any value
• Action  : the Action to perform; the supported values are: T=Trip, U=Untrip, O=On, F=Off, D=Dim
• Endpoint  : the Endpoint device ID (altid); if Endpoint=0, it means the parent node, or the current node if the device has no children

Examples:

00=Ue1,FF=Te1 => if receive 0x00, Untrip endpoint "e1"; if receive 0xFF, Trip endpoint "e1"

XX=D02 => Dim endpoint 02 to whatever value received

00=T0,FF=U0 => if receive 0x00, Trip the current node; if receive 0xFF, Untrip the current node

Format:

<CC Hex>-<Supported Type>,<Supported Type>;<CC Hex>-<Supported Type>,<Supported Type>

where:

• CC Hex  : the Hex value of the command class (without 0x):
  • 0x31 for COMMAND_CLASS_SENSOR_MULTILEVEL
  • 0x32 for COMMAND_CLASS_METER
• Supported Type  : The HEX value of the type supported for the Command class without 0x
  • Supported types for COMMAND_CLASS_SENSOR_MULTILEVEL:
    • Temperature = 0x01
    • General = 0x02
    • Luminance = 0x03
    • Power = 0x04
    • RelativeHumidity = 0x05
    • Velocity = 0x06
    • Direction = 0x07
    • AtmosphericPressure = 0x08
    • BarometricPressure = 0x09
    • SolarRadiation = 0x0A
    • DewPoint = 0x0B
    • RainRate = 0x0C
    • TideLevel = 0x0D
    • Weight = 0x0E
    • Voltage = 0x0F
    • Current = 0x10
    • CO2level = 0x11
    • AirFlow = 0x12
    • TankCapacity = 0x13
    • Distance = 0x14
    • SeismicIntensity = 0x19
    • UltraViolet = 0x1B

• • Supported types for COMMAND_CLASS_METER:
    • Electric=0x01
    • Gas=0x02
    • Water=0x03

Examples:

31-0F,0E,10,1B;32-01,03 => Device supports Voltage, Weight, Current and UltraViolet for COMMAND_CLASS_SENSOR_MULTILEVEL and Electric and Water from COMMAND_CLASS_METER

If the variable is empty it will be treated as support anything. If the variable does not contain a command class that command class will be treated as support everything.

Allows setting what each Alarm Type does for devices using COMMAND_CLASS_ALARM / COMMAND_CLASS_NOTIFICATION. The format is:

AlarmTypes:AlarmLevels:AlarmCode:Action;AlarmTypes:AlarmLevels:AlarmCode:Action

where:

• AlarmTypes : type1,type2-type3,!type4
• AlarmLevels : 00,01,05-20,!FF
• AlarmCode : SMOKE, CO, TAMPER_ALARM, etc.
• Action : 0 = don't update the Tripped variable, 1 = update the Tripped variable, 2 = ignore the message (i.e. don't update the sl_Alarm variable)

Example:

01:FF:SMOKE:1;0C:FF::1;0D:FF:TAMPER_ALARM:0

• if Alarm Type is 0x01 and the Alarm Level is 0xFF, then set the sl_Alarm variable to "SMOKE" and trip the sensor
• if Alarm Type is 0x0C and the Alarm Level is 0xFF, don't update the sl_Alarm variable, and trip the sensor
• if Alarm Type is 0x0D and the Alarm Level is 0xFF, then set the sl_Alarm variable to "TAMPER_ALARM", but don't trip the sensor

The format is a ';' separated list of tokens. Format of each token:

TypesV1:LevelV1:NotificationStatus:NotificationType:Event:AlarmCode:UpdateTripped

Where:

• TypesV1 : type1_v1,type2_v1-type3_v1,!type4_v1, XX (don't care)
• LevelV1 : 00,01,02-05,!FF, XX (don't care)
• NotificationStatus : 01-FF, XX (don't care)
• NotificationType : type1,type2-type3,!type4, XX (don't care)
• Event : 00,01,03-5A,!04,!FF, XX (don't care)
• AlarmCode : SMOKE, CO, TAMPER_ALARM, etc.
• TripValue : 0 = Untrip, 1 = Trip, C = don't update the Tripped variable (only the Alarm Code), X = Ignore

If the TypeV1 or NotificationType are not XX and if there was no match, the function will try the next token.

1,3,4,255

You could add this variable with a value = 0 if you want to be in NO association groups.

Format:

<CC #1>-<Command #1>,<Command #2>;<CC #2>-*;<CC #3>-<Command #1>

• Both the command classes and the commands are given by their hex code.
• * is used as an wild card indicating all commands.

Example:

26-03,05;71;20-03

That means: ignore CC 26 commands 03 and 05, CC 71 and CC 20 command 03.

• 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.

Examples:

1. Set parameter 29 to "3" on node 15:

• HTTP request:

/data_request?id=action&DeviceNum=1&serviceId=urn:micasaverde-com:serviceId:ZWaveNetwork1&action=SendData&Node=15&Data=x70%204%2029%201%203

• Lua:

luup.call_action("urn:micasaverde-com:serviceId:ZWaveNetwork1", "SendData", {Node=15, Data="x70 4 29 1 3"}, 1)

2. Turn on a light (node 7):

• HTTP request:

/data_request?id=action&DeviceNum=1&serviceId=urn:micasaverde-com:serviceId:ZWaveNetwork1&action=SendData&Node=7&Data=x20%201%20xFF

• Lua:

luup.call_action("urn:micasaverde-com:serviceId:ZWaveNetwork1", "SendData", {Node=7, Data="x20 1 xFF"}, 1)

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, HTTP auth, 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:

The format is: Enabled,BufferSeconds,NumFramesToPurge,Format,URL

• Enabled can be 0 or 1. If it's 1, the ring buffer is enabled.
• BufferSeconds: how many seconds of video to keep in the buffer. This is limited by the available memory on Vera. Setting this to a large value will cause instability.
• NumFramesToPurge: how many frames to wait before attempting to purge.
• Format can be 2=MJPEG, 3=MP4.
• URL is the streaming URL.

• 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.

<stream type>,<protocol>,<url>

• The stream types currently supported are: flv, flv_low, rtsp, rtsp_low.

The types with the "_low" suffix are the low bandwidth versions, and are used when streaming through the relay servers.

• The supported protocols are: http, rtsp.

Example:

flv,http,/img/media.flv;rtsp,rtsp,/img/media.sav;flv_low,http,/img/media.flv?stream=2;rtsp_low,rtsp,/img/media.sav?stream=2

Syntax:

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

<VERSION=3>next_available_user_code_id\t
user_code_id,active,date_added,date_used,PIN_code(encrypted),name(a-z,0-9);
slot,slot_lock,w,[d|s],dow,hour_start,minute_start,hour_stop,minute_stop;
slot,slot_lock,t,[d|s],start,stop;\t

Where:

• VERSION is used to track syntax changes.
• active can be one of the following values:
  • 0 = The code isn't programmed.
  • 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 it will be programmed 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.

UserID="<pin_slot>" UserName="<pin_code_name>"

• UserCodeName is the PIN code name.
• newPin is the new PIN code.
• user is the PIN code slot number.
• purge: if this is 1, all the schedules programmed into the door lock will be removed.
• json is a json that looks like this:

{
    "user_code" : {
        "slot" : "<pin_slot>",        // Used when adding/updating a PIN code.
        "name" : "<name>",
        "code" : "<pin_code>",
        "user" : "<restriction_slot>" // Used when adding/updating restrictions.
    },
    "weekly_schedules" : [
        {
            "day_of_week" : "136"
            "from_time" : "12:34"
            "to_time" : "23:45"
        },
        {
            "day_of_week" : "25"
            "from_time" : "13:46"
            "to_time" : "21:09"
        }
        ...
    ],
    "daily_schedules" : [
        {
            "start_date" : "YYYY-MM-DD HH:MM:SS"
            "stop_date" : "YYYY-MM-DD HH:MM:SS"
        },
        {
            "start_date" : "YYYY-MM-DD HH:MM:SS"
            "stop_date" : "YYYY-MM-DD HH:MM:SS"
        }
        ...
    ]
}

• • slot in json is equivalent to user
  • name in json is equivalent to UserCodeName
  • code in json is equivalent to newPin

If the json parameter is present, user, UserCodeName and newPin are ignored.

^* The parameters from SetPinValidityDate and SetPinValidityWeekly are also accepted. Internally, this action calls the implementation functions of those actions if StartDate, respectively DayOfWeek parameters are given. The parameters in the json take precedence over the other parameters.

• UserCode is the PIN code slot number. The starting slot number is 1.
• StartDate and StopDate are strings representing the dates, formatted like this: YYYY-MM-DD HH:MM:SS (SQL DATETIME)
• 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%2014:00:00&StopDate=2012-09-03%2015:00:00&Replace=1

• UserCode is the PIN code slot number. The starting slot number 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 slot number. The starting slot number is 1.
• slotID is the restriction slot number. The starting slot number is 1.

• Off
• HeatOn
• CoolOn
• AutoChangeOver

• Idle
• Heating
• Cooling

• Auto
• ContinuousOn
• PeriodicOn

Format: HEAT,COOL,AUTO

Example: AllSetpoints = 72,74,73

• 72 = heating setpoint
• 74 = cooling setpoint
• 73 = auto mode setpoint

"S" = The report correspond to the current operating state and should update the setpoint in the current mode

Note: For thermostats, UserSuppliedWattage consists of 3 numbers separated by commas. The default is 1500,1500,300. The first number is how many watts are used when the thermostat is in 'heat' mode; the second is how many watts are used when the thermostat is in 'cool' mode; and the third number is for the 'fan only' mode.

CurrentConsumption,Average,Peak,LastReading,Seconds

• LastReading is the Unix time.
• Seconds is the period of time the Average value was computed for.

NumberOfButtons[,ButtonNumber-AssociationNumber-SceneNumber=ButtonName[,ButtonNumber-AssociationNumber-SceneNumber=ButtonName[,etc.]]]

Where:

• ButtonNumber must be from 1 to NumberOfButtons.
• AssociationNumber is the association group.
• SceneNumber is an event ID, and it's sent instead of the one we program.
• ButtonName is the user friendly name of the button.

Example:

2,1-1-1=Tap Button,2-2-2=Hold Button

OldButtonNumber-Attribute-NewButtonNumber[,OldButtonNumber-Attribute-NewButtonNumber[,etc.]]

Where Attribute has the following meaning:

• 0 = Key pressed
• 1 = Key is released, sent only as a termination of a Key Held Down sequence
• 2 = Key held down
• 3 = Key double tapped ¹

¹ This is not Z-Wave standard, so it's not available on all the scene controllers.

Example:

1-0-1,1-3-2,2-0-3,2-3-4,3-0-5,3-3-6,4-0-7,4-3-8

• newValue is the new light state. The valid values are:
  • 0 = off
  • 1 = green
  • 2 = red
  • 3 = orange
• Indicator is the button number.