Difference between revisions of "Driver Capability List"

From Hubitat Documentation
Jump to: navigation, search
m (CarbonMonoxideDetector: removed extraneous space)
(Replaced content with " <big>'''We're moving!''' Please visit http://docs2.hubitat.com for the latest documentation.</big> <big> This document is available at: http://docs2.hubitat.com/en/devel...")
(Tag: Replaced)
 
Line 1: Line 1:
{{Top}}
 
Capabilities that can be used in drivers
 
  
== AccelerationSensor ==
+
<big>'''We're moving!''' Please visit http://docs2.hubitat.com for the latest documentation.</big>
  
'''<big>Device Selector</big>'''
+
<big>
:<code>capability.accelerationSensor</code>
+
This document is available at: http://docs2.hubitat.com/en/developer/driver/capability-list
'''<big>Driver Definition</big>'''
+
</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>'''
 
 
 
== AirQuality ==
 
 
 
'''<big>Device Selector</big>'''
 
:<code>capability.airQuality</code>
 
'''<big>Driver Definition</big>'''
 
:<code>capability "AirQuality"</code>
 
 
 
'''<big>Attributes</big>'''
 
:'''<code>airQualityIndex</code>''' - NUMBER, range:0..500
 
 
 
'''<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, unit:%
 
 
 
'''<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, unit:%
 
 
 
'''<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 (Deprecated) ==
 
 
 
'''<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, unit:ppm
 
 
 
'''<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 ["clear", "tested", "detected"]
 
 
 
'''<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, unit:%
 
 
 
'''<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", "EFFECTS"]
 
 
 
'''<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, unit:°K
 
 
 
'''<big>Commands</big>'''
 
:'''<code>setColorTemperature(colortemperature, level, transitionTime)</code>'''
 
::''colortemperature'' required (NUMBER) - Color temperature in degrees Kelvin
 
::''level'' optional (NUMBER) - level to set
 
::''transitionTime'' optional (NUMBER) - transition time to use in seconds
 
 
 
== 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>'''
 
 
 
== CurrentMeter ==
 
 
 
'''<big>Device Selector</big>'''
 
:<code>capability.currentMeter</code>
 
'''<big>Driver Definition</big>'''
 
:<code>capability "CurrentMeter"</code>
 
 
 
'''<big>Attributes</big>'''
 
:'''<code>amperage</code>''' - NUMBER, unit:A
 
 
 
'''<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>'''
 
:'''<code>doubleTap(buttonNumber)</code>'''
 
::''buttonNumber'' required (NUMBER)
 
 
 
== EnergyMeter ==
 
 
 
'''<big>Device Selector</big>'''
 
:<code>capability.energyMeter</code>
 
'''<big>Driver Definition</big>'''
 
:<code>capability "EnergyMeter"</code>
 
 
 
'''<big>Attributes</big>'''
 
:'''<code>energy</code>''' - NUMBER, unit:kWh
 
 
 
'''<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"]
 
:'''<code>supportedFanSpeeds</code>''' - JSON_OBJECT
 
 
 
'''<big>Commands</big>'''
 
:'''<code>setSpeed(fanspeed)</code>'''
 
::''fanspeed'' required (ENUM) - Fan speed to set
 
:'''<code>cycleSpeed()</code>'''
 
 
 
== 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>'''
 
 
 
== Flash ==
 
 
 
'''<big>Device Selector</big>'''
 
:<code>capability.flash</code>
 
'''<big>Driver Definition</big>'''
 
:<code>capability "Flash"</code>
 
 
 
'''<big>Attributes</big>'''
 
 
 
'''<big>Commands</big>'''
 
:'''<code>flash(rateToFlash)</code>'''
 
::''rateToFlash'' optional (NUMBER) Rate to flash in ms
 
 
 
== 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>'''
 
 
 
== GasDetector ==
 
 
 
'''<big>Device Selector</big>'''
 
:<code>capability.gasDetector</code>
 
'''<big>Driver Definition</big>'''
 
:<code>capability "GasDetector"</code>
 
 
 
'''<big>Attributes</big>'''
 
:'''<code>naturalGas</code>''' - ENUM ["clear", "tested", "detected"]
 
 
 
'''<big>Commands</big>'''
 
 
 
== 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>'''
 
:'''<code>hold(buttonNumber)</code>'''
 
::''buttonNumber'' required (NUMBER)
 
 
 
== IlluminanceMeasurement ==
 
 
 
'''<big>Device Selector</big>'''
 
:<code>capability.illuminanceMeasurement</code>
 
'''<big>Driver Definition</big>'''
 
