Add example description #169

Xinyuan-LilyGO · Oct 28, 2024 · a4aef6e · a4aef6e
1 parent 90632a4
commit a4aef6e
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -81,14 +81,15 @@
 | HP303BSensor*                   | ✅                 | ✅                  | ✅                  | ✅               | ✅                  | ✅               |
 | SPIExample*                     | ✅                 | ✅                  | ✅                  | ✅               | ✅                  | ✅               |
 | PowerMonitoring                 | ✅                 | ❌                  | ❌(No support)[2]   | ✅               | ❌                  | ✅               |
-| SimHatAccelerometer             | ✅                 | ❌                  | ❌(No support)[2]   | ✅[1]            | ❌                  | ✅               |
-| SimHatCurrentSensor             | ✅                 | ❌                  | ❌(No support)[2]   | ✅               | ❌                  | ✅               |
-| SimHatOneWireSensor             | ✅                 | ❌                  | ❌(No support)[2]   | ✅               | ❌                  | ✅               |
-| SimHatRelay                     | ✅                 | ❌                  | ❌(No support)[2]   | ✅               | ❌                  | ✅               |
+| SimHatAccelerometer[3]          | ✅                 | ❌                  | ❌(No support)[2]   | ✅[1]            | ❌                  | ✅               |
+| SimHatCurrentSensor[3]          | ✅                 | ❌                  | ❌(No support)[2]   | ✅               | ❌                  | ✅               |
+| SimHatOneWireSensor[3]          | ✅                 | ❌                  | ❌(No support)[2]   | ✅               | ❌                  | ✅               |
+| SimHatRelay[3]                  | ✅                 | ❌                  | ❌(No support)[2]   | ✅               | ❌                  | ✅               |
 
 - HP303BSensor,SPIExample it only demonstrates how to define and use SPI and I2C. Please confirm the pin connection and IO definition before use.
 - [1] T-A7608-ESP32 Conflict with Solar ADC
 - [2] The relay driver conflicts with the board RST and cannot work
