Files
ha-ninstrip/custom_components/ninstrip/const.py
T
Michael Sauer 2c77b2d325 feat: update-Entitaet fuer die Firmware und das Testgeruest
Aufgebaut wie ha-ninlight: die Abbilder liegen unter ninstrip_firmware im
Konfigurationsverzeichnis, Home Assistant liefert sie selbst unter einer
einmaligen Adresse aus, und zwar genau die Bytes, die vorher geprueft
wurden. Dazu firmware.py (Anhaenger, Versionsreihenfolge, WLAN-Pruefung,
Katalog), http.py, urls.py und shared.py.

Drei Unterschiede zu ninlight, alle aus der Firmware heraus:

* Verglichen wird device_type - die Platine -, nicht product. Letzteres ist
  bei allen Platinen 'ninstrip'; die Abbilder unterscheiden sich aber hart,
  die K1Y invertiert das Datensignal und die KL-RGBC3 nicht. Firmware ohne
  dieses Feld bekommt gar kein Angebot.
* Die WLAN-Pruefung sucht die SSID unverpackt: ein ESP32-Abbild ist nicht
  gzip-verpackt wie das des W600. An einem mit sdkconfig.local gebauten
  Abbild gegengeprueft - die SSID steht genau einmal NUL-gerahmt drin.
* Der Fehlerschluessel heisst device_url_too_long statt lamp_url_too_long.

Dazu das Testgeruest, das es hier bisher gar nicht gab: 204 Tests in
tests_unit/ (ohne HA-Instanz) und tests/ (mit), Abdeckung 97 %, dazu
scripts/check.sh als Ersatz fuer die fehlende CI. Die Nutzdaten in
tests_unit/samples.py sind an der Stehlampe abgefragt.

Beim Gegenpruefen per Mutation fiel auf, dass die Platinenpruefung
unmittelbar vor dem Senden ungeprueft war - der Test dazu ist jetzt da und
faellt, wenn man die Pruefung entfernt.
2026-09-22 23:10:07 +02:00

54 lines
2.0 KiB
Python

"""Konstanten der ninstrip-Integration. Bewusst frei von Home-Assistant-Importen."""
from __future__ import annotations
from datetime import timedelta
from typing import Final
DOMAIN: Final = "ninstrip"
# Oeffentliches Werks-Token der Firmware (NL_DEFAULT_TOKEN), dasselbe wie bei
# ninlight. Ein Geraet im Auslieferungszustand und nach jedem Werksreset
# antwortet damit - deshalb belegt der Einrichtungsdialog es vor.
DEFAULT_TOKEN: Final = "aabbccddeeff0011223344"
CONF_SCAN_INTERVAL: Final = "scan_interval"
# Nur noetig, wenn die Geraete die interne Adresse von Home Assistant nicht
# ueber schlichtes http erreichen.
CONF_DEVICE_BASE_URL: Final = "device_base_url"
DEFAULT_PORT: Final = 3333
DEFAULT_SCAN_INTERVAL: Final = 30
MIN_SCAN_INTERVAL: Final = 10
MAX_SCAN_INTERVAL: Final = 300
# So viele aufeinanderfolgende Fehlversuche werden geschluckt, bevor das
# Geraet als nicht verfuegbar gilt. Ein kurzer Aussetzer im WLAN soll nicht
# sofort alle Entitaeten ausgrauen.
MAX_POLL_FAILURES: Final = 3
# Die Firmware erlaubt hoechstens 16 Segmente (nl_segments.h) und 512 Pixel.
MAX_SEGMENTS: Final = 16
MAX_PIXELS: Final = 512
# Acht Szenenplaetze (nl_presets.h).
MAX_PRESETS: Final = 8
# --- Firmware-Aktualisierung -----------------------------------------
# Ordner unterhalb des HA-Konfigurationsverzeichnisses, in dem die Abbilder
# liegen (tools/release_images.sh der Firmware legt sie dort ab).
FIRMWARE_DIR_NAME: Final = "ninstrip_firmware"
CATALOG_SCAN_INTERVAL: Final = timedelta(minutes=5)
SIGNAL_CATALOG_UPDATED: Final = f"{DOMAIN}_catalog_updated"
FIRMWARE_URL_PREFIX: Final = "/api/ninstrip/firmware/"
# len(secrets.token_urlsafe(32))
FIRMWARE_KEY_LENGTH: Final = 43
# Laengere fw_update-Adressen weist das Geraet ab (nl_api_system.c: url[256]).
MAX_DEVICE_URL_LENGTH: Final = 255
OTA_POLL_INTERVAL_S: Final = 5.0
# Der ESP32 laedt rund 1 MB und startet danach neu; ein totes Gegenueber kann
# aber minutenlang im TCP haengen. Grosszuegig wie bei ninlight.
OTA_TIMEOUT_S: Final = 12 * 60.0