Driver Capability List

Driver Capability List

Capabilities that can be used in drivers (or selected for in apps), along with any commands (methods) and attributes that they require.

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

AirQuality

Device Selector

capability.airQuality

Driver Definition

capability "AirQuality"

Attributes

airQualityIndex - NUMBER, range:0..500

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, unit:%

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, unit:%

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 (Deprecated)

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, unit:ppm

Commands

CarbonMonoxideDetector

Device Selector

capability.carbonMonoxideDetector

Driver Definition

capability "CarbonMonoxideDetector "

Attributes

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

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, unit:%

Commands

• setColor(colormap)
  • colormap required (COLOR_MAP) - Map of color settings in HSV/HSB format using keys hue, saturation, and (optionally) level:
    • hue: 0-100 (hue as percent)
    • saturation: 0-100 (saturation as percent)
    • level: 0-100 (brightness/value as pecent)
• 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", "EFFECTS"]

Commands

ColorTemperature

Device Selector

capability.colorTemperature

Driver Definition

capability "ColorTemperature"

Attributes

• colorName - STRING
• colorTemperature - NUMBER, unit:°K

Commands

• setColorTemperature(colortemperature, level, transitionTime)
  • colortemperature required (NUMBER) - Color temperature in degrees Kelvin
  • level optional (NUMBER) - level to set
  • transitionTime optional (NUMBER) - transition time to use in seconds

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

CurrentMeter

Device Selector

capability.currentMeter

Driver Definition

capability "CurrentMeter"

Attributes

• amperage - NUMBER, unit:A

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

• doubleTap(buttonNumber)
  • buttonNumber required (NUMBER)

EnergyMeter

Device Selector

capability.energyMeter

Driver Definition

capability "EnergyMeter"

Attributes

• energy - NUMBER, unit:kWh

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"]
• supportedFanSpeeds - JSON_OBJECT

Commands

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

FilterStatus

Device Selector

capability.filterStatus

Driver Definition

capability "FilterStatus"

Attributes

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

Commands

Flash

Device Selector

capability.flash

Driver Definition

capability "Flash"

Attributes

Commands

• flash(rateToFlash)
  • rateToFlash optional (NUMBER) Rate to flash in ms

GarageDoorControl

Device Selector

capability.garageDoorControl

Driver Definition

capability "GarageDoorControl"

Attributes

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

Commands

• close()
• open()

GasDetector

Device Selector

capability.gasDetector

Driver Definition

capability "GasDetector"

Attributes

• naturalGas - ENUM ["clear", "tested", "detected"]

Commands

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

• hold(buttonNumber)
  • buttonNumber required (NUMBER)

IlluminanceMeasurement

Device Selector

capability.illuminanceMeasurement

Driver Definition

capability "IlluminanceMeasurement"

Attributes

• illuminance - NUMBER, unit:lx

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() - this method will run on system start on devices using capability "Initialize" (one common use is re-establishing telnet, websocket, or similar LAN connections for such devices)

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()

LiquidFlowRate

Device Selector

capability.liquidFlowRate

Driver Definition

capability "LiquidFlowRate"

Attributes

• rate - NUMBER, unit:LPM || GPM

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

MediaInputSource

Device Selector

capability.mediaInputSource

Driver Definition

capability "MediaInputSource"

Attributes

• supportedInputs - JSON_OBJECT
• mediaInputSource - STRING

Commands

• setInputSource(inputName)
  • inputName required (STRING) - Input to select

MediaTransport

Device Selector

capability.mediaTransport

Driver Definition

capability "MediaTransport"

Attributes

transportStatus - ENUM - ["playing", "paused", "stopped"]

Commands

• play()
• pause()
• stop()

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, unit:W

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, unit: Pa || psi

Commands

PushableButton

Device Selector

capability.pushableButton

Driver Definition

capability "PushableButton"

Attributes

• numberOfButtons - NUMBER
• pushed - NUMBER

Commands

• push(buttonNumber)
  • buttonNumber required (NUMBER)

Refresh

Device Selector

capability.refresh

Driver Definition

capability "Refresh"

Attributes

Commands

refresh()

RelativeHumidityMeasurement

Device Selector

capability.relativeHumidityMeasurement

Driver Definition

capability "RelativeHumidityMeasurement"

Attributes

• humidity - NUMBER, unit:%rh

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

• release(buttonNumber)
  • buttonNumber required (NUMBER)

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, unit:dB

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, volume, voice)
  • text required (STRING) - Text to speak
  • volume optional (NUMBER)
  • voice optional (STRING) - AWS Polly voice name

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, unit:%

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

• networkStatus - ENUM ["online", "offline"]

Commands

• sendMsg(message)
  • message required (STRING) - Text message to send

TemperatureMeasurement

Device Selector

capability.temperatureMeasurement

Driver Definition

capability "TemperatureMeasurement"

Attributes

• temperature - NUMBER, unit:°F || °C

Commands

TestCapability

Device Selector

capability.testCapability

Driver Definition

capability "TestCapability"

Attributes

Commands

Thermostat

Device Selector

capability.thermostat

Driver Definition

capability "Thermostat"

Attributes

• coolingSetpoint - NUMBER, unit:°F || °C
• heatingSetpoint - NUMBER, unit:°F || °C
• schedule - JSON_OBJECT (Deprecated)
• supportedThermostatFanModes - JSON_OBJECT
• supportedThermostatModes - JSON_OBJECT
• temperature - NUMBER, unit:°F || °C
• 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, unit:°F || °C

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) (Deprecated)
  • JSON_OBJECT (JSON_OBJECT) - JSON_OBJECT (Deprecated)
• 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, unit:°F || °C

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, unit:°F || °C

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, unit:°F || °C

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()

Variable

Device Selector

capability.variable

Driver Definition

capability "Variable"

Attributes

• variable - STRING

Commands

• setVariable(valueToSet)
  • valueToSet required (STRING)

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, unit:V
• frequency - NUMBER, unit:Hz

Commands

WaterSensor

Device Selector

capability.waterSensor

Driver Definition

capability "WaterSensor"

Attributes

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

Commands

WindowBlind

Device Selector

capability.windowBlind

Driver Definition

capability "WindowBlind"

Attributes

• position - NUMBER, unit:%
• windowBlind - ENUM ["opening", "partially open", "closed", "open", "closing", "unknown"]
• tilt - NUMBER, unit:%

Commands

• close()
• open()
• setPosition(position)
  • position required (NUMBER) - Shade position (0 to 100)
• startPositionChange(direction)
  • direction required (ENUM) - Direction for position change request ["open", "close"]
• stopPositionChange()
• setTiltLevel(tilt)
  • tilt required (NUMBER) - Tilt percent (0 to 100)

WindowShade

Device Selector

capability.windowShade

Driver Definition

capability "WindowShade"

Attributes

• position - NUMBER, unit:%
• windowShade - ENUM ["opening", "partially open", "closed", "open", "closing", "unknown"]

Commands

• close()
• open()
• setPosition(position)
  • position required (NUMBER) - Shade position (0 to 100)
• startPositionChange(direction)
  • direction required (ENUM) - Direction for position change request ["open", "close"]
• stopPositionChange()

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