Homey

Devices of a Homey Pro through its local API, with live updates.

In a dashboard file: a connection with "driver": "homey", its settings in config, and what a data source of it reads in that data source’s params (Connections and data sources).

Example

A dashboard with a connection of this driver, named homey, and a tile that reads it. Any number of tiles can read the same connection. In the editor, the values of params are picked from what the connection lists; ids in the example are made up.

{
    "schemaVersion": 4,
    "connections": {
        "homey": {
            "driver": "homey",
            "config": { "host": "192.168.1.50", "key": "your API key" }
        }
    },
    "screens": [
        {
            "name": "Home",
            "tiles": [
                {
                    "type": "value",
                    "label": "Bedroom",
                    "layout": { "x": 1, "y": 1, "width": 2, "height": 2 },
                    "dataSource": {
                        "connection": "homey",
                        "params": {
                            "device": "7cc7fa33-fb17-47cf-8ca7-c92ac217d11f",
                            "capability": "measure_temperature"
                        }
                    },
                    "options": { "numberFormat": "0.0", "unit": "°C" }
                }
            ]
        }
    ]
}

Settings (config)

Field	Type	Default	What
host	text	required	The Homey, for example 192.168.1.50.
key	text	required	An API key, made in Homey’s settings under API keys. A credential.
homeyId	text		The Homey’s id, to find it again at another address; the connection’s test fills it in.
refreshInterval	number, above 0		Seconds between refreshes.

What a data source reads (params)

Field	Type	Default	What
device	text	required	Device. One of the Homey’s devices, with its room.
capability	text		Value. Which of the device’s values; all of them, and a light’s state, when left out.
refreshInterval	number, above 0		Refresh every. Seconds; the connection’s setting when left out.