PaulVua/aircarto-protocols
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: merge parsers/ into formats/ and drop misleading JSON wrapper

Browse Source 
Parsers and formats are tightly linked (a parser produces a format) and
the split made cross-links heavy for a single parser file. Also removed
the confusing "Enveloppe JSON" block in udp-miotiq.md that mixed the
raw webhook wrapper with what the backend actually consumes — the
decoded payload schema lives in json-payload.md and is now referenced
directly.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Your Name
2026-04-24 11:02:10 +02:00
parent fee8b7dc15
commit 33c4472350
6 changed files with 21 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -10,15 +10,14 @@ Documentation de référence pour tous les capteurs AirCarto : protocoles de com
aircarto-protocols/
├── CONVENTIONS.md Nommage, versioning, style doc
├── data-budget.md Estimation conso cellulaire vs budget Miotiq 1 Go/10 ans
├── formats/ Formats d'échange de données
├── formats/ Formats d'échange et parsers associés
│ ├── json-payload.md Format JSON canonique des mesures
│ ├── iso-pollutant-codes.md Mapping ISO_XX → polluant / grandeur
│ └── mqtt.md Topics et conventions MQTT
├── sensors/ Un fichier par capteur
│ ├── _TEMPLATE.md Gabarit à copier pour tout nouveau capteur
│ └── nextpm.md NextPM (Tera Sensor) — UART
└── parsers/ Parsers côté serveur / passerelle
└── udp-miotiq.md Webhook Miotiq (UDP → HTTPS JSON)
│ ├── mqtt.md Topics et conventions MQTT
│ └── udp-miotiq.md Webhook Miotiq (UDP → HTTPS JSON) + descripteur binaire
└── sensors/ Un fichier par capteur
├── _TEMPLATE.md Gabarit à copier pour tout nouveau capteur
└── nextpm.md NextPM (Tera Sensor) — UART
```
## Index des capteurs
@@ -31,12 +30,12 @@ aircarto-protocols/
| Nom | Transport | Doc | État |
|-----------------|------------------|-----------------------------------------------|-------------------------------|
| UDP Miotiq | UDP → HTTPS JSON | [parsers/udp-miotiq.md](parsers/udp-miotiq.md) | Descripteur NebuleAir Pro 4G + legacy MobileAir |
| UDP Miotiq | UDP → HTTPS JSON | [formats/udp-miotiq.md](formats/udp-miotiq.md) | Descripteur NebuleAir Pro 4G + legacy MobileAir |
## Comment ajouter une entrée
- **Nouveau capteur** : copier `sensors/_TEMPLATE.md` vers `sensors/<nom>.md`, remplir les sections, mettre à jour l'index ci-dessus.
- **Nouveau format / parser** : créer le fichier sous `formats/` ou `parsers/`, mettre à jour l'index.
- **Nouveau format ou parser** : créer le fichier sous `formats/`, mettre à jour l'index.
- Voir [CONVENTIONS.md](CONVENTIONS.md) pour le style et le nommage.
## Pourquoi ce repo
@@ -45,7 +44,7 @@ Avant : chaque firmware AirCarto (NebuleAir, ModuleAir, MobileAir…) redéfinis
Ici on centralise la **spécification** :
- **Capteur → Miotiq** : payload UDP binaire, décodé côté Miotiq via un *descripteur* ([`parsers/udp-miotiq.md`](parsers/udp-miotiq.md)).
- **Capteur → Miotiq** : payload UDP binaire, décodé côté Miotiq via un *descripteur* ([`formats/udp-miotiq.md`](formats/udp-miotiq.md)).
- **Miotiq → serveur AirCarto** : JSON canonique 2026 ([`formats/json-payload.md`](formats/json-payload.md)) posté sur `api.aircarto.com/receive_data`.
- **Vocabulaire polluants** : codes ISO LCSQA ([`formats/iso-pollutant-codes.md`](formats/iso-pollutant-codes.md)).
- **Capteurs physiques** : docs individuelles sous `sensors/` (protocole UART/I2C, câblage, commandes).