AntoineVe/tableau-de-bord
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(home-assistant): mettre à jour la documentation de l'intégration présence

Browse Source 
Précise l'authentification Bearer (WORKLOG_API_TOKEN), la configuration
des secrets et commandes REST Home Assistant, les codes de réponse de
l'API et la conservation des événements de présence.

Co-authored-by: OpenAI/GPT-5.6-Terra <vibecoder@antoineve.me>
This commit is contained in:
Antoine Van Elstraete
2026-08-15 17:21:20 +02:00
parent fc3250f431
commit b7bde134aa
5 changed files with 34 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/onboarding.md
View File

@@ -101,7 +101,7 @@ Ce fichier contient les paramètres qui ne changent pas fréquemment et qui déf
- **Véhicules (`[vehicles.*]`)** : Nom, type (moteur ou velo), carburant (electric, diesel, essence, none), émissions de CO₂ par km, et puissance fiscale (CV).
- **Trajets (`[journeys.*]`)** : Profils de trajets prédéfinis (ex: "moteur_seul", "moteur_velo") avec les distances associées par type de moyen de transport.
- **Barème kilométrique (`[bareme_kilometrique.YYYY.*]`)** : Les tranches fiscales officielles de remboursement par année et par puissance fiscale (CV).
- **Home Assistant (`[home_assistant]`)** : Les valeurs par défaut et le fuseau utilisés par la future API de présence :
- **Home Assistant (`[home_assistant]`)** : Les valeurs par défaut et le fuseau utilisés par l'API de présence (implémentée dans `app/api.py` et `app/business/presence_service.py`) :
```toml
[home_assistant]
timezone = "Europe/Paris"
@@ -113,7 +113,7 @@ Ce fichier contient les paramètres qui ne changent pas fréquemment et qui déf
*Note : Ces données sont chargées en mémoire au démarrage de l'application dans `app.config["TOML"]`.*
Le secret de la future API ne doit pas être ajouté au fichier TOML. Il proviendra de la variable d'environnement `WORKLOG_API_TOKEN` lorsqu'elle sera implémentée ; cette étape ne le stocke ni ne le gère.
Le secret de l'API de présence ne doit pas être ajouté au fichier TOML. Il est configuré via la variable d'environnement `WORKLOG_API_TOKEN` sur le serveur d'exécution.
### SQLite / `instance/worklog.db` (Données dynamiques)
La base de données stocke l'activité saisie par l'utilisateur :
@@ -126,8 +126,7 @@ Les événements de présence stockent `received_at` comme un timestamp UTC naï
conformément à la convention existante des métadonnées. `occurred_at` est différent :
il représente une heure locale Europe/Paris naïve, et `local_date` est le jour local
qui en est dérivé. Une arrivée non encore rattachée à une plage est identifiée par
`event_type = "arrival"` et `time_slot_id IS NULL`; la signification de
`processed_at` sera précisée par le service métier de l'étape suivante.
`event_type = "arrival"` et `time_slot_id IS NULL`; `processed_at` enregistre l'instant de traitement effectif de l'événement par le service métier.
---
@@ -293,3 +292,5 @@ sudo systemctl restart tableau-de-bord-pro
Pour aller plus loin, n'hésite pas à consulter les documents suivants à la racine du projet :
- [README.md](../README.md) : Présentation générale, instructions d'installation détaillées et script d'import CSV en masse.
- [AGENTS.md](../AGENTS.md) : Guide de développement et consignes pour les agents d'intelligence artificielle travaillant sur ce dépôt.
- [Documentation API REST (Intégration Présence)](api.md) : Spécifications techniques et contractuelles de l'API REST de présence.
- [Documentation Home Assistant](home-assistant.md) : Guide de configuration des scripts, secrets et automatisations Home Assistant.