Skip to content

Commit ca6ffab

Browse files
committed
docs: clarify README structure and improve admonitions
- Replace inline [!IMPORTANT]/[!NOTE] markers with blockquote-style admonitions for consistent rendering
1 parent 9855471 commit ca6ffab

2 files changed

Lines changed: 14 additions & 5 deletions

File tree

Mk2_3phase_RFdatalog_temp/Readme.en.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,10 @@ This program is designed to be used with the Arduino IDE and/or other developmen
2424
- [Hardware configuration](#hardware-configuration)
2525
- [Software configuration](#software-configuration)
2626
- [Priority rotation](#priority-rotation)
27-
- [Forced operation configuration](#forced-operation-configuration)
27+
- [Forced operation configuration (New Flexible System)](#forced-operation-configuration-new-flexible-system)
28+
- [Feature activation](#feature-activation-1)
29+
- [OverridePins definition](#overridepins-definition)
30+
- [Usage](#usage)
2831
- [Routing stop](#routing-stop)
2932
- [Advanced program configuration](#advanced-program-configuration)
3033
- [`DIVERSION_START_THRESHOLD_WATTS` parameter](#diversion_start_threshold_watts-parameter)
@@ -532,7 +535,8 @@ For more details on ESPHome configuration and Home Assistant integration, consul
532535

533536
# Configuration without extension board
534537

535-
[!IMPORTANT] If you don't have the specific extension board or the appropriate motherboard PCB (these two elements not being available for now), you can still achieve integration by your own means.
538+
> [!IMPORTANT]
539+
> If you don't have the specific extension board or the appropriate motherboard PCB (these two elements not being available for now), you can still achieve integration by your own means.
536540
537541
In this case:
538542
- No connection is predefined between ESP32 and Mk2PVRouter
@@ -545,7 +549,8 @@ Ensure particularly that pin numbers used in each configuration correspond exact
545549

546550
For temperature probes, you can connect them directly to ESP32 using a `GPIO` pin of your choice, which you'll then configure in ESPHome. **Don't forget to add a 4.7 kΩ pull-up resistor between the data line (DQ) and +3.3 V power supply** to ensure proper 1-Wire bus operation.
547551

548-
[!NOTE] Even without the extension board, all Home Assistant integration features remain accessible, provided your wiring and software configurations are correctly implemented.
552+
> [!NOTE]
553+
> Even without the extension board, all Home Assistant integration features remain accessible, provided your wiring and software configurations are correctly implemented.
549554
550555
For more details on ESPHome configuration and Home Assistant integration, consult the [detailed documentation available in this gist](https://gist.github.com/FredM67/986e1cb0fc020fa6324ccc151006af99). This complete guide explains step by step how to configure your ESP32 with ESPHome to maximize your PVRouter's features in Home Assistant.
551556

Mk2_3phase_RFdatalog_temp/Readme.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ Ce programme est conçu pour être utilisé avec l’IDE Arduino et/ou d’autre
1919
- [Configuration du Watchdog](#configuration-du-watchdog)
2020
- [Configuration du ou des capteurs de température](#configuration-du-ou-des-capteurs-de-température)
2121
- [Activation de la fonctionnalité](#activation-de-la-fonctionnalité)
22+
- [Avec l’Arduino IDE](#avec-larduino-ide)
23+
- [Avec Visual Studio Code et PlatformIO](#avec-visual-studio-code-et-platformio)
2224
- [Configuration du ou des capteurs (commun aux 2 cas précédents)](#configuration-du-ou-des-capteurs-commun-aux-2-cas-précédents)
2325
- [Configuration de la gestion des Heures Creuses (dual tariff)](#configuration-de-la-gestion-des-heures-creuses-dual-tariff)
2426
- [Configuration matérielle](#configuration-matérielle)
@@ -567,7 +569,8 @@ Pour plus de détails sur la configuration d’ESPHome et l’intégration avec
567569

568570
# Configuration sans carte d’extension
569571

570-
[!IMPORTANT] Si vous ne disposez pas de la carte d’extension spécifique ni du PCB carte-mère approprié (ces deux éléments n’étant pas disponibles pour l’instant), vous pouvez toujours réaliser l’intégration par vos propres moyens.
572+
> [!IMPORTANT]
573+
> Si vous ne disposez pas de la carte d’extension spécifique ni du PCB carte-mère approprié (ces deux éléments n’étant pas disponibles pour l’instant), vous pouvez toujours réaliser l’intégration par vos propres moyens.
571574
572575
Dans ce cas :
573576
- Aucune connexion n’est prédéfinie entre l’ESP32 et le Mk2PVRouter
@@ -580,7 +583,8 @@ Assurez-vous notamment que les numéros de pins utilisés dans chaque configurat
580583

581584
Pour les sondes de température, vous pouvez les connecter directement à l’ESP32 en utilisant une broche `GPIO` de votre choix, que vous configurerez ensuite dans ESPHome. **N’oubliez pas d’ajouter une résistance pull-up de 4,7 kΩ entre la ligne de données (DQ) et l’alimentation +3,3 V** pour assurer le bon fonctionnement du bus 1-Wire.
582585

583-
[!NOTE] Même sans la carte d’extension, toutes les fonctionnalités d’intégration avec Home Assistant restent accessibles, à condition que votre câblage et vos configurations logicielles soient correctement réalisés.
586+
> [!NOTE]
587+
> Même sans la carte d’extension, toutes les fonctionnalités d’intégration avec Home Assistant restent accessibles, à condition que votre câblage et vos configurations logicielles soient correctement réalisés.
584588
585589
Pour plus de détails sur la configuration d’ESPHome et l’intégration avec Home Assistant, consultez la [documentation détaillée disponible dans ce gist](https://gist.github.com/FredM67/986e1cb0fc020fa6324ccc151006af99). Ce guide complet vous explique pas à pas comment configurer votre ESP32 avec ESPHome pour exploiter au maximum les fonctionnalités de votre PVRouter dans Home Assistant.
586590

0 commit comments

Comments
 (0)