Merge branch 'master' into dev

README.md

@@ -1,65 +1,98 @@
 # Tion Home Assistant
-Интеграция обеспечивает управление бризерами Tion, а также чтение показаний датчиков (включая датчики MagicAir) из системы умного дома Home Assistant.
 
-*Внимание: для работы требуется шлюз MagicAir!*
+Компонент для интеграции оборудования Tion в Home Assistant.
+
+Интеграция - облачная, работает через API Tion'а, соответственно, **для работы компонента требуется станция MagicAir**.
+
+![screenshot.png](docs%2Fscreenshot.png)
+
+#### Поддерживаемые устройства:
+* Бризер Tion Breezer 3S
+* Бризер Tion Breezer 4S
+* Станция/шлюз Tion MagicAir
+* Модуль CO2+
 
 ## Установка
 
-### HACS:
-1. HACS->Settings->Custom repositories 
-2. Добавьте `vaproloff/tion_home_assistant` в поле `ADD CUSTOM REPOSITORY` и выберите `Integration` в `CATEGORY`. Щелкните кнопку `Save`
-3. перезагрузите Home Assistant
+### HACS _(рекомендуется)_:
+> Рекомендуется использовать данный способ, что позволит легко следить за обновлениями компонента и легко их устанавливать.
+1. `HACS` -> `...` (настройки) -> `Пользовательские репозитории` 
+2. Добавьте `vaproloff/tion_home_assistant` в поле `Репозиторий` и выберите тип `Интеграция`. Щелкните кнопку `Добавить`.
+3. Перезагрузите Home Assistant
 
-### Без HACS:
-1. скачайте zip файл с компонентом
-2. поместите содержимое в `config/custom_components/tion` папку системы Home Assistant
-3. перезагрузите Home Assistant
+### Вручную:
+1. Скачайте zip файл с компонентом
+2. Поместите содержимое в `config/custom_components/tion` папку системы Home Assistant
+3. Перезагрузите Home Assistant
 
 ## Настройка
-> Настройки > Интеграции > Добавить интеграцию > **Tion**
+> `Настройки` -> `Устройства и службы` > `Добавить интеграцию` > `Tion`
 
 Если интеграции нет в списке - очистите кэш браузера.
 
+---
 ## Использование:
-Среди устройств должны появиться:
-- бризеры `climate.`,
-- датчики бризера `sensor.`,
-- датчики MagicAir `sensor.`,
-- выключатели подсветки бризеров, MagicAir `switch.`,
-- выключатели звука бризеров `switch.`,
-- целевой уровень CO2 зоны `number.`,
-- минимальная и максимальная скорости бризера в режиме `auto` `number.`.
-
-Службы Home Assistant для управления вашими устройствами:
-### climate.set_fan_mode
-`fan_mode` задает скорость бризера следующим образом (тип - строка):
-- `1`-`6` - включить в ручном режиме с заданной скоростью
-- `auto` - автоматическое управление скоростью в зависимости от уровня CO2
-
-### climate.set_hvac_mode
-`hvac_mode` задает режим работы прибора:
-- `heat` - нагреватель включен
-- `fan_only` - нагреватель выключен
-- `off` - прибор выключен
-
-### climate.set_temperature
-Используйте для задачи целевой температуры нагревателя
+### Устройства Home Assistant, предоставляемые интеграцией:
+#### Бризеры Tion:
+- термостат `climate`
+  - выбор режима `hvac_mode`
+  - установка температуры воздуха для подогрева
+  - выбор режима качания `swing_mode` _(источник входящего потока воздуха)_
+  - выбор скорости `fan_speed`
+- датчик температуры входящего потока воздуха `sensor` _(до нагревателя)_
+- датчик температуры выходящего потока воздуха `sensor` _(после нагревателя)_
+- выключатель подогрева воздуха `switch`
+- выключатель подсветки кнопки `switch`
+- выключатель звуковых сигналов `switch`
+- минимальная скорость для Авто режима `number` _(атрибут speed_min_set объекта climate бризера будет удалён, поддержка - до конца 2024 г.)_
+- максимальная скорость для Авто режима `number` _(атрибут speed_max_set объекта climate бризера будет удалён, поддержка - до конца 2024 г.)_
+- сенсор даты-времени следующей замены фильтров `sensor` _(атрибут filter_days_left объекта climate бризера будет удалён, поддержка - до конца 2024 г.)_
+- бинарный сенсор необходимости замены фильтров `binary_sensor` _(атрибут filter_need_replace объекта climate бризера будет удалён, поддержка - до конца 2024 г.)_
 
