View source for Luup UPnP Variables and Actions

This is a list of all the UPnP actions and variables used by MiOS.

Some actions and variables have self-explanatory names, so there's a dash ('-') instead of the description.

== HomeAutomationGateway1 ==
* '''Service ID''': urn:micasaverde-com:serviceId:HomeAutomationGateway1
* '''File''': S_HomeAutomationGateway1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" | Variable
 ! style="border: 1px solid #000; width:  60px" | Type
 ! style="border: 1px solid #000"               | Description
 |-
 | style="border: 1px solid #000" | DataVersion
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | A number that increases each time the data changes.
 |-
 | style="border: 1px solid #000" | UDN
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | The Unique Device Name of the UPnP device.
 |}


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" rowspan="2" | Action
 ! style="border: 1px solid #000"               colspan="2" | Arguments
 ! style="border: 1px solid #000"               rowspan="2" | Description
 |-
 ! style="border: 1px solid #000; width: 130px"             | Name
 ! style="border: 1px solid #000; width: 140px"             | Type or Related Variable
 |-
 | style="border: 1px solid #000" rowspan="1" | Reload
 | style="border: 1px solid #000; text-align: center" colspan="2" | none
 | style="border: 1px solid #000" rowspan="1" | Reload the LuaUPnP engine.
 |-
 | style="border: 1px solid #000" rowspan="3" | ModifyUserData
 | style="border: 1px solid #000" | inUserData
 | style="border: 1px solid #000" | UserData
 | style="border: 1px solid #000" rowspan="3" | Make changes to the UserData.
* <tt>inUserData</tt> is the new UserData object which will be added to the UserData or will replace an existent UserData object.
* <tt>DataFormat</tt> must be ''json''.
* If <tt>Reload</tt> is ''1'' the LuaUPnP engine will reload after the UserData is modified.
For more information read the [[ModifyUserData]] page.
 |-
 | style="border: 1px solid #000" | DataFormat
 | style="border: 1px solid #000" | string
 |-
 | style="border: 1px solid #000" | Reload
 | style="border: 1px solid #000" | boolean
 |-
 | style="border: 1px solid #000" rowspan="4" | SetVariable
 | style="border: 1px solid #000" | DeviceNum
 | style="border: 1px solid #000" | int or string
 | style="border: 1px solid #000" rowspan="4" | Create or change the value of a variable.
* <tt>DeviceNum</tt> can be an UDN or a number.
* <tt>Service</tt> is the service ID of the variable.
* <tt>Variable</tt> is the variable name.
* <tt>Value</tt> is the new variable value.
 |-
 | style="border: 1px solid #000" | Service
 | style="border: 1px solid #000" | string
 |-
 | style="border: 1px solid #000" | Variable
 | style="border: 1px solid #000" | string
 |-
 | style="border: 1px solid #000" | Value
 | style="border: 1px solid #000" | string
 |-
 | style="border: 1px solid #000" rowspan="1" | RunScene
 | style="border: 1px solid #000" | SceneNum
 | style="border: 1px solid #000" | int
 | style="border: 1px solid #000" rowspan="1" | Run the given scene.
 |-
 | style="border: 1px solid #000" rowspan="1" | SceneOff
 | style="border: 1px solid #000" | SceneNum
 | style="border: 1px solid #000" | int
 | style="border: 1px solid #000" rowspan="1" | Turn off all the devices from DEVICE_CATEGORY_DIMMABLE_LIGHT and DEVICE_CATEGORY_SWITCH from the given scene.
 |-
 | style="border: 1px solid #000" rowspan="2" | RunLua
 | style="border: 1px solid #000" | DeviceNum
 | style="border: 1px solid #000" | int or string
 | style="border: 1px solid #000" rowspan="2" | Run the given Lua code. If <tt>DeviceNum</tt> is specified, the code is run using that device's interface.
 |-
 | style="border: 1px solid #000" | Code
 | style="border: 1px solid #000" | string
 |-
 | style="border: 1px solid #000" rowspan="14" | CreateDevice
 | style="border: 1px solid #000" | deviceType
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" rowspan="14" | Create a device using the given parameters.
* <tt>deviceType</tt> is the UPnP device type.
* <tt>internalID</tt> 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.
* <tt>Description</tt> is the device name, which is shown to the user on the dashboard.
* <tt>UpnpDevFilename</tt> is the UPnP device description file name.
* <tt>UpnpImplFilename</tt> is the implementation file to use.
* If the device is IP based, <tt>IpAddress</tt> is the IP address and port of the device.
* If this should be the child of another device, <tt>DeviceNumParent</tt> is the device number of the parent device.
* <tt>RoomNum</tt> is the number of the room the device will be in.
* <tt>PluginNum</tt> tells the device which plugin to use. The plugin will be installed automatically if it's not already installed.
* <tt>StateVariables</tt> 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: <tt>service,variable=value\nservice,variable=value\n</tt>...
* If <tt>Reload</tt> is '''1''', the Luup engine will be restarted after the device is created.
 |-
 | style="border: 1px solid #000" | internalID
 | style="border: 1px solid #000" | string
 |-
 | style="border: 1px solid #000" | Description
 | style="border: 1px solid #000" | string
 |-
 | style="border: 1px solid #000" | UpnpDevFilename
 | style="border: 1px solid #000" | string
 |-
 | style="border: 1px solid #000" | UpnpImplFilename
 | style="border: 1px solid #000" | string
 |-
 | style="border: 1px solid #000" | IpAddress
 | style="border: 1px solid #000" | string
 |-
 | style="border: 1px solid #000" | MacAddress
 | style="border: 1px solid #000" | string
 |-
 | style="border: 1px solid #000" | Username
 | style="border: 1px solid #000" | string
 |-
 | style="border: 1px solid #000" | Password
 | style="border: 1px solid #000" | string
 |-
 | style="border: 1px solid #000" | DeviceNumParent
 | style="border: 1px solid #000" | int
 |-
 | style="border: 1px solid #000" | RoomNum
 | style="border: 1px solid #000" | int
 |-
 | style="border: 1px solid #000" | PluginNum
 | style="border: 1px solid #000" | int
 |-
 | style="border: 1px solid #000" | StateVariables
 | style="border: 1px solid #000" | string
 |-
 | style="border: 1px solid #000" | Reload
 | style="border: 1px solid #000" | boolean
 |-
 | style="border: 1px solid #000" rowspan="2" | DeleteDevice
 | style="border: 1px solid #000" | DeviceNum
 | style="border: 1px solid #000" | int
 | style="border: 1px solid #000" rowspan="2" | Delete the device given either through its number, or through its UDN.
 |-
 | style="border: 1px solid #000" | UDN
 | style="border: 1px solid #000" | string
 |-
 | style="border: 1px solid #000" rowspan="3" | CreatePlugin
 | style="border: 1px solid #000" | PluginNum
 | style="border: 1px solid #000" | int
 | style="border: 1px solid #000" rowspan="3" | Create a plugin with the <tt>PluginNum</tt> number and <tt>Version</tt> version. <tt>StateVariables</tt> are the variables that will be set when the device is created. For more information look at the description of the '''CreateDevice''' action above.
 |-
 | style="border: 1px solid #000" | Version
 | style="border: 1px solid #000" | int
 |-
 | style="border: 1px solid #000" | StateVariables
 | style="border: 1px solid #000" | string
 |-
 | style="border: 1px solid #000" rowspan="1" | DeletePlugin
 | style="border: 1px solid #000" | PluginNum
 | style="border: 1px solid #000" | int
 | style="border: 1px solid #000" rowspan="1" | Uninstall the given plugin.
 |-
 | style="border: 1px solid #000" rowspan="2" | CreatePluginDevice
 | style="border: 1px solid #000" | PluginNum
 | style="border: 1px solid #000" | int
 | style="border: 1px solid #000" rowspan="2" | Creates a device for plugin #<tt>PluginNum</tt>.
 |-
 | style="border: 1px solid #000" | StateVariables
 | style="border: 1px solid #000" | string
 |-
 | style="border: 1px solid #000" rowspan="2" | ImportUpnpDevice
 | style="border: 1px solid #000" | UDN
 | style="border: 1px solid #000" | UDN
 | style="border: 1px solid #000" rowspan="2" |
 |-
 | style="border: 1px solid #000" | RoomNum
 | style="border: 1px solid #000" | DeviceNum
 |-
 | style="border: 1px solid #000" rowspan="2" | LogIpRequest
 | style="border: 1px solid #000" | IpAddress
 | style="border: 1px solid #000" | UDN
 | style="border: 1px solid #000" rowspan="2" |
 |-
 | style="border: 1px solid #000" | MacAddress
 | style="border: 1px solid #000" | UDN
 |-
 | style="border: 1px solid #000" | SetHouseMode
 | style="border: 1px solid #000" | Mode
 | style="border: 1px solid #000" | int
 | style="border: 1px solid #000" | Changes the house mode.
