Skip to content

Commit e92c01a

Browse files
committed
write intro
1 parent 2afddef commit e92c01a

File tree

1 file changed

+34
-19
lines changed

1 file changed

+34
-19
lines changed

docs/tutorial/intro.md

Lines changed: 34 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,34 +5,49 @@ title: Welcome
55

66
# Local Control for Emporia Vue
77

8-
Brief explanation of what this project does (Local control for Emporia Vue).
8+
The Emporia Vue is an excellent piece of hardware for measuring your home's electrical consumption.
9+
Critically, it has a UL listing that proves that it has been designed and tested to be safe,
10+
something many hobbyist solutions lack.
11+
12+
The goal of this project, and this guide, is to help you get (unofficial) Open Source firmware
13+
running on your Emporia Vue so that you can control it locally from
14+
[Home Assistant](https://www.home-assistant.io/). This gets you
15+
16+
- faster update times
17+
- fully offline function, with no internet requirement
18+
- the ability to automate your home based on your power consumption, to, for example, handle time-of-use billing
19+
20+
It is an unofficial project, so you should not expect any support from Emporia on your flashed hardware.
921

10-
## ⚠️ SAFETY WARNING ⚠️
1122
:::danger
12-
**Working with mains electricity is dangerous.**
13-
Large, bold warning about working with mains electricity.
23+
24+
**Working with mains electricity is dangerous**
25+
26+
You should not attempt flashing the board while it is connected to mains electricity, for both your and your computer's safety.
27+
28+
Electrical panel work should only be done by a qualified person.
29+
1430
:::
1531

1632
## Supported Hardware
17-
Clearly state support for Vue 2 and Vue 3.
18-
* [Vue 3 Specific Guide](1-hardware-prep.md)
33+
34+
This project supports both the Emporia Vue 2 and the Emporia Vue 3.
1935

2036
## Prerequisites (Bill of Materials)
2137

2238
### Hardware list
23-
* USB UART
24-
* Jumper wires
25-
* Headers
26-
* Soldering iron
2739

28-
### Software list
29-
* ESPHome
30-
* esptool
31-
* drivers
40+
- Emporia Vue, either v2 or v3
41+
- USB to serial converter module
42+
- I tested this with a cheap & generic CH340G adapter
43+
- 4 male-to-female jumper wires
44+
- 4 male pcb-mount headers
45+
- Soldering iron & accessories
46+
- [some recommendations here][soldering-iron]
3247

33-
## Quick Links / Navigation
48+
[soldering-iron]: https://web.archive.org/web/20250803172237/https://old.reddit.com/r/AskElectronics/wiki/soldering
49+
50+
### Software list
3451

35-
* [Hardware Preparation](1-hardware-prep.md) - Guide the user through the physical modification of the device and the electrical panel work.
36-
* [Flashing](2-flashing.md) - The software installation process.
37-
* [Configuration](3-configuration.md) - Explaining the YAML.
38-
* [Integrations](4-integrations.md) - What to do after the device is running.
52+
- [esptool.py](https://github.com/espressif/esptool) ([windows instructions](https://cyberblogspot.com/how-to-install-esptool-on-windows-10/), [generic instructions](https://docs.espressif.com/projects/esptool/en/latest/esp32/installation.html))
53+
- Working ESPHome installation [(see "Getting started")](https://esphome.io/)

0 commit comments

Comments
 (0)