Luup UPnP Variables and Actions
(→ZWaveNetwork1) |
|||
Line 1: | Line 1: | ||
− | + | == 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" | Related variable/type | |
− | + | |- | |
− | + | | 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" | ui4 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" | ui4 | |
− | + | | 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" | ui4 | |
− | + | | 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" | ui4 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="10" | CreateDevice | |
− | + | | style="border: 1px solid #000" | deviceType | |
− | + | | style="border: 1px solid #000" | string | |
− | + | | style="border: 1px solid #000" rowspan="10" | 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>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>... | |
− | + | |- | |
− | + | | 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" | DeviceNumParent | |
− | + | | style="border: 1px solid #000" | ui4 | |
− | + | |- | |
− | + | | style="border: 1px solid #000" | RoomNum | |
− | + | | style="border: 1px solid #000" | ui4 | |
− | + | |- | |
− | + | | style="border: 1px solid #000" | StateVariables | |
− | + | | style="border: 1px solid #000" | string | |
− | + | |- | |
− | + | | style="border: 1px solid #000" rowspan="2" | DeleteDevice | |
− | + | | style="border: 1px solid #000" | DeviceNum | |
− | + | | style="border: 1px solid #000" | ui4 | |
− | + | | 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" | ui4 | |
− | + | | 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" | ui4 | |
− | + | |- | |
− | + | | 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" | ui4 | |
− | + | | 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" | ui4 | |
− | + | | 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 | |
− | + | |} | |
− | + | ||
− | + | == 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 process | |
− | + | * -1 = Device waiting to be configured | |
− | + | * 0 = Device not configured | |
− | + | * 1 = Device successfully configured | |
− | + | * 2 = Device partially configured | |
− | + | |- | |
− | + | | style="border: 1px solid #000" | PollingEnabled | |
− | + | | style="border: 1px solid #000" | boolean | |
− | + | | style="border: 1px solid #000" | This is ''1'' if polling is enabled for this device, meaning that MiOS can automatically poll the device for its status. | |
− | + | |- | |
− | + | | style="border: 1px solid #000" | PollMinDelay | |
− | + | | style="border: 1px solid #000" | ui1 | |
− | + | | style="border: 1px solid #000" | The minimum interval for polling. MiOS won't poll this device more often that this interval. | |
− | + | |- | |
− | + | | 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; 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" | Related variable/type | |
− | + | |- | |
− | + | | 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.). | |
− | + | |- | |
− | + | | style="border: 1px solid #000" rowspan="2" | SetPollFrequency | |
− | + | | style="border: 1px solid #000" | PollingEnabled | |
− | + | | style="border: 1px solid #000" | PollingEnabled | |
− | + | | style="border: 1px solid #000" rowspan="2" | Sets the <tt>PollMinDelay</tt> variable. | |
− | + | |- | |
− | + | | style="border: 1px solid #000" | PollMinDelay | |
− | + | | style="border: 1px solid #000" | PollMinDelay | |
− | + | |} | |
− | + | ||
− | + | ||
− | + | == 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" | boolean | |
− | + | | 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" | boolean | |
− | + | | style="border: 1px solid #000" | The UNIX time of the last Z-Wave dongle backup. | |
− | + | |- | |
− | + | | 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" | 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" | | |
− | + | |- | |
− | + | | style="border: 1px solid #000" | PollDelayInitial | |
− | + | | style="border: 1px solid #000" | ui1 | |
− | + | | style="border: 1px solid #000" | | |
− | + | |- | |
− | + | | style="border: 1px solid #000" | PollDelayDeadTime | |
− | + | | style="border: 1px solid #000" | ui1 | |
− | + | | style="border: 1px solid #000" | | |
− | + | |- | |
− | + | | style="border: 1px solid #000" | PollMinDelay | |
− | + | | style="border: 1px solid #000" | ui1 | |
− | + | | style="border: 1px solid #000" | | |
− | + | |- | |
− | + | | style="border: 1px solid #000" | PollFrequency | |
− | + | | style="border: 1px solid #000" | ui1 | |
− | + | | 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" | Related variable/type | |
− | + | |- | |
− | + | | 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" 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. | |
− | + | |} | |
− | + | ||
− | + | == InsteonNetwork1 == | |
− | + | * '''Service ID''': urn:micasaverde-com:serviceId:InsteonNetwork1 | |
− | + | * '''File''': S_InsteonNetwork1.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" | Node | |
− | + | | 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" | Related variable/type | |
− | + | |- | |
− | + | | style="border: 1px solid #000" rowspan="1" | ResetNetwork | |
− | + | | style="border: 1px solid #000; text-align: center" colspan="2" | none | |
− | + | | style="border: 1px solid #000" rowspan="1" | | |
− | + | |- | |
− | + | | style="border: 1px solid #000" rowspan="1" | RemoveNodes | |
− | + | | style="border: 1px solid #000; text-align: center" colspan="2" | none | |
− | + | | style="border: 1px solid #000" rowspan="1" | | |
− | + | |- | |
− | + | | style="border: 1px solid #000" rowspan="1" | AddNodes | |
− | + | | style="border: 1px solid #000; text-align: center" colspan="2" | none | |
− | + | | style="border: 1px solid #000" rowspan="1" | | |
− | + | |- | |
− | + | | style="border: 1px solid #000" rowspan="1" | StopAddRemoveNodes | |
− | + | | style="border: 1px solid #000; text-align: center" colspan="2" | none | |
− | + | | style="border: 1px solid #000" rowspan="1" | | |
− | + | |- | |
− | + | | style="border: 1px solid #000" rowspan="2" | SendData | |
− | + | | style="border: 1px solid #000" | Node | |
− | + | | style="border: 1px solid #000" | Node | |
− | + | | style="border: 1px solid #000" rowspan="2" | | |
− | + | |- | |
− | + | | style="border: 1px solid #000" | Data | |
− | + | | style="border: 1px solid #000" | Node | |
− | + | |} | |
− | + | ||
− | + | ||
− | + | == 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: | 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>. | The <tt>URL</tt> is the streaming URL compatible with the players specified in <tt>Info</tt>. | ||
− | + | ||
− | + | Currently only the <tt>protocol</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>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" | 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. | |
− | + | |} | |
− | + | ||
− | + | == 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" | Related variable/type | |
− | + | |- | |
− | + | | style="border: 1px solid #000" rowspan="1" | MoveLeft | |
− | + | | style="border: 1px solid #000; text-align: center" colspan="2" | none | |
− | + | | style="border: 1px solid #000" 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" 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" 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" 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" 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" 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" | | |
− | < | + | |} |
− | < | + | |
− | </ | + | |
− | < | + | == 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 (desired) 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" | Related variable/type | ||
+ | |- | ||
+ | | 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 desired 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" | Related variable/type | ||
+ | |- | ||
+ | | style="border: 1px solid #000" rowspan="1" | Up | ||
+ | | style="border: 1px solid #000; text-align: center" colspan="2" | none | ||
+ | | style="border: 1px solid #000" 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" 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" 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 (desired) 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" | Related variable/type | ||
+ | |- | ||
+ | | 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. | ||
+ | |- | ||
+ | | style="border: 1px solid #000" | sl_UserCode | ||
+ | | style="border: 1px solid #000" | string | ||
+ | | style="border: 1px solid #000" | The index number of the last PIN code entered by the user. | ||
+ | |- | ||
+ | | 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" | int | ||
+ | | 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" | string | ||
+ | | 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" | string | ||
+ | | 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" | Related variable/type | ||
+ | |- | ||
+ | | 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="2" | SetPin | ||
+ | | style="border: 1px solid #000" | UserCodeName | ||
+ | | style="border: 1px solid #000" | sl_UserCode | ||
+ | | style="border: 1px solid #000" rowspan="2" | Adds a PIN code. This code will be added to the <tt>PinCodes</tt> variable and to the door lock. | ||
+ | * <tt>UserCodeName</tt> is the PIN code name. | ||
+ | * <tt>newPin</tt> is the new PIN code. | ||
+ | |- | ||
+ | | style="border: 1px solid #000" | newPin | ||
+ | | style="border: 1px solid #000" | sl_UserCode | ||
+ | |- | ||
+ | | 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 '''index''' number. The starting index is 1. | ||
+ | * <tt>StartDate</tt> and <tt>StopDate</tt> are strings representing the dates, formatted like this: <tt>year-month-day hour:minute</tt> | ||
+ | * <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+14:00&StopDate=2012-09-03+15: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 '''index''' number. The starting index 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 '''index''' number. The starting index is 1. | ||
+ | * <tt>slotID</tt> is the slot number. The starting index 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 at index <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 ''Normal'' or ''EnergySavingsMode''. | ||
+ | |- | ||
+ | | 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; 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" | Related variable/type | ||
+ | |- | ||
+ | | 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" | Related variable/type | ||
+ | |- | ||
+ | | 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_Heat / urn:upnp-org:serviceId:TemperatureSetpoint1_Cool | ||
+ | * '''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. | ||
+ | |- | ||
+ | | style="border: 1px solid #000" | CurrentSetpoint | ||
+ | | style="border: 1px solid #000" | i4 | ||
+ | | style="border: 1px solid #000" | The actual temperature setpoint. | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| 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" | Related variable/type | ||
+ | |- | ||
+ | | 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" | | ||
+ | |} | ||
+ | |||
+ | == 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" | | ||
+ | |} | ||
+ | |||
+ | |||
+ | == 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" | | ||
+ | |} | ||
+ | |||
+ | |||
+ | == 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" | | ||
+ | |} | ||
+ | |||
+ | |||
+ | == 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" | | ||
+ | |- | ||
+ | | 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" | Related variable/type | ||
+ | |- | ||
+ | | 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" | | ||
+ | |- | ||
+ | | style="border: 1px solid #000" | UserSuppliedWattage | ||
+ | | style="border: 1px solid #000" | ui4 | ||
+ | | style="border: 1px solid #000" | See <tt>Watts</tt>. | ||
+ | |- | ||
+ | | style="border: 1px solid #000" | KWH | ||
+ | | style="border: 1px solid #000" | ui4 | ||
+ | | 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" | Related variable/type | ||
+ | |- | ||
+ | | 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" | Related variable/type | ||
+ | |- | ||
+ | | 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" | | ||
+ | |- | ||
+ | | style="border: 1px solid #000" | stopbits | ||
+ | | style="border: 1px solid #000" | ui1 | ||
+ | | style="border: 1px solid #000" | | ||
+ | |- | ||
+ | | style="border: 1px solid #000" | databits | ||
+ | | style="border: 1px solid #000" | ui1 | ||
+ | | style="border: 1px solid #000" | | ||
+ | |- | ||
+ | | 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" | | ||
+ | |- | ||
+ | | style="border: 1px solid #000" | sl_SceneDeactivated | ||
+ | | style="border: 1px solid #000" | ui2 | ||
+ | | style="border: 1px solid #000" | | ||
+ | |- | ||
+ | | style="border: 1px solid #000" | Scenes | ||
+ | | style="border: 1px solid #000" | string | ||
+ | | style="border: 1px solid #000" | | ||
+ | |} | ||
+ | |||
+ | |||
+ | == 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" | Light | ||
+ | | style="border: 1px solid #000" | ui1 | ||
+ | | 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" | Related variable/type | ||
+ | |- | ||
+ | | style="border: 1px solid #000" rowspan="2" | SetLight | ||
+ | | style="border: 1px solid #000" | newValue | ||
+ | | style="border: 1px solid #000" | Light | ||
+ | | style="border: 1px solid #000" rowspan="2" | | ||
+ | |- | ||
+ | | style="border: 1px solid #000" | Indicator | ||
+ | | style="border: 1px solid #000" | Light | ||
+ | |} | ||
+ | |||
+ | |||
+ | == 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" | Related variable/type | |
− | + | |- | |
− | + | | 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 | |
− | + | |} | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + |
Revision as of 15:03, 4 September 2012
HomeAutomationGateway1
- Service ID: urn:micasaverde-com:serviceId:HomeAutomationGateway1
- File: S_HomeAutomationGateway1.xml
Variable | Type | Description |
---|---|---|
DataVersion | ui4 | A number that increases each time the data changes. |
UDN | string | The Unique Device Name of the UPnP device. |
Action | Arguments | Description | |
---|---|---|---|
Name | Related variable/type | ||
Reload | none | Reload the LuaUPnP engine. | |
ModifyUserData | inUserData | UserData | Make changes to the UserData.
For more information read the ModifyUserData page. |
DataFormat | string | ||
Reload | boolean | ||
SetVariable | DeviceNum | ui4 or string | Create or change the value of a variable.
|
Service | string | ||
Variable | string | ||
Value | string | ||
RunScene | SceneNum | ui4 | Run the given scene. |
SceneOff | SceneNum | ui4 | Turn off all the devices from DEVICE_CATEGORY_DIMMABLE_LIGHT and DEVICE_CATEGORY_SWITCH from the given scene. |
RunLua | DeviceNum | ui4 or string | Run the given Lua code. If DeviceNum is specified, the code is run using that device's interface. |
Code | string | ||
CreateDevice | deviceType | string | Create a device using the given parameters.
|
internalID | string | ||
Description | string | ||
UpnpDevFilename | string | ||
UpnpImplFilename | string | ||
IpAddress | string | ||
MacAddress | string | ||
DeviceNumParent | ui4 | ||
RoomNum | ui4 | ||
StateVariables | string | ||
DeleteDevice | DeviceNum | ui4 | Delete the device given either through its number, or through its UDN. |
UDN | string | ||
CreatePlugin | PluginNum | ui4 | Create a plugin with the PluginNum number and Version version. StateVariables are the variables that will be set when the device is created. For more information look at the description of the CreateDevice action above. |
Version | ui4 | ||
StateVariables | string | ||
DeletePlugin | PluginNum | ui4 | Uninstall the given plugin. |
CreatePluginDevice | PluginNum | ui4 | Creates a device for plugin #PluginNum. |
StateVariables | string | ||
ImportUpnpDevice | UDN | UDN | |
RoomNum | DeviceNum | ||
LogIpRequest | IpAddress | UDN | |
MacAddress | UDN |
HaDevice1
- Service ID: urn:micasaverde-com:serviceId:HaDevice1
- File: S_HaDevice1.xml
Variable | Type | Description |
---|---|---|
CommFailure | boolean | This is set to 1 if we've lost communication with the device. |
Configured | boolean | The configuration state of the device:
|
PollingEnabled | boolean | This is 1 if polling is enabled for this device, meaning that MiOS can automatically poll the device for its status. |
PollMinDelay | ui1 | The minimum interval for polling. MiOS won't poll this device more often that this interval. |
BatteryLevel | i1 | The battery level reported by the device. |
Action | Arguments | Description | |
---|---|---|---|
Name | Related variable/type | ||
Reconfigure | none | Reconfigure the device. | |
StressTest | none | Stress test the Z-Wave device. | |
Remove | none | Remove the device from the Z-Wave network. | |
Poll | none | Poll the device. | |
ToggleState | none | 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.). | |
SetPollFrequency | PollingEnabled | PollingEnabled | Sets the PollMinDelay variable. |
PollMinDelay | PollMinDelay |
ZWaveNetwork1
- Service ID: urn:micasaverde-com:serviceId:ZWaveNetwork1
- File: S_ZWaveNetwork1.xml
Variable | Type | Description |
---|---|---|
NetStatusID | ui1 | The status of the Z-Wave network:
|
NetStatusText | string | Full Z-Wave network status description |
LastError | string | The last Z-Wave error in the network |
LastUpdate | boolean | The UNIX time when the Z-Wave component of the LuaUPnP engine started. |
LastDongleBackup | boolean | The UNIX time of the last Z-Wave dongle backup. |
VersionInfo | boolean | The Z-Wave version. |
HomeID | boolean | The unique ID of the Z-Wave network. |
Role | boolean | Z-Wave specific stuff. |
ComPort | string | This is the port where MiOS will search for the Z-Wave dongle. On Vera Lite, this is /dev/ttyS0. |
LockComPort | boolean | 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 ComPort. |
Use45 | boolean | If this is "1", use Z-Wave version 3.20 instead of 2.78. |
UseMR | boolean | If this is "1", use MiOS routing. |
LimitNeighbors | boolean | With MiOS routing: if this is "1", when the routing table is created, consider only Z-Wave's neighbors as valid options. |
PollingEnabled | boolean | |
PollDelayInitial | ui1 | |
PollDelayDeadTime | ui1 | |
PollMinDelay | ui1 | |
PollFrequency | ui1 |
Action | Arguments | Description | |
---|---|---|---|
Name | Related variable/type | ||
ResetNetwork | ResetMode | string | Reset the Z-Wave network.
|
HomeID | string | ||
ZeroMemory | boolean | ||
PutByte | StartAddress | string | Used to convert Z-Wave from 2.78 to 3.20 in which case the StartAddress parameter must be "convert502_452" and the rest are ignored. |
StopAddress | string | ||
Value | ui4 | ||
ReconfigureAllNodes | FailedOnly | boolean | Reconfigure the Z-Wave nodes. If FailedOnly is "1", only the devices that failed to configure are reconfigured. |
UpdateNetwork | none | Get network update from SUC/SIS. | |
UpdateNeighbors | Device | ui4 | Update the neighbor nodes of the given device. Device is the device number. |
BackupDongle | Restore | boolean | Backs up the Z-Wave network. The backup is in /etc/cmh/dongle.dump. If Restore is "1", the Z-Wave network is restored from the backup. |
PollAllNodes | none | * | |
RemoveNodes | InclusionMode | string | Puts Vera in exclude mode.
|
NodeType | ui1 | ||
Timeout | ui1 | ||
Multiple | boolean | ||
Reload | boolean | ||
AddNodes | InclusionMode | string | Puts Vera in include mode.
|
NodeType | ui1 | ||
Timeout | ui1 | ||
Multiple | boolean | ||
ControllerShift | boolean | ||
Reload | boolean | ||
DownloadNetwork | none | Copy the Z-Wave network from a master controller. | |
HealNetwork | BatteryMinutes | ui1 | Heals/consolidates the Z-Wave network.
|
Node | ui1 | ||
StressCycles | ui1 | ||
Configure | boolean | ||
ManualRoute | boolean | ||
StartStage | ui1 | ||
StopStage | ui1 | ||
SetPolling | IsTemporary | boolean | Set the polling parameters.
|
PollingEnabled | PollingEnabled | ||
PollDelayInitial | PollDelayInitial | ||
PollDelayDeadTime | PollDelayDeadTime | ||
PollMinDelay | PollMinDelay | ||
PollFrequency | PollFrequency | ||
SendData | Node | ui1 | Sends the Z-Wave Data to the Z-Wave Node. |
Data | string | ||
SimulateIncomingData | Data | string | Calls the Z-Wave message handler for the given data. |
InsteonNetwork1
- Service ID: urn:micasaverde-com:serviceId:InsteonNetwork1
- File: S_InsteonNetwork1.xml
Variable | Type | Description |
---|---|---|
Node | string |
Action | Arguments | Description | |
---|---|---|---|
Name | Related variable/type | ||
ResetNetwork | none | ||
RemoveNodes | none | ||
AddNodes | none | ||
StopAddRemoveNodes | none | ||
SendData | Node | Node | |
Data | Node |
USBUIRT1
- Service ID: urn:micasaverde-com:serviceId:USBUIRT1
- File: S_USBUIRT.xml
Variable | Type | Description |
---|---|---|
ComPort | string | The path of the USB port the UIRT is connected to. On Vera Lite this is /dev/ttyUSB0 |
Camera1
- Service ID: urn:micasaverde-com:serviceId:Camera1
- File: S_Camera1.xml
Variable | Type | Description |
---|---|---|
VideoURLs | string | This variable defines the streaming parameters, and without it streaming doesn't work. This variable has this structure:
Info1:URL1:Info2:URL2:
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.
Currently only the protocol, players and URL parameters are used. The rest of the parameters are ignored.
rtsp,0,mpeg4,,m,640,480,qai:img/media.sav:http,0,mjpeg,,m,640,480,w:img/video.mjpeg: |
URL | string | This is the URL to get a snapshot from the camera. |
RelatedSensors | string | Comma separated list of device numbers: archive a photo whenever one of the sensors is tripped. |
SensorArchiveSeconds | ui4 | How many seconds to archive the video after the sensor(s) are tripped. |
RelatedLights | string | Comma separated list of device numbers: which lights should be turned on when viewing this camera. |
LightOptions | string | When to turn on the lights:
So VSBA means do them all. |
AutoArchiveSeconds | ui4 | Archives a picture from the camera every this number of seconds. |
AutoArchivePreserveDays | ui4 | How many days to keep the pictures in the archive. |
PanTiltZoom1
- Service ID: urn:micasaverde-com:serviceId:PanTiltZoom1
- File: S_PanTiltZoom1.xml
Action | Arguments | Description | |
---|---|---|---|
Name | Related variable/type | ||
MoveLeft | none | ||
MoveRight | none | ||
MoveUp | none | ||
MoveDown | none | ||
ZoomIn | none | ||
ZoomOut | none | ||
GoToPreset | presetNumber | ui1 |
SwitchPower1
- Service ID: urn:upnp-org:serviceId:SwitchPower1
- File: S_SwitchPower1.xml
Variable | Type | Description |
---|---|---|
Target | boolean | The target (desired) state of the device. |
Status | boolean | The current state of the device. |
Action | Arguments | Description | |
---|---|---|---|
Name | Related variable/type | ||
SetTarget | newTargetValue | Target | Sets the desired state of the device. Used to turn a device On or Off. |
WindowCovering1
- Service ID: urn:upnp-org:serviceId:WindowCovering1
- File: S_WindowCovering1.xml
Action | Arguments | Description | |
---|---|---|---|
Name | Related variable/type | ||
Up | none | ||
Down | none | ||
Stop | none |
Dimming1
- Service ID: urn:upnp-org:serviceId:Dimming1
- File: S_Dimming1.xml
Variable | Type | Description |
---|---|---|
LoadLevelTarget | ui1 | The target (desired) dimming value; it doesn't represent the actual dimming state. |
LoadLevelStatus | ui1 | Represents the actual dimming state. |
Action | Arguments | Description | |
---|---|---|---|
Name | Related variable/type | ||
SetLoadLevelTarget | newLoadlevelTarget | LoadLevelTarget | 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
Variable | Type | Description |
---|---|---|
Target | boolean | Represents the target (desired) door state. |
Status | boolean | Represents the current door state. "1" = locked, "0" = unlocked |
PinCodes | string | The list of PIN codes. |
sl_UserCode | string | The index number of the last PIN code entered by the user. |
sl_PinFailed | boolean | This becomes "1" when a bad PIN code is entered. |
sl_CodeChanged | int | If a PIN code was changed using the lock keypad, this contains the PIN code index number. |
sl_LockButton | boolean | This is "1" if the Lock button has been pressed on the lock keypad. |
sl_LockFailure | boolean | This is "1" if the lock fails to operate. |
sl_UnauthUser | string | This is "1" if the user code was entered outside of a valid date. |
sl_LockChanged | string | If a PIN code was changed using the lock keypad, this contains the PIN code index number. |
sl_LowBattery | boolean | This is "1" when the battery level is low. |
sl_VeryLowBattery | boolean | This is "1" when the battery level is very low. |
Action | Arguments | Description | |
---|---|---|---|
Name | Related variable/type | ||
SetTarget | newTargetValue | Target | Sets the target (desired) state of the door. Used to lock and unlock the door. |
SetPin | UserCodeName | sl_UserCode | Adds a PIN code. This code will be added to the PinCodes variable and to the door lock.
|
newPin | sl_UserCode | ||
SetPinValidityDate | UserCode | ui1 | Sets the daily time interval in which a PIN code is valid.
|
StartDate | string | ||
StopDate | string | ||
Replace | boolean | ||
SetPinValidityWeekly | UserCode | ui1 | Sets the weekly time interval in which a PIN code is valid.
Example: 1367 means Monday, Wednesday, Saturday and Sunday.
|
DayOfWeek | ui4 | ||
StartHour | ui1 | ||
StartMinute | ui1 | ||
StopHour | ui1 | ||
StopMinute | ui1 | ||
Replace | boolean | ||
ClearPinValidity | UserCode | ui4 | Clears the given restriction slot.
|
slotID | ui4 | ||
ClearPin | UserCode | ui1 | Removes the PIN code at index UserCode. |
HVAC_UserOperatingMode1
- Service ID: urn:upnp-org:serviceId:HVAC_UserOperatingMode1
- File: S_HVAC_UserOperatingMode1.xml
Variable | Type | Description |
---|---|---|
ModeTarget | string | The desired operating mode of the HVAC. Currently MiOS supports only:
|
ModeStatus | string | The actual operating mode of the HVAC. |
EnergyModeTarget | string | The desired energy mode. Can be Normal or EnergySavingsMode. |
EnergyModeStatus | string | The actual energy mode. |
Action | Arguments | Description | |
---|---|---|---|
Name | Related variable/type | ||
SetModeTarget | NewModeTarget | ModeTarget | Sets the desired HVAC operating mode. |
SetEnergyModeTarget | NewModeTarget | EnergyModeTarget | Sets the desired energy mode. |
HVAC_OperatingState1
- Service ID: urn:micasaverde-com:serviceId:HVAC_OperatingState1
- File: S_HVAC_OperatingState1.xml
Variable | Type | Description |
---|---|---|
ModeState | string | Represents what the HVAC is actually doing right now. The most common actions are:
|
HVAC_FanOperatingMode1
- Service ID: urn:upnp-org:serviceId:HVAC_FanOperatingMode1
- File: S_HVAC_FanOperatingMode1.xml
Variable | Type | Description |
---|---|---|
Mode | string | The fan operation mode. Can be:
|
FanStatus | string | Represents the current fan state; can be On or Off. |
Action | Arguments | Description | |
---|---|---|---|
Name | Related variable/type | ||
SetMode | NewMode | Mode | Sets the fan operating mode. Changes the Mode variable. |
TemperatureSetpoint1
- Service ID: urn:upnp-org:serviceId:TemperatureSetpoint1_Heat / urn:upnp-org:serviceId:TemperatureSetpoint1_Cool
- File: S_TemperatureSetpoint1.xml
Variable | Type | Description |
---|---|---|
SetpointTarget | i4 | The target temperature setpoint. |
CurrentSetpoint | i4 | The actual temperature setpoint. |
Action | Arguments | Description | |
---|---|---|---|
Name | Related variable/type | ||
SetCurrentSetpoint | NewCurrentSetpoint | CurrentSetpoint | Sets the target setpoint. |
TemperatureSensor1
- Service ID: urn:upnp-org:serviceId:TemperatureSensor1
- File: S_TemperatureSensor1.xml
Variable | Type | Description |
---|---|---|
CurrentTemperature | i4 |
GenericSensor1
- Service ID: urn:micasaverde-com:serviceId:GenericSensor1
- File: S_GenericSensor1.xml
Variable | Type | Description |
---|---|---|
CurrentLevel | i4 |
LightSensor1
- Service ID: urn:micasaverde-com:serviceId:LightSensor1
- File: S_LightSensor1.xml
Variable | Type | Description |
---|---|---|
CurrentLevel | i4 |
HumiditySensor1
- Service ID: urn:micasaverde-com:serviceId:HumiditySensor1
- File: S_HumiditySensor1.xml
Variable | Type | Description |
---|---|---|
CurrentLevel | i4 |
SecuritySensor1
- Service ID: urn:micasaverde-com:serviceId:SecuritySensor1
- File: S_SecuritySensor1.xml
Variable | Type | Description |
---|---|---|
Tripped | boolean | |
Armed | boolean | This is used by MiOS as a way to disable sending notifications when a sensor is tripped/untripped. |
LastTrip | i4 | This is the UNIX time when the sensor last reported that it was tripped. |
Action | Arguments | Description | |
---|---|---|---|
Name | Related variable/type | ||
SetArmed | newArmedValue | Armed | Arms or disarms the sensor. |
EnergyMetering1
- Service ID: urn:micasaverde-com:serviceId:EnergyMetering1
- File: S_EnergyMetering1.xml
Variable | Type | Description |
---|---|---|
Watts | ui4 | 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 UserSupliedWattage. |
Pulse | ui4 | |
UserSuppliedWattage | ui4 | See Watts. |
KWH | ui4 |
Action | Arguments | Description | |
---|---|---|---|
Name | Related variable/type | ||
ResetKWH | none |
IrTransmitter1
- Service ID: urn:micasaverde-com:serviceId:IrTransmitter1
- File: S_IrTransmitter1.xml
Action | Arguments | Description | |
---|---|---|---|
Name | Related variable/type | ||
SendProntoCode | ProntoCode | string | Sends the given IR code. |
SerialPort1
- Service ID: urn:micasaverde-org:serviceId:SerialPort1
- File: S_SerialPort1.xml
Variable | Type | Description |
---|---|---|
path | string | The path of the serial port. On Vera Lite it's /dev/ttyUSB0 |
baud | ui4 | |
stopbits | ui1 | |
databits | ui1 | |
parity | string | Can be odd or even. |
SceneController1
- Service ID: urn:micasaverde-com:serviceId:SceneController1
- File: S_SceneController1.xml
Variable | Type | Description |
---|---|---|
sl_SceneActivated | ui2 | |
sl_SceneDeactivated | ui2 | |
Scenes | string |
SceneControllerLED1
- Service ID: urn:micasaverde-com:serviceId:SceneControllerLED1
- File: S_SceneControllerLED1.xml
Variable | Type | Description |
---|---|---|
Light | ui1 |
Action | Arguments | Description | |
---|---|---|---|
Name | Related variable/type | ||
SetLight | newValue | Light | |
Indicator | Light |
IrDevice1
- Service ID: urn:micasaverde-com:serviceId:IrDevice1
- File: S_IrDevice1.xml
Variable | Type | Description |
---|---|---|
Codesets | string | |
Codeset | string | |
Remote | int | |
Scene | string |
Action | Arguments | Description | |
---|---|---|---|
Name | Related variable/type | ||
SendCode | Codeset | Codeset | |
Button | Remote | ||
Repeat | Remote |