+- [3] Requires external expansion board support [T-SimHat](https://www.lilygo.cc/products/lilygo%C2%AE-t-simhat-can-rs485-relay-5v)
 
 # Quick start ⚡
 

diff --git a/examples/SimHatAccelerometer/SimHatAccelerometer.ino b/examples/SimHatAccelerometer/SimHatAccelerometer.ino
@@ -4,8 +4,14 @@
  * @license   MIT
  * @copyright Copyright (c) 2024  ShenZhen XinYuan Electronic Technology Co., Ltd
  * @date      2024-10-17
- *
  */
+
+// * @note      Requires external expansion board support https://www.lilygo.cc/products/lilygo%C2%AE-t-simhat-can-rs485-relay-5v
+// * @note      Requires external expansion board support https://www.lilygo.cc/products/lilygo%C2%AE-t-simhat-can-rs485-relay-5v
+// * @note      Requires external expansion board support https://www.lilygo.cc/products/lilygo%C2%AE-t-simhat-can-rs485-relay-5v
+// * @note      Requires external expansion board support https://www.lilygo.cc/products/lilygo%C2%AE-t-simhat-can-rs485-relay-5v
+// * @note      Requires external expansion board support https://www.lilygo.cc/products/lilygo%C2%AE-t-simhat-can-rs485-relay-5v
+
 #include <Arduino.h>
 #include <Wire.h>
 #include <SPI.h>

diff --git a/examples/SimHatCurrentSensor/SimHatCurrentSensor.ino b/examples/SimHatCurrentSensor/SimHatCurrentSensor.ino
@@ -1,6 +1,12 @@
 // REQUIRES the following Arduino libraries:
 // - Adafruit INA219 Lib: https://github.com/adafruit/Adafruit_INA219
 // - Adafruit Unified Sensor Lib: https://github.com/adafruit/Adafruit_Sensor
+// * @note      Requires external expansion board support https://www.lilygo.cc/products/lilygo%C2%AE-t-simhat-can-rs485-relay-5v
+// * @note      Requires external expansion board support https://www.lilygo.cc/products/lilygo%C2%AE-t-simhat-can-rs485-relay-5v
+// * @note      Requires external expansion board support https://www.lilygo.cc/products/lilygo%C2%AE-t-simhat-can-rs485-relay-5v
+// * @note      Requires external expansion board support https://www.lilygo.cc/products/lilygo%C2%AE-t-simhat-can-rs485-relay-5v
+// * @note      Requires external expansion board support https://www.lilygo.cc/products/lilygo%C2%AE-t-simhat-can-rs485-relay-5v
+
 #include <Adafruit_Sensor.h>
 #include <Adafruit_BusIO_Register.h>
 #include <Adafruit_INA219.h>

diff --git a/examples/SimHatOneWireSensor/SimHatOneWireSensor.ino b/examples/SimHatOneWireSensor/SimHatOneWireSensor.ino
@@ -7,6 +7,12 @@
 // - DHT Sensor Library: https://github.com/adafruit/DHT-sensor-library
 // - Adafruit Unified Sensor Lib: https://github.com/adafruit/Adafruit_Sensor
 
+// * @note      Requires external expansion board support https://www.lilygo.cc/products/lilygo%C2%AE-t-simhat-can-rs485-relay-5v
+// * @note      Requires external expansion board support https://www.lilygo.cc/products/lilygo%C2%AE-t-simhat-can-rs485-relay-5v
+// * @note      Requires external expansion board support https://www.lilygo.cc/products/lilygo%C2%AE-t-simhat-can-rs485-relay-5v
+// * @note      Requires external expansion board support https://www.lilygo.cc/products/lilygo%C2%AE-t-simhat-can-rs485-relay-5v
+// * @note      Requires external expansion board support https://www.lilygo.cc/products/lilygo%C2%AE-t-simhat-can-rs485-relay-5v
+
 #include <Adafruit_Sensor.h>
 #include <Adafruit_BusIO_Register.h>
 #include <DHT.h>

diff --git a/examples/SimHatRelay/SimHatRelay.ino b/examples/SimHatRelay/SimHatRelay.ino
@@ -7,6 +7,12 @@
  *
  */
 
+// * @note      Requires external expansion board support https://www.lilygo.cc/products/lilygo%C2%AE-t-simhat-can-rs485-relay-5v
+// * @note      Requires external expansion board support https://www.lilygo.cc/products/lilygo%C2%AE-t-simhat-can-rs485-relay-5v
+// * @note      Requires external expansion board support https://www.lilygo.cc/products/lilygo%C2%AE-t-simhat-can-rs485-relay-5v
+// * @note      Requires external expansion board support https://www.lilygo.cc/products/lilygo%C2%AE-t-simhat-can-rs485-relay-5v
+// * @note      Requires external expansion board support https://www.lilygo.cc/products/lilygo%C2%AE-t-simhat-can-rs485-relay-5v
+
 #include <Arduino.h>
 
 // T-A7670X SIM-Hat Pin

diff --git a/platformio.ini b/platformio.ini
@@ -25,12 +25,12 @@
 ; default_envs = T-Call-A7670X-V1-1
 
 ;! SIM7672G and SIM7670G are exactly the same, except for the name change
-; default_envs = T-SIM7672G
+default_envs = T-SIM7672G
 
 ; https://www.lilygo.cc/products/t-a7608e-h
 ; default_envs = T-A7608X
 
-default_envs = T-A7608X-S3
+; default_envs = T-A7608X-S3
 
 ; default_envs = T-A7608X-DC-S3
 
@@ -72,22 +72,25 @@ default_envs = T-A7608X-S3
 ; src_dir = examples/HttpsBuiltlnGet
 ; src_dir = examples/HttpsBuiltlnPost
 ; src_dir = examples/MqttsBuiltlnEMQX
+src_dir = examples/MqttsBuiltlnWill
 ; src_dir = examples/HttpsOTAUpgrade
 ; src_dir = examples/HP303BSensor
 ; src_dir = examples/SPIExample
 ; src_dir = examples/SendLocationFromSMS
 ; src_dir = examples/SendLocationFromSMS_Use_TinyGPS
 ; src_dir = examples/PowerMonitoring
 ; src_dir = examples/SimHatOneWireSensor
-src_dir = examples/SimHatCurrentSensor
+; src_dir = examples/SimHatCurrentSensor
 ; src_dir = examples/SimHatRelay
 ; src_dir = examples/SimHatAccelerometer
 
 
 [env]
 platform = espressif32
 framework = arduino
-; extra_scripts =  ./script/pos_extra_script.py
+
+monitor_speed = 115200
+
 
 [esp32dev_base]
 board = esp32dev