Luup UPnP Variables and Actions

From MiOS
(Difference between revisions)
Jump to: navigation, search
(→‎HomeAutomationGateway1)
(→‎HomeAutomationGateway1)
Line 34: Line 34:
 
  | style="border: 1px solid #000" | inUserData
 
  | style="border: 1px solid #000" | inUserData
 
  | style="border: 1px solid #000" | UserData
 
  | 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" 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" | DataFormat
Line 44: Line 48:
 
  | style="border: 1px solid #000" rowspan="4" | SetVariable
 
  | style="border: 1px solid #000" rowspan="4" | SetVariable
 
  | style="border: 1px solid #000" | DeviceNum
 
  | style="border: 1px solid #000" | DeviceNum
−
  | style="border: 1px solid #000" | number or string
+
  | 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>Value</tt> is the new variable value.
+
  | 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" | Service
Line 55: Line 63:
 
  | style="border: 1px solid #000" | Value
 
  | style="border: 1px solid #000" | Value
 
  | style="border: 1px solid #000" | string
 
  | style="border: 1px solid #000" | string
−
|-
 
−
| style="border: 1px solid #000" rowspan="3" | GetVariable
 
−
| style="border: 1px solid #000" | DeviceNum
 
−
| style="border: 1px solid #000" | DeviceNum
 
−
| style="border: 1px solid #000" rowspan="3" |
 
−
|-
 
−
| style="border: 1px solid #000" | Service
 
−
| style="border: 1px solid #000" | UserData
 
−
|-
 
−
| style="border: 1px solid #000" | Variable
 
−
| style="border: 1px solid #000" | UserData
 
−
|-
 
−
| style="border: 1px solid #000" rowspan="3" | GetStatus
 
−
| style="border: 1px solid #000" | DataFormat
 
−
| style="border: 1px solid #000" | DataFormat
 
−
| style="border: 1px solid #000" rowspan="3" |
 
−
|-
 
−
| style="border: 1px solid #000" | DeviceNum
 
−
| style="border: 1px solid #000" | DeviceNum
 
−
|-
 
−
| style="border: 1px solid #000" | UDN
 
−
| style="border: 1px solid #000" | UDN
 
−
|-
 
−
| style="border: 1px solid #000" rowspan="3" | GetActions
 
−
| style="border: 1px solid #000" | DeviceNum
 
−
| style="border: 1px solid #000" | DeviceNum
 
−
| style="border: 1px solid #000" rowspan="3" |
 
−
|-
 
−
| style="border: 1px solid #000" | UDN
 
−
| style="border: 1px solid #000" | UDN
 
−
|-
 
−
| style="border: 1px solid #000" | DataFormat
 
−
| style="border: 1px solid #000" | DataFormat
 
 
  |-
 
  |-
 
  | style="border: 1px solid #000" rowspan="1" | RunScene
 
  | style="border: 1px solid #000" rowspan="1" | RunScene
 
  | style="border: 1px solid #000" | SceneNum
 
  | style="border: 1px solid #000" | SceneNum
−
  | style="border: 1px solid #000" | DeviceNum
+
  | style="border: 1px solid #000" | ui4
−
  | style="border: 1px solid #000" rowspan="1" |
+
  | style="border: 1px solid #000" rowspan="1" | Run the given scene.
 
  |-
 
  |-
 
  | style="border: 1px solid #000" rowspan="1" | SceneOff
 
  | style="border: 1px solid #000" rowspan="1" | SceneOff
 
  | style="border: 1px solid #000" | SceneNum
 
  | style="border: 1px solid #000" | SceneNum
−
  | style="border: 1px solid #000" | DeviceNum
+
  | style="border: 1px solid #000" | ui4
−
  | style="border: 1px solid #000" rowspan="1" |
+
  | 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" rowspan="2" | RunLua
 
  | style="border: 1px solid #000" | DeviceNum
 
  | style="border: 1px solid #000" | DeviceNum
−
  | style="border: 1px solid #000" | DeviceNum
+
  | style="border: 1px solid #000" | ui4 or string
−
  | style="border: 1px solid #000" rowspan="2" |
+
  | 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" | Code
−
  | style="border: 1px solid #000" | UDN
+
  | style="border: 1px solid #000" | string
−
|-
+
−
| style="border: 1px solid #000" rowspan="2" | ProcessChildDevices
+
−
| style="border: 1px solid #000" | DeviceNumParent
+
−
| style="border: 1px solid #000" | DeviceNum
+
−
| style="border: 1px solid #000" rowspan="2" |
+
−
|-
+
−
| style="border: 1px solid #000" | DeviceList
+
−
| style="border: 1px solid #000" | UDN
+
 
  |-
 
  |-
 
  | style="border: 1px solid #000" rowspan="10" | CreateDevice
 
  | style="border: 1px solid #000" rowspan="10" | CreateDevice
 
  | style="border: 1px solid #000" | deviceType
 
  | style="border: 1px solid #000" | deviceType
