Skip to content

Commit

Permalink
new ru readme and samples
Browse files Browse the repository at this point in the history
  • Loading branch information
dentra committed Jul 22, 2022
1 parent 3de84b1 commit 6ac66f6
Show file tree
Hide file tree
Showing 6 changed files with 486 additions and 102 deletions.
168 changes: 68 additions & 100 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,129 +1,97 @@
[![Version][version-shield]][version]
[![License][license-shield]][license]
[![ESPHome release][esphome-release-shield]][esphome-release]
[![Open in Visual Studio Code][open-in-vscode-shield]][open-in-vscode]
[![Telegram][telegram-shield]][telegram]
[![Support author][donate-me-shield]][donate-me]
[![PayPal.Me][paypal-me-shield]][paypal-me]

[open-in-vscode-shield]: https://open.vscode.dev/badges/open-in-vscode.svg
[open-in-vscode]: https://open.vscode.dev/dentra/esphome-components
[version-shield]: https://img.shields.io/static/v1?label=Version&message=2022.7.0&color=green
[version]: https://github.com/dentra/esphome-tion/releases/

[paypal-me-shield]: https://img.shields.io/static/v1.svg?label=%20&message=PayPal.Me&logo=paypal
[license-shield]: https://img.shields.io/static/v1?label=License&message=MIT&color=orange&logo=license
[license]: https://opensource.org/licenses/MIT

[esphome-release-shield]: https://img.shields.io/static/v1?label=ESPHome&message=2022.6&color=green&logo=esphome
[esphome-release]: https://github.com/esphome/esphome/releases/

[open-in-vscode-shield]: https://img.shields.io/static/v1?label=+&message=Open+in+VSCode&color=blue&logo=visualstudiocode
[open-in-vscode]: https://open.vscode.dev/dentra/esphome-tion

[telegram-shield]: https://img.shields.io/static/v1?label=+&message=Telegram&logo=telegram
[telegram]: https://t.me/esphome_tion

[donate-me-shield]: https://img.shields.io/static/v1?label=+&message=Donate
[donate-me]: https://www.tinkoff.ru/cf/3dZPaLYDBAI

[paypal-me-shield]: https://img.shields.io/static/v1?label=+&message=PayPal.Me&logo=paypal
[paypal-me]: https://paypal.me/dentra0

# Tion

This is a ESPHome component to control `Tion 4s` and `Tion Lite` Breezers from ESP32 via BLE protocol.
Версия на русском языке доступна [здесь](README_ru.md).

This is a ESPHome component to control `Tion 4S`, `Tion Lite` and `Tion 3S` Breezers from ESP32 via BLE protocol.

At this moment the componet is build using climate platform and allows to control:

* On/Off
* Heater On/Off
* Target temperature
* Fan speed
* Buzzer
* Led
* Inflow/Recirculation (4s Only)
* Boost Mode (4s Only)
* Boost Time (4s Only)
* Led (4S and Lite only)
* Inflow/Recirculation (4S only)
* Inflow/Recirculation/Mixed (3S only)
* Presets
* Boost preset time

And additionaly monitor:

* Temperature inside
* Temperature outside
* Heater power
* Filter days left
* Filter warnout state
* Airflow counter
* Heater power (4S and Lite only)
* Filter time left
* Filter warnout state (4S and Lite only)
* Boost time left
* Airflow counter (4S and Lite only)
* Current productivity (3S only)
* Version

## Firmware

You can find sample configuration files for [Tion 4S](tion-4s.yaml), [Tion Lite](tion-lt.yaml) and [Tion 3S](tion-3s.yaml) (they are self-descriptive).

* Download the necessary configuration for your breezer
* Modify `substitutions` section for your preferred values
* Change the set of packages to your needs
* Place the modified file in the ESPHome config directory
* Run the build and firmware upload of your configuration
* Add the device that appears to the Home Assistant

