diff --git a/alarmdecoder/devices/base_device.py b/alarmdecoder/devices/base_device.py index 857563c..8311080 100644 --- a/alarmdecoder/devices/base_device.py +++ b/alarmdecoder/devices/base_device.py @@ -1,3 +1,11 @@ +""" +This module contains the base device type for the `AlarmDecoder`_ (AD2) family. + +.. _AlarmDecoder: http://www.alarmdecoder.com + +.. moduleauthor:: Scott Petersen +""" + import threading from ..util import CommError, TimeoutError, InvalidMessageError diff --git a/alarmdecoder/devices/serial_device.py b/alarmdecoder/devices/serial_device.py index a372d3f..96bc636 100644 --- a/alarmdecoder/devices/serial_device.py +++ b/alarmdecoder/devices/serial_device.py @@ -1,3 +1,13 @@ +""" +This module contains the :py:class:`SerialDevice` interface for the `AD2USB`_, `AD2SERIAL`_ or `AD2PI`_. + +.. _AD2USB: http://www.alarmdecoder.com +.. _AD2SERIAL: http://www.alarmdecoder.com +.. _AD2PI: http://www.alarmdecoder.com + +.. moduleauthor:: Scott Petersen +""" + import threading import serial import serial.tools.list_ports diff --git a/alarmdecoder/devices/socket_device.py b/alarmdecoder/devices/socket_device.py index 301cbe0..3963769 100644 --- a/alarmdecoder/devices/socket_device.py +++ b/alarmdecoder/devices/socket_device.py @@ -1,3 +1,14 @@ +""" +This module contains :py:class:`SocketDevice` interface for `AlarmDecoder`_ devices +that are exposed through `ser2sock`_ or another IP to serial solution. Also supports +SSL if using `ser2sock`_. + +.. _ser2sock: http://github.com/nutechsoftware/ser2sock +.. _AlarmDecoder: http://www.alarmdecoder.com + +.. moduleauthor:: Scott Petersen +""" + import threading import socket import select diff --git a/alarmdecoder/devices/usb_device.py b/alarmdecoder/devices/usb_device.py index 8d3e617..48b1d50 100644 --- a/alarmdecoder/devices/usb_device.py +++ b/alarmdecoder/devices/usb_device.py @@ -1,3 +1,11 @@ +""" +This module contains the :py:class:`USBDevice` interface for the `AD2USB`_. + +.. _AD2USB: http://www.alarmdecoder.com + +.. moduleauthor:: Scott Petersen +""" + import time import threading from .base_device import Device