| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Name | Name | Last commit date | ||
|---|---|---|---|---|
This library directly interfaces Arduino and esp8266 microcontrollers to DSC PowerSeries security systems for integration with home automation, notifications on alarm events, and usage as a virtual keypad. This enables homes and offices with existing DSC security systems (of which millions have been installed over the decades) to connect with modern devices and software, while retaining the features and reliability of a hardwired system for under $5USD in components.
The built-in examples can be used as-is or as a base to adapt to other uses:
Blynk app virtual keypad:

I Had: A DSC security system not being monitored by a third-party service.
I Wanted: Notification if the alarm triggered.
I was interested in finding a solution that directly accessed the pair of data lines that DSC uses for their proprietary Keybus protocol to send data between the panel and modules (keypads, etc). Tapping into the data lines is an ideal task for a microcontroller and also presented an opportunity to work with the Arduino platform.
While there has been excellent discussion about the DSC Keybus protocol and a few existing projects, there were major issues that remained unsolved:
Poking around with a logic analyzer and oscilloscope revealed that the errors capturing the Keybus data were timing issues. Updating the existing projects to fix this turned out to be more troublesome than starting from scratch, so this project was born. After resolving the data errors, it was possible to reverse engineer the protocol by capturing the Keybus binary data as the security system handled various events. At this point, this interface resolves all of the earlier issues (and goes beyond my initial goal of simply seeing if the alarm is triggered).


The included examples demonstrate how to use the library and can be used as-is or adapted to integrate with other software. Post an issue/pull request if you've developed (and would like to share) a sketch/integration that others can use.
Status: Processes and prints the security system status to a serial interface, including reading from serial for the virtual keypad. This demonstrates how to determine if the security system status has changed, what has changed, and how to take action based on those changes. Post an issue/pull request if you have a use for additional system states - for now, only a subset of all decoded commands are being tracked for status to limit memory usage:
Homebridge-MQTT: Integrates with Apple HomeKit, including the iOS Home app and Siri. This uses MQTT to interface with Homebridge and homebridge-mqttthing and demonstrates using the armed and alarm states for the HomeKit securitySystem object, zone states for the contactSensor objects, and fire alarm states for the smokeSensor object.
HomeAssistant-MQTT: Integrates with Home Assistant via MQTT. This uses the armed and alarm states for the HomeAssistant Alarm Control Panel component, as well as zone, fire alarm, and trouble states for the Binary Sensor component.
Homey: Integrates with Athom Homey and the Homeyduino library, including armed, alarm, and fire states (currently limited to one partition), and zone states. Thanks to MagnusPer for contributing this example!
Pushbullet (esp8266-only): Demonstrates how to send a push notification when the status has changed. This example sends notifications via Pushbullet and requires the esp8266 for SSL support.
Twilio (esp8266-only): Demonstrates how to send a push notification when the status has changed. This example sends notifications via Twilio and requires the esp8266 for SSL support - thanks to ColingNG for contributing this example!
Email (esp8266-only): Demonstrates how to send an email when the status has changed. Email is sent using SMTPS (port 465) with SSL for encryption - this is necessary on the ESP8266 until STARTTLS can be supported. For example, this will work with Gmail after changing the account settings to allow less secure apps.
This can be used to send SMS messages if the number's service provider has an email to SMS gateway - examples for the US:
VirtualKeypad-Blynk (esp8266-only): Provides a virtual keypad interface for the free Blynk app on iOS and Android. Scan one of the following QR codes from within the Blynk app for an example keypad layout:
Note: Installing Blynk as a local server is recommended to keep control of the security system internal to your network. This also lets you use as many widgets as needed for free - local servers can setup users with any amount of Blynk Energy. Using the default Blynk cloud service with the above example layouts requires more of Blynk's Energy units than available on the free usage tier.
VirtualKeypad-Web (esp8266-only): Provides a virtual keypad web interface, using the esp8266 itself as a standalone web server. This example uses the ESP Async Web Server and Websockets - thanks to Elektrik1 for contributing this example!
KeybusReader: Decodes and prints data from the Keybus to a serial interface, including reading from serial for the virtual keypad. This can be used to help decode the Keybus protocol and is also handy as a troubleshooting tool to verify that data is displayed without errors.
See src/dscKeybusPrintData.cpp for all currently known Keybus protocol commands and messages. Issues and pull requests with additions/corrections are welcome!
DSC Aux(+) ---+--- Arduino Vin pin
|
+--- esp8266 NodeMCU Vin pin
|
+--- 5v voltage regulator --- esp8266 Wemos D1 Mini 5v pin
DSC Aux(-) --- Arduino/esp8266 Ground
+--- dscClockPin (Arduino Uno: 2,3 / esp8266: D1,D2,D8)
DSC Yellow --- 15k ohm resistor ---|
+--- 10k ohm resistor --- Ground
+--- dscReadPin (Arduino Uno: 2-12 / esp8266: D1,D2,D8)
DSC Green ---- 15k ohm resistor ---|
+--- 10k ohm resistor --- Ground
Virtual keypad (optional):
DSC Green ---- NPN collector --\
|-- NPN base --- 1k ohm resistor --- dscWritePin (Arduino Uno: 2-12 / esp8266: D1,D2,D8)
Ground --- NPN emitter --/
This allows a sketch to send keys to the DSC panel to emulate the physical DSC keypads and enables full control of the panel from the sketch or other software.
Keys are sent to partition 1 by default and can be changed to a different partition. The following keys can be sent to the panel - see the examples for usage:
Panel options affecting this interface, configured by *8 + installer code - see the DSC installation manual for your panel for configuration steps:
Swinger shutdown: By default, the panel will limit the number of alarm commands sent in a single armed cycle to 3 - for example, a zone alarm being triggered multiple times will stop reporting after 3 alerts. This is to avoid sending alerts repeatedly to a third-party monitoring service, and also affects this interface. As I do not use a monitoring service, I disable swinger shutdown by setting this to 000.
AC power failure reporting delay: The default delay is 30 minutes and can be set to 000 to immediately report a power failure.
Memory usage can be adjusted based on the number of partitions, zones, and data buffer size specified in src/dscKeybusInterface.h. Default settings:
PCB layouts are available in extras/PCB Layouts - thanks to sjlouw for contributing these designs!
Support for the esp32 and other platforms depends on adjusting the code to use their platform-specific timers. In addition to hardware interrupts to capture the DSC clock, this library uses platform-specific timer interrupts to capture the DSC data line in a non-blocking way 250us after the clock changes (without using delayMicroseconds()). This is necessary because the clock and data are asynchronous - I've observed keypad data delayed up to 160us after the clock falls.
AVR Freaks - DSC Keybus Protocol: An excellent discussion on how data is sent on the Keybus.
stagf15/DSC_Panel: A library that nearly works for the PC1555MX but had timing and data errors. Writing this library from scratch was primarily a programming exercise, otherwise it should be possible to patch the DSC_Panel library.
dougkpowers/pc1550-interface: An interface for the DSC Classic series.
| Back | FazBrowse Home | New Git URL |