## Usage
> Everything that you do, you do at your own risk
### Sample configuration for Tion 4s
```yaml
external_components:
- source: github://dentra/[email protected]

ota:
on_begin:
then:
- lambda: id(ble_client_tion).set_enabled(false);

esp32_ble_tracker:

ble_client:
- mac_address: $mac_tion
id: ble_client_tion

climate:
- platform: tion_4s
ble_client_id: ble_client_tion
name: "$name"
buzzer:
name: "$name Buzzer"
led:
name: "$name Led"
recirculation:
name: "$name Recirculation"
temp_in:
name: "$name Temp in"
temp_out:
name: "$name Temp out"
heater_power:
name: "$name Heater power"
airflow_counter:
name: "$name Airflow counter"
filter_days_left:
name: "$name Filter Days Left"
filter_warnout:
name: "$name Filter Warnout"
boost_time:
name: "$name Boost Time"
version:
name: "$name Version"
update_interval: 60s
```
### Sample configuration for Tion Lite
```yaml
external_components:
- source: github://dentra/[email protected]

ota:
on_begin:
then:
- lambda: id(ble_client_tion).set_enabled(false);

esp32_ble_tracker:

ble_client:
- mac_address: $mac_tion
id: ble_client_tion

climate:
- platform: tion_lt
ble_client_id: ble_client_tion
name: "$name"
buzzer:
name: "$name Buzzer"
led:
name: "$name Led"
temp_in:
name: "$name Temp in"
temp_out:
name: "$name Temp out"
heater_power:
name: "$name Heater power"
airflow_counter:
name: "$name Airflow counter"
filter_days_left:
name: "$name Filter Days Left"
filter_warnout:
name: "$name Filter Warnout"
version:
name: "$name Version"
update_interval: 60s
```
After flashing firmware and before first run you need to enter your Breezer into the pairing mode (please follow the manual) and only then start ESP.

Additionally for `Tion 3S` you need to push `Pair` button.

>
> ### **WARNING: Everything that you do, you do at your own risk!**
>
## Roadmap

* Reset filters support.
* Support connection via hardware UART.

## Issue reporting

Feel free to open issues for bug reporting and feature requests. Will accept English and Russian language.

