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.
136 Commits
2 Branches
2.3 MiB
 
Tree: 4328382492
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '4328382492'
${ noResults }
alarmdecoder/docs/_build/html/_modules/pyad2usb/zonetracking.html

368 lines
33 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>pyad2usb.zonetracking &mdash; pyad2usb  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="pyad2usb  documentation" href="../../index.html" />

  27.     <link rel="up" title="Module code" href="../index.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><a href="../../index.html">pyad2usb  documentation</a> &raquo;</li>

  40.           <li><a href="../index.html" accesskey="U">Module code</a> &raquo;</li> 

  41.       </ul>

  42.     </div>  

  43. 

  44.     <div class="document">

  45.       <div class="documentwrapper">

  46.         <div class="bodywrapper">

  47.           <div class="body">

  48.             

  49.   <h1>Source code for pyad2usb.zonetracking</h1><div class="highlight"><pre>

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

  51. <span class="sd">Provides zone tracking functionality for the AD2USB device family.</span>

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

  53. 

  54. <span class="kn">import</span> <span class="nn">time</span>

  55. <span class="kn">from</span> <span class="nn">.event</span> <span class="kn">import</span> <span class="n">event</span>

  56. <span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">messages</span>

  57. 

  58. <div class="viewcode-block" id="Zone"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.zonetracking.Zone">[docs]</a><span class="k">class</span> <span class="nc">Zone</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>

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

  60. <span class="sd">    Representation of a panel zone.</span>

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

  62. 

  63.     <span class="n">CLEAR</span> <span class="o">=</span> <span class="mi">0</span>

  64.     <span class="sd">&quot;&quot;&quot;Status indicating that the zone is cleared.&quot;&quot;&quot;</span>

  65.     <span class="n">FAULT</span> <span class="o">=</span> <span class="mi">1</span>

  66.     <span class="sd">&quot;&quot;&quot;Status indicating that the zone is faulted.&quot;&quot;&quot;</span>

  67.     <span class="n">CHECK</span> <span class="o">=</span> <span class="mi">2</span>   <span class="c"># Wire fault</span>

  68.     <span class="sd">&quot;&quot;&quot;Status indicating that there is a wiring issue with the zone.&quot;&quot;&quot;</span>

  69. 

  70.     <span class="n">STATUS</span> <span class="o">=</span> <span class="p">{</span> <span class="n">CLEAR</span><span class="p">:</span> <span class="s">&#39;CLEAR&#39;</span><span class="p">,</span> <span class="n">FAULT</span><span class="p">:</span> <span class="s">&#39;FAULT&#39;</span><span class="p">,</span> <span class="n">CHECK</span><span class="p">:</span> <span class="s">&#39;CHECK&#39;</span> <span class="p">}</span>

  71. 

  72.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">zone</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="n">status</span><span class="o">=</span><span class="n">CLEAR</span><span class="p">):</span>

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

  74. <span class="sd">        Constructor</span>

  75. 

  76. <span class="sd">        :param zone: The zone number.</span>

  77. <span class="sd">        :type zone: int</span>

  78. <span class="sd">        :param name: Human readable zone name.</span>

  79. <span class="sd">        :type name: str</span>

  80. <span class="sd">        :param status: Initial zone state.</span>

  81. <span class="sd">        :type status: int</span>

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

  83.         <span class="bp">self</span><span class="o">.</span><span class="n">zone</span> <span class="o">=</span> <span class="n">zone</span>

  84.         <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>

  85.         <span class="bp">self</span><span class="o">.</span><span class="n">status</span> <span class="o">=</span> <span class="n">status</span>

  86.         <span class="bp">self</span><span class="o">.</span><span class="n">timestamp</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>

  87. 

  88.     <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

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

  90. <span class="sd">        String conversion operator.</span>

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

  92.         <span class="k">return</span> <span class="s">&#39;Zone {0} {1}&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">zone</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>

  93. 

  94.     <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

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

  96. <span class="sd">        Human readable representation operator.</span>

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

  98.         <span class="k">return</span> <span class="s">&#39;Zone({0}, {1}, ts {2})&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">zone</span><span class="p">,</span> <span class="n">Zone</span><span class="o">.</span><span class="n">STATUS</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">status</span><span class="p">],</span> <span class="bp">self</span><span class="o">.</span><span class="n">timestamp</span><span class="p">)</span>

  99. </div>

  100. <div class="viewcode-block" id="Zonetracker"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.zonetracking.Zonetracker">[docs]</a><span class="k">class</span> <span class="nc">Zonetracker</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>

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

  102. <span class="sd">    Handles tracking of zone and their statuses.</span>

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

  104. 

  105.     <span class="n">on_fault</span> <span class="o">=</span> <span class="n">event</span><span class="o">.</span><span class="n">Event</span><span class="p">(</span><span class="s">&#39;Called when the device detects a zone fault.&#39;</span><span class="p">)</span>

  106.     <span class="n">on_restore</span> <span class="o">=</span> <span class="n">event</span><span class="o">.</span><span class="n">Event</span><span class="p">(</span><span class="s">&#39;Called when the device detects that a fault is restored.&#39;</span><span class="p">)</span>

  107. 

  108.     <span class="n">EXPIRE</span> <span class="o">=</span> <span class="mi">30</span>

  109.     <span class="sd">&quot;&quot;&quot;Zone expiration timeout.&quot;&quot;&quot;</span>

  110. 

  111.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

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

  113. <span class="sd">        Constructor</span>

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

  115.         <span class="bp">self</span><span class="o">.</span><span class="n">_zones</span> <span class="o">=</span> <span class="p">{}</span>

  116.         <span class="bp">self</span><span class="o">.</span><span class="n">_zones_faulted</span> <span class="o">=</span> <span class="p">[]</span>

  117.         <span class="bp">self</span><span class="o">.</span><span class="n">_last_zone_fault</span> <span class="o">=</span> <span class="mi">0</span>

  118. 

  119. <div class="viewcode-block" id="Zonetracker.update"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.zonetracking.Zonetracker.update">[docs]</a>    <span class="k">def</span> <span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span>

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

  121. <span class="sd">        Update zone statuses based on the current message.</span>

  122. 

  123. <span class="sd">        :param message: Message to use to update the zone tracking.</span>

  124. <span class="sd">        :type message: Message or ExpanderMessage</span>

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

  126.         <span class="n">zone</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>

  127. 

  128.         <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">messages</span><span class="o">.</span><span class="n">ExpanderMessage</span><span class="p">):</span>

  129.             <span class="k">if</span> <span class="n">message</span><span class="o">.</span><span class="n">type</span> <span class="o">==</span> <span class="n">messages</span><span class="o">.</span><span class="n">ExpanderMessage</span><span class="o">.</span><span class="n">ZONE</span><span class="p">:</span>

  130.                 <span class="n">zone</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_expander_to_zone</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">address</span><span class="p">),</span> <span class="nb">int</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">channel</span><span class="p">))</span>

  131. 

  132.                 <span class="n">status</span> <span class="o">=</span> <span class="n">Zone</span><span class="o">.</span><span class="n">CLEAR</span>

  133.                 <span class="k">if</span> <span class="nb">int</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">value</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>

  134.                     <span class="n">status</span> <span class="o">=</span> <span class="n">Zone</span><span class="o">.</span><span class="n">FAULT</span>

  135.                 <span class="k">elif</span> <span class="nb">int</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">value</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>

  136.                     <span class="n">status</span> <span class="o">=</span> <span class="n">Zone</span><span class="o">.</span><span class="n">CHECK</span>

  137. 

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

  139.                     <span class="bp">self</span><span class="o">.</span><span class="n">_update_zone</span><span class="p">(</span><span class="n">zone</span><span class="p">,</span> <span class="n">status</span><span class="o">=</span><span class="n">status</span><span class="p">)</span>

  140.                 <span class="k">except</span> <span class="ne">IndexError</span><span class="p">:</span>

  141.                     <span class="bp">self</span><span class="o">.</span><span class="n">_add_zone</span><span class="p">(</span><span class="n">zone</span><span class="p">,</span> <span class="n">status</span><span class="o">=</span><span class="n">status</span><span class="p">)</span>

  142. 

  143.         <span class="k">else</span><span class="p">:</span>

  144.             <span class="c"># Panel is ready, restore all zones.</span>

  145.             <span class="k">if</span> <span class="n">message</span><span class="o">.</span><span class="n">ready</span><span class="p">:</span>

  146.                 <span class="k">for</span> <span class="n">idx</span><span class="p">,</span> <span class="n">z</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_zones_faulted</span><span class="p">):</span>

  147.                     <span class="bp">self</span><span class="o">.</span><span class="n">_update_zone</span><span class="p">(</span><span class="n">z</span><span class="p">,</span> <span class="n">Zone</span><span class="o">.</span><span class="n">CLEAR</span><span class="p">)</span>

  148. 

  149.                 <span class="bp">self</span><span class="o">.</span><span class="n">_last_zone_fault</span> <span class="o">=</span> <span class="mi">0</span>

  150. 

  151.             <span class="c"># Process fault</span>

  152.             <span class="k">elif</span> <span class="s">&quot;FAULT&quot;</span> <span class="ow">in</span> <span class="n">message</span><span class="o">.</span><span class="n">text</span> <span class="ow">or</span> <span class="n">message</span><span class="o">.</span><span class="n">check_zone</span><span class="p">:</span>

  153.                 <span class="c"># Apparently this representation can be both base 10</span>

  154.                 <span class="c"># or base 16, depending on where the message came</span>

  155.                 <span class="c"># from.</span>

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

  157.                     <span class="n">zone</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">numeric_code</span><span class="p">)</span>

  158.                 <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>

  159.                     <span class="n">zone</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">numeric_code</span><span class="p">,</span> <span class="mi">16</span><span class="p">)</span>

  160. 

  161.                 <span class="c"># Add new zones and clear expired ones.</span>

  162.                 <span class="k">if</span> <span class="n">zone</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_zones_faulted</span><span class="p">:</span>

  163.                     <span class="bp">self</span><span class="o">.</span><span class="n">_update_zone</span><span class="p">(</span><span class="n">zone</span><span class="p">)</span>

  164.                     <span class="bp">self</span><span class="o">.</span><span class="n">_clear_zones</span><span class="p">(</span><span class="n">zone</span><span class="p">)</span>

  165.                 <span class="k">else</span><span class="p">:</span>

  166.                     <span class="n">status</span> <span class="o">=</span> <span class="n">Zone</span><span class="o">.</span><span class="n">FAULT</span>

  167.                     <span class="k">if</span> <span class="n">message</span><span class="o">.</span><span class="n">check_zone</span><span class="p">:</span>

  168.                         <span class="n">status</span> <span class="o">=</span> <span class="n">Zone</span><span class="o">.</span><span class="n">CHECK</span>

  169. 

  170.                     <span class="bp">self</span><span class="o">.</span><span class="n">_add_zone</span><span class="p">(</span><span class="n">zone</span><span class="p">,</span> <span class="n">status</span><span class="o">=</span><span class="n">status</span><span class="p">)</span>

  171.                     <span class="bp">self</span><span class="o">.</span><span class="n">_zones_faulted</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">zone</span><span class="p">)</span>

  172.                     <span class="bp">self</span><span class="o">.</span><span class="n">_zones_faulted</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span>

  173. 

  174.                 <span class="c"># Save our spot for the next message.</span>

  175.                 <span class="bp">self</span><span class="o">.</span><span class="n">_last_zone_fault</span> <span class="o">=</span> <span class="n">zone</span>

  176. 

  177.             <span class="bp">self</span><span class="o">.</span><span class="n">_clear_expired_zones</span><span class="p">()</span>

  178. </div>

  179.     <span class="k">def</span> <span class="nf">_clear_zones</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">zone</span><span class="p">):</span>

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

  181. <span class="sd">        Clear all expired zones from our status list.</span>

  182. 

  183. <span class="sd">        :param zone: current zone being processed.</span>

  184. <span class="sd">        :type zone: int</span>

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

  186.         <span class="n">cleared_zones</span> <span class="o">=</span> <span class="p">[]</span>

  187.         <span class="n">found_last</span> <span class="o">=</span> <span class="n">found_new</span> <span class="o">=</span> <span class="n">at_end</span> <span class="o">=</span> <span class="bp">False</span>

  188. 

  189.         <span class="c"># First pass: Find our start spot.</span>

  190.         <span class="n">it</span> <span class="o">=</span> <span class="nb">iter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_zones_faulted</span><span class="p">)</span>

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

  192.             <span class="k">while</span> <span class="ow">not</span> <span class="n">found_last</span><span class="p">:</span>

  193.                 <span class="n">z</span> <span class="o">=</span> <span class="n">it</span><span class="o">.</span><span class="n">next</span><span class="p">()</span>

  194. 

  195.                 <span class="k">if</span> <span class="n">z</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_zone_fault</span><span class="p">:</span>

  196.                     <span class="n">found_last</span> <span class="o">=</span> <span class="bp">True</span>

  197.                     <span class="k">break</span>

  198. 

  199.         <span class="k">except</span> <span class="ne">StopIteration</span><span class="p">:</span>

  200.             <span class="n">at_end</span> <span class="o">=</span> <span class="bp">True</span>

  201. 

  202.         <span class="c"># Continue until we find our end point and add zones in</span>

  203.         <span class="c"># between to our clear list.</span>

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

  205.             <span class="k">while</span> <span class="ow">not</span> <span class="n">at_end</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">found_new</span><span class="p">:</span>

  206.                 <span class="n">z</span> <span class="o">=</span> <span class="n">it</span><span class="o">.</span><span class="n">next</span><span class="p">()</span>

  207. 

  208.                 <span class="k">if</span> <span class="n">z</span> <span class="o">==</span> <span class="n">zone</span><span class="p">:</span>

  209.                     <span class="n">found_new</span> <span class="o">=</span> <span class="bp">True</span>

  210.                     <span class="k">break</span>

  211.                 <span class="k">else</span><span class="p">:</span>

  212.                     <span class="n">cleared_zones</span> <span class="o">+=</span> <span class="p">[</span><span class="n">z</span><span class="p">]</span>

  213. 

  214.         <span class="k">except</span> <span class="ne">StopIteration</span><span class="p">:</span>

  215.             <span class="k">pass</span>

  216. 

  217.         <span class="c"># Second pass: roll through the list again if we didn&#39;t find</span>

  218.         <span class="c"># our end point and remove everything until we do.</span>

  219.         <span class="k">if</span> <span class="ow">not</span> <span class="n">found_new</span><span class="p">:</span>

  220.             <span class="n">it</span> <span class="o">=</span> <span class="nb">iter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_zones_faulted</span><span class="p">)</span>

  221. 

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

  223.                 <span class="k">while</span> <span class="ow">not</span> <span class="n">found_new</span><span class="p">:</span>

  224.                     <span class="n">z</span> <span class="o">=</span> <span class="n">it</span><span class="o">.</span><span class="n">next</span><span class="p">()</span>

  225. 

  226.                     <span class="k">if</span> <span class="n">z</span> <span class="o">==</span> <span class="n">zone</span><span class="p">:</span>

  227.                         <span class="n">found_new</span> <span class="o">=</span> <span class="bp">True</span>

  228.                         <span class="k">break</span>

  229.                     <span class="k">else</span><span class="p">:</span>

  230.                         <span class="n">cleared_zones</span> <span class="o">+=</span> <span class="p">[</span><span class="n">z</span><span class="p">]</span>

  231. 

  232.             <span class="k">except</span> <span class="ne">StopIteration</span><span class="p">:</span>

  233.                 <span class="k">pass</span>

  234. 

  235.         <span class="c"># Actually remove the zones and trigger the restores.</span>

  236.         <span class="k">for</span> <span class="n">idx</span><span class="p">,</span> <span class="n">z</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">cleared_zones</span><span class="p">):</span>

  237.             <span class="bp">self</span><span class="o">.</span><span class="n">_update_zone</span><span class="p">(</span><span class="n">z</span><span class="p">,</span> <span class="n">Zone</span><span class="o">.</span><span class="n">CLEAR</span><span class="p">)</span>

  238. 

  239.     <span class="k">def</span> <span class="nf">_clear_expired_zones</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

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

  241. <span class="sd">        Update zone status for all expired zones.</span>

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

  243.         <span class="n">zones</span> <span class="o">=</span> <span class="p">[]</span>

  244. 

  245.         <span class="k">for</span> <span class="n">z</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_zones</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>

  246.             <span class="n">zones</span> <span class="o">+=</span> <span class="p">[</span><span class="n">z</span><span class="p">]</span>

  247. 

  248.         <span class="k">for</span> <span class="n">z</span> <span class="ow">in</span> <span class="n">zones</span><span class="p">:</span>

  249.             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_zones</span><span class="p">[</span><span class="n">z</span><span class="p">]</span><span class="o">.</span><span class="n">status</span> <span class="o">!=</span> <span class="n">Zone</span><span class="o">.</span><span class="n">CLEAR</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_zone_expired</span><span class="p">(</span><span class="n">z</span><span class="p">):</span>

  250.                 <span class="bp">self</span><span class="o">.</span><span class="n">_update_zone</span><span class="p">(</span><span class="n">z</span><span class="p">,</span> <span class="n">Zone</span><span class="o">.</span><span class="n">CLEAR</span><span class="p">)</span>

  251. 

  252.     <span class="k">def</span> <span class="nf">_add_zone</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">zone</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="n">status</span><span class="o">=</span><span class="n">Zone</span><span class="o">.</span><span class="n">CLEAR</span><span class="p">):</span>

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

  254. <span class="sd">        Adds a zone to the internal zone list.</span>

  255. 

  256. <span class="sd">        :param zone: The zone number.</span>

  257. <span class="sd">        :type zone: int</span>

  258. <span class="sd">        :param name: Human readable zone name.</span>

  259. <span class="sd">        :type name: str</span>

  260. <span class="sd">        :param status: The zone status.</span>

  261. <span class="sd">        :type status: int</span>

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

  263.         <span class="k">if</span> <span class="ow">not</span> <span class="n">zone</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_zones</span><span class="p">:</span>

  264.             <span class="bp">self</span><span class="o">.</span><span class="n">_zones</span><span class="p">[</span><span class="n">zone</span><span class="p">]</span> <span class="o">=</span> <span class="n">Zone</span><span class="p">(</span><span class="n">zone</span><span class="o">=</span><span class="n">zone</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> <span class="n">status</span><span class="o">=</span><span class="n">status</span><span class="p">)</span>

  265. 

  266.         <span class="k">if</span> <span class="n">status</span> <span class="o">!=</span> <span class="n">Zone</span><span class="o">.</span><span class="n">CLEAR</span><span class="p">:</span>

  267.             <span class="bp">self</span><span class="o">.</span><span class="n">on_fault</span><span class="p">(</span><span class="n">zone</span><span class="p">)</span>

  268. 

  269.     <span class="k">def</span> <span class="nf">_update_zone</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">zone</span><span class="p">,</span> <span class="n">status</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>

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

  271. <span class="sd">        Updates a zones status.</span>

  272. 

  273. <span class="sd">        :param zone: The zone number.</span>

  274. <span class="sd">        :type zone: int</span>

  275. <span class="sd">        :param status: The zone status.</span>

  276. <span class="sd">        :type status: int</span>

  277. 

  278. <span class="sd">        :raises: IndexError</span>

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

  280.         <span class="k">if</span> <span class="ow">not</span> <span class="n">zone</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_zones</span><span class="p">:</span>

  281.             <span class="k">raise</span> <span class="ne">IndexError</span><span class="p">(</span><span class="s">&#39;Zone does not exist and cannot be updated: </span><span class="si">%d</span><span class="s">&#39;</span><span class="p">,</span> <span class="n">zone</span><span class="p">)</span>

  282. 

  283.         <span class="k">if</span> <span class="n">status</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>

  284.             <span class="bp">self</span><span class="o">.</span><span class="n">_zones</span><span class="p">[</span><span class="n">zone</span><span class="p">]</span><span class="o">.</span><span class="n">status</span> <span class="o">=</span> <span class="n">status</span>

  285. 

  286.         <span class="bp">self</span><span class="o">.</span><span class="n">_zones</span><span class="p">[</span><span class="n">zone</span><span class="p">]</span><span class="o">.</span><span class="n">timestamp</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>

  287. 

  288.         <span class="k">if</span> <span class="n">status</span> <span class="o">==</span> <span class="n">Zone</span><span class="o">.</span><span class="n">CLEAR</span><span class="p">:</span>

  289.             <span class="k">if</span> <span class="n">zone</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_zones_faulted</span><span class="p">:</span>

  290.                 <span class="bp">self</span><span class="o">.</span><span class="n">_zones_faulted</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">zone</span><span class="p">)</span>

  291. 

  292.             <span class="bp">self</span><span class="o">.</span><span class="n">on_restore</span><span class="p">(</span><span class="n">zone</span><span class="p">)</span>

  293. 

  294.     <span class="k">def</span> <span class="nf">_zone_expired</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">zone</span><span class="p">):</span>

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

  296. <span class="sd">        Determine if a zone is expired or not.</span>

  297. 

  298. <span class="sd">        :param zone: The zone number.</span>

  299. <span class="sd">        :type zone: int</span>

  300. 

  301. <span class="sd">        :returns: Whether or not the zone is expired.</span>

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

  303.         <span class="k">if</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">&gt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">_zones</span><span class="p">[</span><span class="n">zone</span><span class="p">]</span><span class="o">.</span><span class="n">timestamp</span> <span class="o">+</span> <span class="n">Zonetracker</span><span class="o">.</span><span class="n">EXPIRE</span><span class="p">:</span>

  304.             <span class="k">return</span> <span class="bp">True</span>

  305. 

  306.         <span class="k">return</span> <span class="bp">False</span>

  307. 

  308.     <span class="k">def</span> <span class="nf">_expander_to_zone</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">address</span><span class="p">,</span> <span class="n">channel</span><span class="p">):</span>

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

  310. <span class="sd">        Convert an address and channel into a zone number.</span>

  311. 

  312. <span class="sd">        :param address: The expander address</span>

  313. <span class="sd">        :type address: int</span>

  314. <span class="sd">        :param channel: The channel</span>

  315. <span class="sd">        :type channel: int</span>

  316. 

  317. <span class="sd">        :returns: The zone number associated with an address and channel.</span>

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

  319. 

  320.         <span class="c"># TODO: This is going to need to be reworked to support the larger</span>

  321.         <span class="c">#       panels without fixed addressing on the expanders.</span>

  322. 

  323.         <span class="n">idx</span> <span class="o">=</span> <span class="n">address</span> <span class="o">-</span> <span class="mi">7</span>   <span class="c"># Expanders start at address 7.</span>

  324. 

  325.         <span class="k">return</span> <span class="n">address</span> <span class="o">+</span> <span class="n">channel</span> <span class="o">+</span> <span class="p">(</span><span class="n">idx</span> <span class="o">*</span> <span class="mi">7</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span></div>

  326. </pre></div>

  327. 

  328.           </div>

  329.         </div>

  330.       </div>

  331.       <div class="sphinxsidebar">

  332.         <div class="sphinxsidebarwrapper">

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

  334.   <h3>Quick search</h3>

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

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

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

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

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

  340.     </form>

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

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

  343.     </p>

  344. </div>

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

  346.         </div>

  347.       </div>

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

  349.     </div>

  350.     <div class="related">

  351.       <h3>Navigation</h3>

  352.       <ul>

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

  354.           <a href="../../genindex.html" title="General Index"

  355.              >index</a></li>

  356.         <li class="right" >

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

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

  359.         <li><a href="../../index.html">pyad2usb  documentation</a> &raquo;</li>

  360.           <li><a href="../index.html" >Module code</a> &raquo;</li> 

  361.       </ul>

  362.     </div>

  363.     <div class="footer">

  364.         &copy; Copyright 2013, Author.

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

  366.     </div>

  367.   </body>

  368. </html>