Inkhaus

Widgets#

A widget is one tile on a tab. You add it to config.yaml as one item of a tab's widgets: list. Most widgets need only the line entity: with the id from Home Assistant. The kind of widget follows from the first part of the id (light. gives a light).

Each section below says what the widget is for, what you can set, and shows a picture and a snippet to copy.

Options every widget has#

KeyValuesDefaultEffect
entityan entity id, such as light.floor_lampnoneThe thing in Home Assistant. Every widget needs entity or group, except notifications (see its section).
groupa group name from groups:noneSeveral things in one widget (see Cover groups).
nametextthe Home Assistant nameThe label on the tile. Required for groups.
sizeWxH, such as 2x1depends on the typeCells wide and high. Only some types allow another size (table at the end).
typea widget typefrom the entityPick the widget type yourself, for entities that have none (see Show any entity as a sensor).
Same entity without and with a name line.
Rename a widget with name.

What you'll see: the tile shows your name instead of the Home Assistant name.

Light#

For lights. A tap switches it on or off. A long press opens a brightness popup, if the light can dim.

Light widget on (filled black) and off (outline), with the two config lines that make them.
A light: filled when on, outline when off.
- entity: light.living_room_ceiling
  name: Ceiling
Light in each state: on, off, waiting for confirmation and unavailable.
A light in each state.

If the tile stays dashed with an hourglass, Home Assistant has not confirmed yet. If it is dotted with n/a, the light is unavailable.

The brightness popup has plus and minus buttons, presets and an Off button.

Brightness popup with numbered parts.
A popup: long press a light to dim it.

Switch, window sensor and automation#

Switch, window sensor and automation tiles.
Switch, window sensor, automation.
- entity: switch.living_room_fan
  name: Fan
- entity: binary_sensor.living_room_window
  name: Window
- entity: automation.night_mode
  name: Night mode
Automation enabled and disabled.
An automation: tap to enable or disable.
Binary sensors in words: window, door and others.
Open or closed, on or off, in words.

Cover (shutter, blind)#

A wide tile with three buttons: up, stop and down. The button of the direction the cover is moving in is filled.

A shutter in five states.
A shutter in five states.
- entity: cover.living_room_shutter
  name: Shutter

Cover or light group#

A group lets one tile control several things of the same kind. Define the group once at the top of the file, then use it as a widget:

Groups entry and the widget that uses it.
One button for several shutters.
groups:
  downstairs_shutters:
    - cover.living_room_shutter
    - cover.kitchen_shutter
    - cover.hall_shutter
tabs:
  - title: Living room
    widgets:
      - group: downstairs_shutters
        name: Downstairs shutters

If it doesn't work: "unknown group" means the name after group: is not spelled like the one under groups:.

Thermostat (climate)#

A wide tile: current temperature, humidity, a target and minus and plus buttons. Taps on the buttons are collected and sent 1.5 seconds after your last tap, so you can tap several times.

Thermostat with target 22.0 and minus and plus.
A thermostat.
Thermostat heating, off and unavailable.
Thermostat states.
- entity: climate.living_room
  name: Living room

Sensor#

Shows a value: a temperature, a humidity, a power reading. Read only. A tap (or long press) shows its history graph.

Sensor 1x1 and 2x1 with their snippets.
Sensor 1x1 and size 2x1.
KeyValuesDefaultEffect
attributean attribute name (a-z, 0-9, _, up to 40 characters)the stateShow this attribute instead of the state.
detailsup to 2 attribute names, in bracketsnoneA second line, only visible at 2x1 or wider.
unittext, up to 8 charactersfrom Home AssistantReplaces the unit shown.
decimals0 to 3whole numbers as is, others 1 decimalRounds numbers.
size1x1 or 2x11x12x1 puts the name on the left and the value on the right.
- entity: sensor.living_room_climate
  name: Living room
  size: 2x1
  attribute: temperature
  details: [humidity, dew_point]
  decimals: 1
Decimals 0, default and 2.
Round a value with decimals; replace the unit with unit.

If it doesn't work: n/a with a dotted frame means Home Assistant says "unavailable"; - means no value yet. If the attribute is wrong, check its name in Home Assistant under Developer tools, States.

Sensor with a value, unavailable and loading.
A sensor when data is missing.

Show any entity as a sensor#

Some entities have no widget of their own, for example person.alice. Tell the device to show them as a sensor:

Entity with type sensor.
Show any entity as a sensor.
- entity: person.alice
  type: sensor
  name: Alice

Without type: sensor, the Config row in Settings reports "unsupported entity domain".

Weather#

A tile with the current condition and temperature. Default size is 2x1; 1x1 is possible.

Weather tile 2x1.
Current weather.
- entity: weather.home
  name: Home

Forecast#

Add forecast: true for the next 3 days (weekday, icon, high and low). It needs a wide tile: the size is raised automatically. A day that Home Assistant does not answer shows -.

Weather with a three day forecast.
Weather with a forecast.
- entity: weather.home
  forecast: true

The forecast is fetched for the tab you are looking at: at each scheduled wake, and when you wake the device only if the last answer is older than 30 minutes. forecast works for a single weather entity only, not for a group. Default false.

Vacuum#

A wide tile with start, pause and back to dock buttons.

Robot vacuum states.
A robot vacuum.
- entity: vacuum.robot
  name: Vacuum

Media player#

A wide tile with the cover art of the playing track on the left, the title and artist (your name while nothing plays) and previous, play or pause, and next buttons. Tap the text or the cover to open a popup with a large cover, title, artist, album, the buttons, a volume bar (minus and plus in 5 % steps, or rocker up and down) and mute. Volume and mute are dotted when the player does not support them.

