Deviceclass will be created and a device tile will be shown in the interface. Every
Deviceclass is associated with a
Driverclasses of your app will be instantiated when your app is started, even if there are no devices of that type paired with Homey. This allows the driver to be responsible for pairing new devices and defining Flow cards.
drivers/directory which will look like this:
/drivers/<driver_id>/driver.jsfile contains the
Driverclass. This class is responsible for pairing devices and describes the functionality for the devices belonging to the driver such as Flow cards.
/drivers/<driver_id>/device.jsfile contains the
Deviceclass. This class implements the device's functionality such as its capabilities and Flows.
/drivers/<driver_id>/driver.compose.jsonfile is the driver manifest, when building your app all the
driver.compose.jsonfiles will be bundled into your App Manifest. A basic driver manifest looks like this:
/drivers/<driver_id>/assets/icon.svg. Read the app store guidelines for more information about the driver icon.
"platforms": ["local", "cloud"]
locketc. When a specific device is not supported by Homey, you can use the class
"capabilities": ["onoff", "dim"]
onoffwhich allows users to toggle the light on or off. It can also support the
dimcapability which would allow the user to change the lights brightness.
onoffcapability has the type
booleanand can thus be either
false. The capability
dimis of type
numberand can be any number between
0 - 1, as defined in the capability's definition.
"settings": [ ... ]
"pair": [ ... ]
pairproperty of the device manifest describes the steps necessary to add the device to Homey.
"deprecated": trueto your driver in your App Manifest. It will still work, but won't show up anymore in the 'Add Device' list.
"connectivity": [ ... ]
[ "infrared", "lan" ]for a TV that is turned on by Infrared, and then controlled over Wi-Fi LAN.
dataproperty. This property contains a unique identifier for the device. This object cannot be changed after pairing. This
dataproperty is an object containing any properties of the types String, Number or Object. Homey uses this object to identify your device, together with the driver's ID. Read more in the Device pairing documentation.
/assets/folder contains the icon and images for that driver. These images should be clean marketing pictures of the device that this driver implements, these are shown in the Homey App Store.