Difference between revisions of "Driver Capability List"

From Hubitat Documentation
Jump to: navigation, search
(→‎SwitchLevel)
Line 1: Line 1:
 
Capabilities that can be used in drivers
 
Capabilities that can be used in drivers
 +
 +
== AccelerationSensor ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.accelerationSensor</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "AccelerationSensor"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>acceleration</code>''' - ENUM ["inactive", "active"]
 +
 +
'''<big>Commands</big>'''
 +
 +
== Actuator ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.actuator</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Actuator"</code>
 +
 +
'''<big>Attributes</big>'''
 +
 +
'''<big>Commands</big>'''
 +
 +
== Alarm ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.alarm</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Alarm"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>alarm</code>''' - ENUM ["strobe", "off", "both", "siren"]
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>both()</code>'''
 +
:'''<code>off()</code>'''
 +
:'''<code>siren()</code>'''
 +
:'''<code>strobe()</code>'''
 +
 +
== AudioNotification ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.audioNotification</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "AudioNotification"</code>
 +
 +
'''<big>Attributes</big>'''
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>playText(text, volumelevel)</code>'''
 +
::''text'' required (STRING) - Text to play
 +
::''volumelevel'' optional (NUMBER) - Volume level (0 to 100)
 +
:'''<code>playTextAndRestore(text, volumelevel)</code>'''
 +
::''text'' required (STRING) - Text to play
 +
::''volumelevel'' optional (NUMBER) - Volume level (0 to 100)
 +
:'''<code>playTextAndResume(text, volumelevel)</code>'''
 +
::''text'' required (STRING) - Text to play
 +
::''volumelevel'' optional (NUMBER) - Volume level (0 to 100)
 +
:'''<code>playTrack(trackuri, volumelevel)</code>'''
 +
::''trackuri'' required (STRING) - URI/URL of track to play
 +
::''volumelevel'' optional (NUMBER) - Volume level (0 to 100)
 +
:'''<code>playTrackAndRestore(trackuri, volumelevel)</code>'''
 +
::''trackuri'' required (STRING) - URI/URL of track to play
 +
::''volumelevel'' optional (NUMBER) - Volume level (0 to 100)
 +
:'''<code>playTrackAndResume(trackuri, volumelevel)</code>'''
 +
::''trackuri'' required (STRING) - URI/URL of track to play
 +
::''volumelevel'' optional (NUMBER) - Volume level (0 to 100)
 +
 +
== AudioVolume ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.audioVolume</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "AudioVolume"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>mute</code>''' - ENUM ["unmuted", "muted"]
 +
:'''<code>volume</code>''' - NUMBER
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>mute()</code>'''
 +
:'''<code>setVolume(volumelevel)</code>'''
 +
::''volumelevel'' required (NUMBER) - Volume level (0 to 100)
 +
:'''<code>unmute()</code>'''
 +
:'''<code>volumeDown()</code>'''
 +
:'''<code>volumeUp()</code>'''
 +
 +
== Battery ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.battery</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Battery"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>battery</code>''' - NUMBER
 +
 +
'''<big>Commands</big>'''
 +
 +
== Beacon ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.beacon</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Beacon"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>presence</code>''' - ENUM ["not present", "present"]
 +
 +
'''<big>Commands</big>'''
 +
 +
== Bulb ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.bulb</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Bulb"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>switch</code>''' - ENUM ["on", "off"]
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>off()</code>'''
 +
:'''<code>on()</code>'''
 +
 +
== Button ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.button</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Button"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>button</code>''' - NUMBER
 +
:'''<code>holdableButton</code>''' - ENUM ["true", "false"]
 +
:'''<code>numberOfButtons</code>''' - NUMBER
 +
 +
'''<big>Commands</big>'''
 +
 +
== CarbonDioxideMeasurement ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.carbonDioxideMeasurement</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "CarbonDioxideMeasurement"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>carbonDioxide</code>''' - NUMBER
 +
 +
'''<big>Commands</big>'''
 +
 +
== CarbonMonoxideDetector ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.carbonMonoxideDetector</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "CarbonMonoxideDetector"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>carbonMonoxide</code>''' - ENUM ["detected", "tested", "clear"]
 +
 +
'''<big>Commands</big>'''
 +
 +
== ChangeLevel ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.changeLevel</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "ChangeLevel"</code>
 +
 +
'''<big>Attributes</big>'''
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>startLevelChange(direction)</code>'''
 +
::''direction'' required (ENUM) - Direction for level change request
 +
:'''<code>stopLevelChange()</code>'''
 +
 +
== Chime ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.chime</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Chime"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>soundEffects</code>''' - JSON_OBJECT
 +
:'''<code>soundName</code>''' - STRING
 +
:'''<code>status</code>''' - ENUM ["playing", "stopped"]
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>playSound(soundnumber)</code>'''
 +
::''soundnumber'' required (NUMBER) - Sound number to play
 +
:'''<code>stop()</code>'''
 +
 +
== ColorControl ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.colorControl</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "ColorControl"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>RGB</code>''' - STRING
 +
:'''<code>color</code>''' - STRING
 +
:'''<code>colorName</code>''' - STRING
 +
:'''<code>hue</code>''' - NUMBER
 +
:'''<code>saturation</code>''' - NUMBER
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>setColor(colormap)</code>'''
 +
::''colormap'' required (COLOR_MAP) - Color map settings [hue*:(0 to 100), saturation*:(0 to 100), level:(0 to 100)]
 +
:'''<code>setHue(hue)</code>'''
 +
::''hue'' required (NUMBER) - Color Hue (0 to 100)
 +
:'''<code>setSaturation(saturation)</code>'''
 +
::''saturation'' required (NUMBER) - Color Saturation (0 to 100)
 +
 +
== ColorMode ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.colorMode</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "ColorMode"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>colorMode</code>''' - ENUM ["CT", "RGB"]
 +
 +
'''<big>Commands</big>'''
 +
 +
== ColorTemperature ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.colorTemperature</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "ColorTemperature"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>colorName</code>''' - STRING
 +
:'''<code>colorTemperature</code>''' - NUMBER
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>setColorTemperature(colortemperature)</code>'''
 +
::''colortemperature'' required (NUMBER) - Color temperature in degrees Kelvin
 +
 +
== Configuration ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.configuration</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Configuration"</code>
 +
 +
'''<big>Attributes</big>'''
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>configure()</code>'''
 +
 +
== Consumable ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.consumable</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Consumable"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>consumableStatus</code>''' - ENUM ["missing", "order", "maintenance_required", "good", "replace"]
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>setConsumableStatus(STRING)</code>'''
 +
::''STRING''  (STRING) - STRING
 +
 +
== ContactSensor ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.contactSensor</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "ContactSensor"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>contact</code>''' - ENUM ["closed", "open"]
 +
 +
'''<big>Commands</big>'''
 +
 +
== DoorControl ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.doorControl</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "DoorControl"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>door</code>''' - ENUM ["unknown", "closed", "open", "closing", "opening"]
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>close()</code>'''
 +
:'''<code>open()</code>'''
 +
 +
== DoubleTapableButton ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.doubleTapableButton</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "DoubleTapableButton"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>doubleTapped</code>''' - NUMBER
 +
 +
'''<big>Commands</big>'''
 +
 +
== EnergyMeter ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.energyMeter</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "EnergyMeter"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>energy</code>''' - NUMBER
 +
 +
'''<big>Commands</big>'''
 +
 +
