Capabilities

There are many different connected devices in the world today & each works just a little different from the next. Every company has their own APIs, device schemas, etc. What capabilities provide is a way to break down all of these unique devices into some common core functions. Consider, the Switch capability. It's our most popular capability as its sole purpose is to turn something on or off. To control something with the Switch capability, you simply set the Switch attribute to either On or Off. Doesn't matter who manufactured the product or what kind of API it is using. This allows you to design universal page templates that can work with any device you throw at it.

Capabilities

Acceleration Sensor

The AccelerationSensor capability allows for acceleration detection.

Attributes	Type	Possible Values
Acceleration	Enum	Active, Inactive
LastAcceleration	Date

Air Quality Sensor

The AirQualitySensor capability gets the air quality number.

Attributes	Type	Unit	Possible Values
AirQuality	Integer	CAQI	0-100

Alarm

The Alarm capability allows for interacting with devices that serve as alarms.

Attributes	Type	Possible Values
Alarm	Enum	Both, Off, Siren, Strobe

Audio Bass

The AudioBass capability allows for the control of audio bass.

Attributes	Type	Unit	Possible Values
Bass	Float	dB	-10.0 - 10.0

Audio Mute

The AudioMute capability allows for the control of audio mute.

Attributes	Type	Possible Values
Mute	Enum	Muted, Unmuted

Audio Sound Mode

The AudioSoundMode capability allows for the control of audio sound mode.

Attributes	Type	Possible Values
SoundMode	String
SupportedSoundModes	Array	[]

Audio Track Data

The AudioTrackData capability gets the value of the audio track data.

Attributes	Type	Possible Values
AudioTrackData.Source	String
AudioTrackData.Title	String
AudioTrackData.Artist	String
AudioTrackData.Album	String
AudioTrackData.AlbumArtUri	String
AudioTrackData.Duration	Time	0:00 - 24:00:00

Audio Treble

The AudioTreble capability allows for the control of audio treble.

Attributes	Type	Unit	Possible Values
Treble	Float	dB	-10.0 - 10.0

Audio Volume

The AudioVolume capability allows for the control of audio volume using a percentage scale.

Attributes	Type	Unit	Possible Values
Volume	Integer	%	0-100

Audio Volume Decibel

The AudioVolumeDecibel capability allows for the control of audio volume using a decibel scale.

Attributes	Type	Unit	Possible Values
VolumeDecibel	Float	dB	-80.0 - 18.0

Battery

The Battery capability defines that the device has a battery.

Attributes	Type	Unit	Possible Values
Battery	Integer	%	0-100

Binary Sensor

The BinarySensor capability allows reading the value of a binary sensor device.

Attributes	Type	Possible Values
Binary	Enum	On, Off
LastBinary	Date

Button

The Button capability allows reading the state of a physical button.

Attributes	Type	Possible Values
Button	Enum	Pushed, Standby

Carbon Dioxide Measurement

The CarbonDioxideMeasurement capability measures carbon dioxide levels.

Attributes	Type	Unit	Possible Values
CarbonDioxide	Integer	ppm	0-1000000

Carbon Monoxide Detector

The CarbonMonoxideDetector capability measures carbon monoxide levels.

Attributes	Type	Possible Values
CarbonMonoxide	Enum	Clear, Detected, Tested
LastCarbonMonoxide	Date

Carbon Monoxide Measurement

The CarbonMonoxideMeasurement capability measures carbon monoxide levels.

Attributes	Type	Unit	Possible Values
CarbonMonoxideLevel	Integer	ppm	0-1000000

Color Control

The ColorControl capability allows for control of a color changing device by setting its hue, saturation, and color values.

Attributes	Type	Possible Values
Color	String	Hex color string

Color Temperature

The ColorTemperature capability allows for setting the color temperature attribute of a color changing device.

Attributes	Type	Unit	Possible Values
ColorTemperature	Integer	K	1 - 30000

Contact Sensor

The ContactSensor capability allows reading the value of a contact sensor device.

Attributes	Type	Possible Values
Contact	Enum	Closed, Open
LastContact	Date

Current Measurement

The CurrentMeasurement capability gets the value of current measured from devices that support it.

Attributes	Type	Unit
Current	Number	A

Dishwasher Mode

The DishwasherMode capability allows for the control of the dishwasher.

Attributes	Type	Possible Values
DishwasherMode	Enum	Auto, Quick, Rinse, Dry

Dishwasher Operating State

The DishwasherOperatingState capability allows for the control of the dishwasher operational state.

Attributes	Type	Possible Values
MachineState	Enum	Pause, Run, Stop
SupportedMachineStates	Array	[]
DishwasherJobState	Enum	Airwash, Cooling, Drying, Finish, PreDrain, PreWash, Rinse, Spin, Unknown, Wash, WrinklePrevent
CompletionTime	Date

