onoff
. This is a boolean capability that tells Homey whether the device is turned on
(when true
) or off
(when false
). Homey ships with many capabilities (called system capabilities). These can be found in the Device Capability Reference.capabilities
is required. This is an array with the keys of all capabilities. This array can be overwritten during pairing.device.js
) instance needs to keep the device synchronised with Homey. Capabilities need to be synchronized both ways. This means that if a device's state changes, for example if the user turns on the lights, your app needs to tell Homey. It is also possible for Homey to request your app to change the state of the device, for example when a Flow is triggered to turn off the lights.Device
class should listen for changes to the device's and then update the capability value within Homey by calling Device#setCapabilityValue()
. You should also register a method with Device#registerCapabilityListener()
that to update the state of the physical device.capabilitiesOptions
object in the driver's entry in the App Manifest.title
{ "en": "My Custom Title" }
.preventInsights
preventTag
Device#registerCapabilityListener()
.duration
true
to allow users to set a duration on the Flow Action card associated with this capability.onoff
, windowcoverings_closed
, garagedoor_closed
and button
, are:insightsTitleTrue
insightsTitleFalse
measure_*
capabilities, are:units
"Β°C"
Homey can automatically convert this capability value to Fahrenheit.decimals
min
max
step
alarm_motion
and alarm_contact
are:zoneActivity
false
to disable zone activity for this capability.measure_power
are:approximated
onoff
are:setOnDim
false
to prevent the onoff
capability from being set when the dim
capability is updated by a Flow action card. See Lights for more information.onoff
and volume_mute
are:getable
false
to make the onoff
or volume_mute
capability stateless. If this option is set to false
the device's quickAction
will be disabled, the UI components will be updated, and some Flow cards will be added/removed. getable
capability option is available as of Homey v7.2.1. getable: false
to an existing driver will break users' Flows as it removes a number of Flow cards belonging to the onoff
and volume_mute
capabilities.capabilities
.type
boolean
, number
, string
or enum
.title
getable
true
, a boolean whether the capability's value can be requested by a front-end. When getable is false
, your Device doesn't need to call Device#setCapabilityValue
.setable
true
, a boolean whether the capability's value can be set by a front-end. When setable is false
, your Device doesn't need to register a capability listener.units
"Β°C"
Homey can automatically convert this capability value to Fahrenheit.uiComponent
uiComponent
to null
.icon
.svg
Icon.insights
false
, whether this capability should create an Insights log.boolean
the following additional properties can be set:uiQuickAction
insightsTitleTrue
insightsTitleFalse
number
the following additional properties can be set:min
max
step
decimals
enum
the following additional properties can be set:values
id
, which will be the capability value, and a title
, which is a translation object. The three values
should have the ID's up
, idle
, and down
.{ "id": "option1", "title": { "en": "First option" }}
alarm_
. By default all capabilities with this prefix are grouped, and a warning icon is shown if the value of any of the boolean capabilities is true
. Alternatively users can choose to show the indicator value of a single specific Alarm capability. The alarm_battery
capabilities will show an "empty battery" icon instead of an exclamation mark.measure_
or meter_
. The measure_battery
capability will always be displayed with a custom battery icon instead of a number.uiComponent
property in your custom capability."uiComponent": "toggle"
boolean
capability. Depending on the capability, the look might change."uiComponent": "slider"
number
capability. Depending on the capability, the look might change."uiComponent": "sensor"
number
, enum
, string
or boolean
capabilities.true
and begin with alarm_
will flash red."uiComponent": "thermostat"
target_temperature
capability, and an optional measure_temperature
.target_temperature
and measure_temperature
, make sure the dot suffix of the capabilities are the same so that they will be displayed together, for instance: target_temperature.top
and measure_temperature.top
."uiComponent": "media"
speaker_playing
, speaker_next
, speaker_prev
, speaker_shuffle
and speaker_repeat
capabilities."uiComponent": "color"
light_hue
, light_saturation
, light_temperature
and light_mode
capabilities."uiComponent": "battery"
measure_battery
or alarm_battery
capability."uiComponent": "picker"
enum
capability and shows a list of possible values."uiComponent": "ternary"
enum
capability with three values, meant for motorized components."uiComponent": null
null
as value.This feature depends on Homey v3.1.0 and Homey Smartphone App v3.0.1.
uiComponent
in the device view. When this button is pressed the registered capability listener will be triggered. This allows you to initiate actions from the device's settings.button
. In order to mark it as a maintenance action add the maintenanceAction: true
property to the capabilitiesOptions
object of the driver manifest. Additionally, provide a title
property, and optionally a desc
property.device.js
to listen for maintenance action events.measure_temperature.inside
& measure_temperature.outside
.