<tt>Mode</tt> can be:
* <tt>1</tt> = Home
* <tt>2</tt> = Away
* <tt>3</tt> = Night
* <tt>4</tt> = Vacation
 |}

== HaDevice1 ==
* '''Service ID''': urn:micasaverde-com:serviceId:HaDevice1
* '''File''': S_HaDevice1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" | Variable
 ! style="border: 1px solid #000; width:  60px" | Type
 ! style="border: 1px solid #000"               | Description
 |-
 | style="border: 1px solid #000" | CommFailure
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | This is set to ''1'' if we've lost communication with the device.
 |-
 | style="border: 1px solid #000" | Configured
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | The configuration state of the device:
* -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
 |-
 | style="border: 1px solid #000" | AutoConfigure
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | If this is "1", MiOS will automatically check the routing info for this every 12 hours.
 |-
 | style="border: 1px solid #000" | BatteryLevel
 | style="border: 1px solid #000" | i1
 | style="border: 1px solid #000" | The battery level reported by the device.
 |-
 | style="border: 1px solid #000" | BatteryDate
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | The UNIX time when the <tt>BatteryLevel</tt> was reported.
 |-
 | style="border: 1px solid #000" | LastTimeCheck
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | Only for devices that are capable of implementing time, this is when the time was last checked.
 |-
 | style="border: 1px solid #000" | LastTimeOffset
 | style="border: 1px solid #000" | ui1
 | style="border: 1px solid #000" | For <tt>LastTimeCheck</tt>, this is the timezone offset from UTC when the time was last checked.
 |-
 | style="border: 1px solid #000" | LastUpdate
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | This is when the device information was last updated. (Mostly used for Z-Wave devices)
 |-
 | style="border: 1px solid #000" | FirstConfigured
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | This is when the device was first configured. (Mostly used for Z-Wave devices)
 |-
 | style="border: 1px solid #000" | IgnoreRoom
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | Used only by the MiOS scene controller. Internal stuff.
 |-
 | style="border: 1px solid #000" | Commands
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | This is a comma separated list of <tt>ControlCodes</tt> for the enabled UI controls. If the <tt>ControlCode</tt> of an UI control (e.g. button) is not in this list, the button will be disabled (greyed out). If this variable is missing, all controls will be enabled. If this variable is empty, all controls will be disabled.
 |-
 | style="border: 1px solid #000" | IODevice
 | style="border: 1px solid #000" | ui2
 | style="border: 1px solid #000" | The device number to connect to for IO. (this is on the master device)
 |-
 | style="border: 1px solid #000" | IOPort
 | style="border: 1px solid #000" | ui2
 | style="border: 1px solid #000" | The port to receive connections on from <tt>IODevice</tt>. (this is on the serial port)
 |-
 | style="border: 1px solid #000" | ReverseOnOff
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | If this is "1", the commands for some devices are reversed (e.g. the On command will turn the device Off, and vice versa). Not all devices support this.
 |-
 | style="border: 1px solid #000" | sl_Alarm
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | Currently used only by the water leak sensor, contains the alarm code.
 |-
 | style="border: 1px solid #000" | ModeSetting
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | Contains the state of the device for each house mode.
The format is:
 <house mode>:<state>;<house mode>:<state>;...
* If <tt>state</tt> is empty, the sensor is disarmed/bypassed.
* If <tt>state</tt> is "A", the sensor is armed.
Example:
 1:;2:A;3:A;4:A
* In <tt>Home</tt>(1) mode the sensor is disarmed;
* in <tt>Away</tt>(2), <tt>Night</tt>(3) and <tt>Vacation</tt>(4) modes the sensor is armed.
 |}


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" rowspan="2" | Action
 ! style="border: 1px solid #000"               colspan="2" | Arguments
 ! style="border: 1px solid #000"               rowspan="2" | Description
 |-
 ! style="border: 1px solid #000; width: 130px"             | Name
 ! style="border: 1px solid #000; width: 140px"             | Type or Related Variable
 |-
 | style="border: 1px solid #000" rowspan="1" | Reconfigure
 | style="border: 1px solid #000; text-align: center" colspan="2" | none
 | style="border: 1px solid #000" rowspan="1" | Reconfigure the device.
 |-
 | style="border: 1px solid #000" rowspan="1" | StressTest
 | style="border: 1px solid #000; text-align: center" colspan="2" | none
 | style="border: 1px solid #000" rowspan="1" | Stress test the Z-Wave device.
 |-
 | style="border: 1px solid #000" rowspan="1" | Remove
 | style="border: 1px solid #000; text-align: center" colspan="2" | none
 | style="border: 1px solid #000" rowspan="1" | Remove the device from the Z-Wave network.
 |-
 | style="border: 1px solid #000" rowspan="1" | Poll
 | style="border: 1px solid #000; text-align: center" colspan="2" | none
 | style="border: 1px solid #000" rowspan="1" | Poll the device.
 |-
 | style="border: 1px solid #000" rowspan="1" | ToggleState
 | style="border: 1px solid #000; text-align: center" colspan="2" | none
 | style="border: 1px solid #000" rowspan="1" | Toggle the state of the device (e.g. if the device it's Off, turns it On). The device must have a binary state (On/Off, Locked/Unlocked, etc.).
 |}


