Luup Devices
Dluksenberg (Talk | contribs) (→Service) |
Dluksenberg (Talk | contribs) (→HVAC/Climate) |
||
| Line 52: | Line 52: | ||
newArmedValue: 1 for armed, 0 for disarmed. | newArmedValue: 1 for armed, 0 for disarmed. | ||
| − | == HVAC/Climate == | + | == HVAC/Climate == |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | === | + | === 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 | ||
| − | + | === Variables === | |
| − | ==== | + | |
| − | + | ||
| − | + | ==== urn:upnp-org:serviceId:HVAC_UserOperatingMode1 -- ModeStatus ==== | |
| − | + | One of Off, HeatOn, CoolOn, or AutoChangeOver depending on the User operation mode of the thermostat. | |
| − | + | ||
| − | + | ||
| − | '''Arguments:''' NewMode(String) | + | ==== urn:upnp-org:serviceId:HVAC_FanOperatingMode1 -- ModeStatus ==== |
| + | |||
| + | One of Auto, ContinuousOn, or PeriodicOn depending on the fan mode of the thermostat. | ||
| + | |||
| + | ==== urn:upnp-org:serviceId:TemperatureSensor1 -- CurrentTemperature ==== | ||
| + | |||
| + | An integer value representing the temperature that the thermostat is reporting. | ||
| + | |||
| + | ==== urn:upnp-org:serviceId:TemperatureSetpoint1_Heat -- CurrentSetpoint ==== | ||
| + | |||
| + | An integer value representing the heat setpoint for the thermostat | ||
| + | |||
| + | ==== urn:upnp-org:serviceId:TemperatureSetpoint1_Cool -- CurrentSetpoint ==== | ||
| + | |||
| + | An integer value representing the cool setpoint for the thermostat | ||
| + | |||
| + | === Actions === | ||
| + | |||
| + | ==== SetModeTarget ==== | ||
| + | |||
| + | Sets the desired operation mode for the thermostat. | ||
| + | |||
| + | '''Arguments:''' NewModeTarget(String) | ||
| + | |||
| + | NewModeTarget: One of Off, CoolOn, HeatOn, or AutoChangeOver. | ||
| + | |||
| + | ==== 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. | ||
| + | |||
| + | ==== 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. | ||
| + | |||
| + | === Examples === | ||
| + | |||
| + | Set Thermostat #98 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 | ||
| − | |||
== Lock == | == Lock == | ||
Lorem ipsum dolor sit amet, ultricies ligula ligula maecenas, sed laboriosam erat. | Lorem ipsum dolor sit amet, ultricies ligula ligula maecenas, sed laboriosam erat. | ||
Revision as of 16:02, 21 June 2011
Home Automation Device
The generic device type that all MiOS devices implement.
Service
- urn:micasaverde-com:serviceId:HaDevice1
Variables
Actions
Switch
A binary switch, for an appliance, florescent light, or a relay.
Service
- urn:upnp-org:serviceId:SwitchPower1
Variables
Status
The state of the device. 1 is on, 0 is off.
Actions
SetTarget
Sets the target state of the dimmer
Arguments: NewTargetValue(Integer)
NewTargetValue: 1 for on, 0 for off.
Dimmer
A dimmable light.
Service
- urn:upnp-org:serviceId:Dimming1
Variables
newTargetValue: an integer between 0 and 100 indicating the desired % of lighting.
Actions
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.
Sensor
A security sensor, or any device that can be "tripped"
Service
u*rn:micasaverde-com:serviceId:SecuritySensor
Variables
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.
Tripped
An integer. 1 for tripped, 0 for not.
LastTrip
An integer with the UNIX timestamp of the last trip event that the MiOS engine recorded.
Actions
SetArmed
Sets the armed state of the sensor.
Arguments: newArmedValue(Integer)
newArmedValue: 1 for armed, 0 for disarmed.
HVAC/Climate
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
Variables
urn:upnp-org:serviceId:HVAC_UserOperatingMode1 -- ModeStatus
One of Off, HeatOn, CoolOn, or AutoChangeOver depending on the User operation mode of the thermostat.
urn:upnp-org:serviceId:HVAC_FanOperatingMode1 -- ModeStatus
One of Auto, ContinuousOn, or PeriodicOn depending on the fan mode of the thermostat.
urn:upnp-org:serviceId:TemperatureSensor1 -- CurrentTemperature
An integer value representing the temperature that the thermostat is reporting.
urn:upnp-org:serviceId:TemperatureSetpoint1_Heat -- CurrentSetpoint
An integer value representing the heat setpoint for the thermostat
urn:upnp-org:serviceId:TemperatureSetpoint1_Cool -- CurrentSetpoint
An integer value representing the cool setpoint for the thermostat
Actions
SetModeTarget
Sets the desired operation mode for the thermostat.
Arguments: NewModeTarget(String)
NewModeTarget: One of Off, CoolOn, HeatOn, or AutoChangeOver.
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.
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.
Examples
Set Thermostat #98 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
Lock
Lorem ipsum dolor sit amet, ultricies ligula ligula maecenas, sed laboriosam erat.
Service
urn:micasaverde-com:serviceId:DoorLock1
Variables
Status
1 for locked, 0 for unlocked
Actions
SetTarget
Sets the desired lock state of the door lock
Arguments: newTargetValue(integer)
newTargetValue: 1 for lock, 0 for unlock
Window Covering
Blinds and shades.
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.
Actions
Up
Moves the covering up.
Down
Moves the covering down.
Stop
Stops the covering moving.
Sensor - Humidity
A humidity sensor.
Service
urn:micasaverde-com:serviceId:HumiditySensor1
Variables
CurrentLevel(Integer): The current humidity level that the sensor is reporting.
Sensor - Temperature
A temperature sensor.
Service
urn:upnp-org:serviceId:TemperatureSensor1
Variables
CurrentLevel(Integer): The current temperature in degrees the sensor is reporting.
Sensor - Light
A light sensor.
Service
urn:schemas-micasaverde-com:service:LightSensor:1
Variables
CurrentLevel(Integer): The current light level that the sensor is reporting.
Power Meter
A power meter or a device that can display power usage.
Service
urn:micasaverde-com:serviceId:EnergyMetering1
Variables
Watts(Integer): The energy draw the meter is recording, in watts.
