Luup UPnP Variables and Actions

From MiOS
(Difference between revisions)
Jump to: navigation, search
m (→‎USBUIRT1)
(→‎Camera1)
Line 553: Line 553:
 
  ! style="border: 1px solid #000; width:  60px" | Type
 
  ! style="border: 1px solid #000; width:  60px" | Type
 
  ! style="border: 1px solid #000"              | Description
 
  ! style="border: 1px solid #000"              | Description
−
|-
 
−
| style="border: 1px solid #000" | UseCMS
 
−
| style="border: 1px solid #000" | boolean
 
−
| style="border: 1px solid #000" |
 
 
  |-
 
  |-
 
  | style="border: 1px solid #000" | VideoURLs
 
  | style="border: 1px solid #000" | VideoURLs
 
  | style="border: 1px solid #000" | string
 
  | style="border: 1px solid #000" | string
−
  | style="border: 1px solid #000" |
+
  | style="border: 1px solid #000" | This variable defines the streaming parameters, and without it streaming doesn't work. This variable has this structure:
 +
<tt>Info1:URL1:Info2:URL2:</tt>
 +
 
 +
 
 +
The <tt>Info</tt> parameters are:
 +
 
 +
1. The protocol: can be <tt>rtsp</tt> or <tt>http</tt>
 +
 
 +
2. HTTP authentication required: 1 = yes, send the username and password in the request, 0 = no, don't send the username and password
 +
 
 +
3. Video codec: <tt>mpeg4</tt> | <tt>mjpeg</tt> | etc.
 +
 
 +
4. Audio codec: blank = no audio
 +
 
 +
5. Resolution: <tt>t</tt> = thumbnail, <tt>s</tt> = small, <tt>m</tt> = medium, <tt>l</tt> = large
 +
 
 +
6. Width: 640
 +
 
 +
7. Height: 480
 +
 
 +
8. Players: <tt>q</tt>|<tt>a</tt>|<tt>i</tt>|<tt>w</tt>, a string of characters indicating known good players. <tt>q</tt> = Quicktime plugin, <tt>a</tt> = Android, <tt>i</tt> = iPhone, <tt>w</tt> = normal web browser.
 +
 
 +
 
 +
The <tt>URL</tt> is the streaming URL compatible with the players specified in <tt>Info</tt>.
 +
 
 +
Currently only the <tt>protocol</tt>, <tt>players</tt> and <tt>URL</tt> parameters are used. The rest of the parameters are ignored.
 +
 
 +
 
 +
<tt>VideoURLs</tt> example for VistaCam:
 +
 
 +
<tt>rtsp,0,mpeg4,,m,640,480,qai:img/media.sav:http,0,mjpeg,,m,640,480,w:img/video.mjpeg:</tt>
 
  |-
 
  |-
 
  | style="border: 1px solid #000" | URL
 
  | style="border: 1px solid #000" | URL
 
  | style="border: 1px solid #000" | string
 
  | style="border: 1px solid #000" | string
−
  | style="border: 1px solid #000" |
+
  | style="border: 1px solid #000" | This is the URL to get a snapshot from the camera.
−
|-
+
−
| style="border: 1px solid #000" | DirectStreamingURL
+
−
| style="border: 1px solid #000" | string
+
−
| style="border: 1px solid #000" |
+
 
  |-
 
  |-
 
  | style="border: 1px solid #000" | RelatedSensors
 
  | style="border: 1px solid #000" | RelatedSensors
 
  | style="border: 1px solid #000" | string
 
  | style="border: 1px solid #000" | string
−
  | style="border: 1px solid #000" |
+
  | 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" | SensorArchiveSeconds
 
  | style="border: 1px solid #000" | ui4
 
  | style="border: 1px solid #000" | ui4
−
  | style="border: 1px solid #000" |
+
  | 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" | RelatedLights
 
  | style="border: 1px solid #000" | string
 
  | style="border: 1px solid #000" | string
−
  | style="border: 1px solid #000" |
+
  | 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" | LightOptions
 
  | style="border: 1px solid #000" | string
 
  | style="border: 1px solid #000" | string
−
  | style="border: 1px solid #000" |
+
  | 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" | AutoArchiveSeconds
 
  | style="border: 1px solid #000" | ui4
 
  | style="border: 1px solid #000" | ui4
−
  | style="border: 1px solid #000" |
+
  | 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" | AutoArchivePreserveDays
 
  | style="border: 1px solid #000" | ui4
 
  | style="border: 1px solid #000" | ui4
−
  | style="border: 1px solid #000" |
+
  | style="border: 1px solid #000" | How many days to keep the pictures in the archive.
 
  |}
 
  |}
−
 
  
 
== PanTiltZoom1 ==
 
== PanTiltZoom1 ==

Revision as of 15:20, 3 September 2012

