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/util.html

230 lines
17 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.util &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.util</h1><div class="highlight"><pre>

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

  51. <span class="sd">Provides utility classes for the AD2USB devices.</span>

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

  53. 

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

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

  56. <span class="kn">import</span> <span class="nn">traceback</span>

  57. <span class="kn">import</span> <span class="nn">threading</span>

  58. 

  59. <div class="viewcode-block" id="NoDeviceError"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.util.NoDeviceError">[docs]</a><span class="k">class</span> <span class="nc">NoDeviceError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>

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

  61. <span class="sd">    No devices found.</span>

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

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

  64. </div>

  65. <div class="viewcode-block" id="CommError"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.util.CommError">[docs]</a><span class="k">class</span> <span class="nc">CommError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>

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

  67. <span class="sd">    There was an error communicating with the device.</span>

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

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

  70. </div>

  71. <div class="viewcode-block" id="TimeoutError"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.util.TimeoutError">[docs]</a><span class="k">class</span> <span class="nc">TimeoutError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>

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

  73. <span class="sd">    There was a timeout while trying to communicate with the device.</span>

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

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

  76. </div>

  77. <div class="viewcode-block" id="InvalidMessageError"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.util.InvalidMessageError">[docs]</a><span class="k">class</span> <span class="nc">InvalidMessageError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>

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

  79. <span class="sd">    The format of the panel message was invalid.</span>

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

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

  82. </div>

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

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

  85. <span class="sd">    Represents firmware for the AD2USB/AD2SERIAL devices.</span>

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

  87. 

  88.     <span class="c"># Constants</span>

  89.     <span class="n">STAGE_START</span> <span class="o">=</span> <span class="mi">0</span>

  90.     <span class="n">STAGE_WAITING</span> <span class="o">=</span> <span class="mi">1</span>

  91.     <span class="n">STAGE_BOOT</span> <span class="o">=</span> <span class="mi">2</span>

  92.     <span class="n">STAGE_LOAD</span> <span class="o">=</span> <span class="mi">3</span>

  93.     <span class="n">STAGE_UPLOADING</span> <span class="o">=</span> <span class="mi">4</span>

  94.     <span class="n">STAGE_DONE</span> <span class="o">=</span> <span class="mi">5</span>

  95. 

  96.     <span class="nd">@staticmethod</span>

  97. <div class="viewcode-block" id="Firmware.upload"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.util.Firmware.upload">[docs]</a>    <span class="k">def</span> <span class="nf">upload</span><span class="p">(</span><span class="n">dev</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">progress_callback</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>

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

  99. <span class="sd">        Uploads firmware to an AD2USB/AD2SERIAL device.</span>

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

  101. 

  102.         <span class="k">def</span> <span class="nf">do_upload</span><span class="p">():</span>

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

  104. <span class="sd">            Perform the actual firmware upload to the device.</span>

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

  106.             <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>

  107.                 <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">f</span><span class="p">:</span>

  108.                     <span class="n">line</span> <span class="o">=</span> <span class="n">line</span><span class="o">.</span><span class="n">rstrip</span><span class="p">()</span>

  109. 

  110.                     <span class="k">if</span> <span class="n">line</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s">&#39;:&#39;</span><span class="p">:</span>

  111.                         <span class="n">dev</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">line</span> <span class="o">+</span> <span class="s">&quot;</span><span class="se">\r</span><span class="s">&quot;</span><span class="p">)</span>

  112.                         <span class="n">res</span> <span class="o">=</span> <span class="n">dev</span><span class="o">.</span><span class="n">read_line</span><span class="p">(</span><span class="n">timeout</span><span class="o">=</span><span class="mf">10.0</span><span class="p">)</span>

  113. 

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

  115.                             <span class="n">progress_callback</span><span class="p">(</span><span class="n">Firmware</span><span class="o">.</span><span class="n">STAGE_UPLOADING</span><span class="p">)</span>

  116. 

  117.                         <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mf">0.05</span><span class="p">)</span>

  118. 

  119.         <span class="k">def</span> <span class="nf">read_until</span><span class="p">(</span><span class="n">pattern</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mf">0.0</span><span class="p">):</span>

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

  121. <span class="sd">            Read characters until a specific pattern is found or the timeout is hit.</span>

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

  123.             <span class="k">def</span> <span class="nf">timeout_event</span><span class="p">():</span>

  124.                 <span class="n">timeout_event</span><span class="o">.</span><span class="n">reading</span> <span class="o">=</span> <span class="bp">False</span>

  125. 

  126.             <span class="n">timeout_event</span><span class="o">.</span><span class="n">reading</span> <span class="o">=</span> <span class="bp">True</span>

  127. 

  128.             <span class="n">timer</span> <span class="o">=</span> <span class="bp">None</span>

  129.             <span class="k">if</span> <span class="n">timeout</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>

  130.                 <span class="n">timer</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Timer</span><span class="p">(</span><span class="n">timeout</span><span class="p">,</span> <span class="n">timeout_event</span><span class="p">)</span>

  131.                 <span class="n">timer</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>

  132. 

  133.             <span class="n">buf</span> <span class="o">=</span> <span class="s">&#39;&#39;</span>

  134.             <span class="n">position</span> <span class="o">=</span> <span class="mi">0</span>

  135. 

  136.             <span class="k">while</span> <span class="n">timeout_event</span><span class="o">.</span><span class="n">reading</span><span class="p">:</span>

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

  138.                     <span class="n">char</span> <span class="o">=</span> <span class="n">dev</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>

  139. 

  140.                     <span class="k">if</span> <span class="n">char</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span> <span class="n">char</span> <span class="o">!=</span> <span class="s">&#39;&#39;</span><span class="p">:</span>

  141.                         <span class="k">if</span> <span class="n">char</span> <span class="o">==</span> <span class="n">pattern</span><span class="p">[</span><span class="n">position</span><span class="p">]:</span>

  142.                             <span class="n">position</span> <span class="o">=</span> <span class="n">position</span> <span class="o">+</span> <span class="mi">1</span>

  143.                             <span class="k">if</span> <span class="n">position</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">pattern</span><span class="p">):</span>

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

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

  146.                             <span class="n">position</span> <span class="o">=</span> <span class="mi">0</span>

  147. 

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

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

  150. 

  151.             <span class="k">if</span> <span class="n">timer</span><span class="p">:</span>

  152.                 <span class="k">if</span> <span class="n">timer</span><span class="o">.</span><span class="n">is_alive</span><span class="p">():</span>

  153.                     <span class="n">timer</span><span class="o">.</span><span class="n">cancel</span><span class="p">()</span>

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

  155.                     <span class="k">raise</span> <span class="n">TimeoutError</span><span class="p">(</span><span class="s">&#39;Timeout while waiting for line terminator.&#39;</span><span class="p">)</span>

  156. 

  157.         <span class="k">def</span> <span class="nf">stage_callback</span><span class="p">(</span><span class="n">stage</span><span class="p">):</span>

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

  159.                 <span class="n">progress_callback</span><span class="p">(</span><span class="n">stage</span><span class="p">)</span>

  160. 

  161.         <span class="k">if</span> <span class="n">dev</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>

  162.             <span class="k">raise</span> <span class="n">NoDeviceError</span><span class="p">(</span><span class="s">&#39;No device specified for firmware upload.&#39;</span><span class="p">)</span>

  163. 

  164.         <span class="n">stage_callback</span><span class="p">(</span><span class="n">Firmware</span><span class="o">.</span><span class="n">STAGE_START</span><span class="p">)</span>

  165. 

  166.         <span class="k">if</span> <span class="n">dev</span><span class="o">.</span><span class="n">is_reader_alive</span><span class="p">():</span>

  167.             <span class="c"># Close the reader thread and wait for it to die, otherwise</span>

  168.             <span class="c"># it interferes with our reading.</span>

  169.             <span class="n">dev</span><span class="o">.</span><span class="n">stop_reader</span><span class="p">()</span>

  170.             <span class="k">while</span> <span class="n">dev</span><span class="o">.</span><span class="n">_read_thread</span><span class="o">.</span><span class="n">is_alive</span><span class="p">():</span>

  171.                 <span class="n">stage_callback</span><span class="p">(</span><span class="n">Firmware</span><span class="o">.</span><span class="n">STAGE_WAITING</span><span class="p">)</span>

  172.                 <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>

  173. 

  174.         <span class="c"># Reboot the device and wait for the boot loader.</span>

  175.         <span class="n">stage_callback</span><span class="p">(</span><span class="n">Firmware</span><span class="o">.</span><span class="n">STAGE_BOOT</span><span class="p">)</span>

  176.         <span class="n">dev</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">&quot;=&quot;</span><span class="p">)</span>

  177.         <span class="n">read_until</span><span class="p">(</span><span class="s">&#39;!boot&#39;</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mf">15.0</span><span class="p">)</span>

  178. 

  179.         <span class="c"># Get ourselves into the boot loader and wait for indication</span>

  180.         <span class="c"># that it&#39;s ready for the firmware upload.</span>

  181.         <span class="n">stage_callback</span><span class="p">(</span><span class="n">Firmware</span><span class="o">.</span><span class="n">STAGE_LOAD</span><span class="p">)</span>

  182.         <span class="n">dev</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">&quot;=&quot;</span><span class="p">)</span>

  183.         <span class="n">read_until</span><span class="p">(</span><span class="s">&#39;!load&#39;</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mf">15.0</span><span class="p">)</span>

  184. 

  185.         <span class="c"># And finally do the upload.</span>

  186.         <span class="n">do_upload</span><span class="p">()</span>

  187.         <span class="n">stage_callback</span><span class="p">(</span><span class="n">Firmware</span><span class="o">.</span><span class="n">STAGE_DONE</span><span class="p">)</span></div></div>

  188. </pre></div>

  189. 

  190.           </div>

  191.         </div>

  192.       </div>

  193.       <div class="sphinxsidebar">

  194.         <div class="sphinxsidebarwrapper">

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

  196.   <h3>Quick search</h3>

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

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

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

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

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

  202.     </form>

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

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

  205.     </p>

  206. </div>

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

  208.         </div>

  209.       </div>

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

  211.     </div>

  212.     <div class="related">

  213.       <h3>Navigation</h3>

  214.       <ul>

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

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

  217.              >index</a></li>

  218.         <li class="right" >

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

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

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

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

  223.       </ul>

  224.     </div>

  225.     <div class="footer">

  226.         &copy; Copyright 2013, Author.

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

  228.     </div>

  229.   </body>

  230. </html>