Use MQTT per default and mention api as alternative (#63)

syssi · Jun 30, 2022 · ca41ef4 · ca41ef4
1 parent 6eb6f9e
commit ca41ef4
Show file tree

Hide file tree

Showing 8 changed files with 77 additions and 43 deletions.
diff --git a/README.md b/README.md
@@ -102,17 +102,19 @@ wifi:
   password: !secret wifi_password
 
 ota:
-# api:
-
-logger:
-  baud_rate: 0
 
+# If you use Home Assistant please remove this `mqtt` section and uncomment the `api` component!
 mqtt:
   broker: !secret mqtt_host
   username: !secret mqtt_username
   password: !secret mqtt_password
   id: mqtt_client
 
+# api:
+
+logger:
+  baud_rate: 0
+
 uart:
   baud_rate: 4800
   tx_pin: GPIO1

diff --git a/esp32-example.yaml b/esp32-example.yaml
@@ -2,6 +2,8 @@ substitutions:
   name: soyosource-gtn-virtual-meter
   device_description: "Monitor a Soyosource GTN and control the power output on demand both via RS485"
   external_components_source: github://syssi/esphome-soyosource-gtn-virtual-meter@main
+  tx_pin: GPIO1
+  rx_pin: GPIO3
 
 esphome:
   name: ${name}
@@ -22,21 +24,23 @@ wifi:
   password: !secret wifi_password
 
 ota:
-# api:
-
-logger:
-  baud_rate: 0
 
+# If you use Home Assistant please remove this `mqtt` section and uncomment the `api` component!
 mqtt:
   broker: !secret mqtt_host
   username: !secret mqtt_username
   password: !secret mqtt_password
   id: mqtt_client
 
+# api:
+
+logger:
+  baud_rate: 0
+
 uart:
   baud_rate: 4800
-  tx_pin: GPIO1
-  rx_pin: GPIO3
+  tx_pin: ${tx_pin}
+  rx_pin: ${rx_pin}
 
 soyosource_modbus:
   # Optional settings

diff --git a/esp32-multiple-uarts-example.yaml b/esp32-multiple-uarts-example.yaml
@@ -4,6 +4,10 @@ substitutions:
   device0: firstfloor_soyosource_gtn_virtual_meter
   device1: groundfloor_soyosource_gtn_virtual_meter
   external_components_source: github://syssi/esphome-soyosource-gtn-virtual-meter@main
+  tx_pin_uart0: GPIO1
+  rx_pin_uart0: GPIO3
+  tx_pin_uart1: GPIO14
+  rx_pin_uart1: GPIO4
 
 esphome:
   name: ${name}
@@ -26,28 +30,30 @@ ethernet:
   clk_mode: GPIO17_OUT
   phy_addr: 0
 
-# api:
 ota:
 
-logger:
-  baud_rate: 0
-  level: INFO
-
+# If you use Home Assistant please remove this `mqtt` section and uncomment the `api` component!
 mqtt:
   broker: !secret mqtt_host
   username: !secret mqtt_username
   password: !secret mqtt_password
   id: mqtt_client
 
+# api:
+
+logger:
+  baud_rate: 0
+  level: INFO
+
 uart:
   - id: uart0
     baud_rate: 4800
-    tx_pin: GPIO1
-    rx_pin: GPIO3
+    tx_pin: ${tx_pin_uart0}
+    rx_pin: ${rx_pin_uart0}
   - id: uart1
     baud_rate: 4800
-    tx_pin: GPIO14
-    rx_pin: GPIO4
+    tx_pin: ${tx_pin_uart1}
+    rx_pin: ${rx_pin_uart1}
 
 soyosource_modbus:
   - id: modbus0

diff --git a/esp8266-display-example.yaml b/esp8266-display-example.yaml
@@ -1,7 +1,11 @@
 substitutions:
   name: soyosource-gtn-display
-  device_description: "Monitor and control the WiFi version of the Soyosource GTN via the USB-TTL port and control the power output on demand via RS485"
+  device_description: "Monitor and control the WiFi version of the Soyosource GTN via the TTL-WIFI port and control the power output on demand via RS485"
   external_components_source: github://syssi/esphome-soyosource-gtn-virtual-meter@main
+  tx_pin_ttl_wifi: GPIO14
+  rx_pin_ttl_wifi: GPIO12
+  tx_pin_rs485: GPIO4
+  rx_pin_rs485: GPIO5
 
 esphome:
   name: ${name}
@@ -22,23 +26,30 @@ wifi:
   password: !secret wifi_password
 
 ota:
-api:
+
+# If you use Home Assistant please remove this `mqtt` section and uncomment the `api` component!
+mqtt:
+  broker: !secret mqtt_host
+  username: !secret mqtt_username
+  password: !secret mqtt_password
+  id: mqtt_client
+
+# api:
+
 logger:
   level: INFO
 
 # Please be careful: The display port has a logic level of 5V.
 uart:
   - id: uart0
     baud_rate: 9600
-    tx_pin: GPIO14
-    rx_pin: GPIO12
-    debug:
-      direction: BOTH
+    tx_pin: ${tx_pin_ttl_wifi}
+    rx_pin: ${rx_pin_ttl_wifi}
 
   - id: uart1
     baud_rate: 4800
-    tx_pin: GPIO4
-    rx_pin: GPIO5
+    tx_pin: ${tx_pin_rs485}
+    rx_pin: ${rx_pin_rs485}
 
 soyosource_modbus:
   - id: modbus0

diff --git a/esp8266-example.yaml b/esp8266-example.yaml
@@ -2,6 +2,8 @@ substitutions:
   name: soyosource-gtn-virtual-meter
   device_description: "Monitor a Soyosource GTN and control the power output on demand both via RS485"
   external_components_source: github://syssi/esphome-soyosource-gtn-virtual-meter@main
+  tx_pin: GPIO1
+  rx_pin: GPIO3
 
 esphome:
   name: ${name}
@@ -22,21 +24,23 @@ wifi:
   password: !secret wifi_password
 
 ota:
-# api:
-
-logger:
-  baud_rate: 0
 
+# If you use Home Assistant please remove this `mqtt` section and uncomment the `api` component!
 mqtt:
   broker: !secret mqtt_host
   username: !secret mqtt_username
   password: !secret mqtt_password
   id: mqtt_client
 
+# api:
+
+logger:
+  baud_rate: 0
+
 uart:
   baud_rate: 4800
-  tx_pin: GPIO1
-  rx_pin: GPIO3
+  tx_pin: ${tx_pin}
+  rx_pin: ${rx_pin}
 
 soyosource_modbus:
   # Optional settings

diff --git a/esp8266-fake-display.yaml b/esp8266-fake-display.yaml
@@ -1,8 +1,8 @@
 substitutions:
   name: fake-display
-  device_description: "Emulate the USB-TTL port traffic of the Soyosource GTN (WiFi version)"
-  tx_pin: GPIO5
-  rx_pin: GPIO4
+  device_description: "Emulate the TTL-WIFI port traffic of the Soyosource GTN (WiFi version)"
+  tx_pin: GPIO4
+  rx_pin: GPIO5
 
 esphome:
   name: ${name}
@@ -18,8 +18,8 @@ wifi:
   ssid: !secret wifi_ssid
   password: !secret wifi_password
 
-api:
 ota:
+api:
 logger:
 
 uart:

diff --git a/esp8266-inverter-emulator.yaml b/esp8266-inverter-emulator.yaml
@@ -1,9 +1,9 @@
 substitutions:
   name: soyosource-gtn-inverter-emu
-  device_description: "Emulate the USB-TTL port traffic of the Soyosource GTN (WiFi version)"
+  device_description: "Emulate the TTL-WIFI port traffic of the Soyosource GTN (WiFi version)"
   external_components_source: github://syssi/esphome-soyosource-gtn-virtual-meter@main
-  tx_pin: GPIO1
-  rx_pin: GPIO3
+  tx_pin: GPIO4
+  rx_pin: GPIO5
 
 esphome:
   name: ${name}
@@ -25,9 +25,7 @@ wifi:
 
 ota:
 api:
-
 logger:
-  baud_rate: 0
 
 # Please be careful: The display port has a logic level of 5V.
 uart:

diff --git a/esp8266-wifi-dongle-example.yaml b/esp8266-wifi-dongle-example.yaml
@@ -22,7 +22,16 @@ wifi:
   password: !secret wifi_password
 
 ota:
-api:
+
+# If you use Home Assistant please remove this `mqtt` section and uncomment the `api` component!
+mqtt:
+  broker: !secret mqtt_host
+  username: !secret mqtt_username
+  password: !secret mqtt_password
+  id: mqtt_client
+
+# api:
+
 logger:
   baud_rate: 0
   level: INFO