House Plan Card v1.0.0: Lovelace card (TS+Lit) + houseplan integration (server-side layout storage), HACS-ready

This commit is contained in:
JB
2026-07-03 19:09:24 +03:00
commit 0c6f37198f
28 changed files with 3310 additions and 0 deletions
+64
View File
@@ -0,0 +1,64 @@
"""House Plan: серверное хранилище раскладки + раздача Lovelace-карточки."""
from __future__ import annotations
import logging
from pathlib import Path
from homeassistant.components.frontend import add_extra_js_url
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.storage import Store
from . import websocket_api as hp_ws
from .const import DOMAIN, FRONTEND_URL, STORAGE_KEY, STORAGE_VERSION
_LOGGER = logging.getLogger(__name__)
async def async_setup(hass: HomeAssistant, config) -> bool:
"""Регистрируем WS-команды и хранилище на старте."""
hass.data.setdefault(DOMAIN, {})
hass.data[DOMAIN]["store"] = Store(hass, STORAGE_VERSION, STORAGE_KEY)
hp_ws.async_register(hass)
return True
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
"""Config entry: статика фронтенда + авто-подключение JS."""
hass.data.setdefault(DOMAIN, {})
hass.data[DOMAIN]["entry"] = entry
entry.async_on_unload(entry.add_update_listener(_update_listener))
card_path = Path(__file__).parent / "frontend" / "houseplan-card.js"
if card_path.exists():
try:
from homeassistant.components.http import StaticPathConfig
await hass.http.async_register_static_paths(
[StaticPathConfig(FRONTEND_URL, str(card_path), cache_headers=False)]
)
except ImportError: # старые версии HA
hass.http.register_static_path(FRONTEND_URL, str(card_path), cache_headers=False)
add_extra_js_url(hass, f"{FRONTEND_URL}?v={_manifest_version(hass)}")
else:
_LOGGER.warning("houseplan-card.js не найден рядом с интеграцией: %s", card_path)
return True
def _manifest_version(hass: HomeAssistant) -> str:
try:
import json
manifest = Path(__file__).parent / "manifest.json"
return json.loads(manifest.read_text()).get("version", "0")
except Exception: # noqa: BLE001
return "0"
async def _update_listener(hass: HomeAssistant, entry: ConfigEntry) -> None:
hass.data[DOMAIN]["entry"] = entry
async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
hass.data[DOMAIN].pop("entry", None)
return True
Binary file not shown.
Binary file not shown.
Binary file not shown.
+41
View File
@@ -0,0 +1,41 @@
"""Config flow: одна запись без параметров."""
from __future__ import annotations
import voluptuous as vol
from homeassistant import config_entries
from .const import CONF_ADMIN_ONLY, DOMAIN
class HouseplanConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
"""Установка в один шаг."""
VERSION = 1
async def async_step_user(self, user_input=None):
if self._async_current_entries():
return self.async_abort(reason="single_instance_allowed")
if user_input is not None:
return self.async_create_entry(title="House Plan", data={}, options=user_input)
return self.async_show_form(
step_id="user",
data_schema=vol.Schema({vol.Optional(CONF_ADMIN_ONLY, default=False): bool}),
)
@staticmethod
def async_get_options_flow(config_entry):
return HouseplanOptionsFlow()
class HouseplanOptionsFlow(config_entries.OptionsFlow):
"""Опция: правка раскладки только администраторами."""
async def async_step_init(self, user_input=None):
if user_input is not None:
return self.async_create_entry(title="", data=user_input)
current = self.config_entry.options.get(CONF_ADMIN_ONLY, False)
return self.async_show_form(
step_id="init",
data_schema=vol.Schema({vol.Optional(CONF_ADMIN_ONLY, default=current): bool}),
)
+7
View File
@@ -0,0 +1,7 @@
"""Константы интеграции House Plan."""
DOMAIN = "houseplan"
STORAGE_KEY = f"{DOMAIN}.layout"
STORAGE_VERSION = 1
FRONTEND_URL = "/houseplan_files/houseplan-card.js"
CONF_ADMIN_ONLY = "admin_only"
File diff suppressed because one or more lines are too long
+13
View File
@@ -0,0 +1,13 @@
{
"domain": "houseplan",
"name": "House Plan",
"codeowners": ["@justbusiness"],
"config_flow": true,
"dependencies": ["http", "frontend", "websocket_api"],
"documentation": "https://github.com/justbusiness/houseplan-card",
"integration_type": "service",
"iot_class": "local_push",
"issue_tracker": "https://github.com/justbusiness/houseplan-card/issues",
"requirements": [],
"version": "1.0.0"
}
+18
View File
@@ -0,0 +1,18 @@
{
"config": {
"step": {
"user": {
"title": "House Plan",
"data": { "admin_only": "Правка раскладки только администраторами" }
}
},
"abort": { "single_instance_allowed": "Уже настроено — допускается одна запись." }
},
"options": {
"step": {
"init": {
"data": { "admin_only": "Правка раскладки только администраторами" }
}
}
}
}
+18
View File
@@ -0,0 +1,18 @@
{
"config": {
"step": {
"user": {
"title": "House Plan",
"data": { "admin_only": "Правка раскладки только администраторами" }
}
},
"abort": { "single_instance_allowed": "Уже настроено — допускается одна запись." }
},
"options": {
"step": {
"init": {
"data": { "admin_only": "Правка раскладки только администраторами" }
}
}
}
}
+74
View File
@@ -0,0 +1,74 @@
"""WS-команды houseplan/layout/get|set|update — серверное хранение раскладки."""
from __future__ import annotations
from typing import Any
import voluptuous as vol
from homeassistant.components import websocket_api
from homeassistant.core import HomeAssistant, callback
from .const import CONF_ADMIN_ONLY, DOMAIN
POS_SCHEMA = vol.Schema({vol.Required("x"): vol.Coerce(float), vol.Required("y"): vol.Coerce(float)})
LAYOUT_SCHEMA = vol.Schema({str: POS_SCHEMA})
@callback
def async_register(hass: HomeAssistant) -> None:
"""Регистрация WS-команд."""
websocket_api.async_register_command(hass, ws_layout_get)
websocket_api.async_register_command(hass, ws_layout_set)
websocket_api.async_register_command(hass, ws_layout_update)
def _store(hass: HomeAssistant):
return hass.data[DOMAIN]["store"]
def _check_write(hass: HomeAssistant, connection) -> bool:
entry = hass.data[DOMAIN].get("entry")
admin_only = bool(entry and entry.options.get(CONF_ADMIN_ONLY, False))
return connection.user.is_admin if admin_only else True
@websocket_api.websocket_command({vol.Required("type"): "houseplan/layout/get"})
@websocket_api.async_response
async def ws_layout_get(hass: HomeAssistant, connection, msg: dict[str, Any]) -> None:
"""Вернуть сохранённую раскладку."""
data = await _store(hass).async_load() or {}
connection.send_result(msg["id"], {"layout": data.get("layout", {})})
@websocket_api.websocket_command(
{vol.Required("type"): "houseplan/layout/set", vol.Required("layout"): LAYOUT_SCHEMA}
)
@websocket_api.async_response
async def ws_layout_set(hass: HomeAssistant, connection, msg: dict[str, Any]) -> None:
"""Полностью заменить раскладку."""
if not _check_write(hass, connection):
connection.send_error(msg["id"], "unauthorized", "Правка раскладки разрешена только администраторам")
return
await _store(hass).async_save({"layout": msg["layout"]})
connection.send_result(msg["id"], {"ok": True})
@websocket_api.websocket_command(
{
vol.Required("type"): "houseplan/layout/update",
vol.Required("device_id"): str,
vol.Required("pos"): POS_SCHEMA,
}
)
@websocket_api.async_response
async def ws_layout_update(hass: HomeAssistant, connection, msg: dict[str, Any]) -> None:
"""Обновить позицию одного устройства."""
if not _check_write(hass, connection):
connection.send_error(msg["id"], "unauthorized", "Правка раскладки разрешена только администраторам")
return
store = _store(hass)
data = await store.async_load() or {}
layout = data.get("layout", {})
layout[msg["device_id"]] = msg["pos"]
await store.async_save({"layout": layout})
connection.send_result(msg["id"], {"ok": True})