Max Gramser
ae308e37ab
Home Assistant shows an ESPHome device action with bare field names and types only: no description, no dropdowns. The new Alerts button opens a reference page instead: per screen the exact action names (esphome.<node>_show_alert and _dismiss_alert) with copy buttons and whether the firmware is new enough, a paste-ready YAML example per screen, every field with explanation, example and the byte limits per board, all icons with glyph and name (searchable, tap copies), the colour swatches, the behaviour (timeout, button, flash, standby, replace), and the esphome.screen_alert event with an automation that waits for the button. core.alert_reference() carries the data and tests/test_alerts_reference.py keeps it equal to what both board profiles, tile_palette.h, alert_overlay.h and tile_icons.py compile. Screens carry alert_action and dismiss_action in the inventory. App only; firmware stays 0.2.31. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
101 lines
6.5 KiB
Python
101 lines
6.5 KiB
Python
"""The Alerts cheatsheet in ESP Screens must describe exactly what the firmware compiles."""
|
|
import asyncio
|
|
import importlib.util
|
|
import re
|
|
import sys
|
|
import tempfile
|
|
import unittest
|
|
from pathlib import Path
|
|
|
|
ROOT = Path(__file__).resolve().parents[1]
|
|
sys.path.insert(0, str(ROOT / 'screen_manager/app'))
|
|
import tile_icons # noqa: E402
|
|
from core import (ALERT_LIMITS, ALERT_MIN_FIRMWARE, FIRMWARE_VERSION, TILE_BACKGROUNDS, alert_reference, # noqa: E402
|
|
alert_service)
|
|
from updates import parse_version # noqa: E402
|
|
|
|
PROFILES = {'cyd': 'home-like-2432s028.yaml', 'guition': 'guition-4848s040.yaml'}
|
|
STATIC = ROOT / 'screen_manager/app/static'
|
|
|
|
class ReferenceTests(unittest.TestCase):
|
|
def test_fields_and_limits_match_both_board_profiles(self):
|
|
reference = alert_reference()
|
|
for board, name in PROFILES.items():
|
|
text = (ROOT / name).read_text()
|
|
block = text.split(' - action: show_alert\n', 1)[1].split(' - action: dismiss_alert\n', 1)[0]
|
|
self.assertEqual(re.findall(r'^ (\w+): (\w+)$', block, re.M), [(f['name'], f['type']) for f in reference['fields']], name)
|
|
for field, key in (('title', 'ALERT_TITLE_MAX'), ('subtitle', 'ALERT_SUBTITLE_MAX'), ('button_text', 'ALERT_BUTTON_MAX')):
|
|
self.assertEqual(ALERT_LIMITS[board][field], int(re.search(rf'^ {key}: "(\d+)"', text, re.M)[1]), (board, field))
|
|
for needle in ('event: esphome.screen_alert', 'execute("replaced")', 'reason: "timeout"', 'reason: "remote"', 'reason: "ok"'):
|
|
self.assertIn(needle, text, (name, needle))
|
|
self.assertEqual(reference['event'], 'esphome.screen_alert')
|
|
self.assertEqual([e['action'] for e in reference['endings']], ['ok', 'timeout', 'replaced', 'remote'])
|
|
self.assertEqual(reference['limits'], ALERT_LIMITS)
|
|
|
|
def test_colours_icons_and_fallback_match_the_firmware_headers(self):
|
|
reference = alert_reference()
|
|
palette = (ROOT / 'components/smart_display/tile_palette.h').read_text()
|
|
self.assertEqual([c['name'] for c in reference['colors']], re.findall(r'if\(name=="(\w+)"\)return 0x', palette))
|
|
for colour in reference['colors']:
|
|
self.assertIn(f'if(name=="{colour["name"]}")return 0x{colour["color"][1:]};', palette)
|
|
self.assertEqual(colour['label'], TILE_BACKGROUNDS[colour['name']]['label'])
|
|
header = (ROOT / 'components/smart_display/alert_overlay.h').read_text()
|
|
self.assertIn(f'FALLBACK_ICON = "{reference["fallback_icon"]}"', header)
|
|
self.assertEqual(reference['fallback_cp'], tile_icons.GLYPHS[reference['fallback_icon']])
|
|
for icon in reference['suggested_icons']:
|
|
self.assertEqual(icon['cp'], tile_icons.GLYPHS[icon['name']], icon)
|
|
self.assertEqual([(i['name'], i['cp']) for i in reference['extra_icons']], list(tile_icons.FIXED))
|
|
self.assertEqual(len(reference['suggested_icons']), len({i['name'] for i in reference['suggested_icons']}))
|
|
|
|
def test_action_names_follow_home_assistant_and_the_firmware_is_current(self):
|
|
self.assertEqual(alert_service('studio-1'), 'esphome.studio_1_show_alert')
|
|
self.assertEqual(alert_service('keuken-scherm', 'dismiss_alert'), 'esphome.keuken_scherm_dismiss_alert')
|
|
for missing in (None, '', 3):
|
|
self.assertIsNone(alert_service(missing))
|
|
self.assertLessEqual(parse_version(ALERT_MIN_FIRMWARE), parse_version(FIRMWARE_VERSION))
|
|
|
|
def test_page_carries_the_cheatsheet(self):
|
|
html = (STATIC / 'index.html').read_text()
|
|
for marker in ('id="open-alerts"', 'id="alerts-dialog"', 'id="close-alerts"', 'id="alerts-screens"', 'id="alerts-icons"', 'id="alerts-colors"', 'id="alerts-fields"', 'id="alerts-example"'):
|
|
self.assertIn(marker, html, marker)
|
|
script = (STATIC / 'app.js').read_text()
|
|
for marker in ('inventory.alerts', 'alert_action', 'dismiss_action', 'function renderAlerts', '#open-alerts'):
|
|
self.assertIn(marker, script, marker)
|
|
self.assertIn('#alerts-dialog', (STATIC / 'style.css').read_text())
|
|
|
|
HAS_AIOHTTP = importlib.util.find_spec('aiohttp') is not None
|
|
if HAS_AIOHTTP:
|
|
from server import Manager, create_app
|
|
from aiohttp.test_utils import TestClient, TestServer
|
|
|
|
@unittest.skipUnless(HAS_AIOHTTP, 'Run using .venv-portal/bin/python for server tests')
|
|
class InventoryTests(unittest.IsolatedAsyncioTestCase):
|
|
async def test_inventory_carries_the_reference_and_each_screen_its_action_names(self):
|
|
class HA:
|
|
online = True
|
|
registry = [{'entity_id': 'text.studio_1_tegelinstellingen', 'platform': 'esphome', 'original_name': 'Tegelinstellingen', 'device_id': 'd1'},
|
|
{'entity_id': 'sensor.studio_1_apparaatnaam', 'platform': 'esphome', 'original_name': 'Apparaatnaam', 'device_id': 'd1'},
|
|
{'entity_id': 'sensor.studio_1_schermfirmware', 'platform': 'esphome', 'original_name': 'Schermfirmware', 'device_id': 'd1'},
|
|
{'entity_id': 'text.oud_tegelinstellingen', 'platform': 'esphome', 'original_name': 'Tegelinstellingen', 'device_id': 'd2'}]
|
|
devices = [{'id': 'd1', 'name': 'Studio 1'}, {'id': 'd2', 'name': 'Oud scherm'}]
|
|
areas = []
|
|
states = {'text.studio_1_tegelinstellingen': {'state': 'Ready'}, 'sensor.studio_1_apparaatnaam': {'state': 'studio-1'},
|
|
'sensor.studio_1_schermfirmware': {'state': '0.2.31'}, 'text.oud_tegelinstellingen': {'state': 'Ready'}}
|
|
changed = asyncio.Event()
|
|
async def send(self, inbox, message): pass
|
|
with tempfile.TemporaryDirectory() as temp:
|
|
manager = Manager(HA(), Path(temp) / 'screens.json')
|
|
async with TestClient(TestServer(create_app(manager, True))) as client:
|
|
full = await (await client.get('/api/inventory')).json()
|
|
self.assertEqual(full['alerts'], alert_reference())
|
|
by_id = {s['id']: s for s in full['screens']}
|
|
self.assertEqual(by_id['text.studio_1_tegelinstellingen']['alert_action'], 'esphome.studio_1_show_alert')
|
|
self.assertEqual(by_id['text.studio_1_tegelinstellingen']['dismiss_action'], 'esphome.studio_1_dismiss_alert')
|
|
self.assertIsNone(by_id['text.oud_tegelinstellingen']['alert_action'])
|
|
light = await (await client.get('/api/inventory?light=1')).json()
|
|
self.assertNotIn('alerts', light)
|
|
self.assertEqual(light['screens'][0]['alert_action'], 'esphome.studio_1_show_alert')
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main()
|