Device file headers.

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 <scott@nutech.com>
+"""
+
 import threading
 
 from ..util import CommError, TimeoutError, InvalidMessageError

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 <scott@nutech.com>
+"""
+
 import threading
 import serial
 import serial.tools.list_ports

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 <scott@nutech.com>
+"""
+
 import threading
 import socket
 import select

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 <scott@nutech.com>
+"""
+
 import time
 import threading
 from .base_device import Device