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.

AttributesTypePossible Values
AccelerationEnumActive, Inactive

Activity Lighting Mode

The ActivityLightingMode capability allows for the control of the activity lighting mode of a device.

AttributesTypePossible Values
LightingModeEnumReading, Writing, Computer, Night

Air Conditioner Mode

The AirConditionerMode capability allows for the control of the air conditioner.

AttributesTypePossible Values
AirConditionerModeEnumAuto, Cool, Dry, CoolClean, DryClean, FanOnly, Heat, HeatClean, NotSupported

Air Quality Sensor

The AirQualitySensor capability gets the air quality number.

AttributesTypeUnitPossible Values
AirQualityIntegerCAQI0-100

Alarm

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

AttributesTypePossible Values
AlarmEnumBoth, Off, Siren, Strobe

Audio Mute

The AudioMute capability allows for the control of audio mute.

AttributesTypePossible Values
MuteEnumMuted, Unmuted

Audio Track Data

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

AttributesTypePossible Values
AudioTrackData.SourceString
AudioTrackData.TitleString
AudioTrackData.ArtistString
AudioTrackData.AlbumString
AudioTrackData.AlbumArtUriString
AudioTrackData.DurationTime0:00 - 24:00:00

Audio Volume

The AudioVolume capability allows for the control of audio volume.

AttributesTypeUnitPossible Values
VolumeInteger%0-100

Battery

The Battery capability defines that the device has a battery.

AttributesTypeUnitPossible Values
BatteryInteger%0-100

Carbon Dioxide Measurement

The CarbonDioxideMeasurement capability measures carbon dioxide levels.

AttributesTypeUnitPossible Values
CarbonDioxideIntegerppm0-1000000

Carbon Monoxide Detector

The CarbonMonoxideDetector capability measures carbon monoxide levels.

AttributesTypePossible Values
CarbonMonoxideEnumClear, Detected, Tested

Carbon Monoxide Measurement

The CarbonMonoxideMeasurement capability measures carbon monoxide levels.

AttributesTypeUnitPossible Values
CarbonMonoxideLevelIntegerppm0-1000000

Color Control

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

AttributesTypePossible Values
ColorStringHex color string

Color Temperature

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

AttributesTypeUnitPossible Values
ColorTemperatureIntegerK1 - 30000

Contact Sensor

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

AttributesTypePossible Values
ContactEnumClosed, Open

Dishwasher Mode

The DishwasherMode capability allows for the control of the dishwasher.

AttributesTypePossible Values
DishwasherModeEnumAuto, Quick, Rinse, Dry

Dishwasher Operating State

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

AttributesTypePossible Values
MachineStateEnumPause, Run, Stop
SupportedMachineStatesArray[]
DishwasherJobStateEnumAirwash, Cooling, Drying, Finish, PreDrain, PreWash, Rinse, Spin, Unknown, Wash, WrinklePrevent
CompletionTimeDate

Door Control

The DoorControl capability allows for the control of a door.

AttributesTypePossible Values
DoorEnumClosed, Closing, Open, Opening, Unknown

Dryer Mode

The DryerMode capability allows for the control of the dryer.

AttributesTypePossible Values
DryerModeEnumRegular, LowHeat, HighHeat

Dryer Operating State

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

AttributesTypePossible Values
MachineStateEnumPause, Run, Stop
SupportedMachineStatesArray[]
DryerJobStateEnumCooling, DelayWash, Drying, Finished, None, WeightSensing, WrinklePrevent
CompletionTimeDate

Dust Sensor

The DustSensor capability allows reading of the dust sensor.

AttributesTypeUnitPossible Values
FineDustLevelIntegerµg/m3
DustLevelIntegerµg/m3

Energy Meter

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

AttributesTypeUnitPossible Values
EnergyNumberkWh

Equivalent Carbon Dioxide Measurement

The EquivalentCarbonDioxideMeasurement capability measures equivalent carbon dioxide levels.

