Home Assistant

Entities of a Home Assistant, with live updates, and its services as commands.

In a dashboard file: a connection with "driver": "homeassistant", 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 home, 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": {
        "home": {
            "driver": "homeassistant",
            "config": { "host": "192.168.1.10", "token": "your long-lived access token" }
        }
    },
    "screens": [
        {
            "name": "Home",
            "tiles": [
                {
                    "type": "value",
                    "label": "Outside",
                    "layout": { "x": 1, "y": 1, "width": 2, "height": 2 },
                    "dataSource": {
                        "connection": "home",
                        "params": { "entity": "sensor.outdoor_temperature" }
                    },
                    "options": { "numberFormat": "0.0", "unit": "°C" }
                }
            ]
        }
    ]
}

Settings (config)

Field	Type	Default	What
host	text	required	Home Assistant, for example 192.168.1.10, or its URL, such as https://ha.example.com.
port	whole number, 1 to 65535		8123 when left out; not used with a URL.
token	text	required	A long-lived access token, made in your Home Assistant profile under Security. A credential.
refreshInterval	number, above 0		Seconds between refreshes.

What a data source reads (params)

Field	Type	Default	What
entity	text	required	Entity. One of Home Assistant’s entities, with its area.
attribute	text		Attribute. One of the entity’s attributes; its state when left out, and a light or a thermostat whole.
refreshInterval	number, above 0		Refresh every. Seconds; the connection’s setting when left out.