== ZWaveDevice1 ==
* '''Service ID''': urn:micasaverde-com:serviceId:ZWaveDevice1
* '''File''': S_ZWaveDevice1.xml ''(nonexistent)''


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" | Variable
 ! style="border: 1px solid #000; width:  60px" | Type
 ! style="border: 1px solid #000"               | Description
 |-
 | style="border: 1px solid #000" | PollSettings
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | This is the polling frequency for a node (i.e. the minimum number of seconds between two poll commands to the same node). If this variable doesn't exist or is blank, the default polling frequency set in the <tt>ZWaveNetwork1</tt>'s <tt>PollFrequency</tt> variable will be used. If it's '''0''', polling will be disabled for this node.
 |-
 | style="border: 1px solid #000" | PollCommands
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | A comma-separated list of command classes/commands to poll. '<tt>X</tt>' means the device won't respond to any poll.
 |-
 | style="border: 1px solid #000" | MultiChEndpoint
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | Internal stuff.
 |-
 | style="border: 1px solid #000" | MultiChCapabilities
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | Internal stuff.
 |-
 | style="border: 1px solid #000" | Neighbors
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | This is a comma-separated list of the neighbor devices' node IDs. '1' is the Vera's node ID.
 |-
 | style="border: 1px solid #000" | NeighborsInverse
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | This is a comma-separated list of the neighbors that see us.
 |-
 | style="border: 1px solid #000" | Capabilities
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | The first 6 numbers in <tt>Capabilities</tt> are what is reported by the <tt>ZW_GetNodeProtocolInfo</tt> function: Capability, Security, Reserved, Basic Device Class [, Generic Device Class, Specific Device Class]. If the <tt>Capability</tt> is >= 128, then the device listens for commands, otherwise it's a battery operated device that only wakes up occasionally. After the '|' in <tt>Capabilities</tt> are the command classes supported. More information here: [[ZWave_Command_Classes]]
 |-
 | style="border: 1px solid #000" | SecurityFailed
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | If this is "1", MiOS won't talk to this node with security even if the node reports it can.
 |-
 | style="border: 1px solid #000" | LastReset
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | When we last reset the node association. (UNIX time)
 |-
 | style="border: 1px solid #000" | WakeupInterval
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | How often this battery operated device should wake up to report its status. The default value is 1800 seconds.
 |-
 | style="border: 1px solid #000" | ConfiguredWakeupInterval
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | The wakeup interval already configured on the device.
 |-
 | style="border: 1px solid #000" | LastWakeup
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | When this device last woke up and reported its status. (UNIX time)
 |-
 | style="border: 1px solid #000" | LastRouteUpdate
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | When this device's routing information was last checked/updated. (UNIX time)
 |-
 | style="border: 1px solid #000" | Health
 | style="border: 1px solid #000" | ui1
 | style="border: 1px solid #000" | A rating from 0-5. A large number means that MiOS can communicate with it easily.
 |-
 | style="border: 1px solid #000" | HealthDate
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | The date the rating was assigned. (UNIX time)
 |-
 | style="border: 1px solid #000" | VariablesGet
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | This is a comma-separated list of the configuration settings read from the device.
The format is:
 variable1_number,variable1_value,variable2_number,variable2_value,...
 |-
 | style="border: 1px solid #000" | VariablesSet
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | This is a comma-separated list of the configuration settings set by the user.
The format is:
 variable1_number-variable1_description,variable1_data_type,variable1_value,variable2_number-variable2_description,variable2_data_type,variable2_value,...
 |-
 | style="border: 1px solid #000" | AssociationGet
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | This are the association settings read from the device.
 |-
 | style="border: 1px solid #000" | AssociationSet
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | This are the association settings set by the user.
 |-
 | style="border: 1px solid #000" | AssociationNum
 | style="border: 1px solid #000" | ui1
 | style="border: 1px solid #000" | The number of association groupings.
 |-
 | style="border: 1px solid #000" | NonceACK
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | Internal stuff.
 |-
 | style="border: 1px solid #000" | ManufacturerInfo
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | Device information. Format:
 manufacturerID,productType,productID
 |-
 | style="border: 1px solid #000" | VersionInfo
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | This is what's reported by the COMMAND_CLASS_VERSION command VERSION_REPORT. There are 5 values: Z-Wave Library Type, Z-Wave Protocol Version, Z-Wave Protocol Sub Version, Application Version, Application Sub Version. The <tt>Application Version</tt> is specific to the device and not defined by Z-Wave.
 |-
 | style="border: 1px solid #000" | SetPointInfo
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | A comma-separated list of the supported setpoint types:
* <tt>H1</tt> = Heating
* <tt>C1</tt> = Cooling
* <tt>F1</tt> = Furnace
* <tt>D1</tt> = Dry Air
* <tt>MA</tt> = Moist Air
* <tt>AC</tt> = Auto changeover
* <tt>H2</tt> = Energy Save Heating
* <tt>C2</tt> = Energy Save Cooling
* <tt>AH</tt> = Away Heating
 |-
 | style="border: 1px solid #000" | NodeInfo
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | The list of the command classes supported by this device. (hexadecimal numbers)
 |-
 | style="border: 1px solid #000" | InitialName
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | The name that was initially set when the node was first added.
 |-
 | style="border: 1px solid #000" | ConfiguredName
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | The user-specified name when we configured the node.
 |-
 | style="border: 1px solid #000" | ConfiguredVariable
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | The user-specified <tt>VariablesSet</tt> when we configured the node.
 |-
 | style="border: 1px solid #000" | ConfiguredAssoc
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | The user-specified <tt>AssociationSet</tt> when we configured the node.
 |-
 | style="border: 1px solid #000" | Documentation
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | URL of the documentation used on the ''Device Options'' page.
 |-
 | style="border: 1px solid #000" | MeterType
 | style="border: 1px solid #000" | ui1
 | style="border: 1px solid #000" | The meter type:
* 1 = electric
* 2 = gas
* 3 = water
 |-
 | style="border: 1px solid #000" | MeterScale
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | A bit map of the supported meter scales.
 |-
 | style="border: 1px solid #000" | AlarmType
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | List of the supported alarm types.
 |-
 | style="border: 1px solid #000" | PollOk, PollTxFail, PollNoReply
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | These variables are incremented each time the last poll job has the status they describe. They are reset after each network heal.
 |-
 | style="border: 1px solid #000" | ManualRoute
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | A route specified by the end-user. This is a '''dot'''-separated list of nodes.
 |-
 | style="border: 1px solid #000" | AllRoutesFailed
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | This is "1" when all the manual routes have failed.
 |-
 | style="border: 1px solid #000" | AutoRoute
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | This contains a list of various routes chosen by profilings.
Format:
 route1_node1.route1_node2...-route1_score[x],route2_node1.route2_node2...-route2_score[x],...
The <tt>score</tt> is a measure of latency and accuracy, the lower the number, the better. '<tt>x</tt>' means that the last attempt to use this route failed, so it won't be used anymore.
 |-
 | style="border: 1px solid #000" | IgnoreDirectScene
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | Internal stuff.
 |-
 | style="border: 1px solid #000" | SwitchMlSettings
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | Internal stuff.
 |}
<br>

== ZWaveNetwork1 ==
* '''Service ID''': urn:micasaverde-com:serviceId:ZWaveNetwork1
* '''File''': S_ZWaveNetwork1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" | Variable
 ! style="border: 1px solid #000; width:  60px" | Type
 ! style="border: 1px solid #000"               | Description
 |-
 | style="border: 1px solid #000" | NetStatusID
 | style="border: 1px solid #000" | ui1
 | style="border: 1px solid #000" | The status of the Z-Wave network:
* 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
 |-
 | style="border: 1px solid #000" | NetStatusText
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | Full Z-Wave network status description
 |-
 | style="border: 1px solid #000" | LastError
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | The last Z-Wave error in the network
 |-
 | style="border: 1px solid #000" | LastUpdate
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | The UNIX time when the Z-Wave component of the LuaUPnP engine started.
 |-
 | style="border: 1px solid #000" | LastDongleBackup
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | The UNIX time of the last Z-Wave dongle backup.
 |-
 | style="border: 1px solid #000" | LastHeal
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | The UNIX time of the last Z-Wave network heal.
 |-
 | style="border: 1px solid #000" | VersionInfo
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | The Z-Wave version.
 |-
 | style="border: 1px solid #000" | HomeID
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | The unique ID of the Z-Wave network.
 |-
 | style="border: 1px solid #000" | Role
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | Z-Wave specific stuff.
 |-
 | style="border: 1px solid #000" | TO3066
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | Internal stuff.
 |-
 | style="border: 1px solid #000" | ComPort
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | This is the port where MiOS will search for the Z-Wave dongle. On Vera Lite, this is <tt>/dev/ttyS0</tt>.
 |-
 | style="border: 1px solid #000" | LockComPort
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | If this is "1", MiOS won't search for the Z-Wave dongle on the other available ports if it doesn't find it on <tt>ComPort</tt>.
 |-
 | style="border: 1px solid #000" | Use45
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | If this is "1", use Z-Wave version 3.20 instead of 2.78.
 |-
 | style="border: 1px solid #000" | UseMR
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | If this is "1", use MiOS routing.
 |-
 | style="border: 1px solid #000" | LimitNeighbors
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | With MiOS routing: if this is "1", when the routing table is created, consider only Z-Wave's neighbors as valid options.
 |-
 | style="border: 1px solid #000" | PollingEnabled
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | If this is "1", MiOS will automatically poll the Z-Wave devices.
 |-
 | style="border: 1px solid #000" | PollDelayInitial
 | style="border: 1px solid #000" | ui1
 | style="border: 1px solid #000" | Number of seconds after the LuaUPnP engine has (re-)started before the polling loop begins.
 |-
 | style="border: 1px solid #000" | PollDelayDeadTime
 | style="border: 1px solid #000" | ui1
 | style="border: 1px solid #000" | Number of seconds MiOS must not have transmitted any non-poll command before the next poll command is sent.
 |-
 | style="border: 1px solid #000" | PollMinDelay
 | style="border: 1px solid #000" | ui1
 | style="border: 1px solid #000" | Number of seconds between poll commands.
 |-
 | style="border: 1px solid #000" | PollFrequency
 | style="border: 1px solid #000" | ui1
 | style="border: 1px solid #000" | Minimum number of seconds between poll commands to the same node.
 |-
 | style="border: 1px solid #000" | SceneIDs
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | Used for scene controllers. This is a CSV where each item has this format: <tt>node#-button#=ZWaveSceneID</tt>
 |}


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" rowspan="2" | Action
 ! style="border: 1px solid #000"               colspan="2" | Arguments
 ! style="border: 1px solid #000"               rowspan="2" | Description
 |-
 ! style="border: 1px solid #000; width: 130px"             | Name
 ! style="border: 1px solid #000; width: 140px"             | Type or Related Variable
 |-
 | style="border: 1px solid #000" rowspan="3" | ResetNetwork
 | style="border: 1px solid #000" | ResetMode
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" rowspan="3" | Reset the Z-Wave network.
* <tt>ResetMode</tt> can be "SIS" or "SUC".
* <tt>HomeID</tt> 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.
* <tt>ZeroMemory</tt>: if this is "1", the memory will be zeroed before resetting.
 |-
 | style="border: 1px solid #000" | HomeID
 | style="border: 1px solid #000" | string
 |-
 | style="border: 1px solid #000" | ZeroMemory
 | style="border: 1px solid #000" | boolean
 |-
 | style="border: 1px solid #000" rowspan="3" | PutByte
 | style="border: 1px solid #000" | StartAddress
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" rowspan="3" | Used to convert Z-Wave from 2.78 to 3.20 in which case the <tt>StartAddress</tt> parameter must be "convert502_452" and the rest are ignored.
 |-
 | style="border: 1px solid #000" | StopAddress
 | style="border: 1px solid #000" | string
 |-
 | style="border: 1px solid #000" | Value
 | style="border: 1px solid #000" | ui4
 |-
 | style="border: 1px solid #000" rowspan="1" | ReconfigureAllNodes
 | style="border: 1px solid #000" | FailedOnly
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" rowspan="1" | Reconfigure the Z-Wave nodes. If <tt>FailedOnly</tt> is "1", only the devices that failed to configure are reconfigured.
 |-
 | style="border: 1px solid #000" rowspan="1" | UpdateNetwork
 | style="border: 1px solid #000; text-align: center" colspan="2" | none
 | style="border: 1px solid #000" rowspan="1" | Get network update from SUC/SIS.
 |-
 | style="border: 1px solid #000" rowspan="1" | UpdateNeighbors
 | style="border: 1px solid #000" | Device
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" rowspan="1" | Update the neighbor nodes of the given device. <tt>Device</tt> is the device number.
 |-
 | style="border: 1px solid #000" rowspan="1" | BackupDongle
 | style="border: 1px solid #000" | Restore
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" rowspan="1" | Backs up the Z-Wave network. The backup is in <tt>/etc/cmh/dongle.dump</tt>. If <tt>Restore</tt> is "1", the Z-Wave network is restored from the backup.
 |-
 | style="border: 1px solid #000" rowspan="1" | PollAllNodes
 | style="border: 1px solid #000; text-align: center" colspan="2" | none
 | style="border: 1px solid #000; text-align: center" rowspan="1" | -
 |-
 | style="border: 1px solid #000" rowspan="5" | RemoveNodes
 | style="border: 1px solid #000" | InclusionMode
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" rowspan="5" | Puts Vera in exclude mode.
* <tt>InclusionMode</tt> can be "FullPower" or anything else, in which case the exclusion will be low power.
* <tt>NodeType</tt> is the type of node to be excluded. The valid values are:
** 1 = any
** 2 = controller
** 3 = slave
** 4 = existing
** 5 = stop
* <tt>Timeout</tt> is the number of seconds Vera will be in exclude mode.
* If <tt>Multiple</tt> is "0" then Vera will exit exclude mode after a node is excluded.
* If <tt>Reload</tt> is "1" the LuaUPnP engine will be restarted after Vera exits exclude mode.
 |-
 | style="border: 1px solid #000" | NodeType
 | style="border: 1px solid #000" | ui1
 |-
 | style="border: 1px solid #000" | Timeout
 | style="border: 1px solid #000" | ui1
 |-
 | style="border: 1px solid #000" | Multiple
 | style="border: 1px solid #000" | boolean
 |-
 | style="border: 1px solid #000" | Reload
 | style="border: 1px solid #000" | boolean
 |-
 | style="border: 1px solid #000" rowspan="6" | AddNodes
 | style="border: 1px solid #000" | InclusionMode
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" rowspan="6" | Puts Vera in include mode.
* <tt>InclusionMode</tt> can be "FullPower" or anything else, in which case the inclusion will be low power.
* <tt>NodeType</tt> is the type of node to be included. The valid values are:
** 1 = any
** 2 = controller
** 3 = slave
** 4 = existing
** 5 = stop
* <tt>Timeout</tt> is the number of seconds Vera will be in include mode.
* If <tt>Multiple</tt> is "0" then Vera will exit include mode after a node is included.
* <tt>ControllerShift</tt> must be "0".
* If <tt>Reload</tt> is "1" the LuaUPnP engine will be restarted after Vera exits include mode.
 |-
 | style="border: 1px solid #000" | NodeType
 | style="border: 1px solid #000" | ui1
 |-
 | style="border: 1px solid #000" | Timeout
 | style="border: 1px solid #000" | ui1
 |-
 | style="border: 1px solid #000" | Multiple
 | style="border: 1px solid #000" | boolean
 |-
 | style="border: 1px solid #000" | ControllerShift
 | style="border: 1px solid #000" | boolean
 |-
 | style="border: 1px solid #000" | Reload
 | style="border: 1px solid #000" | boolean
 |-
 | style="border: 1px solid #000" rowspan="1" | DownloadNetwork
 | style="border: 1px solid #000; text-align: center" colspan="2" | none
 | style="border: 1px solid #000" rowspan="1" | Copy the Z-Wave network from a master controller.
 |-
 | style="border: 1px solid #000" rowspan="7" | HealNetwork
 | style="border: 1px solid #000" | BatteryMinutes
 | style="border: 1px solid #000" | ui1
 | style="border: 1px solid #000" rowspan="7" | Heals/consolidates the Z-Wave network.
* <tt>BatteryMinutes</tt>: how many minutes to wait for battery operated devices to be discovered.
* If <tt>Node</tt> is not blank, then only this node will be repaired.
* <tt>StressCycles</tt> is the number of cycles to stress test each node.
* If <tt>Configure</tt> is "1", then all the devices will be re-configured when done.
* If <tt>ManualRoute</tt> is "1", then only update MiOS routing (overrides other settings).
* <tt>StartStage</tt> 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 <tt>BatteryMinutes</tt> to request neighbor node update and configure all battery operated nodes.
** 7 = Do a stress test for <tt>StressCycles</tt>.
* <tt>StopStage</tt>: Same as <tt>StartStage</tt>.
 |-
 | style="border: 1px solid #000" | Node
 | style="border: 1px solid #000" | ui1
 |-
 | style="border: 1px solid #000" | StressCycles
 | style="border: 1px solid #000" | ui1
 |-
 | style="border: 1px solid #000" | Configure
 | style="border: 1px solid #000" | boolean
 |-
 | style="border: 1px solid #000" | ManualRoute
 | style="border: 1px solid #000" | boolean
 |-
 | style="border: 1px solid #000" | StartStage
 | style="border: 1px solid #000" | ui1
 |-
 | style="border: 1px solid #000" | StopStage
 | style="border: 1px solid #000" | ui1
 |-
 | style="border: 1px solid #000" rowspan="6" | SetPolling
 | style="border: 1px solid #000" | IsTemporary
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" rowspan="6" | Set the polling parameters.
* If <tt>IsTemporary</tt> is "1", then these polling settings will be lost when the LuaUPnP engine is reloaded.
* <tt>PollingEnabled</tt>: see the related variable.
* <tt>PollDelayInitial</tt>: see the related variable.
* <tt>PollDelayDeadTime</tt>: see the related variable.
* <tt>PollMinDelay</tt>: see the related variable.
* <tt>PollFrequency</tt>: see the related variable.
 |-
 | style="border: 1px solid #000" | PollingEnabled
 | style="border: 1px solid #000" | PollingEnabled
 |-
 | style="border: 1px solid #000" | PollDelayInitial
 | style="border: 1px solid #000" | PollDelayInitial
 |-
 | style="border: 1px solid #000" | PollDelayDeadTime
 | style="border: 1px solid #000" | PollDelayDeadTime
 |-
 | style="border: 1px solid #000" | PollMinDelay
 | style="border: 1px solid #000" | PollMinDelay
 |-
 | style="border: 1px solid #000" | PollFrequency
 | style="border: 1px solid #000" | PollFrequency
 |-
 | style="border: 1px solid #000" rowspan="2" | SendData
 | style="border: 1px solid #000" | Node
 | style="border: 1px solid #000" | ui1
 | style="border: 1px solid #000" rowspan="2" | Sends the Z-Wave <tt>Data</tt> to the Z-Wave <tt>Node</tt>.
 |-
 | style="border: 1px solid #000" | Data
 | style="border: 1px solid #000" | string
 |-
 | style="border: 1px solid #000" rowspan="1" | SimulateIncomingData
 | style="border: 1px solid #000" | Data
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" rowspan="1" | Calls the Z-Wave message handler for the given data.
 |}


== USBUIRT1 ==
* '''Service ID''': urn:micasaverde-com:serviceId:USBUIRT1
* '''File''': S_USBUIRT.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" | Variable
 ! style="border: 1px solid #000; width:  60px" | Type
 ! style="border: 1px solid #000"               | Description
 |-
 | style="border: 1px solid #000" | ComPort
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | The path of the USB port the UIRT is connected to. On Vera Lite this is <tt>/dev/ttyUSB0</tt>
 |}


== Camera1 ==
* '''Service ID''': urn:micasaverde-com:serviceId:Camera1
* '''File''': S_Camera1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" | Variable
 ! style="border: 1px solid #000; width:  60px" | Type
 ! style="border: 1px solid #000"               | Description
 |-
 | style="border: 1px solid #000" | VideoURLs
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | This variable defines the streaming parameters, and without it streaming doesn't work. This variable has this structure:
<tt>Info1:URL1:Info2:URL2:</tt>


The <tt>Info</tt> parameters are:

1. The protocol: can be <tt>rtsp</tt> or <tt>http</tt>

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: <tt>mpeg4</tt> | <tt>mjpeg</tt> | etc.

4. Audio codec: blank = no audio

5. Resolution: <tt>t</tt> = thumbnail, <tt>s</tt> = small, <tt>m</tt> = medium, <tt>l</tt> = large

6. Width: 640

7. Height: 480

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


The <tt>URL</tt> is the streaming URL compatible with the players specified in <tt>Info</tt>.

Currently only the <tt>protocol</tt>, <tt>HTTP auth</tt>, <tt>players</tt> and <tt>URL</tt> parameters are used. The rest of the parameters are ignored.


<tt>VideoURLs</tt> example for VistaCam:

<tt>rtsp,0,mpeg4,,m,640,480,qai:img/media.sav:http,0,mjpeg,,m,640,480,w:img/video.mjpeg:</tt>
 |-
 | style="border: 1px solid #000" | URL
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | This is the URL to get a snapshot from the camera.
 |-
 | style="border: 1px solid #000" | RingBuffer
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | This variable contains the ring buffer parameters.
The format is: <code>Enabled,BufferSeconds,NumFramesToPurge,Format,URL</code>
* <code>Enabled</code> can be '''0''' or '''1'''. If it's '''1''', the ring buffer is enabled.
* <code>BufferSeconds</code>: 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.
* <code>NumFramesToPurge</code>: how many frames to wait before attempting to purge.
* <code>Format</code> can be '''2'''=MJPEG, '''3'''=MP4.
* <code>URL</code> is the streaming URL.
 |-
 | style="border: 1px solid #000" | RelatedSensors
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | Comma separated list of device numbers: archive a photo whenever one of the sensors is tripped.
 |-
 | style="border: 1px solid #000" | SensorArchiveSeconds
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | How many seconds to archive the video after the sensor(s) are tripped.
 |-
 | style="border: 1px solid #000" | RelatedLights
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | Comma separated list of device numbers: which lights should be turned on when viewing this camera.
 |-
 | style="border: 1px solid #000" | LightOptions
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | When to turn on the lights:
* <tt>V</tt>: when I view the camera from the web or phone;
* <tt>S</tt>: when the sensor(s) above are tripped and they are armed;
* <tt>B</tt>: when the sensors above are tripped and they are *not* armed;
* <tt>A</tt>: when you take an automatic picture for the archive;
So <tt>VSBA</tt> means do them all.
 |-
 | style="border: 1px solid #000" | AutoArchiveSeconds
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | Archives a picture from the camera every this number of seconds.
 |-
 | style="border: 1px solid #000" | AutoArchivePreserveDays
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | How many days to keep the pictures in the archive.
 |-
 | style="border: 1px solid #000" | Streams
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | Contains a list separated by semicolons, where each element in the list has the following format:
<code><stream type>,<protocol>,<url></code>
* The ''stream types'' currently supported are: <tt>flv</tt>, <tt>flv_low</tt>, <tt>rtsp</tt>, <tt>rtsp_low</tt>.
The types with the "_low" suffix are the low bandwidth versions, and are used when streaming through the relay servers.
* The supported ''protocols'' are: <tt>http</tt>, <tt>rtsp</tt>.
Example:

<code>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</code>
 |}
<br>

== PanTiltZoom1 ==
* '''Service ID''': urn:micasaverde-com:serviceId:PanTiltZoom1
* '''File''': S_PanTiltZoom1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" rowspan="2" | Action
 ! style="border: 1px solid #000"               colspan="2" | Arguments
 ! style="border: 1px solid #000"               rowspan="2" | Description
 |-
 ! style="border: 1px solid #000; width: 130px"             | Name
 ! style="border: 1px solid #000; width: 140px"             | Type or Related Variable
 |-
 | style="border: 1px solid #000" rowspan="1" | MoveLeft
 | style="border: 1px solid #000; text-align: center" colspan="2" | none
 | style="border: 1px solid #000; text-align: center" rowspan="1" | -
 |-
 | style="border: 1px solid #000" rowspan="1" | MoveRight
 | style="border: 1px solid #000; text-align: center" colspan="2" | none
 | style="border: 1px solid #000; text-align: center" rowspan="1" | -
 |-
 | style="border: 1px solid #000" rowspan="1" | MoveUp
 | style="border: 1px solid #000; text-align: center" colspan="2" | none
 | style="border: 1px solid #000; text-align: center" rowspan="1" | -
 |-
 | style="border: 1px solid #000" rowspan="1" | MoveDown
 | style="border: 1px solid #000; text-align: center" colspan="2" | none
 | style="border: 1px solid #000; text-align: center" rowspan="1" | -
 |-
 | style="border: 1px solid #000" rowspan="1" | ZoomIn
 | style="border: 1px solid #000; text-align: center" colspan="2" | none
 | style="border: 1px solid #000; text-align: center" rowspan="1" | -
 |-
 | style="border: 1px solid #000" rowspan="1" | ZoomOut
 | style="border: 1px solid #000; text-align: center" colspan="2" | none
 | style="border: 1px solid #000; text-align: center" rowspan="1" | -
 |-
 | style="border: 1px solid #000" rowspan="1" | GoToPreset
 | style="border: 1px solid #000" | presetNumber
 | style="border: 1px solid #000" | ui1
 | style="border: 1px solid #000" rowspan="1" | Moves the camera to the given preset.
 |}


== SwitchPower1 ==
* '''Service ID''': urn:upnp-org:serviceId:SwitchPower1
* '''File''': S_SwitchPower1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" | Variable
 ! style="border: 1px solid #000; width:  60px" | Type
 ! style="border: 1px solid #000"               | Description
 |-
 | style="border: 1px solid #000" | Target
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | The target state of the device.
 |-
 | style="border: 1px solid #000" | Status
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | The current state of the device.
 |}


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" rowspan="2" | Action
 ! style="border: 1px solid #000"               colspan="2" | Arguments
 ! style="border: 1px solid #000"               rowspan="2" | Description
 |-
 ! style="border: 1px solid #000; width: 130px"             | Name
 ! style="border: 1px solid #000; width: 140px"             | Type or Related Variable
 |-
 | style="border: 1px solid #000" rowspan="1" | SetTarget
 | style="border: 1px solid #000" | newTargetValue
 | style="border: 1px solid #000" | Target
 | style="border: 1px solid #000" rowspan="1" | Sets the target state of the device. Used to turn a device On or Off.
 |}


== WindowCovering1 ==
* '''Service ID''': urn:upnp-org:serviceId:WindowCovering1
* '''File''': S_WindowCovering1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" rowspan="2" | Action
 ! style="border: 1px solid #000"               colspan="2" | Arguments
 ! style="border: 1px solid #000"               rowspan="2" | Description
 |-
 ! style="border: 1px solid #000; width: 130px"             | Name
 ! style="border: 1px solid #000; width: 140px"             | Type or Related Variable
 |-
 | style="border: 1px solid #000" rowspan="1" | Up
 | style="border: 1px solid #000; text-align: center" colspan="2" | none
 | style="border: 1px solid #000; text-align: center" rowspan="1" | -
 |-
 | style="border: 1px solid #000" rowspan="1" | Down
 | style="border: 1px solid #000; text-align: center" colspan="2" | none
 | style="border: 1px solid #000; text-align: center" rowspan="1" | -
 |-
 | style="border: 1px solid #000" rowspan="1" | Stop
 | style="border: 1px solid #000; text-align: center" colspan="2" | none
 | style="border: 1px solid #000; text-align: center" rowspan="1" | -
 |}


== Dimming1 ==
* '''Service ID''': urn:upnp-org:serviceId:Dimming1
* '''File''': S_Dimming1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" | Variable
 ! style="border: 1px solid #000; width:  60px" | Type
 ! style="border: 1px solid #000"               | Description
 |-
 | style="border: 1px solid #000" | LoadLevelTarget
 | style="border: 1px solid #000" | ui1
 | style="border: 1px solid #000" | The target dimming value; it doesn't represent the actual dimming state.
 |-
 | style="border: 1px solid #000" | LoadLevelStatus
 | style="border: 1px solid #000" | ui1
 | style="border: 1px solid #000" | Represents the actual dimming state.
 |}


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" rowspan="2" | Action
 ! style="border: 1px solid #000"               colspan="2" | Arguments
 ! style="border: 1px solid #000" rowspan="2" | Description
 |-
 ! style="border: 1px solid #000; width: 130px"             | Name
 ! style="border: 1px solid #000; width: 140px"             | Type or Related Variable
 |-
 | style="border: 1px solid #000" rowspan="1" | SetLoadLevelTarget
 | style="border: 1px solid #000" | newLoadlevelTarget
 | style="border: 1px solid #000" | LoadLevelTarget
 | style="border: 1px solid #000" rowspan="1" | Sets the desired dimming level. Used to adjust the dimming level of a device.
 |}


== DoorLock1 ==

*'''Service ID''': urn:micasaverde-com:serviceId:DoorLock1
*'''File''': S_DoorLock1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
|-
! style="border: 1px solid #000; width: 150px" | Variable
! style="border: 1px solid #000; width: 60px" | Type
! style="border: 1px solid #000"               | Description
|-
| style="border: 1px solid #000" | Target
| style="border: 1px solid #000" | boolean
| style="border: 1px solid #000" | Represents the target (desired) door state.
|-
| style="border: 1px solid #000" | Status
| style="border: 1px solid #000" | boolean
| style="border: 1px solid #000" | Represents the current door state. "1" = locked, "0" = unlocked
|-
| style="border: 1px solid #000" | PinCodes
| style="border: 1px solid #000" | string
| style="border: 1px solid #000" | The list of PIN codes.
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:
* <tt>VERSION</tt> is used to track syntax changes.
* <tt>active</tt> can be one of the following values:
** <tt>0</tt> = The code isn't programmed.
** <tt>1</tt> = The code is permanently programmed into the lock, which '''doesn't''' support hardware-based scheduling.
** <tt>2</tt> = The code is permanently programmed into the lock, which '''does''' support hardware-based scheduling.
** <tt>3</tt> = The code is programmed into the lock and will be removed by software later.
** <tt>4</tt> = The code is not programmed into the lock, but it will be programmed later by the software.
** <tt>5</tt> = The code is programmed into the lock which supports hardware-based scheduling and will enable/disable it automatically.
* The <tt>slotid</tt> is an auto-incrementing number.
* The <tt>slotid_lock</tt> is the ID in the lock.
* The restriction type: '''<tt>w</tt>''' (''weekly'') or '''<tt>d</tt>''' (''daily repeating'') = day of week based, '''<tt>t</tt>''' = time based (''yearly'')
* <tt>[d|s]</tt>: internal stuff.
|-
| style="border: 1px solid #000" | NumSchedules
| style="border: 1px solid #000" | string
| style="border: 1px solid #000" | Maximum number of restrictions supported by the door lock.
Syntax:
 max_weekly,max_yearly,max_daily_repeating