-### tion.set_zone_target_co2
-Используйте для задачи целевого уровня CO2 для (в Авто режиме бризера) _(устаревшая служба, поддержка - до конца 2024 г.)_
+#### Станция MagicAir и Модуль CO2:
+- датчик температуры `sensor`
+- датчик влажности `sensor`
+- датчик уровня CO2 `sensor`
+- датчик качества воздуха (содержание частиц PM25) `sensor` _(при наличии)_
+- целевой уровень CO2 для Авто режима `number` _(атрибут target_co2 объекта climate бризера будет удалён, поддержка - до конца 2024 г.)_
+- выключатель подсветки `switch`
 
-### tion.set_breezer_min_speed
-Используйте для задачи минимальной скорости (в Авто режиме бризера) _(устаревшая служба, поддержка - до конца 2024 г.)_
+### Службы Home Assistant для управления вашими устройствами:
+#### Стандартные сервисы Home Assistant:
+* `climate.turn_on` - включение бризера
+* `climate.turn_off` - выключение бризера
+* `climate.set_temperature` - регулирование уставки температуры бризера
+* `climate.set_fan_mode` - установка скорости вентилятора `fan_mode` бризера:
+  - `1`-`6` - заданная скорость в ручном режиме
+  - `auto` - автоматическое управление скоростью в зависимости от уровня CO2
+* `climate.set_hvac_mode` - установка режима работы `hvac_mode` бризера:
+  - `heat` - бризер включен, нагреватель включен
+  - `fan_only` - бризер включен, нагреватель выключен
+  - `off` - бризер выключен
+* `climate.set_swing_mode` - выбор входящего потока воздуха бризера в качестве режима качания `swing_mode` термостата:
+  - `outside` - с улицы
+  - `inside` - из комнаты (доступно только при ручном режиме выбора скорости)
+  - `mixed` - смешанный (только для Tion Breezer 3S, доступно только при ручном режиме выбора скорости)
+* `number.set_value` - установка целевого значения уровня CO2, минимальной и максимальной скоростей вентилятора для Авто режима
+* `switch.turn_on` - включение подогрева, подсветки и звуковых сигналов бризера, модуля CO2, станции MagicAir
+* `switch.turn_off` - выключение подогрева, подсветки и звуковых сигналов бризера, модуля CO2, станции MagicAir
+* `switch.toggle` - переключение подогрева, подсветки и звуковых сигналов бризера, модуля CO2, станции MagicAir
 
-### tion.set_breezer_max_speed
-Используйте для задачи максимальной скорости (в Авто режиме бризера) _(устаревшая служба, поддержка - до конца 2024 г.)_
+#### Специальные сервисы компонента Tion:
+* `tion.reset_filters` - сброс периода замены фильтров бризера
+> Устаревшие службы, на замену пришли соответствующие объекты, поддержка данных служб - до конца 2024 г.
+> * `tion.set_zone_target_co2` - регулирование целевого уровня CO2 в Авто режиме бризера
+> * `tion.set_breezer_min_speed` - установка минимальной скорости в Авто режиме бризера
+> * `tion.set_breezer_max_speed` - установка максимальной скорости в Авто режиме бризера
 
-## Если что-то не работает
-Включите расширенное логирование для интеграции и пакета `tion` в файле конфигурации `configuration.yaml`:
-```yaml
-logger:
-  default: warning
-  logs:
-    custom_components.tion: info
-    tion: info
-```
+---
+### Если что-то не работает
+1. Создайте топик по [ссылке](https://github.com/vaproloff/tion_home_assistant/issues/new).
+2. Опишите проблему, прикрепите логи.
+3. Для расширенного логирования необходимо в файл конфигурации `configuration.yaml` добавить:
+    ```yaml
+    logger:
+      default: info
+      logs:
+        custom_components.tion: debug
+    ```