Welcome to the Homey Apps SDK v3 reference

The Homey Apps SDK v3 reference is the documentation of all managers & classes in the Homey Apps SDK for Python.

It is recommended to read the Homey Apps SDK guide first before you use this reference.

Managers

Almost all functionality can be accessed through a Manager. For example, ManagerDrivers is your entrypoint to get a Driver by calling self.homey.drivers.get_driver(<driver_id>). This method then returns the instance of Driver for the given id.

You can access any manager through the Homey instance using self.homey.<manager_id>. For example, write self.homey.flow to access the instance of ManagerFlow.

Classes

Most classes are accessed through a manager. There are three 'special' classes in the SDK that you can extend in your app:

  • App — Assigned to homey_export in app.py
  • Driver — Assigned to homey_export in driver.py
  • Device — Assigned to homey_export in device.py

These classes are the basis for your app, you are expected to extend and export them from your app.

Issues

Please report any issues you find in the Apps SDK Issue Tracker.

Related Projects