Door Control

The DoorControl capability allows for the control of a door.

Attributes	Type	Possible Values
Door	Enum	Closed, Closing, Open, Opening, Unknown

Dryer Mode

The DryerMode capability allows for the control of the dryer.

Attributes	Type	Possible Values
DryerMode	Enum	Regular, LowHeat, HighHeat

Dryer Operating State

The DryerOperatingState capability allows for the control of the dryer operational state.

Attributes	Type	Possible Values
MachineState	Enum	Pause, Run, Stop
SupportedMachineStates	Array	[]
DryerJobState	Enum	Cooling, DelayWash, Drying, Finished, None, WeightSensing, WrinklePrevent
CompletionTime	Date

Energy Meter

The EnergyMeter capability reads the energy consumption of an energy metering device.

Attributes	Type	Unit	Possible Values
Energy	Number	kWh

Fan Speed

The FanSpeed capability allows for the control of the fan speed.

Attributes	Type	Possible Values
FanSpeed	Enum	Off, Low, Medium, High

Generic Sensor

The GenericSensor capability allows reading the value of a generic sensor.

Attributes	Type	Possible Values
Sensor	String

Geolocation

The Geolocation capability allows reading the geolocation of a tracking device.

Attributes	Type	Possible Values
Latitude	Number
Longitude	Number
Speed	Number
Accuracy	Number
AltitudeAccuracy	Number
LastUpdateTime	Date

Illuminance Measurement

The IlluminanceMeasurement capability gives the illuminance reading from devices that support it.

Attributes	Type	Unit	Possible Values
Illuminance	Integer	lux	0-100000

Location

The Location capability allows reading the location of a tracking device.

Attributes	Type	Possible Values
Location	String

Location Mode

The LocationMode capability allows for setting the mode of a location.

Attributes	Type	Possible Values
LocationMode	Enum	Home, Away, Night, Vacation, Day, Evening, Night
SupportedLocationModes	Array	[]

Lock

The Lock capability allows for the control of a lock device.

Attributes	Type	Possible Values
Lock	Enum	Locked, Unlocked

Media Browser

The MediaBrowser capability allows for a browsing a media device's content.

Attributes	Type	Possible Values
MediaBrowser	Object

Media Control

The MediaControl capability allows for the control of a media device.

Attributes	Type	Possible Values
MediaCommand	Enum	PowerOff, PowerOn, PowerToggle, Menu, List, Guide, Info, Option, Setup, Exit, VolumeUp, VolumeDown, Mute, DirectionUp, DirectionLeft, DirectionDown, DirectionRight, Select, Back, ChannelUp, ChannelDown, PrevChannel, Rewind, Play, Pause, FastForward, SkipBackward, SkipForward, Stop, Record, Red, Green, Yellow, Blue, Number1, Number2, Number3, Number4, Number5, Number6, Number7, Number8, Number9, Number0, Hyphen, NumberEnter, Return, RepeatAll, RepeatOff, RepeatOne, ShuffleOff, ShuffleOn, Home, ModeMovie, ModeMusic, ModeGame, ModePure, ModeDirect, ModeUp, ModeDown
SupportedMediaCommands	Array	[]

Media Group

The MediaGroup capability allows for group control of a media device.

Attributes	Type	Possible Values
GroupCommand	Enum	Group

Media Input Source

The MediaInputSource capability allows for the control of the media input source.

Attributes	Type	Possible Values
InputSource	String	Varies by device.
SupportedInputSources	Array	[]

Media Playback Repeat

The MediaPlaybackRepeat capability allows for the control of the media playback repeat.

Attributes	Type	Possible Values
PlaybackRepeatMode	Enum	All, Off, One

Media Playback Shuffle

The MediaPlaybackShuffle capability allows for the control of media playback shuffle.

Attributes	Type	Possible Values
PlaybackShuffle	Enum	Disabled, Enabled

Media Playback

The MediaPlayback capability allows for the control of the media playback.

Attributes	Type	Possible Values
PlaybackStatus	Enum	Pause, Play, Stop, FastForward, Rewind

Media Playback Time

The MediaPlaybackTime capability allows for the control of the media playback time/position.

Attributes	Type	Possible Values
PlaybackTime	Time	0:00 - 24:00:00

Motion Sensor

The MotionSensor capability allows for the ability to read motion sensor device states.

Attributes	Type	Possible Values
Motion	Enum	Active, Inactive
LastMotion	Date

Occupancy Sensor

The OccupancySensor capability gives the ability to see the current status of a occupancy sensor device.

