Mirror/smart-domofon
1
0
Fork 0
mirror of https://github.com/Anonym-tsk/smart-domofon.git synced 2025-12-06 11:36:57 +03:00
Code Issues Packages Projects Releases Wiki Activity

ESPHome Readme

Browse Source
This commit is contained in:
Nikolay Vasilchuk
2019-07-01 11:38:48 +03:00
parent 3ccd180673
commit d2e4c0cb08
1 changed files with 6 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
esphome/README.md
View File

@@ -1,57 +1,13 @@
# Smart intercom with MQTT based on NodeMCUv3
This device can send "door open" command to intercom main unit after receiving of incoming call. It only works with coordinate line intercoms. Tested with Cyfral russian intercom.
[ESPHome](https://esphome.io/) version of Smart Intercom
Thanks to [Metori](https://github.com/Metori) for [original progect](https://github.com/Metori/mqtt_domofon)
## Parts used
* NodeMCU v3 x 1
* Double relay module x1 (or two single relay modules)
* LED x3 (or one RGB LED)
* Button x2
* Optocoupler x1
* Some resistors
## Example Parts
1. [Оптопара PC817B](https://roboshop.spb.ru/PC817B)
2. [Реле электромеханическое 2-канальное](https://roboshop.spb.ru/SRD-05VDC-SL-C-2-channel-rele)
3. [NodeMCU V3](https://roboshop.spb.ru/NodeMCU-v3-dev-board)
4. [RGB светодиод на плате](https://roboshop.spb.ru/RGB-led-module)
5. [Кнопка тактовая 6х6х13мм KFC-A06-13H](https://roboshop.spb.ru/KFC-A06-13H)
6. [Провода "мама-мама" 10см, 20 шт.](https://roboshop.spb.ru/female-to-female-line)
7. [Провода "папа-мама" 10см, 20 шт.](https://roboshop.spb.ru/male-to-female-line)
8. [Резисторы](https://roboshop.spb.ru/600-resist-set)
9. [microUSB кабель](https://roboshop.spb.ru/BS-410)
## Scheme
![Scheme](https://raw.githubusercontent.com/Anonym-tsk/smart-domofon/master/scheme.jpeg)
*Thanks to Oleg Yu*
[Scheme and parts](https://github.com/Anonym-tsk/smart-domofon/blob/master/README.md)
## Configuration and build
1. Fill in WiFi and MQTT credentials in [software.h](https://github.com/Anonym-tsk/smart-domofon/blob/master/src/config/software.h)
2. Fill in `upload_port` in [platformio.ini](https://github.com/Anonym-tsk/smart-domofon/blob/master/platformio.ini)
3. Use [PlatformIO](https://platformio.org/platformio-ide) to build and upload firmware
1. Fill in WiFi credentials in [domofon.yaml](https://github.com/Anonym-tsk/smart-domofon/blob/master/esphome/domofon.yaml#L10)
2. Use [ESPHome](https://esphome.io) to build and upload firmware
## Status MQTT messages (domofon/status)
* 'R' - ready; sent after successfull boot-up or after receiving of 'P' message
* 'L' - last will message; send when device goes offline
## Home Assistant Telegram notifications
## Incoming MQTT messages (domofon/in)
* 'O' - door open command
* 'N' - call reject command (door will not open)
* 'P' - ping command (answers with 'R')
## Outgoing MQTT messages (domofon/out)
* 'C' - call; sent after detecting of incoming intercom call
* 'H' - hangup; sent after detected incoming call finished
* 'B' - button; sent when "door open" has been performed by green hw button press
* 'J' - reJected; sent when incoming call has been rejected by red hw button press
* 'S' - success; sent in response to 'O' or 'N' command
* 'F' - fail; sent in response to 'O' or 'N' command (this means that 'O' or 'N' command has been received but no incoming call detected)
## Home Assistant integration
![Home Assistant](https://raw.githubusercontent.com/Anonym-tsk/smart-domofon/master/homeassistant/ha.png)
[Full configuration with sensor, switches and automations](https://github.com/Anonym-tsk/smart-domofon/blob/master/homeassistant/domofon.yaml)
Put this file into `/config/packages/domofon.yaml` and correct notification service in automations.
Put [this file](https://github.com/Anonym-tsk/smart-domofon/blob/master/esphome/homeassistant/domofon.yaml) into `/config/packages/domofon.yaml` and correct notification service in automations.