−
  | style="border: 1px solid #000" | UDN
+
  | style="border: 1px solid #000" | string
−
  | style="border: 1px solid #000" rowspan="10" |
+
  | 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" | internalID
−
  | style="border: 1px solid #000" | UDN
+
  | style="border: 1px solid #000" | string
 
  |-
 
  |-
 
  | style="border: 1px solid #000" | Description
 
  | style="border: 1px solid #000" | Description
−
  | style="border: 1px solid #000" | UDN
+
  | style="border: 1px solid #000" | string
 
  |-
 
  |-
 
  | style="border: 1px solid #000" | UpnpDevFilename
 
  | style="border: 1px solid #000" | UpnpDevFilename

Revision as of 14:20, 31 August 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 UDN
UpnpImplFilename UDN
IpAddress UDN
MacAddress UDN
DeviceNumParent DeviceNum
RoomNum DeviceNum
StateVariables UDN
DeleteDevice DeviceNum DeviceNum
UDN UDN
CreatePlugin PluginNum DeviceNum
StateVariables UDN
DeletePlugin PluginNum DeviceNum
CreatePluginDevice PluginNum DeviceNum
StateVariables UDN
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
Configured boolean
ID string
PollingEnabled boolean
PollMinDelay ui1
sl_Alarm string
BatteryLevel i1


Action Arguments Description
Name Related variable/type
Reconfigure none
StressTest none
Remove none
Poll none
ToggleState none
SetPollFrequency PollingEnabled PollingEnabled
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

Camera1

  • Service ID: urn:micasaverde-com:serviceId:Camera1
  • File: S_Camera1.xml


Variable Type Description
UseCMS boolean
VideoURLs string
URL string
DirectStreamingURL string
RelatedSensors string
SensorArchiveSeconds ui4
RelatedLights string
LightOptions string
AutoArchiveSeconds ui4
AutoArchivePreserveDays ui4


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. The UserCodeName parameter is the PIN code name and newPin parameter is the new PIN code.
newPin sl_UserCode
SetPinValidityDate UserCode ui4 Sets the date interval in which a PIN code is valid. The UserCode parameter is the PIN code and the StartDate and StopDate parameters are strings representing the dates, formatted like this: year-month-day hour:minute
StartDate dateTime
StopDate dateTime
SetPinValidityWeekly UserCode ui4
DayOfWeek ui4
StartHour ui1
StartMinute ui1
StopHour ui1
StopMinute ui1
Replace Target
ClearPinValidity UserCode ui4
slotID ui4
ClearPin UserCode sl_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
Application string
CurrentSetpoint i4
SetpointAchieved boolean
Name string


Action Arguments Description
Name Related variable/type
GetApplication none
SetApplication NewApplication Application
SetCurrentSetpoint NewCurrentSetpoint CurrentSetpoint
GetCurrentSetpoint none
GetSetpointAchieved none
GetName none
SetName NewName Name


TemperatureSensor1

  • Service ID: urn:upnp-org:serviceId:TemperatureSensor1
  • File: S_TemperatureSensor1.xml


Variable Type Description
CurrentTemperature i4
Application string
Name string


Action Arguments Description
Name Related variable/type
GetApplication none
SetApplication NewApplication Application
GetCurrentTemperature none
GetName none
SetName NewName Name


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
LastTrip i4


Action Arguments Description
Name Related variable/type
SetArmed newArmedValue Armed


EnergyMetering1

  • Service ID: urn:micasaverde-com:serviceId:EnergyMetering1
  • File: S_EnergyMetering1.xml


Variable Type Description
Watts ui4
ActualUsage boolean
WholeHouse boolean
Pulse ui4
UserSuppliedWattage ui4
KWH ui4


Action Arguments Description
Name Related variable/type
ResetKWH none


IrTransmitter1

  • Service ID: urn:micasaverde-com:serviceId:IrTransmitter1
  • File: S_IrTransmitter1.xml


Variable Type Description
ProntoCode string
Status boolean


Action Arguments Description
Name Related variable/type
SendProntoCode ProntoCode ProntoCode


SerialPort1

  • Service ID: urn:micasaverde-org:serviceId:SerialPort1
  • File: S_SerialPort1.xml


Variable Type Description
path string
baud ui4
stopbits ui1
databits ui1
parity string


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=4549"
Personal tools