Below is a summary table of existing capabilities with associated states (if any) and systems.
A capability may be readable. This means a request can be made to query its current value.
A capability may be executable. This means a request can be made to execute it.
A capability that is not readable or executable may be used as an event. This means it can trigger scenarios created by the end user or generate notifications.
CAPABILITY | STATES | READABLE | EXECUTABLE | DESCRIPTION | SYSTEMS |
---|---|---|---|---|---|
access |
|
Query openings statuses such as doors or windows. It cannot be executed | |||
active |
|
Change the device availability by enabling or disabling it | - | ||
alert | - | Used as an event to alert the user from a danger | |||
brightness | any value between 1 and 254 | Query or set a brightness value for a light | |||
detect | - | Used as an event for sensors detecting something | |||
dim | any value between 0 and 100 (in %) | Change the intensity of a light | |||
dock | - | Command a device to return to its dock to charge such as vacuums | |||
hue | any value between 0 and 65535 | Change the color of a light using the HUE scheme | |||
humidity | any value between 0 and 100 (in %) | Query the current humidity detected by the device | |||
mode | any value | Change the function mode of the device | |||
operation |
|
Change the function mode of the device | |||
position |
|
Move in the specified direction | |||
position_vertical |
|
Move in the specified direction | |||
pressure | any value (in kPa) | Query the current pressure detected by the device | |||
protection |
|
Change alarms protection mode | |||
record |
|
Start or stop the device recording | |||
rgb | any value between 000000 and FFFFFF | Change the color of a light using the RGB scheme | |||
ring | - | Used as an event for alerting someone is ringing at the device | |||
saturation | any value between 0 and 254 | Query or set a saturation value for a light | |||
show | - | Show the given device on user clients | |||
snapshot | - | Used to trigger a snapshot from the device | |||
speed | any value (at least 0) | Change the device speed | |||
status |
|
Common capability to set on or off the device | |||
temperature | any value (in Celsius) | Query the current temperature detected by the device | |||
trigger | - | Common capability to execute a scene | |||
unlock | - | Unlock the device. It may be used for a front door for example | |||
wind_angle | any value | Query the current wind angle detected by the device | |||
wind_strength | any value | Query the current wind strength detected by the device |