AttributesTypeUnitPossible Values
EquivalentCarbonDioxideMeasurementIntegerppm0-1000000

Fan Speed

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

AttributesTypePossible Values
FanSpeedEnumOff, Low, Medium, High

Filter Status

The FilterStatus capability gets the status of the filter.

AttributesTypePossible Values
FilterStatusEnumNormal, Replace

Formaldehyde Measurement

The FormaldehydeMeasurement capability measures formaldehyde levels.

AttributesTypeUnitPossible Values
FormaldehydeLevelIntegerppm0-1000000

Illuminance Measurement

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

AttributesTypeUnitPossible Values
IlluminanceIntegerlux0-100000

Infrared Level

The InfraredLevel capability allows for the control of the infrared level attribute of a device.

AttributesTypeUnitPossible Values
InfraredLevelInteger%0-100

Location Mode

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

AttributesTypePossible Values
LocationModeEnumHome, Away, Night, Vacation, Day, Evening, Night
LocationModeArray[]

Lock

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

AttributesTypePossible Values
LockEnumLocked, Unlocked

Media Browser

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

AttributesTypePossible Values
MediaBrowserObject

Media Control

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

AttributesTypePossible Values
MediaCommandEnumPowerOff, 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
SupportedMediaCommandsArray[]

Media Input Source

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

AttributesTypePossible Values
InputSourceStringVaries by device.
SupportedInputSourcesArray[]

Media Playback Repeat

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

AttributesTypePossible Values
PlaybackRepeatModeEnumAll, Off, One

Media Playback Shuffle

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

AttributesTypePossible Values
PlaybackShuffleEnumDisabled, Enabled

Media Playback

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

AttributesTypePossible Values
PlaybackStatusEnumPause, Play, Stop, FastForward, Rewind

Media Playback Time

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

AttributesTypePossible Values
PlaybackTimeTime0:00 - 24:00:00

Motion Sensor

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

AttributesTypePossible Values
MotionEnumActive, Inactive

Odor Sensor

The OdorSensor capability gets the odor sensor reading.

AttributesTypePossible Values
OdorLevelNumber0 - 1000000

Oven Mode

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

AttributesTypePossible Values
OvenModeEnumHeating, Grill, Warming, Defrosting

Oven Operating State

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

AttributesTypePossible Values
MachineStateEnumReady, Running, Paused
SupportedMachineStatesArray[]
OvenJobStateEnumCleaning, Cooking, Cooling, Draining, Preheat, Ready, Rinsing
CompletionTimeDate
OperationTimeNumber
ProgressNumber0 - 100

Oven Setpoint

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

AttributesTypePossible Values
OvenSetpointNumber0 - 1000

Power Meter

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

AttributesTypeUnitPossible Values
PowerNumberW

Power Source

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

AttributesTypePossible Values
PowerSourceEnumBattery, DC, Mains

Precipitation Level Measurement

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

AttributesTypeUnitPossible Values
PrecipitationLevelNumberin

Precipitation Rate Measurement

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

AttributesTypeUnitPossible Values
PrecipitationRateNumberin/h

Presence Sensor

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

AttributesTypePossible Values
PresenceEnumNotPresent, Present

Rapid Cooling

The RapidCooling capability allows for the control of rapid cooling.

AttributesTypePossible Values
RapidCoolingEnumOff, On

Refrigeration Setpoint

The RefrigerationSetpoint capability allows for the control of the refrigeration set point.

AttributesTypeUnitPossible Values
RefrigerationSetpointNumber°-460 - 10000

Relative Humidity Measurement

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

AttributesTypeUnitPossible Values
HumidityNumber%0 - 100

Robot Cleaner Cleaning Mode

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

AttributesTypePossible Values
RobotCleanerCleaningModeEnumAuto, Part, Repeat, Manual, Stop, Map

Robot Cleaner Movement

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

AttributesTypePossible Values
RobotCleanerMovementEnumHoming, Idle, Charging, Alarm, PowerOff, Reserve, Point, After, Cleaning