Media player playing, paused and unavailable, and its popup.
A media player.
- entity: media_player.living_room
  name: Living room

One entity per tile (no groups). With several players, give each a name.

Cover art#

The picture comes from Home Assistant (entity_picture), is fetched once per track and shown in 16 greys. A player that is off, or has no picture, shows an empty square with a speaker; while the picture loads it shows an hourglass; if it cannot be fetched (too large, not a JPEG or PNG, no answer) it shows the square with a speaker and an alert, and tries again at the next wake or when the track changes. Because the cover sits beside the text there is room for about 14 characters in landscape and 11 in portrait; longer titles end in ....

Cover art: shown, no picture, loading and failed.
The cover art states.

Add art: false for the text-only tile and popup:

- entity: media_player.living_room
  art: false        # default is true (picture fetched once per track)
A media player with and without cover art.
Cover art on and off.

Notifications#

A bell with the number of Home Assistant notifications. It has no entity. Tap it to open a list where you can dismiss one notification or press Clear all (which asks first).

Notification tile with 0 and 3 and the list popup.
Home Assistant notifications.
- type: notifications
  name: Alerts

name is optional and defaults to Alerts. The tile is outline at 0 and filled when there is at least one. It shows 99+ above 99, - while loading and n/a when the list cannot be fetched.

Alarm panel#

A shield with the mode of a Home Assistant alarm panel: Off, Home, Away, Night, Arming, Entry (the entry delay) or ALARM (filled while it is triggered). Tap it to open a keypad: type the code, then pick Disarm, Home, Away or Night.

Alarm panel tiles and the keypad.
An alarm panel and its keypad.
- entity: alarm_control_panel.home
  name: Alarm

In the demo, the panels on the Alarm tab accept the code 1234 to disarm.

Lock and garage door#

A padlock or a garage with its state. A tap asks first, then acts. The question has three buttons: Yes (rocker up), No (rocker down) and Skip (push, or a tap outside). It skips by itself after 15 seconds. Nothing happens unless you answer Yes.

Lock and garage tiles.
A lock and a garage door.
- entity: lock.front_door
  name: Front door
- entity: cover.garage
  type: garage
  name: Garage
LooksA tap
Lock, lockedLocked, outlineasks Unlock Front door?
Lock, unlockedOpen, filledlocks at once (locking is safe)
Lock, locking, unlocking, jammedLocking, Opening, Jammed (filled)nothing
Garage, closedClosed, outlineasks Open Garage?
Garage, openOpen, filledasks Close Garage?
Garage, opening or closingOpening, Closingstops the door, without a question

Calendar#

The next two events of a Home Assistant calendar, each with its time and title ("14:30", "now", "Tue 09:00", "all day"). Read-only: a tap does nothing. It is 2x1; a wider tile is allowed where the screen has room.

Calendar tiles: events, nothing planned, an all-day event and unavailable.
The next events of a calendar.
- entity: calendar.family

The device asks Home Assistant for the events of the next 7 days while the tab is shown. "No events" means nothing is planned in that time. Events that are already over are left out. Until the answer arrives, the calendar's own next event is shown.

Energy#

Today's energy use and solar production as two bars on one scale, in kWh. Read-only: a tap or long press opens the hourly usage bars (the usage sensor only).

Energy tile with used and solar bars, and with solar missing.
Used and solar, one scale.
- type: energy
  usage: sensor.energy_used_today
  solar: sensor.energy_solar_today

Either key may be left out; then only that row is shown. The values are "today so far": the change since local midnight, taken from Home Assistant statistics. So a running total such as sensor.shellypro3em_..._total_active_energy works as is, a daily utility meter too. The value can lag the real one by up to an hour (statistics are compiled by Home Assistant). - means no value (yet), n/a means both sensors are unavailable.

History graph on the tab#

Add display: graph to a sensor to draw its history right on the tab. This works for sensors and binary sensors, one entity only.

Graph widgets: line, step and bars.
Line, step or bars.
- entity: sensor.living_room_temperature
  display: graph
  history: 24

Graph options#

history accepts a number of hours (history: 48), false to switch it off, or a block:

Graph options: hours, min and max, statistic, period.
Graph options at a glance.
- entity: sensor.energy_today
  display: graph
  history:
    hours: 168
    type: bar
    statistic: sum
    period: day
KeyValuesDefaultEffect
hours1 to 72024How far back the graph goes.
typeauto, line, bar, stepautoThe shape.
statisticmean, min, max, sum, changemean (sum for energy sensors)What a bar shows. Only for type: bar.
periodauto, hour, dayautoThe width of a bar. Only for type: bar.
min, maxnumbers, min below maxautomaticFixes the vertical axis.
sourceauto, history, statisticsautoWhere the data comes from. Bars need statistics (the default picks it).

Not allowed: type: bar with source: history, and hourly bars over more than 128 hours.

The history popup#

Without display: graph, a tap or long press on a sensor still opens the history in a popup. Set history: false on the sensor to switch the popup off. The popup uses the same history options.

History graph popup with callouts.
Long press a sensor to see its history.

Sizes#

The size blocks and which widgets allow them.
Sizes each widget allows.
WidgetDefaultOther sizes
Light, switch, automation, binary sensor, notifications, alarm panel, lock, garage door1x1none
Energy2x1none
Sensor1x12x1
Weather2x11x1 (and wider with the forecast)
Cover, group, climate, vacuum, media playerwide (2 cells in portrait, 3 in landscape with 5 columns, 2 with 4 columns)none
Graph2x22x1 up to a full-width, 3 row block

A size a widget does not allow is changed to the nearest allowed one.

← Touch and buttonsTabs and layout →