mirror/esphome-emporia-vue-utility
1
0
Fork 0
mirror of https://github.com/nekorevend/esphome-emporia-vue-utility.git synced 2026-01-10 05:10:40 -07:00
Code Issues Packages Projects Releases Wiki Activity

Documentation fixes, and a few changes. (#11)

Browse Source
This commit is contained in:
pixelgrb
2025-10-04 09:42:11 -07:00
committed by GitHub
parent 0ec0d49b83
commit dd177d5a6f
6 changed files with 36 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/installing_esphome.md
View File

@@ -2,7 +2,7 @@
## Introduction
If this is your time to [ESPHome](https://esphome.io/), the terminology can be confusing. You may hear “flash ESPHome on your device”, but that’s not a totally accurate statement.
If this is your first time to [ESPHome](https://esphome.io/), the terminology can be confusing. You may hear "flash ESPHome on your device", but that’s not a totally accurate statement.
ESPHome is a **framework and toolchain** for creating custom firmware. This usually involves:
- Writing a short YAML configuration file, and optionally providing custom code.
@@ -21,7 +21,7 @@ There are multiple ways to do this and much of the documentation out there is di
You will interact with two distinct parts of ESPHome:
1. **ESPHome** — this is software you will use this to back up the stock firmware, compile this project, and flash the Vue. There are two main ways to do this, with some caveats.
2. **ESPHome integration** — you only need to install the [ESPHome Integration](https://www.home-assistant.io/integrations/esphome) in Home Assistant. It is quite magical. Once the Vue is flashed and running on Wi-Fi, it will auto-discover it and create the sensor entities automatically.
2. **ESPHome Integration** — you only need to install the [ESPHome Integration](https://www.home-assistant.io/integrations/esphome) in Home Assistant. It is quite magical. Once the Vue is flashed and running on Wi-Fi, it will auto-discover it and create the sensor entities automatically.
### How ESPHome works
@@ -46,7 +46,7 @@ This gives you a CLI (command-line interface) to run ESPHome. You run this in t
- Better for developers: quick iteration, local editing of YAML/Python/C++.
- Flexible: you can use local custom code without publishing to GitHub.
- Full control over build logs, debugging, and advanced options.
- You **can** backup the original firmware with this.
- You **can backup the original firmware** with this.
#### 2. ESPHome Device Builder --- [install guide](https://esphome.io/guides/getting_started_hassio/#installing-esphome-device-builder)
@@ -56,13 +56,13 @@ This is a Home Assistant add-on. It is basically a UI wrapper for the ESPHome C
- Runs inside Home Assistant (web UI).
- Better for end users: simpler UI.
- Initial flashing still happens on your PC. It works using WebSerial (via a browser).
- You **cannot** use this to backup the original firmware.
- You **cannot use this to backup the original firmware**.
### What is best for you?
- If you are adamant about [backing up the original Vue firmware](backup_firmware.md), minimally install the CLI just to get the backup step done. You can use either the CLI or the Device Builder to program and flash, and you can switch between them as well.
- If you are adamant about [backing up the original Vue firmware](backup_firmware.md), minimally install the CLI just to get the backup step done. You can use either the CLI or the Device Builder to program and flash, and you can switch between them at any time as well.
- If you like working from the command line and want full control, the ESPHome CLI is straightforward: you write YAML by hand, build, and flash. It’s lean, reproducible, and great if you’re already comfortable with terminals.
- If you like working from the command line and want full control, the ESPHome CLI is straightforward: you write YAML in a text file, build, and flash. It’s lean, reproducible, and great if you’re already comfortable with terminals.
- The Device Builder adds a friendlier interface. It’s easier for beginners, integrates neatly with Home Assistant, and makes troubleshooting or rebuilding devices more point-and-click.