Where:
* <tt>max_weekly</tt> is the number of weekly restrictions slots.
* <tt>max_yearly</tt> is the number of yearly restrictions slots.
* <tt>max_daily_repeating</tt> is the number of daily repeating restrictions slots.
|-
| style="border: 1px solid #000" | MinPinSize ''and'' MaxPinSize
| style="border: 1px solid #000" | ui1
| style="border: 1px solid #000" | The minimum and maximum number of digits of the PIN code.
|-
| style="border: 1px solid #000" | sl_UserCode
| style="border: 1px solid #000" | string
| style="border: 1px solid #000" | Contains information about the last used PIN code:
 UserID="<pin_slot>" UserName="<pin_code_name>"
|-
| style="border: 1px solid #000" | sl_PinFailed
| style="border: 1px solid #000" | boolean
| style="border: 1px solid #000" | This becomes "1" when a bad PIN code is entered.
|-
| style="border: 1px solid #000" | sl_CodeChanged
| style="border: 1px solid #000" | ui1
| style="border: 1px solid #000" | If a PIN code was changed using the lock keypad, this contains the PIN code index number.
|-
| style="border: 1px solid #000" | sl_LockButton
| style="border: 1px solid #000" | boolean
| style="border: 1px solid #000" | This is "1" if the Lock button has been pressed on the lock keypad.
|-
| style="border: 1px solid #000" | sl_LockFailure
| style="border: 1px solid #000" | boolean
| style="border: 1px solid #000" | This is "1" if the lock fails to operate.
|-
| style="border: 1px solid #000" | sl_UnauthUser
| style="border: 1px solid #000" | boolean
| style="border: 1px solid #000" | This is "1" if the user code was entered outside of a valid date.
|-
| style="border: 1px solid #000" | sl_LockChanged
| style="border: 1px solid #000" | ui1
| style="border: 1px solid #000" | If a PIN code was changed using the lock keypad, this contains the PIN code index number.
|-
| style="border: 1px solid #000" | sl_LowBattery
| style="border: 1px solid #000" | boolean
| style="border: 1px solid #000" | This is "1" when the battery level is low.
|-
| style="border: 1px solid #000" | sl_VeryLowBattery
| style="border: 1px solid #000" | boolean
| style="border: 1px solid #000" | This is "1" when the battery level is very low.
|}