Attributes	Type	Possible Values
Occupancy	Enum	Occupied, Unoccupied
LastOccupancy	Date

Oven Mode

The OvenMode capability allows for the control of the oven mode.

Attributes	Type	Possible Values
OvenMode	Enum	Heating, Grill, Warming, Defrosting

Oven Operating State

The OvenOperatingState capability allows for the control of the oven operational state.

Attributes	Type	Possible Values
MachineState	Enum	Ready, Running, Paused
SupportedMachineStates	Array	[]
OvenJobState	Enum	Cleaning, Cooking, Cooling, Draining, Preheat, Ready, Rinsing
CompletionTime	Date
OperationTime	Number
Progress	Number	0 - 100

Oven Setpoint

The OvenSetpoint capability allows for the control of the oven set point.

Attributes	Type	Possible Values
OvenSetpoint	Number	0 - 1000

Power Meter

The PowerMeter capability allows for reading the power consumption from devices that report it.

Attributes	Type	Unit	Possible Values
Power	Number	W

Power Source

The PowerSource capability gives the ability to determine the current power source of the device.

Attributes	Type	Possible Values
PowerSource	Enum	Battery, DC, Mains

Precipitation Level Measurement

The PrecipitationLevelMeasurement capability allows for measuring the amount rain that has fallen for a given day.

Attributes	Type	Unit	Possible Values
PrecipitationLevel	Number	in

Precipitation Rate Measurement

The PrecipitationRateMeasurement capability allows for measuring the rate in which rain is falling.

Attributes	Type	Unit	Possible Values
PrecipitationRate	Number	in/h

Presence Sensor

The PresenceSensor capability gives the ability to see the current status of a presence sensor device.

Attributes	Type	Possible Values
Presence	Enum	NotPresent, Present
LastPresence	Date

Pressure Measurement

The PressureMeasurement capability gets the pressure from a device that reports current pressure.

Attributes	Type	Unit	Possible Values
Pressure	Number	hPa/mbar/inHg/psi	0 - 10000

Relative Humidity Measurement

The RelativeHumidityMeasurement capability allows reading the relative humidity from devices that support it.

Attributes	Type	Unit	Possible Values
Humidity	Number	%	0 - 100

Robot Cleaner Cleaning Mode

The RobotCleanerCleaningMode capability allows for the control of the robot cleaner cleaning mode.

Attributes	Type	Possible Values
RobotCleanerCleaningMode	Enum	Auto, Part, Repeat, Manual, Stop, Map

Robot Cleaner Movement

The RobotCleanerMovement capability allows for the control of the robot cleaner movement.

Attributes	Type	Possible Values
RobotCleanerMovement	Enum	Homing, Idle, Charging, Alarm, PowerOff, Reserve, Point, After, Cleaning, Pause

Robot Cleaner Power Mode

The RobotCleanerPowerMode capability allows for the control of the robot cleaner power mode.

Attributes	Type	Possible Values
RobotCleanerPowerMode	String
SupportedRobotCleanerPowerModes	Array	[]

Scene

The Scene capability allows for activating a scene on a device.

Attributes	Type	Possible Values
Scene	String
SupportedScenes	Array	[]

Security System

The SecuritySystem capability allows for control of a security system.

Attributes	Type	Possible Values
SecuritySystemStatus	Enum	ArmedAway, ArmedHome, ArmedStay, ArmedNight, Disarmed, AllDisarmed
SupportedSecuritySystemStates	Array	[]

Signal Strength

The SignalStrength capability gives the ability to read the signal strength of Devices that support it.

Attributes	Type	Unit	Possible Values
Lqi	Integer		0 - 255
Rssi	Number	dBm	-200 - 0

Smoke Detector

The SmokeDetector capability allows for smoke detection.

Attributes	Type	Possible Values
Smoke	Enum	Clear, Detected, Tested
LastSmoke	Date

Sound Measurement

The SoundMeasurement capability allows for the ability to measure the sound level.

Attributes	Type	Unit	Possible Values
SoundLevel	Number	dB

Sound Sensor

The SoundSensor capability allows for sound detection.

Attributes	Type	Possible Values
Sound	Enum	Detected, NotDetected
LastSound	Date

Switch Level

The SwitchLevel capability allows for the control of the level of a device like a light or a dimmer switch.

Attributes	Type	Unit	Possible Values
Level	Integer	%	0 - 100

Switch

The Switch capability allows for a device to be turned on or off.

Attributes	Type	Possible Values
Switch	Enum	On, Off

Tamper Alert

The TamperAlert capability gets the value of the tamper alert.

Attributes	Type	Possible Values
Tamper	Enum	Clear, Detected
LastTamper	Date

Temperature Alarm

The TemperatureAlarm capability gets the value of the temperature alarm.

