Files
gree-controller-ha-addon/gree-controller/README.md
T
2026-09-09 15:05:22 +02:00

36 lines
1.5 KiB
Markdown

# GREE Controller
Local GREE HVAC controller packaged as a Home Assistant add-on. It uses `host_network: true` so UDP discovery and the host VLAN/ethernet interfaces are directly available to the controller. Persistent data is stored in `/data/gree-controller.db` and is included in Home Assistant backups.
## PL - topologia HA / VLAN / GREE
![Topologia Home Assistant OS + GREE Controller + VLAN](./topologia-ha-vlan-gree-pl.png)
Najważniejsze:
- VLAN-y konfigurujesz na hoście Home Assistant OS,
- dodatek współdzieli interfejsy hosta przez `host_network`,
- nie trzeba tworzyć Docker `macvlan`,
- przy wielu bezpośrednio podłączonych podsieciach `gree_interface` może pozostać puste,
- discovery UDP broadcast wykonuj osobno dla każdego VLAN-u/podsieci.
Pełna dokumentacja: [DOCS.pl.md](./DOCS.pl.md).
## EN - HA / VLAN / GREE topology
![Home Assistant OS + GREE Controller + VLAN topology](./topology-ha-vlan-gree-en.png)
Key points:
- configure VLANs on the Home Assistant OS host,
- the add-on shares host interfaces via `host_network`,
- Docker `macvlan` is not required,
- with multiple directly attached subnets `gree_interface` may be left empty,
- run UDP broadcast discovery separately for each VLAN/subnet.
Full documentation: [DOCS.md](./DOCS.md).
## Versioning
The project version is maintained only in the root `Cargo.toml`. The build script copies it into the Home Assistant `config.yaml` and publishes one `amd64 + aarch64` OCI manifest under that version. No separate architecture release tags are used.