{| style="border: 1px solid #000; border-collapse: collapse"
|-
! style="border: 1px solid #000; width: 150px" rowspan="2" | Action
! style="border: 1px solid #000" colspan="2" | Arguments
! style="border: 1px solid #000" rowspan="2" | Description
|-
! style="border: 1px solid #000; width: 130px" | Name
! style="border: 1px solid #000; width: 140px" | Type or Related Variable
|-
| style="border: 1px solid #000" rowspan="1" | SetTarget
| style="border: 1px solid #000" | newTargetValue
| style="border: 1px solid #000" | Target
| style="border: 1px solid #000" rowspan="1" | Sets the target (desired) state of the door. Used to lock and unlock the door.
|-
| style="border: 1px solid #000" rowspan="7" | SetPin
| style="border: 1px solid #000" | UserCodeName
| style="border: 1px solid #000" | string
| style="border: 1px solid #000" rowspan="7" | Adds a PIN code. This code will be added to the <code>PinCodes</code> variable and to the door lock.
* <code>UserCodeName</code> is the PIN code name.
* <code>newPin</code> is the new PIN code.
* <code>user</code> is the PIN code slot number.
* <code>purge</code>: if this is '''<tt>1</tt>''', all the schedules programmed into the door lock will be removed.
* <code>json</code> 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"
         }
         ...
     ]
 }
