Add native api note for Home Assistant users (#171)

2024-10-21 07:09:27 +00:00 · 2024-06-21 07:14:54 +02:00 · 2024-06-21 07:14:54 +02:00 · af99b1d586
commit af99b1d586
parent 9f104855ba
21 changed files with 63 additions and 31 deletions
--- a/bluesmart-charger-esp32-example.yaml
+++ b/bluesmart-charger-esp32-example.yaml
@ -23,6 +23,8 @@ ota:
 logger:
  baud_rate: 0

+# If you use Home Assistant please remove this `mqtt` section and uncomment the `api` component!
+# The native API has many advantages over MQTT: https://esphome.io/components/api.html#advantages-over-mqtt
 mqtt:
  broker: !secret mqtt_host
  username: !secret mqtt_username
--- a/bluesmart-charger-esp8266-example.yaml
+++ b/bluesmart-charger-esp8266-example.yaml
@ -21,6 +21,8 @@ ota:

 logger:

+# If you use Home Assistant please remove this `mqtt` section and uncomment the `api` component!
+# The native API has many advantages over MQTT: https://esphome.io/components/api.html#advantages-over-mqtt
 mqtt:
  broker: !secret mqtt_host
  username: !secret mqtt_username
--- a/debug-esp32-example.yaml
+++ b/debug-esp32-example.yaml
@ -24,10 +24,11 @@ wifi:
 ota:
  platform: esphome

-api:
-
 logger:

+api:
+  reboot_timeout: 0s
+
 uart:
  id: uart_0
  baud_rate: 19200
--- a/debug-esp8266-example.yaml
+++ b/debug-esp8266-example.yaml
@ -21,12 +21,13 @@ wifi:
 ota:
  platform: esphome

-api:
-
 logger:
  baud_rate: 0
  esp8266_store_log_strings_in_flash: false

+api:
+  reboot_timeout: 0s
+
 uart:
  id: uart_0
  baud_rate: 19200
--- a/multi-rs-esp8266-example.yaml
+++ b/multi-rs-esp8266-example.yaml
@ -23,6 +23,8 @@ logger:
  baud_rate: 0
  esp8266_store_log_strings_in_flash: false

+# If you use Home Assistant please remove this `mqtt` section and uncomment the `api` component!
+# The native API has many advantages over MQTT: https://esphome.io/components/api.html#advantages-over-mqtt
 mqtt:
  broker: !secret mqtt_host
  username: !secret mqtt_username
--- a/phoenix-charger-esp8266-example.yaml
+++ b/phoenix-charger-esp8266-example.yaml
@ -23,6 +23,8 @@ logger:
  baud_rate: 0
  esp8266_store_log_strings_in_flash: false

+# If you use Home Assistant please remove this `mqtt` section and uncomment the `api` component!
+# The native API has many advantages over MQTT: https://esphome.io/components/api.html#advantages-over-mqtt
 mqtt:
  broker: !secret mqtt_host
  username: !secret mqtt_username
--- a/phoenix-inverter-esp8266-example.yaml
+++ b/phoenix-inverter-esp8266-example.yaml
@ -23,6 +23,8 @@ logger:
  baud_rate: 0
  esp8266_store_log_strings_in_flash: false

+# If you use Home Assistant please remove this `mqtt` section and uncomment the `api` component!
+# The native API has many advantages over MQTT: https://esphome.io/components/api.html#advantages-over-mqtt
 mqtt:
  broker: !secret mqtt_host
  username: !secret mqtt_username
--- a/smartshunt-esp8266-example.yaml
+++ b/smartshunt-esp8266-example.yaml
@ -23,6 +23,8 @@ logger:
  baud_rate: 0
  esp8266_store_log_strings_in_flash: false

+# If you use Home Assistant please remove this `mqtt` section and uncomment the `api` component!
+# The native API has many advantages over MQTT: https://esphome.io/components/api.html#advantages-over-mqtt
 mqtt:
  broker: !secret mqtt_host
  username: !secret mqtt_username
--- a/smartsolar-mppt-esp8266-example-advanced.yaml
+++ b/smartsolar-mppt-esp8266-example-advanced.yaml
@ -30,23 +30,27 @@ wifi:

 captive_portal:

+ota:
+  platform: esphome
+
 logger:
  baud_rate: 0
  # level: VERY_VERBOSE
  esp8266_store_log_strings_in_flash: false

-# Enable Home Assistant API
-api:
-  reboot_timeout: 0s
-
-ota:
-  platform: esphome
+# If you use Home Assistant please remove this `mqtt` section and uncomment the `api` component!
+# The native API has many advantages over MQTT: https://esphome.io/components/api.html#advantages-over-mqtt
+mqtt:
+  broker: !secret mqtt_host
+  username: !secret mqtt_username
+  password: !secret mqtt_password
+  id: mqtt_client

 web_server:
  port: 80

 time:
-  - platform: homeassistant
+  - platform: sntp

 uart:
  id: uart_bus
--- a/smartsolar-mppt-esp8266-example-multiple-uarts.yaml
+++ b/smartsolar-mppt-esp8266-example-multiple-uarts.yaml
@ -25,6 +25,8 @@ logger:
  baud_rate: 0
  esp8266_store_log_strings_in_flash: false

+# If you use Home Assistant please remove this `mqtt` section and uncomment the `api` component!
+# The native API has many advantages over MQTT: https://esphome.io/components/api.html#advantages-over-mqtt
 mqtt:
  broker: !secret mqtt_host
  username: !secret mqtt_username
--- a/smartsolar-mppt-esp8266-example.yaml
+++ b/smartsolar-mppt-esp8266-example.yaml
@ -23,6 +23,8 @@ logger:
  baud_rate: 0
  esp8266_store_log_strings_in_flash: false

+# If you use Home Assistant please remove this `mqtt` section and uncomment the `api` component!
+# The native API has many advantages over MQTT: https://esphome.io/components/api.html#advantages-over-mqtt
 mqtt:
  broker: !secret mqtt_host
  username: !secret mqtt_username
--- a/tests/emulator-all-keys.yaml
+++ b/tests/emulator-all-keys.yaml
@ -12,14 +12,15 @@ wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password

-api:
-
 ota:
  platform: esphome

 logger:
  level: DEBUG

+api:
+  reboot_timeout: 0s
+
 uart:
  baud_rate: 19200
  tx_pin: ${tx_pin}
--- a/tests/fake-bluesmart-ip22-0xa332.yaml
+++ b/tests/fake-bluesmart-ip22-0xa332.yaml
@ -12,14 +12,15 @@ wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password

-api:
-
 ota:
  platform: esphome

 logger:
  level: DEBUG

+api:
+  reboot_timeout: 0s
+
 uart:
  baud_rate: 19200
  tx_pin: ${tx_pin}
--- a/tests/fake-bluesmart-ip65-0xa30a.yaml
+++ b/tests/fake-bluesmart-ip65-0xa30a.yaml
@ -12,14 +12,15 @@ wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password

-api:
-
 ota:
  platform: esphome

 logger:
  level: DEBUG

+api:
+  reboot_timeout: 0s
+
 uart:
  baud_rate: 19200
  tx_pin: ${tx_pin}
--- a/tests/fake-bmv600.yaml
+++ b/tests/fake-bmv600.yaml
@ -12,14 +12,15 @@ wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password

-api:
-
 ota:
  platform: esphome

 logger:
  level: DEBUG

+api:
+  reboot_timeout: 0s
+
 uart:
  baud_rate: 19200
  tx_pin: ${tx_pin}
--- a/tests/fake-bmv700.yaml
+++ b/tests/fake-bmv700.yaml
@ -12,14 +12,15 @@ wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password

-api:
-
 ota:
  platform: esphome

 logger:
  level: DEBUG

+api:
+  reboot_timeout: 0s
+
 uart:
  baud_rate: 19200
  tx_pin: ${tx_pin}
--- a/tests/fake-bmv710.yaml
+++ b/tests/fake-bmv710.yaml
@ -12,14 +12,15 @@ wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password

-api:
-
 ota:
  platform: esphome

 logger:
  level: DEBUG

+api:
+  reboot_timeout: 0s
+
 uart:
  baud_rate: 19200
  tx_pin: ${tx_pin}
--- a/tests/fake-bmv712.yaml
+++ b/tests/fake-bmv712.yaml
@ -12,14 +12,15 @@ wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password

-api:
-
 ota:
  platform: esphome

 logger:
  level: DEBUG

+api:
+  reboot_timeout: 0s
+
 uart:
  baud_rate: 19200
  tx_pin: ${tx_pin}
--- a/tests/fake-multi-rs-solar.yaml
+++ b/tests/fake-multi-rs-solar.yaml
@ -12,14 +12,15 @@ wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password

-api:
-
 ota:
  platform: esphome

 logger:
  level: DEBUG

+api:
+  reboot_timeout: 0s
+
 uart:
  baud_rate: 19200
  tx_pin: ${tx_pin}
--- a/tests/fake-phoenix-inverter.yaml
+++ b/tests/fake-phoenix-inverter.yaml
@ -12,14 +12,15 @@ wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password

-api:
-
 ota:
  platform: esphome

 logger:
  level: DEBUG

+api:
+  reboot_timeout: 0s
+
 uart:
  baud_rate: 19200
  tx_pin: ${tx_pin}
--- a/tests/fake-smartsolar-mppt.yaml
+++ b/tests/fake-smartsolar-mppt.yaml
@ -12,14 +12,15 @@ wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password

-api:
-
 ota:
  platform: esphome

 logger:
  level: DEBUG

+api:
+  reboot_timeout: 0s
+
 uart:
  baud_rate: 19200
  tx_pin: ${tx_pin}