mirror of
https://github.com/Matysh/houseplan-card
synced 2026-09-30 11:49:16 +00:00
Agreed with the owner: whether a device is on the plan is a CHECKBOX
('Hide device from plan', every kind incl. virtual), not a runtime
algorithm. The old filter survives only as the SEEDER of those flags.
- marker.hidden is the flag; hidden devices are BUILT (room LQI counts
them — owner's decision) but rendered only in the device editor with
'Show hidden' on, ghosted. They cast no glow and no light fill: an
invisible device casts no visible light (owner's decision).
- seedHiddenBindings(): non-physical devices (excluded domains, Group,
scene, bridge, myheat children, grouped lamps) in bound areas WITHOUT a
marker. The editing client materialises them into hidden:true stub
markers, sets settings.filter_seeded, retires settings.show_all, and
strips fresh-hidden ids from the red-dot list. Unticking the checkbox
keeps a hidden:false marker — the seeder never revisits a marked device,
so the user's decision is final. New non-physical devices hide silently;
physical ones keep the red-dot flow.
- legacy configs (no filter_seeded) keep the OLD behaviour verbatim —
runtime filter, shared show_all, hidden-means-gone — until an editing
client materialises them, so a read-only tablet never sees a half-state.
- 'Show all' is renamed 'Show hidden' and is LOCAL to the tab; the shared
settings.show_all retires with the runtime filter.
- 'Remove from plan' disappears for auto/entity devices (the checkbox is
the way); a virtual device's Delete remains a real deletion.
- docs/FILTERING.md is the source of truth for the mechanism.
Tests: seeder/seeded/legacy/lights units (146), smoke_hidden_flag with 12
assertions (68 smokes). Inventory: 146 / 51 / 43 / 68.
145 lines
6.2 KiB
TypeScript
145 lines
6.2 KiB
TypeScript
/**
|
|
* Shared STATIC renderer for a single houseplan space — used by the read-only
|
|
* `houseplan-space-card`. Draws exactly what is CONFIGURED (plan background,
|
|
* configured room borders/names, device markers at their saved positions), with NO interactivity
|
|
* (pointer-events:none) and NO state subscription; room fills are rendered exactly as
|
|
* configured on the full card (a snapshot of the current states passed via `hass`).
|
|
* Geometry/model math lives in space-geometry.ts (pure, unit-tested).
|
|
*/
|
|
import { html, svg, nothing, type TemplateResult } from 'lit';
|
|
import { buildDevices, areaLqi, areaLights, areaTemp } from './devices';
|
|
import { spaceDisplayOf, roomFillStyle, fillColorsOf, roomFillModeOf } from './logic';
|
|
import { DEFAULT_ICON_RULES, compileIconRules, EXCLUDED_DOMAINS } from './rules';
|
|
import { t, type Lang } from './i18n';
|
|
import type { ServerConfig } from './types';
|
|
import {
|
|
spaceModels, roomCenter, defaultPositions, markerPos, labelPos, type Layout,
|
|
} from './space-geometry';
|
|
|
|
export { spaceModels } from './space-geometry';
|
|
|
|
export interface StaticRenderOpts {
|
|
hass: any;
|
|
cfg: ServerConfig;
|
|
layout: Layout;
|
|
spaceId: string;
|
|
iconSize?: number;
|
|
lang: Lang;
|
|
/**
|
|
* Resolve a stored content url to what the DOM may actually request — the
|
|
* plan lives behind `requires_auth`, so it needs an `authSig` signature.
|
|
* Returning '' means "not signed yet": the caller must render no <image>
|
|
* rather than an unsigned one, which would 401 (review R3-2).
|
|
*/
|
|
displayUrl?: (raw: string) => string;
|
|
}
|
|
|
|
/**
|
|
* Static schematic of one space. Returns the inner stage template (svg + marker
|
|
* layer) or null when the space id is unknown (the caller renders an error card).
|
|
*/
|
|
export function renderSpaceStatic(o: StaticRenderOpts): TemplateResult | null {
|
|
const models = spaceModels(o.cfg);
|
|
const space = models.find((s) => s.id === o.spaceId);
|
|
if (!space) return null;
|
|
const vb = space.vb;
|
|
const disp = spaceDisplayOf(o.cfg.spaces.find((s: any) => s.id === o.spaceId));
|
|
const cfgSize = o.iconSize ?? 2.5;
|
|
const iconPct = cfgSize > 8 ? 2.5 : cfgSize;
|
|
|
|
const areaToSpace: Record<string, string> = {};
|
|
for (const s of o.cfg.spaces || []) for (const r of (s as any).rooms || []) if (r.area) areaToSpace[r.area] = (s as any).id;
|
|
const excluded = o.cfg.settings?.exclude_integrations ? new Set(o.cfg.settings.exclude_integrations) : EXCLUDED_DOMAINS;
|
|
const iconRules = compileIconRules(
|
|
o.cfg.settings?.icon_rules?.length ? o.cfg.settings.icon_rules : DEFAULT_ICON_RULES,
|
|
);
|
|
const loc = (k: 'device.unnamed' | 'device.light_group' | 'device.fallback' | 'device.virtual') => t(o.lang, k);
|
|
const all = buildDevices({
|
|
hass: o.hass,
|
|
areaToSpace,
|
|
markers: o.cfg.markers || [],
|
|
settings: o.cfg.settings || {},
|
|
excluded,
|
|
showAll: !!o.cfg.settings?.show_all,
|
|
firstSpaceId: models[0]?.id || '',
|
|
loc,
|
|
iconRules,
|
|
});
|
|
// the static card never shows hidden devices — there is no editor here
|
|
const devs = all.filter((d) => d.space === o.spaceId && !d.hidden);
|
|
const defPos = defaultPositions(devs, space, iconPct);
|
|
|
|
const roomShapes = space.rooms
|
|
.filter((r) => r.area || disp.showBorders)
|
|
.map((r) => {
|
|
let cls = 'room ' + (space.bg ? 'overlay' : 'yard');
|
|
let style = '';
|
|
// tier 3 wins over the space, exactly as on the full card (HP-1454-07)
|
|
const fill = roomFillModeOf(disp.fill, r);
|
|
if (disp.showBorders || fill !== 'none') {
|
|
cls += ' styled';
|
|
const parts = [`--room-stroke:${disp.color}`, `--room-stroke-op:${disp.showBorders ? disp.opacity : 0}`];
|
|
// fill rendered exactly as configured on the full card (snapshot of current states)
|
|
const fillC = r.area
|
|
? roomFillStyle(
|
|
fill,
|
|
fill === 'lqi' ? areaLqi(o.hass, devs, r.area) : null,
|
|
fill === 'light' ? areaLights(o.hass, devs, r.area) : 'none',
|
|
fill === 'temp' ? areaTemp(o.hass, devs, r.area) : null,
|
|
disp.tempMin,
|
|
disp.tempMax,
|
|
fillColorsOf(o.cfg?.settings),
|
|
)
|
|
: null;
|
|
if (fillC) {
|
|
cls += ' filled';
|
|
parts.push(`--room-fill:${fillC.c}`, `--room-fill-op:${fillC.a.toFixed(3)}`);
|
|
} else {
|
|
parts.push('--room-fill:transparent', '--room-fill-op:0');
|
|
}
|
|
style = parts.join(';');
|
|
}
|
|
const svgLabel = !space.bg && !disp.showNames;
|
|
const c = roomCenter(r);
|
|
const shape = r.poly
|
|
? svg`<polygon class="${cls}" style="${style}" points="${r.poly.map((p) => p.join(',')).join(' ')}"></polygon>`
|
|
: svg`<rect class="${cls}" style="${style}" x="${r.x}" y="${r.y}" width="${r.w}" height="${r.h}" rx="${Math.min(r.w!, r.h!) * 0.03}"></rect>`;
|
|
return svg`${shape}${svgLabel ? svg`<text class="rlabel" x="${c[0]}" y="${c[1]}">${r.name}</text>` : nothing}`;
|
|
});
|
|
|
|
const markers = devs.map((d) => {
|
|
const p = markerPos(d, o.layout, o.cfg, defPos, space);
|
|
const left = ((p.x - vb[0]) / vb[2]) * 100;
|
|
const top = ((p.y - vb[1]) / vb[3]) * 100;
|
|
return html`<div class="dev ${d.virtual ? 'virtual' : ''}" style="left:${left}%;top:${top}%">
|
|
<ha-icon icon="${d.icon}"></ha-icon>
|
|
</div>`;
|
|
});
|
|
|
|
const labels = disp.showNames
|
|
? space.rooms
|
|
.filter((r) => r.name)
|
|
.map((r) => {
|
|
const p = labelPos(r, space.id, o.layout, o.cfg);
|
|
const left = ((p.x - vb[0]) / vb[2]) * 100;
|
|
const top = ((p.y - vb[1]) / vb[3]) * 100;
|
|
const op = Math.min(1, disp.opacity + 0.25);
|
|
return html`<div class="roomlabel" style="left:${left}%;top:${top}%;color:${disp.color};opacity:${op}">${r.name}</div>`;
|
|
})
|
|
: [];
|
|
|
|
const bgHref = space.bg ? (o.displayUrl ? o.displayUrl(space.bg.href) : space.bg.href) : '';
|
|
|
|
return html`
|
|
<div class="hp-static-stage" style="aspect-ratio:${vb[2]}/${vb[3]}">
|
|
<svg viewBox="${vb[0]} ${vb[1]} ${vb[2]} ${vb[3]}" preserveAspectRatio="xMidYMid meet">
|
|
${bgHref
|
|
? svg`<image href="${bgHref}" x="${space.bg!.x}" y="${space.bg!.y}" width="${space.bg!.w}" height="${space.bg!.h}" preserveAspectRatio="none" />`
|
|
: nothing}
|
|
${roomShapes}
|
|
</svg>
|
|
<div class="devlayer" style="--icon-size:${iconPct}cqw">${markers}${labels}</div>
|
|
</div>
|
|
`;
|
|
}
|