Every key of config.yaml and secrets.yaml, with its values, default and effect. The key tables are checked against the program code by site/check.py. If you are new, read Getting started first.
Each widget has exactly one of entity or group (except type: notifications and type: energy, which have neither).
Key
Values
Default
Effect
entity
entity id, domain.object_id
none
The Home Assistant thing. Supported domains: cover, light, switch, automation, climate, sensor, binary_sensor, weather, vacuum, media_player, calendar, alarm_control_panel, lock.
group
a name from groups
none
A widget for all members of the group. Needs name.
name
text
the Home Assistant name
The label. Required for groups. Default Alerts for notifications.
size
WxH
depends on the type
See Widgets, Sizes. Sizes a type does not allow are corrected.
type
sensor, cover, light, switch, automation, climate, binary_sensor, weather, vacuum, media_player, calendar, alarm_control_panel, lock, garage, notifications, energy
from the entity
Pick the widget type yourself, for example type: sensor for person.alice. notifications needs no entity. garage is a cover entity shown as a garage door; a cover with device_class garage or gate becomes one without type.
type: energy, no entity or group. At least one of usage and solar is needed. Size is always 2x1. name and size are accepted but not shown.
Key
Values
Default
Effect
usage
sensor id
none
The consumption sensor, the top row (Used). A running total (total_increasing, such as a Shelly 3EM total) works: the widget shows the change since local midnight.
solar
sensor id
none
The solar production sensor, the second row (Solar). Same rules.
history
false
on
history: false switches the long press popup off.
Both sensors need long-term statistics in Home Assistant (any sensor with a state_class has them). Wh is shown as kWh.
Tested on the device with the largest allowed dashboard (16 tabs of 24 widgets, 384 widgets, every widget type, long names, 25 % unknown ids): it boots, fetches the states in chunks of 40 ids, cycles tabs and takes taps for 19 minutes without a crash.
16 tabs, 24 widgets per tab, 16 entities per group. More is refused with a config error.
The config file is at most 64 KB.
A first start from the SD card takes about 3 to 7 seconds for the largest file; later starts use the cache (about 0.1 s).
Home Assistant is asked for the states in chunks of 40 entities, so the number of entities is not limited by the request size.
Private: your Wi-Fi password and the Home Assistant token. Keep it off the internet. It is stored as plain text on the card, so treat the card like a key.
In priority order: the first one in range is used. A single profile without the list dash is also accepted.
name
1 to 20 characters, unique
Network 1, Network 2, ...
The label shown in Settings.
ssid / password
text
ssid required, password optional (open network)
Network name and password, inside quotes. Each profile needs a different SSID.
ha_url
internal, external, auto
auto
Which address to use on this network. external needs external_url.
static_ip
block
DHCP
A fixed IP address. All four fields are then required.
ip / gateway / subnet / dns
IPv4 addresses
none
The static_ip fields.
home_assistant
block
required
The Home Assistant address and token.
internal_url / external_url / token
text
internal_url and token required
internal_url starts with http:// or https://. external_url is optional and must start with https://. The token is a long-lived access token (see Getting started).
connection
block (old format)
none
Old format of the three rows above, inside config.yaml. It is an error once secrets.yaml exists.