Product name tweaks.

README.md

@@ -1,6 +1,6 @@
-Alarm Decoder
+AlarmDecoder
 =============
-#### Interface for the [Alarm Decoder](http://www.alarmdecoder.com) (AD2) device family ####
+#### Interface for the [AlarmDecoder](http://www.alarmdecoder.com) (AD2) device family ####
 
 
 This Python library aims to provide a consistent interface for the entire [Alarm
@@ -20,7 +20,7 @@ or from source:
 
 Requirements
 ------------
-* An [Alarm Decoder](http://www.alarmdecoder.com) device
+* An [AlarmDecoder](http://www.alarmdecoder.com) device
 * Python 2.7
 * [pyftdi](https://github.com/eblot/pyftdi) >= 0.9.0
 * [pyusb](http://sourceforge.net/apps/trac/pyusb/) >= 1.0.0b1

alarmdecoder/decoder.py

@@ -1,7 +1,7 @@
 """
 Provides the main AlarmDecoder class.
 
-.. _Alarm Decoder: http://www.alarmdecoder.com
+.. _AlarmDecoder: http://www.alarmdecoder.com
 
 .. moduleauthor:: Scott Petersen <scott@nutech.com>
 """
@@ -16,7 +16,7 @@ from .zonetracking import Zonetracker
 
 class AlarmDecoder(object):
     """
-    High-level wrapper around `Alarm Decoder`_ (AD2) devices.
+    High-level wrapper around `AlarmDecoder`_ (AD2) devices.
     """
 
     # High-level Events
@@ -81,7 +81,7 @@ class AlarmDecoder(object):
         """
         Constructor
 
-        :param device: The low-level device used for this `Alarm Decoder`_
+        :param device: The low-level device used for this `AlarmDecoder`_
                        interface.
         :type device: Device
         """
@@ -124,7 +124,7 @@ class AlarmDecoder(object):
     @property
     def id(self):
         """
-        The ID of the `Alarm Decoder`_ device.
+        The ID of the `AlarmDecoder`_ device.
 
         :returns: identification string for the device
         """
@@ -195,7 +195,7 @@ class AlarmDecoder(object):
 
     def send(self, data):
         """
-        Sends data to the `Alarm Decoder`_ device.
+        Sends data to the `AlarmDecoder`_ device.
 
         :param data: data to send
         :type data: string

alarmdecoder/devices.py

@@ -1,5 +1,5 @@
 """
-This module contains different types of devices belonging to the `Alarm Decoder`_ (AD2) family.
+This module contains different types of devices belonging to the `AlarmDecoder`_ (AD2) family.
 
 * :py:class:`USBDevice`: Interfaces with the `AD2USB`_ device.
 * :py:class:`SerialDevice`: Interfaces with the `AD2USB`_, `AD2SERIAL`_ or `AD2PI`_.
@@ -7,7 +7,7 @@ This module contains different types of devices belonging to the `Alarm Decoder`
   Also supports SSL if using `ser2sock`_.
 
 .. _ser2sock: http://github.com/nutechsoftware/ser2sock
-.. _Alarm Decoder: http://www.alarmdecoder.com
+.. _AlarmDecoder: http://www.alarmdecoder.com
 .. _AD2USB: http://www.alarmdecoder.com
 .. _AD2SERIAL: http://www.alarmdecoder.com
 .. _AD2PI: http://www.alarmdecoder.com
@@ -31,7 +31,7 @@ from .event import event
 
 class Device(object):
     """
-    Base class for all `Alarm Decoder`_ (AD2) device types.
+    Base class for all `AlarmDecoder`_ (AD2) device types.
     """
 
     # Generic device events
@@ -771,7 +771,7 @@ class SerialDevice(Device):
 
 class SocketDevice(Device):
     """
-    Device that supports communication with an `Alarm Decoder`_ (AD2) that is
+    Device that supports communication with an `AlarmDecoder`_ (AD2) that is
     exposed via `ser2sock`_ or another Serial to IP interface.
     """
 

alarmdecoder/messages.py

@@ -1,5 +1,5 @@
 """
-Message representations received from the panel through the `Alarm Decoder`_ (AD2)
+Message representations received from the panel through the `AlarmDecoder`_ (AD2)
 devices.
 
 * :py:class:`Message`: The standard and most common message received from a panel.
@@ -7,7 +7,7 @@ devices.
 * :py:class:`RFMessage`: Message received from an RF receiver module.
 * :py:class:`LRRMessage`: Message received from a long-range radio module.
 
-.. _Alarm Decoder: http://www.alarmdecoder.com
+.. _AlarmDecoder: http://www.alarmdecoder.com
 
 .. moduleauthor:: Scott Petersen <scott@nutech.com>
 """

alarmdecoder/util.py

@@ -1,7 +1,7 @@
 """
-Provides utility classes for the `Alarm Decoder`_ (AD2) devices.
+Provides utility classes for the `AlarmDecoder`_ (AD2) devices.
 
-.. _Alarm Decoder: http://www.alarmdecoder.com
+.. _AlarmDecoder: http://www.alarmdecoder.com
 
 .. moduleauthor:: Scott Petersen <scott@nutech.com>
 """
@@ -40,7 +40,7 @@ class InvalidMessageError(Exception):
 
 class Firmware(object):
     """
-    Represents firmware for the Alarm Decoder devices.
+    Represents firmware for the `AlarmDecoder`_ devices.
     """
 
     # Constants
@@ -55,7 +55,7 @@ class Firmware(object):
     @staticmethod
     def upload(dev, filename, progress_callback=None):
         """
-        Uploads firmware to an `Alarm Decoder`_ device.
+        Uploads firmware to an `AlarmDecoder`_ device.
 
         :param filename: firmware filename
         :type filename: string

alarmdecoder/zonetracking.py

@@ -1,7 +1,7 @@
 """
-Provides zone tracking functionality for the `Alarm Decoder`_ (AD2) device family.
+Provides zone tracking functionality for the `AlarmDecoder`_ (AD2) device family.
 
-.. _Alarm Decoder: http://www.alarmdecoder.com
+.. _AlarmDecoder: http://www.alarmdecoder.com
 
 .. moduleauthor:: Scott Petersen <scott@nutech.com>
 """

docs/build/html/_sources/index.txt

@@ -4,7 +4,7 @@
    contain the root `toctree` directive.
 
 Welcome to Alarm Decoder's documentation!
-========================================
+=========================================
 
 .. _Alarm Decoder: http://www.alarmdecoder.com
 .. _examples: http://github.com/nutechsoftware/alarmdecoder/tree/master/examples

docs/build/html/alarmdecoder.event.html

@@ -23,9 +23,7 @@
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="top" title="alarmdecoder  documentation" href="index.html" />
-    <link rel="up" title="alarmdecoder Package" href="alarmdecoder.html" />
-    <link rel="prev" title="alarmdecoder Package" href="alarmdecoder.html" /> 
+    <link rel="top" title="alarmdecoder  documentation" href="index.html" /> 
   </head>
   <body>
     <div class="related">
@@ -37,11 +35,7 @@
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="right" >
-          <a href="alarmdecoder.html" title="alarmdecoder Package"
-             accesskey="P">previous</a> |</li>
-        <li><a href="index.html">alarmdecoder  documentation</a> &raquo;</li>
-          <li><a href="alarmdecoder.html" accesskey="U">alarmdecoder Package</a> &raquo;</li> 
+        <li><a href="index.html">alarmdecoder  documentation</a> &raquo;</li> 
       </ul>
     </div>  
 
@@ -110,9 +104,6 @@ e.fire(<a href="#id6"><span class="problematic" id="id7">*</span></a>args, <a hr
 </li>
 </ul>
 
-  <h4>Previous topic</h4>
-  <p class="topless"><a href="alarmdecoder.html"
-                        title="previous chapter">alarmdecoder Package</a></p>
   <h3>This Page</h3>
   <ul class="this-page-menu">
     <li><a href="_sources/alarmdecoder.event.txt"
@@ -144,11 +135,7 @@ e.fire(<a href="#id6"><span class="problematic" id="id7">*</span></a>args, <a hr
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="right" >
-          <a href="alarmdecoder.html" title="alarmdecoder Package"
-             >previous</a> |</li>
-        <li><a href="index.html">alarmdecoder  documentation</a> &raquo;</li>
-          <li><a href="alarmdecoder.html" >alarmdecoder Package</a> &raquo;</li> 
+        <li><a href="index.html">alarmdecoder  documentation</a> &raquo;</li> 
       </ul>
     </div>
     <div class="footer">

docs/build/html/alarmdecoder.html

@@ -57,7 +57,7 @@
 <dt id="alarmdecoder.decoder.AlarmDecoder">
 <em class="property">class </em><tt class="descclassname">alarmdecoder.decoder.</tt><tt class="descname">AlarmDecoder</tt><big>(</big><em>device</em><big>)</big><a class="reference internal" href="_modules/alarmdecoder/decoder.html#AlarmDecoder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
-<p>High-level wrapper around <a class="reference external" href="http://www.alarmdecoder.com">Alarm Decoder</a> (AD2) devices.</p>
+<p>High-level wrapper around <a class="reference external" href="http://www.alarmdecoder.com">AlarmDecoder</a> (AD2) devices.</p>
 <dl class="attribute">
 <dt id="alarmdecoder.decoder.AlarmDecoder.on_arm">
 <tt class="descname">on_arm</tt><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.on_arm" title="Permalink to this definition">¶</a></dt>
@@ -286,7 +286,7 @@
 <dl class="attribute">
 <dt id="alarmdecoder.decoder.AlarmDecoder.id">
 <tt class="descname">id</tt><a class="reference internal" href="_modules/alarmdecoder/decoder.html#AlarmDecoder.id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.id" title="Permalink to this definition">¶</a></dt>
-<dd><p>The ID of the <a class="reference external" href="http://www.alarmdecoder.com">Alarm Decoder</a> device.</p>
+<dd><p>The ID of the <a class="reference external" href="http://www.alarmdecoder.com">AlarmDecoder</a> device.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
@@ -353,7 +353,7 @@ thread should be started.</li>
 <dl class="method">
 <dt id="alarmdecoder.decoder.AlarmDecoder.send">
 <tt class="descname">send</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/alarmdecoder/decoder.html#AlarmDecoder.send"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.send" title="Permalink to this definition">¶</a></dt>
-<dd><p>Sends data to the <a class="reference external" href="http://www.alarmdecoder.com">Alarm Decoder</a> device.</p>
+<dd><p>Sends data to the <a class="reference external" href="http://www.alarmdecoder.com">AlarmDecoder</a> device.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
@@ -419,7 +419,7 @@ thread should be started.</li>
 </div>
 <div class="section" id="module-alarmdecoder.devices">
 <span id="devices-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">devices</span></tt> Module<a class="headerlink" href="#module-alarmdecoder.devices" title="Permalink to this headline">¶</a></h2>
-<p>This module contains different types of devices belonging to the <a class="reference external" href="http://www.alarmdecoder.com">Alarm Decoder</a> (AD2) family.</p>
+<p>This module contains different types of devices belonging to the <a class="reference external" href="http://www.alarmdecoder.com">AlarmDecoder</a> (AD2) family.</p>
 <ul class="simple">
 <li><a class="reference internal" href="#alarmdecoder.devices.USBDevice" title="alarmdecoder.devices.USBDevice"><tt class="xref py py-class docutils literal"><span class="pre">USBDevice</span></tt></a>: Interfaces with the <a class="reference external" href="http://www.alarmdecoder.com">AD2USB</a> device.</li>
 <li><a class="reference internal" href="#alarmdecoder.devices.SerialDevice" title="alarmdecoder.devices.SerialDevice"><tt class="xref py py-class docutils literal"><span class="pre">SerialDevice</span></tt></a>: Interfaces with the <a class="reference external" href="http://www.alarmdecoder.com">AD2USB</a>, <a class="reference external" href="http://www.alarmdecoder.com">AD2SERIAL</a> or <a class="reference external" href="http://www.alarmdecoder.com">AD2PI</a>.</li>
@@ -430,7 +430,7 @@ Also supports SSL if using <a class="reference external" href="http://github.com
 <dt id="alarmdecoder.devices.Device">
 <em class="property">class </em><tt class="descclassname">alarmdecoder.devices.</tt><tt class="descname">Device</tt><a class="reference internal" href="_modules/alarmdecoder/devices.html#Device"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.devices.Device" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
-<p>Base class for all <a class="reference external" href="http://www.alarmdecoder.com">Alarm Decoder</a> (AD2) device types.</p>
+<p>Base class for all <a class="reference external" href="http://www.alarmdecoder.com">AlarmDecoder</a> (AD2) device types.</p>
 <dl class="attribute">
 <dt id="alarmdecoder.devices.Device.on_open">
 <tt class="descname">on_open</tt><a class="headerlink" href="#alarmdecoder.devices.Device.on_open" title="Permalink to this definition">¶</a></dt>
@@ -919,7 +919,7 @@ reading.</li>
 <dt id="alarmdecoder.devices.SocketDevice">
 <em class="property">class </em><tt class="descclassname">alarmdecoder.devices.</tt><tt class="descname">SocketDevice</tt><big>(</big><em>interface=('localhost'</em>, <em>10000)</em><big>)</big><a class="reference internal" href="_modules/alarmdecoder/devices.html#SocketDevice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.devices.SocketDevice" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="#alarmdecoder.devices.Device" title="alarmdecoder.devices.Device"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.devices.Device</span></tt></a></p>
-<p>Device that supports communication with an <a class="reference external" href="http://www.alarmdecoder.com">Alarm Decoder</a> (AD2) that is
+<p>Device that supports communication with an <a class="reference external" href="http://www.alarmdecoder.com">AlarmDecoder</a> (AD2) that is
 exposed via <a class="reference external" href="http://github.com/nutechsoftware/ser2sock">ser2sock</a> or another Serial to IP interface.</p>
 <dl class="attribute">
 <dt id="alarmdecoder.devices.SocketDevice.interface">
@@ -1084,7 +1084,7 @@ reading.</li>
 </div>
 <div class="section" id="module-alarmdecoder.messages">
 <span id="messages-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">messages</span></tt> Module<a class="headerlink" href="#module-alarmdecoder.messages" title="Permalink to this headline">¶</a></h2>
-<p>Message representations received from the panel through the <a class="reference external" href="http://www.alarmdecoder.com">Alarm Decoder</a> (AD2)
+<p>Message representations received from the panel through the <a class="reference external" href="http://www.alarmdecoder.com">AlarmDecoder</a> (AD2)
 devices.</p>
 <ul class="simple">
 <li><a class="reference internal" href="#alarmdecoder.messages.Message" title="alarmdecoder.messages.Message"><tt class="xref py py-class docutils literal"><span class="pre">Message</span></tt></a>: The standard and most common message received from a panel.</li>
@@ -1352,7 +1352,7 @@ devices.</p>
 </div>
 <div class="section" id="module-alarmdecoder.zonetracking">
 <span id="zonetracking-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">zonetracking</span></tt> Module<a class="headerlink" href="#module-alarmdecoder.zonetracking" title="Permalink to this headline">¶</a></h2>
-<p>Provides zone tracking functionality for the <a class="reference external" href="http://www.alarmdecoder.com">Alarm Decoder</a> (AD2) device family.</p>
+<p>Provides zone tracking functionality for the <a class="reference external" href="http://www.alarmdecoder.com">AlarmDecoder</a> (AD2) device family.</p>
 <dl class="class">
 <dt id="alarmdecoder.zonetracking.Zone">
 <em class="property">class </em><tt class="descclassname">alarmdecoder.zonetracking.</tt><tt class="descname">Zone</tt><big>(</big><em>zone=0</em>, <em>name=''</em>, <em>status=0</em><big>)</big><a class="reference internal" href="_modules/alarmdecoder/zonetracking.html#Zone"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.zonetracking.Zone" title="Permalink to this definition">¶</a></dt>
@@ -1500,7 +1500,7 @@ devices.</p>
 </div>
 <div class="section" id="module-alarmdecoder.util">
 <span id="util-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">util</span></tt> Module<a class="headerlink" href="#module-alarmdecoder.util" title="Permalink to this headline">¶</a></h2>
-<p>Provides utility classes for the <a class="reference external" href="http://www.alarmdecoder.com">Alarm Decoder</a> (AD2) devices.</p>
+<p>Provides utility classes for the <a class="reference external" href="http://www.alarmdecoder.com">AlarmDecoder</a> (AD2) devices.</p>
 <dl class="exception">
 <dt id="alarmdecoder.util.NoDeviceError">
 <em class="property">exception </em><tt class="descclassname">alarmdecoder.util.</tt><tt class="descname">NoDeviceError</tt><a class="reference internal" href="_modules/alarmdecoder/util.html#NoDeviceError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.util.NoDeviceError" title="Permalink to this definition">¶</a></dt>
@@ -1533,7 +1533,7 @@ devices.</p>
 <dt id="alarmdecoder.util.Firmware">
 <em class="property">class </em><tt class="descclassname">alarmdecoder.util.</tt><tt class="descname">Firmware</tt><a class="reference internal" href="_modules/alarmdecoder/util.html#Firmware"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.util.Firmware" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
-<p>Represents firmware for the Alarm Decoder devices.</p>
+<p>Represents firmware for the <a class="reference external" href="http://www.alarmdecoder.com">AlarmDecoder</a> devices.</p>
 <dl class="attribute">
 <dt id="alarmdecoder.util.Firmware.STAGE_START">
 <tt class="descname">STAGE_START</tt><em class="property"> = 0</em><a class="headerlink" href="#alarmdecoder.util.Firmware.STAGE_START" title="Permalink to this definition">¶</a></dt>
@@ -1567,7 +1567,7 @@ devices.</p>
 <dl class="staticmethod">
 <dt id="alarmdecoder.util.Firmware.upload">
 <em class="property">static </em><tt class="descname">upload</tt><big>(</big><em>dev</em>, <em>filename</em>, <em>progress_callback=None</em><big>)</big><a class="reference internal" href="_modules/alarmdecoder/util.html#Firmware.upload"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.util.Firmware.upload" title="Permalink to this definition">¶</a></dt>
-<dd><p>Uploads firmware to an <a class="reference external" href="http://www.alarmdecoder.com">Alarm Decoder</a> device.</p>
+<dd><p>Uploads firmware to an <a class="reference external" href="http://www.alarmdecoder.com">AlarmDecoder</a> device.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />

docs/index.rst

@@ -4,7 +4,7 @@
    contain the root `toctree` directive.
 
 Welcome to Alarm Decoder's documentation!
-========================================
+=========================================
 
 .. _Alarm Decoder: http://www.alarmdecoder.com
 .. _examples: http://github.com/nutechsoftware/alarmdecoder/tree/master/examples

examples/alarm_email.py

@@ -5,7 +5,7 @@ from alarmdecoder import AlarmDecoder
 from alarmdecoder.devices import USBDevice
 
 # Configuration values
-SUBJECT = "Alarm Decoder - ALARM"
+SUBJECT = "AlarmDecoder - ALARM"
 FROM_ADDRESS = "root@localhost"
 TO_ADDRESS = "root@localhost"       # NOTE: Sending an SMS is as easy as looking
                                     # up the email address format for your provider.

examples/virtual_zone_expander.py

@@ -12,7 +12,7 @@ def main():
     restores it.
 
     This is an advanced feature that allows you to emulate a virtual zone.  When
-    the Alarm Decoder is configured to emulate a zone expander we can fault and
+    the AlarmDecoder is configured to emulate a zone expander we can fault and
     restore those zones programmatically at will. These events can also be seen by
     others, such as home automation platforms which allows you to connect other
     devices or services and monitor them as you would any pyhysical zone.
@@ -22,7 +22,7 @@ def main():
 
     In order for this to happen you need to perform a couple configuration steps:
 
-    1. Enable zone expander emulation on your Alarm Decoder device by hitting '!'
+    1. Enable zone expander emulation on your AlarmDecoder device by hitting '!'
        in a terminal and going through the prompts.
     2. Enable the zone expander in your panel programming.
     """

setup.py

@@ -10,7 +10,7 @@ def readme():
 
 setup(name='alarmdecoder',
     version='0.5',
-    description='Python interface library for the Alarm Decoder (AD2) family '
+    description='Python interface library for the AlarmDecoder (AD2) family '
                 'of alarm devices, including: the AD2USB, AD2SERIAL and AD2PI.',
     long_description=readme(),
     classifiers=[