Contents

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.
  • inUserData is the new UserData object which will be added to the UserData or will replace an existent UserData object.
  • DataFormat must be json.
  • If Reload is 1 the LuaUPnP engine will reload after the UserData is modified.

For more information read the ModifyUserData page.

DataFormat string
Reload boolean
SetVariable DeviceNum ui4 or string Create or change the value of a variable.
  • DeviceNum can be an UDN or a number.
  • Service is the service ID of the variable.
  • Variable is the variable name.
  • Value is the new variable value.
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.
  • deviceType is the UPnP device type.
  • internalID is the specific ID (also known as altid) of the device; for example, for Z-Wave devices this is the Node ID, and for Insteon device it is the Insteon ID.
  • Description is the device name, which is shown to the user on the dashboard.
  • UpnpDevFilename is the UPnP device description file name.
  • UpnpImplFilename is the implementation file to use.
  • If the device is IP based, IpAddress is the IP address and port of the device.
  • If this should be the child of another device, DeviceNumParent is the device number of the parent device.
  • RoomNum is the number of the room the device will be in.
  • StateVariables is a string containing the variables you want set when the device is created. You can specify multiple variables by separating them with a line feed ('\n'), and use ',' and '=' to separate service, variable and value, like this: service,variable=value\nservice,variable=value\n...
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:
  • -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
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
NetStatusText string
ActiveScenes string
LastError string
ResetMode string
InclusionMode string
NodeType string
Timeout ui1
Multiple boolean
Node ui1
Device ui4
PollingEnabled boolean
PollDelayInitial ui1
PollDelayDeadTime ui1
PollMinDelay ui1
PollFrequency ui1
Reload boolean


Action Arguments Description
Name Related variable/type
ResetNetwork ResetMode ResetMode
HomeID NetStatusText
ZeroMemory Multiple
PutByte StartAddress NetStatusText
StopAddress NetStatusText
Value NetStatusText
ReconfigureAllNodes FailedOnly Multiple
UpdateNetwork none
UpdateNeighbors Device Device
BackupDongle Restore PollingEnabled
PollAllNodes none
RemoveNodes InclusionMode InclusionMode
NodeType NodeType
Timeout Timeout
Multiple Multiple
Reload Reload
AddNodes InclusionMode InclusionMode
NodeType NodeType
Timeout Timeout
Multiple Multiple
ControllerShift Multiple
Reload Reload
DownloadNetwork none
HealNetwork BatteryMinutes Timeout
Node Node
StressCycles Timeout
Configure Multiple
ManualRoute Multiple
StartStage Timeout
StopStage Timeout
SetPolling IsTemporary Multiple
PollingEnabled PollingEnabled
PollDelayInitial PollDelayInitial
PollDelayDeadTime PollDelayDeadTime
PollMinDelay PollMinDelay
PollFrequency PollFrequency
SendData Node Node
Data NetStatusText
SimulateIncomingData Data NetStatusText


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:


The Info parameters are:

1. The protocol: can be rtsp or http

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

3. Video codec: mpeg4 | mjpeg | etc.

4. Audio codec: blank = no audio

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

6. Width: 640

7. Height: 480

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


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

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


VideoURLs example for VistaCam:

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

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

So VSBA means do them all.

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.
  • UserCodeName is the PIN code name.
  • newPin is the new PIN code.
newPin sl_UserCode
SetPinValidityDate UserCode ui1 Sets the daily time interval in which a PIN code is valid.
  • UserCode is the PIN code index number. The starting index is 1.
  • StartDate and StopDate are strings representing the dates, formatted like this: year-month-day hour:minute
  • Replace: If this parameter is "1" the current restriction is replaced with the new one. Otherwise a new restriction is added, unless there are no more available restriction slots.

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

StartDate string
StopDate string
Replace boolean
SetPinValidityWeekly UserCode ui1 Sets the weekly time interval in which a PIN code is valid.
  • UserCode is the PIN code index number. The starting index is 1.
  • DayOfWeek contains the days of week numbers when the PIN code is restricted. Monday is '1' and Sunday is '7'.

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

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

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

DayOfWeek ui4
StartHour ui1
StartMinute ui1
StopHour ui1
StopMinute ui1
Replace boolean
ClearPinValidity UserCode ui4 Clears the given restriction slot.
  • UserCode is the PIN code index number. The starting index is 1.
  • slotID is the slot number. The starting index is 1.
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:
  • Off
  • HeatOn
  • CoolOn
  • AutoChangeOver
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:
  • Idle
  • Heating
  • Cooling

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:
  • Auto
  • ContinuousOn
  • PeriodicOn
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
Retrieved from "http://wiki.mios.com/index.php?title=Luup_UPnP_Variables_and_Actions&oldid=4571"
Personal tools