Skip to content

Commit

Permalink
update readme and configs
Browse files Browse the repository at this point in the history
  • Loading branch information
dentra committed May 15, 2024
1 parent 3244e81 commit 086e6ab
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 26 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,9 @@ At this moment the componet is build using climate platform and allows the follo
## Build ESPHome firmware

Sample configuration (available for [download](ewh.yaml)):
You can download and use example configurations for [EWH](ewh.yaml) and [BWH](bwh.yaml) for ZWH try EWH or BWH instead.

Sample configuration:

```yaml
substitutions:
Expand All @@ -71,8 +73,8 @@ substitutions:
# version of ewh
project_version: "master"
# UART configuration.
tx_pin: TX # use 19 for Lilygo T-Dongle S3
rx_pin: RX # use 20 for Lilygo T-Dongle S3
tx_pin: GPIO19 # use TX for iot-uni-dongle or coolrf-heatstick
rx_pin: GPIO20 # use RX for iot-uni-dongle or coolrf-heatstick

# please do not change packeages order it is very important, just comment/uncomment
packages:
Expand All @@ -96,8 +98,8 @@ packages:
# - packages/cloud.yaml
# Required package, do not comment
- packages/base.yaml
# Required package, replace with esp8266.yaml if you use ESP8266
- packages/esp32.yaml
# Required package, replace with esp32.yaml/esp8266.yaml if you use ESP32/ESP8266
- packages/esp32_s3.yaml
```
## Expiremental cloud support
Expand Down
10 changes: 3 additions & 7 deletions bwh.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ substitutions:
wifi_password: !secret wifi_password
# password for fallback wifi hotspot
wifi_ap_password: !secret wifi_ap_password
# UART configuration.
tx_pin: 19 # use TX for iot-uni-dongle or coolrf-heatstick
rx_pin: 20 # use RX for iot-uni-dongle or coolrf-heatstick
# UART configuration. Somtimes may need to swap tx/rx.
tx_pin: GPIO19 # use TX for iot-uni-dongle or coolrf-heatstick
rx_pin: GPIO20 # use RX for iot-uni-dongle or coolrf-heatstick

# please do not change packeages order it is very important, just comment/uncomment
packages:
Expand Down Expand Up @@ -52,10 +52,6 @@ wifi:
ssid: $wifi_ssid
password: $wifi_password

logger:
# Make sure logging is not using the serial port
baud_rate: 0

uart:
tx_pin: $tx_pin
rx_pin: $rx_pin
Expand Down
4 changes: 0 additions & 4 deletions ets.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,6 @@ wifi:
ssid: $wifi_ssid
password: $wifi_password

logger:
# Make sure logging is not using the serial port
baud_rate: 0

# Configure hardware serial port
uart:
tx_pin: TX
Expand Down
14 changes: 5 additions & 9 deletions ewh.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ substitutions:
# password for fallback wifi hotspot
wifi_ap_password: !secret wifi_ap_password
# UART configuration.
tx_pin: 19 # use TX for iot-uni-dongle or coolrf-heatstick
rx_pin: 20 # use RX for iot-uni-dongle or coolrf-heatstick
tx_pin: GPIO19 # use TX for iot-uni-dongle or coolrf-heatstick
rx_pin: GPIO20 # use RX for iot-uni-dongle or coolrf-heatstick

# please do not change packeages order it is very important, just comment/uncomment
packages:
Expand All @@ -38,10 +38,10 @@ packages:
# - packages/ewh_web.yaml
## optional package, uncomment next line to enable experimental cloud support
# - packages/cloud.yaml
# Required package, do not comment
# Required package, do not comment move or remove
- packages/base.yaml
# Required package, replace with esp8266.yaml if you use ESP8266
- packages/esp32.yaml
# Required package, replace with esp32.yaml/esp8266.yaml if you use ESP32/ESP8266
- packages/esp32_s3.yaml

time:
platform: sntp
Expand All @@ -61,10 +61,6 @@ wifi:
ssid: $wifi_ssid
password: $wifi_password

logger:
# Make sure logging is not using the serial port
baud_rate: 0

uart:
tx_pin: $tx_pin
rx_pin: $rx_pin
Expand Down
4 changes: 3 additions & 1 deletion packages/base.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ substitutions:
# project source refresh interval
project_source_refresh: 12h
# project idenitfier
project_id: rka
project_id: ewh
# node name
node_name: $project_id
# name for main entity and prefix for all others.
Expand Down Expand Up @@ -37,6 +37,8 @@ captive_portal:

ota:
logger:
# Make sure logging is not using the serial port
baud_rate: 0

external_components:
- source: github://dentra/[email protected]
Expand Down

0 comments on commit 086e6ab

Please sign in to comment.