:<code>capability "IlluminanceMeasurement"</code>
 
 
 
'''<big>Attributes</big>'''
 
:'''<code>illuminance</code>''' - NUMBER, unit:lx
 
 
 
'''<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>'''
 
 
 
== LevelPreset ==
 
 
 
'''<big>Device Selector</big>'''
 
:<code>capability.levelPreset</code>
 
'''<big>Driver Definition</big>'''
 
:<code>capability "LevelPreset"</code>
 
 
 
'''<big>Attributes</big>'''
 
:'''<code>levelPreset</code>''' - NUMBER, unit:%, range:1..100
 
 
 
'''<big>Commands</big>'''
 
:'''<code>presetLevel(level)</code>'''
 
::''level'' required (NUMBER) - Level to preset (1 to 100)
 
 
 
== 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>'''
 
 
 
== LiquidFlowRate ==
 
 
 
'''<big>Device Selector</big>'''
 
:<code>capability.liquidFlowRate</code>
 
'''<big>Driver Definition</big>'''
 
:<code>capability "LiquidFlowRate"</code>
 
 
 
'''<big>Attributes</big>'''
 
:'''<code>rate</code>''' - NUMBER, unit:LPM || GPM
 
 
 
== 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
 
 
 
== MediaInputSource ==
 
 
 
'''<big>Device Selector</big>'''
 
:<code>capability.mediaInputSource</code>
 
'''<big>Driver Definition</big>'''
 
:<code>capability "MediaInputSource"</code>
 
 
 
'''<big>Attributes</big>'''
 
:'''<code>supportedInputs</code>''' - JSON_OBJECT
 
:'''<code>mediaInputSource</code>''' - STRING
 
 
 
'''<big>Commands</big>'''
 
:'''<code>setInputSource(inputName)</code>'''
 
::''inputName'' required (STRING) - Input to select
 
 
 
== MediaTransport ==
 
 
 
'''<big>Device Selector</big>'''
 
:<code>capability.mediaTransport</code>
 
'''<big>Driver Definition</big>'''
 
:<code>capability "MediaTransport"</code>
 
 
 
'''<big>Attributes</big>'''
 
:'''<code>transportStatus</code>''' - ENUM - ["playing", "paused", "stopped"]
 
 
 
'''<big>Commands</big>'''
 
:'''<code>play()</code>'''
 
:'''<code>pause()</code>'''
 
:'''<code>stop()</code>'''
 
 
 
== 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, unit:W
 
 
 
'''<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, unit: Pa || psi
 
 
 
'''<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>'''
 
:'''<code>push(buttonNumber)</code>'''
 
::''buttonNumber'' required (NUMBER)
 
 
 
== 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, unit:%rh
 
 
 
'''<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>'''
 
:'''<code>release(buttonNumber)</code>'''
 
::''buttonNumber'' required (NUMBER)
 
 
 
 
 
== 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, unit:dB
 
 
 
'''<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, volume, voice)</code>'''
 
::''text'' required (STRING) - Text to speak
 
::''volume'' optional (NUMBER)
 
::''voice'' optional (STRING) - AWS Polly voice name
 
 
 
== 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 ==
 
 
 
'''<big>Device Selector</big>'''
 
:<code>capability.switchLevel</code>
 
'''<big>Driver Definition</big>'''
 
:<code>capability "SwitchLevel"</code>
 
 
 
'''<big>Attributes</big>'''
 
:'''<code>level</code>''' - NUMBER, unit:%
 
 
 
'''<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>'''
 
