Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yoziru/esphome-zehnder-comfoair
Interact with Zehnder Comfoair Q using ESPHome and Home Assistant
https://github.com/yoziru/esphome-zehnder-comfoair
comfoair comfoairq esp32 esphome home-assistant home-automation homeassistant iot zehnder
Last synced: 2 months ago
JSON representation
Interact with Zehnder Comfoair Q using ESPHome and Home Assistant
- Host: GitHub
- URL: https://github.com/yoziru/esphome-zehnder-comfoair
- Owner: yoziru
- License: gpl-3.0
- Created: 2023-05-02T18:38:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-19T21:02:01.000Z (8 months ago)
- Last Synced: 2024-05-20T10:22:44.552Z (8 months ago)
- Topics: comfoair, comfoairq, esp32, esphome, home-assistant, home-automation, homeassistant, iot, zehnder
- Language: C++
- Homepage: https://yoziru.github.io/esphome-zehnder-comfoair/
- Size: 6.33 MB
- Stars: 13
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Zehnder Comfoair Q ESPHome
This project lets you use an ESP32 device with a CAN interface to interact with the Zehnder ComfoAir Q ventilation unit. Tested with:
- [Olimex ESP32-EVB-EA-IND](docs/esp32-evb.md) using its internal CAN bus component + separate power supply
- [M5Stack AtomS3 Lite](docs/m5stack-atoms3.md) with Mini CAN Unit (TJA1051T/3) feeding off the 12V supply of the ventilation unit
It exposes all known information and airflow control through the [ESPHome native API](https://esphome.io/components/api.html), and allows you to integrate the unit in Home Assistant as depicted below:
You can find the configuration YAML files in the `docs` folder.
Untested but might also work on an ESP8266 with an MCP2551 (untested).
Needs at least ESPHome 2022.5.0 (since it depends on some CAN bus component updates).
## Hardware
See specific guides for each device:
- [Olimex ESP32-EVB](docs/esp32-evb.md)
- [M5Stack AtomS3 Lite](docs/m5stack-atoms3.md)
- Example ESP32 alternative (see [diagram](https://github.com/mat3u/comfoair-esp32/tree/hacomfoairmqtt-compatibility#connections-diagram))
## Software
1. Copy and rename `secrets.yaml.example` to `secrets.yaml` and update it with your WiFi credentials (`wifi_ssid` and `wifi_password`).
2. Build the image with [ESPHome](https://esphome.io/guides/getting_started_command_line.html)
```sh
make compile
```
3. Upload/flash the firmware to the board.
```sh
make upload
```
> By default the project builds for the AtomS3 board. To change your board, you can specify the `BOARD` parameter. For example for the Olimex ESP32-EVB:
>```sh
>make compile BOARD=esp32-evb
>make upload BOARD=esp32-evb
>```
Now when you go to the Home Assistant “Integrations” screen (under “Configuration” panel), you should see the ESPHome device show up in the discovered section (although this can take up to 5 minutes). Alternatively, you can manually add the device by clicking “CONFIGURE” on the ESPHome integration and entering “.local” as the host.
Optional: for the ventilation card with the arrows, see [`docs/home-assistant/example-picture-elements-card.yaml`](docs/home-assistant/example-picture-elements-card.yaml)
## Credits
Based on the original repo: https://github.com/felixstorm/esphome-custom-components
Inspired by
- https://github.com/vekexasia/comfoair-esp32
- https://github.com/michaelarnauts/aiocomfoconnect
- [https://github.com/mat3u/comfoair-esp32](https://github.com/mat3u/comfoair-esp32/tree/hacomfoairmqtt-compatibility)
- [https://github.com/hcouplet/comfoair-esp32](https://github.com/hcouplet/comfoair-esp32/tree/hacomfoairmqtt-compatibility)
A lot of this repo was inspired by the reverse engineering [here](https://github.com/marco-hoyer/zcan/issues/1).
- [ComfoControl Protocol](https://github.com/michaelarnauts/aiocomfoconnect/blob/master/docs/PROTOCOL.md)
- [RMI PROTOCOL](https://github.com/michaelarnauts/aiocomfoconnect/blob/master/docs/PROTOCOL-RMI.md)
- [PDO PROTOCOL](https://github.com/michaelarnauts/aiocomfoconnect/blob/master/docs/PROTOCOL-PDO.md)