Attributes	Type	Possible Values
TemperatureAlarm	Enum	Cleared, Freeze, Heat, RateOfRise
LastTemperatureAlarm	Date

Temperature Measurement

The TemperatureMeasurement capability gets the temperature from a Device that reports current temperature.

Attributes	Type	Unit	Possible Values
Temperature	Number	°	-460 - 10000

Thermostat Cooling Setpoint

The ThermostatCoolingSetpoint capability allows for setting the cooling setpoint on a thermostat.

Attributes	Type	Unit	Possible Values
CoolingSetpoint	Number	°	-460 - 10000

Thermostat Fan Mode

The ThermostatFanMode capability allows for setting the fan mode on a thermostat.

Attributes	Type	Possible Values
ThermostatFanMode	Enum	Auto, Circulate, FollowSchedule, On
SupportedThermostatFanModes	Array	[]

Thermostat Heating Setpoint

The ThermostatHeatingSetpoint capability allows for setting the heating setpoint on a thermostat.

Attributes	Type	Unit	Possible Values
HeatingSetpoint	Number	°	-460 - 10000

Thermostat Hold

The ThermostatHold capability allows for setting the hold on a thermostat.

Attributes	Type	Possible Values
ThermostatHoldState	Enum	NoHold, TemporaryHold, PermanentHold, HoldUntil
ThermostatHoldEndTime	Time	0:00 - 24:00

Thermostat Mode

The ThermostatMode capability allows for setting the mode on a thermostat.

Attributes	Type	Possible Values
ThermostatMode	Enum	Auto, Eco, RushHour, Cool, EmergencyHeat, Heat, Off
SupportedThermostatModes	Array	[]

Thermostat Operating State

The ThermostatOperatingState capability gives the ability to see the current state that the thermostat is operating in.

Attributes	Type	Possible Values
ThermostatOperatingState	Enum	Cooling, FanOnly, Heating, Idle, PendingCool, PendingHeat, VentEconomizer

Thermostat Preset

The ThermostatPreset capability allows for setting the preset mode on a thermostat.

Attributes	Type	Possible Values
ThermostatPreset	String
SupportedThermostatPresets	Array	[]

Tv Channel

The TvChannel capability allows for the control of the TV channel.

Attributes	Type	Possible Values
TvChannel.Name	String
TvChannel.Number	Number

Ultraviolet Index

The UltravioletIndex capability gives the ability to get the ultraviolet index from devices that report it.

Attributes	Type	Possible Values
UltravioletIndex	Integer	0-255

Valve

The Valve capability allows for the control of a valve device.

Attributes	Type	Possible Values
Valve	Enum	Closed, Open

Video Stream

The VideoStream capability allows for the control of the video stream.

Attributes	Type	Possible Values
Stream	Stream

Voltage Measurement

The VoltageMeasurement capability gets the value of voltage measured from devices that support it.

Attributes	Type	Unit
Voltage	Number	V

Washer Mode

The WasherMode capability allows for the control of the washer mode.

Attributes	Type	Possible Values
WasherMode	Enum	Regular, Heavy, Rinse, SpinDry

Washer Operating State

The WasherOperatingState capability allows for the control of the washer operational state.

Attributes	Type	Possible Values
MachineState	Enum	Pause, Run, Stop
SupportedMachineStates	Array	[]
WasherJobState	Enum	Airwash, Cooling, DelayWash, Drying, Finish, None, PreWash, Rinse, Spin, Wash, WeightSensing, WrinklePrevent
CompletionTime	Date

Water Sensor

The WaterSensor capability gets the status off of a water sensor device.

Attributes	Type	Possible Values
Water	Enum	Dry, Wet
LastWater	Date

Weather Condition

The WeatherCondition capability gets the condition of the weather.

Attributes	Type	Possible Values
Weather	Enum	Clear, Cloudy, Fog, Hail, Thunderstorm, PartlyCloudy, Showers, Rain, Snow, RainSnow, Sunny, Windy, Haze, Exceptional

Wind Direction Measurement

The WindDirectionMeasurement capability allows for the ability to measure the wind direction.

Attributes	Type	Possible Values
WindDirection	Enum	N, NE, E, SE, S, SW, W, NW

Wind Gust Measurement

The WindGustMeasurement capability allows for the ability to measure the wind gust.

Attributes	Type	Unit
WindGust	Number	MPH

Wind Measurement

The WindMeasurement capability allows for the ability to measure the wind speed.

Attributes	Type	Unit
Wind	Number	MPH

Window Shade

The WindowShade capability allows for the control of the window shade.

Attributes	Type	Possible Values
WindowShade	Enum	Closed, Closing, Open, Opening, PartiallyOpen, Pause