From f4d80a46090b7a1b04399e5aca345eb960307fb1 Mon Sep 17 00:00:00 2001 From: Sam Stenvall Date: Wed, 16 Nov 2022 23:21:15 +0200 Subject: [PATCH 1/2] Add known issues section and table of contents --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/README.md b/README.md index c61c799..e453ffe 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,25 @@ unit's computer board. The REST endpoints for enabling/disabling the various modes are designed to be consumed by https://www.home-assistant.io/integrations/switch.rest/ with minimal effort. See examples in the `docs/` directory. +## Table of contents + +* [Features](#features) +* [Requirements](#requirements) +* [Installation](#installation) + * [Running as a systemd service](#running-as-a-systemd-service) + * [Running as a Home Assistant OS addon](#running-as-a-home-assistant-os-addon) +* [Usage](#usage) +* [HTTP endpoints](#http-endpoints) + * [GET /summary](#get-summary) + * [GET /mode/{flag}](#get-modeflag) + * [GET /alarms](#get-alarms) + * [POST /mode/{flag}](#post-modeflag) + * [POST /setting/{setting}/{value}](#post-settingsettingvalue) +* [MQTT support](#mqtt-support) + * [Home Assistant MQTT discovery](#home-assistant-mqtt-discovery) +* [Known issues](#known-issues) +* [License](#license) + ## Features * HTTP API for reading temperatures, modes and settings, as well as changing some settings @@ -342,6 +361,23 @@ in Home Assistant automatically through the MQTT integration. The following enti ![](https://raw.githubusercontent.com/Jalle19/eda-modbus-bridge/master/docs/readme_ha3.png "Home Assistant sensors") ![](https://raw.githubusercontent.com/Jalle19/eda-modbus-bridge/master/docs/readme_ha4.png "Home Assistant configuration") +## Known issues + +* Some ventilation units sometimes trip the "TE20 Huoneilma kuuma" alarm when Modbus is used and a room temperature + sensor has not been connected to the main board. This can be alleviated by reducing the polling interval from 10 + seconds to something like 30 seconds, or fixed permanently by either connecting an NTC10 temperature sensor or a 10 + kiloohm resistor to the sensor input terminals (not tested, but confirmed by Enervent). + +* It is not possible to adjust the ventilation level when the unit is operating in normal mode. Enervent has confirmed + that this is a limitation in the protocol and there is no direct solution. A workaround is to repurpose one of the + modes, e.g. "long away", to be a "manual control" mode, since the ventilation level can be adjusted for all non- + normal modes of operation. A slight caveat with this is that the temperature target is also reduced, and the + temperature target reduction setting doesn't always seem to accept values below 2 degrees Celsius. Experiment with + these values to find something that suits your use case, or trust the built-in automation in the ventilation unit to + do its job. + ## License GNU GENERAL PUBLIC LICENSE 3.0 + +Some documentation under `docs/` is proprietary. From 23e69aded126573b632a941b67d2a46067198260 Mon Sep 17 00:00:00 2001 From: Sam Stenvall Date: Wed, 16 Nov 2022 23:26:44 +0200 Subject: [PATCH 2/2] Add credits section --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index e453ffe..f1be9dc 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,7 @@ https://www.home-assistant.io/integrations/switch.rest/ with minimal effort. See * [Home Assistant MQTT discovery](#home-assistant-mqtt-discovery) * [Known issues](#known-issues) * [License](#license) +* [Credits](#credits) ## Features @@ -381,3 +382,8 @@ in Home Assistant automatically through the MQTT integration. The following enti GNU GENERAL PUBLIC LICENSE 3.0 Some documentation under `docs/` is proprietary. + +## Credits + +Credits to Jaakko Ala-Paavola for creating https://web.archive.org/web/20201020102005/http://ala-paavola.fi/jaakko/doku.php?id=pingvin +and self-hosting a copy of the relatively hard to find EDA modbus register PDF document.