## Your thanks
If this project was useful to you, you can [buy me](https://paypal.me/dentra0) a Cup of coffee :)

If this project was useful to you or you want to support its further development you can always leave your thanks
via [Card2Card](https://www.tinkoff.ru/cf/3dZPaLYDBAI ) or [PayPal](https://paypal.me/dentra0 ).

## Commercial use

For questions of commercial use or custom development/improvement, please contact me by mail dennis.trachuk at gmail.com
100 changes: 100 additions & 0 deletions README_ru.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
[![Version][version-shield]][version]
[![License][license-shield]][license]
[![ESPHome release][esphome-release-shield]][esphome-release]
[![Open in Visual Studio Code][open-in-vscode-shield]][open-in-vscode]
[![Telegram][telegram-shield]][telegram]
[![Support author][donate-me-shield]][donate-me]
[![PayPal.Me][paypal-me-shield]][paypal-me]

[version-shield]: https://img.shields.io/static/v1?label=Version&message=2022.7.0&color=green
[version]: https://github.com/dentra/esphome-tion/releases/

[license-shield]: https://img.shields.io/static/v1?label=License&message=MIT&color=orange&logo=license
[license]: https://opensource.org/licenses/MIT

[esphome-release-shield]: https://img.shields.io/static/v1?label=ESPHome&message=2022.6&color=green&logo=esphome
[esphome-release]: https://github.com/esphome/esphome/releases/

[open-in-vscode-shield]: https://img.shields.io/static/v1?label=+&message=Open+in+VSCode&color=blue&logo=visualstudiocode
[open-in-vscode]: https://open.vscode.dev/dentra/esphome-tion

[telegram-shield]: https://img.shields.io/static/v1?label=+&message=Telegram&logo=telegram
[telegram]: https://t.me/esphome_tion

[donate-me-shield]: https://img.shields.io/static/v1?label=+&message=Donate
[donate-me]: https://www.tinkoff.ru/cf/3dZPaLYDBAI

[paypal-me-shield]: https://img.shields.io/static/v1?label=+&message=PayPal.Me&logo=paypal
[paypal-me]: https://paypal.me/dentra0

# Tion

English version of this page is available [here](README.md).

Компонет ESPHome для управления бризерами `Tion 4S`, `Tion Lite` и `Tion 3S` с помощью ESP32 через BLE протокол.

На текущий момент компонент построен на платформе `climate` и позволяет контролировать:

* Включение/Выключение
* Включение/Выключение обогрева
* Выставление целевой температуры нагрева
* Установка скорости притока воздуха
* Управление звуковыми оповещениями
* Управление световымы оповещениями (только для 4S и Lite)
* Переключение режима приток/рециркуляция (только для 4S)
* Переключение режима приток/рециркуляция/смешанный (только для 3S)
* Поддержка пресетов
* Настройка времени пресета `Турбо`

Дополнительно осуществляется мониториг следующих показателей:

* Температура снаружи
* Температура внутри
* Текущая потребяемая мощность нагревателя (только для 4S и Lite)
* Оставшееся время жизни фильтров
* Индикация о требущейся замене/очистке фильтра (только для 4S и Lite)
* Оставшееся время работы режима `Турбо`
* Счетчик прошедшего воздуха (только для 4S и Lite)
* Текущая производительностью бризера (только для 3S)
* Версия програмного обеспечения бризера

## Прошивка

Вы можете загрузить и использовать примеры конфигурации для [Tion 4S](tion-4s.yaml), [Tion Lite](tion-lt.yaml) и [Tion 3S](tion-3s.yaml), все файлы с подробным описанием (на английском)

* Скачайте конфигурацию соотствующую модели вашего бризера
* Измените секцию `substitutions` согласно вашим предвочтениям
* Измените набор подключаемых пакетов по вашему вкусу
* Поместите модифицированный файл в директорию с конфигурацией ESPHome
* Запустите сборку и прошивку вашей конфигурации
* Добавьте появившееся устройство в Home Assistant

## Использование
После [прошивки](#прошивка) и перед первым использование вам необъходимо ввести свой бризер в режим сопряжения (см. инструкцию) и только потом включать ESP.

Дополнительно, только для `Tion 3S`, необходимо нажать кнопку `Pair` в Home Assistant.

>
> ### **ВНИМАНИЕ: Все что вы делаете вы делаете только на свой страх и риск!**
>
## Планы на будущее

* Поддержка физического подключения через интеграционный разъем для `Tion 4S` (так же исследую возможность для 3S и Lite).
* Управление сбросом ресура фильтров
* Автоматическое управление притоком от внешнего датчика CO2

## Решение проблем и поддержка новых функций

Не стесняйтесь открывать [задачи](https://github.com/dentra/esphome-tion/issues) для сообщений об ошибках и запросов новых функций.

Так же вы можете воспользоваться [группой в Telegram](https://t.me/esphome_tion).

## Ваша благодарность

Если этот проект оказался для вас полезен и/или вы хотите поддержать его дальнейше развитие, то всегда можно оставить вашу благодарность
через [Card2Card](https://www.tinkoff.ru/cf/3dZPaLYDBAI) или [PayPal](https://paypal.me/dentra0).

## Коммерческое использование

По вопросам коммерческого использования или заказной разработки/доработки, обращийтесь по почте dennis.trachuk на gmail.com
4 changes: 2 additions & 2 deletions packages/common.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,5 @@ external_components:
- source: $tion_source

ble_client:
- mac_address: $tion_mac_address
id: tion_ble_client
mac_address: $tion_mac_address
id: tion_ble_client
Loading

0 comments on commit 6ac66f6

Please sign in to comment.