Merge pull request #5 from strannick-ru/master

Документация платы gelmer (ru)

ge1mer/README.md

@@ -1,5 +1,5 @@
 # Умный домофон (версия на [ESPHome](https://esphome.io/) от [Ge1mer](https://github.com/Ge1mer))
-[English](https://github.com/Anonym-tsk/smart-domofon/blob/master/ge1mer/README_EN.md) | **Русский**
+[English](../ge1mer/README_EN.md) | **Русский**
 
 ---
 
@@ -13,11 +13,18 @@
 
 [Чат в Telegram](https://t.me/domofon_esp)
 
-![Board](https://raw.githubusercontent.com/Anonym-tsk/smart-domofon/master/ge1mer/board.jpeg)
+![Board](../ge1mer/domofon-scheme.png)
 
-![Connection](https://raw.githubusercontent.com/Anonym-tsk/smart-domofon/master/ge1mer/connection.jpeg)
+![Connection](../ge1mer/connection.jpeg)
+
+на этой схеме:
+
+* УКП (устройство квартирное переговорное) — плата домофона
+* Линия — входящий в квартиру кабель
+* Питание — питание для платы
 
 ## Возможности и режимы
+* Управление как физической кнопкой на корпусе, так и через интеграцию с умным домом
 * Режим автоматического открытия двери (одиночный и постоянный)
 * Режим автоматического отклонения вызова
 * Режим "без звука" постоянный или на один звонок
@@ -46,10 +53,45 @@
     * Нет входящего вызова - выключит режим автоматического открытия или отклонения
     * Входящий звонок - отклонит вызов
 
+## Подключение
+1. Аккуратно вскройте домофон и определите, где кабель, входящий из подъезда, подсоединён к плате. Запомните, какой из проводов кабеля плюс, какой минус, в дальнейшем это поможет избежать ошибок подключения (впрочем, если вы их перепутаете, ничего страшного не случится, ни плата, ни домофон не пострадают, просто не будут работать, пока не подключите правильно).
+2. Проверьте, нет ли на входящем из подъезда кабеле [винтовых соединений или скруток](../ge1mer/domofon-line.jpg). В большинстве случаев этот кабель не припаян непосредственно к плате домофона, а подсоединён в соединительным проводам. Возможно, имеет смысл поставить плату именно в этот разрыв.
+3. Подключите входящий из подъезда кабель к разъёмам Line+ и Line- платы (обратите внимание на подписи [на обратной стороне платы](../ge1mer/domofon-back.jpg)), подключите идущие к плате домофона провода к разъёмам Intercom+ и Intercom- платы.
+4. Подключите питание. Это возможно как через имеющийся usb-разъём, так и через разъёмы power+/power- (см. подписи [на обратной стороне платы](../ge1mer/domofon-back.jpg)). Подать можно от 3.5 до 16 вольт, но надо помнить, что при напряжении более 5 вольт плата будет греться.
+
+дополнение: чтобы упростить монтаж, можно припаять к плате винтовые клеммники (например, [такие](https://www.chipdip.ru/product/308-021-12-14)) и подключать входящий кабель, провода к плате домофона, провода к внешней кнопке и, при необходимости, кабель питания, уже к ним.
+
 ## Конфигурация и прошивка
-1. Заполните настройки WiFi в файле [domofon.yaml](https://github.com/Anonym-tsk/smart-domofon/blob/master/ge1mer/domofon.yaml#L21)
+1. Заполните настройки WiFi в файле [domofon.yaml](../ge1mer/domofon.yaml#L21)
 2. Используйте [ESPHome](https://esphome.io) для компиляции и загрузки прошивки
 
 ## Уведомления в Telegram через Home Assistant
 
-Положите [этот файл](https://github.com/Anonym-tsk/smart-domofon/blob/master/ge1mer/homeassistant/domofon.yaml) в `/config/packages/domofon.yaml` и исправьте используемые сервисы в автоматизации.
+Положите [этот файл](../ge1mer/homeassistant/domofon.yaml) в `/config/packages/domofon.yaml` и исправьте используемые сервисы в автоматизации.
+
+## Замена интеграции с Home Assistant на MQTT
+
+1. Закомментируйте раздел API в файле [domofon.yaml](../ge1mer/domofon.yaml#L94) (строки 94-138)
+2. После закомментированных строк впишите следующее:
+```
+mqtt:
+  broker: 192.168.1.25   # IP-адрес MQTT-брокера
+  port: 1883             # порт MQTT-брокера
+  discovery: false       # отключаем интеграцию с Home Assistant
+  username: ""
+  password: ""
+```
+
+## Интеграция умного домофона со SprutHub
+
+1. Замените интеграцию с Home Assistant на MQTT, как описано в предыдущем разделе. В качестве IP-адреса MQTT-брокера используйте IP-адрес SprutHub-а, порт 44444, логин и пароль оставьте пустыми.
+2. Добавьте файл [domofon.json](../ge1mer/domofon.json) в каталог `/home/makesimple/.SprutHub/data/Templates/MQTT/Custom`
+3. Следуйте указаниям статьи [Настройка Sprut.Hub для работы с ESP через MQTT](https://wiki.sprut.ai/ru/spruthub/accessory/mqtt-devices-templates).
+
+## Ищем проблемы (если после подключения что-то не заработало)
+1. Отключите питание платы. Проверьте, работает ли домофон, как обычно.
+   1. Если панель домофона на улице показывает ошибку, вероятно перепутана полярность входящих проводов, попробуйте поменять.
+   2. Если вызов идёт, но в трубке нет звука, попробуйте поменять сопротивление подстроечного резистора. Для этого аккуратно поверните его отвёрткой против часовой стрелки на четверть оборота. После этого попробуйте снова. При необходимости повторите.
+2.  Если с выключенной платой домофон работает как обычно, а с включенной не определяется входящий звонок (проще всего во время вызова посмотреть на строку "Domofon incoming call" в Home Assistant, необходимо увеличить в прошивке значения call_end_detect_delay и relay_answer_on_time, после чего перезалить прошивку.
+3.  Если входящий звонок определяется, но не работает открытие двери через плату, необходимо увеличить в прошивке значение relay_open_on_time, после чего перезалить прошивку.
+4.  если указанные действия ни к чему не привели - стоит обратиться за помощью в [чат в Telegram](https://t.me/domofon_esp).

ge1mer/domofon.json

@@ -0,0 +1,149 @@
+{
+  "name": "Домофон",
+  "manufacturer": "Anonym-tsk",
+  "model": "ge1mer",
+  "services": [
+    {
+      "name": "Автооткр.",
+      "type": "Switch",
+      "characteristics": [
+        {
+          "type": "On",
+          "link": {
+            "type": "String",
+            "topicSearch": "(.*)/switch/domofon_automatically_open/state",
+            "topicGet": "domofon/switch/domofon_automatically_open/state",
+            "topicSet": "domofon/switch/domofon_automatically_open/command",
+            "map": {
+              "false": "OFF",
+              "true": "ON"
+            }
+          }
+        }
+      ]
+    },
+    {
+      "name": "Автооткр.1 раз",
+      "type": "Switch",
+      "characteristics": [
+        {
+          "type": "On",
+          "link": {
+            "type": "String",
+            "topicGet": "domofon/switch/domofon_automatically_open_once/state",
+            "topicSet": "domofon/switch/domofon_automatically_open_once/command",
+            "map": {
+              "false": "OFF",
+              "true": "ON"
+            }
+          }
+        }
+      ]
+    },
+    {
+      "name": "Автосброс",
+      "type": "Switch",
+      "characteristics": [
+        {
+          "type": "On",
+          "link": {
+            "type": "String",
+            "topicGet": "domofon/switch/domofon_automatically_reject/state",
+            "topicSet": "domofon/switch/domofon_automatically_reject/command",
+            "map": {
+              "false": "OFF",
+              "true": "ON"
+            }
+          }
+        }
+      ]
+    },
+    {
+      "name": "Открыть",
+      "type": "Switch",
+      "characteristics": [
+        {
+          "type": "On",
+          "link": {
+            "type": "String",
+            "topicGet": "domofon/switch/domofon_accept_call/state",
+            "topicSet": "domofon/switch/domofon_accept_call/command",
+            "map": {
+              "false": "OFF",
+              "true": "ON"
+            }
+          }
+        }
+      ]
+    },
+     {
+      "name": "Сброс вызова",
+      "type": "Switch",
+      "characteristics": [
+        {
+          "type": "On",
+          "link": {
+            "type": "String",
+            "topicGet": "domofon/switch/domofon_reject_call/state",
+            "topicSet": "domofon/switch/domofon_reject_call/command",
+            "map": {
+              "false": "OFF",
+              "true": "ON"
+            }
+          }
+        }
+      ]
+    },
+    {
+      "name": "Mute",
+      "type": "Switch",
+      "characteristics": [
+        {
+          "type": "On",
+          "link": {
+            "type": "String",
+            "topicGet": "domofon/switch/domofon_mute_sound/state",
+            "topicSet": "domofon/switch/domofon_mute_sound/command",
+            "map": {
+              "false": "OFF",
+              "true": "ON"
+            }
+          }
+        }
+      ]
+    },
+    {
+      "name": "Mute 1 раз",
+      "type": "Switch",
+      "characteristics": [
+        {
+          "type": "On",
+          "link": {
+            "type": "String",
+            "topicGet": "domofon/switch/domofon_mute_sound_once/state",
+            "topicSet": "domofon/switch/domofon_mute_sound_once/command",
+            "map": {
+              "false": "OFF",
+              "true": "ON"
+            }
+          }
+        }
+      ]
+    },
+    {
+      "name": "Вход.Звонок",
+  "type": "ContactSensor",
+  "characteristics": [{
+    "type": "ContactSensorState",
+    "link": {
+      "type": "Integer",
+      "topicGet": "domofon/binary_sensor/domofon_incoming_call/state",
+      "map": {
+              "0": "OFF",
+              "1": "ON"
+            }
+    }
+  }]
+}
+  ]
+}