Prepare HACS distribution

This commit is contained in:
2026-07-21 12:45:15 +02:00
parent 9947b9c3ad
commit fea8809fb9
4 changed files with 60 additions and 37 deletions
+21
View File
@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2026 Raph666
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+33 -36
View File
@@ -1,45 +1,42 @@
# Arkteos — développement
# Arkteos
Ce dépôt prépare une intégration custom Home Assistant en lecture seule pour
une PAC Arkteos Zuran 4.
Intégration custom Home Assistant en lecture seule pour une PAC Arkteos Zuran
4. Elle expose les données décodées du protocole REG3 par des entités natives
Home Assistant.
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.
Lintégration se connecte exclusivement au proxy Arkteos fourni par laddon
Home Assistant séparé. Elle ne se connecte jamais directement à la PAC et
nenvoie aucune commande. Le port du proxy est configurable ; sa valeur par
défaut est `9641`.
## Références disponibles
## Installation avec HACS
- `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.
1. Dans HACS, ouvre **Intégrations** puis le menu à trois points.
2. Choisis **Dépôts personnalisés**.
3. Ajoute `https://gitea.i-host.fr/raph666/home-assistant-arkteos` avec la
catégorie **Intégration**.
4. Installe **Arkteos**.
5. Redémarre Home Assistant.
6. Ajoute lintégration dans **Paramètres > Appareils et services**.
## État du dépôt
Le proxy Arkteos doit être disponible avant la configuration de lintégration.
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.
## Migration et validation
## Arborescence cible proposée
Conserve temporairement le flow Node-RED existant pendant la comparaison des
valeurs publiées. Il reste la référence fonctionnelle actuelle des champs
décodés.
```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/
```
Le protocole REG3 est observé depuis des captures et le flow Node-RED de
référence ; aucune documentation officielle complète du protocole nest
actuellement disponible. Les champs et les règles de découpage sont limités à
ce qui est démontré par ces références.
Cette arborescence est une proposition : elle ne crée encore aucun de ces
fichiers.
## Développement
- `references/arkteos_nodered_flow.json` : flow Node-RED de référence.
- `references/proxy_protocol_notes.md` : contexte connu sur le proxy.
- `tests/fixtures/` : trames réelles anonymisées utilisées par les tests.
Les captures privées et les informations de connexion ne doivent pas être
versionnées.
+2 -1
View File
@@ -5,6 +5,7 @@
"iot_class": "local_push",
"version": "0.1.0",
"requirements": [],
"documentation": "REPLACE_WITH_GITEA_REPOSITORY_URL",
"documentation": "https://gitea.i-host.fr/raph666/home-assistant-arkteos",
"issue_tracker": "https://gitea.i-host.fr/raph666/home-assistant-arkteos/issues",
"codeowners": []
}
+4
View File
@@ -0,0 +1,4 @@
{
"name": "Arkteos",
"render_readme": true
}