** ''<tt>slot</tt>'' in <code>json</code> is equivalent to <code>user</code>
** ''<tt>name</tt>'' in <code>json</code> is equivalent to <code>UserCodeName</code>
** ''<tt>code</tt>'' in <code>json</code> is equivalent to <code>newPin</code>


If the <code>json</code> parameter is present, <code>user</code>, <code>UserCodeName</code> and <code>newPin</code> are ignored.


<sup>*</sup> The parameters from <code>SetPinValidityDate</code> and <code>SetPinValidityWeekly</code> are also accepted. Internally, this action calls the implementation functions of those actions if <code>StartDate</code>, respectively <code>DayOfWeek</code> parameters are given. The parameters in the <code>json</code> take precedence over the other parameters.
|-
| style="border: 1px solid #000" | newPin
| style="border: 1px solid #000" | ui4
|-
| style="border: 1px solid #000" | user
| style="border: 1px solid #000" | ui1
|-
| style="border: 1px solid #000" | purge
| style="border: 1px solid #000" | boolean
|-
| style="border: 1px solid #000" | json
| style="border: 1px solid #000" | string
|-
| style="border: 1px solid #000" colspan="2" | <sup>*</sup> <tt>SetPinValidityDate</tt> parameters
|-
| style="border: 1px solid #000" colspan="2" | <sup>*</sup> <tt>SetPinValidityWeekly</tt> parameters
|-
| style="border: 1px solid #000" rowspan="4" | SetPinValidityDate
| style="border: 1px solid #000" | UserCode
| style="border: 1px solid #000" | ui1
| style="border: 1px solid #000" rowspan="4" | Sets the daily time interval in which a PIN code is valid.
* <tt>UserCode</tt> is the PIN code slot number. The starting slot number is 1.
* <tt>StartDate</tt> and <tt>StopDate</tt> are strings representing the dates, formatted like this: <tt>YYYY-MM-DD HH:MM:SS</tt> (SQL DATETIME)
* <tt>Replace</tt>: 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
|-
| style="border: 1px solid #000" | StartDate
| style="border: 1px solid #000" | string
|-
| style="border: 1px solid #000" | StopDate
| style="border: 1px solid #000" | string
|-
| style="border: 1px solid #000" | Replace
| style="border: 1px solid #000" | boolean
|-
| style="border: 1px solid #000" rowspan="7" | SetPinValidityWeekly
| style="border: 1px solid #000" | UserCode
| style="border: 1px solid #000" | ui1
| style="border: 1px solid #000" rowspan="7" | Sets the weekly time interval in which a PIN code is valid.
* <tt>UserCode</tt> is the PIN code slot number. The starting slot number is 1.
* <tt>DayOfWeek</tt> contains the days of week numbers when the PIN code is restricted. Monday is '<tt>1</tt>' and Sunday is '<tt>7</tt>'.
Example: <tt>1367</tt> means Monday, Wednesday, Saturday and Sunday.
* <tt>StartHour</tt> is the hour the restriction starts at.
* <tt>StartMinute</tt> is the minute the restriction starts at.
* <tt>StopHour</tt> is the hour the restriction stops at.
* <tt>StopMinute</tt> is the minute the restriction stops at.
* <tt>Replace</tt>: 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
|-
| style="border: 1px solid #000" | DayOfWeek
| style="border: 1px solid #000" | ui4
|-
| style="border: 1px solid #000" | StartHour
| style="border: 1px solid #000" | ui1
|-
| style="border: 1px solid #000" | StartMinute
| style="border: 1px solid #000" | ui1
|-
| style="border: 1px solid #000" | StopHour
| style="border: 1px solid #000" | ui1
|-
| style="border: 1px solid #000" | StopMinute
| style="border: 1px solid #000" | ui1
|-
| style="border: 1px solid #000" | Replace
| style="border: 1px solid #000" | boolean
|-
| style="border: 1px solid #000" rowspan="2" | ClearPinValidity
| style="border: 1px solid #000" | UserCode
| style="border: 1px solid #000" | ui4
| style="border: 1px solid #000" rowspan="2" | Clears the given restriction slot.
* <tt>UserCode</tt> is the PIN code slot number. The starting slot number is 1.
* <tt>slotID</tt> is the restriction slot number. The starting slot number is 1.
|-
| style="border: 1px solid #000" | slotID
| style="border: 1px solid #000" | ui4
|-
| style="border: 1px solid #000" rowspan="1" | ClearPin
| style="border: 1px solid #000" | UserCode
| style="border: 1px solid #000" | ui1
| style="border: 1px solid #000" rowspan="1" | Removes the PIN code from slot <tt>UserCode</tt>.
|}

