docs: Harmonize wsen-hids README — add I2C address and power sections.#206
docs: Harmonize wsen-hids README — add I2C address and power sections.#206Charly-sketch wants to merge 1 commit intomainfrom
Conversation
nedseb
left a comment
There was a problem hiding this comment.
Salut Charly,
🔴 Problème critique : mauvais fichier modifié
Cette PR modifie `lib/wsen-pads/README.md` mais le titre, la description et le contenu parlent de wsen-hids. Tu as écrasé le README de WSEN-PADS avec le contenu de WSEN-HIDS.
Résultat : le README de WSEN-PADS (capteur de pression) a été remplacé par la doc du WSEN-HIDS (capteur d'humidité). Toute la documentation spécifique au WSEN-PADS (plage de pression, résolution 24-bit, modes ODR, low-noise, low-pass filter, connexion SAO, adresses 0x5C/0x5D...) est supprimée.
La PR doit être refaite intégralement. L'issue #197 demande d'harmoniser le README de wsen-hids, pas de remplacer celui de wsen-pads ^^.
Ce qui aurait dû être fait
L'issue #197 demandait d'ajouter les sections manquantes au README de wsen-hids (`lib/wsen-hids/README.md`). Le diff montre que tu voulais ajouter :
- Une section I²C Address dédiée
- Une section Power Management (power_off, power_on, reboot)
- Corriger l'I2C bus (0 → 1) et simplifier l'init
Ces modifications sont pertinentes, mais elles devaient être appliquées à `lib/wsen-hids/README.md`, pas à `lib/wsen-pads/README.md`.
Vérifications à faire avant de re-soumettre
En relisant le diff, j'ai noté quelques points sur le contenu WSEN-HIDS lui-même :
1. Constantes ODR avec préfixe `WSEN_HIDS.`
WSEN_HIDS.ODR_1_HZ
WSEN_HIDS.ODR_7_HZLes constantes ODR ne sont pas des attributs de classe. Elles sont dans `const.py` et s'utilisent directement :
from wsen_hids.const import ODR_1_HZ
sensor.set_continuous(ODR_1_HZ)Même problème pour les constantes AVG — `WSEN_HIDS.AVG_16` est incorrect. Vérifie en lisant `lib/wsen-hids/wsen_hids/const.py`.
2. Section "Optional parameters" vide
# Optional parameters:
sensor = WSEN_HIDS(i2c)La section "Optional parameters" ne montre... aucun paramètre optionnel. Soit tu listes les vrais paramètres (`address`, `check_device`, `enable_bdu` — lis le constructeur dans `device.py`), soit tu supprimes cette sous-section.
3. `read_one_shot(timeout_ms=500)`
Le README indique :
sensor.read_one_shot(timeout_ms=500)Vérifie que le paramètre s'appelle bien `timeout_ms` dans le code (et pas juste `timeout`). Le code utilise `DEFAULT_ONE_SHOT_TIMEOUT_MS` comme valeur par défaut.
4. Méthodes non documentées
Plusieurs méthodes publiques du driver ne sont pas dans le README :
- `device_id()` — identification du capteur
- `check_device()` — vérification de la connexion
- `trigger_one_shot()` — déclencher une conversion sans lire
- `enable_bdu()` — Block Data Update
5. Pas de newline finale
Le fichier se termine sans `\n` (`\ No newline at end of file` dans le diff). Ajoute une ligne vide à la fin.
Résumé
| Problème | Sévérité |
|---|---|
| Mauvais fichier modifié (wsen-pads au lieu de wsen-hids) | 🔴 Critique |
| README wsen-pads supprimé | 🔴 Critique |
| Constantes avec préfixe classe incorrect | 🟡 À corriger |
| Section "Optional parameters" vide | 🟡 À corriger |
| Méthodes publiques non documentées | 🟡 Incomplet |
| Pas de newline finale | 🟡 À corriger |
Action requise : ferme cette PR, restaure `lib/wsen-pads/README.md`, et crée une nouvelle PR qui modifie le bon fichier (`lib/wsen-hids/README.md`).
Closes #197
Parent issue: #194
Add missing README sections for WSEN-HIDS driver
This PR completes the documentation by adding:
Also fixes minor formatting issues in the README.