:<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>'''
 
:'''<code>networkStatus</code>''' - ENUM ["online", "offline"]
 
'''<big>Commands</big>'''
 
:'''<code>sendMsg(message)</code>'''
 
::''message'' required (STRING) - Text message to send
 
 
 
== TemperatureMeasurement ==
 
 
 
'''<big>Device Selector</big>'''
 
:<code>capability.temperatureMeasurement</code>
 
'''<big>Driver Definition</big>'''
 
:<code>capability "TemperatureMeasurement"</code>
 
 
 
'''<big>Attributes</big>'''
 
:'''<code>temperature</code>''' - NUMBER, unit:°F || °C
 
 
 
'''<big>Commands</big>'''
 
 
 
== TestCapability ==
 
 
 
'''<big>Device Selector</big>'''
 
:<code>capability.testCapability</code>
 
'''<big>Driver Definition</big>'''
 
:<code>capability "TestCapability"</code>
 
 
 
'''<big>Attributes</big>'''
 
 
 
'''<big>Commands</big>'''
 
 
 
== Thermostat ==
 
 
 
'''<big>Device Selector</big>'''
 
:<code>capability.thermostat</code>
 
'''<big>Driver Definition</big>'''
 
:<code>capability "Thermostat"</code>
 
 
 
'''<big>Attributes</big>'''
 
:'''<code>coolingSetpoint</code>''' - NUMBER, unit:°F || °C 
 
:'''<code>heatingSetpoint</code>''' - NUMBER, unit:°F || °C 
 
:'''<code>schedule</code>''' - JSON_OBJECT '''(Deprecated)'''
 
:'''<code>supportedThermostatFanModes</code>''' - JSON_OBJECT
 
:'''<code>supportedThermostatModes</code>''' - JSON_OBJECT
 
:'''<code>temperature</code>''' - NUMBER, unit:°F || °C 
 
:'''<code>thermostatFanMode</code>''' - ENUM ["on", "circulate", "auto"]
 
:'''<code>thermostatMode</code>''' - ENUM ["auto", "off", "heat", "emergency heat", "cool"]
 
:'''<code>thermostatOperatingState</code>''' - ENUM ["heating", "pending cool", "pending heat", "vent economizer", "idle", "cooling", "fan only"]
 
:'''<code>thermostatSetpoint</code>''' - NUMBER, unit:°F || °C 
 
 
 
'''<big>Commands</big>'''
 
:'''<code>auto()</code>'''
 
:'''<code>cool()</code>'''
 
:'''<code>emergencyHeat()</code>'''
 
:'''<code>fanAuto()</code>'''
 
:'''<code>fanCirculate()</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>'''  '''(Deprecated)'''
 
::''JSON_OBJECT''  (JSON_OBJECT) - JSON_OBJECT  '''(Deprecated)'''
 
:'''<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, unit:°F || °C 
 
 
 
'''<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>fanCirculate()</code>'''
 
:'''<code>fanOn()</code>'''
 
:'''<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, unit:°F || °C 
 
 
 
'''<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>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>'''
 
::''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, unit:°F || °C 
 
 
 
'''<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>'''
 
 
 
== Variable ==
 
 
 
'''<big>Device Selector</big>'''
 
:<code>capability.variable</code>
 
'''<big>Driver Definition</big>'''
 
:<code>capability "Variable"</code>
 
 
 
'''<big>Attributes</big>'''
 
:'''<code>variable</code>''' - STRING
 
 
 
'''<big>Commands</big>'''
 
:'''<code>setVariable(valueToSet)</code>'''
 
::''valueToSet'' required (STRING)
 
 
 
== 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, unit:V
 
:'''<code>frequency</code>''' - NUMBER, unit:Hz
 
 
 
'''<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>'''
 
 
 
== WindowBlind ==
 
 
 
'''<big>Device Selector</big>'''
 
:<code>capability.windowBlind</code>
 
'''<big>Driver Definition</big>'''
 
:<code>capability "WindowBlind"</code>
 
 
 
'''<big>Attributes</big>'''
 
:'''<code>position</code>''' - NUMBER, unit:%
 
:'''<code>windowBlind</code>''' - ENUM ["opening", "partially open", "closed", "open", "closing", "unknown"]
 
:'''<code>tilt</code>''' - NUMBER, unit:%
 
 
 
'''<big>Commands</big>'''
 
:'''<code>close()</code>'''
 
:'''<code>open()</code>'''
 
:'''<code>setPosition(position)</code>'''
 
::''position'' required (NUMBER) - Shade position (0 to 100)
 
:'''<code>startPositionChange(direction)</code>'''
 
::''direction'' required (ENUM) - Direction for position change request ["open", "close"]
 
:'''<code>stopPositionChange()</code>'''
 
:'''<code>setTiltLevel(tilt)</code>'''
 
::''tilt'' required (NUMBER) - Tilt percent (0 to 100)
 
 
 
== WindowShade ==
 
 
 
'''<big>Device Selector</big>'''
 
:<code>capability.windowShade</code>
 
'''<big>Driver Definition</big>'''
 
:<code>capability "WindowShade"</code>
 
 
 
'''<big>Attributes</big>'''
 
:'''<code>position</code>''' - NUMBER, unit:%
 
:'''<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)
 
:'''<code>startPositionChange(direction)</code>'''
 
::''direction'' required (ENUM) - Direction for position change request ["open", "close"]
 
:'''<code>stopPositionChange()</code>'''
 
 
 
== 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>'''
 

Latest revision as of 04:04, 25 September 2022

We're moving! Please visit http://docs2.hubitat.com for the latest documentation.

This document is available at: http://docs2.hubitat.com/en/developer/driver/capability-list