Skip to content

Reference

Jump to bottom
Alex RAMIREZ edited this page Oct 9, 2026 · 5 revisions

🇫🇷 Version française

Maquette reference

Every element of a Maquette card and every key it accepts, one section per element, with types, values, defaults, a valid YAML example and where to find it in the built-in editor.

This page is the exhaustive reference: a lookup table for every public key and enumerated value of version 0.2.0 (keys new in 0.2.0 are listed in Home › What's new in 0.2.0). The other pages of this wiki are the guides: Drawing the plan, Entities, Widgets, Ambience… If this page and the card disagree, the card is right: please report it.

Contents

Conventions

  • Units. Coordinates and sizes on the plan are in centimetres. x grows to the right, y grows downwards (screen convention). A point is [x, y], a segment [x1, y1, x2, y2], a polygon a list of points.
  • Angles are in degrees, clockwise (rotation, north, direction).
  • Entities. Any field typed entity takes a Home Assistant entity id (sensor.living_temperature). Fields typed attribute take an attribute name of that entity (current_temperature).
  • Booleans are true / false. For most boolean keys (outside, zoom, hidden, sub_area, protected, mirror, tint, alert, confirm, full_page, editor, legend, replay, showcase, when_away, average, marker, view_button, the keys of interaction, tablet and room_labels…), booleans written as text ("false", "no", "off", "0", "true", "yes"…) are read as booleans; numbers written as text ("120") are accepted for coordinates and numbers.
  • Free values. Names, entity ids, icons (mdi:…), colours (#rgb…#rrggbbaa, rgb() / hsl() with numeric values, a CSS colour name or var(--…)), numbers, coordinates, service data and HA states are copied as they are. Only keys and enumerated values (the Values column, listed again under Enumerated values) are part of the schema.
  • Checked values. Everything that ends up in the drawing is checked when the configuration is read: coordinates and numbers must be finite numbers (a point keeps only its x and y), enumerated values must be known, colours and icons must have the formats above. An invalid value is removed (never an error) with one warning in the browser console (maquette-card : invalid value(s) removed: …); texts are always shown as text. See Security.
  • Unknown keys. A key that is not in this page is ignored with a warning in the browser console (maquette-card : unknown key « … » (ignored)); an enumerated value written with its former French name gives maquette-card : unknown value « … » for « … » (ignored). Each warning is shown once per page. A configuration written with the former French keys of the development versions (pieces without rooms) is refused with a message asking to convert it to the English keys (CHANGELOG › Former French keys).
  • Omitted keys use the default shown. — means “absent / not set”. The editor removes a key whose value is put back to its default, so saved YAML stays minimal.
  • Common element keys. Rooms, openings, badges, texts and furniture also take hidden, level, group and locked (see Layers and Groups). locked: true: in the editor the element can still be selected and edited in its edit dialog, but it can no longer be moved or resized with the mouse or the arrow keys, and a click on it goes to the element underneath when there is one (padlock in its floating toolbar, its edit dialog and Layers › Plan elements). Walls and fences have no per-element lock: lock their whole layer (layers.locked: [walls, fences], see Layers).
  • Named colors. Every color key (color, animation.color, widget color, animations.<event>.color, ambience.traces.color, ambience.energy.color) also takes a name of the plan palette: the element follows the palette when it changes. A gauge severity keeps its fixed green, orange and red.
  • Editor paths use the English interface labels: Editor: ⚙ Settings › Display means the ⚙ Settings button of the editor toolbar (in the « More tools » menu ⋮ on phones), tab Display of its dialog. Add › Furniture is the Add button (key A), tab Furniture.

Card root

The card itself: its type, identity, title, and the lists of every element of the plan.

Key Type Values Default Description
type string custom:maquette-card — Card type (required). The former custom:plan-maison-card still works as an alias
id string written by the editor Identifier used by the editor to find the card when saving; also keys the per-browser layer choices
title string — Title above the plan. "" (empty) removes the header in tablet mode
summary list / bool 4 default chips Summary chips; false or [] = none
rooms list [] Rooms and sub-areas
walls list [] Walls
fences list [] Fences
openings list [] Openings
badges list [] Device badges
texts list [] Texts and info boxes
furniture list [] Furniture and connected furniture
panels object — Panels of the home view
layers object — Layers
groups list — Groups
templates list — Templates saved by the editor
ambience object — Ambience
animations object — Animations per event
alerts list — Full-plan alerts
badge_style object — Badge style
palette object name → color — Named colors, e.g. {accent: "#e8710a"}. Name: lowercase letter first, then lowercase letters, digits, _ or - (31 at most); color: #hex, rgb(), hsl(), CSS name or var(--…). Offered in every color picker of the editor (traces and energy flows have no color picker: YAML only); an element whose color is a name follows the palette (a removed name gives it its default color back). Editor: ⚙ Settings › Display › Named colors
replay bool / object — Replay
showcase bool / object — Showcase
interaction object — Interaction
tablet bool / object — Wall tablet
animation_level enum full reduced none full Animation level
demo bool — Demo
language, full_page, margin, editor, show_furniture, presence, room_labels, temperature_tint, legend Global settings
view_layout, layout_options, grid_options, visibility, card_mod Preserved Home Assistant keys 
type: custom:maquette-card
id: home
title: Home
rooms:
  - name: Living room
    poly: [[0, 0], [500, 0], [500, 420], [0, 420]]
walls:
  - [0, 0, 500, 0]

Editor: the card is added from the Home Assistant card picker: Maquette (custom:maquette-card, starts with one 4 × 3 m room and its walls, title "My plan") or Maquette — demo (custom:maquette-card-demo, always the demo). Add dashboard offers the strategies Maquette (custom:maquette: a dashboard "Home" with a panel view "Plan" and an empty card id: plan, converted to normal views on the first save) and Maquette — demo (custom:maquette-demo). title is in ⚙ Settings › General; id is written automatically on the first save.

Global settings

Card-wide options about how the card works rather than what it draws.

Key Type Values Default Description
language string auto en fr auto Interface language. auto follows the Home Assistant profile (French for fr*, English otherwise). Numbers and dates always follow the HA locale
full_page bool true Full-height layout without scrollbar when the card is at least 760 px wide
margin number (cm) editor: 0–2000, step 10 40 Margin around the drawing
editor bool true Show the editor (pencil) button, to administrators only. false hides it: remove the key in HA's code editor to get it back
show_furniture bool / enum true false desktop true false hides furniture (like furniture in layers.hidden); desktop shows it only when the card is at least 760 px wide
presence entity zone, person, group… zone.home Default presence for chips with show and alerts with when_away: a zone counts people (> 0 = somebody home), a person / group / binary sensor is present when home / on
room_labels object all true What room labels show, see below
room_labels.name bool true Room name (still read by screen readers when false)
room_labels.temperature bool true Temperature
room_labels.humidity bool true Humidity. A label left empty is hidden
temperature_tint object / false {min: 17, max: 28} Room colour by temperature, also the ends of the legend gradient. false = no tint and no gradient
temperature_tint.min number (°C) editor: −30–60, step 0.5 17 Blue at and below this temperature
temperature_tint.max number (°C) editor: −30–60, step 0.5 28 Red at and above. If min ≥ max, both fall back to the defaults
legend bool true false hides the legend under the plan 
language: en
full_page: true
margin: 60
editor: true
show_furniture: desktop
presence: group.family
room_labels:
  name: true
  temperature: true
  humidity: false
temperature_tint:
  min: 18
  max: 26
legend: false

Editor: ⚙ Settings. Every field, its key and its range:

Tab › section Field Key Values Default
General Title title text —
General Card language language Automatic / English / Français auto
General Full height on large screens full_page switch true
General Margin around the plan margin 0–2000 cm, step 10 40
General Edit button (pencil) editor switch (confirmation before hiding) true
Display Furniture shown show_furniture Always / Large screens (desktop) / Never true
Display Layers button for viewers layers.view_button switch false
Features Replay the day replay switch off
Features Replayed period (with replay) replay.hours 1–72 h 24
Features Starting speed (with replay) replay.speed ×60 / ×300 / ×900 / ×3600 900
Features Examples below the plan showcase switch off
Features Default presence presence entity zone.home
Features › Set elsewhere Full-plan alerts, Summary chips — links —
Rooms and legend › On room labels Room name / Temperature / Humidity room_labels.name / .temperature / .humidity switches true
Rooms and legend › Room color Tint by temperature temperature_tint switch (false when off) on
Rooms and legend › Room color Blue at / Red at (with the tint) temperature_tint.min / .max −30–60 °C, step 0.5, blue below red 17 / 28
Rooms and legend Legend below the plan legend switch true
People on the plan (only with ambience.people) People away / People at home / Avatar ambience.people.away / .at_home / .avatar see People direction / grouped / picture
Device badges Unavailable device / Inactive device / Badge size / Values in badges badge_style.* see Badge style
Interaction Tapping a room / Locked view / Back to the whole plan after interaction.* see Interaction; reset_after 0–3600 s, step 10
Interaction › Wall tablet Tablet mode, then Summary chips / Side panels / Screen burn-in protection tablet, tablet.* see Wall tablet
Interaction › Animations Animation level animation_level Full / Reduced / None full

A setting put back to its default is removed from the YAML; a number out of range is refused. Help texts are behind the ⓘ buttons. Under the dialog title: the installed version (Maquette 0.1.0), a Documentation link and Report an issue (the repository's issues).

Rooms and sub-areas

A room is a polygon with optional temperature and humidity sensors; tapping it opens its room view. With sub_area: true it becomes a sub-area: a dashed, named outline inside another room (kitchen, shower…).

Key Type Values Default Description
name string — Room name (label, room view, lists)
poly list of [x, y] ≥ 3 points required Outline. A room without 3 valid points is ignored
label [x, y] — Label position; no label without it
temperature entity — Temperature sensor: label value and room tint
humidity entity — Humidity sensor
temperature_attribute attribute — Read this attribute of temperature instead of its state (e.g. a weather or climate entity)
humidity_attribute attribute — Same for humidity
tap entity — Entity opened from the label in room view, and by interaction.room_tap: more_info (else temperature)
outside bool false Outdoor area: no temperature tint; receives the weather and stronger night tint
zoom bool true false: no room view on tap (terrace, courtyard…); the label still opens its entity
area string HA area id — Linked Home Assistant area: its devices, scenes and automations in the room view
auto_actions bool true Automatic buttons in the room view (lights, shutters)
automations bool true Show the linked automations and scripts in the room view
actions list — Custom buttons of the room view, see below
panels object {left, right} — Panels shown in this room's view
sub_area bool false Sub-area: dashed outline, no tint, no walls, not counted in the summary chips; a click opens the room that contains it
hidden bool false Hidden in the view (still counted in the summary chips)
level number 0 Order inside its layer (higher = on top)
group string group id — Editor group

Room buttons (rooms[].actions[]):

Key Type Values Default Description
name string — Button label
icon icon — Button icon
action string domain.service — Service called (e.g. scene.turn_on, light.turn_off). A sensitive service always asks for confirmation
target entity / enum an entity id, or room — Target entity; room = the whole room (its HA area if linked, else the room's entities of that domain)
data object {} Service data, copied as is
confirm bool false true: a confirmation dialog even for a safe service. A sensitive service is confirmed anyway 
rooms:
  - name: Living room
    poly: [[0, 0], [500, 0], [500, 420], [0, 420]]
    label: [250, 210]
    temperature: sensor.living_temperature
    humidity: sensor.living_humidity
    tap: sensor.living_temperature
    area: living_room
    auto_actions: true
    automations: true
    actions:
      - name: Movie mode
        icon: mdi:movie-open-outline
        action: scene.turn_on
        target: scene.movie
        data: {}
        confirm: true
      - {name: All off, icon: mdi:lightbulb-off, action: light.turn_off, target: room}
    panels:
      right:
        - {type: tile, title: Temperature, entity: sensor.living_temperature, history: 24}
  - name: Terrace
    poly: [[0, 420], [500, 420], [500, 700], [0, 700]]
    outside: true
    zoom: false
    temperature: weather.home
    temperature_attribute: temperature
    humidity: weather.home
    humidity_attribute: humidity
  - name: Kitchen
    sub_area: true
    poly: [[20, 20], [200, 20], [200, 120], [20, 120]]
    label: [110, 70]
    level: 1
    hidden: false
    group: ground_floor

Editor: toolbar Rectangular room with its walls (R) or Freeform room (P); Add › Rooms (Home Assistant area, All my HA areas). Click a room to select it: its handles appear and a small floating toolbar shows next to it (Edit, Duplicate, lock, Bring to front / Send to back, Delete). Edit, a double-click or Enter opens the room's edit dialog: tabs General (name, size, sensors, Outdoor, Sub-area…), Home Assistant area (link, Add the area's devices, entities to place on the walls) and Room view (Left panel / Right panel, Action buttons), with a live preview of the room cropped from the real plan (right on a computer, on top on a phone). Ctrl+Z undoes, Apply or Esc closes. Sub-areas: Add › Furniture › Sub-areas (kitchen, shower…).

Walls

Walls are plain thick segments. They only carry their layer and an optional group.

Item Type Values Default Description
[x1, y1, x2, y2] list of 4 numbers required Segment, from (x1, y1) to (x2, y2)
5th value string group id — Optional group: [x1, y1, x2, y2, "<id>"] 
walls:
  - [0, 0, 500, 0]
  - [500, 0, 500, 420, ground_floor]

Editor: toolbar Wall (M); select a wall for To boundary (turn it into a fence) and Split in two. Hide or lock all walls in Layers. Clean up the plan fixes gaps, offsets, stubs, duplicates and walls under openings, and flags windows without outside and shutters linked to nothing, with a preview (see Clean up the plan).

Fences

Fences and property limits: thinner, outlined segments, same format as walls.

Item Type Values Default Description
[x1, y1, x2, y2] list of 4 numbers required Segment
5th value string group id — Optional group 
fences:
  - [-300, -200, 900, -200]
  - [900, -200, 900, 800, garden]

Editor: toolbar Boundary / fence (L); select one for To wall and Split in two.

Openings

Windows, doors and gates drawn on a wall segment, with their contact, shutter or motorised entity.

Key Type Values Default Description
type enum window door gate required Kind of opening (drawing, icons)
seg [x1, y1, x2, y2] required Segment on the wall. An opening without a valid seg is ignored
name string — Name (lists, card header, open-openings chip)
contact entity / list up to 8 entities — Contact sensor: red when on / open. A list for one opening with several sensors (left and right leaf…): open as soon as one is, closed when one answers and none is open, unavailable only when all are; counted once, one line per sensor in its card
shutter entity — Shutter (cover): drawn on the outside, darker when closed, animated while moving
entity entity — Motorised opening (gate, garage door), used when there is no contact
outside [dx, dy] [-1, 0] [1, 0] [0, -1] [0, 1] [0, 0] Outside direction (left, right, up, down): the shutter is drawn on that side
shutter_only bool false Draw only the shutter, not the window line
bay string — Bay name: leaves with the same bay form one bay (one card, one line, counted once; one sun patch for the ambience light)
sill number (cm) 0–300 auto Ambience light: height of the bottom of the glazing (0 = down to the floor). Auto = 90, or 0 for a bay at least 180 cm wide (adjoining leaves added up)
height number (cm) 10–500 215 Ambience light: height of the top of the glazing (glazed door with glazed: top: 200)
glazed enum / bool full top (true = full) — Door only: a glazed door lets daylight in like a window (sky light, sun patch, bounced glow; its shutter counts). full = glazed full height (0 to 215 cm, patch at the foot of the door), top = small pane at the top (150 to 200 cm: patch further in, smaller, weaker sky light). sill and height still refine it
overhang number (cm) 0–500 — Ambience light: depth of a roof overhang above the window or door. It blocks the high sun (summer) and lets the low sun in (winter): the patch is shortened or removed depending on the elevation
overhang_height number (cm) 0–300 0 Height of the overhang above the top of the glazing
slats enum tilt vented — Ambience light, with a shutter: tilt = tilting slats, the lowered part lets light through according to the cover's current_tilt_position (100 = open); vented = a closed shutter still lets thin streaks of light through. Without it, a basic shutter (unchanged rendering)
leaves number 1 2 1 Number of leaves drawn (with swing)
swing enum left right sliding — Draws the leaves: hinge side seen from inside facing outside, or two sliding panels. Absent = nothing drawn
outward bool false Leaves open outward (left / right)
animation enum / object see Animations animations.opening This opening's animation while open
shutter_animation enum / object see Animations animations.shutter Its shutter's animation while moving
tap enum card more_info none card with a card, else more-info What a tap does, see Cards
protected bool false No “off” from the plan: no “off” switch in its card, switch greyed out while on in the room view
confirm bool false true: its on / off switch (card, room view) asks for confirmation, even for a safe service (e.g. a garage door driven by a switch)
card object / list — Its card
hidden bool false Hidden in the view (and left out of the room view)
level number 0 Order inside the Openings layer
group string group id — Editor group 
openings:
  - type: window
    seg: [90, 0, 410, 0]
    name: Living room window
    contact: binary_sensor.living_window
    shutter: cover.living_shutter
    outside: [0, -1]
    shutter_only: false
    bay: Living room bay
    animation: wave
    shutter_animation: {type: pulse, duration: 1}
    tap: card
    protected: false
    card:
      title: Living room bay
      widgets:
        - {type: cover, entity: cover.living_shutter}
  - type: door
    seg: [500, 100, 500, 190]
    contact: binary_sensor.front_door
    shutter: cover.front_door_shutter
    leaves: 1
    swing: right
    outward: false
    level: 1
  - type: gate
    seg: [200, -200, 500, -200]
    entity: cover.gate
    tap: more_info
    group: garden
    hidden: false
  - type: window                 # one bay, two sensors (left and right leaf)
    seg: [600, 0, 840, 0]
    name: Bedroom bay
    contact: [binary_sensor.bedroom_left, binary_sensor.bedroom_right]
    leaves: 2
    swing: sliding

bay is still there for leaves drawn as separate openings; one opening with a contact list is simpler when the leaves share one segment.

Editor: toolbar Opening (O), or Add › Openings: presets (Window + shutter + contact, Door + shutter + contact, French window + shutter + contact, Sliding bay window, Tilt and turn window, Garage door, Gate…) and Create an opening (type, leaves, swing, sensors, animation, preview; Add then draw it, or Save to My templates). Drawn on a wall, its sensors are looked up among the free entities of the bordering room (room area, else the HA area with the same name, else the only area whose name contains it or is contained in it): one match is linked, several open a short list (that room first, Other entity…, Skip), none is highlighted “to complete” (the edit dialog then opens on Sensors); outside points away from the indoor room. Select it for the floating toolbar, then Edit (or double-click, Enter) for its edit dialog, previewed in its room: tabs General (Type, Leaves, Opening, Outside side, Bay (grouped leaves), position), Sensors (Contact, Shutter, motorised entity), Light, Card and Animation; the footer has Edit in the workshop to apply another preset without redrawing. The dialog suggests a free contact or shutter of the same room, or the type matching the contact's device class. Add a sensor under Contact links another one (several free contacts in the room: tick them in the short list, then Link).

Device badges

A badge is a round device icon placed on the plan, coloured when its entity is active, with an optional value, light halo, animation and card.

Key Type Values Default Description
entity entity — Main entity: state, colour, more-info, on / off in its card
pos [x, y] required Position. A badge without a valid pos is ignored
icon icon mdi:circle Icon
name string entity name Tooltip, lists, card header
color colour HA active state colour (--state-active-color, else yellow) Colour when active
light_color bool guessed from color The colour is light: the icon is drawn dark when active
halo number (cm) / bool — Light halo radius while active; true = 130
room string a room name — Clip the halo to this room
alert bool false Alert badge: uses animations.alert (pulse) when active
active entity entity Entity that defines “active”
active_attribute attribute — Use this attribute of the active entity instead of its state
threshold number — Active when the active value is above this number. Without it: active for on, open, opening, closing, playing, heating, cooling, cleaning, detected, home
value entity — Numeric value shown in the badge
attribute attribute — Show this attribute of entity as the value (wins over value)
unit string entity unit Unit after the value (written as is, e.g. " °C")
decimals number 0–6 0 (attribute: 1) Decimals of value, or of a numeric attribute
tap enum card more_info none card with a card, else more-info See Cards
protected bool false No “off” from the plan: no “off” switch in its card, switch greyed out while on in the room view
confirm bool false true: its on / off switch (card, room view) asks for confirmation, even for a safe service (e.g. a garage door driven by a switch)
card object / list — Its card
animation enum / object see Animations animations.light, .alert or .badge Animation while active
hidden bool false Hidden in the view and in the room view (still counted in the summary chips)
level number 0 Order inside the Devices layer
zoom_only bool badge_style.zoom_only true: hidden on the whole plan, shown in the view of its room (always shown in the editor)
group string group id — Editor group 
badges:
  - entity: light.living_lamp
    pos: [230, 200]
    icon: mdi:floor-lamp
    name: Lamp
    color: "#f6c445"
    light_color: true
    halo: 170
    room: Living room
    animation: {type: halo, color: "#ffd54f"}
  - entity: switch.washer_plug
    pos: [60, 380]
    icon: mdi:washing-machine
    active: sensor.washer_power
    threshold: 5
    value: sensor.washer_power
    unit: " W"
    decimals: 0
    tap: card
    protected: true
    card: {title: Washer, widgets: [{type: tile, entity: sensor.washer_power, history: 24}]}
  - entity: climate.living_room
    pos: [300, 60]
    icon: mdi:thermostat
    attribute: temperature
    unit: " °C"
    active_attribute: hvac_action
    alert: false
    level: 2
    hidden: false
    group: ground_floor

Editor: Add › Devices (Light, Any device…), then click on the plan; select it for its floating toolbar, then Edit (double-click, Enter) for its edit dialog: tabs General (entity, name, icon, colour, Value shown on the badge…), Advanced settings, Card and Animation, previewed in its room.

Texts and info boxes

A text is a free label on the plan. With info, it becomes an info box: a framed list of live entity values.

Key Type Values Default Description
text string — The text; the title of an info box (optional there)
pos [x, y] required Centre. A text without a valid pos is ignored
size number 1 Size factor of the font (1 = default size); texts scale with the zoom
style enum subtle boxed Info boxes only: subtle = no background
info list — Lines of the info box, see below
hidden bool false Hidden in the view
level number 0 Order inside the Texts layer
group string group id — Editor group

Info box lines (texts[].info[]):

Key Type Values Default Description
entity entity — Entity shown (a tap opens its more-info)
name string entity name Line name
attribute attribute — Show this attribute instead of the state
unit string entity unit Unit
decimals number 1 (0 at 100 and above) Decimals
icon icon entity or measurement icon Icon 
texts:
  - text: Garden
    pos: [700, 500]
    size: 1.4
  - text: Outside
    pos: [700, -100]
    style: subtle
    level: 1
    group: garden
    hidden: false
    info:
      - {entity: sensor.outside_temperature}
      - {entity: sensor.living_humidity, name: Living room, decimals: 0}
      - {entity: climate.thermostat, attribute: current_temperature, unit: "°C", icon: mdi:thermostat}

Editor: toolbar Text (T) (the new text opens in its edit dialog, ready to type); Add › Info box, then Entity to add lines in the Entities tab of its edit dialog.

Furniture

Top-view symbols. Plain furniture never catches clicks in the view; furniture with an entity, a value or a card is connected furniture.

Key Type Values Default Description
type enum see the catalogue below, or custom required Symbol. An unknown type is drawn as a rectangle
shape list at most 40 shapes — custom only: the drawing, see below
pos [x, y] [0, 0] Centre
size [width, depth] / number 5–5000 each (the Create furniture workshop: up to 2000) catalogue size Size before rotation; a single number = a square
rotation number (°) 0 Clockwise rotation
mirror bool false Mirrored (corner sofa, bath…)
name string type name Tooltip; for area, the label drawn on the plan
chairs number 0–12 per table Tables only: number of chairs
tint bool true Connected furniture: tinted at rest (false = colour only when active)
hidden bool false Hidden in the view
level number 0 (-1 for rug and area) Order inside the Furniture layer
group string group id — Editor group
entity, value, active, active_attribute, threshold, attribute, unit, decimals, color, tap, protected, confirm, card, animation See Connected furniture 
furniture:
  - type: double_bed
    pos: [420, 160]
    size: [160, 200]
    rotation: 90
    name: Bed
  - type: corner_sofa
    pos: [150, 300]
    mirror: true
  - type: round_table
    pos: [380, 330]
    chairs: 5
  - type: area
    pos: [120, 80]
    size: [220, 140]
    name: Reading corner
    level: -1
    group: ground_floor
    hidden: false

Catalogue (category as shown in the editor, default size in cm as width × depth):

Category type Name Default size Notes
Living room sofa Sofa 200 × 90
Living room corner_sofa Corner sofa 250 × 200
Living room armchair Armchair 80 × 80
Living room coffee_table Coffee table 100 × 60
Living room tv_unit TV unit 160 × 45 colour #7e57c2
Living room shelf Shelf 100 × 35
Living room rug Rug 200 × 140 level −1
Living room plant Plant 45 × 45
Living room fireplace Fireplace / stove 100 × 50
Dining square_table Square table 90 × 90 4 chairs
Dining rect_table Rectangular table 160 × 90 6 chairs
Dining round_table Round table 110 × 110 4 chairs, round
Dining chair Chair 45 × 45
Kitchen counter Worktop 240 × 60
Kitchen sink Sink 100 × 60
Kitchen hob Hob 60 × 60 colour #ff7043
Kitchen fridge Fridge 60 × 65 colour #29b6f6
Kitchen washing_machine Washing machine 60 × 60 colour #42a5f5
Kitchen dishwasher Dishwasher 60 × 60 colour #42a5f5
Bedroom and office single_bed Single bed 90 × 190
Bedroom and office double_bed Double bed 160 × 200
Bedroom and office crib Cot 60 × 120
Bedroom and office wardrobe Wardrobe 120 × 60
Bedroom and office dresser Chest of drawers 100 × 50
Bedroom and office desk Desk 140 × 70 colour #fb8c00
Bedroom and office nightstand Bedside table 45 × 40
Bathroom shower Shower 90 × 90
Bathroom bathtub Bathtub 170 × 75
Bathroom washbasin Washbasin 60 × 45
Bathroom toilet Toilet 40 × 65
Utilities boiler Boiler 45 × 35 colour #ef5350
Utilities water_heater Water heater 55 × 55 round, colour #ef5350
Utilities radiator Radiator 80 × 12 colour #ef5350
Utilities electrical_panel Electrical panel 50 × 15 colour #fbc02d
Utilities router Router / NAS 35 × 25 colour #26a69a
Utilities ev_charger EV charger 30 × 20 colour #43a047
Utilities heat_pump Heat pump / AC (outdoor unit) 90 × 35 colour #26c6da
Shapes and areas area Named area 300 × 200 level −1
Shapes and areas rect Rectangle 100 × 60
Shapes and areas circle Circle 60 × 60 round
Shapes and areas stairs Stairs 90 × 280
Outdoor car Car 178 × 406 colour #43a047
Outdoor bike Bike 60 × 180
Outdoor tree Tree / shrub 200 × 200 round
Outdoor pool Pool 800 × 400

Rugs and named areas are drawn under the other furniture (level: -1 by default). Round types have no mirror button. The colour is the default accent of connected furniture of that type.

Editor: Add › Furniture (one tab, with Create furniture, the sub-areas and a section per category; search), click to place; select it for size, rotation (±15°, ±90°), Mirror, Chairs, Template.

Custom furniture

type: custom draws its shape: shapes in order (the last on top), coordinates in % of size from the top left corner, so the piece can be resized. Invalid values are bounded or dropped, never drawn as text. color (#rrggbb, a colour name or var(--…), anything else is dropped) tints the piece; connected, its accent and active look still apply.

Shape key Type Values Default Description
kind enum rect rounded_rect ellipse line polygon required Unknown kinds are dropped
x, y number (%) −50–150 0 Top left corner (rect, rounded_rect, ellipse)
w, h number (%) 0–200 100 Width and depth (rect, rounded_rect, ellipse)
radius number (cm) 0–500, at most half the smaller side 8 rounded_rect corner radius
points [[x, y], …] (%) 2–24 points (line), 3–24 (polygon) required line, polygon
style enum filled outline dashed filled Fill and stroke 
furniture:
  - type: custom
    pos: [250, 200]
    size: [180, 120]
    name: Corner bench
    color: "#188038"
    shape:
      - {kind: polygon, points: [[0, 0], [100, 0], [100, 40], [40, 40], [40, 100], [0, 100]]}
      - {kind: ellipse, x: 10, y: 10, w: 20, h: 20}
      - {kind: line, points: [[0, 50], [100, 50]], style: dashed}

Editor: Add › Furniture › Create furniture: start from a basic shape (rectangle, rounded rectangle, circle, L shape) or any catalogue piece (converted to shapes), set name, size (cm), category, search words, colour, shapes (cm) and optionally an entity, with a preview to scale; Add to place it or Save to My templates (shown in its category, with Edit). A placed piece opens in the same workshop from its edit dialog (Edit the shape, or Customize the shape for a catalogue piece). In the preview, shapes are selected, dragged and resized directly (8 handles, Shift: proportions; points of lines and polygons, + to add one, long press or Delete to remove one), snapping to a 5 cm grid and to edges and centres (Alt: off); arrows move by 1 cm (Shift: 10 cm), Ctrl+Z / Ctrl+Y undo inside the workshop. Values are stored in % of size with at most two decimals.

Connected furniture

Any piece of furniture becomes connected with an entity, a value or a card: accent tint, “active” look, value badge, and a tap target that opens its card or more-info. Same keys and meaning as device badges.

Key Type Values Default Description
entity entity — Main entity: state, active look, on / off in its card
value entity — Numeric value shown in a badge on the furniture (hidden below 24 px on screen)
active entity entity Entity that defines “active”
active_attribute attribute — Attribute of the active entity
threshold number — Active above this value (e.g. 50 W for a charger)
attribute attribute — Show this attribute of entity as the value
unit string entity unit Unit of the value
decimals number 0–6 0 Decimals of the value
color colour #rgb…#rrggbbaa, CSS name, var(--…) per type, else theme primary Accent colour (see the catalogue)
tint bool true false = coloured only when active
tap enum card more_info none card with a card, more_info with an entity or value, else none What a tap does
protected bool false No “off” switch in its card (fridge, freezer…)
confirm bool false true: its card's on / off switch asks for confirmation, even for a safe service
card object / list — Its card
animation enum / object see Animations animations.furniture Animation while active; shape: outline follows its outline 
furniture:
  - type: ev_charger
    pos: [495, -870]
    name: Charger
    entity: switch.charger_plug
    value: sensor.charger_plug_power
    active: sensor.charger_plug_power
    threshold: 50
    unit: W
    decimals: 0
    color: "#188038"
    tint: true
    tap: card
    protected: true
    animation: {type: wave, shape: outline}
    card:
      title: EV charging
      widgets:
        - {type: ev, title: Car, battery: sensor.ev_battery, power: sensor.charger_plug_power}
  - type: boiler
    pos: [40, 600]
    entity: climate.boiler
    active_attribute: hvac_action
    attribute: current_temperature

Editor: select the furniture › Connected (entity, value, tap behaviour, protected, Advanced settings); Fill from device proposes a card; Merge with “…” absorbs a badge of the same entity less than 1.5 m away.

Cards

A card is the dialog opened by tapping an opening, a badge or connected furniture: a header (icon, name, state, on / off switch, More info ⓘ button, ✕ to close) and a stack of widgets.

Key Type Values Default Description
card object / list — The card; a plain list is read as its widgets
card.title string element name Card title
card.widgets list widgets [] Widgets, in order (same types and keys as panels)
card.more_info entity / path / URL / false main entity What the header's More info ⓘ button does: an entity opens its HA more-info, a dashboard path (/lovelace/energy, not //…) navigates to it, a URL (http://… or https://…) opens in a new tab, false (or none) hides the button. Any other link (javascript:, data:…) is removed
tap enum card more_info none card when there is a card card opens the card, more_info the HA more-info of the main entity, none does nothing
protected bool false Never show the “off” switch (a “Turn back on” button only when it is off)
confirm bool false The on / off switch asks for confirmation, even for a safe service (the widgets of the card have their own confirm)

The on / off switch only appears for switch, light, fan, input_boolean and humidifier entities. Inside a card, rows show values (no toggles, no Activate button). The services a card can call are: the element's own turn_on / turn_off (the switch; never turn_off when protected), and the buttons of its cover (open / stop / close a cover or a valve), lock (lock / unlock / open) and thermostat (climate.set_temperature) widgets. Sensitive ones (unlock, open a garage door…) always ask for confirmation, see Security. card.more_info also accepts none (same as false).

badges:
  - entity: switch.fridge_plug
    pos: [80, 60]
    tap: card
    protected: true
    card:
      title: Fridge
      more_info: /lovelace/energy   # the ⓘ button opens the Energy dashboard
      widgets:
        - {type: tile, title: Power, entity: sensor.fridge_power, history: 24}
        - {type: entities, entities: [sensor.fridge_temperature, {entity: sensor.fridge_energy, name: Today}]}
openings:
  - type: door
    seg: [0, 100, 0, 190]
    contact: binary_sensor.back_door
    card:
      - {type: entities, entities: [binary_sensor.back_door, sensor.back_door_battery]}

Editor: select the opening, badge or furniture › Card: Add widget, Fill from device, Save card as template, “More info” button (default, another entity, a page, hidden); the right column shows the real card while it is selected.

Panels

Side columns of widgets next to the plan. The card's panels are shown in the home view; a room's panels in its room view.

Key Type Values Default Description
panels.left list widgets [] Left column (merged into one column on narrow screens)
panels.right list widgets [] Right column 
panels:
  left:
    - {type: tariff, title: Tariff, price: sensor.tempo_price, period: sensor.tempo_period}
  right:
    - {type: gauge, title: Power, entity: sensor.linky_power, min: 0, max: 9000}
rooms:
  - name: Office
    poly: [[0, 0], [300, 0], [300, 300], [0, 300]]
    panels:
      left: [{type: climate, rooms: [Office]}]
      right: []

Editor: Add widget below the Left panel / Right panel columns (or Add › Widgets); click a widget to edit it, drag to reorder. Room panels: select the room › Left panel / Right panel. Hidden by default in tablet mode.

Widgets

Widgets fill panels and cards. Every widget has a type; the keys below are shared, and each type adds its own (one key always means the same thing).

Key Type Values Default Description
type enum tariff ev gauge tile entities periods divider cover lock thermostat climate required Widget type
title string — Header title (tile, gauge, cover, lock, thermostat: entity name by default)
icon icon per type Header icon
color colour — Accent colour (gauge: arc colour)
rows list — Extra lines under tile, gauge, tariff, ev, cover, lock and thermostat, see below
confirm bool false (cover, lock: see their section) true: every service of the widget asks for confirmation, even a safe one: switches and Activate buttons of its rows, thermostat set point, cover and lock buttons. false never skips the confirmation of a sensitive service

Rows (rows[], also entities[] of the entities widget): an entity id, or an object:

Key Type Values Default Description
entity entity — Entity shown (tap = more-info)
name string entity name Line name
icon icon entity icon Line icon
decimals number 1 (0 at 100 and above) Decimals
unit string entity unit Unit 
panels:
  right:
    - type: tile
      title: Outside
      icon: mdi:thermometer
      color: "#1a73e8"
      entity: sensor.outside_temperature
      rows:
        - sensor.outside_humidity
        - {entity: sensor.outside_pressure, name: Pressure, icon: mdi:gauge, decimals: 0, unit: hPa}

Editor: Add › Widgets, or Add widget in a panel or a card; click the widget, then Edit in its floating toolbar: the edit dialog shows the widget itself as its preview (← or Esc goes back to the room or the card it belongs to). The editor also offers 65 ready-made widgets built on these types: see Widgets › Ready-made widgets.

Widget: tariff

Live electricity price, current period (peak / off-peak) and Tempo colours of today and tomorrow.

Key Type Values Default Description
price entity — Price sensor (unit, else €/kWh)
period entity — Current period; green when it contains “creuse” / “off-peak”, orange otherwise, neutral (outline) when unavailable or unknown
color_today entity — Tempo colour of today (Bleu / Blanc / Rouge or Blue / White / Red)
color_tomorrow entity — Tempo colour of tomorrow 
panels:
  left:
    - type: tariff
      title: Live rate
      price: sensor.tempo_price
      period: sensor.tempo_period
      color_today: sensor.tempo_today
      color_tomorrow: sensor.tempo_tomorrow

Widget: ev

Electric vehicle: battery ring, charging state, range and charging session.

Key Type Values Default Description
battery entity — Battery level (%)
range entity — Range
power entity — Charging power, in the entity's unit (W, kW or MW; no unit = W); shown in W, or kW from 1000 W
threshold number (W) 50 Charging when power (converted to W) is above
plugged entity — Plugged state (on, plugged, connected, true)
session_kwh entity — Energy of the session
session_cost entity — Cost of the session 
panels:
  left:
    - type: ev
      title: Car
      battery: sensor.ev_battery
      range: sensor.ev_range
      power: sensor.charger_power
      threshold: 50
      plugged: binary_sensor.ev_plugged
      session_kwh: sensor.charger_session
      session_cost: sensor.charger_session_cost

Widget: gauge

A value on an arc between a minimum and a maximum (green, then orange from 60 %, red from 85 %, unless color or severity).

Key Type Values Default Description
entity entity — Value
min number decimals allowed (pH: 6.5) 0 Start of the arc
max number decimals allowed 100 End of the arc (the editor proposes 9000)
unit string entity unit Unit
decimals number 1 (0 at 100 and above) Decimals
severity object green, yellow, red: numbers — Arc colour by value, like the HA gauge card: each colour applies from its value up to the next one (any order, any of the three) 
panels:
  right:
    - {type: gauge, title: Power, entity: sensor.linky_power, min: 0, max: 9000, unit: W, decimals: 0}
    - {type: gauge, title: CO₂, entity: sensor.living_co2, min: 400, max: 2000, unit: ppm, severity: {green: 0, yellow: 800, red: 1200}}
    - {type: gauge, title: Home battery, entity: sensor.home_battery, unit: "%", severity: {red: 0, yellow: 20, green: 50}}

Widget: tile

A large value with an optional history chart.

Key Type Values Default Description
entity entity — Value
unit string entity unit Unit
decimals number 1 (0 at 100 and above) Decimals
history number (h) — Hours of history chart; 0 or absent = no chart (the editor proposes 24) 
panels:
  right:
    - {type: tile, title: Fridge, entity: sensor.fridge_temperature, unit: "°C", decimals: 1, history: 24}

Widget: entities

A list of entities; lights, switches, fans, humidifiers and input booleans get a toggle, scenes, scripts and buttons an Activate button (values only inside a card); a script or a button asks for confirmation before it runs (a scene does not, unless the widget has confirm: true, which confirms its toggles too); a problem binary sensor (leak, smoke, gas, CO…) that is on shows in red.

Key Type Values Default Description
entities list rows — Same format as rows 
panels:
  left:
    - type: entities
      title: Lights
      entities:
        - light.living_lamp
        - {entity: switch.coffee_maker, name: Coffee, icon: mdi:coffee}

Widget: periods

A day / week / month / year table, from HA long-term statistics or from four entities per column.

Key Type Values Default Description
periods list day week month year all four Rows, in this order
columns list [] Columns, see below
note string — Note under the table

Columns (columns[]):

Key Type Values Default Description
name string — Column header
unit string — Unit under the header
stat entity — Cumulative sensor: change over the calendar day / week / month / year from HA statistics
factor number 1 Multiplier applied to the values, with stat or with the four entities (e.g. 0.001 for Wh → kWh)
decimals number 2 Decimals
day, week, month, year entity — Without stat: one entity per period
source enum stat entities — Written by the editor to remember which of the two the column uses 
panels:
  left:
    - type: periods
      title: Consumption
      periods: [day, week, month, year]
      note: From the Linky meter
      columns:
        - {name: Energy, unit: kWh, stat: sensor.energy_total, factor: 0.001, decimals: 1, source: stat}
        - name: Cost
          unit: €
          source: entities
          day: sensor.cost_day
          week: sensor.cost_week
          month: sensor.cost_month
          year: sensor.cost_year

Widget: divider

A horizontal line, with an optional section title.

Key Type Values Default Description
title string — Section title
spacing number (px) — Space above and below 
panels:
  left:
    - {type: divider, title: Heating, spacing: 12}

Widget: cover

Control of a cover (shutter, blind, gate, garage or motorised door) or a valve (water shut-off, irrigation): state, position bar, Open / Stop / Close.

Key Type Values Default Description
entity entity a cover.* or valve.* — The cover or valve; other domains are dropped
confirm bool true for device class garage, gate, door and for valves; else false Confirmation dialog before each button. Opening is always confirmed for a valve and for a cover that is not a shutter, blind, curtain, awning or window (false does not remove it)

Only cover.open_cover, cover.stop_cover and cover.close_cover (or valve.open_valve, valve.stop_valve, valve.close_valve) of this entity are ever called; Stop is hidden when the entity does not support it.

panels:
  left:
    - type: cover
      title: Gate
      entity: cover.gate
      confirm: true
      rows: [{entity: binary_sensor.gate_closed}]

Widget: lock

A lock entity: state (red when unlocked or jammed) and the useful action — Unlock when locked, Lock when unlocked, both when the state is uncertain (jammed, moving, unknown) — plus Open when the lock supports it.

Key Type Values Default Description
entity entity a lock.* — The lock; other domains are dropped
confirm bool unlock and open only true: Lock is confirmed too. Unlock and Open are always confirmed (false does not remove it)

Only lock.lock, lock.unlock and lock.open of this entity are ever called (no code is sent: a lock that needs one is operated from its more-info). Nothing happens from the editor's preview.

panels:
  left:
    - {type: lock, title: Front door, entity: lock.front_door}

Widget: thermostat

A climate entity: measured temperature, set point with −/+ (device step and limits), current action, mode.

Key Type Values Default Description
entity entity a climate.* — Thermostat
confirm bool false true: each −/+ asks for confirmation (climate.set_temperature) 
panels:
  right:
    - {type: thermostat, entity: climate.living_room, rows: [sensor.living_humidity]}

Widget: climate

Temperature and humidity of every room with sensors, with their trend over a duration and alerts.

Key Type Values Default Description
duration number (min) 5–240 30 Trend window (from HA history)
rooms list room names every room with a sensor Rooms shown (rooms sharing the same sensors are shown once)
outside bool true false hides outdoor rooms
average bool false First line: indoor average and its trend
stable_t number (°C) 0.3 Flat arrow below this change
alert_t number (°C) 1.5 Alert at or above this change
stable_h number (%) 2 Same for humidity
alert_h number (%) 10 Same for humidity
t_min, t_max number (°C) — Absolute temperature limits (alert outside)
h_min, h_max number (%) — Absolute humidity limits 
panels:
  right:
    - type: climate
      title: Room climate
      duration: 30
      rooms: [Bedroom, Living room]
      outside: false
      average: true
      stable_t: 0.3
      alert_t: 1.5
      stable_h: 2
      alert_h: 10
      t_min: 16
      t_max: 28
      h_min: 30
      h_max: 70

Summary chips

Chips above the plan. Without summary, four are shown: open openings, lights on, shutters down, indoor temperature. A list chooses, orders and extends them.

Key Type Values Default Description
type enum openings lights shutters temperature entity required Chip type, see below
icon icon per type Icon override
show enum away home always away: only when nobody is home; home: only when somebody is home
presence entity root presence (zone.home) Presence used by show
new_line bool false This chip starts a new line
below bool false This chip stacks under the previous one
type Shows Own keys
openings Open windows / doors (red when any; a bay counts once) —
lights Lights of the plan that are on —
shutters Shutters of the plan below 50 % —
temperature Mean temperature of the indoor rooms —
entity <value> <name> of any entity entity, name, unit, decimals, alert_above, alert_state, hide_if

entity chip keys:

Key Type Values Default Description
entity entity — Entity shown (tap = more-info)
name string entity name Text after the value; "" = value only
unit string entity unit Unit
decimals number 1 (0 at 100 and above) Decimals
alert_above number — Red chip above this value
alert_state string — Red chip when the state equals this
hide_if string — Hide the chip for this state (also hidden while the entity is missing) 
summary:
  - type: openings
  - type: lights
    show: home
  - type: shutters
    new_line: true
  - type: temperature
    icon: mdi:thermometer
    below: true
  - type: entity
    entity: sensor.ev_battery
    name: battery
    unit: "%"
    decimals: 0
    alert_above: 90
    alert_state: "unavailable"
    hide_if: "unknown"
    show: away
    presence: person.sam

Editor: click a chip above the plan, then Edit in its floating toolbar (preview: the chip itself); + Chip (Add a chip to the summary) adds one; drag a chip next to, under or below the others. Also ⚙ Settings › Features › Summary chips. Hidden by default in tablet mode.

Layers

Every element belongs to a fixed layer by kind. Two groups, each with its own order; the overlay group is always above the drawing.

Key Type Values Default Description
layers.drawing_order list rooms sub_areas halos furniture fences walls openings that order Drawing layers, bottom → top; missing ones follow in default order
layers.overlay_order list room_labels area_labels badges texts that order Layers above the drawing, bottom → top
layers.hidden list any layer [] Hidden in the view (drawn at 25 % and not clickable in the editor)
layers.locked list any layer [] Not selectable in the editor (clicks go through); no effect in the view
layers.view_button bool false Layers button next to the zoom buttons: each viewer hides layers for himself (kept in the browser)
hidden (on an element) bool false This element is hidden in the view
level (on an element) number 0 Order inside its layer, higher = on top (rug, area: -1)

area_labels holds the labels of named areas and sub-areas; badges the device badges; room_labels the room labels.

layers:
  drawing_order: [rooms, sub_areas, furniture, halos, fences, walls, openings]
  overlay_order: [room_labels, area_labels, badges, texts]
  hidden: [fences]
  locked: [walls, rooms]
  view_button: true

Editor: toolbar Layers, a dialog (drag or ↑ / ↓ to reorder, eye, padlock, Reset order, Plan elements: a click opens the element's edit dialog, Esc comes back to Layers); per element: Hide in view, Bring to front / Send to back; view_button also in ⚙ Settings › Display.

Groups

Groups bind elements so that they select and move together in the editor.

Key Type Values Default Description
groups[].id string — Group identifier, used by group
groups[].name string — Group name in the editor
group (on an element) string a group id — Membership of a room, opening, badge, text or furniture
5th value of a wall / fence string a group id — Membership of a wall or fence 
groups:
  - {id: garden, name: Garden}
badges:
  - {entity: light.garden, pos: [600, 500], group: garden}
fences:
  - [550, 450, 900, 450, garden]

Editor: select several elements (frame, Ctrl+click, Ctrl+A): the floating toolbar acts on all of them (Edit, Duplicate, lock, Delete); Edit opens a dialog with the shared settings (Align, Hide in view, group name) and the list of the selection, previewed together; Group (Ctrl+G) / Ungroup (Ctrl+Shift+G). The first click on a member selects the group, a second click the element alone.

Templates

Reusable elements saved by the editor and offered again in Add › My templates.

Key Type Values Default Description
name string — Template name
id string — Short identifier written by the workshops (Create a widget, Create an opening, Create furniture)
kind enum badge opening furniture widget — What item is
icon icon — Icon in the catalogue
description string — Subtitle in the catalogue
type enum furniture types, custom — furniture templates: the furniture type
category enum living dining kitchen bedroom bathroom utility shapes outdoor — Custom furniture: catalogue category it is listed in (else My templates)
keywords string — Custom furniture: extra search words
domain string an entity domain — badge templates: domain proposed when choosing the entity; furniture with ask: [entity]: domain looked up
item object — The element: a badge, an opening, a furniture or a widget, with the keys of that element (no position)
items list widgets — A whole card saved as a template: all its widgets
ask list widget key paths; contact shutter entity (openings); entity (furniture) — Entity fields to choose at each use: widgets leave them empty and highlighted “to complete” (entity, rows, columns.0.stat…); openings and furniture look them up in the room where they are placed

Without “Keep the entities”, entity keys are left out and asked again at each use; value: $entite stands for the chosen entity.

templates:
  - name: Ceiling light
    kind: badge
    icon: mdi:lightbulb
    domain: light
    item: {icon: mdi:lightbulb, color: "#f6c445", halo: 130}
  - name: My fridge
    kind: furniture
    type: fridge
    description: 70 × 72 cm
    item: {type: fridge, size: [70, 72], tap: more_info}
  - name: Bay window
    kind: opening
    icon: mdi:window-closed-variant
    item: {type: window, shutter_only: false}
  - name: Garden door
    id: p7c2m9de
    kind: opening
    icon: mdi:door
    ask: [contact, shutter]
    item: {type: door, leaves: 2, swing: left}
  - name: Corner bench
    id: b4n8q1zt
    kind: furniture
    type: custom
    category: living
    keywords: bench seat
    description: 180 × 120 cm
    item: {type: custom, size: [180, 120], color: "#188038", shape: [{kind: rect, x: 0, y: 0, w: 100, h: 100}]}
  - name: EV card
    kind: widget
    icon: mdi:card-text-outline
    description: Card · 2 widgets
    items:
      - {type: ev, title: Car, battery: sensor.ev_battery}
      - {type: divider}
  - name: Room CO₂
    id: k3f9x2qa
    kind: widget
    icon: mdi:molecule-co2
    description: Gauge
    ask: [entity]
    item: {type: gauge, title: Room CO₂, min: 400, max: 2000, unit: ppm, severity: {green: 0, yellow: 800, red: 1200}}

Editor: select an element › Template (Save as template); a card › Save card as template; Add a widget › Create a widget, Add › Create an opening or Create furniture › Save to My templates; reuse from Add › My templates.

Ambience

Optional, discreet layers drawn under the badges: night tint and sunlight, weather on outdoor rooms, traces of recent changes, energy flows and people. Never drawn while editing (except as a preview with its panel open); nothing leaves Home Assistant.

Key Type Values Default Description
intensity enum / number subtle normal strong, or 0–1 subtle Overall strength (0.45 / 0.7 / 1)
north number (°) 0 Where north points, clockwise from the top of the plan (45 = top right)
day_night bool / object on Day and night; false = off
weather entity / object — Weather
traces number / bool / object on, 10 min Traces; false = off
energy bool / object — Energy flows
people bool / list / object — People

As soon as ambience is present, day_night and traces are on unless set to false.

ambience:
  intensity: normal
  north: 45
  day_night: true
  weather: weather.home
  traces: 10
  energy: true
  people: true

Editor: toolbar Ambience and animations › Plan ambience, then Intensity, Plan north (°), Day and night, Weather, Traces (duration 0–240 min, step 5), Energy flow, People.

Day and night

Night tint from the sun's elevation (stronger outdoors), sunlight from the sun's side, warmer at sunrise and sunset, and a sun marker on the edge of the plan.

Key Type Values Default Description
day_night bool / object on true / {} = defaults, false = off
day_night.sun entity sun.sun Sun entity (elevation, azimuth)
day_night.intensity number 0–2 1 Factor on ambience.intensity
day_night.marker bool true Sun marker on the edge of the plan 
ambience:
  day_night: {sun: sun.sun, intensity: 1.2, marker: false}

Weather

The Home Assistant weather painted on outdoor rooms (outside: true): cloud shadows, rain, snow, hail, wind, fog, lightning.

Key Type Values Default Description
weather entity / object — A weather.* entity, or the object below
weather.entity entity — Weather entity (required in the object form)
weather.intensity number 0–2 1 Factor on ambience.intensity
weather.direction number (°) / enum an angle, or wind 135 Direction of travel, clockwise from the top (135 = top left → bottom right); wind = the real wind 
ambience:
  weather: {entity: weather.home, intensity: 0.8, direction: wind}

Traces

What just changed keeps a fading outline (numeric sensors excluded; a HA restart leaves no traces).

Key Type Values Default Description
traces number / bool / object 10 Duration in minutes; false or 0 = off
traces.duration number (min) up to 240 10 Fading duration
traces.color colour theme primary Trace colour 
ambience:
  traces: {duration: 15, color: "#1a73e8"}

Energy flows

Beads travelling from the electrical panel to every furniture / badge whose value is a power (W, kW), faster and more numerous as the power grows.

Key Type Values Default Description
energy bool / object — true / {} = defaults
energy.source number / enum a furniture index, or a furniture type electrical_panel Furniture the flows start from
energy.threshold number (W) 5 Minimum power to draw a flow
energy.color colour target colour, else type colour, else #fbc02d Flow colour
energy.badges bool true false: no flows to device badges (furniture only) 
ambience:
  energy: {source: electrical_panel, threshold: 20, color: "#fbc02d", badges: false}

People

People on the plan: at home side by side at a gathering point; away on the plan edge in their real direction with the distance or zone (HA home coordinates + north).

Key Type Values Default Description
people bool / list / object — true = every person.*; a list = these people; an object = the settings below
people.home [x, y] / string a point or a room name centre of the indoor rooms Gathering point at home (a room: its label position)
people.entities list person.* ids or {entity} every person.* People shown
people.entities[].entity entity — A person
people.away enum direction zone hidden direction Away: on the edge in their direction with the distance; zone: a row of chips along the bottom with the HA zone name; hidden: not shown
people.at_home enum grouped hidden grouped At home: side by side at home; or not shown
people.avatar enum picture initials picture HA profile picture (initials when there is none, or when it is not served by Home Assistant itself), or always initials
people.persons object {person.x: {away, at_home, avatar}} — Per-person overrides of away, at_home, avatar (they win over the shared ones) 
ambience:
  people:
    home: Living room
    entities: [person.sam, {entity: person.camille}]
    away: direction
    at_home: grouped
    avatar: picture
    persons:
      person.camille: {away: hidden}
      person.sam: {away: zone, avatar: initials, at_home: grouped}

Editor: shared away, at_home, avatar in ⚙ Settings › People on the plan; per person and home in Ambience and animations › People (drag the avatars on the plan to set home as [x, y]).

Light

Light from outside and from the lamps, on by default as soon as ambience is present. Static SVG (no animation, no filter), redrawn only when the sun (to the degree), a shutter, the moon phase or a lamp changes.

Key Type Values Default Description
light boolean / object true false = off; an object = the settings below
light.sun boolean / number 0 to 2 true Daylight through the window openings and glazed doors (glazed), clipped to the room. Every window that is not closed lets in sky light by day: a beam that widens into the room, brightest against the glass and fading with depth, in a slightly warm white blended in screen mode (it brightens the floor, never a grey veil), plus a faint light over the whole room, scaled to the number and size of its open windows (fades in during civil twilight, a little stronger on the sunny side, a little stronger when overcast). Windows facing the sun also get a soft-edged patch on the floor (direction from sun.sun azimuth + north, length from the elevation, shortened by the linked shutter) and a warm glow bounced around it. Adjoining leaves (same bay, same group, or in line and touching) form one bay with a single patch. With a meteo weather entity, the direct sun follows its cloud_coverage (10 % or less = full sun, 90 % or more = none), else its condition (overcast = none); rain, fog or snow remove it. Weather effects (clouds, fog, rain) stay outside: never painted over indoor rooms. false turns all daylight off (sky glow included); a number scales the direct patch only (1 = default, 0 = no patch, 2 = twice as bright)
light.sky boolean / number 0 to 2 true Strength of the sky glow (1 = default, 0 = none)
light.bounce boolean / number 0 to 2 true Strength of the glow bounced around the patches, sun and moon (1 = default, 0 = none)
light.sky_diffusion number 0 to 1 0.6 Diffusion of the sky light (and of the night-sky glow): 0 = a sharp beam, 1 = a wide blur that grows with the depth (nearly sharp against the glass, wider and wider into the room, no visible edge). Editor: Diffusion slider, 0 to 100 %
light.sky_kelvin auto / number 1800 to 10000 auto Sky light color as a color temperature (black body); auto = the default slightly warm white
light.sun_kelvin auto / number 1800 to 10000 auto Sun patch color (the bounced glow is a little warmer); auto = the default, golden near sunset
light.moon boolean / entity true, false or a sensor.* true At night, a cool light through the same windows. The moon's direction is computed by the card from the Home Assistant latitude / longitude and the time: a faint cool patch behind the windows that see it, only the night-sky glow through the others (and when the moon is down). Phase from a moon phase sensor (Moon integration, sensor.moon_phase used if present), else computed; stronger near full moon. Without coordinates, a glow straight through each window
light.doors enum open closed open Daylight of a lit room also reaches the next room through an inside door that is open (its contact on / open) or an interior glass wall (a window, or a glazed door, between two indoor rooms): a fainter light over the whole next room and a glow near the opening, one step only (not passed on further), lamps not included. closed = an inside door without a sensor counts as closed
light.lamps boolean true Halos of light.* badges with halo take the lamp color (rgb_color, else hs_color, else color_temp_kelvin) and brightness, blend (screen) where they overlap, and stay inside the lamp's room (room, else the room it is in) 
ambience:
  north: 45
  light: {sun: true, moon: sensor.moon_phase, lamps: true}
  # stronger and warmer: light: {sky: 1.6, bounce: 1.6, sun: 1.3, sky_kelvin: 5000, sun_kelvin: 3200}

Windows: sill at 90 cm and top at 215 cm; 180 cm wide or more = a bay down to the floor. Glazed doors: 0 to 215 cm (full) or 150 to 200 cm (top). Light grazing the wall (over 78°) is ignored. Editor: Ambience and animations › Light (sliders 0 to 200 %, color temperature with an Auto button), with a sample room to preview them at any time of day and in any weather.

Badge style

How device badges show on the plan. Every key is optional; the defaults keep the original look.

Key Type Values Default Description
badge_style.unavailable enum dimmed dashed hidden dimmed Unavailable device: faded, dashed outline, or not shown
badge_style.inactive enum shown active_only dimmed shown Inactive device: shown, shown only while active, or faded
badge_style.size enum small normal large normal 0.8 ×, 1 ×, 1.25 × (same size on screen whatever the zoom)
badge_style.values enum always hover never always Value in the badge: always, on hover / focus (always on touch screens), never
badge_style.zoom_only bool false true: badges only show in the view of their room; a badge's own zoom_only wins

A hidden badge still counts in the summary chips and still appears in the room view; a badge in a full-plan alert stays visible; in the editor every badge stays visible.

badge_style:
  unavailable: dashed
  inactive: active_only
  size: small
  values: hover

Editor: ⚙ Settings › Device badges.

Full-plan alerts

Rules that light up the whole plan while they hold: pulsing veil, banner (name, elements, details, hide until the next change), elements circled by a wave. Never while editing.

Key Type Values Default Description
name string Alert Banner title
entity entity — One watched entity
entities list of entities — Several watched entities
type enum openings — Watch every opening of the plan (each of its contact sensors, else entity; an opening is named once)
level enum critical warning info critical Red (critical), amber (warning), accent without pulse (info); the highest active level wins
icon icon per level Banner icon
above number — Active when the value is above
below number — Active when the value is below (if no above)
state string — Active when the state equals this (if no above / below)
when_away bool false Only when nobody is home
presence entity root presence (zone.home) Presence used by when_away
enabled bool true false turns the rule off without removing it

Without above, below or state, an entity is active when on, open, triggered or detected.

alerts:
  - name: Smoke detected
    entities: [binary_sensor.smoke_kitchen, binary_sensor.smoke_hall]
    level: critical
    icon: mdi:smoke-detector
  - name: Opening while nobody is home
    type: openings
    when_away: true
    presence: group.family
    level: warning
  - {name: Freezer too warm, entity: sensor.freezer_temperature, above: -12, level: warning}
  - {name: Cellar too cold, entity: sensor.cellar_temperature, below: 5, level: info, enabled: false}
  - {name: Alarm, entity: alarm_control_panel.home, state: triggered}

Editor: Ambience and animations › Full-plan alerts (Alert on entities, Opening, empty home); also ⚙ Settings › Features › Full-plan alerts.

Animations

One animation per event for the whole plan (animations); an opening, badge or connected furniture overrides it with its own animation (shutter_animation for a shutter).

Event key Applies to Default
animations.opening Door / window open {type: pulse, duration: 1.6}
animations.shutter Shutter moving {type: scroll, duration: 0.8}
animations.alert Badge with alert: true, while active {type: pulse, duration: 1.2}
animations.light light.* badge on {type: none, duration: 2.4}
animations.badge Other active badge {type: none, duration: 2}
animations.furniture Active connected furniture {type: none, duration: 2.4}

An animation is a type name (animation: halo) or an object:

Key Type Values Default Description
type enum none pulse breathe blink halo wave scroll per event none = colour only
color colour element colour Animation colour
duration number (s) 0.2–20 per event Seconds per cycle
intensity number 0.2–2 1 Strength
shape enum outline — Furniture: the wave follows its outline 
animations:
  opening: {type: pulse, duration: 1.6}
  shutter: {type: scroll, duration: 0.8}
  alert: {type: blink, duration: 1.2, intensity: 1.5}
  light: {type: halo, color: "#ffd54f"}
  badge: wave
  furniture: {type: breathe, duration: 3, shape: outline}
badges:
  - {entity: binary_sensor.motion, pos: [100, 100], animation: {type: wave, color: "#e91e63"}}

Editor: Ambience and animations › Animations per event (Default animations resets them); per element: its edit dialog › Animation. The animation level can reduce or stop them all.

Replay

A Replay the day button next to the zoom: the history of every entity of the plan is loaded once, then the whole plan (colours, openings, shutters, lights, ambience, people, alerts, side panels) is drawn at the chosen moment, with a timeline (play / pause, speed, marks). Never while editing.

Key Type Values Default Description
replay bool / object — true = defaults
replay.hours number (h) 1–72 24 Period replayed
replay.speed enum (number) 60 300 900 3600 900 Starting speed, in seconds of the day per second (the timeline still changes it) 
replay:
  hours: 48
  speed: 3600

Editor: ⚙ Settings › Features › Replay the day, Replayed period, Starting speed.

Showcase

Draws under the plan an example of every animation type, every weather and the ambience effects (night, low sun, trace, energy flow, alert, person away).

Key Type Values Default Description
showcase bool / object — true = under the plan
showcase.pos [x, y] under the plan, at margin Top-left corner
showcase.width number (cm) at least 700 plan width minus margins Width 
showcase:
  pos: [0, 1200]
  width: 1200

Editor: ⚙ Settings › Features › Examples below the plan.

Interaction

How the card reacts to touch. Without these keys it behaves as before. Never applied inside the editor.

Key Type Values Default Description
interaction.room_tap enum room_view more_info none room_view Tapping a room: room view; more-info of its tap entity (else temperature); nothing. A room with zoom: false keeps its own behaviour
interaction.lock_view bool false No panning nor wheel / pinch zoom, zoom buttons hidden; taps still work
interaction.reset_after number (s) 0–86400 (editor: step 10) 0 Back to the whole plan after this many seconds without interaction (room view, zoom, cards closed, paused replay back to live); 0 = never 
interaction:
  room_tap: more_info
  lock_view: true
  reset_after: 60

Editor: ⚙ Settings › Interaction (Tapping a room, Locked view, Back to the whole plan after).

Wall tablet

Tablet mode: the plan fills the whole card, full page, centred; summary chips and side panels hidden; with an empty title, no header. It does not lock the view (see Interaction).

Key Type Values Default Description
tablet bool / object false true = {summary: false, panels: false, burn_in: true}; an object sets each point
tablet.summary bool false Show the summary chips
tablet.panels bool false Show the side panels (home and rooms)
tablet.burn_in bool true Burn-in protection: the card moves by one pixel every 3 minutes, within 2 px 
title: ""
tablet: {summary: false, panels: true, burn_in: true}
interaction:
  lock_view: true
  reset_after: 60

Editor: ⚙ Settings › Interaction › Wall tablet (Tablet mode, Summary chips, Side panels, Screen burn-in protection).

Animation level

A global limit on motion. The system “reduce motion” setting is always respected.

Key Type Values Default Description
animation_level enum full reduced none full full: every animation; reduced: nothing loops (pulses, waves, weather, flows), short transitions; none: no animation nor transition. Replay and showcase follow it 
animation_level: reduced

Editor: ⚙ Settings › Interaction › Animations › Animation level.

Demo

A built-in demo apartment with simulated states; nothing is ever sent to the house.

Key Type Values Default Description
demo bool false true replaces the plan with the demo; only title and language of the config are kept 
type: custom:maquette-card
demo: true
title: Demo
language: en

Editor: none (the demo has no editor). The card picker offers Maquette — demo (custom:maquette-card-demo), and Add dashboard the Maquette — demo strategy. The demo also turns on replay and showcase.

Preserved Home Assistant keys

Keys that Home Assistant adds to any card (layout, visibility, card-mod). Maquette keeps them as they are, untranslated.

Key Type Values Default Description
view_layout any — Layout options of the view (masonry, panel, custom layouts)
layout_options any — Former sections-view layout
grid_options any — Sections-view size (columns, rows)
visibility list — Card visibility conditions
card_mod any — card-mod styles 
type: custom:maquette-card
grid_options: {columns: full, rows: auto}
visibility:
  - {condition: screen, media_query: "(min-width: 768px)"}
card_mod:
  style: "ha-card {border-radius: 24px}"

Editor: the HA dashboard editor (Layout and Visibility tabs); kept by the Maquette editor on save. An imported plan never brings these keys: the card keeps its own.

Security

Maquette runs in your Home Assistant frontend with the rights of the logged-in user. Import plans and templates only from people you trust; the card still protects you as follows.

Sensitive services are always confirmed. Every service called from the plan (room buttons, widgets in panels and cards, switches, Activate) is checked against a list of safe services. Any other service opens a short dialog that names the real action, the service (lock.unlock) and the target entities, whatever the button's label says; the keys of data are shown, never their values (a code stays hidden). Cancel has the focus; Escape cancels.

Safe (no dialog) Sensitive (always confirmed)
turn_on, turn_off, toggle of light, switch, fan, input_boolean, humidifier, media_player, climate, remote, automation; water heater on / off; fan, humidifier, climate, water heater and media player settings (speed, mode, temperature, volume, play / pause…) lock.unlock, lock.open
scene.turn_on; input_number, number, input_select, select values alarm_control_panel.alarm_disarm, alarm_trigger
cover.close_cover, stop_cover (and tilt); valve.close_valve, stop_valve opening a cover (open_cover, set_cover_position, toggle, tilt) unless every target is a shutter, blind, curtain, awning or window (device_class); garage doors, gates, doors and covers without a class are confirmed
lock.lock; alarm_control_panel.alarm_arm_* valve.open_valve, set_valve_position, toggle
homeassistant.turn_on / turn_off / toggle when every target is in a safe domain above; homeassistant.update_entity script.*, button.press, input_button.press, automation.trigger, homeassistant.restart / stop, shell_command, rest_command, notify… and any service not listed as safe

confirm: true forces the confirmation, even for a safe service, on anything that calls one: room buttons (actions[].confirm), badges, openings and connected furniture (their on / off switch, in their card and in the room view) and widgets (switches and Activate of their rows, thermostat −/+, cover and lock buttons). Typical case: a garage door, a gate or a heater driven by a switch. confirm: false never removes the confirmation of a sensitive service. protected: true (badges, openings, furniture) keeps the device from being turned off from the plan.

Import check. Export / import › Import first shows a summary and applies nothing until you confirm: the services of the room buttons (sensitive ones marked), the entities controlled by widgets (cover, lock, thermostat, Activate rows), the More info links, the values removed as invalid (with their path, e.g. rooms[0].poly), elements without valid coordinates, and the dashboard keys of the file that are ignored. Re-importing the plan unchanged applies it directly. Limits: 2 MB of text, 200,000 values, 40 levels of nesting, 5,000 items per list; YAML is read without its extended types; __proto__, constructor and prototype keys are dropped. Drafts and copies kept in the browser are read back the same way.

What is never drawn as code. Texts, names and HA states are escaped; numbers, enumerated values, colours, icons and links are checked (see Conventions); every piece of HTML the card or the editor builds goes through a filter that removes scripts, event handlers (on…), links other than #…, url() other than url(#…), and pictures not served by Home Assistant. The card makes no request outside Home Assistant.

Key index

Every public key, alphabetically, with the sections that document it.

Key Section(s)
above Full-plan alerts
action Rooms and sub-areas
actions Rooms and sub-areas
active Device badges, Connected furniture
active_attribute Device badges, Connected furniture
alert Device badges, Animations
alert_above Summary chips
alert_h Widgets, Widget: climate
alert_state Summary chips
alert_t Widgets, Widget: climate
alerts Card root, Full-plan alerts
ambience Card root, Ambience
animation Animations, Openings, Device badges, Connected furniture
animation_level Card root, Animation level
animations Card root, Animations
area Rooms and sub-areas
at_home People
attribute Device badges, Texts and info boxes, Connected furniture
ask Templates
auto_actions Rooms and sub-areas
automations Rooms and sub-areas
avatar People
average Widgets, Widget: climate
away People
badge Animations
badge_style Card root, Badge style
badges Card root, Device badges, Energy flows
battery Widgets, Widget: ev
bay Openings
below Summary chips, Full-plan alerts
burn_in Wall tablet
card Cards, Openings, Device badges, Connected furniture
card_mod Preserved Home Assistant keys
category Templates
chairs Furniture
color Widgets, Animations, Device badges, Connected furniture, Traces, Energy flows
color_today Widgets, Widget: tariff
color_tomorrow Widgets, Widget: tariff
columns Widgets, Widget: periods
confirm Rooms and sub-areas, Openings, Device badges, Connected furniture, Cards, Widgets, Widget: cover, Widget: lock, Widget: thermostat, Security
contact Openings
data Rooms and sub-areas
day Widget: periods
day_night Day and night, Ambience
decimals Summary chips, Widgets, Widget: gauge, Widget: tile, Widget: periods, Device badges, Texts and info boxes, Connected furniture
demo Card root, Demo
description Templates
direction Weather
domain Templates
drawing_order Layers
duration Widgets, Widget: climate, Animations, Traces
editor Global settings
enabled Full-plan alerts
energy Energy flows, Ambience
entities Widgets, Widget: entities, People, Full-plan alerts
entity Summary chips, Widgets, Widget: gauge, Widget: tile, Widget: cover, Widget: lock, Widget: thermostat, Openings, Device badges, Texts and info boxes, Connected furniture, Weather, People, Full-plan alerts
factor Widget: periods
fences Card root, Fences
full_page Global settings
furniture Card root, Furniture, Animations
glazed Openings
grid_options Preserved Home Assistant keys
group Rooms and sub-areas, Groups, Openings, Device badges, Texts and info boxes, Furniture
groups Card root, Groups
h Custom furniture
h_max Widgets, Widget: climate
h_min Widgets, Widget: climate
halo Device badges
height Openings
hidden Rooms and sub-areas, Layers, Openings, Device badges, Texts and info boxes, Furniture
hide_if Summary chips
history Widgets, Widget: tile
home People
hours Replay
humidity Rooms and sub-areas, Global settings
humidity_attribute Rooms and sub-areas
icon Summary chips, Rooms and sub-areas, Widgets, Device badges, Texts and info boxes, Templates, Full-plan alerts
id Card root, Groups, Templates
inactive Badge style
info Texts and info boxes
intensity Animations, Ambience, Day and night, Weather
interaction Card root, Interaction
item Templates
items Templates
keywords Templates
kind Templates, Custom furniture
label Rooms and sub-areas
lamps Light
language Global settings
layers Card root, Layers
layout_options Preserved Home Assistant keys
leaves Openings
left Rooms and sub-areas, Panels
legend Global settings
level Rooms and sub-areas, Layers, Openings, Device badges, Texts and info boxes, Furniture, Full-plan alerts
light Animations, Light
light_color Device badges
lock_view Interaction
locked Layers, Conventions (on an element)
margin Global settings
marker Day and night
max Widgets, Widget: gauge, Global settings
min Widgets, Widget: gauge, Global settings
mirror Furniture
month Widget: periods
moon Light
more_info Cards
name Summary chips, Rooms and sub-areas, Widgets, Widget: periods, Openings, Device badges, Texts and info boxes, Furniture, Groups, Templates, Full-plan alerts, Global settings
new_line Summary chips
north Ambience
note Widgets, Widget: periods
opening Animations
openings Card root, Openings
outside Rooms and sub-areas, Widgets, Widget: climate, Openings
outward Openings
overhang Openings
overhang_height Openings
overlay_order Layers
palette Card root
panels Rooms and sub-areas, Panels, Card root, Wall tablet
people People, Ambience
period Widgets, Widget: tariff
periods Widgets, Widget: periods
persons People
plugged Widgets, Widget: ev
points Custom furniture
poly Rooms and sub-areas
pos Device badges, Texts and info boxes, Furniture, Showcase
power Widgets, Widget: ev
presence Summary chips, Full-plan alerts, Global settings
price Widgets, Widget: tariff
protected Openings, Cards, Device badges, Connected furniture
radius Custom furniture
range Widgets, Widget: ev
replay Card root, Replay
reset_after Interaction
right Rooms and sub-areas, Panels
room Device badges
room_labels Global settings
room_tap Interaction
rooms Card root, Rooms and sub-areas, Widgets, Widget: climate
rotation Furniture
rows Widgets
seg Openings
session_cost Widgets, Widget: ev
severity (green, yellow, red) Widgets, Widget: gauge
session_kwh Widgets, Widget: ev
shape Animations, Furniture
show Summary chips
show_furniture Global settings
showcase Card root, Showcase
shutter Openings, Animations
shutter_animation Animations, Openings
shutter_only Openings
sill Openings
slats Openings
size Texts and info boxes, Furniture, Badge style
source Widget: periods, Energy flows
spacing Widgets, Widget: divider
speed Replay
stable_h Widgets, Widget: climate
stable_t Widgets, Widget: climate
stat Widget: periods
state Full-plan alerts
style Texts and info boxes, Custom furniture
sub_area Rooms and sub-areas
summary Card root, Summary chips, Wall tablet
sun Day and night, Light
swing Openings
t_max Widgets, Widget: climate
t_min Widgets, Widget: climate
tablet Card root, Wall tablet
tap Rooms and sub-areas, Openings, Cards, Device badges, Connected furniture
target Rooms and sub-areas
temperature Rooms and sub-areas, Global settings
temperature_attribute Rooms and sub-areas
temperature_tint Global settings
templates Card root, Templates
text Texts and info boxes
texts Card root, Texts and info boxes
threshold Widgets, Widget: ev, Device badges, Connected furniture, Energy flows
tint Furniture
title Card root, Widgets, Widget: divider, Cards
traces Traces, Ambience
type Card root, Summary chips, Widgets, Openings, Animations, Furniture, Templates, Full-plan alerts
unavailable Badge style
unit Summary chips, Widgets, Widget: gauge, Widget: tile, Widget: periods, Device badges, Texts and info boxes, Connected furniture
value Device badges, Connected furniture
values Badge style
view_button Layers
view_layout Preserved Home Assistant keys
visibility Preserved Home Assistant keys
w Custom furniture
walls Card root, Walls
weather Weather, Ambience
week Widget: periods
when_away Full-plan alerts
widgets Cards
width Showcase
x Custom furniture
y Custom furniture
year Widget: periods
zoom Rooms and sub-areas
zoom_only Device badges, Badge style

Enumerated values

Every enumerated value, by key.

<widget> stands for any widget: in panels.left / panels.right, in a room's panels, in a card or in a widget template (templates[].items); <person> for a person.* entity id.

Key path(s) Values
<widget>.columns[].source stat entities
<widget>.periods[] day week month year
<widget>.type tariff ev gauge tile entities periods divider cover lock thermostat climate
alerts[].level critical warning info
alerts[].type openings
ambience.energy.source
furniture[].type
templates[].type 		sofa corner_sofa armchair coffee_table tv_unit shelf rug plant fireplace square_table rect_table round_table chair counter sink hob fridge washing_machine dishwasher single_bed double_bed crib nightstand wardrobe dresser desk shower bathtub washbasin toilet boiler water_heater radiator electrical_panel router ev_charger heat_pump car bike tree pool area rect circle stairs custom
ambience.intensity subtle normal strong
ambience.people.at_home
ambience.people.persons.<person>.at_home 		grouped hidden
ambience.people.avatar
ambience.people.persons.<person>.avatar 		picture initials
ambience.people.away
ambience.people.persons.<person>.away 		direction zone hidden
ambience.weather.direction wind
animation_level full reduced none
animations.alert
animations.alert.type
animations.badge
animations.badge.type
animations.furniture
animations.furniture.type
animations.light
animations.light.type
animations.opening
animations.opening.type
animations.shutter
animations.shutter.type
badges[].animation
badges[].animation.type
furniture[].animation
furniture[].animation.type
openings[].animation
openings[].animation.type
openings[].shutter_animation
openings[].shutter_animation.type 		none pulse breathe blink halo wave scroll
animations.alert.shape
animations.badge.shape
animations.furniture.shape
animations.light.shape
animations.opening.shape
animations.shutter.shape
badges[].animation.shape
furniture[].animation.shape
openings[].animation.shape
openings[].shutter_animation.shape 		outline
badge_style.inactive shown active_only dimmed
badge_style.size small normal large
badge_style.unavailable dimmed dashed hidden
badge_style.values always hover never
badges[].tap
furniture[].tap
openings[].tap 		card more_info none
furniture[].shape[].kind
templates[].item.shape[].kind 		rect rounded_rect ellipse line polygon
furniture[].shape[].style
templates[].item.shape[].style 		filled outline dashed
interaction.room_tap room_view more_info none
layers.drawing_order[]
layers.hidden[]
layers.locked[]
layers.overlay_order[] 		rooms sub_areas halos furniture fences walls openings room_labels area_labels badges texts
openings[].type window door gate
openings[].swing
templates[].item.swing 		left right sliding
rooms[].actions[].target room
show_furniture desktop
summary[].show away home
summary[].type openings lights shutters temperature entity
templates[].kind widget furniture badge opening
templates[].category living dining kitchen bedroom bathroom utility shapes outdoor
texts[].style subtle

The same enumerations apply inside templates: templates[].item (badge, opening, furniture or widget keys) and templates[].items[] (widgets), and inside a card written as a plain list of widgets.

Not translated, but restricted by the card:

Key Values
language auto en fr (free string; anything else = auto)
show_furniture true false desktop
replay.speed 60 300 900 3600 (numbers)
openings[].outside [-1, 0] [1, 0] [0, -1] [0, 1]

Maquette · a living floor plan for Home Assistant · MIT · Issues · 🇬🇧 Home · 🇫🇷 Accueil

Maquette

Start

Plan

Home Assistant

Using the card

Practical

🇫🇷 Français

Clone this wiki locally