== EstimatedTimeOfArrival ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.estimatedTimeOfArrival</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "EstimatedTimeOfArrival"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>eta</code>''' - DATE
 +
 +
'''<big>Commands</big>'''
 +
 +
== FanControl ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.fanControl</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "FanControl"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>speed</code>''' - ENUM ["low","medium-low","medium","medium-high","high","on","off","auto"]
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>setSpeed(fanspeed)</code>'''
 +
::''fanspeed'' required (ENUM) - Fan speed to set
 +
 +
== FilterStatus ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.filterStatus</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "FilterStatus"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>filterStatus</code>''' - ENUM ["normal", "replace"]
 +
 +
'''<big>Commands</big>'''
 +
 +
== GarageDoorControl ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.garageDoorControl</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "GarageDoorControl"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>door</code>''' - ENUM ["unknown", "open", "closing", "closed", "opening"]
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>close()</code>'''
 +
:'''<code>open()</code>'''
 +
 +
== HealthCheck ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.healthCheck</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "HealthCheck"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>checkInterval</code>''' - NUMBER
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>ping()</code>'''
 +
 +
== HoldableButton ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.holdableButton</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "HoldableButton"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>held</code>''' - NUMBER
 +
 +
'''<big>Commands</big>'''
  
 
== IlluminanceMeasurement ==
 
== IlluminanceMeasurement ==
  
−
== TemperatureMeasurement ==
+
'''<big>Device Selector</big>'''
 +
:<code>capability.illuminanceMeasurement</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "IlluminanceMeasurement"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>illuminance</code>''' - NUMBER
 +
 
 +
'''<big>Commands</big>'''
 +
 
 +
== ImageCapture ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.imageCapture</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "ImageCapture"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>image</code>''' - STRING
 +
 
 +
'''<big>Commands</big>'''
 +
:'''<code>take()</code>'''
 +
 
 +
== Indicator ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.indicator</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Indicator"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>indicatorStatus</code>''' - ENUM ["never", "when on", "when off"]
 +
 
 +
'''<big>Commands</big>'''
 +
:'''<code>indicatorNever()</code>'''
 +
:'''<code>indicatorWhenOff()</code>'''
 +
:'''<code>indicatorWhenOn()</code>'''
 +
 
 +
== Initialize ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.initialize</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Initialize"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
 
 +
'''<big>Commands</big>'''
 +
:'''<code>initialize()</code>'''
 +
 
 +
== Light ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.light</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Light"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>switch</code>''' - ENUM ["on", "off"]
 +
 
 +
'''<big>Commands</big>'''
 +
:'''<code>off()</code>'''
 +
:'''<code>on()</code>'''
 +
 
 +
== LightEffects ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.lightEffects</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "LightEffects"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>effectName</code>''' - STRING
 +
:'''<code>lightEffects</code>''' - JSON_OBJECT
 +
 
 +
'''<big>Commands</big>'''
 +
:'''<code>setEffect(effectnumber)</code>'''
 +
::''effectnumber'' required (NUMBER) - Effect number to enable
 +
:'''<code>setNextEffect()</code>'''
 +
:'''<code>setPreviousEffect()</code>'''
 +
 
 +
== LocationMode ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.locationMode</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "LocationMode"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>mode</code>''' - DYNAMIC_ENUM
 +
 
 +
'''<big>Commands</big>'''
 +
 
 +
== Lock ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.lock</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Lock"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>lock</code>''' - ENUM ["locked", "unlocked with timeout", "unlocked", "unknown"]
 +
 
 +
'''<big>Commands</big>'''
 +
:'''<code>lock()</code>'''
 +
:'''<code>unlock()</code>'''
 +
 
 +
== LockCodes ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.lockCodes</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "LockCodes"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>codeChanged</code>''' - ENUM ["added", "changed", "deleted", "failed"]
 +
:'''<code>codeLength</code>''' - NUMBER
 +
:'''<code>lockCodes</code>''' - JSON_OBJECT
 +
:'''<code>maxCodes</code>''' - NUMBER
 +
 
 +
'''<big>Commands</big>'''
 +
:'''<code>deleteCode(codeposition)</code>'''
 +
::''codeposition'' required (NUMBER) - Code position number to delete
 +
:'''<code>getCodes()</code>'''
 +
:'''<code>setCode(codeposition, pincode, name)</code>'''
 +
::''codeposition'' required (NUMBER) - Code position number
 +
::''pincode'' required (STRING) - Numeric PIN code
 +
::''name'' optional (STRING) - Name for this lock code
 +
:'''<code>setCodeLength(pincodelength)</code>'''
 +
::''pincodelength'' required (NUMBER) - Maximum pin code lentgh for this lock
 +
 
 +
== MediaController ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.mediaController</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "MediaController"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>activities</code>''' - JSON_OBJECT
 +
:'''<code>currentActivity</code>''' - STRING
 +
 
 +
'''<big>Commands</big>'''
 +
:'''<code>getAllActivities()</code>'''
 +
:'''<code>getCurrentActivity()</code>'''
 +
:'''<code>startActivity(activityname)</code>'''
 +
::''activityname'' required (STRING) - Name of media activity to start
 +
 
 +
== Momentary ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.momentary</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Momentary"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
 
 +
'''<big>Commands</big>'''
 +
:'''<code>push()</code>'''
 +
 
 +
== MotionSensor ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.motionSensor</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "MotionSensor"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>motion</code>''' - ENUM ["inactive", "active"]
 +
 
 +
'''<big>Commands</big>'''
 +
 
 +
== MusicPlayer ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.musicPlayer</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "MusicPlayer"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>level</code>''' - NUMBER
 +
:'''<code>mute</code>''' - ENUM ["unmuted", "muted"]
 +
:'''<code>status</code>''' - STRING
 +
:'''<code>trackData</code>''' - JSON_OBJECT
 +
:'''<code>trackDescription</code>''' - STRING
 +
 
 +
'''<big>Commands</big>'''
 +
:'''<code>mute()</code>'''
 +
:'''<code>nextTrack()</code>'''
 +
:'''<code>pause()</code>'''
 +
:'''<code>play()</code>'''
 +
:'''<code>playText(text)</code>'''
 +
::''text'' required (STRING) - Text to play
 +
:'''<code>playTrack(trackuri)</code>'''
 +
::''trackuri'' required (STRING) - URI/URL of track to play
 +
:'''<code>previousTrack()</code>'''
 +
:'''<code>restoreTrack(trackuri)</code>'''
 +
::''trackuri'' required (STRING) - URI/URL of track to restore
 +
:'''<code>resumeTrack(trackuri)</code>'''
 +
::''trackuri'' required (STRING) - URI/URL of track to play
 +
:'''<code>setLevel(volumelevel)</code>'''
 +
::''volumelevel'' required (NUMBER) - Volume level (0 to 100)
 +
:'''<code>setTrack(trackuri)</code>'''
 +
::''trackuri'' required (STRING) - URI/URL of track to set
 +
:'''<code>stop()</code>'''
 +
:'''<code>unmute()</code>'''
 +
 
 +
== Notification ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.notification</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Notification"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
 
 +
'''<big>Commands</big>'''
 +
:'''<code>deviceNotification(text)</code>'''
 +
::''text'' required (STRING) - Notification text
 +
 
 +
== Outlet ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.outlet</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Outlet"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>switch</code>''' - ENUM ["on", "off"]
 +
 
 +
'''<big>Commands</big>'''
 +
:'''<code>off()</code>'''
 +
:'''<code>on()</code>'''
 +
 
 +
