Difference between revisions of "Driver Capability List"

From Hubitat Documentation
Jump to: navigation, search
(SwitchLevel)
Line 7: Line 7:
 
== SwitchLevel ==
 
== SwitchLevel ==
  
'''<big>Device Definition</big>'''
+
'''<big>Driver Definition</big>'''
 
:<code>capability "Switch Level"</code>
 
:<code>capability "Switch Level"</code>
  
Line 20: Line 20:
 
:: ''Level'' (NUMBER) - Level to set (0 to 100)
 
:: ''Level'' (NUMBER) - Level to set (0 to 100)
 
:: ''Duration'' (NUMBER) - Transition duration in seconds
 
:: ''Duration'' (NUMBER) - Transition duration in seconds
 
  
 
== Thermostat ==
 
== Thermostat ==

Revision as of 19:43, 7 January 2019

Capabilities that can be used in drivers

IlluminanceMeasurement

TemperatureMeasurement

SwitchLevel

Driver Definition

capability "Switch Level"

Device Selector

capability.switchLevel

Attributes

level - NUMBER

Commands

setLevel(Level, Duration)
Level (NUMBER) - Level to set (0 to 100)
Duration (NUMBER) - Transition duration in seconds

Thermostat

Device Selector

capability.thermostat

Attributes

temperature - NUMBER
heatingSetpoint - NUMBER
coolingSetpoint - NUMBER
thermostatSetpoint - NUMBER
thermostatMode - ENUM ["auto", "off", "heat", "emergency heat", "cool"]
thermostatFanMode - ENUM ["on", "circulate", "auto"]
thermostatOperatingState - ENUM ["heating", "pending cool", "pending heat", "vent economizer", "idle", "cooling", "fan only"]
schedule - JSON_OBJECT
supportedThermostatModes - ENUM ["auto", "off", "heat", "emergency heat", "cool"]
supportedThermostatFanModes - ENUM ["on", "circulate", "auto"]

Commands

setHeatingSetpoint(Temperature)
Temperature (NUMBER) - Heating setpoint in degrees
setCoolingSetpoint(Temperature)
Temperature (NUMBER) - Cooling setpoint in degrees
off()
heat()
emergencyHeat()
cool()
setThermostatMode(Thermostat mode)
Thermostat mode (ENUM) ["auto", "off", "heat", "emergency heat", "cool"] - Thermostat mode to set
fanOn()
fanAuto()
fanCirculate()
setThermostatFanMode(Fan mode)
Fan mode (ENUM) ["on", "circulate", "auto"] - Fan mode to set
auto()
setSchedule(JSON_OBJECT)