Updated sample headers to add some little doc

mathieucarbou · Mar 1, 2024 · 6f6dbdb · 6f6dbdb
1 parent 9e5a083
commit 6f6dbdb
Show file tree

Hide file tree

Showing 9 changed files with 63 additions and 39 deletions.
diff --git a/examples/EnergyReset/EnergyReset.ino b/examples/EnergyReset/EnergyReset.ino
@@ -1,3 +1,13 @@
+/*
+  * This example shows how to reset the energy counter of the PZEM004Tv3
+  * when the energy consumed is greater than 0.002 kWh.
+  *
+  * The circuit:
+  * - PZEM004Tv3 connected to Serial1 (RX=27, TX=14)
+  *
+  * Compile with -D MYCILA_PZEM_JSON_SUPPORT to enable JSON support
+  * Add ArduinoJson library to your project
+*/
 #include <Arduino.h>
 #include <ArduinoJson.h>
 #include <MycilaPZEM004Tv3.h>

diff --git a/examples/EnergyResetAsync/EnergyResetAsync.ino b/examples/EnergyResetAsync/EnergyResetAsync.ino
@@ -1,3 +1,13 @@
+/*
+  * This example shows how to reset the energy counter of the PZEM004Tv3
+  * when the energy consumed is greater than 0.002 kWh.
+  *
+  * The circuit:
+  * - PZEM004Tv3 connected to Serial1 (RX=27, TX=14)
+  *
+  * Compile with -D MYCILA_PZEM_JSON_SUPPORT to enable JSON support
+  * Add ArduinoJson library to your project
+*/
 #include <Arduino.h>
 #include <ArduinoJson.h>
 #include <MycilaPZEM004Tv3.h>

diff --git a/examples/Read/Read.ino b/examples/Read/Read.ino
@@ -1,3 +1,12 @@
+/*
+  * This example shows how to read the energy data of a PZEM004Tv3
+  *
+  * The circuit:
+  * - PZEM004Tv3 connected to Serial1 (RX=27, TX=14)
+  *
+  * Compile with -D MYCILA_PZEM_JSON_SUPPORT to enable JSON support
+  * Add ArduinoJson library to your project
+*/
 #include <Arduino.h>
 #include <ArduinoJson.h>
 #include <MycilaPZEM004Tv3.h>

diff --git a/examples/ReadAsync/ReadAsync.ino b/examples/ReadAsync/ReadAsync.ino
@@ -1,3 +1,12 @@
+/*
+  * This example shows how to read the energy data of a PZEM004Tv3
+  *
+  * The circuit:
+  * - PZEM004Tv3 connected to Serial1 (RX=27, TX=14)
+  *
+  * Compile with -D MYCILA_PZEM_JSON_SUPPORT to enable JSON support
+  * Add ArduinoJson library to your project
+*/
 #include <Arduino.h>
 #include <ArduinoJson.h>
 #include <MycilaPZEM004Tv3.h>

diff --git a/examples/ReadAsyncMulti/ReadAsyncMulti.ino b/examples/ReadAsyncMulti/ReadAsyncMulti.ino
@@ -1,3 +1,14 @@
+/*
+  * This example shows how to read the energy data of several PZEM004Tv3 devices on the same Serial port.
+  * PZEM have to be assigned addresses before using this example.
+  *
+  * The circuit:
+  * - PZEM004Tv3 #1 connected to Serial1 (RX=27, TX=14)
+  * - PZEM004Tv3 #2 connected to Serial1 (RX=27, TX=14)
+  *
+  * Compile with -D MYCILA_PZEM_JSON_SUPPORT to enable JSON support
+  * Add ArduinoJson library to your project
+*/
 #include <Arduino.h>
 #include <ArduinoJson.h>
 #include <MycilaPZEM004Tv3.h>

diff --git a/examples/Search/Search.ino b/examples/Search/Search.ino
@@ -1,3 +1,11 @@
+/*
+  * This example shows how to search for PZEM004Tv3 devices on the same Serial port.
+  * PZEM have to be assigned addresses before using this example.
+  *
+  * The circuit:
+  * - PZEM004Tv3 #1 connected to Serial1 (RX=27, TX=14)
+  * - PZEM004Tv3 #2 connected to Serial1 (RX=27, TX=14)
+*/
 #include <Arduino.h>
 #include <MycilaPZEM004Tv3.h>
 

diff --git a/examples/SetAddress/SetAddress.ino b/examples/SetAddress/SetAddress.ino
@@ -1,3 +1,9 @@
+/*
+  * This example shows how to set an address to a PZEM004Tv3 device.
+  *
+  * The circuit:
+  * - PZEM004Tv3 connected to Serial1 (RX=27, TX=14)
+*/
 #include <Arduino.h>
 #include <MycilaPZEM004Tv3.h>
 

diff --git a/examples/SetAddressMulti/SetAddressMulti.ino b/examples/SetAddressMulti/SetAddressMulti.ino
diff --git a/platformio.ini b/platformio.ini
@@ -6,7 +6,6 @@ lib_dir = .
 ; src_dir = examples/EnergyReset
 ; src_dir = examples/EnergyResetAsync
 src_dir = examples/SetAddress
-; src_dir = examples/SetAddressMulti
 ; src_dir = examples/Search
 default_envs = esp32
 ; default_envs = esp32s3box