== Polling ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.polling</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Polling"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
 
 +
'''<big>Commands</big>'''
 +
:'''<code>poll()</code>'''
 +
 
 +
== PowerMeter ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.powerMeter</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "PowerMeter"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>power</code>''' - NUMBER
 +
 
 +
'''<big>Commands</big>'''
 +
 
 +
== PowerSource ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.powerSource</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "PowerSource"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>powerSource</code>''' - ENUM ["battery", "dc", "mains", "unknown"]
 +
 
 +
'''<big>Commands</big>'''
 +
 
 +
== PresenceSensor ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.presenceSensor</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "PresenceSensor"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>presence</code>''' - ENUM ["present", "not present"]
 +
 
 +
'''<big>Commands</big>'''
 +
 
 +
== PressureMeasurement ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.pressureMeasurement</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "PressureMeasurement"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>pressure</code>''' - NUMBER
 +
 
 +
'''<big>Commands</big>'''
 +
 
 +
== PushableButton ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.pushableButton</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "PushableButton"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>numberOfButtons</code>''' - NUMBER
 +
:'''<code>pushed</code>''' - NUMBER
 +
 
 +
'''<big>Commands</big>'''
 +
 
 +
== Refresh ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.refresh</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Refresh"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
 
 +
'''<big>Commands</big>'''
 +
:'''<code>refresh()</code>'''
 +
 
 +
== RelativeHumidityMeasurement ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.relativeHumidityMeasurement</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "RelativeHumidityMeasurement"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>humidity</code>''' - NUMBER
 +
 
 +
'''<big>Commands</big>'''
 +
 
 +
== RelaySwitch ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.relaySwitch</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "RelaySwitch"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>switch</code>''' - ENUM ["on", "off"]
 +
 
 +
'''<big>Commands</big>'''
 +
:'''<code>off()</code>'''
 +
:'''<code>on()</code>'''
 +
 
 +
== ReleasableButton ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.releasableButton</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "ReleasableButton"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>released</code>''' - NUMBER
 +
 
 +
'''<big>Commands</big>'''
 +
 
 +
== SamsungTV ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.samsungTV</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "SamsungTV"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>messageButton</code>''' - JSON_OBJECT
 +
:'''<code>mute</code>''' - ENUM ["muted", "unknown", "unmuted"]
 +
:'''<code>pictureMode</code>''' - ENUM ["unknown", "standard", "movie", "dynamic"]
 +
:'''<code>soundMode</code>''' - ENUM ["speech", "movie", "unknown", "standard", "music"]
 +
:'''<code>switch</code>''' - ENUM ["on", "off"]
 +
:'''<code>volume</code>''' - NUMBER
 +
 
 +
'''<big>Commands</big>'''
 +
:'''<code>mute()</code>'''
 +
:'''<code>off()</code>'''
 +
:'''<code>on()</code>'''
 +
:'''<code>setPictureMode(ENUM)</code>'''
 +
::''ENUM''  (ENUM) - ENUM
 +
:'''<code>setSoundMode(ENUM)</code>'''
 +
::''ENUM''  (ENUM) - ENUM
 +
:'''<code>setVolume(NUMBER)</code>'''
 +
::''NUMBER''  (NUMBER) - NUMBER
 +
:'''<code>showMessage(STRING, STRING, STRING, STRING)</code>'''
 +
::''STRING''  (STRING) - STRING
 +
::''STRING''  (STRING) - STRING
 +
::''STRING''  (STRING) - STRING
 +
::''STRING''  (STRING) - STRING
 +
:'''<code>unmute()</code>'''
 +
:'''<code>volumeDown()</code>'''
 +
:'''<code>volumeUp()</code>'''
 +
 
 +
== SecurityKeypad ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.securityKeypad</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "SecurityKeypad"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>codeChanged</code>''' - ENUM ["added", "changed", "deleted", "failed"]
 +
:'''<code>codeLength</code>''' - NUMBER
 +
:'''<code>lockCodes</code>''' - JSON_OBJECT
 +
:'''<code>maxCodes</code>''' - NUMBER
 +
:'''<code>securityKeypad</code>''' - ENUM ["disarmed", "armed home", "armed away", "unknown"]
 +
 
 +
'''<big>Commands</big>'''
 +
:'''<code>armAway()</code>'''
 +
:'''<code>armHome()</code>'''
 +
:'''<code>deleteCode(codeposition)</code>'''
 +
::''codeposition'' required (NUMBER) - Code position number to delete
 +
:'''<code>disarm()</code>'''
 +
:'''<code>getCodes()</code>'''
 +
:'''<code>setCode(codeposition, pincode, name)</code>'''
 +
::''codeposition'' required (NUMBER) - Code position number
 +
::''pincode'' required (STRING) - Numeric PIN code
 +
::''name'' optional (STRING) - Name for this lock code
 +
:'''<code>setCodeLength(pincodelength)</code>'''
 +
::''pincodelength'' required (NUMBER) - Maximum pin code lentgh for this keypad
 +
:'''<code>setEntryDelay(entrancedelay)</code>'''
 +
::''entrancedelay'' required (NUMBER) - Entrance delay in seconds
 +
:'''<code>setExitDelay(exitdelay)</code>'''
 +
::''exitdelay'' required (NUMBER) - Exit delay in seconds
 +
 
 +
== Sensor ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.sensor</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Sensor"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
 
 +
'''<big>Commands</big>'''
 +
 
 +
== ShockSensor ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.shockSensor</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "ShockSensor"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>shock</code>''' - ENUM ["clear", "detected"]
 +
 
 +
'''<big>Commands</big>'''
 +
 
 +
== SignalStrength ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.signalStrength</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "SignalStrength"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>lqi</code>''' - NUMBER
 +
:'''<code>rssi</code>''' - NUMBER
 +
 
 +
'''<big>Commands</big>'''
 +
 
 +
== SleepSensor ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.sleepSensor</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "SleepSensor"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>sleeping</code>''' - ENUM ["not sleeping", "sleeping"]
 +
 
 +
'''<big>Commands</big>'''
 +
 
 +
== SmokeDetector ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.smokeDetector</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "SmokeDetector"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>smoke</code>''' - ENUM ["clear", "tested", "detected"]
 +
 
 +
'''<big>Commands</big>'''
 +
 
 +
== SoundPressureLevel ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.soundPressureLevel</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "SoundPressureLevel"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>soundPressureLevel</code>''' - NUMBER
 +
 
 +
'''<big>Commands</big>'''
 +
 
 +
== SoundSensor ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.soundSensor</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "SoundSensor"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>sound</code>''' - ENUM ["detected", "not detected"]
 +
 
 +
'''<big>Commands</big>'''
 +
 
 +
== SpeechRecognition ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.speechRecognition</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "SpeechRecognition"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>phraseSpoken</code>''' - STRING
 +
 
 +
'''<big>Commands</big>'''
 +
 
 +
== SpeechSynthesis ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.speechSynthesis</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "SpeechSynthesis"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
 
 +
'''<big>Commands</big>'''
 +
:'''<code>speak(text)</code>'''
 +
::''text'' required (STRING) - Text to speak
 +
 
 +
== StepSensor ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.stepSensor</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "StepSensor"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>goal</code>''' - NUMBER
 +
:'''<code>steps</code>''' - NUMBER
 +
 
 +
'''<big>Commands</big>'''
 +
 
 +
== Switch ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.switch</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Switch"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>switch</code>''' - ENUM ["on", "off"]
 +
 
 +
'''<big>Commands</big>'''
 +
