Luup UPnP Variables and Actions

From MiOS
(Difference between revisions)
Jump to: navigation, search
(→‎HVAC_UserOperatingMode1)
(→‎DoorLock1)
Line 875: Line 875:
 
| style="border: 1px solid #000" | json
 
| style="border: 1px solid #000" | json
 
| style="border: 1px solid #000" | PinCodes
 
| style="border: 1px solid #000" | PinCodes
−
| style="border: 1px solid #000" rowspan="3" |  
+
| style="border: 1px solid #000" rowspan="3" | Add a PIN code. This code will be added to the ''PinCodes'' variable and to the door lock. The required parameters are ''UserCodeName'' which is the PIN code name and ''newPin'', which is the PIN code.
 
|-
 
|-
 
| style="border: 1px solid #000" | UserCodeName
 
| style="border: 1px solid #000" | UserCodeName
Line 933: Line 933:
 
| style="border: 1px solid #000" rowspan="1" |  
 
| style="border: 1px solid #000" rowspan="1" |  
 
|}
 
|}
−
 
  
 
== HVAC_UserOperatingMode1 ==
 
== HVAC_UserOperatingMode1 ==

Revision as of 17:25, 10 August 2012

Contents

HomeAutomationGateway1

  • Service ID: urn:micasaverde-com:serviceId:HomeAutomationGateway1
  • File: S_HomeAutomationGateway1.xml


Variable Type Description
UserData string
DataFormat string
DeviceNum ui4
DataVersion ui4
UDN string
ActiveScenes string
DataVersionUserData ui4
DataVersionStatus ui4
Reload boolean


Action Arguments Description
Name Related variable/type
Reload none
GetUserData DataFormat DataFormat
DataVersion DataVersion
ModifyUserData inUserData UserData
DataFormat DataFormat
Reload Reload
SetVariable DeviceNum DeviceNum
Service UserData
Variable UserData
Value UserData
GetVariable DeviceNum DeviceNum
Service UserData
Variable UserData
GetStatus DataFormat DataFormat
DeviceNum DeviceNum
UDN UDN
GetActions DeviceNum DeviceNum
UDN UDN
DataFormat DataFormat
RunScene SceneNum DeviceNum
SceneOff SceneNum DeviceNum
RunLua DeviceNum DeviceNum
Code UDN
ProcessChildDevices DeviceNumParent DeviceNum
DeviceList UDN
CreateDevice deviceType UDN
internalID UDN
Description UDN
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 json PinCodes Add a PIN code. This code will be added to the PinCodes variable and to the door lock. The required parameters are UserCodeName which is the PIN code name and newPin, which is the PIN code.
UserCodeName sl_UserCode
newPin sl_UserCode
SetPinValidityDate UserCode ui4
StartDate dateTime
StopDate dateTime
Replace Target
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=4513"
Personal tools