Create sample YAMLs that use the external component and update README.

This commit is contained in:
Victor Chang
2024-06-09 15:36:17 -07:00
parent fc6676e197
commit 678a56ab03
3 changed files with 310 additions and 3 deletions

View File

@@ -4,8 +4,19 @@ This is an unauthorized and unoffical firmware for the Emporia View Utility Conn
## Disclaimer
This software is of generally poor quality and should not be used by anyone. When you install the software on your device, it
will no longer report data to Emporia. You should backup the original Emporia firmware before installing this.
There is no guarantee of quality. When you install the software on your device, it will no longer report data to Emporia. You should backup the original Emporia firmware before installing this.
## Backup the original firmware
Determine which COM device your USB to serial adapter is and use it in the below command(s). Typically a single digit number. (e.g. `COM3`)
Backup:
`.\esptool --port COM# --chip esp32 -b 115200 read_flash 0x0 0x400000 .\vueUtilityConnect_stock.bin`
Restore:
`.\esptool --port COM# --chip esp32 -b 115200 write_flash --flash_freq 80m 0x0 .\vueUtilityConnect_stock.bin`
## Installation
@@ -26,7 +37,7 @@ a portable USB battery pack works well for this.
Instead of connecting IO0 and EN, you can simply short IO0 to ground while connecting power to get the device into bootloader mode.
Download `emporia_vue_utility.h` and either `vue-utility.yaml` or `vue-utility-solar.yaml`. Edit the YAML and modify to your liking.
Use either YAML file in the `example_yaml` directory and modify it to your liking.
Execute `esphome run vue-utility.yaml` or `esphome run vue-utility-solar.yaml` to build and install.
@@ -36,3 +47,7 @@ There are three LEDs on the device, which have "power", "wifi" and "link" icons
* **Power** = An ESPHome status led. Slowly flashing means warning, quickly flashing means error, solid on means OK. See [status_led](https://esphome.io/components/status_led.html) docs.
* **Wifi** = Normally solid on, will briefly flash each time a meter rejoin is attempted which indicates poor signal from the meter.
* **Link** = Flashes off briefly about once every 5 seconds. More specifically, the LED turns off when a reading from the meter is requested and turns back on when a response is received. If no response is received then the LED will remain off. If this LED is never turning on then no readings are being returned by the meter.
## More Details
Check out the `docs` directory for technical details!