jmg
/
alarmdecoder
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
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.
280 Commits
2 Branches
2.3 MiB
 
Tree: e663d60a37
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'e663d60a37'
${ noResults }
alarmdecoder/docs/build/html/index.html

170 lines
9.1 KiB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  3. 

  4. 

  5. <html xmlns="http://www.w3.org/1999/xhtml">

  6.   <head>

  7.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

  8.     

  9.     <title>Welcome to Alarm Decoder’s documentation! &mdash; alarmdecoder  documentation</title>

  10.     

  11.     <link rel="stylesheet" href="_static/default.css" type="text/css" />

  12.     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />

  13.     

  14.     <script type="text/javascript">

  15.       var DOCUMENTATION_OPTIONS = {

  16.         URL_ROOT:    './',

  17.         VERSION:     '',

  18.         COLLAPSE_INDEX: false,

  19.         FILE_SUFFIX: '.html',

  20.         HAS_SOURCE:  true

  21.       };

  22.     </script>

  23.     <script type="text/javascript" src="_static/jquery.js"></script>

  24.     <script type="text/javascript" src="_static/underscore.js"></script>

  25.     <script type="text/javascript" src="_static/doctools.js"></script>

  26.     <link rel="top" title="alarmdecoder  documentation" href="#" />

  27.     <link rel="next" title="alarmdecoder Package" href="alarmdecoder.html" /> 

  28.   </head>

  29.   <body>

  30.     <div class="related">

  31.       <h3>Navigation</h3>

  32.       <ul>

  33.         <li class="right" style="margin-right: 10px">

  34.           <a href="genindex.html" title="General Index"

  35.              accesskey="I">index</a></li>

  36.         <li class="right" >

  37.           <a href="py-modindex.html" title="Python Module Index"

  38.              >modules</a> |</li>

  39.         <li class="right" >

  40.           <a href="alarmdecoder.html" title="alarmdecoder Package"

  41.              accesskey="N">next</a> |</li>

  42.         <li><a href="#">alarmdecoder  documentation</a> &raquo;</li> 

  43.       </ul>

  44.     </div>  

  45. 

  46.     <div class="document">

  47.       <div class="documentwrapper">

  48.         <div class="bodywrapper">

  49.           <div class="body">

  50.             

  51.   <div class="section" id="welcome-to-alarm-decoder-s-documentation">

  52. <h1>Welcome to Alarm Decoder&#8217;s documentation!<a class="headerlink" href="#welcome-to-alarm-decoder-s-documentation" title="Permalink to this headline">¶</a></h1>

  53. <p>This is the API documentation for the <a class="reference external" href="http://www.alarmdecoder.com">Alarm Decoder</a> Python library.  It provides support for interacting with the <a class="reference external" href="http://www.alarmdecoder.com">Alarm Decoder</a> (AD2) family of security alarm devices, including the AD2USB, AD2SERIAL and AD2PI.</p>

  54. <p>The source code, requirements and examples for this project may be found <a class="reference external" href="http://github.com/nutechsoftware/alarmdecoder">here</a>.</p>

  55. <p>Please see the <a class="reference external" href="http://github.com/nutechsoftware/alarmdecoder/tree/master/examples">examples</a> directory for more samples, but a basic one is included below:</p>

  56. <div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">time</span>

  57. <span class="kn">from</span> <span class="nn">alarmdecoder</span> <span class="kn">import</span> <span class="n">AlarmDecoder</span>

  58. <span class="kn">from</span> <span class="nn">alarmdecoder.devices</span> <span class="kn">import</span> <span class="n">USBDevice</span>

  59. 

  60. <span class="k">def</span> <span class="nf">main</span><span class="p">():</span>

  61.     <span class="sd">&quot;&quot;&quot;</span>

  62. <span class="sd">    Example application that prints messages from the panel to the terminal.</span>

  63. <span class="sd">    &quot;&quot;&quot;</span>

  64.     <span class="k">try</span><span class="p">:</span>

  65.         <span class="c"># Retrieve the first USB device</span>

  66.         <span class="n">device</span> <span class="o">=</span> <span class="n">AlarmDecoder</span><span class="p">(</span><span class="n">USBDevice</span><span class="o">.</span><span class="n">find</span><span class="p">())</span>

  67. 

  68.         <span class="c"># Set up an event handler and open the device</span>

  69.         <span class="n">device</span><span class="o">.</span><span class="n">on_message</span> <span class="o">+=</span> <span class="n">handle_message</span>

  70.         <span class="k">with</span> <span class="n">device</span><span class="o">.</span><span class="n">open</span><span class="p">():</span>

  71.             <span class="k">while</span> <span class="bp">True</span><span class="p">:</span>

  72.                 <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>

  73. 

  74.     <span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span> <span class="n">ex</span><span class="p">:</span>

  75.         <span class="k">print</span> <span class="s">&#39;Exception:&#39;</span><span class="p">,</span> <span class="n">ex</span>

  76. 

  77. <span class="k">def</span> <span class="nf">handle_message</span><span class="p">(</span><span class="n">sender</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span>

  78.     <span class="sd">&quot;&quot;&quot;</span>

  79. <span class="sd">    Handles message events from the AlarmDecoder.</span>

  80. <span class="sd">    &quot;&quot;&quot;</span>

  81.     <span class="k">print</span> <span class="n">sender</span><span class="p">,</span> <span class="n">message</span><span class="o">.</span><span class="n">raw</span>

  82. 

  83. <span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">&#39;__main__&#39;</span><span class="p">:</span>

  84.     <span class="n">main</span><span class="p">()</span>

  85. </pre></div>

  86. </div>

  87. <p>Table of Contents:</p>

  88. <div class="toctree-wrapper compound">

  89. <ul>

  90. <li class="toctree-l1"><a class="reference internal" href="alarmdecoder.html">alarmdecoder Package</a><ul>

  91. <li class="toctree-l2"><a class="reference internal" href="alarmdecoder.html#module-alarmdecoder.decoder"><tt class="docutils literal"><span class="pre">decoder</span></tt> Module</a></li>

  92. <li class="toctree-l2"><a class="reference internal" href="alarmdecoder.html#module-alarmdecoder.devices"><tt class="docutils literal"><span class="pre">devices</span></tt> Module</a></li>

  93. <li class="toctree-l2"><a class="reference internal" href="alarmdecoder.html#module-alarmdecoder.messages"><tt class="docutils literal"><span class="pre">messages</span></tt> Module</a></li>

  94. <li class="toctree-l2"><a class="reference internal" href="alarmdecoder.html#module-alarmdecoder.zonetracking"><tt class="docutils literal"><span class="pre">zonetracking</span></tt> Module</a></li>

  95. <li class="toctree-l2"><a class="reference internal" href="alarmdecoder.html#module-alarmdecoder.util"><tt class="docutils literal"><span class="pre">util</span></tt> Module</a></li>

  96. <li class="toctree-l2"><a class="reference internal" href="alarmdecoder.html#module-alarmdecoder.panels"><tt class="docutils literal"><span class="pre">panels</span></tt> Module</a></li>

  97. </ul>

  98. </li>

  99. </ul>

  100. </div>

  101. </div>

  102. <div class="section" id="indices-and-tables">

  103. <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>

  104. <ul class="simple">

  105. <li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>

  106. <li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>

  107. <li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>

  108. </ul>

  109. </div>

  110. 

  111. 

  112.           </div>

  113.         </div>

  114.       </div>

  115.       <div class="sphinxsidebar">

  116.         <div class="sphinxsidebarwrapper">

  117.   <h3><a href="#">Table Of Contents</a></h3>

  118.   <ul>

  119. <li><a class="reference internal" href="#">Welcome to Alarm Decoder&#8217;s documentation!</a><ul>

  120. </ul>

  121. </li>

  122. <li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>

  123. </ul>

  124. 

  125.   <h4>Next topic</h4>

  126.   <p class="topless"><a href="alarmdecoder.html"

  127.                         title="next chapter">alarmdecoder Package</a></p>

  128.   <h3>This Page</h3>

  129.   <ul class="this-page-menu">

  130.     <li><a href="_sources/index.txt"

  131.            rel="nofollow">Show Source</a></li>

  132.   </ul>

  133. <div id="searchbox" style="display: none">

  134.   <h3>Quick search</h3>

  135.     <form class="search" action="search.html" method="get">

  136.       <input type="text" name="q" />

  137.       <input type="submit" value="Go" />

  138.       <input type="hidden" name="check_keywords" value="yes" />

  139.       <input type="hidden" name="area" value="default" />

  140.     </form>

  141.     <p class="searchtip" style="font-size: 90%">

  142.     Enter search terms or a module, class or function name.

  143.     </p>

  144. </div>

  145. <script type="text/javascript">$('#searchbox').show(0);</script>

  146.         </div>

  147.       </div>

  148.       <div class="clearer"></div>

  149.     </div>

  150.     <div class="related">

  151.       <h3>Navigation</h3>

  152.       <ul>

  153.         <li class="right" style="margin-right: 10px">

  154.           <a href="genindex.html" title="General Index"

  155.              >index</a></li>

  156.         <li class="right" >

  157.           <a href="py-modindex.html" title="Python Module Index"

  158.              >modules</a> |</li>

  159.         <li class="right" >

  160.           <a href="alarmdecoder.html" title="alarmdecoder Package"

  161.              >next</a> |</li>

  162.         <li><a href="#">alarmdecoder  documentation</a> &raquo;</li> 

  163.       </ul>

  164.     </div>

  165.     <div class="footer">

  166.         &copy; Copyright 2013, Nu Tech Software Solutions, Inc..

  167.       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.

  168.     </div>

  169.   </body>

  170. </html>