== HVAC_UserOperatingMode1 ==
* '''Service ID''': urn:upnp-org:serviceId:HVAC_UserOperatingMode1
* '''File''': S_HVAC_UserOperatingMode1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" | Variable
 ! style="border: 1px solid #000; width:  60px" | Type
 ! style="border: 1px solid #000"               | Description
 |-
 | style="border: 1px solid #000" | ModeTarget
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | The desired operating mode of the HVAC. Currently MiOS supports only:
* Off
* HeatOn
* CoolOn
* AutoChangeOver
 |-
 | style="border: 1px solid #000" | ModeStatus
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | The actual operating mode of the HVAC.
 |-
 | style="border: 1px solid #000" | EnergyModeTarget
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | The desired energy mode. Can be <tt>Normal</tt> or <tt>EnergySavingsMode</tt>.
 |-
 | style="border: 1px solid #000" | EnergyModeStatus
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | The actual energy mode.
 |-
 | style="border: 1px solid #000" | AutoMode
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | If specified, and if 0, the thermostat doesn't support auto mode.
 |}


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" rowspan="2" | Action
 ! style="border: 1px solid #000"               colspan="2" | Arguments
 ! style="border: 1px solid #000"               rowspan="2" | Description
 |-
 ! style="border: 1px solid #000; width: 130px"             | Name
 ! style="border: 1px solid #000; width: 140px"             | Type or Related Variable
 |-
 | style="border: 1px solid #000" rowspan="1" | SetModeTarget
 | style="border: 1px solid #000" | NewModeTarget
 | style="border: 1px solid #000" | ModeTarget
 | style="border: 1px solid #000" rowspan="1" | Sets the desired HVAC operating mode.
 |-
 | style="border: 1px solid #000" rowspan="1" | SetEnergyModeTarget
 | style="border: 1px solid #000" | NewModeTarget
 | style="border: 1px solid #000" | EnergyModeTarget
 | style="border: 1px solid #000" rowspan="1" | Sets the desired energy mode.
 |}


== HVAC_OperatingState1 ==
* '''Service ID''': urn:micasaverde-com:serviceId:HVAC_OperatingState1
* '''File''': S_HVAC_OperatingState1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" | Variable
 ! style="border: 1px solid #000; width:  60px" | Type
 ! style="border: 1px solid #000"               | Description
 |-
 | style="border: 1px solid #000" | ModeState
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | Represents what the HVAC is actually doing right now. The most common actions are:
* Idle
* Heating
* Cooling
 |}


== HVAC_FanOperatingMode1 ==
* '''Service ID''': urn:upnp-org:serviceId:HVAC_FanOperatingMode1
* '''File''': S_HVAC_FanOperatingMode1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" | Variable
 ! style="border: 1px solid #000; width:  60px" | Type
 ! style="border: 1px solid #000"               | Description
 |-
 | style="border: 1px solid #000" | Mode
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | The fan operation mode. Can be:
* Auto
* ContinuousOn
* PeriodicOn
 |-
 | style="border: 1px solid #000" | FanStatus
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | Represents the current fan state; can be ''On'' or ''Off''.
 |}


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" rowspan="2" | Action
 ! style="border: 1px solid #000"               colspan="2" | Arguments
 ! style="border: 1px solid #000"               rowspan="2" | Description
 |-
 ! style="border: 1px solid #000; width: 130px"             | Name
 ! style="border: 1px solid #000; width: 140px"             | Type or Related Variable
 |-
 | style="border: 1px solid #000" rowspan="1" | SetMode
 | style="border: 1px solid #000" | NewMode
 | style="border: 1px solid #000" | Mode
 | style="border: 1px solid #000" rowspan="1" | Sets the fan operating mode. Changes the Mode variable.
 |}


== TemperatureSetpoint1 ==
* '''Service ID''': urn:upnp-org:serviceId:TemperatureSetpoint1 
<span style="color: red">NOTE:</span> On UI7, <code>urn:upnp-org:serviceId:TemperatureSetpoint1_Heat</code> and <code>urn:upnp-org:serviceId:TemperatureSetpoint1_Cool</code> are obsolete.
* '''File''': S_TemperatureSetpoint1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" | Variable
 ! style="border: 1px solid #000; width:  60px" | Type
 ! style="border: 1px solid #000"               | Description
 |-
 | style="border: 1px solid #000" | SetpointTarget
 | style="border: 1px solid #000" | i4
 | style="border: 1px solid #000" | The target temperature setpoint for the current thermostat mode.
 |-
 | style="border: 1px solid #000" | CurrentSetpoint
 | style="border: 1px solid #000" | i4
 | style="border: 1px solid #000" | The actual temperature setpoint for the current thermostat mode.
 |-
 | style="border: 1px solid #000" | AllSetpoints
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | A comma separated list containing the current setpoints for the following thermostat modes: heat, cool, auto.
Format: <code>HEAT,COOL,AUTO</code>

Example: <code>AllSetpoints = 72,74,73</code>
* 72 = heating setpoint
* 74 = cooling setpoint
* 73 = auto mode setpoint
 |-
 | style="border: 1px solid #000" | AutoMode
 | style="border: 1px solid #000" | i4
 | style="border: 1px solid #000" | If specified, the thermostat doesn't support auto setpoint, so set heat+cool this many degrees +/-
 |}


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" rowspan="2" | Action
 ! style="border: 1px solid #000"               colspan="2" | Arguments
 ! style="border: 1px solid #000"               rowspan="2" | Description
 |-
 ! style="border: 1px solid #000; width: 130px"             | Name
 ! style="border: 1px solid #000; width: 140px"             | Type or Related Variable
 |-
 | style="border: 1px solid #000" rowspan="1" | SetCurrentSetpoint
 | style="border: 1px solid #000" | NewCurrentSetpoint
 | style="border: 1px solid #000" | CurrentSetpoint
 | style="border: 1px solid #000" rowspan="1" | Sets the target setpoint.
 |}


== TemperatureSensor1 ==
* '''Service ID''': urn:upnp-org:serviceId:TemperatureSensor1
* '''File''': S_TemperatureSensor1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" | Variable
 ! style="border: 1px solid #000; width:  60px" | Type
 ! style="border: 1px solid #000"               | Description
 |-
 | style="border: 1px solid #000" | CurrentTemperature
 | style="border: 1px solid #000" | i4
 | style="border: 1px solid #000; text-align: center" | -
 |}


== GenericSensor1 ==
* '''Service ID''': urn:micasaverde-com:serviceId:GenericSensor1
* '''File''': S_GenericSensor1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" | Variable
 ! style="border: 1px solid #000; width:  60px" | Type
 ! style="border: 1px solid #000"               | Description
 |-
 | style="border: 1px solid #000" | CurrentLevel
 | style="border: 1px solid #000" | i4
 | style="border: 1px solid #000; text-align: center" | -
 |}


== LightSensor1 ==
* '''Service ID''': urn:micasaverde-com:serviceId:LightSensor1
* '''File''': S_LightSensor1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" | Variable
 ! style="border: 1px solid #000; width:  60px" | Type
 ! style="border: 1px solid #000"               | Description
 |-
 | style="border: 1px solid #000" | CurrentLevel
 | style="border: 1px solid #000" | i4
 | style="border: 1px solid #000; text-align: center" | -
 |}


== HumiditySensor1 ==
* '''Service ID''': urn:micasaverde-com:serviceId:HumiditySensor1
* '''File''': S_HumiditySensor1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" | Variable
 ! style="border: 1px solid #000; width:  60px" | Type
 ! style="border: 1px solid #000"               | Description
 |-
 | style="border: 1px solid #000" | CurrentLevel
 | style="border: 1px solid #000" | i4
 | style="border: 1px solid #000; text-align: center" | -
 |}


