Luup UPnP Variables and Actions

Revision as of 10:41, 7 August 2012 (view source) Mcvflorin (Talk | contribs) ← Older edit		Revision as of 10:45, 7 August 2012 (view source) Mcvflorin (Talk | contribs) (→‎DoorLock1) Newer edit →
Line 715:		Line 715:
	== DoorLock1 ==		== DoorLock1 ==
	* '''Service ID''': urn:micasaverde-com:serviceId:DoorLock1		* '''Service ID''': urn:micasaverde-com:serviceId:DoorLock1
		+	* '''File''': S_DoorLock1.xml
Line 722:		Line 723:
	|-		|-
	| style="border: 1px solid #000" | SetTarget		| style="border: 1px solid #000" | SetTarget
−	| style="border: 1px solid #000" |	+	| style="border: 1px solid #000" | Sets the target state of the door. Modifies the ''Target'' variable. Used to lock and unlock the door.
	|-		|-
	| style="border: 1px solid #000" | SetPin		| style="border: 1px solid #000" | SetPin
−	| style="border: 1px solid #000" |	+	| style="border: 1px solid #000" |
	|-		|-
	| style="border: 1px solid #000" | ClearPin		| style="border: 1px solid #000" | ClearPin
Line 793:		Line 794:
	| style="border: 1px solid #000" |		| style="border: 1px solid #000" |
	|}		|}
−
	== HVAC_UserOperatingMode1 ==		== HVAC_UserOperatingMode1 ==

---

Revision as of 10:45, 7 August 2012

Contents 1 HaGateway 2 HaDevice 3 ZWaveNetwork 4 ZWaveDevice 5 InsteonNetwork 6 InsteonDevice 7 USB_UIRT 8 Camera 9 PanTiltZoom 10 SwitchPower1 11 S_WindowCovering1 12 Dimming1 13 DoorLock1 14 HVAC_UserOperatingMode1 15 HVAC_OperatingState1 16 HVAC_FanOperatingMode1 17 TemperatureSetpoint1_Heat/Cool 18 TemperatureSensor1 19 GenericSensor1 20 LightSensor1 21 HumiditySensor1 22 SecuritySensor1 23 EnergyMetering1 24 IrTransmitter1 25 SerialPort1 26 SceneController1 27 SceneControllerLED1 28 GenericIO 29 IR

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

DoorLock1

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

Action	Description
SetTarget	Sets the target state of the door. Modifies the Target variable. Used to lock and unlock the door.
SetPin
ClearPin
SetPinValidityDate
SetPinValidityWeekly
ClearPinValidity

Variable	Description
Status
Target
MinPinSize
MaxPinSize
KeepPinCodes
sl_UserCode
sl_PinFailed
sl_LockButton
sl_LockFailure
sl_UnauthUser
sl_LowBattery
sl_VeryLowBattery
sl_CodeChanged
sl_LockChanged
PinCodes
NumSchedules

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