A clone of: https://github.com/nutechsoftware/alarmdecoder This is requires as they dropped support for older firmware releases w/o building in backward compatibility code, and they had previously hardcoded pyserial to a python2 only version.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Scott Petersen e663d60a37 Made USB (via pyftdi) optional. Changed examples to use SerialDevice and moved USB to it's own example. Updated requirements and setup. 9 years ago
alarmdecoder Made USB (via pyftdi) optional. Changed examples to use SerialDevice and moved USB to it's own example. Updated requirements and setup. 9 years ago
bin Added support for baudrate on the command-line. Disabled reader thread by default. 11 years ago
docs Updated version and documentation. 10 years ago
examples Made USB (via pyftdi) optional. Changed examples to use SerialDevice and moved USB to it's own example. Updated requirements and setup. 9 years ago
test Fixed KPM header test. 11 years ago
.gitignore Added LRR example. Updated gitignore. 10 years ago
LICENSE Added license details. 11 years ago
MANIFEST.in Filename updates. 11 years ago
README.rst Reworked descriptions. 11 years ago
requirements.txt Made USB (via pyftdi) optional. Changed examples to use SerialDevice and moved USB to it's own example. Updated requirements and setup. 9 years ago
setup.py Made USB (via pyftdi) optional. Changed examples to use SerialDevice and moved USB to it's own example. Updated requirements and setup. 9 years ago

README.rst

.. _AlarmDecoder: http://www.alarmdecoder.com
.. _ser2sock: http://github.com/nutechsoftware/ser2sock
.. _pyftdi: https://github.com/eblot/pyftdi
.. _pyusb: http://sourceforge.net/apps/trac/pyusb
.. _pyserial: http://pyserial.sourceforge.net
.. _pyopenssl: https://launchpad.net/pyopenssl
.. _readthedocs: http://alarmdecoder.readthedocs.org
.. _examples: http://github.com/nutechsoftware/alarmdecoder/tree/master/examples

============
AlarmDecoder
============

-------
Summary
-------

This Python library aims to provide a consistent interface for the `AlarmDecoder`_ product line. (AD2USB, AD2SERIAL and AD2PI)
This also includes devices that have been exposed via `ser2sock`_, which
supports encryption via SSL/TLS.

------------
Installation
------------
AlarmDecoder can be installed through pip:
pip install alarmdecoder

or from source:
python setup.py install

* Note: python-setuptools is required for installation.

------------
Requirements
------------
* An `AlarmDecoder`_ device
* Python 2.7
* `pyftdi`_ >= 0.9.0
* `pyusb`_ >= 1.0.0b1
* `pyserial`_ >= 2.7
* `pyopenssl`_

-------------
Documentation
-------------
API documentation can be found at `readthedocs`_.

--------
Examples
--------
A basic example is included below. Please see the `examples`_ directory for more.::

import time
from alarmdecoder import AlarmDecoder
from alarmdecoder.devices import USBDevice

def main():
"""
Example application that prints messages from the panel to the terminal.
"""
try:
# Retrieve the first USB device
device = AlarmDecoder(USBDevice.find())

# Set up an event handler and open the device
device.on_message += handle_message
with device.open():
while True:
time.sleep(1)

except Exception, ex:
print 'Exception:', ex

def handle_message(sender, message):
"""
Handles message events from the AlarmDecoder.
"""
print sender, message.raw

if __name__ == '__main__':
main()