:'''<code>off()</code>'''
 +
:'''<code>on()</code>'''
  
 
== SwitchLevel ==
 
== SwitchLevel ==
  
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.switchLevel</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "SwitchLevel"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>level</code>''' - NUMBER
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>setLevel(level, duration)</code>'''
 +
::''level'' required (NUMBER) - Level to set (0 to 100)
 +
::''duration'' optional (NUMBER) - Transition duration in seconds
 +
 +
== TV ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.tv</code>
 
'''<big>Driver Definition</big>'''
 
'''<big>Driver Definition</big>'''
−
:<code>capability "Switch Level"</code>
+
:<code>capability "TV"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>channel</code>''' - NUMBER
 +
:'''<code>movieMode</code>''' - STRING
 +
:'''<code>picture</code>''' - STRING
 +
:'''<code>power</code>''' - STRING
 +
:'''<code>sound</code>''' - STRING
 +
:'''<code>volume</code>''' - NUMBER
 +
 
 +
'''<big>Commands</big>'''
 +
:'''<code>channelDown()</code>'''
 +
:'''<code>channelUp()</code>'''
 +
:'''<code>volumeDown()</code>'''
 +
:'''<code>volumeUp()</code>'''
 +
 
 +
== TamperAlert ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.tamperAlert</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "TamperAlert"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>tamper</code>''' - ENUM ["clear", "detected"]
 +
 
 +
'''<big>Commands</big>'''
 +
 
 +
== Telnet ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.telnet</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Telnet"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
 
 +
'''<big>Commands</big>'''
 +
 
 +
== TemperatureMeasurement ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.temperatureMeasurement</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "TemperatureMeasurement"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>temperature</code>''' - NUMBER
 +
 
 +
'''<big>Commands</big>'''
 +
 
 +
== TestCapability ==
  
 
'''<big>Device Selector</big>'''
 
'''<big>Device Selector</big>'''
−
:<code>capability.switchLevel</code>
+
:<code>capability.testCapability</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "TestCapability"</code>
  
 
'''<big>Attributes</big>'''
 
'''<big>Attributes</big>'''
−
: '''<code>level</code>''' - NUMBER
 
  
 
'''<big>Commands</big>'''
 
'''<big>Commands</big>'''
−
:'''<code>setLevel(Level, Duration)</code>'''
 
−
:: ''Level'' (NUMBER) - Level to set (0 to 100)
 
−
:: ''Duration'' (NUMBER) - Transition duration in seconds
 
  
 
== Thermostat ==
 
== Thermostat ==
 +
 
'''<big>Device Selector</big>'''
 
'''<big>Device Selector</big>'''
−
 
+
:<code>capability.thermostat</code>
−
<code>capability.thermostat</code>
+
'''<big>Driver Definition</big>'''
 +
:<code>capability "Thermostat"</code>
  
 
'''<big>Attributes</big>'''
 
'''<big>Attributes</big>'''
−
:'''<code>temperature</code>''' - NUMBER
+
:'''<code>coolingSetpoint</code>''' - NUMBER  
−
:'''<code>heatingSetpoint</code>''' - NUMBER
+
:'''<code>heatingSetpoint</code>''' - NUMBER  
−
:'''<code>coolingSetpoint</code>''' - NUMBER
+
:'''<code>schedule</code>''' - JSON_OBJECT
−
:'''<code>thermostatSetpoint</code>''' - NUMBER
+
:'''<code>supportedThermostatFanModes</code>''' - ENUM ["on", "circulate", "auto"]
 +
:'''<code>supportedThermostatModes</code>''' - ENUM ["auto", "off", "heat", "emergency heat", "cool"]
 +
:'''<code>temperature</code>''' - NUMBER  
 +
:'''<code>thermostatFanMode</code>''' - ENUM ["on", "circulate", "auto"]
 
:'''<code>thermostatMode</code>''' - ENUM ["auto", "off", "heat", "emergency heat", "cool"]
 
:'''<code>thermostatMode</code>''' - ENUM ["auto", "off", "heat", "emergency heat", "cool"]
−
:'''<code>thermostatFanMode</code>''' - ENUM ["on", "circulate", "auto"]
 
 
:'''<code>thermostatOperatingState</code>''' - ENUM ["heating", "pending cool", "pending heat", "vent economizer", "idle", "cooling", "fan only"]
 
:'''<code>thermostatOperatingState</code>''' - ENUM ["heating", "pending cool", "pending heat", "vent economizer", "idle", "cooling", "fan only"]
−
:'''<code>schedule</code>''' - JSON_OBJECT
+
:'''<code>thermostatSetpoint</code>''' - NUMBER
−
:'''<code>supportedThermostatModes</code>''' - ENUM ["auto", "off", "heat", "emergency heat", "cool"]
 
−
:'''<code>supportedThermostatFanModes</code>''' - ENUM ["on", "circulate", "auto"]
 
  
 
'''<big>Commands</big>'''
 
'''<big>Commands</big>'''
−
:'''<code>setHeatingSetpoint(Temperature)</code>'''
+
:'''<code>auto()</code>'''
−
::''Temperature'' (NUMBER) - Heating setpoint in degrees
+
:'''<code>cool()</code>'''
−
:'''<code>setCoolingSetpoint(Temperature)</code>'''
 
−
::''Temperature'' (NUMBER) - Cooling setpoint in degrees
 
−
:'''<code>off()</code>'''
 
−
:'''<code>heat()</code>'''
 
 
:'''<code>emergencyHeat()</code>'''
 
:'''<code>emergencyHeat()</code>'''
−
:'''<code>cool()</code>'''
+
:'''<code>fanAuto()</code>'''
−
:'''<code>setThermostatMode(Thermostat mode)</code>'''
+
:'''<code>fanCirculate()</code>'''
−
::''Thermostat mode'' (ENUM) ["auto", "off", "heat", "emergency heat", "cool"] - Thermostat mode to set
 
 
:'''<code>fanOn()</code>'''
 
:'''<code>fanOn()</code>'''
 +
:'''<code>heat()</code>'''
 +
:'''<code>off()</code>'''
 +
:'''<code>setCoolingSetpoint(temperature)</code>'''
 +
::''temperature'' required (NUMBER) - Cooling setpoint in degrees
 +
:'''<code>setHeatingSetpoint(temperature)</code>'''
 +
::''temperature'' required (NUMBER) - Heating setpoint in degrees
 +
:'''<code>setSchedule(JSON_OBJECT)</code>'''
 +
::''JSON_OBJECT''  (JSON_OBJECT) - JSON_OBJECT
 +
:'''<code>setThermostatFanMode(fanmode)</code>'''
 +
::''fanmode'' required (ENUM) - Fan mode to set
 +
:'''<code>setThermostatMode(thermostatmode)</code>'''
 +
::''thermostatmode'' required (ENUM) - Thermostat mode to set
 +
 +
== ThermostatCoolingSetpoint ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.thermostatCoolingSetpoint</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "ThermostatCoolingSetpoint"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>coolingSetpoint</code>''' - NUMBER
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>setCoolingSetpoint(temperature)</code>'''
 +
::''temperature'' required (NUMBER) - Cooling setpoint in degrees
 +
 +
== ThermostatFanMode ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.thermostatFanMode</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "ThermostatFanMode"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>thermostatFanMode</code>''' - ENUM ["auto", "circulate", "on"]
 +
 +
'''<big>Commands</big>'''
 
:'''<code>fanAuto()</code>'''
 
