Blocks Deprecated

Deprecated: use the web blocks for new pages This block belongs to state pages and UI components. Existing pages keep running, but new pages should use the web blocks. See Web Pages and the migration guide.

device overview

This block is part of the state ui group and was last modified in core v15.0.0.

device overview state v15.0.0

A ready-made overview of every device home automation knows about: grouped by room or adapter, with live capability readings, sparklines from the analytics store, and the devices that are discovered but not yet adopted. Renders from standard components, so it can be styled and taken apart like anything else.

In pins 11

title value v15.0.0
The heading above the overview. Defaults to the room or adapter being filtered on, and to "Home" when neither is set : a filtered overview titled "Home" describes itself wrongly.
group by value v15.0.0
How to section the cards: "room" (default), "adapter", or "none" for one flat grid of every device, alphabetical.
Default room
summarise condition v15.0.0
Draw one card per group instead of one per device: the group's name, how many devices are in it, and the aggregates that mean something for a group : mean temperature and humidity, total power, the lowest battery, and how many switchable things are on. Off by default.
Default false
adapter value v15.0.0
Show only devices from this adapter. Empty shows all.
room value v15.0.0
Show only devices in this room. Empty shows all.
show discovered condition v15.0.0
Include devices that have been discovered but not adopted. On by default: with auto_adopt off, a device that is visible but not yet in service is exactly what the operator needs to see.
Default true
show graphs condition v15.0.0
Draw a sparkline for numeric capabilities from the analytics store. Silently omitted on a node with no analytics store.
Default true
show camera views condition v15.0.0
Put a still frame on the card of every camera that can produce one. It is a still taken when the page loads, not a stream : nothing refreshes it : and the browser fetches each one lazily, so cameras nobody scrolls to cost nothing. Omitted for adapters with no camera behind them.
Default true
graph hours number v15.0.0
How many hours of history each sparkline covers.
Default 24
class uiclass v15.0.0
Assigns a CSS class to the outer element. • Hidden when unused
style uistyle v15.0.0
Applies inline CSS style to the outer element. • Hidden when unused

Out pins 3

state state
The overview, as components, for state_render_page's content pin.
devices array v15.0.0
The devices the overview drew, so a flow can count or filter them without asking twice.
adapters array v15.0.0
Adapter status: name, connected, device count.

device overview renders every adopted device grouped the way you ask, and it is the fastest way to get a working home automation screen: one block, no per-device wiring. Its devices and adapters out pins carry the same data as arrays, so the page can render the built-in overview inside a div and still drive its own counters from the numbers behind it.

Version history

Introduced in v15.0.0.

Back to state ui Return to the main group to view all sub-groups Back to homeassist ui Return to the group to view all blocks within this group