Luup UPnP Variables and Actions

From MiOS
Revision as of 13:32, 8 August 2012 by Mcvflorin (Talk | contribs)

Jump to: navigation, search

Contents

HaGateway

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


Variable Description
ActiveScenes
DataVersionUserData
DataVersionStatus


Action Description
GetUserData
ModifyUserData
GetVariable
SetVariable
GetStatus
GetActions
CreateDevice
DeleteDevice
CreatePlugin
DeletePlugin
CreatePluginDevice
ImportUpnpDevice
ProcessChildDevices
Reload
RunScene
SceneOff
RunLua
LogIpRequest


HaDevice

  • File: S_HaDevice1.xml
  • Service ID: urn:micasaverde-com:serviceId:HaDevice1


Variable Description
EnergyLog
IODevice
IODeviceXRef
MaxTime
IOPort
IOPortPath
IgnoreRoom
CommFailure
PollingEnabled
PollMinDelay
Configured
JobID
ReverseOnOff
LastUpdate
LastActivity
AutoConfigure
LastTimeCheck
LastTimeOffset
FirstConfigured
BatteryLevel
BatteryDate
BatteryAlarm
Documentation
sl_Alarm


Action Description
Reconfigure
Remove
Poll
SetPollFrequency
StressTest
ToggleState


ZWaveNetwork

  • File: S_ZWaveNetwork1.xml
  • Service ID: urn:micasaverde-com:serviceId:ZWaveNetwork1


Variable Description
LastUpdate
LastHeal
LastRouteFailure
LastDongleBackup
NetStatusID
NetStatusText
ComPort
LockComPort
NodeID
VersionInfo
HomeID
Role
ResetMode
InclusionMode
NodeType
Timeout
Multiple
SimulateIncomingData
PollingEnabled
PollDelayInitial
PollDelayDeadTime
PollMinDelay
PollFrequency
LastError
DelayProcessing
FailedOnly
Use45
UseMR
TO3066
LimitNeighbors


ZWaveDevice

  • File: S_ZWaveDevice1.xml
  • Service ID: urn:micasaverde-com:serviceId:ZWaveDevice1


Variable Description
PollSettings
PollCommands
MultiChEndpoint
MultiChCapabilities
Neighbors
NeighborsInverse
Capabilities
SecurityFailed
Configuration
LastReset
ScenesAsEvents
ScenesTimestamp
WakeupInterval
LastWakeup
LastRouteUpdate
Health
HealthDate
VariablesGet
VariablesSet
AssociationGet
AssociationSet
AssociationNum
NonceACK
ManufacturerInfo
VersionInfo
SetPointInfo
NodeInfo
InitialName
ConfiguredName
ConfiguredVariable
ConfiguredAssoc
Documentation
MeterType
MeterScale
AlarmType
PollOk
PollTxFail
PollNoReply
ManualRoute
AllRoutesFailed
AutoRoute
IgnoreDirectScene
SwitchMlSettings


InsteonNetwork

  • File: S_InsteonNetwork1.xml
  • Service ID: urn:micasaverde-com:serviceId:InsteonNetwork1


Variable Description
ComPort
LockComPort
LastError
LastUpdate
NetStatusID
NetStatusText
PollingEnabled
PollDelayInitial
PollDelayDeadTime
PollMinDelay
PollFrequency
NodeID
sl_X10Code


InsteonDevice

  • File: S_InsteonDevice1.xml
  • Service ID: urn:micasaverde-com:serviceId:InsteonDevice1


Variable Description
PollSettings
MultiChEndpoint
MultiChCapabilities
Neighbors
Capabilities
Configuration
LastReset
ScenesAsEvents
WakeupInterval
LastWakeup
LastRouteUpdate
VariablesGet
VariablesSet
AssociationGet
AssociationSet
ManufacturerInfo
VersionInfo
UpdatedName


USB_UIRT

  • File: S_USBUIRT.xml
  • Service ID: urn:micasaverde-com:serviceId:USBUIRT1


Variable Description


Action Description
ComPort


Camera

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


Variable Description
RelatedSensors
SensorArchiveSeconds
RelatedLights
LightOptions
AutoArchiveSeconds
AutoArchivePreserveDays
URL
DirectStreamingURL
Timeout
PreRollBuffer


PanTiltZoom

  • File: S_PanTiltZoom1.xml
  • Service ID: urn:micasaverde-com:serviceId:PanTiltZoom1


Action Description
MoveLeft
MoveRight
MoveUp
MoveDown
ZoomIn
ZoomOut


SwitchPower1

  • Service ID: urn:upnp-org:serviceId:SwitchPower1


Action Description
SetTarget


Variable Description
Status
Target


S_WindowCovering1

  • Service ID: urn:upnp-org:serviceId:WindowCovering1


Action Description
Up
Down
Stop


Variable Description
Status
Target


Dimming1

  • Service ID: urn:upnp-org:serviceId:Dimming1


Action Description
SetLoadLevelTarget


Variable Description
LoadLevelStatus
LoadLevelTarget


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_USBUIRT1.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
Status boolean


Action Arguments Description
Name Related variable/type
SetTarget newTargetValue Target
GetTarget none
GetStatus none


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
LoadLevelStatus ui1
MinLevel ui1
OnEffectLevel ui1
OnEffect string
ValidOutputValues string
StepDelta ui1
RampRate ui1
RampTime ui4
IsRamping boolean
RampPaused boolean