:'''<code>fanAuto()</code>'''
 
:'''<code>fanCirculate()</code>'''
 
:'''<code>fanCirculate()</code>'''
−
:'''<code>setThermostatFanMode(Fan mode)</code>'''
+
:'''<code>fanOn()</code>'''
−
::''Fan mode'' (ENUM) ["on", "circulate", "auto"] - Fan mode to set
+
:'''<code>setThermostatFanMode(fanmode)</code>'''
 +
::''fanmode'' required (ENUM) - Fan mode to set
 +
 
 +
== ThermostatHeatingSetpoint ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.thermostatHeatingSetpoint</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "ThermostatHeatingSetpoint"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>heatingSetpoint</code>''' - NUMBER
 +
 
 +
'''<big>Commands</big>'''
 +
:'''<code>setHeatingSetpoint(temperature)</code>'''
 +
::''temperature'' required (NUMBER) - Heating setpoint in degrees
 +
 
 +
== ThermostatMode ==
 +
 
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.thermostatMode</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "ThermostatMode"</code>
 +
 
 +
'''<big>Attributes</big>'''
 +
:'''<code>thermostatMode</code>''' - ENUM ["heat", "cool", "emergency heat", "auto", "off"]
 +
 
 +
'''<big>Commands</big>'''
 
:'''<code>auto()</code>'''
 
:'''<code>auto()</code>'''
 +
:'''<code>cool()</code>'''
 +
:'''<code>emergencyHeat()</code>'''
 +
:'''<code>heat()</code>'''
 +
:'''<code>off()</code>'''
 +
:'''<code>setThermostatMode(thermostatmode)</code>'''
 +
::''thermostatmode'' required (ENUM) - Thermostat mode to set
 +
 +
== ThermostatOperatingState ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.thermostatOperatingState</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "ThermostatOperatingState"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>thermostatOperatingState</code>''' - ENUM ["vent economizer", "pending cool", "cooling", "heating", "pending heat", "fan only", "idle"]
 +
 +
'''<big>Commands</big>'''
 +
 +
== ThermostatSchedule ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.thermostatSchedule</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "ThermostatSchedule"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>schedule</code>''' - JSON_OBJECT
 +
 +
'''<big>Commands</big>'''
 
:'''<code>setSchedule(JSON_OBJECT)</code>'''
 
:'''<code>setSchedule(JSON_OBJECT)</code>'''
 +
::''JSON_OBJECT''  (JSON_OBJECT) - JSON_OBJECT
 +
 +
== ThermostatSetpoint ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.thermostatSetpoint</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "ThermostatSetpoint"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>thermostatSetpoint</code>''' - NUMBER
 +
 +
'''<big>Commands</big>'''
 +
 +
== ThreeAxis ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.threeAxis</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "ThreeAxis"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>threeAxis</code>''' - VECTOR3
 +
 +
'''<big>Commands</big>'''
 +
 +
== TimedSession ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.timedSession</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "TimedSession"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>sessionStatus</code>''' - ENUM ["stopped", "canceled", "running", "paused"]
 +
:'''<code>timeRemaining</code>''' - NUMBER
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>cancel()</code>'''
 +
:'''<code>pause()</code>'''
 +
:'''<code>setTimeRemaining(NUMBER)</code>'''
 +
::''NUMBER''  (NUMBER) - NUMBER
 +
:'''<code>start()</code>'''
 +
:'''<code>stop()</code>'''
 +
 +
== Tone ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.tone</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Tone"</code>
 +
 +
'''<big>Attributes</big>'''
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>beep()</code>'''
 +
 +
== TouchSensor ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.touchSensor</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "TouchSensor"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>touch</code>''' - ENUM ["touched"]
 +
 +
'''<big>Commands</big>'''
 +
 +
== UltravioletIndex ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.ultravioletIndex</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "UltravioletIndex"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>ultravioletIndex</code>''' - NUMBER
 +
 +
'''<big>Commands</big>'''
 +
 +
== Valve ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.valve</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "Valve"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>valve</code>''' - ENUM ["open", "closed"]
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>close()</code>'''
 +
:'''<code>open()</code>'''
 +
 +
== VideoCamera ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.videoCapture</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "VideoCamera"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>camera</code>''' - ENUM ["on", "off", "restarting", "unavailable"]
 +
:'''<code>mute</code>''' - ENUM ["unmuted", "muted"]
 +
:'''<code>settings</code>''' - JSON_OBJECT
 +
:'''<code>statusMessage</code>''' - STRING
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>flip()</code>'''
 +
:'''<code>mute()</code>'''
 +
:'''<code>off()</code>'''
 +
:'''<code>on()</code>'''
 +
:'''<code>unmute()</code>'''
 +
 +
== VideoCapture ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.videoCapture</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "VideoCapture"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>clip</code>''' - JSON_OBJECT
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>capture(DATE, DATE, DATE)</code>'''
 +
::''DATE''  (DATE) - DATE
 +
::''DATE''  (DATE) - DATE
 +
::''DATE''  (DATE) - DATE
 +
 +
== VoltageMeasurement ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.voltageMeasurement</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "VoltageMeasurement"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>voltage</code>''' - NUMBER
 +
 +
'''<big>Commands</big>'''
 +
 +
== WaterSensor ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.waterSensor</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "WaterSensor"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>water</code>''' - ENUM ["wet", "dry"]
 +
 +
'''<big>Commands</big>'''
 +
 +
== WindowShade ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.windowShade</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "WindowShade"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>position</code>''' - NUMBER
 +
:'''<code>position</code>''' - NUMBER
 +
:'''<code>windowShade</code>''' - ENUM ["opening", "partially open", "closed", "open", "closing", "unknown"]
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>close()</code>'''
 +
:'''<code>open()</code>'''
 +
:'''<code>setPosition(position)</code>'''
 +
::''position'' required (NUMBER) - Shade position (0 to 100)
 +
 +
