Document project rules and development setup

2026-07-18 15:32:20 +02:00
parent b09f208ef3
commit d72aae696f
2 changed files with 99 additions and 0 deletions
@@ -0,0 +1,45 @@
+# Arkteos — développement
+
+Ce dépôt prépare une intégration custom Home Assistant en lecture seule pour
+une PAC Arkteos Zuran 4.
+
+L'intégration devra lire exclusivement le flux du proxy TCP fourni par l'addon
+Home Assistant séparé, sur le port de référence `9641`. Elle ne doit jamais se
+connecter directement à la PAC ni écrire sur le proxy.
+
+## Références disponibles
+
+- `references/arkteos_nodered_flow.json` : flow Node-RED fonctionnel en
+  production et seule référence actuelle pour le parsing.
+- `references/proxy_protocol_notes.md` : notes de contexte sur le proxy et les
+  tailles de trames rapportées.
+
+## État du dépôt
+
+L'intégration Home Assistant n'est pas encore écrite. Aucun comportement de
+framing TCP ne doit être supposé sans captures ou tests démonstratifs.
+
+## Arborescence cible proposée
+
+```text
+custom_components/
+  arkteos/
+    __init__.py
+    manifest.json
+    config_flow.py
+    const.py
+    coordinator.py
+    parser.py
+    sensor.py
+    binary_sensor.py
+    strings.json
+    translations/
+      fr.json
+tests/
+  components/
+    arkteos/
+references/
+```
+
+Cette arborescence est une proposition : elle ne crée encore aucun de ces
+fichiers.