chore: update readme

This commit is contained in:
Yurii
2024-12-07 22:47:24 +03:00
committed by GitHub
parent 7efcbaa57e
commit 2fe546812c

View File

@@ -1,13 +1,16 @@
<div align="center"> <div align="center">
![logo](/assets/logo.svg)
<br>
[![GitHub version](https://img.shields.io/github/release/Laxilef/OTGateway.svg?include_prereleases)](https://github.com/Laxilef/OTGateway/releases) [![GitHub version](https://img.shields.io/github/release/Laxilef/OTGateway.svg?include_prereleases)](https://github.com/Laxilef/OTGateway/releases)
[![GitHub download](https://img.shields.io/github/downloads/Laxilef/OTGateway/total.svg)](https://github.com/Laxilef/OTGateway/releases/latest) [![GitHub download](https://img.shields.io/github/downloads/Laxilef/OTGateway/total.svg)](https://github.com/Laxilef/OTGateway/releases/latest)
[![License](https://img.shields.io/github/license/Laxilef/OTGateway.svg)](LICENSE.txt) [![License](https://img.shields.io/github/license/Laxilef/OTGateway.svg)](LICENSE.txt)
[![Telegram](https://img.shields.io/badge/Telegram-Channel-33A8E3)](https://t.me/otgateway) [![Telegram](https://img.shields.io/badge/Telegram-Channel-33A8E3)](https://t.me/otgateway)
</div> </div>
<hr />
![Dashboard](https://github.com/user-attachments/assets/07909700-5abb-4058-843b-f693b62799d5)
![Configuration](https://github.com/user-attachments/assets/c48a0790-ac6e-4264-b8f0-e7dcd776e9db)
![Integration with HomeAssistant](https://github.com/user-attachments/assets/505f8eee-e899-4740-888e-0366edd40a10)
## Features ## Features
- Hot water temperature control - Hot water temperature control
@@ -15,26 +18,27 @@
- Smart heating temperature control modes: - Smart heating temperature control modes:
- PID - PID
- Equithermic curves - adjusts the temperature based on indoor and outdoor temperatures - Equithermic curves - adjusts the temperature based on indoor and outdoor temperatures
- Hysteresis setting (for accurate maintenance of room temperature) - Hysteresis setting _(for accurate maintenance of room temperature)_
- Ability to connect an external sensors to monitor outdoor and indoor temperature ([compatible sensors](https://github.com/Laxilef/OTGateway/wiki/Compatibility#temperature-sensors)) - Ability to connect [additional (external) sensors](https://github.com/Laxilef/OTGateway/wiki/Compatibility#temperature-sensors): Dallas (1-wire), NTC 10k, Bluetooth (BLE). Makes it possible to monitor indoor and outdoor temperatures, temperatures on pipes/heat exchangers/etc.
- Emergency mode. If the Wi-Fi connection is lost or the gateway cannot connect to the MQTT server, the mode will turn on. This mode will automatically maintain the set temperature and prevent your home from freezing. In this mode it is also possible to use equithermal curves (weather-compensated control). - Emergency mode. In any dangerous situation _(loss of connection with Wifi, MQTT, sensors, etc)_ it will not let you and your home freeze.
- Automatic error reset (not with all boilers) - Ability of remote fault reset _(not with all boilers)_
- Diagnostics: - Diagnostics:
- The process of heating: works/does not work - Displaying gateway status
- The process of heating water for hot water: working/not working - Displaying the connection status to the boiler via OpenTherm
- Display of boiler errors - Displaying the fault status and fault code
- Burner status (flame): on/off - Displaying the diagnostic status & diagnostic code
- Burner modulation level in percent - Display of the process of heating: works/does not work
- Pressure in the heating system - Display of burner (flame) status: on/off
- Gateway status (depending on errors and connection status) - Display of burner modulation level in percent
- Boiler connection status via OpenTherm interface - Display of pressure in the heating system
- The current temperature of the heat carrier (usually the return heat carrier) - Display of current temperature of the heat carrier
- Set heat carrier temperature (depending on the selected mode) - Display of return temperature of the heat carrier
- Current hot water temperature - Display of setpoint heat carrier temperature (useful when using PID or Equitherm)
- Display of the process of DHW: working/not working
- Display of current hot water temperature
- _And other information..._
- [Home Assistant](https://www.home-assistant.io/) integration via MQTT. The ability to create any automation for the boiler! - [Home Assistant](https://www.home-assistant.io/) integration via MQTT. The ability to create any automation for the boiler!
![logo](/assets/ha.png)
## Documentation ## Documentation
All available information and instructions can be found in the wiki: All available information and instructions can be found in the wiki:
@@ -52,6 +56,7 @@ All available information and instructions can be found in the wiki:
* [Ratios](https://github.com/Laxilef/OTGateway/wiki#ratios) * [Ratios](https://github.com/Laxilef/OTGateway/wiki#ratios)
* [Fit coefficients](https://github.com/Laxilef/OTGateway/wiki#fit-coefficients) * [Fit coefficients](https://github.com/Laxilef/OTGateway/wiki#fit-coefficients)
* [PID mode](https://github.com/Laxilef/OTGateway/wiki#pid-mode) * [PID mode](https://github.com/Laxilef/OTGateway/wiki#pid-mode)
* [Logs and debug](https://github.com/Laxilef/OTGateway/wiki#logs-and-debug)
* [Compatibility](https://github.com/Laxilef/OTGateway/wiki/Compatibility) * [Compatibility](https://github.com/Laxilef/OTGateway/wiki/Compatibility)
* [Boilers](https://github.com/Laxilef/OTGateway/wiki/Compatibility#boilers) * [Boilers](https://github.com/Laxilef/OTGateway/wiki/Compatibility#boilers)
* [Boards](https://github.com/Laxilef/OTGateway/wiki/Compatibility#boards) * [Boards](https://github.com/Laxilef/OTGateway/wiki/Compatibility#boards)
@@ -64,24 +69,5 @@ All available information and instructions can be found in the wiki:
* [Connection](https://github.com/Laxilef/OTGateway/wiki/OT-adapters#connection) * [Connection](https://github.com/Laxilef/OTGateway/wiki/OT-adapters#connection)
* [Leds on board](https://github.com/Laxilef/OTGateway/wiki/OT-adapters#leds-on-board) * [Leds on board](https://github.com/Laxilef/OTGateway/wiki/OT-adapters#leds-on-board)
## Dependencies
- [ESP8266Scheduler](https://github.com/nrwiersma/ESP8266Scheduler) (for ESP8266)
- [ESP32Scheduler](https://github.com/laxilef/ESP32Scheduler) (for ESP32)
- [ArduinoJson](https://github.com/bblanchon/ArduinoJson)
- [OpenTherm Library](https://github.com/ihormelnyk/opentherm_library)
- [ArduinoMqttClient](https://github.com/arduino-libraries/ArduinoMqttClient)
- [ESPTelnet](https://github.com/LennartHennigs/ESPTelnet)
- [FileData](https://github.com/GyverLibs/FileData)
- [GyverPID](https://github.com/GyverLibs/GyverPID)
- [GyverBlinker](https://github.com/GyverLibs/GyverBlinker)
- [DallasTemperature](https://github.com/milesburton/Arduino-Temperature-Control-Library)
- [TinyLogger](https://github.com/laxilef/TinyLogger)
## Debug
To display DEBUG messages you must enable debug in settings (switch is disabled by default).
You can connect via Telnet to read messages. IP: ESP8266 ip, port: 23
___ ___
This project is tested with BrowserStack. This project is tested with BrowserStack.