Skip to content

docs: explain sampling qualification and bounded display recovery - #29

Merged
flowcool merged 1 commit into
upstream/staging-v2r1from
upstream/generic-validation-docs
Oct 20, 2026
Merged

flowcool merged 1 commit into
upstream/staging-v2r1from
upstream/generic-validation-docs

Conversation

@flowcool

@flowcool flowcool commented Oct 20, 2026 •

Copy link
Copy Markdown
Owner

Behavior

Port the generic outcomes of infra-3rr.57/.60. Keep 3 seconds soil sampling until isolated analog evidence supports a change. Explain 15 seconds of programmed dwell versus a 12-second sample span versus measured awake time. Document the already-staged total BUSY budget and native shutdown boundary. Add API/diagnostic/gauge guidance without local fleet provenance.

Target: flowcool/Smart_Plant:upstream/staging-v2r1. Source 713b8cc, predecessor 37d21f3. Open after the preceding contribution merges so this PR contains only its owned change. The upstream baseline is bcf373144b2d5c7e3a712fd02698e2e98e45aeed. No PR to JGAguado is authorized.

Verification

Local relative links resolve. Strict Sphinx build passes. Semantic review matches the exact staging scripts: recovery action bound of 31.510 seconds for MQTT / 31.010 seconds for API plus scheduling, not physical sleep. No bench, induced fault or timing change.

Inspect the semantic diff and git -c core.whitespace=cr-at-eol diff --check; preserve existing line endings. All tracked YAML parses. Firmware fixtures use local fonts/public images and synthetic credentials, never devices or shared builders. Local compilation does not prove deployment.

Rollback: revert this isolated PR on staging. No automatic deployment, fleet/NAS/cache purge/MQTT/HA action.

AI assistance

Codex prepared the port or extraction. The author inspected the behavior, contribution boundary, actual-source tests, compatibility and diff. Existing staging OTA confirmation and native shutdown remain intact.

CodeRabbit review

Require current-head completed review and yaml-syntax before merge. Florent approved one manual review request per ignored PR for this series only. Documentation-only PRs use the standing docs gate. Record review/head/checks/merge in owner infra-3rr.69.

Summary by CodeRabbit

  • Documentation
    • Ajout de recommandations sur la récupération de l’affichage : surveillance, annulation, redémarrage, délais et budget maximal de 30 secondes.
    • Documentation de la qualification hors ligne de l’intervalle d’échantillonnage du sol, actuellement fixé à 3 secondes.
    • Mise à jour du guide multi-appareils concernant les connexions API, les diagnostics, l’échantillonnage, la publication et les limites de récupération.
    • Ajout de précisions sur l’identification des versions, les valeurs invalides et la confirmation des mises à jour avant la mise en veille.

@coderabbitai

coderabbitai Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 3eb3ab3c-0a8b-474c-bcbd-3cfb9376e97b
📥 Commits

Reviewing files that changed from the base of the PR and between 2202c09 and 713b8cc.

📒 Files selected for processing: 3
  • docs/display-recovery.md
  • docs/soil-sampling-qualification.md
  • examples/multi-device/README.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 3 remain after this review.

📜 Recent review details
🔇 Additional comments: 2
docs/display-recovery.md: 1

1-50: LGTM!

examples/multi-device/README.md: 1

157-196: LGTM!

Walkthrough

La pull request ajoute de la documentation sur la récupération de l’affichage, la fenêtre de connexion API et les diagnostics de mesure. Elle propose aussi un protocole hors ligne pour qualifier les intervalles d’échantillonnage du sol. Aucun changement du firmware n’est décrit.

Changes

Récupération de l’affichage

Layer / File(s) Summary
Délais et arrêt de la récupération
docs/display-recovery.md, examples/multi-device/README.md
Les documents décrivent un budget de récupération de 30 secondes, l’annulation du travail obsolète et les limites de mise en veille. Ils précisent aussi le chemin d’arrêt ESPHome et le comportement en cas de panne terminale.

Qualification de l’échantillonnage du sol

Layer / File(s) Summary
Protocole de comparaison des intervalles
docs/soil-sampling-qualification.md
Le document décrit le contrat de cinq échantillons, les intervalles candidats et un protocole de comparaison analogique. Il précise les limites de l’analyse logicielle et les conditions de validation, d’autorisation et de retour arrière.

Fonctionnement multi-appareils

Layer / File(s) Summary
Fenêtre API et diagnostics de mesure
examples/multi-device/README.md
Le README documente la fenêtre API de 10 secondes et son exception en cas de protection batterie critique. Il décrit aussi l’échantillonnage, la publication après le cinquième échantillon et l’affichage des valeurs de mesure.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 713b8

The documentation-only change is mergeable; its selection rule already distinguishes the current control interval from reduced candidates.

Architecture risk: 🔵 Low · up to 713b8

The change affects 2 systems.

Changed systems: docs, examples

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs (service) was modified; 2 changed files map to changed impact.
  • observed — examples (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in docs/display-recovery.md: Ajout d’une documentation complète décrivant le comportement de récupération d’affichage, les délais et limites de terminaison, le chemin d’arrêt normal ESPHome, ainsi que l’exécution et la couverture de la suite de régression isolée.
  • observed — Modified behavior in docs/soil-sampling-qualification.md: Ajout d’une proposition de qualification hors ligne documentant le contrat de cinq échantillons, le filtre médian, les durées à 3 secondes, 200 ms et 100 ms, les limites de l’analyse logicielle, le protocole de comparaison analogique, le maintien du nombre de publications et de la gestion des valeurs invalides, ainsi que la sélection du candidat le plus long satisfaisant les limites convenues. Le document précise qu’aucun changement d’exécution n’est introduit et qu’une validation, une autorisation de déploiement et un retour à la dernière version validée restent requis.
  • observed — Modified behavior in examples/multi-device/README.md: Ajout de la documentation de la fenêtre API de 10 secondes, ignorée pour la protection batterie critique, avec poursuite du cycle normal sans abonné.
  • observed — Modified behavior in examples/multi-device/README.md: Ajout des diagnostics de mesure : cinq échantillons espacés de trois secondes, publication après le cinquième échantillon, exposition de la tension filtrée et de la version, conservation des calibrations et affichage -- pour les valeurs absentes ou non finies.
Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed Le titre décrit clairement les deux changements principaux : la qualification de l’échantillonnage et la récupération bornée de l’affichage. Il est concis et spécifique.
Description check Passed La description contient les sections Behavior, Verification, AI assistance et CodeRabbit. Elle décrit le comportement, les vérifications, les limites et l’assistance IA. Les champs de vérification son…
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Description check

Explanation

La description contient les sections Behavior, Verification, AI assistance et CodeRabbit. Elle décrit le comportement, les vérifications, les limites et l’assistance IA. Les champs de vérification sont intégrés dans un texte continu, et l’URL du contrôle CodeRabbit ainsi que le SHA contrôlé ne sont pas renseignés, mais ces éléments manquants ne rendent pas la description globalement incomplète.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (3 skipped: 3 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Un lapin lit les délais au jardin,
Il compte cinq mesures au petit matin.
L’écran se repose selon son budget,
Les valeurs s’affichent quand elles sont prêtes.
Il range ses notes près des carottes,
Et bondit, ravi, vers sa botte.

Comment @coderabbitai help to get the list of available commands.

@flowcool

Copy link
Copy Markdown
Owner Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@flowcool
flowcool merged commit d16e97d into upstream/staging-v2r1 Oct 20, 2026
2 checks passed
@flowcool
flowcool deleted the upstream/generic-validation-docs branch October 20, 2026 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant