Skip to content

Latest commit

 

History

History
99 lines (67 loc) · 5.83 KB

README.md

File metadata and controls

99 lines (67 loc) · 5.83 KB


Doorman S3

Doorman S3

This repository provides the source files for the Doorman S3 Intercom Gateway, a device designed to connect your TCS or Koch intercom to any home automation system.
It's also compatible with some rebranded Niko, Scantron and older Jung intercoms, which are counterparts of TCS and Koch models.

The Doorman S3 isn't limited to these intercoms alone. With its integrated relay, it can simulate button presses to trigger door openers or lights (supporting up to 40V and a maximum of 2.5A).

If your intercom isn't a TCS, Koch, Niko, Scantron or Jung model but operates on a 2-wire bus within the 14-24V DC range, you might be able to implement other protocols. Additionally, you can monitor the voltage levels on older intercoms (14-24V), allowing you to trigger specific actions based on the voltage readings.

A big thanks to PCBWay for sponsoring this project! For more details on the manufacturing process, scroll down to the "Manufacturing" section.

🚀 Getting started

Be sure to visit the Doorman Docs for all the information you need. If you have any questions or need further assistance, feel free to reach out on Discord or GitHub Issues. I'm here to help!

📦 Interested in buying one?

Feel free to contact me on Discord or via E-Mail.

I offer fully assembled and tested Doorman-S3 units with the Stock Firmware pre-installed, ready for direct integration and adoption into Home Assistant.

🤖 Features

  • Powered by ESP32-S3
  • USB-C port for easy flashing (and because USB-C is cool 😎)
  • Compact design that fits almost anywhere
  • Configurable WS2812B RGB LED to indicate specific events
  • Two additional GPIOs for easy expansion with your own sensors and devices (e.g., I²C)
  • Solid-state relay for switching up to 40V (max. 2.5A), ideal for older intercom systems
  • External Button (G + BTN)
  • Bridge rectifier for bus-wire input to correct polarity
  • TCS bus communication for functions like opening the front door and detecting the doorbell
  • Can be used as a Nuki Bridge with the Nuki Bridge Firmware. Note that this firmware is incompatible with the Nuki app, but it works with the Home Assistant app.

✔️ Compatibility

If your TCS or Koch intercom has screw terminals labeled a, b, and P and operates on 24V DC, it's likely compatible with Doorman.
For detailed compatibility information, check out the Compatibility Docs.

🚩 Repository Structure

The repository is organized into the following directories:

  • pcb: Contains KiCad schematic and PCB design files
  • firmware: Includes ESPHome configuration files
  • components: Includes ESPHome external component files
  • enclosure: Provides STL files for the enclosure design

🛠️ Manufacturing

PCBWay Delivery

I was unsure which PCB manufacturer to choose, but fortunately, PCBWay reached out and offered to sponsor the PCB fabrication. I couldn't be happier with the results—the quality is exceptional, especially with the vibrant colors. Everything arrived in pristine condition, and sourcing parts was hassle-free. They even included two extra unpopulated PCBs.

I handled the soldering of the ESP modules myself using a heating plate, as I already had ESP32 modules at home.

PCBWay made the entire process straightforward and responsive. A special thanks to Liam and Lynne for their support throughout, especially given the numerous changes I made. Their patience and assistance were greatly appreciated.

If you're looking for a reliable, high-quality PCB manufacturer, I highly recommend PCBWay :)

You can find all the neccessary files here.

🙌 Contributing

If you'd like to contribute to the Doorman project, we welcome your involvement!
Please feel free to open a Pull Request. Your contributions, whether they are code improvements, bug fixes, or documentation updates, are greatly appreciated.

📜 Credits

Doorman is heavily built on the code and insights from the following projects and individuals.
This project would not have been possible without their contributions. ❤️

TCSIntercomArduino
Different Methods to read from and write to the TCS Bus.
Feel free to watch the Reverse Engineering Video if you're interested.

tcs-monitor
An mqtt monitor for listening to the TCS Bus.
You can find more information in this Blog Post.

Doorman
A lot of this Doorman project is based on peteh's one.
The main goal is to provide a proper PCB for his Doorman Project.

ESPHome_nuki_lock
This module builds an ESPHome lock platform for Nuki Smartlock (nuki_lock).

AStrehlau
Thank you so much for your time, patience, expertise, and every piece of invaluable advice that helped make this project better, smaller, and more affordable.

calibanorg
Thank you so much for your support, both in terms of encouragement and financial assistance, in the development of Doorman.