Luup Devices
Dluksenberg (Talk | contribs) (→Examples) |
Andreimios (Talk | contribs) (→Sensor - Temperature) |
||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 15: | Line 15: | ||
===Actions=== | ===Actions=== | ||
====SetTarget==== | ====SetTarget==== | ||
| − | Sets the target state of the | + | Sets the target state of the switch |
| − | '''Arguments:''' | + | '''Arguments:''' newTargetValue (Integer) |
| + | |||
| + | newTargetValue: 1 for on, 0 for off. | ||
| − | |||
== Dimmer == | == Dimmer == | ||
A dimmable light. | A dimmable light. | ||
| Line 33: | Line 34: | ||
'''Arguments:''' newLoadlevelTarget(Integer) | '''Arguments:''' newLoadlevelTarget(Integer) | ||
| − | + | newLoadlevelTarget: an integer between 0 and 100 indicating the desired % of lighting/load. | |
| + | |||
== Sensor == | == Sensor == | ||
A security sensor, or any device that can be "tripped" | A security sensor, or any device that can be "tripped" | ||
===Service=== | ===Service=== | ||
| − | + | *urn:micasaverde-com:serviceId:SecuritySensor | |
===Variables=== | ===Variables=== | ||
====Armed==== | ====Armed==== | ||
| Line 71: | Line 73: | ||
One of Off, HeatOn, CoolOn, or AutoChangeOver depending on the User operation mode of the thermostat. | One of Off, HeatOn, CoolOn, or AutoChangeOver depending on the User operation mode of the thermostat. | ||
| − | ==== urn:upnp-org:serviceId:HVAC_FanOperatingMode1 -- | + | ==== urn:upnp-org:serviceId:HVAC_FanOperatingMode1 -- Mode ==== |
| − | One of Auto, ContinuousOn, or PeriodicOn depending on the fan mode of the thermostat. | + | One of Auto, ContinuousOn, or PeriodicOn depending on the fan mode of the thermostat. |
==== urn:upnp-org:serviceId:TemperatureSensor1 -- CurrentTemperature ==== | ==== urn:upnp-org:serviceId:TemperatureSensor1 -- CurrentTemperature ==== | ||
| Line 157: | Line 159: | ||
urn:upnp-org:serviceId:TemperatureSensor1 | urn:upnp-org:serviceId:TemperatureSensor1 | ||
===Variables=== | ===Variables=== | ||
| − | + | CurrentTemperature(Integer): The current temperature in degrees the sensor is reporting. | |
| + | |||
== Sensor - Light == | == Sensor - Light == | ||
A light sensor. | A light sensor. | ||
| Line 164: | Line 167: | ||
===Variables=== | ===Variables=== | ||
CurrentLevel(Integer): The current light level that the sensor is reporting. | CurrentLevel(Integer): The current light level that the sensor is reporting. | ||
| + | |||
== Power Meter == | == Power Meter == | ||
A power meter or a device that can display power usage. | A power meter or a device that can display power usage. | ||
Latest revision as of 07:49, 19 December 2014
[edit] Home Automation Device
The generic device type that all MiOS devices implement.
[edit] Service
- urn:micasaverde-com:serviceId:HaDevice1
[edit] Variables
[edit] Actions
[edit] Switch
A binary switch, for an appliance, florescent light, or a relay.
[edit] Service
- urn:upnp-org:serviceId:SwitchPower1
[edit] Variables
[edit] Status
The state of the device. 1 is on, 0 is off.
[edit] Actions
[edit] SetTarget
Sets the target state of the switch
Arguments: newTargetValue (Integer)
newTargetValue: 1 for on, 0 for off.
[edit] Dimmer
A dimmable light.
[edit] Service
- urn:upnp-org:serviceId:Dimming1
[edit] Variables
newTargetValue: an integer between 0 and 100 indicating the desired % of lighting.
[edit] Actions
[edit] SetLoadLevelTarget
Sets the desired brightness or load level for the dimming device.
Arguments: newLoadlevelTarget(Integer)
newLoadlevelTarget: an integer between 0 and 100 indicating the desired % of lighting/load.
[edit] Sensor
A security sensor, or any device that can be "tripped"
[edit] Service
- urn:micasaverde-com:serviceId:SecuritySensor
[edit] Variables
[edit] Armed
An integer. 1 for armed, 0 for disarmed. This is an internal state variable of the MiOS engine and has nothing to do with the state of the sensor.
[edit] Tripped
An integer. 1 for tripped, 0 for not.
[edit] LastTrip
An integer with the UNIX timestamp of the last trip event that the MiOS engine recorded.
[edit] Actions
[edit] SetArmed
Sets the armed state of the sensor.
Arguments: newArmedValue(Integer)
newArmedValue: 1 for armed, 0 for disarmed.
[edit] HVAC/Climate
[edit] Service
- urn:upnp-org:serviceId:HVAC_UserOperatingMode1
- For action SetModeTarget
- urn:upnp-org:serviceId:TemperatureSetpoint1_Heat
- For action NewCurrentSetpoint
- urn:upnp-org:serviceId:TemperatureSetpoint1_Cool
- For action NewCurrentSetpoint
- urn:upnp-org:serviceId:HVAC_FanOperatingMode1
- For action SetMode
[edit] Variables
[edit] urn:upnp-org:serviceId:HVAC_UserOperatingMode1 -- ModeStatus
One of Off, HeatOn, CoolOn, or AutoChangeOver depending on the User operation mode of the thermostat.
[edit] urn:upnp-org:serviceId:HVAC_FanOperatingMode1 -- Mode
One of Auto, ContinuousOn, or PeriodicOn depending on the fan mode of the thermostat.
[edit] urn:upnp-org:serviceId:TemperatureSensor1 -- CurrentTemperature
An integer value representing the temperature that the thermostat is reporting.
[edit] urn:upnp-org:serviceId:TemperatureSetpoint1_Heat -- CurrentSetpoint
An integer value representing the heat setpoint for the thermostat
[edit] urn:upnp-org:serviceId:TemperatureSetpoint1_Cool -- CurrentSetpoint
An integer value representing the cool setpoint for the thermostat
[edit] Actions
[edit] SetModeTarget
Sets the desired operation mode for the thermostat.
Arguments: NewModeTarget(String)
NewModeTarget: One of Off, CoolOn, HeatOn, or AutoChangeOver.
[edit] SetCurrentSetpoint
Sets the desired setpoint. User serviceId urn:upnp-org:serviceId:TemperatureSetpoint1_Heat for heat and urn:upnp-org:serviceId:TemperatureSetpoint1_Cool for cooling
Arguments: NewCurrentSetpoint(Integer)
NewCurrentSetpoint: An integer value between 0 and 100 specifying the desired heat or cooling setpoint.
[edit] SetMode
Sets the fan operation mode for the thermostat
Arguments: NewMode(String)
NewMode: One of ContinuousOn or Auto, depending on the desired mode of operation for the HVAC system's fan.
[edit] Examples
Set Thermostat #4 to Cool: veraIP:3480/data_request?id=lu_action&DeviceNum=4&serviceId=urn:upnp-org:serviceId:HVAC_UserOperatingMode1&action=SetModeTarget&NewModeTarget=CoolOn
Set Thermostat #98 cool setpoint to 70: veraIP:3480/data_request?id=lu_action&DeviceNum=98&serviceId=urn:upnp-org:serviceId:TemperatureSetpoint1_Cool&action=SetCurrentSetpoint&NewCurrentSetpoint=70
[edit] Lock
Lorem ipsum dolor sit amet, ultricies ligula ligula maecenas, sed laboriosam erat.
[edit] Service
urn:micasaverde-com:serviceId:DoorLock1
[edit] Variables
[edit] Status
1 for locked, 0 for unlocked
[edit] Actions
[edit] SetTarget
Sets the desired lock state of the door lock
Arguments: newTargetValue(integer)
newTargetValue: 1 for lock, 0 for unlock
[edit] Window Covering
Blinds and shades.
[edit] Service
- urn:upnp-org:serviceId:WindowCovering1
- urn:upnp-org:serviceId:SwitchPower1
- Supports the same actions and variables as a switch. On is closed, Off is open.
[edit] Actions
[edit] Up
Moves the covering up.
[edit] Down
Moves the covering down.
[edit] Stop
Stops the covering moving.
[edit] Sensor - Humidity
A humidity sensor.
[edit] Service
urn:micasaverde-com:serviceId:HumiditySensor1
[edit] Variables
CurrentLevel(Integer): The current humidity level that the sensor is reporting.
[edit] Sensor - Temperature
A temperature sensor.
[edit] Service
urn:upnp-org:serviceId:TemperatureSensor1
[edit] Variables
CurrentTemperature(Integer): The current temperature in degrees the sensor is reporting.
[edit] Sensor - Light
A light sensor.
[edit] Service
urn:schemas-micasaverde-com:service:LightSensor:1
[edit] Variables
CurrentLevel(Integer): The current light level that the sensor is reporting.
[edit] Power Meter
A power meter or a device that can display power usage.
[edit] Service
urn:micasaverde-com:serviceId:EnergyMetering1
[edit] Variables
Watts(Integer): The energy draw the meter is recording, in watts.