== ZwMultichannel ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.zwMultichannel</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "ZwMultichannel"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>epEvent</code>''' - STRING
 +
:'''<code>epInfo</code>''' - STRING
 +
 +
'''<big>Commands</big>'''
 +
:'''<code>enableEpEvents(STRING)</code>'''
 +
::''STRING''  (STRING) - STRING
 +
:'''<code>epCmd(NUMBER, STRING)</code>'''
 +
::''NUMBER''  (NUMBER) - NUMBER
 +
::''STRING''  (STRING) - STRING
 +
 +
== pHMeasurement ==
 +
 +
'''<big>Device Selector</big>'''
 +
:<code>capability.pHMeasurement</code>
 +
'''<big>Driver Definition</big>'''
 +
:<code>capability "pHMeasurement"</code>
 +
 +
'''<big>Attributes</big>'''
 +
:'''<code>pH</code>''' - NUMBER
 +
 +
'''<big>Commands</big>'''

Revision as of 23:05, 7 January 2019

Capabilities that can be used in drivers

Contents

AccelerationSensor

Device Selector

capability.accelerationSensor

Driver Definition

capability "AccelerationSensor"

Attributes

acceleration - ENUM ["inactive", "active"]

Commands

Actuator

Device Selector

capability.actuator

Driver Definition

capability "Actuator"

Attributes

Commands

Alarm

Device Selector

capability.alarm

Driver Definition

capability "Alarm"

Attributes

alarm - ENUM ["strobe", "off", "both", "siren"]

Commands

both()
off()
siren()
strobe()

AudioNotification

Device Selector

capability.audioNotification

Driver Definition

capability "AudioNotification"

Attributes

Commands

playText(text, volumelevel)
text required (STRING) - Text to play
volumelevel optional (NUMBER) - Volume level (0 to 100)
playTextAndRestore(text, volumelevel)
text required (STRING) - Text to play
volumelevel optional (NUMBER) - Volume level (0 to 100)
playTextAndResume(text, volumelevel)
text required (STRING) - Text to play
volumelevel optional (NUMBER) - Volume level (0 to 100)
playTrack(trackuri, volumelevel)
trackuri required (STRING) - URI/URL of track to play
volumelevel optional (NUMBER) - Volume level (0 to 100)
playTrackAndRestore(trackuri, volumelevel)
trackuri required (STRING) - URI/URL of track to play
volumelevel optional (NUMBER) - Volume level (0 to 100)
playTrackAndResume(trackuri, volumelevel)
trackuri required (STRING) - URI/URL of track to play
volumelevel optional (NUMBER) - Volume level (0 to 100)

AudioVolume

Device Selector

capability.audioVolume

Driver Definition

capability "AudioVolume"

Attributes

mute - ENUM ["unmuted", "muted"]
volume - NUMBER

Commands

mute()
setVolume(volumelevel)
volumelevel required (NUMBER) - Volume level (0 to 100)
unmute()
volumeDown()
volumeUp()

Battery

Device Selector

capability.battery

Driver Definition

capability "Battery"

Attributes

battery - NUMBER

Commands

Beacon

Device Selector

capability.beacon

Driver Definition

capability "Beacon"

Attributes

presence - ENUM ["not present", "present"]

Commands

Bulb

Device Selector

capability.bulb

Driver Definition

capability "Bulb"

Attributes

switch - ENUM ["on", "off"]

Commands

off()
on()

Button

Device Selector

capability.button

Driver Definition

capability "Button"

Attributes

button - NUMBER
holdableButton - ENUM ["true", "false"]
numberOfButtons - NUMBER

Commands

CarbonDioxideMeasurement

Device Selector

capability.carbonDioxideMeasurement

Driver Definition

capability "CarbonDioxideMeasurement"

Attributes

carbonDioxide - NUMBER

Commands

CarbonMonoxideDetector

Device Selector

capability.carbonMonoxideDetector

Driver Definition

capability "CarbonMonoxideDetector"

Attributes

carbonMonoxide - ENUM ["detected", "tested", "clear"]

Commands

ChangeLevel

Device Selector

capability.changeLevel

Driver Definition

capability "ChangeLevel"

Attributes

Commands

startLevelChange(direction)
direction required (ENUM) - Direction for level change request
stopLevelChange()

Chime

Device Selector

capability.chime

Driver Definition

capability "Chime"

Attributes

soundEffects - JSON_OBJECT
soundName - STRING
status - ENUM ["playing", "stopped"]

Commands

playSound(soundnumber)
soundnumber required (NUMBER) - Sound number to play
stop()

ColorControl

Device Selector

capability.colorControl

Driver Definition

capability "ColorControl"

Attributes

RGB - STRING
color - STRING
colorName - STRING
hue - NUMBER
saturation - NUMBER

Commands

setColor(colormap)
colormap required (COLOR_MAP) - Color map settings [hue*:(0 to 100), saturation*:(0 to 100), level:(0 to 100)]
setHue(hue)
hue required (NUMBER) - Color Hue (0 to 100)
setSaturation(saturation)
saturation required (NUMBER) - Color Saturation (0 to 100)

ColorMode

Device Selector

capability.colorMode

Driver Definition

capability "ColorMode"

Attributes

colorMode - ENUM ["CT", "RGB"]

Commands

ColorTemperature

Device Selector

capability.colorTemperature

Driver Definition

capability "ColorTemperature"

Attributes

colorName - STRING
colorTemperature - NUMBER

Commands

setColorTemperature(colortemperature)
colortemperature required (NUMBER) - Color temperature in degrees Kelvin

Configuration

Device Selector

capability.configuration

Driver Definition

capability "Configuration"

Attributes

Commands

configure()

Consumable

Device Selector

capability.consumable

Driver Definition

capability "Consumable"

Attributes

consumableStatus - ENUM ["missing", "order", "maintenance_required", "good", "replace"]

Commands

setConsumableStatus(STRING)
STRING (STRING) - STRING

ContactSensor

Device Selector

capability.contactSensor

Driver Definition

capability "ContactSensor"

Attributes

contact - ENUM ["closed", "open"]

Commands

DoorControl

Device Selector

capability.doorControl

Driver Definition

capability "DoorControl"

Attributes

door - ENUM ["unknown", "closed", "open", "closing", "opening"]

Commands

close()
open()

DoubleTapableButton

Device Selector

capability.doubleTapableButton

Driver Definition

capability "DoubleTapableButton"

Attributes

doubleTapped - NUMBER

Commands

EnergyMeter

Device Selector

capability.energyMeter

Driver Definition

capability "EnergyMeter"

Attributes

energy - NUMBER

Commands

EstimatedTimeOfArrival

Device Selector

capability.estimatedTimeOfArrival

Driver Definition

capability "EstimatedTimeOfArrival"

Attributes

eta - DATE

Commands

FanControl

Device Selector

capability.fanControl

Driver Definition

capability "FanControl"

Attributes

speed - ENUM ["low","medium-low","medium","medium-high","high","on","off","auto"]

Commands

setSpeed(fanspeed)
fanspeed required (ENUM) - Fan speed to set

FilterStatus

Device Selector

capability.filterStatus

Driver Definition

capability "FilterStatus"

Attributes

filterStatus - ENUM ["normal", "replace"]

Commands

GarageDoorControl

Device Selector

capability.garageDoorControl

Driver Definition

capability "GarageDoorControl"

Attributes

door - ENUM ["unknown", "open", "closing", "closed", "opening"]

Commands

close()
open()

HealthCheck

Device Selector

capability.healthCheck

Driver Definition

capability "HealthCheck"

Attributes

checkInterval - NUMBER

Commands

ping()

HoldableButton

Device Selector

capability.holdableButton

Driver Definition

capability "HoldableButton"

Attributes

held - NUMBER

Commands

IlluminanceMeasurement

Device Selector

capability.illuminanceMeasurement

Driver Definition

capability "IlluminanceMeasurement"

Attributes

illuminance - NUMBER

Commands

ImageCapture

Device Selector

capability.imageCapture

Driver Definition

capability "ImageCapture"

Attributes

image - STRING

Commands

take()

Indicator

Device Selector

capability.indicator

Driver Definition

capability "Indicator"

Attributes

indicatorStatus - ENUM ["never", "when on", "when off"]

Commands

indicatorNever()
indicatorWhenOff()
indicatorWhenOn()

Initialize

Device Selector

capability.initialize

Driver Definition

capability "Initialize"

Attributes

Commands

initialize()

Light

Device Selector

capability.light

Driver Definition

capability "Light"

Attributes

switch - ENUM ["on", "off"]

Commands

off()
on()

LightEffects

Device Selector

capability.lightEffects

Driver Definition

capability "LightEffects"

Attributes

effectName - STRING
lightEffects - JSON_OBJECT

Commands

setEffect(effectnumber)
effectnumber required (NUMBER) - Effect number to enable
setNextEffect()
setPreviousEffect()

LocationMode

Device Selector

capability.locationMode

Driver Definition

capability "LocationMode"

Attributes

mode - DYNAMIC_ENUM

Commands

Lock

Device Selector

capability.lock

Driver Definition

capability "Lock"

Attributes

lock - ENUM ["locked", "unlocked with timeout", "unlocked", "unknown"]

Commands

lock()
unlock()

LockCodes

Device Selector

capability.lockCodes

Driver Definition

capability "LockCodes"

Attributes

codeChanged - ENUM ["added", "changed", "deleted", "failed"]
codeLength - NUMBER
lockCodes - JSON_OBJECT
maxCodes - NUMBER

Commands

deleteCode(codeposition)
codeposition required (NUMBER) - Code position number to delete
getCodes()
setCode(codeposition, pincode, name)
codeposition required (NUMBER) - Code position number
pincode required (STRING) - Numeric PIN code
name optional (STRING) - Name for this lock code
setCodeLength(pincodelength)
pincodelength required (NUMBER) - Maximum pin code lentgh for this lock

MediaController

Device Selector

capability.mediaController

Driver Definition

capability "MediaController"

Attributes

activities - JSON_OBJECT
currentActivity - STRING

Commands

getAllActivities()
getCurrentActivity()
startActivity(activityname)
activityname required (STRING) - Name of media activity to start

Momentary

Device Selector

capability.momentary

Driver Definition

capability "Momentary"

Attributes

Commands

push()

MotionSensor

Device Selector

capability.motionSensor

Driver Definition

capability "MotionSensor"

Attributes

motion - ENUM ["inactive", "active"]

Commands

MusicPlayer

Device Selector

capability.musicPlayer

Driver Definition

capability "MusicPlayer"

Attributes

level - NUMBER
mute - ENUM ["unmuted", "muted"]
status - STRING
trackData - JSON_OBJECT
trackDescription - STRING

Commands

mute()
nextTrack()
pause()
play()
playText(text)
text required (STRING) - Text to play
playTrack(trackuri)
trackuri required (STRING) - URI/URL of track to play
previousTrack()
restoreTrack(trackuri)
trackuri required (STRING) - URI/URL of track to restore
resumeTrack(trackuri)
trackuri required (STRING) - URI/URL of track to play
setLevel(volumelevel)
volumelevel required (NUMBER) - Volume level (0 to 100)
setTrack(trackuri)
trackuri required (STRING) - URI/URL of track to set
stop()
unmute()

Notification

Device Selector

capability.notification

Driver Definition

capability "Notification"

Attributes

Commands

deviceNotification(text)
text required (STRING) - Notification text

Outlet

Device Selector

capability.outlet

Driver Definition

capability "Outlet"

Attributes

switch - ENUM ["on", "off"]

Commands

off()
on()

Polling

Device Selector

capability.polling

Driver Definition

capability "Polling"

Attributes

Commands

poll()

PowerMeter

Device Selector

capability.powerMeter

Driver Definition

capability "PowerMeter"

Attributes

power - NUMBER

Commands

PowerSource

Device Selector

capability.powerSource

Driver Definition

capability "PowerSource"

Attributes

powerSource - ENUM ["battery", "dc", "mains", "unknown"]

Commands

PresenceSensor

Device Selector

capability.presenceSensor

Driver Definition

capability "PresenceSensor"

Attributes

presence - ENUM ["present", "not present"]

Commands

PressureMeasurement

Device Selector

capability.pressureMeasurement

Driver Definition

capability "PressureMeasurement"

Attributes

pressure - NUMBER

Commands

PushableButton

Device Selector

capability.pushableButton

Driver Definition

capability "PushableButton"

Attributes

numberOfButtons - NUMBER
pushed - NUMBER

Commands

Refresh

Device Selector

capability.refresh

Driver Definition

capability "Refresh"

Attributes

Commands

refresh()

RelativeHumidityMeasurement

Device Selector

capability.relativeHumidityMeasurement

Driver Definition

capability "RelativeHumidityMeasurement"

Attributes

humidity - NUMBER

Commands

RelaySwitch

Device Selector

capability.relaySwitch

Driver Definition

capability "RelaySwitch"

Attributes

switch - ENUM ["on", "off"]

Commands

off()
on()

ReleasableButton

Device Selector

capability.releasableButton

Driver Definition

capability "ReleasableButton"

Attributes

released - NUMBER

Commands

SamsungTV

Device Selector

capability.samsungTV

Driver Definition

capability "SamsungTV"

Attributes

messageButton - JSON_OBJECT
mute - ENUM ["muted", "unknown", "unmuted"]
pictureMode - ENUM ["unknown", "standard", "movie", "dynamic"]
soundMode - ENUM ["speech", "movie", "unknown", "standard", "music"]
switch - ENUM ["on", "off"]
volume - NUMBER

Commands

mute()
off()
on()
setPictureMode(ENUM)
ENUM (ENUM) - ENUM
setSoundMode(ENUM)
ENUM (ENUM) - ENUM
setVolume(NUMBER)
NUMBER (NUMBER) - NUMBER
showMessage(STRING, STRING, STRING, STRING)
STRING (STRING) - STRING
STRING (STRING) - STRING
STRING (STRING) - STRING
STRING (STRING) - STRING
unmute()
volumeDown()
volumeUp()

SecurityKeypad

Device Selector

capability.securityKeypad

Driver Definition

capability "SecurityKeypad"

Attributes

codeChanged - ENUM ["added", "changed", "deleted", "failed"]
codeLength - NUMBER
lockCodes - JSON_OBJECT
maxCodes - NUMBER
securityKeypad - ENUM ["disarmed", "armed home", "armed away", "unknown"]

Commands

armAway()
armHome()
deleteCode(codeposition)
codeposition required (NUMBER) - Code position number to delete
disarm()
getCodes()
setCode(codeposition, pincode, name)
codeposition required (NUMBER) - Code position number
pincode required (STRING) - Numeric PIN code
name optional (STRING) - Name for this lock code
setCodeLength(pincodelength)
pincodelength required (NUMBER) - Maximum pin code lentgh for this keypad
setEntryDelay(entrancedelay)
entrancedelay required (NUMBER) - Entrance delay in seconds
setExitDelay(exitdelay)
exitdelay required (NUMBER) - Exit delay in seconds

Sensor

Device Selector

capability.sensor

Driver Definition

capability "Sensor"

Attributes

Commands

ShockSensor

Device Selector

capability.shockSensor

Driver Definition

capability "ShockSensor"

Attributes

shock - ENUM ["clear", "detected"]

Commands

SignalStrength

Device Selector

capability.signalStrength

Driver Definition

capability "SignalStrength"

Attributes

lqi - NUMBER
rssi - NUMBER

Commands

SleepSensor

Device Selector

capability.sleepSensor

Driver Definition

capability "SleepSensor"

Attributes

sleeping - ENUM ["not sleeping", "sleeping"]

Commands

SmokeDetector

Device Selector

capability.smokeDetector

Driver Definition

capability "SmokeDetector"

Attributes

smoke - ENUM ["clear", "tested", "detected"]

Commands

SoundPressureLevel

Device Selector

capability.soundPressureLevel

Driver Definition

capability "SoundPressureLevel"

Attributes

soundPressureLevel - NUMBER

Commands

SoundSensor

Device Selector

capability.soundSensor

Driver Definition

capability "SoundSensor"

Attributes

sound - ENUM ["detected", "not detected"]

Commands

SpeechRecognition

Device Selector

capability.speechRecognition

Driver Definition

capability "SpeechRecognition"

Attributes

phraseSpoken - STRING

Commands

SpeechSynthesis

Device Selector

capability.speechSynthesis

Driver Definition

capability "SpeechSynthesis"

Attributes

Commands

speak(text)
text required (STRING) - Text to speak

StepSensor

Device Selector

capability.stepSensor

Driver Definition

capability "StepSensor"

Attributes

goal - NUMBER
steps - NUMBER

Commands

Switch

Device Selector

capability.switch

Driver Definition

capability "Switch"

Attributes

switch - ENUM ["on", "off"]

Commands

off()
on()

SwitchLevel

Device Selector

capability.switchLevel

Driver Definition

capability "SwitchLevel"

Attributes

level - NUMBER

Commands

setLevel(level, duration)
level required (NUMBER) - Level to set (0 to 100)
duration optional (NUMBER) - Transition duration in seconds

TV

Device Selector

capability.tv

Driver Definition

capability "TV"

Attributes

channel - NUMBER
movieMode - STRING
picture - STRING
power - STRING
sound - STRING
volume - NUMBER

Commands

channelDown()
channelUp()
volumeDown()
volumeUp()

TamperAlert

Device Selector

capability.tamperAlert

Driver Definition

capability "TamperAlert"

Attributes

tamper - ENUM ["clear", "detected"]

Commands

Telnet

Device Selector

capability.telnet

Driver Definition

capability "Telnet"

Attributes

Commands

TemperatureMeasurement

Device Selector

capability.temperatureMeasurement

Driver Definition

capability "TemperatureMeasurement"

Attributes

temperature - NUMBER

Commands

TestCapability

Device Selector

capability.testCapability

Driver Definition

capability "TestCapability"

Attributes

Commands

Thermostat

Device Selector

capability.thermostat

Driver Definition

capability "Thermostat"

Attributes

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

Commands

auto()
cool()
emergencyHeat()
fanAuto()
fanCirculate()
fanOn()
heat()
off()
setCoolingSetpoint(temperature)
temperature required (NUMBER) - Cooling setpoint in degrees
setHeatingSetpoint(temperature)
temperature required (NUMBER) - Heating setpoint in degrees
setSchedule(JSON_OBJECT)
JSON_OBJECT (JSON_OBJECT) - JSON_OBJECT
setThermostatFanMode(fanmode)
fanmode required (ENUM) - Fan mode to set
setThermostatMode(thermostatmode)
thermostatmode required (ENUM) - Thermostat mode to set

ThermostatCoolingSetpoint

Device Selector

capability.thermostatCoolingSetpoint

Driver Definition

capability "ThermostatCoolingSetpoint"

Attributes

coolingSetpoint - NUMBER

Commands

setCoolingSetpoint(temperature)
temperature required (NUMBER) - Cooling setpoint in degrees

ThermostatFanMode

Device Selector

capability.thermostatFanMode

Driver Definition

capability "ThermostatFanMode"

Attributes

thermostatFanMode - ENUM ["auto", "circulate", "on"]

Commands

fanAuto()
fanCirculate()
fanOn()
setThermostatFanMode(fanmode)
fanmode required (ENUM) - Fan mode to set

ThermostatHeatingSetpoint

Device Selector

capability.thermostatHeatingSetpoint

Driver Definition

capability "ThermostatHeatingSetpoint"

Attributes

heatingSetpoint - NUMBER

Commands

setHeatingSetpoint(temperature)
temperature required (NUMBER) - Heating setpoint in degrees

ThermostatMode

Device Selector

capability.thermostatMode

Driver Definition

capability "ThermostatMode"

Attributes

thermostatMode - ENUM ["heat", "cool", "emergency heat", "auto", "off"]

Commands

auto()
cool()
emergencyHeat()
heat()
off()
setThermostatMode(thermostatmode)
thermostatmode required (ENUM) - Thermostat mode to set

ThermostatOperatingState

Device Selector

capability.thermostatOperatingState

Driver Definition

capability "ThermostatOperatingState"

Attributes

thermostatOperatingState - ENUM ["vent economizer", "pending cool", "cooling", "heating", "pending heat", "fan only", "idle"]

Commands

ThermostatSchedule

Device Selector

capability.thermostatSchedule

Driver Definition

capability "ThermostatSchedule"

Attributes

schedule - JSON_OBJECT

Commands

setSchedule(JSON_OBJECT)
JSON_OBJECT (JSON_OBJECT) - JSON_OBJECT

ThermostatSetpoint

Device Selector

capability.thermostatSetpoint

Driver Definition

capability "ThermostatSetpoint"

Attributes

thermostatSetpoint - NUMBER

Commands

ThreeAxis

Device Selector

capability.threeAxis

Driver Definition

capability "ThreeAxis"

Attributes

threeAxis - VECTOR3

Commands

TimedSession

Device Selector

capability.timedSession

Driver Definition

capability "TimedSession"

Attributes

sessionStatus - ENUM ["stopped", "canceled", "running", "paused"]
timeRemaining - NUMBER

Commands

cancel()
pause()
setTimeRemaining(NUMBER)
NUMBER (NUMBER) - NUMBER
start()
stop()

Tone

Device Selector

capability.tone

Driver Definition

capability "Tone"

Attributes

Commands

beep()

TouchSensor

Device Selector

capability.touchSensor

Driver Definition

capability "TouchSensor"

Attributes

touch - ENUM ["touched"]

Commands

UltravioletIndex

Device Selector

capability.ultravioletIndex

Driver Definition

capability "UltravioletIndex"

Attributes

ultravioletIndex - NUMBER

Commands

Valve

Device Selector

capability.valve

Driver Definition

capability "Valve"

Attributes

valve - ENUM ["open", "closed"]

Commands

close()
open()

VideoCamera

Device Selector

capability.videoCapture

Driver Definition

capability "VideoCamera"

Attributes

camera - ENUM ["on", "off", "restarting", "unavailable"]
mute - ENUM ["unmuted", "muted"]
settings - JSON_OBJECT
statusMessage - STRING

Commands

flip()
mute()
off()
on()
unmute()

VideoCapture

Device Selector

capability.videoCapture

Driver Definition

capability "VideoCapture"

Attributes

clip - JSON_OBJECT

Commands

capture(DATE, DATE, DATE)
DATE (DATE) - DATE
DATE (DATE) - DATE
DATE (DATE) - DATE

VoltageMeasurement

Device Selector

capability.voltageMeasurement

Driver Definition

capability "VoltageMeasurement"

Attributes

voltage - NUMBER

Commands

WaterSensor

Device Selector

capability.waterSensor

Driver Definition

capability "WaterSensor"

Attributes

water - ENUM ["wet", "dry"]

Commands

WindowShade

Device Selector

capability.windowShade

Driver Definition

capability "WindowShade"

Attributes

position - NUMBER
position - NUMBER
windowShade - ENUM ["opening", "partially open", "closed", "open", "closing", "unknown"]

Commands

close()
open()
setPosition(position)
position required (NUMBER) - Shade position (0 to 100)

ZwMultichannel

Device Selector

capability.zwMultichannel

Driver Definition

capability "ZwMultichannel"

Attributes

epEvent - STRING
epInfo - STRING

Commands

enableEpEvents(STRING)
STRING (STRING) - STRING
epCmd(NUMBER, STRING)
NUMBER (NUMBER) - NUMBER
STRING (STRING) - STRING

pHMeasurement

Device Selector

capability.pHMeasurement

Driver Definition

capability "pHMeasurement"

Attributes

pH - NUMBER

Commands

Retrieved from "https://docs.hubitat.com/index.php?title=Driver_Capability_List&oldid=1487"