Robot Cleaner Turbo Mode

The RobotCleanerTurboMode capability allows for the control of the robot cleaner turbo mode.

AttributesTypePossible Values
RobotCleanerTurboModeEnumOn, Off, Silence

Scene

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

AttributesTypePossible Values
SceneString
SupportedScenesArray[]

Signal Strength

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

AttributesTypeUnitPossible Values
LqiInteger0 - 255
RssiNumberdBm-200 - 0

Smoke Detector

The SmokeDetector capability allows for smoke detection.

AttributesTypePossible Values
SmokeEnumClear, Detected, Tested

Sound Measurement

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

AttributesTypeUnitPossible Values
SoundLevelNumberdB

Sound Sensor

The SoundSensor capability allows for sound detection.

AttributesTypePossible Values
SoundEnumDetected, NotDetected

Switch Level

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

AttributesTypeUnitPossible Values
LevelInteger%0 - 100

Switch

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

AttributesTypePossible Values
SwitchEnumOn, Off

Tamper Alert

The TamperAlert capability gets the value of the tamper alert.

AttributesTypePossible Values
TamperEnumClear, Detected

Temperature Measurement

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

AttributesTypeUnitPossible Values
TemperatureNumber°-460 - 10000

Thermostat Cooling Setpoint

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

AttributesTypeUnitPossible Values
CoolingSetpointNumber°-460 - 10000

Thermostat Fan Mode

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

AttributesTypePossible Values
ThermostatFanModeEnumAuto, Circulate, FollowSchedule, On
SupportedThermostatFanModesArray[]

Thermostat Heating Setpoint

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

AttributesTypeUnitPossible Values
HeatingSetpointNumber°-460 - 10000

Thermostat Hold

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

AttributesTypePossible Values
ThermostatHoldStateEnumNoHold, TemporaryHold, PermanentHold, HoldUntil
ThermostatHoldEndTimeTime0:00 - 24:00
ThermostatHoldActivityString
SupportedThermostatHoldActivitiesArray[]

Thermostat Mode

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

AttributesTypePossible Values
ThermostatModeEnumAuto, Eco, RushHour, Cool, EmergencyHeat, Heat, Off
SupportedThermostatModesArray[]

Thermostat Operating State

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

AttributesTypePossible Values
ThermostatOperatingStateEnumCooling, FanOnly, Heating, Idle, PendingCool, PendingHeat, VentEconomizer

Tv Channel

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

AttributesTypePossible Values
TvChannel.NameString
TvChannel.NumberNumber

Tvoc Measurement

The TvocMeasurement capability measures total volatile organic compound levels.

AttributesTypeUnitPossible Values
TvocLevelIntegerppm0-1000000

Ultraviolet Index

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

AttributesTypePossible Values
UltravioletIndexInteger0-255

Valve

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

AttributesTypePossible Values
ValveEnumClosed, Open

Video Stream

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

AttributesTypePossible Values
StreamStream

Voltage Measurement

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

AttributesTypeUnit
VoltageNumberV

Washer Mode

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

AttributesTypePossible Values
WasherModeEnumRegular, Heavy, Rinse, SpinDry

Washer Operating State

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

AttributesTypePossible Values
MachineStateEnumPause, Run, Stop
SupportedMachineStatesArray[]
WasherJobStateEnumAirwash, Cooling, DelayWash, Drying, Finish, None, PreWash, Rinse, Spin, Wash, WeightSensing, WrinklePrevent
CompletionTimeDate

Water Sensor

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

AttributesTypePossible Values
WaterEnumDry, Wet

Wind Direction Measurement

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

AttributesTypePossible Values
WindDirectionEnumN, NE, E, SE, S, SW, W, NW

Wind Gust Measurement

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

AttributesTypeUnit
WindGustNumberMPH

Wind Measurement

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

AttributesTypeUnit
WindNumberMPH

Window Shade

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

AttributesTypePossible Values
WindowShadeEnumClosed, Closing, Open, Opening, PartiallyOpen