Skip to content

Commit a27634b

Browse files
authored
docs: build-for-one-install note, roadmap and refreshed screenshots (#17)
* docs: add build-for-one-install note, roadmap and phase table State upfront that Helios is built for one specific installation (hardware hardcoded) and is not plug-and-play; generalization is on the roadmap, not done. Add a small phase table to both READMEs and a ROADMAP.md with the four phases (1-2 done, 3 configurable hardware under HAOS, 4 multi-installation via API). * chore(assets): refresh screenshots to current UI (EN/ES) Regenerate hero/history/battery in English and Spanish, light and dark, at 2x (2880x1800) from the local dev server against HAOS and the dev DB. The UI moved on since the previous set (admin bar, accent picker, mobile). --------- Co-authored-by: gnacho <hnacho@proton.me>
1 parent dfcf38c commit a27634b

15 files changed

Lines changed: 64 additions & 0 deletions

‎README.es.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,14 @@ histórico, datos en vivo desde Home Assistant y el ahorro en euros
2424
calculado contra la tarifa eléctrica real. Un único servicio Node +
2525
SQLite corriendo en un LXC en casa. Sin nube.
2626

27+
> **Hecho a medida para una instalación.** Helios corre mi propia
28+
> configuración — dos inversores concretos y una batería — y esos datos
29+
> están hardcodeados. No es un monitor solar genérico "plug-and-play", y de
30+
> momento no tengo interés inmediato en hacerlo (la configurabilidad del
31+
> hardware está en la [hoja de ruta](#hoja-de-ruta), pero sin hacer). Es
32+
> poco probable que te sirva tal cual. Forkea el repo y adáptalo a tu
33+
> instalación.
34+
2735
## ¿Por qué existe?
2836

2937
Las apps de los fabricantes (Solis Cloud y similares):
@@ -135,6 +143,17 @@ Inversores (Solis/Fox) ──integraciones──▶ HAOS ──WebSocket──
135143
- Actualizar = desplegar el build nuevo y reiniciar el servicio; la BD y
136144
el `.env` (`/opt/helios/`) sobreviven siempre.
137145

146+
## Hoja de ruta
147+
148+
| Fase | Qué | Estado |
149+
|---|---|---|
150+
| 1 | Panel live de solo lectura (producción vs consumo) | Hecho |
151+
| 2 | Backend real, multiusuario, histórico, batería, alertas, PWA, endurecimiento | Hecho (~0.6.x) |
152+
| 3 | Inversores y placas configurables (siempre bajo HAOS) | Planificado |
153+
| 4 | Multi-instalación: varios HAOS o varios Helios vía API | En exploración |
154+
155+
Ver [ROADMAP.md](ROADMAP.md) para más detalle.
156+
138157
## Gracias enormes
139158

140159
Helios no existiría sin [Home Assistant](https://www.home-assistant.io/).

‎README.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,13 @@ from Home Assistant, and savings in euros computed against the real
2424
electricity tariff. One Node + SQLite service running in an LXC at home.
2525
No cloud.
2626

27+
> **Built for one install.** Helios runs my own setup — two specific
28+
> inverters and one battery — and those details are hardcoded. It is not a
29+
> generic, plug-and-play solar monitor, and I have no immediate plans to
30+
> make it one (configurable hardware is on the [roadmap](#roadmap), but not
31+
> done). It will probably not be useful to you as-is. Fork it and adapt it
32+
> to your own installation.
33+
2734
## Why does this exist?
2835

2936
The manufacturers' apps (Solis Cloud and friends):
@@ -135,6 +142,17 @@ Inverters (Solis/Fox) ──integrations──▶ HAOS ──WebSocket──▶
135142
- Update = deploy the new build and restart the service; the DB and the
136143
`.env` (`/opt/helios/`) always survive.
137144

145+
## Roadmap
146+
147+
| Phase | Focus | Status |
148+
|---|---|---|
149+
| 1 | Live read-only panel (production vs consumption) | Done |
150+
| 2 | Real backend, multi-user, history, battery, alerts, PWA, hardening | Done (~0.6.x) |
151+
| 3 | Configurable inverters and panels (still under HAOS) | Planned |
152+
| 4 | Multi-installation: several HAOS or several Helios via API | Exploring |
153+
154+
See [ROADMAP.md](ROADMAP.md) for detail.
155+
138156
## Big thanks
139157

140158
Helios wouldn't exist without [Home Assistant](https://www.home-assistant.io/).

‎ROADMAP.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Roadmap
2+
3+
This is a personal project. The roadmap reflects the direction I have in mind,
4+
not promises or dates. Phases 1 and 2 are done; 3 and 4 are ideas I want to
5+
explore.
6+
7+
| Phase | Focus | Status |
8+
|---|---|---|
9+
| 1 | Live read-only panel (production vs consumption) | Done |
10+
| 2 | Real backend, multi-user, history, battery, alerts, PWA, hardening | Done (~0.6.x) |
11+
| 3 | Configurable inverters and panels (still under HAOS) | Planned |
12+
| 4 | Multi-installation: several HAOS or several Helios via API | Exploring |
13+
14+
## Phase 3 — Configurable hardware, still under HAOS
15+
16+
Today the installation (inverters, panels, battery) and the HAOS sensor mapping
17+
are hardcoded for one setup. Phase 3 makes that configurable so another
18+
installation with a different number or model of inverters can run Helios
19+
without touching code. HAOS stays the source of truth for live data: Helios
20+
consumes, it does not talk to the inverters directly.
21+
22+
## Phase 4 — Multi-installation
23+
24+
One Helios instance watching a single installation is fine for one home. Phase 4
25+
explores monitoring several installations from one place: either one Helios
26+
talking to several HAOS instances, or several Helios instances exposing their
27+
data over an API and aggregating into a single view.

‎assets/hero-en-dark.png‎

-35.2 KB
Loading

‎assets/hero-en-light.png‎

-33.4 KB
Loading

‎assets/hero-es-dark.png‎

-33.6 KB
Loading

‎assets/hero-es-light.png‎

-35.2 KB
Loading
-20 KB
Loading
-19.9 KB
Loading
-18.4 KB
Loading

0 commit comments

Comments
 (0)