== SecuritySensor1 ==
* '''Service ID''': urn:micasaverde-com:serviceId:SecuritySensor1
* '''File''': S_SecuritySensor1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" | Variable
 ! style="border: 1px solid #000; width:  60px" | Type
 ! style="border: 1px solid #000"               | Description
 |-
 | style="border: 1px solid #000" | Tripped
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000; text-align: center" | -
 |-
 | style="border: 1px solid #000" | Armed
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | This is used by MiOS as a way to disable sending notifications when a sensor is tripped/untripped.
 |-
 | style="border: 1px solid #000" | LastTrip
 | style="border: 1px solid #000" | i4
 | style="border: 1px solid #000" | This is the UNIX time when the sensor last reported that it was tripped.
 |}


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" rowspan="2" | Action
 ! style="border: 1px solid #000"               colspan="2" | Arguments
 ! style="border: 1px solid #000"               rowspan="2" | Description
 |-
 ! style="border: 1px solid #000; width: 130px"             | Name
 ! style="border: 1px solid #000; width: 140px"             | Type or Related Variable
 |-
 | style="border: 1px solid #000" rowspan="1" | SetArmed
 | style="border: 1px solid #000" | newArmedValue
 | style="border: 1px solid #000" | Armed
 | style="border: 1px solid #000" rowspan="1" | Arms or disarms the sensor.
 |}


== EnergyMetering1 ==
* '''Service ID''': urn:micasaverde-com:serviceId:EnergyMetering1
* '''File''': S_EnergyMetering1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" | Variable
 ! style="border: 1px solid #000; width:  60px" | Type
 ! style="border: 1px solid #000"               | Description
 |-
 | style="border: 1px solid #000" | Watts
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | If the device can report its wattage, this is the value reported by the device, otherwise this is the value supplied by the user in <tt>UserSupliedWattage</tt>.
 |-
 | style="border: 1px solid #000" | Pulse
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000; text-align: center" | -
 |-
 | style="border: 1px solid #000" | UserSuppliedWattage
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | See <tt>Watts</tt>.
'''Note:''' For thermostats, <tt>UserSuppliedWattage</tt> 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.
 |-
 | style="border: 1px solid #000" | KWH
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000; text-align: center" | -
 |}


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" rowspan="2" | Action
 ! style="border: 1px solid #000"               colspan="2" | Arguments
 ! style="border: 1px solid #000"               rowspan="2" | Description
 |-
 ! style="border: 1px solid #000; width: 130px"             | Name
 ! style="border: 1px solid #000; width: 140px"             | Type or Related Variable
 |-
 | style="border: 1px solid #000" rowspan="1" | ResetKWH
 | style="border: 1px solid #000; text-align: center" colspan="2" | none
 | style="border: 1px solid #000" rowspan="1" | -
 |}


== IrTransmitter1 ==
* '''Service ID''': urn:micasaverde-com:serviceId:IrTransmitter1
* '''File''': S_IrTransmitter1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" rowspan="2" | Action
 ! style="border: 1px solid #000"               colspan="2" | Arguments
 ! style="border: 1px solid #000"               rowspan="2" | Description
 |-
 ! style="border: 1px solid #000; width: 130px"             | Name
 ! style="border: 1px solid #000; width: 140px"             | Type or Related Variable
 |-
 | style="border: 1px solid #000" rowspan="1" | SendProntoCode
 | style="border: 1px solid #000" | ProntoCode
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" rowspan="1" | Sends the given IR code.
 |}


== SerialPort1 ==
* '''Service ID''': urn:micasaverde-org:serviceId:SerialPort1
* '''File''': S_SerialPort1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" | Variable
 ! style="border: 1px solid #000; width:  60px" | Type
 ! style="border: 1px solid #000"               | Description
 |-
 | style="border: 1px solid #000" | path
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | The path of the serial port. On Vera Lite it's <tt>/dev/ttyUSB0</tt>
 |-
 | style="border: 1px solid #000" | baud
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | The baud rate.
 |-
 | style="border: 1px solid #000" | stopbits
 | style="border: 1px solid #000" | ui1
 | style="border: 1px solid #000" | The number of stop bits.
 |-
 | style="border: 1px solid #000" | databits
 | style="border: 1px solid #000" | ui1
 | style="border: 1px solid #000" | The number of data bits.
 |-
 | style="border: 1px solid #000" | parity
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | Can be <tt>odd</tt> or <tt>even</tt>.
 |}


== SceneController1 ==
* '''Service ID''': urn:micasaverde-com:serviceId:SceneController1
* '''File''': S_SceneController1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" | Variable
 ! style="border: 1px solid #000; width:  60px" | Type
 ! style="border: 1px solid #000"               | Description
 |-
 | style="border: 1px solid #000" | sl_SceneActivated
 | style="border: 1px solid #000" | ui2
 | style="border: 1px solid #000" | The number of the activated scene on the scene controller.
 |-
 | style="border: 1px solid #000" | sl_SceneDeactivated
 | style="border: 1px solid #000" | ui2
 | style="border: 1px solid #000" | The number of the deactivated scene on the scene controller.
 |-
 | style="border: 1px solid #000" | Scenes
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | ?
 |-
 | style="border: 1px solid #000" | LastSceneID
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | The scene ID (as reported by the scene controller) of the last activated or deactivated scene.
 |-
 | style="border: 1px solid #000" | LastSceneTime
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" | The UNIX time when the scene was last activated or deactivated.
 |-
 | style="border: 1px solid #000" | ManageLeds
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | If this is "1", automatically turn on/off the scene indicator lights.
 |-
 | style="border: 1px solid #000" | NumButtons
 | style="border: 1px solid #000" | ui1
 | style="border: 1px solid #000" | How many buttons the scene controller has.
 |-
 | style="border: 1px solid #000" | SceneShortcuts
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" | ?
 |-
 | style="border: 1px solid #000" | FiresOffEvents
 | style="border: 1px solid #000" | boolean
 | style="border: 1px solid #000" | ?
 |-
 | style="border: 1px solid #000" | ActivationMethod
 | style="border: 1px solid #000" | ui1
 | style="border: 1px solid #000" | Z-Wave stuff.
 |}


== SceneControllerLED1 ==
* '''Service ID''': urn:micasaverde-com:serviceId:SceneControllerLED1
* '''File''': S_SceneControllerLED1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" | Variable
 ! style="border: 1px solid #000; width:  60px" | Type
 ! style="border: 1px solid #000"               | Description
 |-
 | style="border: 1px solid #000" | LightSettings
 | style="border: 1px solid #000" | ui1
 | style="border: 1px solid #000" | The lights' state. The lower 4 bits of <tt>LightSettings</tt> are the 4 green LEDs, and the upper 4 are the 4 red LEDs. So, 10001 is an orange light, 110010 is an orange light and a red, etc.
 |}


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" rowspan="2" | Action
 ! style="border: 1px solid #000"               colspan="2" | Arguments
 ! style="border: 1px solid #000"               rowspan="2" | Description
 |-
 ! style="border: 1px solid #000; width: 130px"             | Name
 ! style="border: 1px solid #000; width: 140px"             | Type or Related Variable
 |-
 | style="border: 1px solid #000" rowspan="2" | SetLight
 | style="border: 1px solid #000" | newValue
 | style="border: 1px solid #000" | ui4
 | style="border: 1px solid #000" rowspan="2" | Change a light's state.
* <tt>newValue</tt> is the new light state. The valid values are:
** 0 = off
** 1 = green
** 2 = red
** 3 = orange
* <tt>Indicator</tt> is the button number.
 |-
 | style="border: 1px solid #000" | Indicator
 | style="border: 1px solid #000" | ui4
 |}


== IrDevice1 ==
* '''Service ID''': urn:micasaverde-com:serviceId:IrDevice1
* '''File''': S_IrDevice1.xml


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" | Variable
 ! style="border: 1px solid #000; width:  60px" | Type
 ! style="border: 1px solid #000"               | Description
 |-
 | style="border: 1px solid #000" | Codesets
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" |
 |-
 | style="border: 1px solid #000" | Codeset
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" |
 |-
 | style="border: 1px solid #000" | Remote
 | style="border: 1px solid #000" | int
 | style="border: 1px solid #000" |
 |-
 | style="border: 1px solid #000" | Scene
 | style="border: 1px solid #000" | string
 | style="border: 1px solid #000" |
 |}


{| style="border: 1px solid #000; border-collapse: collapse"
 ! style="border: 1px solid #000; width: 150px" rowspan="2" | Action
 ! style="border: 1px solid #000"               colspan="2" | Arguments
 ! style="border: 1px solid #000"               rowspan="2" | Description
 |-
 ! style="border: 1px solid #000; width: 130px"             | Name
 ! style="border: 1px solid #000; width: 140px"             | Type or Related Variable
 |-
 | style="border: 1px solid #000" rowspan="3" | SendCode
 | style="border: 1px solid #000" | Codeset
 | style="border: 1px solid #000" | Codeset
 | style="border: 1px solid #000" rowspan="3" |
 |-
 | style="border: 1px solid #000" | Button
 | style="border: 1px solid #000" | Remote
 |-
 | style="border: 1px solid #000" | Repeat
 | style="border: 1px solid #000" | Remote
 |}