Action Arguments Description
Name Related variable/type
SetLoadLevelTarget newLoadlevelTarget LoadLevelTarget
GetLoadLevelTarget none
GetLoadLevelStatus none
SetOnEffectLevel newOnEffectLevel OnEffectLevel
SetOnEffect newOnEffect OnEffect
GetOnEffectParameters none
StepUp none
StepDown none
StartRampUp none
StartRampDown none
StopRamp none
StartRampToLevel newLoadLevelTarget LoadLevelTarget
newRampTime RampTime
SetStepDelta newStepDelta StepDelta
GetStepDelta none
SetRampRate newRampRate RampRate
GetRampRate none
PauseRamp none
ResumeRamp none
GetIsRamping none
GetRampPaused none
GetRampTime none


DoorLock1

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


Variable Type Description
Target boolean
Status boolean
PinCodes string
sl_UserCode string
sl_PinFailed boolean
sl_CodeChanged int
sl_LockButton boolean
sl_LockFailure boolean
sl_UnauthUser string
sl_LockChanged string
sl_LowBattery boolean
sl_VeryLowBattery boolean
dateTime dateTime
ui4 ui4
ui1 ui1


Action Arguments Description
Name Related variable/type
SetTarget newTargetValue Target
SetPin json PinCodes
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
ModeStatus string
EnergyModeTarget string
EnergyModeStatus string
Name string


Action Arguments Description
Name Related variable/type
SetModeTarget NewModeTarget ModeTarget
SetEnergyModeTarget NewModeTarget EnergyModeTarget
GetModeTarget none
GetModeStatus none
GetName none
SetName NewName Name


HVAC_OperatingState1

  • Service ID: urn:micasaverde-com:serviceId:HVAC_OperatingState1
  • File: S_HVAC_OperatingState1.xml


Variable Type Description
ModeState string


HVAC_FanOperatingMode1

  • Service ID: urn:upnp-org:serviceId:HVAC_FanOperatingMode1
  • File: S_HVAC_FanOperatingMode1.xml


Variable Type Description
Mode string
FanStatus string
Name string


Action Arguments Description
Name Related variable/type
SetMode NewMode Mode
GetMode none
GetFanStatus none
GetName none
SetName NewName Name


TemperatureSetpoint1

  • Service ID: urn:upnp-org:serviceId:TemperatureSetpoint1_Heat
  • 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


TemperatureSetpoint1

  • Service ID: 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

HVAC_UserOperatingMode1

  • Service ID: urn:upnp-org:serviceId:HVAC_UserOperatingMode1


Action Description
SetModeTarget
SetEnergyModeTarget


Variable Description
ModeTarget
ModeStatus
SupportedType
EnergyModeTarget
EnergyModeStatus


HVAC_OperatingState1

  • Service ID: urn:micasaverde-com:serviceId:HVAC_OperatingState1


Variable Description
ModeState
ModeStateForEnergy


HVAC_FanOperatingMode1

  • Service ID: urn:upnp-org:serviceId:HVAC_FanOperatingMode1


Action Description
SetMode


Variable Description
Mode


TemperatureSetpoint1_Heat/Cool

  • Service ID: urn:upnp-org:serviceId:TemperatureSetpoint1_Heat


  • Service ID: urn:upnp-org:serviceId:TemperatureSetpoint1_Cool


Action Description
SetCurrentSetpoint


Variable Description
CurrentSetpoint
SetpointTarget


TemperatureSensor1

  • Service ID: urn:upnp-org:serviceId:TemperatureSensor1


Variable Description
CurrentTemperature


GenericSensor1

  • Service ID: urn:micasaverde-com:serviceId:GenericSensor1


Variable Description
CurrentLevel


LightSensor1

  • Service ID: urn:micasaverde-com:serviceId:LightSensor1


Variable Description
CurrentLevel


HumiditySensor1

  • Service ID: urn:micasaverde-com:serviceId:HumiditySensor1


Variable Description
CurrentLevel


SecuritySensor1

  • Service ID: urn:micasaverde-com:serviceId:SecuritySensor1


Variable Description
Armed
Tripped
LastTrip
SetArmed


EnergyMetering1

  • Service ID: urn:micasaverde-com:serviceId:EnergyMetering1


Action Description
ResetKWH


Variable Description
KWH
KWHReading
kVARh
kVAR
Watts
Pulse
ActualUsage
UserSuppliedWattage
WholeHouse
Log


IrTransmitter1

  • Service ID: urn:micasaverde-com:serviceId:IrTransmitter1


Action Description
SendProntoCode


SerialPort1

  • Service ID: urn:micasaverde-org:serviceId:SerialPort1


Variable Description
baud
vendor
product
path


SceneController1

  • Service ID: urn:micasaverde-com:serviceId:SceneController1


Variable Description
sl_SceneActivated
sl_SceneDeactivated
Scenes
LastSceneID
LastSceneTime
ManageLeds
NumButtons
FiresOffEvents
SceneShortcuts
ActivationMethod


SceneControllerLED1

  • Service ID: urn:micasaverde-com:serviceId:SceneControllerLED1


Action Description
SetLight


Variable Description
LightSettings


GenericIO

  • Service ID: urn:micasaverde-com:serviceId:GenericIO


Variable Description
IsInput
DefaultState


IR

  • Service ID: urn:micasaverde-com:serviceId:IrDevice1


Variable Description
Codesets
Codeset
CodesetProgrammed
Remote
MfrId
ProprietaryCodeset
Personal tools