- ${r.map(([e, t, n]) => w`
+ ${r.map(([e, t, n]) => C`
${e}
${t}
@@ -2858,10 +2861,10 @@ var et = (e) => e <= 1.6 ? {
},
{
id: "entity-state",
- version: 1,
+ version: "0.5.0",
name: "Entity State",
description: "A prominent value from a single entity.",
- icon: qe,
+ icon: Je,
styles: o`
.entity-widget {
align-items: flex-start;
@@ -2941,20 +2944,20 @@ var et = (e) => e <= 1.6 ? {
type: "toggle"
}
],
- render: (e) => w`
+ render: (e) => C`
- ${J(Xe, "Entity state")}
- ${q(e, "title") || q(e, "entity") || "Choose an entity"}
+ ${q(Ze, "Entity state")}
+ ${K(e, "title") || K(e, "entity") || "Choose an entity"}
Live data
`
},
{
id: "text",
- version: 1,
+ version: "0.5.0",
name: "Text",
description: "A simple message or heading.",
- icon: Ke,
+ icon: qe,
styles: o`
.note-widget {
justify-content: center;
@@ -3034,19 +3037,19 @@ var et = (e) => e <= 1.6 ? {
]
}
],
- render: (e) => w`
-
-
${q(e, "title")}
-
${q(e, "text")}
+ render: (e) => C`
+
+ ${K(e, "title")}
+ ${K(e, "text")}
`
},
{
id: "weather",
- version: 4,
+ version: "0.5.0",
name: "Weather",
description: "Current conditions and a daily Home Assistant forecast.",
- icon: Qe,
+ icon: $e,
styles: o`
.weather-widget-placeholder {
align-items: center;
@@ -3101,15 +3104,41 @@ var et = (e) => e <= 1.6 ? {
selector: { boolean: {} }
}
],
- render: (e) => w`
+ render: (e) => C`
- ${J(Qe, "Weather")}
+ ${q($e, "Weather")}
Weather
- ${q(e, "weather") || "Choose a weather entity"}
+ ${K(e, "weather") || "Choose a weather entity"}
`
}
-], mt = (e) => pt.find((t) => t.id === e), ht = pt.map((e) => e.styles), gt = o`
+], Y = (e) => mt.find((t) => t.id === e), ht = (e) => {
+ let t = Y(e.id);
+ return t ? {
+ ...t,
+ version: e.version,
+ name: e.name,
+ description: e.description,
+ defaults: e.defaults,
+ options: e.fields
+ } : {
+ id: e.id,
+ version: e.version,
+ name: e.name,
+ description: e.description,
+ icon: e.icon,
+ defaults: e.defaults,
+ options: e.fields,
+ styles: o``,
+ render: () => C`
+
+ ${e.name}
+ Loading exact preview…
+
+ `
+ };
+}, gt = mt.map((e) => e.styles), _t = o`
.widget {
width: 100%;
height: 100%;
@@ -3172,24 +3201,24 @@ var Z = (e, t) => {
if (typeof n.code == "string" && n.code) return `${t} (${n.code})`;
}
return t;
-}, _t = (e) => {
+}, vt = (e) => {
let t = (/* @__PURE__ */ new Date()).toISOString();
return {
...structuredClone(e),
- id: G(),
+ id: W(),
name: `${e.name} copy`,
createdAt: t,
updatedAt: t,
regions: e.regions.map((e) => ({
...structuredClone(e),
- id: G()
+ id: W()
}))
};
}, Q = (e) => {
let t = e + 1, n = "";
for (; t > 0;) --t, n = String.fromCharCode(65 + t % 26) + n, t = Math.floor(t / 26);
return n;
-}, $ = class extends N {
+}, $ = class extends M {
constructor(...e) {
super(...e), this.store = {
schemaVersion: 1,
@@ -3199,9 +3228,9 @@ var Z = (e, t) => {
}
static {
this.styles = [
- $e,
- gt,
- ...ht
+ et,
+ _t,
+ ...gt
];
}
firstUpdated() {
@@ -3223,7 +3252,7 @@ var Z = (e, t) => {
return this.layoutDraft ?? this.project;
}
get canvasDisplay() {
- return W(this.canvasProject.displayId);
+ return U(this.canvasProject.displayId);
}
get canvasPixels() {
return {
@@ -3232,21 +3261,14 @@ var Z = (e, t) => {
};
}
displayName(e) {
- return e.displayId === "custom" ? "Custom display" : W(e.displayId).name;
+ return e.displayId === "custom" ? "Custom display" : U(e.displayId).name;
}
get selectedRegion() {
return this.project.regions.find((e) => e.id === this.selectedRegionId);
}
widgetDefinition(e) {
- let t = mt(e), n = this.widgetMetadata.find((t) => t.id === e);
- return !t || !n ? t : {
- ...t,
- version: n.version,
- name: n.name,
- description: n.description,
- defaults: n.defaults,
- options: n.fields
- };
+ let t = Y(e), n = this.widgetMetadata.find((t) => t.id === e);
+ return n ? ht(n) : t;
}
updatePreviewScale() {
if (!this.previewBoundary || !this.screenFit || !this.screenBezel) return;
@@ -3360,7 +3382,7 @@ var Z = (e, t) => {
}
async addProject() {
try {
- let e = dt(`Untitled display ${this.store.projects.length + 1}`), t = (await this.hass.callWS({
+ let e = ft(`Untitled display ${this.store.projects.length + 1}`, this.hass.language), t = (await this.hass.callWS({
type: "opendisplay_studio/create_project",
project: e
})).project;
@@ -3374,7 +3396,7 @@ var Z = (e, t) => {
}
}
async duplicateProject() {
- let e = _t(this.project), t = (await this.hass.callWS({
+ let e = vt(this.project), t = (await this.hass.callWS({
type: "opendisplay_studio/create_project",
project: e
})).project;
@@ -3413,10 +3435,10 @@ var Z = (e, t) => {
})), this.renameDialog?.close(), this.showToast("Name updated"));
}
applyDisplayProfile(e, t) {
- let n = W(e), r = lt(n, this.canvasProject.orientation), i = r.columns === this.canvasProject.grid.columns && r.rows === this.canvasProject.grid.rows, a = this.canvasProject.regions.flatMap((e) => e.widget ? [e.widget] : []), o = i ? this.canvasProject.regions : K(r).map((e, t) => ({
+ let n = U(e), r = ut(n, this.canvasProject.orientation), i = r.columns === this.canvasProject.grid.columns && r.rows === this.canvasProject.grid.rows, a = this.canvasProject.regions.flatMap((e) => e.widget ? [e.widget] : []), o = i ? this.canvasProject.regions : G(r).map((e, t) => ({
...e,
widget: a[t]
- })), s = rt(n, this.canvasProject.orientation);
+ })), s = it(n, this.canvasProject.orientation);
this.updateLayoutDraft((i) => ({
...i,
displayId: e,
@@ -3452,10 +3474,10 @@ var Z = (e, t) => {
let t = this.canvasProject.displayId === "custom" ? {
columns: this.canvasProject.grid.rows,
rows: this.canvasProject.grid.columns
- } : lt(this.canvasDisplay, e), n = e === "portrait" ? "clockwise" : "counterclockwise", r = ct(this.canvasProject.regions, this.canvasProject.grid, t, n), i = this.canvasProject.displayId === "custom" ? {
+ } : ut(this.canvasDisplay, e), n = e === "portrait" ? "clockwise" : "counterclockwise", r = lt(this.canvasProject.regions, this.canvasProject.grid, t, n), i = this.canvasProject.displayId === "custom" ? {
width: this.canvasProject.height,
height: this.canvasProject.width
- } : rt(this.canvasDisplay, e);
+ } : it(this.canvasDisplay, e);
this.updateLayoutDraft((n) => ({
...n,
orientation: e,
@@ -3475,7 +3497,7 @@ var Z = (e, t) => {
let n = Math.max(1, Math.min(24, Number(t.currentTarget.value))), r = {
...this.canvasProject.grid,
[e]: n
- }, i = this.canvasProject.regions.flatMap((e) => e.widget ? [e.widget] : []), a = K(r).map((e, t) => ({
+ }, i = this.canvasProject.regions.flatMap((e) => e.widget ? [e.widget] : []), a = G(r).map((e, t) => ({
...e,
widget: i[t]
}));
@@ -3494,7 +3516,7 @@ var Z = (e, t) => {
});
}
selectMergeCell(e) {
- let t = this.canvasProject.regions.find((t) => at(t, e));
+ let t = this.canvasProject.regions.find((t) => ot(t, e));
if (t && (t.label || t.rowSpan > 1 || t.columnSpan > 1)) return;
if (!this.mergeAnchor) {
this.mergeAnchor = e, this.mergeHover = e;
@@ -3504,7 +3526,7 @@ var Z = (e, t) => {
this.mergeAnchor = void 0, this.mergeHover = void 0, this.showToast("Remove the existing region before drawing across it");
return;
}
- let n = ot(this.canvasProject.regions, this.mergeAnchor, e);
+ let n = st(this.canvasProject.regions, this.mergeAnchor, e);
if (!n) {
this.mergeAnchor = void 0, this.mergeHover = void 0, this.showToast("The selected rectangle crosses an existing merged region");
return;
@@ -3524,7 +3546,7 @@ var Z = (e, t) => {
let t = this.canvasProject.regions.find((t) => t.id === e);
!t || t.rowSpan === 1 && t.columnSpan === 1 && !t.label || (this.updateLayoutDraft((t) => ({
...t,
- regions: st(t.regions, e)
+ regions: ct(t.regions, e)
})), this.selectedRegionId = "", this.mergeAnchor = void 0, this.mergeHover = void 0, this.showToast("Region removed"));
}
assignWidget(e) {
@@ -3567,7 +3589,7 @@ var Z = (e, t) => {
}));
}
renderProjectRail() {
- return w`
+ return C`
Displays + New
@@ -3576,40 +3598,40 @@ var Z = (e, t) => {
width: e.width,
height: e.height
};
- return w`
+ return C`
this.selectProject(e.id)}>
- ${e.grid.columns}×${e.grid.rows}
- ${e.name} ${this.displayName(e)} · ${e.status === "ready" ? "Ready" : "Draft"} ${e.status === "ready" ? w`media-source://opendisplay_studio/${e.id}` : E}${e.grid.columns}×${e.grid.rows}
+ ${e.name} ${this.displayName(e)} · ${e.status === "ready" ? "Ready" : "Draft"} ${e.status === "ready" ? C`media-source://opendisplay_studio/${e.id}` : T}
`;
})}
- ${J(Ge)} Delete
+ ${q(Ke)} Delete
`;
}
renderToolbar() {
let e = this.canvasProject, t = this.canvasDisplay;
- return w`
+ return C`
Device model
- ${U.filter((e) => e.family === "Newton Pro").map((e) => w`
+ ${H.filter((e) => e.family === "Newton Pro").map((e) => C`
${e.name} · ${e.nativeWidth}×${e.nativeHeight}${e.freezer ? " · mono" : ""}
`)}
- ${U.filter((e) => e.family === "OpenDisplay" && e.manufacturer === "Seeed Studio").map((e) => w`
+ ${H.filter((e) => e.family === "OpenDisplay" && e.manufacturer === "Seeed Studio").map((e) => C`
${e.name} · ${e.nativeWidth}×${e.nativeHeight}
`)}
- ${U.filter((e) => e.family === "OpenDisplay" && e.manufacturer !== "Seeed Studio").map((e) => w`
+ ${H.filter((e) => e.family === "OpenDisplay" && e.manufacturer !== "Seeed Studio").map((e) => C`
${e.name} · ${e.nativeWidth}×${e.nativeHeight}
`)}
@@ -3618,7 +3640,7 @@ var Z = (e, t) => {
- ${e.displayId === "custom" ? w`
+ ${e.displayId === "custom" ? C`
Width
Height
- ` : E}
+ ` : T}
Palette
- ${(e.displayId === "custom" ? Object.keys(z) : t.palettes).map((e) => w`${z[e]} `)}
+ ${(e.displayId === "custom" ? Object.keys(R) : t.palettes).map((e) => C`${R[e]} `)}
@@ -3651,23 +3673,23 @@ var Z = (e, t) => {
width: this.project.width,
height: this.project.height
};
- return w`
+ return C`
`;
}
renderScreenRegion(e) {
let t = e.widget ? this.widgetDefinition(e.widget.type) : void 0, n = e.columnSpan === 1 || e.rowSpan === 1, r = this.editorMode === "layout", i = !r && !!(this.previewImageUrl || this.previewError), a = !!e.label || e.rowSpan > 1 || e.columnSpan > 1, o = this.canvasProject.regions.filter((e) => e.label || e.rowSpan > 1 || e.columnSpan > 1).sort((e, t) => e.row - t.row || e.column - t.column), s = a ? e.label ?? Q(o.findIndex((t) => t.id === e.id)) : `${e.column}.${e.row}`;
- return w`
+ return C`
{
r && this.splitSelectedRegion(e.id);
}}
>
- ${i ? E : r ? a ? w`${s} ${e.columnSpan}×${e.rowSpan} region
` : E : t && e.widget ? t.render(e.widget.config, {
+ ${i ? T : r ? a ? C`${s} ${e.columnSpan}×${e.rowSpan} region
` : T : t && e.widget ? t.render(e.widget.config, {
compact: n,
palette: this.project.palette
- }) : w`Add widget ${e.columnSpan}×${e.rowSpan} region
`}
+ }) : C`Add widget ${e.columnSpan}×${e.rowSpan} region
`}
`;
}
renderMergeLayer() {
- if (this.editorMode !== "layout") return w``;
+ if (this.editorMode !== "layout") return C``;
let e = Array.from({ length: this.canvasProject.grid.columns * this.canvasProject.grid.rows }, (e, t) => ({
row: Math.floor(t / this.canvasProject.grid.columns) + 1,
column: t % this.canvasProject.grid.columns + 1
})), t = this.mergeHover ?? this.mergeAnchor, n = !!(this.mergeAnchor && t && this.selectionContainsComposedRegion(this.mergeAnchor, t));
- return w`
+ return C`
{
this.mergeHover = void 0;
}}>
${e.map((e) => {
- let r = this.canvasProject.regions.find((t) => at(t, e)), i = !!(r && (r.label || r.rowSpan > 1 || r.columnSpan > 1)), a = !!(this.mergeAnchor && t && e.row >= Math.min(this.mergeAnchor.row, t.row) && e.row <= Math.max(this.mergeAnchor.row, t.row) && e.column >= Math.min(this.mergeAnchor.column, t.column) && e.column <= Math.max(this.mergeAnchor.column, t.column));
- return w`
+ let r = this.canvasProject.regions.find((t) => ot(t, e)), i = !!(r && (r.label || r.rowSpan > 1 || r.columnSpan > 1)), a = !!(this.mergeAnchor && t && e.row >= Math.min(this.mergeAnchor.row, t.row) && e.row <= Math.max(this.mergeAnchor.row, t.row) && e.column >= Math.min(this.mergeAnchor.column, t.column) && e.column <= Math.max(this.mergeAnchor.column, t.column));
+ return C`
{
@dblclick=${(e) => {
e.preventDefault(), e.stopPropagation(), i && r && this.splitSelectedRegion(r.id);
}}
- >${i ? E : `${e.column}.${e.row}`}
+ >${i ? T : `${e.column}.${e.row}`}
`;
})}
@@ -3720,7 +3742,7 @@ var Z = (e, t) => {
width: e.width,
height: e.height
};
- return w`
+ return C`
${e.displayId === "custom" ? "CUSTOM DISPLAY" : `${t.manufacturer} · ${t.diagonal}″`} ${n.width} × ${n.height} px
@@ -3731,24 +3753,24 @@ var Z = (e, t) => {
id="display-screen"
class="display-screen ${this.editorMode === "widgets" && (this.previewImageUrl || this.previewError) ? "live-preview" : ""}"
data-palette=${e.palette}
- style=${I({
+ style=${F({
"--grid-columns": String(e.grid.columns),
"--grid-rows": String(e.grid.rows),
width: `${n.width}px`,
height: `${n.height}px`
})}
>
- ${this.editorMode === "widgets" && (this.previewImageUrl || this.previewError) ? w`
- ${this.previewImageUrl ? w`
` : w`
${this.previewError} `}
+ ${this.editorMode === "widgets" && (this.previewImageUrl || this.previewError) ? C`
+ ${this.previewImageUrl ? C`
` : C`
${this.previewError} `}
${e.regions.map((e) => this.renderScreenRegion(e))}
- ` : w`
+ ` : C`
${e.regions.map((e) => this.renderScreenRegion(e))}
${this.renderMergeLayer()}
`}
@@ -3756,14 +3778,14 @@ var Z = (e, t) => {
- ${this.editorMode === "layout" ? this.mergeAnchor ? w`
First corner selected. Move across the grid and click the opposite corner.
` : w`
Draw a region: Click two opposite corners. Double-click a region to remove it.
` : w`
Live preview: ${this.previewError ? this.previewError : this.previewLoading ? "Refreshing current Home Assistant data…" : this.previewTimings ? `Exact Renderer preview in ${this.previewTimings.pipeline.toFixed(1)} ms (${this.previewTimings.renderer.toFixed(1)} ms render). Select a region to configure it.` : "Select a region to configure its content."}
`}
+ ${this.editorMode === "layout" ? this.mergeAnchor ? C`
First corner selected. Move across the grid and click the opposite corner.
` : C`
Draw a region: Click two opposite corners. Double-click a region to remove it.
` : C`
Live preview: ${this.previewError ? this.previewError : this.previewLoading ? "Refreshing current Home Assistant data…" : this.previewTimings ? `Exact Renderer preview in ${this.previewTimings.pipeline.toFixed(1)} ms (${this.previewTimings.renderer.toFixed(1)} ms render). Select a region to configure it.` : "Select a region to configure its content."}
`}
`;
}
renderOption(e) {
let t = this.selectedRegion?.widget, n = t?.config[e.key] ?? (t ? this.widgetDefinition(t.type)?.defaults[e.key] : void 0), r = e.selector ?? (e.type === "calendar" ? { entity: { filter: { domain: "calendar" } } } : e.type === "entities" ? { entity: { multiple: !0 } } : e.type === "entity" ? { entity: {} } : void 0);
- return r ? w`
+ return r ? C`
{
}]}
@value-changed=${(t) => this.updateWidgetValue(e, t.detail.value[e.key])}
>
- ` : e.type === "toggle" ? w`
+ ` : e.type === "toggle" ? C`
${e.label}
- ` : e.type === "select" ? w`
+ ` : e.type === "select" ? C`
${e.label}
this.updateWidgetOption(e, t)}>
- ${e.options?.map((e) => w`${e.label} `)}
+ ${e.options?.map((e) => C`${e.label} `)}
- ` : e.type === "text" && e.multiline ? w`
+ ` : e.type === "text" && e.multiline ? C`
${e.label}
- ` : w`
+ ` : C`
${e.label}
-
`;
}
@@ -3814,21 +3836,22 @@ var Z = (e, t) => {
}
renderInspector() {
let e = this.selectedRegion;
- if (!e) return w`
+ if (!e) return C`
Region settings Select a region Choose a region on the display to assign a widget and configure its data.
`;
let t = e.widget ? this.widgetDefinition(e.widget.type) : void 0;
- return w`
+ return C`
Region settings R${e.row}:C${e.column} · ${e.columnSpan}×${e.rowSpan}
- ${pt.map((e) => w`
+ ${this.widgetMetadata.map((e) => C`
this.assignWidget(e.id)}>
- ${J(e.icon)}${e.name} ${e.description}
+ ${Y(e.id) ? q(Y(e.id).icon) : C`${e.name} ${e.description}
`)}
- ${t ? w`${t.options.map((e) => this.renderOption(e))}
${Y(Ge)} Remove widget
` : w`Choose a widget Each widget brings its own data source and configuration fields.
${t.options.map((e) => this.renderOption(e))}
${J(Ke)} Remove widget
` : C`Choose a widget Each widget brings its own data source and configuration fields.
`;
}
@@ -3837,7 +3860,7 @@ var Z = (e, t) => {
width: e.width,
height: e.height
};
- return w`
+ return C`
Step 1 · Device & layout
Prepare the canvas
@@ -3848,6 +3871,24 @@ var Z = (e, t) => {
Grid ${e.grid.columns} × ${e.grid.rows}
Regions ${e.regions.length}
+ {
+ let t = e.detail.value.language;
+ t && this.updateLayoutDraft((e) => ({
+ ...e,
+ language: t
+ }));
+ }}
+ >
+ The selected language is used by live preview, Media Source, and the physical display.
Click the first corner of a new region.
Move across the grid and click the opposite corner.
@@ -3857,7 +3898,7 @@ var Z = (e, t) => {
`;
}
renderRenameDialog() {
- return w`
+ return C`
Rename display Use a name that describes where this display will be installed.
Display name {
@@ -3870,12 +3911,12 @@ var Z = (e, t) => {
`;
}
renderWelcome() {
- return w`
+ return C`
@@ -3889,7 +3930,7 @@ var Z = (e, t) => {
Design an e-paper screen that fits the device.
Choose a verified display, compose its native-pixel layout, then add widgets and export the exact screen as PNG or JPG.
- ${Y(Je)} Create your first display
+ ${J(Ye)} Create your first display
1 Select hardware Model, palette and orientation
- ${this.toastMessage ? w`
${this.toastMessage}
` : E}
+ ${this.toastMessage ? C`
${this.toastMessage}
` : T}
`;
}
render() {
- return this.loading ? w`
Loading OpenDisplay Studio…
` : this.loadError ? w`
${this.loadError} Retry
` : this.store.projects.length === 0 ? this.renderWelcome() : w`
+ return this.loading ? C`
Loading OpenDisplay Studio…
` : this.loadError ? C`
${this.loadError} Retry
` : this.store.projects.length === 0 ? this.renderWelcome() : C`
- ${this.editorMode === "layout" ? w`Cancel ${Y(Ue)} Apply layout ` : w`
- ${Y(Ye)} Rename
- ${Y(We)} Duplicate
+ ${this.editorMode === "layout" ? C`Cancel ${J(We)} Apply layout ` : C`
+ ${J(Xe)} Rename
+ ${J(Ge)} Duplicate
this.setProjectStatus(this.project.status === "ready" ? "draft" : "ready")}>${this.project.status === "ready" ? "Move to Draft" : "Mark Ready"}
`}
@@ -3942,10 +3983,10 @@ var Z = (e, t) => {
${this.renderRenameDialog()}
- ${this.toastMessage ? w`
${this.toastMessage}
` : E}
+ ${this.toastMessage ? C`
${this.toastMessage}
` : T}
`;
}
};
-X([Fe({ attribute: !1 })], $.prototype, "hass", void 0), X([P()], $.prototype, "store", void 0), X([P()], $.prototype, "selectedRegionId", void 0), X([P()], $.prototype, "mergeAnchor", void 0), X([P()], $.prototype, "mergeHover", void 0), X([P()], $.prototype, "toastMessage", void 0), X([P()], $.prototype, "loading", void 0), X([P()], $.prototype, "saving", void 0), X([P()], $.prototype, "loadError", void 0), X([P()], $.prototype, "renameDraft", void 0), X([P()], $.prototype, "editorMode", void 0), X([P()], $.prototype, "layoutDraft", void 0), X([P()], $.prototype, "widgetMetadata", void 0), X([P()], $.prototype, "previewImageUrl", void 0), X([P()], $.prototype, "previewLoading", void 0), X([P()], $.prototype, "previewError", void 0), X([P()], $.prototype, "previewTimings", void 0), X([F(".preview-boundary")], $.prototype, "previewBoundary", void 0), X([F(".screen-fit")], $.prototype, "screenFit", void 0), X([F(".screen-bezel")], $.prototype, "screenBezel", void 0), X([F("#rename-dialog")], $.prototype, "renameDialog", void 0), $ = X([Me("opendisplay-studio-panel")], $);
+X([Ie({ attribute: !1 })], $.prototype, "hass", void 0), X([N()], $.prototype, "store", void 0), X([N()], $.prototype, "selectedRegionId", void 0), X([N()], $.prototype, "mergeAnchor", void 0), X([N()], $.prototype, "mergeHover", void 0), X([N()], $.prototype, "toastMessage", void 0), X([N()], $.prototype, "loading", void 0), X([N()], $.prototype, "saving", void 0), X([N()], $.prototype, "loadError", void 0), X([N()], $.prototype, "renameDraft", void 0), X([N()], $.prototype, "editorMode", void 0), X([N()], $.prototype, "layoutDraft", void 0), X([N()], $.prototype, "widgetMetadata", void 0), X([N()], $.prototype, "previewImageUrl", void 0), X([N()], $.prototype, "previewLoading", void 0), X([N()], $.prototype, "previewError", void 0), X([N()], $.prototype, "previewTimings", void 0), X([P(".preview-boundary")], $.prototype, "previewBoundary", void 0), X([P(".screen-fit")], $.prototype, "screenFit", void 0), X([P(".screen-bezel")], $.prototype, "screenBezel", void 0), X([P("#rename-dialog")], $.prototype, "renameDialog", void 0), $ = X([Ne("opendisplay-studio-panel")], $);
//#endregion
export { $ as OdxApp };
diff --git a/custom_components/opendisplay_studio/manifest.json b/custom_components/opendisplay_studio/manifest.json
index 81c36c4..764a88f 100644
--- a/custom_components/opendisplay_studio/manifest.json
+++ b/custom_components/opendisplay_studio/manifest.json
@@ -11,5 +11,5 @@
"issue_tracker": "https://github.com/Misiu/OpenDisplay-Studio-Integration/issues",
"requirements": ["python-liquid==2.3.1"],
"single_config_entry": true,
- "version": "0.3.6"
+ "version": "0.5.0"
}
diff --git a/custom_components/opendisplay_studio/projects.py b/custom_components/opendisplay_studio/projects.py
index 40a74ae..af210d1 100644
--- a/custom_components/opendisplay_studio/projects.py
+++ b/custom_components/opendisplay_studio/projects.py
@@ -3,6 +3,7 @@
from __future__ import annotations
import asyncio
+import re
from collections.abc import Iterable
from copy import deepcopy
from datetime import UTC, datetime
@@ -13,7 +14,7 @@
from homeassistant.helpers.storage import Store
from .const import STORAGE_KEY, STORAGE_VERSION
-from .widgets import WIDGET_DEFINITIONS
+from .widgets import DEFAULT_REGISTRY, WidgetRegistry
type Project = dict[str, Any]
@@ -22,7 +23,10 @@
MAX_NAME_LENGTH = 100
MAX_TEXT_LENGTH = 4_096
PALETTES = {"bw", "gray4", "gray16", "bwr", "bwy", "bwry", "spectra6"}
-WIDGET_TYPES = {item["id"] for item in WIDGET_DEFINITIONS}
+LANGUAGE_PATTERN = re.compile(r"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$")
+WIDGET_VERSION_PATTERN = re.compile(
+ r"^\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?(?:\+[0-9A-Za-z.-]+)?$"
+)
class ProjectValidationError(ValueError):
@@ -54,20 +58,42 @@ def _string(value: object, name: str, maximum: int = MAX_TEXT_LENGTH) -> str:
return result
-def _validate_widget(value: object) -> dict[str, Any] | None:
+def _widget_version(value: object) -> str:
+ """Validate one semantic widget version."""
+ if isinstance(value, str) and WIDGET_VERSION_PATTERN.fullmatch(value):
+ return value
+ raise ProjectValidationError("widget.version must be a semantic version")
+
+
+def _validate_widget(value: object, registry: WidgetRegistry) -> dict[str, Any] | None:
if value is None:
return None
if not isinstance(value, dict):
raise ProjectValidationError("widget must be an object")
widget_type = _string(value.get("type"), "widget.type", 50)
- if widget_type not in WIDGET_TYPES:
+ if widget_type not in registry.widget_types:
message = f"Unsupported widget type: {widget_type}"
raise _invalid(message)
config = value.get("config", {})
if not isinstance(config, dict):
raise ProjectValidationError("widget.config must be an object")
+ widget_definition = registry.definition(widget_type)
+ allowed_keys = set(widget_definition["defaults"])
+ allowed_keys.update(
+ field["key"]
+ for field in widget_definition["fields"]
+ if isinstance(field.get("key"), str)
+ )
+ unknown_keys = set(config) - allowed_keys
+ if unknown_keys:
+ message = (
+ f"{widget_type} widget has unknown configuration: "
+ f"{', '.join(sorted(str(key) for key in unknown_keys))}"
+ )
+ raise ProjectValidationError(message)
+ merged_config = {**widget_definition["defaults"], **config}
normalized_config: dict[str, str | int | float | bool | list[str]] = {}
- for key, item in config.items():
+ for key, item in merged_config.items():
if not isinstance(key, str) or not key or len(key) > 64:
raise ProjectValidationError("widget configuration key is invalid")
scalar = isinstance(item, str | int | float | bool) and not isinstance(
@@ -86,51 +112,47 @@ def _validate_widget(value: object) -> dict[str, Any] | None:
normalized_config[key] = [str(value) for value in item]
else:
normalized_config[key] = item
- if widget_type == "entity-state":
- layout = normalized_config.get("layout", "large")
- normalized_config = {
- "entity": str(normalized_config.get("entity", "")),
- "title": str(normalized_config.get("title", ""))[:MAX_NAME_LENGTH],
- "layout": str(layout) if layout in {"large", "compact"} else "large",
- "showIcon": bool(normalized_config.get("showIcon", True)),
- "showName": bool(normalized_config.get("showName", True)),
- "showUnit": bool(normalized_config.get("showUnit", True)),
- }
- elif widget_type == "calendar":
- days = normalized_config.get("days", 7)
- if isinstance(days, bool) or not isinstance(days, int) or not 1 <= days <= 31:
- raise ProjectValidationError("calendar days must be between 1 and 31")
- normalized_config = {
- "calendar": str(normalized_config.get("calendar", "")),
- "title": str(normalized_config.get("title", "Upcoming"))[:MAX_NAME_LENGTH],
- "days": days,
- "showLocation": bool(normalized_config.get("showLocation", True)),
- "showDescription": bool(normalized_config.get("showDescription", False)),
- "time24h": bool(normalized_config.get("time24h", True)),
- }
- elif widget_type == "weather":
- normalized_config = {
- "weather": str(normalized_config.get("weather", "")),
- "showHumidity": bool(normalized_config.get("showHumidity", True)),
- "showFeelsLike": bool(normalized_config.get("showFeelsLike", True)),
- "showForecast": bool(normalized_config.get("showForecast", True)),
- }
- elif widget_type == "text":
- align = normalized_config.get("align", "left")
- normalized_config = {
- "title": str(normalized_config.get("title", ""))[:MAX_NAME_LENGTH],
- "text": str(normalized_config.get("text", "Text"))[:MAX_TEXT_LENGTH],
- "align": align if align in {"left", "center", "right"} else "left",
- }
+ for field in widget_definition["fields"]:
+ key = field.get("key")
+ if not isinstance(key, str) or key not in normalized_config:
+ continue
+ item = normalized_config[key]
+ field_type = field.get("type")
+ selector = field.get("selector")
+ if field_type == "toggle" or (
+ isinstance(selector, dict) and "boolean" in selector
+ ):
+ normalized_config[key] = bool(item)
+ elif field_type == "number":
+ if isinstance(item, bool) or not isinstance(item, int | float):
+ message = f"{widget_type} {key} must be numeric"
+ raise ProjectValidationError(message)
+ minimum = field.get("min")
+ maximum = field.get("max")
+ if isinstance(minimum, int | float) and item < minimum:
+ message = f"{widget_type} {key} is too small"
+ raise ProjectValidationError(message)
+ if isinstance(maximum, int | float) and item > maximum:
+ message = f"{widget_type} {key} is too large"
+ raise ProjectValidationError(message)
+ elif field_type == "select":
+ allowed = {
+ option.get("value")
+ for option in field.get("options", [])
+ if isinstance(option, dict)
+ }
+ if item not in allowed:
+ normalized_config[key] = widget_definition["defaults"].get(key, "")
return {
"type": widget_type,
- "version": _integer(value.get("version", 1), "widget.version", 1, 100),
+ "version": _widget_version(value.get("version", widget_definition["version"])),
"config": normalized_config,
}
-def validate_project(value: object) -> Project:
+def validate_project(value: object, registry: WidgetRegistry | None = None) -> Project:
"""Validate and normalize a complete project payload."""
+ registry = registry or DEFAULT_REGISTRY
if not isinstance(value, dict):
raise ProjectValidationError("project must be an object")
name = _string(value.get("name"), "name", MAX_NAME_LENGTH)
@@ -145,6 +167,11 @@ def validate_project(value: object) -> Project:
status = value.get("status", "draft")
if status not in {"draft", "ready"}:
raise ProjectValidationError("status is invalid")
+ language = value.get("language", "system")
+ if not isinstance(language, str) or (
+ language != "system" and LANGUAGE_PATTERN.fullmatch(language) is None
+ ):
+ raise ProjectValidationError("language is invalid")
grid = value.get("grid")
if not isinstance(grid, dict):
raise ProjectValidationError("grid must be an object")
@@ -191,7 +218,7 @@ def validate_project(value: object) -> Project:
label = region.get("label")
if isinstance(label, str) and label.strip():
normalized_region["label"] = label.strip()[:MAX_NAME_LENGTH]
- widget = _validate_widget(region.get("widget"))
+ widget = _validate_widget(region.get("widget"), registry)
if widget is not None:
normalized_region["widget"] = widget
normalized_regions.append(normalized_region)
@@ -201,23 +228,53 @@ def validate_project(value: object) -> Project:
widget = region.get("widget")
if widget is None:
continue
+ widget_definition = registry.definition(widget["type"])
config = widget["config"]
- if widget["type"] == "entity-state" and not config["entity"]:
- raise ProjectValidationError(
- "Ready Entity State widgets require an entity"
+ for requirement in widget_definition["dataRequirements"]:
+ if requirement.get("optional"):
+ continue
+ config_key = requirement.get("configKey")
+ field: dict[str, Any] = next(
+ (
+ item
+ for item in widget_definition["fields"]
+ if item.get("key") == config_key
+ ),
+ {},
+ )
+ label = str(field.get("label", config_key or "data source")).lower()
+ source_value = (
+ config.get(config_key) if isinstance(config_key, str) else None
)
- if widget["type"] == "calendar" and not str(config["calendar"]).startswith(
- "calendar."
- ):
- raise ProjectValidationError(
- "Ready Calendar widgets require a calendar entity"
+ sources = (
+ source_value
+ if isinstance(source_value, list)
+ else [source_value]
+ if source_value
+ else []
)
- if widget["type"] == "weather" and not str(config["weather"]).startswith(
- "weather."
- ):
- raise ProjectValidationError(
- "Ready Weather widgets require a weather entity"
+ expected_domain = (
+ "calendar" if field.get("type") == "calendar" else None
)
+ selector = field.get("selector")
+ if isinstance(selector, dict):
+ entity_selector = selector.get("entity")
+ if isinstance(entity_selector, dict):
+ selector_filter = entity_selector.get("filter")
+ if isinstance(selector_filter, dict):
+ domain = selector_filter.get("domain")
+ if isinstance(domain, str):
+ expected_domain = domain
+ if sources and (
+ expected_domain is None
+ or all(
+ str(source).startswith(f"{expected_domain}.")
+ for source in sources
+ )
+ ):
+ continue
+ message = f"Ready {widget['type']} widgets require {label}"
+ raise ProjectValidationError(message)
display_id = value.get("displayId", "custom")
if not isinstance(display_id, str) or len(display_id) > 100:
@@ -226,6 +283,7 @@ def validate_project(value: object) -> Project:
"schemaVersion": 1,
"name": name,
"status": status,
+ "language": language,
"displayId": display_id or "custom",
"width": width,
"height": height,
@@ -239,13 +297,23 @@ def validate_project(value: object) -> Project:
class ProjectStore:
"""Home Assistant-native authoritative project storage."""
- def __init__(self, hass: HomeAssistant) -> None:
+ def __init__(
+ self, hass: HomeAssistant, registry: WidgetRegistry | None = None
+ ) -> None:
"""Initialize the versioned Store."""
self._store: Store[dict[str, Any]] = Store(
hass, STORAGE_VERSION, STORAGE_KEY, atomic_writes=True
)
self._projects: dict[str, Project] = {}
self._lock = asyncio.Lock()
+ self._default_language = hass.config.language
+ self._registry = registry or DEFAULT_REGISTRY
+
+ def _resolve_language(self, project: Project) -> Project:
+ """Pin legacy projects to the Home Assistant system language."""
+ if project["language"] == "system":
+ project["language"] = self._default_language
+ return project
async def async_load(self) -> None:
"""Load projects and discard malformed legacy entries safely."""
@@ -255,7 +323,9 @@ async def async_load(self) -> None:
return
for raw in raw_projects:
try:
- normalized = validate_project(raw)
+ normalized = self._resolve_language(
+ validate_project(raw, self._registry)
+ )
project_id = _string(raw.get("id"), "id", 64)
except ProjectValidationError:
continue
@@ -285,7 +355,7 @@ def get(self, project_id: str) -> Project | None:
async def async_create(self, value: object) -> Project:
"""Create a project with server-owned identity and timestamps."""
- normalized = validate_project(value)
+ normalized = self._resolve_language(validate_project(value, self._registry))
async with self._lock:
if len(self._projects) >= MAX_PROJECTS:
message = f"At most {MAX_PROJECTS} projects are allowed"
@@ -299,7 +369,7 @@ async def async_create(self, value: object) -> Project:
async def async_update(self, project_id: str, value: object) -> Project:
"""Replace editable fields while preserving stable identity."""
- normalized = validate_project(value)
+ normalized = self._resolve_language(validate_project(value, self._registry))
async with self._lock:
existing = self._projects.get(project_id)
if existing is None:
diff --git a/custom_components/opendisplay_studio/websocket.py b/custom_components/opendisplay_studio/websocket.py
index 5f9d8bb..f7d5869 100644
--- a/custom_components/opendisplay_studio/websocket.py
+++ b/custom_components/opendisplay_studio/websocket.py
@@ -17,7 +17,7 @@
validate_project,
)
from .renderer import RendererClient, RendererError
-from .widgets import WIDGET_DEFINITIONS
+from .widgets import DEFAULT_REGISTRY, WidgetRegistry
def _store(hass: HomeAssistant) -> ProjectStore:
@@ -36,6 +36,14 @@ def _renderer_client(hass: HomeAssistant) -> RendererClient:
return cast("RendererClient", client)
+def _widgets(hass: HomeAssistant) -> WidgetRegistry:
+ """Return the discovered package registry used by every render surface."""
+ return cast(
+ "WidgetRegistry",
+ getattr(hass.data[DOMAIN], "widgets", DEFAULT_REGISTRY),
+ )
+
+
def _error(
connection: websocket_api.ActiveConnection,
msg: dict[str, Any],
@@ -55,7 +63,7 @@ def websocket_bootstrap(
"""Return authoritative projects and widget metadata."""
connection.send_result(
msg["id"],
- {"projects": _store(hass).list(), "widgets": WIDGET_DEFINITIONS},
+ {"projects": _store(hass).list(), "widgets": _widgets(hass).definitions},
)
@@ -141,7 +149,7 @@ async def websocket_compose_preview(
) -> None:
"""Render the same live PNG used by Media Source."""
try:
- project = validate_project(msg["project"])
+ project = validate_project(msg["project"], _widgets(hass))
composed = await async_compose_project(hass, project)
rendered = await _renderer_client(hass).async_render(
html=composed.html,
diff --git a/custom_components/opendisplay_studio/widgets.py b/custom_components/opendisplay_studio/widgets.py
deleted file mode 100644
index 3720e56..0000000
--- a/custom_components/opendisplay_studio/widgets.py
+++ /dev/null
@@ -1,224 +0,0 @@
-"""Built-in widget definitions and Liquid templates."""
-
-from __future__ import annotations
-
-from pathlib import Path
-from typing import Any, Final
-
-TEMPLATE_DIRECTORY: Final = Path(__file__).with_name("widget_templates")
-
-WIDGET_DEFINITIONS: Final[list[dict[str, Any]]] = [
- {
- "id": "entity-state",
- "version": 1,
- "name": "Entity State",
- "description": "Current state of a Home Assistant entity.",
- "icon": "mdi:gauge",
- "defaults": {
- "entity": "",
- "title": "",
- "layout": "large",
- "showIcon": True,
- "showName": True,
- "showUnit": True,
- },
- "fields": [
- {"key": "entity", "label": "Entity", "type": "entity", "required": True},
- {"key": "title", "label": "Title", "type": "text"},
- {
- "key": "layout",
- "label": "Layout",
- "type": "select",
- "options": [
- {"label": "Large value", "value": "large"},
- {"label": "Compact", "value": "compact"},
- ],
- },
- {"key": "showIcon", "label": "Show icon", "type": "toggle"},
- {"key": "showName", "label": "Show name", "type": "toggle"},
- {"key": "showUnit", "label": "Show unit", "type": "toggle"},
- ],
- "dataRequirements": [
- {
- "key": "entity",
- "provider": "entity_state",
- "configKey": "entity",
- "cardinality": "one",
- "optional": False,
- }
- ],
- },
- {
- "id": "calendar",
- "version": 1,
- "name": "Calendar",
- "description": "Upcoming events from one Home Assistant calendar.",
- "icon": "mdi:calendar",
- "defaults": {
- "calendar": "",
- "title": "Upcoming",
- "days": 7,
- "showLocation": True,
- "showDescription": False,
- "time24h": True,
- },
- "fields": [
- {
- "key": "calendar",
- "label": "Calendar",
- "type": "calendar",
- "required": True,
- },
- {"key": "title", "label": "Title", "type": "text"},
- {"key": "days", "label": "Days", "type": "number", "min": 1, "max": 31},
- {"key": "showLocation", "label": "Show location", "type": "toggle"},
- {"key": "showDescription", "label": "Show description", "type": "toggle"},
- {"key": "time24h", "label": "24-hour time", "type": "toggle"},
- ],
- "dataRequirements": [
- {
- "key": "calendar",
- "provider": "calendar",
- "configKey": "calendar",
- "cardinality": "one",
- "optional": False,
- "rangeConfigKey": "days",
- }
- ],
- },
- {
- "id": "weather",
- "version": 4,
- "name": "Weather",
- "description": "Current conditions and a daily Home Assistant forecast.",
- "icon": "mdi:weather-partly-cloudy",
- "defaults": {
- "weather": "",
- "showHumidity": True,
- "showFeelsLike": True,
- "showForecast": True,
- },
- "fields": [
- {
- "key": "weather",
- "label": "Weather entity",
- "required": True,
- "selector": {
- "entity": {
- "filter": {
- "domain": "weather",
- }
- }
- },
- },
- {
- "key": "showHumidity",
- "label": "Show humidity",
- "selector": {"boolean": {}},
- },
- {
- "key": "showFeelsLike",
- "label": "Show feels like",
- "selector": {"boolean": {}},
- },
- {
- "key": "showForecast",
- "label": "Show forecast",
- "selector": {"boolean": {}},
- },
- ],
- "dataRequirements": [
- {
- "key": "weather",
- "provider": "weather_forecast",
- "configKey": "weather",
- "cardinality": "one",
- "optional": False,
- "forecastType": "daily",
- }
- ],
- },
- {
- "id": "text",
- "version": 1,
- "name": "Text",
- "description": "Static heading and body text.",
- "icon": "mdi:text",
- "defaults": {"title": "", "text": "Text", "align": "left"},
- "fields": [
- {"key": "title", "label": "Title", "type": "text"},
- {"key": "text", "label": "Text", "type": "text", "multiline": True},
- {
- "key": "align",
- "label": "Alignment",
- "type": "select",
- "options": [
- {"label": "Left", "value": "left"},
- {"label": "Center", "value": "center"},
- {"label": "Right", "value": "right"},
- ],
- },
- ],
- "dataRequirements": [],
- },
-]
-
-ENTITY_TEMPLATE: Final = """
-
-
- {% if config.showIcon %}
-
- {% endif %}
- {% if config.showName %}
-
{{ data.entity.displayName }}
- {% endif %}
-
-
- {{ data.entity.state }}
- {% if config.showUnit and data.entity.unit %}{{ data.entity.unit }} {% endif %}
-
-
-
-"""
-
-CALENDAR_TEMPLATE: Final = """
-
-
{{ config.title }}
- {% if data.calendar.events.size > 0 %}
-
- {% for event in data.calendar.events %}
- {{ event.time }} {{ event.summary }} {% if config.showLocation and event.location %}{{ event.location }} {% endif %}{% if config.showDescription and event.description %}{{ event.description }} {% endif %} {% endfor %}
-
- {% else %}
No upcoming events {% endif %}
-
-"""
-
-TEXT_TEMPLATE: Final = """
-
- {% if config.title %}{{ config.title }} {% endif %}
- {{ config.text }}
-
-"""
-
-WEATHER_TEMPLATE: Final = (TEMPLATE_DIRECTORY / "weather.liquid").read_text(
- encoding="utf-8"
-)
-
-TEMPLATES: Final = {
- "entity-state": ENTITY_TEMPLATE,
- "calendar": CALENDAR_TEMPLATE,
- "weather": WEATHER_TEMPLATE,
- "text": TEXT_TEMPLATE,
-}
-
-
-def definition(widget_type: str) -> dict[str, Any]:
- """Return one built-in definition."""
- return next(item for item in WIDGET_DEFINITIONS if item["id"] == widget_type)
-
-
-def with_defaults(widget_type: str, config: dict[str, Any]) -> dict[str, Any]:
- """Apply definition defaults without trusting missing frontend fields."""
- return {**definition(widget_type)["defaults"], **config}
diff --git a/custom_components/opendisplay_studio/widgets/__init__.py b/custom_components/opendisplay_studio/widgets/__init__.py
new file mode 100644
index 0000000..678b0ce
--- /dev/null
+++ b/custom_components/opendisplay_studio/widgets/__init__.py
@@ -0,0 +1,277 @@
+"""Discover installed widget packages and expose their runtime contracts."""
+
+from __future__ import annotations
+
+import importlib
+import importlib.util
+import re
+import sys
+from collections.abc import Iterable
+from hashlib import sha256
+from pathlib import Path
+from typing import Any, Final, Protocol, cast
+
+import yaml # type: ignore[import-untyped]
+
+BUILTIN_WIDGET_DIRECTORY: Final = Path(__file__).parent
+WIDGET_ID_PATTERN: Final = re.compile(r"^[a-z0-9]+(?:-[a-z0-9]+)*$")
+VERSION_PATTERN: Final = re.compile(
+ r"^\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?(?:\+[0-9A-Za-z.-]+)?$"
+)
+
+
+class WidgetPackageError(ValueError):
+ """An installed widget package is malformed or unsafe to load."""
+
+
+class DataProvider(Protocol):
+ """Runtime interface implemented by reusable and package-owned providers."""
+
+ name: str
+
+ def new_request(self) -> object:
+ """Create an empty aggregate request."""
+ ...
+
+ def add_request(
+ self,
+ request: object,
+ sources: list[str],
+ config: dict[str, Any],
+ requirement: dict[str, Any],
+ ) -> None:
+ """Add one widget requirement to the aggregate request."""
+ ...
+
+ async def async_resolve(self, hass: Any, request: object, language: str) -> object:
+ """Resolve one aggregate request."""
+ ...
+
+ def values(
+ self,
+ resolved: object,
+ sources: list[str],
+ config: dict[str, Any],
+ requirement: dict[str, Any],
+ ) -> list[Any]:
+ """Map aggregate data back to one widget requirement."""
+ ...
+
+
+def _safe_package_file(directory: Path, value: object, field: str) -> Path:
+ """Resolve a package-local file without permitting path traversal."""
+ if not isinstance(value, str) or not value or Path(value).name != value:
+ message = f"{field} must name a file in the widget package"
+ raise WidgetPackageError(message)
+ path = directory / value
+ if not path.is_file():
+ message = f"Missing widget package file: {value}"
+ raise WidgetPackageError(message)
+ return path
+
+
+def _load_provider(path: Path) -> DataProvider:
+ """Load a trusted package provider through its stable PROVIDER export."""
+ if path.is_relative_to(BUILTIN_WIDGET_DIRECTORY):
+ relative_module = path.relative_to(BUILTIN_WIDGET_DIRECTORY).with_suffix("")
+ module_name = f"{__package__}.{'.'.join(relative_module.parts)}"
+ module = importlib.import_module(module_name)
+ else:
+ digest = sha256(str(path.resolve()).encode()).hexdigest()[:16]
+ module_name = f"opendisplay_studio_widget_provider_{digest}"
+ spec = importlib.util.spec_from_file_location(module_name, path)
+ if spec is None or spec.loader is None:
+ message = f"Could not load provider: {path}"
+ raise WidgetPackageError(message)
+ module = importlib.util.module_from_spec(spec)
+ sys.modules[module_name] = module
+ try:
+ spec.loader.exec_module(module)
+ except Exception:
+ sys.modules.pop(module_name, None)
+ raise
+ provider = getattr(module, "PROVIDER", None)
+ if provider is None or not isinstance(getattr(provider, "name", None), str):
+ message = f"Provider {path} does not export PROVIDER"
+ raise WidgetPackageError(message)
+ return cast("DataProvider", provider)
+
+
+def _load_definition(
+ directory: Path,
+) -> tuple[dict[str, Any], str, DataProvider | None]:
+ """Load and validate one widget package directory."""
+ manifest_path = directory / "widget.yml"
+ raw = yaml.safe_load(manifest_path.read_text(encoding="utf-8"))
+ if not isinstance(raw, dict):
+ message = f"Widget manifest must be an object: {manifest_path}"
+ raise WidgetPackageError(message)
+ widget_id = raw.get("id")
+ expected_directory = (
+ widget_id.replace("-", "_") if isinstance(widget_id, str) else ""
+ )
+ if (
+ not isinstance(widget_id, str)
+ or WIDGET_ID_PATTERN.fullmatch(widget_id) is None
+ or expected_directory != directory.name
+ ):
+ message = (
+ "Widget id must be lowercase and match its directory name "
+ f"(hyphens map to underscores): {directory.name}"
+ )
+ raise WidgetPackageError(message)
+ for key in ("name", "description", "icon"):
+ if not isinstance(raw.get(key), str) or not raw[key]:
+ message = f"Widget {widget_id} requires {key}"
+ raise WidgetPackageError(message)
+ version = raw.get("version")
+ if not isinstance(version, str) or VERSION_PATTERN.fullmatch(version) is None:
+ message = f"Widget {widget_id} requires a semantic version"
+ raise WidgetPackageError(message)
+ defaults = raw.get("defaults", {})
+ fields = raw.get("fields", [])
+ requirements = raw.get("dataRequirements", [])
+ if (
+ not isinstance(defaults, dict)
+ or not isinstance(fields, list)
+ or not isinstance(requirements, list)
+ ):
+ message = f"Widget {widget_id} has an invalid contract"
+ raise WidgetPackageError(message)
+ if not all(isinstance(item, dict) for item in fields + requirements):
+ message = f"Widget {widget_id} fields and requirements must be objects"
+ raise WidgetPackageError(message)
+ template_path = _safe_package_file(
+ directory, raw.get("template", "widget.liquid"), "template"
+ )
+ definition = {key: raw[key] for key in ("id", "name", "description", "icon")}
+ definition["version"] = version
+ definition.update(
+ {
+ "defaults": defaults,
+ "fields": fields,
+ "dataRequirements": requirements,
+ }
+ )
+ provider = None
+ if provider_name := raw.get("provider"):
+ provider = _load_provider(
+ _safe_package_file(directory, provider_name, "provider")
+ )
+ return definition, template_path.read_text(encoding="utf-8"), provider
+
+
+class WidgetRegistry:
+ """All installed widget definitions, templates, and data providers."""
+
+ def __init__(self) -> None:
+ """Initialize the reusable provider set."""
+ self._definitions: dict[str, dict[str, Any]] = {}
+ self._templates: dict[str, str] = {}
+ self._providers: dict[tuple[str, str], DataProvider] = {}
+
+ def reload_from_directories(self, roots: Iterable[Path]) -> None:
+ """Atomically replace discovered packages while keeping this registry."""
+ candidate = self.from_directories(roots)
+ definitions, templates, providers = candidate._contents() # noqa: SLF001
+ self._definitions = definitions
+ self._templates = templates
+ self._providers = providers
+
+ def _contents(
+ self,
+ ) -> tuple[
+ dict[str, dict[str, Any]],
+ dict[str, str],
+ dict[tuple[str, str], DataProvider],
+ ]:
+ """Return internal mappings for an atomic same-class replacement."""
+ return self._definitions, self._templates, self._providers
+
+ @classmethod
+ def from_directories(cls, roots: Iterable[Path]) -> WidgetRegistry:
+ """Discover packages; later roots override bundled packages by id."""
+ registry = cls()
+ for root in roots:
+ if not root.is_dir():
+ continue
+ for directory in sorted(root.iterdir()):
+ if not directory.is_dir() or not (directory / "widget.yml").is_file():
+ continue
+ definition, template, provider = _load_definition(directory)
+ widget_id = definition["id"]
+ registry._providers = {
+ key: value
+ for key, value in registry._providers.items()
+ if key[0] != widget_id
+ }
+ registry._definitions[widget_id] = definition
+ registry._templates[widget_id] = template
+ if provider is not None:
+ registry._providers[(widget_id, provider.name)] = provider
+ for widget_definition in registry._definitions.values():
+ for requirement in widget_definition["dataRequirements"]:
+ provider_name = requirement.get("provider")
+ if (widget_definition["id"], provider_name) not in registry._providers:
+ message = (
+ f"Widget {widget_definition['id']} requires unknown "
+ f"provider {provider_name}"
+ )
+ raise WidgetPackageError(message)
+ return registry
+
+ @property
+ def definitions(self) -> list[dict[str, Any]]:
+ """Return definitions sorted by package id."""
+ return [self._definitions[key] for key in sorted(self._definitions)]
+
+ @property
+ def templates(self) -> dict[str, str]:
+ """Return the immutable-by-convention template mapping."""
+ return dict(self._templates)
+
+ @property
+ def widget_types(self) -> set[str]:
+ """Return every installed widget id."""
+ return set(self._definitions)
+
+ def definition(self, widget_type: str) -> dict[str, Any]:
+ """Return one installed widget definition."""
+ try:
+ return self._definitions[widget_type]
+ except KeyError as err:
+ message = f"Unsupported widget type: {widget_type}"
+ raise WidgetPackageError(message) from err
+
+ def template(self, widget_type: str) -> str:
+ """Return one installed Liquid template."""
+ return self._templates[widget_type]
+
+ def provider(self, widget_type: str, name: str) -> DataProvider:
+ """Return a provider scoped to its owning widget package."""
+ try:
+ return self._providers[(widget_type, name)]
+ except KeyError as err:
+ message = f"Widget {widget_type} has no data provider named {name}"
+ raise WidgetPackageError(message) from err
+
+
+DEFAULT_REGISTRY: Final = WidgetRegistry.from_directories([BUILTIN_WIDGET_DIRECTORY])
+WIDGET_DEFINITIONS: Final = DEFAULT_REGISTRY.definitions
+TEMPLATES: Final = DEFAULT_REGISTRY.templates
+
+
+def definition(
+ widget_type: str, registry: WidgetRegistry | None = None
+) -> dict[str, Any]:
+ """Return one installed definition."""
+ return (registry or DEFAULT_REGISTRY).definition(widget_type)
+
+
+def with_defaults(
+ widget_type: str,
+ config: dict[str, Any],
+ registry: WidgetRegistry | None = None,
+) -> dict[str, Any]:
+ """Apply package defaults without trusting missing frontend fields."""
+ return {**definition(widget_type, registry)["defaults"], **config}
diff --git a/custom_components/opendisplay_studio/widgets/calendar/__init__.py b/custom_components/opendisplay_studio/widgets/calendar/__init__.py
new file mode 100644
index 0000000..d7332fd
--- /dev/null
+++ b/custom_components/opendisplay_studio/widgets/calendar/__init__.py
@@ -0,0 +1 @@
+"""Calendar widget package."""
diff --git a/custom_components/opendisplay_studio/widgets/calendar/provider.py b/custom_components/opendisplay_studio/widgets/calendar/provider.py
new file mode 100644
index 0000000..71a8cf0
--- /dev/null
+++ b/custom_components/opendisplay_studio/widgets/calendar/provider.py
@@ -0,0 +1,134 @@
+"""Home Assistant data provider owned by the Calendar widget."""
+
+from __future__ import annotations
+
+import asyncio
+from datetime import date, datetime, timedelta
+from typing import Any, cast
+
+from homeassistant.components.calendar import DATA_COMPONENT, CalendarEntity
+from homeassistant.core import HomeAssistant
+from homeassistant.util import dt as dt_util
+
+
+async def _async_get_events(
+ hass: HomeAssistant, entity_id: str, days: int
+) -> tuple[str, list[dict[str, str | bool | int]]]:
+ """Fetch and normalize events from one calendar entity."""
+ component = hass.data.get(DATA_COMPONENT)
+ entity = component.get_entity(entity_id) if component is not None else None
+ if not isinstance(entity, CalendarEntity):
+ return entity_id, []
+ start = dt_util.now()
+ events = await entity.async_get_events(hass, start, start + timedelta(days=days))
+ normalized: list[dict[str, str | bool | int]] = []
+ for event in events:
+ event_start = event.start
+ all_day = isinstance(event_start, date) and not isinstance(
+ event_start, datetime
+ )
+ if isinstance(event_start, datetime):
+ local_start = dt_util.as_local(event_start)
+ start_value = local_start.isoformat()
+ time_value = local_start.strftime("%H:%M")
+ date_value = local_start.strftime("%a %d %b")
+ else:
+ start_value = event_start.isoformat()
+ time_value = "All day"
+ date_value = event_start.strftime("%a %d %b")
+ event_date = (
+ event_start.date() if isinstance(event_start, datetime) else event_start
+ )
+ normalized.append(
+ {
+ "summary": event.summary or "Untitled event",
+ "start": start_value,
+ "time": time_value,
+ "date": date_value,
+ "location": event.location or "",
+ "description": event.description or "",
+ "allDay": all_day,
+ "dayOffset": max(0, (event_date - start.date()).days),
+ }
+ )
+ return entity_id, normalized
+
+
+def _calendar_value(
+ events: list[dict[str, str | bool | int]],
+ *,
+ days: int,
+ time_24h: bool,
+) -> dict[str, list[dict[str, str | bool | int]]]:
+ """Apply this widget's display range and time format."""
+ visible_events = [
+ dict(event) for event in events if int(event.get("dayOffset", 0)) < days
+ ]
+ if not time_24h:
+ for event in visible_events:
+ time_value = str(event["time"])
+ if time_value != "All day":
+ hours, minutes = (int(part) for part in time_value.split(":"))
+ suffix = "AM" if hours < 12 else "PM"
+ event["time"] = f"{hours % 12 or 12}:{minutes:02d} {suffix}"
+ return {"events": visible_events}
+
+
+class CalendarDataProvider:
+ """Collect and resolve requirements for the Calendar widget package."""
+
+ name = "calendar"
+
+ def new_request(self) -> dict[str, int]:
+ """Create an empty calendar range mapping."""
+ return {}
+
+ def add_request(
+ self,
+ request: object,
+ sources: list[str],
+ config: dict[str, Any],
+ requirement: dict[str, Any],
+ ) -> None:
+ """Add selected calendars and their maximum requested ranges."""
+ requests = cast("dict[str, int]", request)
+ range_key = str(requirement.get("rangeConfigKey", "days"))
+ days = max(1, min(31, int(config.get(range_key, 7))))
+ for entity_id in sources:
+ requests[entity_id] = max(requests.get(entity_id, 0), days)
+
+ async def async_resolve(
+ self, hass: HomeAssistant, request: object, language: str
+ ) -> object:
+ """Resolve events for every aggregate calendar request."""
+ del language
+ requests = cast("dict[str, int]", request)
+ pairs = await asyncio.gather(
+ *(
+ _async_get_events(hass, entity_id, days)
+ for entity_id, days in requests.items()
+ )
+ )
+ return dict(pairs)
+
+ def values(
+ self,
+ resolved: object,
+ sources: list[str],
+ config: dict[str, Any],
+ requirement: dict[str, Any],
+ ) -> list[Any]:
+ """Map normalized calendar events back to one widget."""
+ calendars = cast("dict[str, list[dict[str, str | bool | int]]]", resolved)
+ range_key = str(requirement.get("rangeConfigKey", "days"))
+ return [
+ _calendar_value(
+ calendars.get(source, []),
+ days=int(config.get(range_key, 7)),
+ time_24h=bool(config.get("time24h", True)),
+ )
+ for source in sources
+ ]
+
+
+PROVIDER = CalendarDataProvider()
diff --git a/custom_components/opendisplay_studio/widgets/calendar/widget.liquid b/custom_components/opendisplay_studio/widgets/calendar/widget.liquid
new file mode 100644
index 0000000..f2e2070
--- /dev/null
+++ b/custom_components/opendisplay_studio/widgets/calendar/widget.liquid
@@ -0,0 +1,12 @@
+
+
{{ config.title }}
+ {% if data.calendar.events.size > 0 %}
+
+ {% for event in data.calendar.events %}
+ {{ event.time }} {{ event.summary }} {% if config.showLocation and event.location %}{{ event.location }} {% endif %}{% if config.showDescription and event.description %}{{ event.description }} {% endif %} {% endfor %}
+
+ {% else %}
No upcoming events {% endif %}
+
+
diff --git a/custom_components/opendisplay_studio/widgets/calendar/widget.yml b/custom_components/opendisplay_studio/widgets/calendar/widget.yml
new file mode 100644
index 0000000..fede8d7
--- /dev/null
+++ b/custom_components/opendisplay_studio/widgets/calendar/widget.yml
@@ -0,0 +1,47 @@
+id: calendar
+name: Calendar
+version: "0.5.0"
+description: Upcoming events from one Home Assistant calendar.
+icon: mdi:calendar
+framework: 3.2.0
+template: widget.liquid
+provider: provider.py
+
+defaults:
+ calendar: ""
+ title: Upcoming
+ days: 7
+ showLocation: true
+ showDescription: false
+ time24h: true
+
+fields:
+ - key: calendar
+ label: Calendar
+ type: calendar
+ required: true
+ - key: title
+ label: Title
+ type: text
+ - key: days
+ label: Days
+ type: number
+ min: 1
+ max: 31
+ - key: showLocation
+ label: Show location
+ type: toggle
+ - key: showDescription
+ label: Show description
+ type: toggle
+ - key: time24h
+ label: 24-hour time
+ type: toggle
+
+dataRequirements:
+ - key: calendar
+ provider: calendar
+ configKey: calendar
+ cardinality: one
+ optional: false
+ rangeConfigKey: days
diff --git a/custom_components/opendisplay_studio/widgets/entity_state/__init__.py b/custom_components/opendisplay_studio/widgets/entity_state/__init__.py
new file mode 100644
index 0000000..5b10034
--- /dev/null
+++ b/custom_components/opendisplay_studio/widgets/entity_state/__init__.py
@@ -0,0 +1 @@
+"""Entity State widget package."""
diff --git a/custom_components/opendisplay_studio/widgets/entity_state/provider.py b/custom_components/opendisplay_studio/widgets/entity_state/provider.py
new file mode 100644
index 0000000..9ea3b47
--- /dev/null
+++ b/custom_components/opendisplay_studio/widgets/entity_state/provider.py
@@ -0,0 +1,153 @@
+"""Home Assistant data provider owned by the Entity State widget package."""
+
+from __future__ import annotations
+
+from typing import Any, cast
+
+from homeassistant.core import HomeAssistant
+
+ICON_PATHS = {
+ "calendar": "M7 11H9V13H7V11M21 5V19C21 20.11 20.11 21 19 21H5C3.89 21 3 20.1 3 19V5C3 3.9 3.9 3 5 3H6V1H8V3H16V1H18V3H19C20.11 3 21 3.9 21 5M5 7H19V5H5V7M19 19V9H5V19H19M15 13V11H17V13H15M11 13V11H13V13H11M7 15H9V17H7V15M15 17V15H17V17H15M11 17V15H13V17H11Z",
+ "default": "M11,18H13V16H11V18M12,2A10,10 0 0,0 2,12A10,10 0 0,0 12,22A10,10 0 0,0 22,12A10,10 0 0,0 12,2M12,20C7.59,20 4,16.41 4,12C4,7.59 7.59,4 12,4C16.41,4 20,7.59 20,12C20,16.41 16.41,20 12,20M12,6A4,4 0 0,0 8,10H10A2,2 0 0,1 12,8A2,2 0 0,1 14,10C14,12 11,11.75 11,15H13C13,12.75 16,12.5 16,10A4,4 0 0,0 12,6Z",
+ "heat": "M7.95,3L6.53,5.19L7.95,7.4H7.94L5.95,10.5L4.22,9.6L5.64,7.39L4.22,5.19L6.22,2.09L7.95,3M13.95,2.89L12.53,5.1L13.95,7.3L13.94,7.31L11.95,10.4L10.22,9.5L11.64,7.3L10.22,5.1L12.22,2L13.95,2.89M20,2.89L18.56,5.1L20,7.3V7.31L18,10.4L16.25,9.5L17.67,7.3L16.25,5.1L18.25,2L20,2.89M2,22V14A2,2 0 0,1 4,12H20A2,2 0 0,1 22,14V22H20V20H4V22H2M6,14A1,1 0 0,0 5,15V17A1,1 0 0,0 6,18A1,1 0 0,0 7,17V15A1,1 0 0,0 6,14M10,14A1,1 0 0,0 9,15V17A1,1 0 0,0 10,18A1,1 0 0,0 11,17V15A1,1 0 0,0 10,14M14,14A1,1 0 0,0 13,15V17A1,1 0 0,0 14,18A1,1 0 0,0 15,17V15A1,1 0 0,0 14,14M18,14A1,1 0 0,0 17,15V17A1,1 0 0,0 18,18A1,1 0 0,0 19,17V15A1,1 0 0,0 18,14Z",
+ "humidity": "M12,3.25C12,3.25 6,10 6,14C6,17.32 8.69,20 12,20A6,6 0 0,0 18,14C18,10 12,3.25 12,3.25M14.47,9.97L15.53,11.03L9.53,17.03L8.47,15.97M9.75,10A1.25,1.25 0 0,1 11,11.25A1.25,1.25 0 0,1 9.75,12.5A1.25,1.25 0 0,1 8.5,11.25A1.25,1.25 0 0,1 9.75,10M14.25,14.5A1.25,1.25 0 0,1 15.5,15.75A1.25,1.25 0 0,1 14.25,17A1.25,1.25 0 0,1 13,15.75A1.25,1.25 0 0,1 14.25,14.5Z",
+ "illuminance": "M12,9A3,3 0 0,1 15,12A3,3 0 0,1 12,15A3,3 0 0,1 9,12A3,3 0 0,1 12,9M12,4.5C17,4.5 21.27,7.61 23,12C21.27,16.39 17,19.5 12,19.5C7,19.5 2.73,16.39 1,12C2.73,7.61 7,4.5 12,4.5M3.18,12C4.83,15.36 8.24,17.5 12,17.5C15.76,17.5 19.17,15.36 20.82,12C19.17,8.64 15.76,6.5 12,6.5C8.24,6.5 4.83,8.64 3.18,12Z",
+ "light": "M12,2A7,7 0 0,1 19,9C19,11.38 17.81,13.47 16,14.74V17A1,1 0 0,1 15,18H9A1,1 0 0,1 8,17V14.74C6.19,13.47 5,11.38 5,9A7,7 0 0,1 12,2M9,21V20H15V21A1,1 0 0,1 14,22H10A1,1 0 0,1 9,21M12,4A5,5 0 0,0 7,9C7,11.05 8.23,12.81 10,13.58V16H14V13.58C15.77,12.81 17,11.05 17,9A5,5 0 0,0 12,4Z",
+ "power": "M7,2H17L13.5,9H17L10,22V14H7V2M9,4V12H12V14.66L14,11H10.24L13.76,4H9Z",
+ "pressure": "M12,2A10,10 0 0,0 2,12A10,10 0 0,0 12,22A10,10 0 0,0 22,12A10,10 0 0,0 12,2M12,4A8,8 0 0,1 20,12C20,14.4 19,16.5 17.3,18C15.9,16.7 14,16 12,16C10,16 8.2,16.7 6.7,18C5,16.5 4,14.4 4,12A8,8 0 0,1 12,4M14,5.89C13.62,5.9 13.26,6.15 13.1,6.54L11.81,9.77L11.71,10C11,10.13 10.41,10.6 10.14,11.26C9.73,12.29 10.23,13.45 11.26,13.86C12.29,14.27 13.45,13.77 13.86,12.74C14.12,12.08 14,11.32 13.57,10.76L13.67,10.5L14.96,7.29L14.97,7.26C15.17,6.75 14.92,6.17 14.41,5.96C14.28,5.91 14.15,5.89 14,5.89M10,6A1,1 0 0,0 9,7A1,1 0 0,0 10,8A1,1 0 0,0 11,7A1,1 0 0,0 10,6M7,9A1,1 0 0,0 6,10A1,1 0 0,0 7,11A1,1 0 0,0 8,10A1,1 0 0,0 7,9M17,9A1,1 0 0,0 16,10A1,1 0 0,0 17,11A1,1 0 0,0 18,10A1,1 0 0,0 17,9Z",
+ "switch": "M17 6H7C3.69 6 1 8.69 1 12S3.69 18 7 18H17C20.31 18 23 15.31 23 12S20.31 6 17 6M17 16H7C4.79 16 3 14.21 3 12S4.79 8 7 8H17C19.21 8 21 9.79 21 12S19.21 16 17 16M17 9C15.34 9 14 10.34 14 12S15.34 15 17 15 20 13.66 20 12 18.66 9 17 9Z",
+ "temperature": "M15 13V5A3 3 0 0 0 9 5V13A5 5 0 1 0 15 13M12 4A1 1 0 0 1 13 5V8H11V5A1 1 0 0 1 12 4Z",
+}
+
+MDI_ICON_KEYS = {
+ "mdi:flash-outline": "power",
+ "mdi:gauge": "pressure",
+ "mdi:lightbulb-outline": "light",
+ "mdi:radiator": "heat",
+ "mdi:thermometer": "temperature",
+ "mdi:toggle-switch-outline": "switch",
+ "mdi:water-percent": "humidity",
+}
+
+
+def _entity_icon_path(entity_id: str, attributes: dict[str, object]) -> str:
+ """Choose a deterministic local icon without external image requests."""
+ configured = attributes.get("icon")
+ if isinstance(configured, str) and configured in MDI_ICON_KEYS:
+ return ICON_PATHS[MDI_ICON_KEYS[configured]]
+ device_class = str(attributes.get("device_class", ""))
+ key = {
+ "current": "power",
+ "energy": "power",
+ "humidity": "humidity",
+ "illuminance": "illuminance",
+ "power": "power",
+ "pressure": "pressure",
+ "temperature": "temperature",
+ "voltage": "power",
+ }.get(device_class)
+ if key is None:
+ key = {
+ "calendar": "calendar",
+ "climate": "heat",
+ "light": "light",
+ "switch": "switch",
+ }.get(entity_id.partition(".")[0], "default")
+ return ICON_PATHS[key]
+
+
+class EntityStateProvider:
+ """Normalize current state-machine values."""
+
+ def __init__(self, hass: HomeAssistant) -> None:
+ """Initialize the state reader."""
+ self._hass = hass
+
+ def get_many(self, entity_ids: set[str]) -> dict[str, dict[str, str]]:
+ """Return normalized values for every requested entity."""
+ result: dict[str, dict[str, str]] = {}
+ for entity_id in entity_ids:
+ state = self._hass.states.get(entity_id)
+ if state is None:
+ result[entity_id] = {
+ "state": "Unavailable",
+ "unit": "",
+ "name": entity_id,
+ "iconPath": ICON_PATHS["default"],
+ }
+ continue
+ result[entity_id] = {
+ "state": state.state,
+ "unit": str(state.attributes.get("unit_of_measurement", "")),
+ "name": str(state.attributes.get("friendly_name", entity_id)),
+ "iconPath": _entity_icon_path(entity_id, state.attributes),
+ }
+ return result
+
+
+class EntityStateDataProvider:
+ """Generic aggregate provider for entity-state widget requirements."""
+
+ name = "entity_state"
+
+ def new_request(self) -> set[str]:
+ """Create an empty entity ID set."""
+ return set()
+
+ def add_request(
+ self,
+ request: object,
+ sources: list[str],
+ config: dict[str, Any],
+ requirement: dict[str, Any],
+ ) -> None:
+ """Add selected entity IDs to the aggregate request."""
+ del config, requirement
+ cast("set[str]", request).update(sources)
+
+ async def async_resolve(
+ self, hass: HomeAssistant, request: object, language: str
+ ) -> object:
+ """Resolve current states for every aggregate entity ID."""
+ del language
+ return EntityStateProvider(hass).get_many(cast("set[str]", request))
+
+ def values(
+ self,
+ resolved: object,
+ sources: list[str],
+ config: dict[str, Any],
+ requirement: dict[str, Any],
+ ) -> list[Any]:
+ """Map normalized entity states back to one widget."""
+ entities = cast("dict[str, dict[str, str]]", resolved)
+ values = [
+ dict(
+ entities.get(
+ source,
+ {
+ "state": "Unavailable",
+ "unit": "",
+ "name": source,
+ "iconPath": ICON_PATHS["default"],
+ },
+ )
+ )
+ for source in sources
+ ]
+ if not values and requirement.get("cardinality") != "many":
+ values = [
+ {
+ "state": "Unavailable",
+ "unit": "",
+ "name": "Choose an entity",
+ "iconPath": ICON_PATHS["default"],
+ }
+ ]
+ title = str(config.get("title", "")).strip()
+ for value in values:
+ value["displayName"] = title or value["name"]
+ return values
+
+
+PROVIDER = EntityStateDataProvider()
diff --git a/custom_components/opendisplay_studio/widgets/entity_state/widget.liquid b/custom_components/opendisplay_studio/widgets/entity_state/widget.liquid
new file mode 100644
index 0000000..e3a4d33
--- /dev/null
+++ b/custom_components/opendisplay_studio/widgets/entity_state/widget.liquid
@@ -0,0 +1,15 @@
+
+
+ {% if config.showIcon %}
+
+ {% endif %}
+ {% if config.showName %}
+
{{ data.entity.displayName }}
+ {% endif %}
+
+
+ {{ data.entity.state }}
+ {% if config.showUnit and data.entity.unit %}{{ data.entity.unit }} {% endif %}
+
+
+
diff --git a/custom_components/opendisplay_studio/widgets/entity_state/widget.yml b/custom_components/opendisplay_studio/widgets/entity_state/widget.yml
new file mode 100644
index 0000000..7796e3b
--- /dev/null
+++ b/custom_components/opendisplay_studio/widgets/entity_state/widget.yml
@@ -0,0 +1,49 @@
+id: entity-state
+name: Entity State
+version: "0.5.0"
+description: Current state of a selected Home Assistant entity.
+icon: mdi:gauge
+framework: 3.2.0
+template: widget.liquid
+provider: provider.py
+
+defaults:
+ entity: ""
+ title: ""
+ layout: large
+ showIcon: true
+ showName: true
+ showUnit: true
+
+fields:
+ - key: entity
+ label: Entity
+ type: entity
+ required: true
+ - key: title
+ label: Title
+ type: text
+ - key: layout
+ label: Layout
+ type: select
+ options:
+ - label: Large value
+ value: large
+ - label: Compact
+ value: compact
+ - key: showIcon
+ label: Show icon
+ type: toggle
+ - key: showName
+ label: Show name
+ type: toggle
+ - key: showUnit
+ label: Show unit
+ type: toggle
+
+dataRequirements:
+ - key: entity
+ provider: entity_state
+ configKey: entity
+ cardinality: one
+ optional: false
diff --git a/custom_components/opendisplay_studio/widgets/text/widget.liquid b/custom_components/opendisplay_studio/widgets/text/widget.liquid
new file mode 100644
index 0000000..e4ce12a
--- /dev/null
+++ b/custom_components/opendisplay_studio/widgets/text/widget.liquid
@@ -0,0 +1,5 @@
+
+ {% if config.title %}{{ config.title }} {% endif %}
+ {{ config.text }}
+
+
diff --git a/custom_components/opendisplay_studio/widgets/text/widget.yml b/custom_components/opendisplay_studio/widgets/text/widget.yml
new file mode 100644
index 0000000..c6de97e
--- /dev/null
+++ b/custom_components/opendisplay_studio/widgets/text/widget.yml
@@ -0,0 +1,33 @@
+id: text
+name: Text
+version: "0.5.0"
+description: Static heading and body text.
+icon: mdi:text
+framework: 3.2.0
+template: widget.liquid
+
+defaults:
+ title: ""
+ text: Text
+ align: left
+
+fields:
+ - key: title
+ label: Title
+ type: text
+ - key: text
+ label: Text
+ type: text
+ multiline: true
+ - key: align
+ label: Alignment
+ type: select
+ options:
+ - label: Left
+ value: left
+ - label: Center
+ value: center
+ - label: Right
+ value: right
+
+dataRequirements: []
diff --git a/custom_components/opendisplay_studio/widgets/weather/__init__.py b/custom_components/opendisplay_studio/widgets/weather/__init__.py
new file mode 100644
index 0000000..e6709c7
--- /dev/null
+++ b/custom_components/opendisplay_studio/widgets/weather/__init__.py
@@ -0,0 +1 @@
+"""Weather widget package."""
diff --git a/custom_components/opendisplay_studio/widgets/weather/provider.py b/custom_components/opendisplay_studio/widgets/weather/provider.py
new file mode 100644
index 0000000..197bb3e
--- /dev/null
+++ b/custom_components/opendisplay_studio/widgets/weather/provider.py
@@ -0,0 +1,319 @@
+"""Home Assistant data provider owned by the Weather widget package."""
+
+from __future__ import annotations
+
+import asyncio
+import json
+import logging
+from dataclasses import dataclass
+from datetime import date
+from pathlib import Path
+from typing import Any, cast
+
+from babel.core import UnknownLocaleError
+from babel.dates import format_date
+from homeassistant.components.weather import DOMAIN as WEATHER_DOMAIN
+from homeassistant.components.weather import SERVICE_GET_FORECASTS
+from homeassistant.core import HomeAssistant
+from homeassistant.exceptions import HomeAssistantError
+from homeassistant.helpers.translation import async_get_translations
+from homeassistant.util import dt as dt_util
+
+LOGGER_NAME = "custom_components.opendisplay_studio"
+LOGGER = logging.getLogger(LOGGER_NAME)
+TRANSLATIONS_DIRECTORY = Path(__file__).with_name("translations")
+WEATHER_ICON_BASE_URL = "https://trmnl.com/images/plugins/weather"
+
+WEATHER_CONDITION_ICONS = {
+ "clear-night": "wi-night-clear.svg",
+ "cloudy": "wi-cloudy.svg",
+ "exceptional": "wi-na.svg",
+ "fog": "wi-fog.svg",
+ "hail": "wi-hail.svg",
+ "lightning": "wi-lightning.svg",
+ "lightning-rainy": "wi-thunderstorm.svg",
+ "partlycloudy": "wi-day-cloudy.svg",
+ "pouring": "wi-rain-wind.svg",
+ "rainy": "wi-rain.svg",
+ "snowy": "wi-snow.svg",
+ "snowy-rainy": "wi-rain-mix.svg",
+ "sunny": "wi-day-sunny.svg",
+ "windy": "wi-strong-wind.svg",
+ "windy-variant": "wi-cloudy-windy.svg",
+}
+
+
+def _translation_file(language: str) -> Path:
+ """Resolve a validated language name inside this widget package."""
+ return TRANSLATIONS_DIRECTORY / f"{language}.json"
+
+
+def _read_translation_file(path: Path) -> dict[str, str]:
+ """Read one flat widget translation resource."""
+ value = json.loads(path.read_text(encoding="utf-8"))
+ if not isinstance(value, dict):
+ return {}
+ return {
+ str(key): str(label) for key, label in value.items() if isinstance(label, str)
+ }
+
+
+def _load_widget_labels(language: str) -> dict[str, str]:
+ """Load English, base-language, and exact-locale widget labels."""
+ labels = _read_translation_file(_translation_file("en"))
+ candidates = [language.partition("-")[0], language]
+ for candidate in dict.fromkeys(candidates):
+ path = _translation_file(candidate)
+ if candidate != "en" and path.is_file():
+ labels.update(_read_translation_file(path))
+ return labels
+
+
+@dataclass(frozen=True, slots=True)
+class WeatherLocalizer:
+ """Localized Weather vocabulary from the widget and Home Assistant."""
+
+ language: str
+ labels: dict[str, str]
+ condition_labels: dict[str, str]
+
+ @classmethod
+ def english(cls) -> WeatherLocalizer:
+ """Return the package's deterministic standalone fallback."""
+ return cls(language="en", labels=_load_widget_labels("en"), condition_labels={})
+
+ @classmethod
+ async def async_create(cls, hass: HomeAssistant, language: str) -> WeatherLocalizer:
+ """Load widget labels and reuse Home Assistant's Weather translations."""
+ weather_entity, weather_title, labels = await asyncio.gather(
+ async_get_translations(
+ hass, language, "entity_component", integrations={WEATHER_DOMAIN}
+ ),
+ async_get_translations(
+ hass, language, "title", integrations={WEATHER_DOMAIN}
+ ),
+ hass.async_add_executor_job(_load_widget_labels, language),
+ )
+ labels["weather"] = weather_title.get(
+ "component.weather.title", labels["weather"]
+ )
+ attribute_prefix = "component.weather.entity_component._.state_attributes."
+ for key in ("temperature", "apparent_temperature", "humidity"):
+ labels[key] = weather_entity.get(
+ f"{attribute_prefix}{key}.name", labels[key]
+ )
+ state_prefix = "component.weather.entity_component._.state."
+ condition_labels = {
+ key.removeprefix(state_prefix): value
+ for key, value in weather_entity.items()
+ if key.startswith(state_prefix)
+ }
+ return cls(language=language, labels=labels, condition_labels=condition_labels)
+
+ def condition(self, condition: str) -> str:
+ """Return a localized Home Assistant weather condition."""
+ return self.condition_labels.get(
+ condition,
+ condition.replace("-", " ").capitalize()
+ if condition
+ else self.labels["unavailable"],
+ )
+
+
+def _weather_icon(condition: str) -> str:
+ """Map a Home Assistant condition to the widget's weather icon."""
+ filename = WEATHER_CONDITION_ICONS.get(condition, "wi-na.svg")
+ return f"{WEATHER_ICON_BASE_URL}/{filename}"
+
+
+def _placeholder(entity_id: str, localizer: WeatherLocalizer) -> dict[str, Any]:
+ """Return the complete Weather template contract without live data."""
+ return {
+ "entity_id": entity_id,
+ "name": entity_id or localizer.labels["choose_weather_entity"],
+ "condition": "unavailable",
+ "condition_label": localizer.labels["unavailable"],
+ "icon": _weather_icon("exceptional"),
+ "temperature": "—",
+ "temperature_unit": "",
+ "apparent_temperature": None,
+ "humidity": None,
+ "updated_at": "",
+ "forecast": [],
+ "labels": localizer.labels,
+ }
+
+
+def _uv_label(value: object, labels: dict[str, str]) -> str | None:
+ """Convert a numeric UV index into the localized exposure category."""
+ if not isinstance(value, int | float) or isinstance(value, bool):
+ return None
+ if value >= 11:
+ return labels["uv_extreme"]
+ if value >= 8:
+ return labels["uv_very_high"]
+ if value >= 6:
+ return labels["uv_high"]
+ if value >= 3:
+ return labels["uv_moderate"]
+ return labels["uv_low"]
+
+
+def _forecast_date_label(
+ value: object, today: date, localizer: WeatherLocalizer
+) -> str:
+ """Create a compact localized label for a forecast timestamp."""
+ parsed = dt_util.parse_datetime(str(value)) if value else None
+ if parsed is None:
+ return ""
+ local_date = dt_util.as_local(parsed).date()
+ offset = (local_date - today).days
+ if offset == 0:
+ return localizer.labels["today"]
+ if offset == 1:
+ return localizer.labels["tomorrow"]
+ try:
+ return format_date(
+ local_date, format="EEE", locale=localizer.language.replace("-", "_")
+ )
+ except UnknownLocaleError, ValueError:
+ return local_date.strftime("%a")
+
+
+@dataclass(frozen=True, slots=True)
+class WeatherResult:
+ """Resolved values and render language for one compose pass."""
+
+ values: dict[str, dict[str, Any]]
+ localizer: WeatherLocalizer
+
+
+class WeatherDataProvider:
+ """Collect and resolve Weather requirements for the generic composer."""
+
+ name = "weather_forecast"
+
+ def new_request(self) -> set[str]:
+ """Create an empty deduplicated request."""
+ return set()
+
+ def add_request(
+ self,
+ request: object,
+ sources: list[str],
+ config: dict[str, Any],
+ requirement: dict[str, Any],
+ ) -> None:
+ """Add selected weather entity IDs."""
+ del config, requirement
+ cast("set[str]", request).update(sources)
+
+ async def async_resolve(
+ self, hass: HomeAssistant, request: object, language: str
+ ) -> WeatherResult:
+ """Resolve current state, daily forecast, and package translations."""
+ localizer = await WeatherLocalizer.async_create(hass, language)
+ entity_ids = cast("set[str]", request)
+ if not entity_ids:
+ return WeatherResult({}, localizer)
+
+ sorted_entity_ids = sorted(entity_ids)
+ try:
+ response = await hass.services.async_call(
+ WEATHER_DOMAIN,
+ SERVICE_GET_FORECASTS,
+ {"type": "daily"},
+ blocking=True,
+ target={"entity_id": sorted_entity_ids},
+ return_response=True,
+ )
+ except HomeAssistantError as err:
+ LOGGER.warning(
+ "Daily weather forecast is unavailable; rendering current "
+ "conditions without forecast: %s",
+ err,
+ )
+ response = {}
+ forecast_response = response if isinstance(response, dict) else {}
+ today = dt_util.now().date()
+ result: dict[str, dict[str, Any]] = {}
+
+ for entity_id in sorted_entity_ids:
+ state = hass.states.get(entity_id)
+ attributes = state.attributes if state is not None else {}
+ condition = state.state if state is not None else "unavailable"
+ response_item = forecast_response.get(entity_id, {})
+ raw_forecasts = (
+ response_item.get("forecast", [])
+ if isinstance(response_item, dict)
+ else []
+ )
+ forecasts: list[dict[str, Any]] = []
+ if isinstance(raw_forecasts, list):
+ for item in raw_forecasts:
+ if not isinstance(item, dict):
+ continue
+ forecast_condition = str(item.get("condition") or "exceptional")
+ uv_index = item.get("uv_index")
+ forecasts.append(
+ {
+ "datetime": str(item.get("datetime") or ""),
+ "date_label": _forecast_date_label(
+ item.get("datetime"), today, localizer
+ ),
+ "condition": forecast_condition,
+ "condition_label": localizer.condition(forecast_condition),
+ "icon": _weather_icon(forecast_condition),
+ "temperature": item.get("temperature"),
+ "templow": item.get("templow"),
+ "uv_index": uv_index,
+ "uv_label": _uv_label(uv_index, localizer.labels),
+ "precipitation_probability": item.get(
+ "precipitation_probability"
+ ),
+ }
+ )
+
+ result[entity_id] = {
+ "entity_id": entity_id,
+ "name": str(attributes.get("friendly_name", entity_id)),
+ "condition": condition,
+ "condition_label": localizer.condition(condition),
+ "icon": _weather_icon(condition),
+ "temperature": attributes.get("temperature", "—"),
+ "temperature_unit": str(attributes.get("temperature_unit", "")),
+ "apparent_temperature": attributes.get("apparent_temperature"),
+ "humidity": attributes.get("humidity"),
+ "updated_at": (
+ dt_util.as_local(state.last_updated).strftime("%H:%M")
+ if state is not None
+ else ""
+ ),
+ "forecast": forecasts,
+ "labels": localizer.labels,
+ }
+ return WeatherResult(result, localizer)
+
+ def values(
+ self,
+ resolved: object,
+ sources: list[str],
+ config: dict[str, Any],
+ requirement: dict[str, Any],
+ ) -> list[Any]:
+ """Map resolved entities to the requirement's declared cardinality."""
+ del config
+ weather = cast("WeatherResult", resolved)
+ values = [
+ {
+ **weather.values.get(source, _placeholder(source, weather.localizer)),
+ "labels": weather.localizer.labels,
+ }
+ for source in sources
+ ]
+ if not values and requirement.get("cardinality") != "many":
+ values = [_placeholder("", weather.localizer)]
+ return values
+
+
+PROVIDER = WeatherDataProvider()
diff --git a/custom_components/opendisplay_studio/widgets/weather/translations/en.json b/custom_components/opendisplay_studio/widgets/weather/translations/en.json
new file mode 100644
index 0000000..05020d5
--- /dev/null
+++ b/custom_components/opendisplay_studio/widgets/weather/translations/en.json
@@ -0,0 +1,22 @@
+{
+ "weather": "Weather",
+ "temperature": "Temperature",
+ "apparent_temperature": "Apparent temperature",
+ "humidity": "Humidity",
+ "right_now": "Right now",
+ "low": "Low",
+ "high": "High",
+ "low_high": "L/H",
+ "today": "Today",
+ "tomorrow": "Tomorrow",
+ "precipitation": "Precipitation",
+ "details": "Details",
+ "uv": "UV",
+ "uv_low": "Low",
+ "uv_moderate": "Moderate",
+ "uv_high": "High",
+ "uv_very_high": "Very high",
+ "uv_extreme": "Extreme",
+ "unavailable": "Unavailable",
+ "choose_weather_entity": "Choose a weather entity"
+}
diff --git a/custom_components/opendisplay_studio/widgets/weather/translations/pl.json b/custom_components/opendisplay_studio/widgets/weather/translations/pl.json
new file mode 100644
index 0000000..7899406
--- /dev/null
+++ b/custom_components/opendisplay_studio/widgets/weather/translations/pl.json
@@ -0,0 +1,19 @@
+{
+ "weather": "Pogoda",
+ "right_now": "Teraz",
+ "low": "Min.",
+ "high": "Maks.",
+ "low_high": "Min./maks.",
+ "today": "Dzisiaj",
+ "tomorrow": "Jutro",
+ "precipitation": "Opady",
+ "details": "Szczegóły",
+ "uv": "UV",
+ "uv_low": "Niskie",
+ "uv_moderate": "Umiarkowane",
+ "uv_high": "Wysokie",
+ "uv_very_high": "Bardzo wysokie",
+ "uv_extreme": "Ekstremalne",
+ "unavailable": "Niedostępne",
+ "choose_weather_entity": "Wybierz encję pogody"
+}
diff --git a/custom_components/opendisplay_studio/widget_templates/weather.liquid b/custom_components/opendisplay_studio/widgets/weather/widget.liquid
similarity index 84%
rename from custom_components/opendisplay_studio/widget_templates/weather.liquid
rename to custom_components/opendisplay_studio/widgets/weather/widget.liquid
index 099d430..a93b441 100644
--- a/custom_components/opendisplay_studio/widget_templates/weather.liquid
+++ b/custom_components/opendisplay_studio/widgets/weather/widget.liquid
@@ -26,7 +26,7 @@
{{ current.temperature }}°
- Temperature ({{ current.updated_at }})
+ {{ current.labels.temperature }} ({{ current.updated_at }})
` : w`
+ 
+ 
+ 
-