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

652 lines
71 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.devices &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.devices</h1><div class="highlight"><pre>

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

  51. <span class="sd">Contains different types of devices belonging to the AD2USB family.</span>

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

  53. 

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

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

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

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

  58. <span class="kn">import</span> <span class="nn">serial</span>

  59. <span class="kn">import</span> <span class="nn">serial.tools.list_ports</span>

  60. <span class="kn">import</span> <span class="nn">socket</span>

  61. <span class="kn">from</span> <span class="nn">pyftdi.pyftdi.ftdi</span> <span class="kn">import</span> <span class="o">*</span>

  62. <span class="kn">from</span> <span class="nn">pyftdi.pyftdi.usbtools</span> <span class="kn">import</span> <span class="o">*</span>

  63. <span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">util</span>

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

  65. 

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

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

  68. <span class="sd">    Generic parent device to all AD2USB products.</span>

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

  70. 

  71.     <span class="c"># Generic device events</span>

  72.     <span class="n">on_open</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 has been opened&#39;</span><span class="p">)</span>

  73.     <span class="n">on_close</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 has been closed&#39;</span><span class="p">)</span>

  74.     <span class="n">on_read</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 a line has been read from the device&#39;</span><span class="p">)</span>

  75.     <span class="n">on_write</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 data has been written to the device&#39;</span><span class="p">)</span>

  76. 

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

  78.         <span class="bp">self</span><span class="o">.</span><span class="n">_id</span> <span class="o">=</span> <span class="s">&#39;&#39;</span>

  79.         <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span> <span class="o">=</span> <span class="s">&#39;&#39;</span>

  80.         <span class="bp">self</span><span class="o">.</span><span class="n">_interface</span> <span class="o">=</span> <span class="bp">None</span>

  81.         <span class="bp">self</span><span class="o">.</span><span class="n">_device</span> <span class="o">=</span> <span class="bp">None</span>

  82.         <span class="bp">self</span><span class="o">.</span><span class="n">_running</span> <span class="o">=</span> <span class="bp">False</span>

  83.         <span class="bp">self</span><span class="o">.</span><span class="n">_read_thread</span> <span class="o">=</span> <span class="n">Device</span><span class="o">.</span><span class="n">ReadThread</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>    <span class="c"># NOTE: not sure this is going to work..</span>

  84. 

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

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

  87. 

  88.     <span class="nd">@property</span>

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

  90.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id</span>

  91. 

  92.     <span class="nd">@id.setter</span>

  93. <div class="viewcode-block" id="Device.id"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.Device.id">[docs]</a>    <span class="k">def</span> <span class="nf">id</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>

  94.         <span class="bp">self</span><span class="o">.</span><span class="n">_id</span> <span class="o">=</span> <span class="n">value</span>

  95. </div>

  96. <div class="viewcode-block" id="Device.is_reader_alive"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.Device.is_reader_alive">[docs]</a>    <span class="k">def</span> <span class="nf">is_reader_alive</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

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

  98. <span class="sd">        Indicates whether or not the reader thread is alive.</span>

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

  100.         <span class="k">return</span> <span class="bp">self</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>

  101. </div>

  102. <div class="viewcode-block" id="Device.stop_reader"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.Device.stop_reader">[docs]</a>    <span class="k">def</span> <span class="nf">stop_reader</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

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

  104. <span class="sd">        Stops the reader thread.</span>

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

  106.         <span class="bp">self</span><span class="o">.</span><span class="n">_read_thread</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>

  107. </div>

  108. <div class="viewcode-block" id="Device.ReadThread"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.Device.ReadThread">[docs]</a>    <span class="k">class</span> <span class="nc">ReadThread</span><span class="p">(</span><span class="n">threading</span><span class="o">.</span><span class="n">Thread</span><span class="p">):</span>

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

  110. <span class="sd">        Reader thread which processes messages from the device.</span>

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

  112. 

  113.         <span class="n">READ_TIMEOUT</span> <span class="o">=</span> <span class="mi">10</span>

  114. 

  115.         <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">device</span><span class="p">):</span>

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

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

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

  119.             <span class="n">threading</span><span class="o">.</span><span class="n">Thread</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>

  120.             <span class="bp">self</span><span class="o">.</span><span class="n">_device</span> <span class="o">=</span> <span class="n">device</span>

  121.             <span class="bp">self</span><span class="o">.</span><span class="n">_running</span> <span class="o">=</span> <span class="bp">False</span>

  122. 

  123. <div class="viewcode-block" id="Device.ReadThread.stop"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.Device.ReadThread.stop">[docs]</a>        <span class="k">def</span> <span class="nf">stop</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

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

  125. <span class="sd">            Stops the running thread.</span>

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

  127.             <span class="bp">self</span><span class="o">.</span><span class="n">_running</span> <span class="o">=</span> <span class="bp">False</span>

  128. </div>

  129. <div class="viewcode-block" id="Device.ReadThread.run"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.Device.ReadThread.run">[docs]</a>        <span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

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

  131. <span class="sd">            The actual read process.</span>

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

  133.             <span class="bp">self</span><span class="o">.</span><span class="n">_running</span> <span class="o">=</span> <span class="bp">True</span>

  134. 

  135.             <span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">_running</span><span class="p">:</span>

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

  137.                     <span class="bp">self</span><span class="o">.</span><span class="n">_device</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="bp">self</span><span class="o">.</span><span class="n">READ_TIMEOUT</span><span class="p">)</span>

  138.                 <span class="k">except</span> <span class="n">util</span><span class="o">.</span><span class="n">TimeoutError</span><span class="p">,</span> <span class="n">err</span><span class="p">:</span>

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

  140. 

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

  142. </div></div></div>

  143. <div class="viewcode-block" id="USBDevice"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.USBDevice">[docs]</a><span class="k">class</span> <span class="nc">USBDevice</span><span class="p">(</span><span class="n">Device</span><span class="p">):</span>

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

  145. <span class="sd">    AD2USB device exposed with PyFTDI&#39;s interface.</span>

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

  147. 

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

  149.     <span class="n">FTDI_VENDOR_ID</span> <span class="o">=</span> <span class="mh">0x0403</span>

  150.     <span class="n">FTDI_PRODUCT_ID</span> <span class="o">=</span> <span class="mh">0x6001</span>

  151.     <span class="n">BAUDRATE</span> <span class="o">=</span> <span class="mi">115200</span>

  152. 

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

  154. <div class="viewcode-block" id="USBDevice.find_all"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.USBDevice.find_all">[docs]</a>    <span class="k">def</span> <span class="nf">find_all</span><span class="p">():</span>

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

  156. <span class="sd">        Returns all FTDI devices matching our vendor and product IDs.</span>

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

  158.         <span class="n">devices</span> <span class="o">=</span> <span class="p">[]</span>

  159. 

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

  161.             <span class="n">devices</span> <span class="o">=</span> <span class="n">Ftdi</span><span class="o">.</span><span class="n">find_all</span><span class="p">([(</span><span class="n">USBDevice</span><span class="o">.</span><span class="n">FTDI_VENDOR_ID</span><span class="p">,</span> <span class="n">USBDevice</span><span class="o">.</span><span class="n">FTDI_PRODUCT_ID</span><span class="p">)],</span> <span class="n">nocache</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>

  162.         <span class="k">except</span> <span class="p">(</span><span class="n">usb</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">USBError</span><span class="p">,</span> <span class="n">FtdiError</span><span class="p">),</span> <span class="n">err</span><span class="p">:</span>

  163.             <span class="k">raise</span> <span class="n">util</span><span class="o">.</span><span class="n">CommError</span><span class="p">(</span><span class="s">&#39;Error enumerating AD2USB devices: {0}&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">err</span><span class="p">)))</span>

  164. 

  165.         <span class="k">return</span> <span class="n">devices</span>

  166. </div>

  167.     <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">vid</span><span class="o">=</span><span class="n">FTDI_VENDOR_ID</span><span class="p">,</span> <span class="n">pid</span><span class="o">=</span><span class="n">FTDI_PRODUCT_ID</span><span class="p">,</span> <span class="n">serial</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">interface</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>

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

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

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

  171.         <span class="n">Device</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>

  172. 

  173.         <span class="bp">self</span><span class="o">.</span><span class="n">_device</span> <span class="o">=</span> <span class="n">Ftdi</span><span class="p">()</span>

  174.         <span class="bp">self</span><span class="o">.</span><span class="n">_interface</span> <span class="o">=</span> <span class="n">interface</span>

  175.         <span class="bp">self</span><span class="o">.</span><span class="n">_vendor_id</span> <span class="o">=</span> <span class="n">vid</span>

  176.         <span class="bp">self</span><span class="o">.</span><span class="n">_product_id</span> <span class="o">=</span> <span class="n">pid</span>

  177.         <span class="bp">self</span><span class="o">.</span><span class="n">_serial_number</span> <span class="o">=</span> <span class="n">serial</span>

  178.         <span class="bp">self</span><span class="o">.</span><span class="n">_description</span> <span class="o">=</span> <span class="n">description</span>

  179. 

  180. <div class="viewcode-block" id="USBDevice.open"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.USBDevice.open">[docs]</a>    <span class="k">def</span> <span class="nf">open</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">baudrate</span><span class="o">=</span><span class="n">BAUDRATE</span><span class="p">,</span> <span class="n">interface</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">no_reader_thread</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>

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

  182. <span class="sd">        Opens the device.</span>

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

  184.         <span class="c"># Set up defaults</span>

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

  186.             <span class="n">baudrate</span> <span class="o">=</span> <span class="n">USBDevice</span><span class="o">.</span><span class="n">BAUDRATE</span>

  187. 

  188.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_interface</span> <span class="ow">is</span> <span class="bp">None</span> <span class="ow">and</span> <span class="n">interface</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>

  189.             <span class="bp">self</span><span class="o">.</span><span class="n">_interface</span> <span class="o">=</span> <span class="mi">0</span>

  190. 

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

  192.             <span class="bp">self</span><span class="o">.</span><span class="n">_interface</span> <span class="o">=</span> <span class="n">interface</span>

  193. 

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

  195.             <span class="n">index</span> <span class="o">=</span> <span class="mi">0</span>

  196. 

  197.         <span class="c"># Open the device and start up the thread.</span>

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

  199.             <span class="bp">self</span><span class="o">.</span><span class="n">_device</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_vendor_id</span><span class="p">,</span>

  200.                              <span class="bp">self</span><span class="o">.</span><span class="n">_product_id</span><span class="p">,</span>

  201.                              <span class="bp">self</span><span class="o">.</span><span class="n">_interface</span><span class="p">,</span>

  202.                              <span class="n">index</span><span class="p">,</span>

  203.                              <span class="bp">self</span><span class="o">.</span><span class="n">_serial_number</span><span class="p">,</span>

  204.                              <span class="bp">self</span><span class="o">.</span><span class="n">_description</span><span class="p">)</span>

  205. 

  206.             <span class="bp">self</span><span class="o">.</span><span class="n">_device</span><span class="o">.</span><span class="n">set_baudrate</span><span class="p">(</span><span class="n">baudrate</span><span class="p">)</span>

  207. 

  208.             <span class="bp">self</span><span class="o">.</span><span class="n">_id</span> <span class="o">=</span> <span class="s">&#39;USB {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">_device</span><span class="o">.</span><span class="n">usb_dev</span><span class="o">.</span><span class="n">bus</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_device</span><span class="o">.</span><span class="n">usb_dev</span><span class="o">.</span><span class="n">address</span><span class="p">)</span>

  209.         <span class="k">except</span> <span class="p">(</span><span class="n">usb</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">USBError</span><span class="p">,</span> <span class="n">FtdiError</span><span class="p">),</span> <span class="n">err</span><span class="p">:</span>

  210.             <span class="bp">self</span><span class="o">.</span><span class="n">on_close</span><span class="p">()</span>

  211. 

  212.             <span class="k">raise</span> <span class="n">util</span><span class="o">.</span><span class="n">NoDeviceError</span><span class="p">(</span><span class="s">&#39;Error opening AD2USB device: {0}&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">err</span><span class="p">)))</span>

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

  214.             <span class="bp">self</span><span class="o">.</span><span class="n">_running</span> <span class="o">=</span> <span class="bp">True</span>

  215.             <span class="k">if</span> <span class="ow">not</span> <span class="n">no_reader_thread</span><span class="p">:</span>

  216.                 <span class="bp">self</span><span class="o">.</span><span class="n">_read_thread</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>

  217. 

  218.             <span class="bp">self</span><span class="o">.</span><span class="n">on_open</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">_serial_number</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_description</span><span class="p">))</span>

  219. </div>

  220. <div class="viewcode-block" id="USBDevice.close"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.USBDevice.close">[docs]</a>    <span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

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

  222. <span class="sd">        Closes the device.</span>

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

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

  225.             <span class="bp">self</span><span class="o">.</span><span class="n">_running</span> <span class="o">=</span> <span class="bp">False</span>

  226.             <span class="bp">self</span><span class="o">.</span><span class="n">_read_thread</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>

  227. 

  228.             <span class="bp">self</span><span class="o">.</span><span class="n">_device</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>

  229. 

  230.             <span class="c"># HACK: Probably should fork pyftdi and make this call in .close().</span>

  231.             <span class="bp">self</span><span class="o">.</span><span class="n">_device</span><span class="o">.</span><span class="n">usb_dev</span><span class="o">.</span><span class="n">attach_kernel_driver</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_interface</span><span class="p">)</span>

  232.         <span class="k">except</span> <span class="p">(</span><span class="n">FtdiError</span><span class="p">,</span> <span class="n">usb</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">USBError</span><span class="p">):</span>

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

  234. 

  235.         <span class="bp">self</span><span class="o">.</span><span class="n">on_close</span><span class="p">()</span>

  236. </div>

  237. <div class="viewcode-block" id="USBDevice.write"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.USBDevice.write">[docs]</a>    <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>

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

  239. <span class="sd">        Writes data to the device.</span>

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

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

  242.             <span class="bp">self</span><span class="o">.</span><span class="n">_device</span><span class="o">.</span><span class="n">write_data</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>

  243. 

  244.             <span class="bp">self</span><span class="o">.</span><span class="n">on_write</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>

  245.         <span class="k">except</span> <span class="n">FtdiError</span><span class="p">,</span> <span class="n">err</span><span class="p">:</span>

  246.             <span class="k">raise</span> <span class="n">util</span><span class="o">.</span><span class="n">CommError</span><span class="p">(</span><span class="s">&#39;Error writing to AD2USB device.&#39;</span><span class="p">)</span>

  247. </div>

  248. <div class="viewcode-block" id="USBDevice.read"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.USBDevice.read">[docs]</a>    <span class="k">def</span> <span class="nf">read</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

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

  250. <span class="sd">        Reads a single character from the device.</span>

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

  252.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_device</span><span class="o">.</span><span class="n">read_data</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>

  253. </div>

  254. <div class="viewcode-block" id="USBDevice.read_line"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.USBDevice.read_line">[docs]</a>    <span class="k">def</span> <span class="nf">read_line</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mf">0.0</span><span class="p">):</span>

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

  256. <span class="sd">        Reads a line from the device.</span>

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

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

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

  260. 

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

  262. 

  263.         <span class="n">got_line</span> <span class="o">=</span> <span class="bp">False</span>

  264.         <span class="n">ret</span> <span class="o">=</span> <span class="bp">None</span>

  265. 

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

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

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

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

  270. 

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

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

  273.                 <span class="n">buf</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_device</span><span class="o">.</span><span class="n">read_data</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>

  274. 

  275.                 <span class="k">if</span> <span class="n">buf</span> <span class="o">!=</span> <span class="s">&#39;&#39;</span><span class="p">:</span>

  276.                     <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span> <span class="o">+=</span> <span class="n">buf</span>

  277. 

  278.                     <span class="k">if</span> <span class="n">buf</span> <span class="o">==</span> <span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">:</span>

  279.                         <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>

  280.                             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span> <span class="o">==</span> <span class="s">&quot;</span><span class="se">\r</span><span class="s">&quot;</span><span class="p">:</span>

  281.                                 <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span><span class="p">[:</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span>

  282. 

  283.                                 <span class="c"># ignore if we just got \r\n with nothing else in the buffer.</span>

  284.                                 <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>

  285.                                     <span class="n">got_line</span> <span class="o">=</span> <span class="bp">True</span>

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

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

  288.                             <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>

  289. 

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

  291. 

  292.         <span class="k">except</span> <span class="p">(</span><span class="n">usb</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">USBError</span><span class="p">,</span> <span class="n">FtdiError</span><span class="p">),</span> <span class="n">err</span><span class="p">:</span>

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

  294. 

  295.             <span class="k">raise</span> <span class="n">util</span><span class="o">.</span><span class="n">CommError</span><span class="p">(</span><span class="s">&#39;Error reading from AD2USB device: {0}&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">err</span><span class="p">)))</span>

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

  297.             <span class="k">if</span> <span class="n">got_line</span><span class="p">:</span>

  298.                 <span class="n">ret</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span>

  299.                 <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span> <span class="o">=</span> <span class="s">&#39;&#39;</span>

  300. 

  301.                 <span class="bp">self</span><span class="o">.</span><span class="n">on_read</span><span class="p">(</span><span class="n">ret</span><span class="p">)</span>

  302. 

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

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

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

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

  307.                 <span class="k">raise</span> <span class="n">util</span><span class="o">.</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>

  308. 

  309.         <span class="k">return</span> <span class="n">ret</span>

  310. 

  311. </div></div>

  312. <div class="viewcode-block" id="SerialDevice"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.SerialDevice">[docs]</a><span class="k">class</span> <span class="nc">SerialDevice</span><span class="p">(</span><span class="n">Device</span><span class="p">):</span>

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

  314. <span class="sd">    AD2USB or AD2SERIAL device exposed with the pyserial interface.</span>

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

  316. 

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

  318.     <span class="n">BAUDRATE</span> <span class="o">=</span> <span class="mi">19200</span>

  319. 

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

  321. <div class="viewcode-block" id="SerialDevice.find_all"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.SerialDevice.find_all">[docs]</a>    <span class="k">def</span> <span class="nf">find_all</span><span class="p">(</span><span class="n">pattern</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>

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

  323. <span class="sd">        Returns all serial ports present.</span>

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

  325.         <span class="n">devices</span> <span class="o">=</span> <span class="p">[]</span>

  326. 

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

  328.             <span class="k">if</span> <span class="n">pattern</span><span class="p">:</span>

  329.                 <span class="n">devices</span> <span class="o">=</span> <span class="n">serial</span><span class="o">.</span><span class="n">tools</span><span class="o">.</span><span class="n">list_ports</span><span class="o">.</span><span class="n">grep</span><span class="p">(</span><span class="n">pattern</span><span class="p">)</span>

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

  331.                 <span class="n">devices</span> <span class="o">=</span> <span class="n">serial</span><span class="o">.</span><span class="n">tools</span><span class="o">.</span><span class="n">list_ports</span><span class="o">.</span><span class="n">comports</span><span class="p">()</span>

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

  333.             <span class="k">raise</span> <span class="n">util</span><span class="o">.</span><span class="n">CommError</span><span class="p">(</span><span class="s">&#39;Error enumerating AD2SERIAL devices: {0}&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">err</span><span class="p">)))</span>

  334. 

  335.         <span class="k">return</span> <span class="n">devices</span>

  336. </div>

  337.     <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">interface</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>

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

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

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

  341.         <span class="n">Device</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>

  342. 

  343.         <span class="bp">self</span><span class="o">.</span><span class="n">_interface</span> <span class="o">=</span> <span class="n">interface</span>

  344.         <span class="bp">self</span><span class="o">.</span><span class="n">_id</span> <span class="o">=</span> <span class="n">interface</span>

  345.         <span class="bp">self</span><span class="o">.</span><span class="n">_device</span> <span class="o">=</span> <span class="n">serial</span><span class="o">.</span><span class="n">Serial</span><span class="p">(</span><span class="n">timeout</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">writeTimeout</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>     <span class="c"># Timeout = non-blocking to match pyftdi.</span>

  346. 

  347. <div class="viewcode-block" id="SerialDevice.open"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.SerialDevice.open">[docs]</a>    <span class="k">def</span> <span class="nf">open</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">baudrate</span><span class="o">=</span><span class="n">BAUDRATE</span><span class="p">,</span> <span class="n">interface</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">no_reader_thread</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>

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

  349. <span class="sd">        Opens the device.</span>

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

  351.         <span class="c"># Set up the defaults</span>

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

  353.             <span class="n">baudrate</span> <span class="o">=</span> <span class="n">SerialDevice</span><span class="o">.</span><span class="n">BAUDRATE</span>

  354. 

  355.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_interface</span> <span class="ow">is</span> <span class="bp">None</span> <span class="ow">and</span> <span class="n">interface</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>

  356.             <span class="k">raise</span> <span class="n">util</span><span class="o">.</span><span class="n">NoDeviceError</span><span class="p">(</span><span class="s">&#39;No AD2SERIAL device interface specified.&#39;</span><span class="p">)</span>

  357. 

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

  359.             <span class="bp">self</span><span class="o">.</span><span class="n">_interface</span> <span class="o">=</span> <span class="n">interface</span>

  360. 

  361.         <span class="bp">self</span><span class="o">.</span><span class="n">_device</span><span class="o">.</span><span class="n">port</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_interface</span>

  362. 

  363.         <span class="c"># Open the device and start up the reader thread.</span>

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

  365.             <span class="bp">self</span><span class="o">.</span><span class="n">_device</span><span class="o">.</span><span class="n">open</span><span class="p">()</span>

  366.             <span class="bp">self</span><span class="o">.</span><span class="n">_device</span><span class="o">.</span><span class="n">baudrate</span> <span class="o">=</span> <span class="n">baudrate</span>            <span class="c"># NOTE: Setting the baudrate before opening the</span>

  367.                                                         <span class="c">#       port caused issues with Moschip 7840/7820</span>

  368.                                                         <span class="c">#       USB Serial Driver converter. (mos7840)</span>

  369.                                                         <span class="c">#</span>

  370.                                                         <span class="c">#       Moving it to this point seems to resolve</span>

  371.                                                         <span class="c">#       all issues with it.</span>

  372. 

  373.         <span class="k">except</span> <span class="p">(</span><span class="n">serial</span><span class="o">.</span><span class="n">SerialException</span><span class="p">,</span> <span class="ne">ValueError</span><span class="p">),</span> <span class="n">err</span><span class="p">:</span>

  374.             <span class="bp">self</span><span class="o">.</span><span class="n">on_close</span><span class="p">()</span>

  375. 

  376.             <span class="k">raise</span> <span class="n">util</span><span class="o">.</span><span class="n">NoDeviceError</span><span class="p">(</span><span class="s">&#39;Error opening AD2SERIAL device on port {0}.&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">interface</span><span class="p">))</span>

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

  378.             <span class="bp">self</span><span class="o">.</span><span class="n">_running</span> <span class="o">=</span> <span class="bp">True</span>

  379.             <span class="bp">self</span><span class="o">.</span><span class="n">on_open</span><span class="p">((</span><span class="s">&#39;N/A&#39;</span><span class="p">,</span> <span class="s">&quot;AD2SERIAL&quot;</span><span class="p">))</span>

  380. 

  381.             <span class="k">if</span> <span class="ow">not</span> <span class="n">no_reader_thread</span><span class="p">:</span>

  382.                 <span class="bp">self</span><span class="o">.</span><span class="n">_read_thread</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>

  383. </div>

  384. <div class="viewcode-block" id="SerialDevice.close"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.SerialDevice.close">[docs]</a>    <span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

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

  386. <span class="sd">        Closes the device.</span>

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

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

  389.             <span class="bp">self</span><span class="o">.</span><span class="n">_running</span> <span class="o">=</span> <span class="bp">False</span>

  390.             <span class="bp">self</span><span class="o">.</span><span class="n">_read_thread</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>

  391. 

  392.             <span class="bp">self</span><span class="o">.</span><span class="n">_device</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>

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

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

  395. 

  396.         <span class="bp">self</span><span class="o">.</span><span class="n">on_close</span><span class="p">()</span>

  397. </div>

  398. <div class="viewcode-block" id="SerialDevice.write"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.SerialDevice.write">[docs]</a>    <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>

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

  400. <span class="sd">        Writes data to the device.</span>

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

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

  403.             <span class="bp">self</span><span class="o">.</span><span class="n">_device</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>

  404.         <span class="k">except</span> <span class="n">serial</span><span class="o">.</span><span class="n">SerialTimeoutException</span><span class="p">,</span> <span class="n">err</span><span class="p">:</span>

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

  406.         <span class="k">except</span> <span class="n">serial</span><span class="o">.</span><span class="n">SerialException</span><span class="p">,</span> <span class="n">err</span><span class="p">:</span>

  407.             <span class="k">raise</span> <span class="n">util</span><span class="o">.</span><span class="n">CommError</span><span class="p">(</span><span class="s">&#39;Error writing to serial device.&#39;</span><span class="p">)</span>

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

  409.             <span class="bp">self</span><span class="o">.</span><span class="n">on_write</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>

  410. </div>

  411. <div class="viewcode-block" id="SerialDevice.read"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.SerialDevice.read">[docs]</a>    <span class="k">def</span> <span class="nf">read</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

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

  413. <span class="sd">        Reads a single character from the device.</span>

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

  415.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_device</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>

  416. </div>

  417. <div class="viewcode-block" id="SerialDevice.read_line"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.SerialDevice.read_line">[docs]</a>    <span class="k">def</span> <span class="nf">read_line</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mf">0.0</span><span class="p">):</span>

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

  419. <span class="sd">        Reads a line from the device.</span>

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

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

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

  423. 

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

  425. 

  426.         <span class="n">got_line</span> <span class="o">=</span> <span class="bp">False</span>

  427.         <span class="n">ret</span> <span class="o">=</span> <span class="bp">None</span>

  428. 

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

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

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

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

  433. 

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

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

  436.                 <span class="n">buf</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_device</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>

  437. 

  438.                 <span class="k">if</span> <span class="n">buf</span> <span class="o">!=</span> <span class="s">&#39;&#39;</span> <span class="ow">and</span> <span class="n">buf</span> <span class="o">!=</span> <span class="s">&quot;</span><span class="se">\xff</span><span class="s">&quot;</span><span class="p">:</span>     <span class="c"># AD2SERIAL specifically apparently sends down \xFF on boot.</span>

  439.                     <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span> <span class="o">+=</span> <span class="n">buf</span>

  440. 

  441.                     <span class="k">if</span> <span class="n">buf</span> <span class="o">==</span> <span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">:</span>

  442.                         <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>

  443.                             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span> <span class="o">==</span> <span class="s">&quot;</span><span class="se">\r</span><span class="s">&quot;</span><span class="p">:</span>

  444.                                 <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span><span class="p">[:</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span>

  445. 

  446.                                 <span class="c"># ignore if we just got \r\n with nothing else in the buffer.</span>

  447.                                 <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>

  448.                                     <span class="n">got_line</span> <span class="o">=</span> <span class="bp">True</span>

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

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

  451.                             <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>

  452. 

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

  454. 

  455.         <span class="k">except</span> <span class="p">(</span><span class="ne">OSError</span><span class="p">,</span> <span class="n">serial</span><span class="o">.</span><span class="n">SerialException</span><span class="p">),</span> <span class="n">err</span><span class="p">:</span>

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

  457. 

  458.             <span class="k">raise</span> <span class="n">util</span><span class="o">.</span><span class="n">CommError</span><span class="p">(</span><span class="s">&#39;Error reading from AD2SERIAL device: {0}&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">err</span><span class="p">)))</span>

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

  460.             <span class="k">if</span> <span class="n">got_line</span><span class="p">:</span>

  461.                 <span class="n">ret</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span>

  462.                 <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span> <span class="o">=</span> <span class="s">&#39;&#39;</span>

  463. 

  464.                 <span class="bp">self</span><span class="o">.</span><span class="n">on_read</span><span class="p">(</span><span class="n">ret</span><span class="p">)</span>

  465. 

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

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

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

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

  470.                 <span class="k">raise</span> <span class="n">util</span><span class="o">.</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>

  471. 

  472.         <span class="k">return</span> <span class="n">ret</span>

  473. </div></div>

  474. <div class="viewcode-block" id="SocketDevice"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.SocketDevice">[docs]</a><span class="k">class</span> <span class="nc">SocketDevice</span><span class="p">(</span><span class="n">Device</span><span class="p">):</span>

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

  476. <span class="sd">    Device that supports communication with an AD2USB that is exposed via ser2sock or another</span>

  477. <span class="sd">    Serial to IP interface.</span>

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

  479. 

  480.     <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">interface</span><span class="o">=</span><span class="p">(</span><span class="s">&quot;localhost&quot;</span><span class="p">,</span> <span class="mi">10000</span><span class="p">)):</span>

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

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

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

  484.         <span class="n">Device</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>

  485. 

  486.         <span class="bp">self</span><span class="o">.</span><span class="n">_interface</span> <span class="o">=</span> <span class="n">interface</span>

  487.         <span class="bp">self</span><span class="o">.</span><span class="n">_host</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_port</span> <span class="o">=</span> <span class="n">interface</span>

  488. 

  489. <div class="viewcode-block" id="SocketDevice.open"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.SocketDevice.open">[docs]</a>    <span class="k">def</span> <span class="nf">open</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">baudrate</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">interface</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">no_reader_thread</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>

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

  491. <span class="sd">        Opens the device.</span>

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

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

  494.             <span class="bp">self</span><span class="o">.</span><span class="n">_interface</span> <span class="o">=</span> <span class="n">interface</span>

  495.             <span class="bp">self</span><span class="o">.</span><span class="n">_host</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_port</span> <span class="o">=</span> <span class="n">interface</span>

  496. 

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

  498.             <span class="bp">self</span><span class="o">.</span><span class="n">_device</span> <span class="o">=</span> <span class="n">socket</span><span class="o">.</span><span class="n">socket</span><span class="p">(</span><span class="n">socket</span><span class="o">.</span><span class="n">AF_INET</span><span class="p">,</span> <span class="n">socket</span><span class="o">.</span><span class="n">SOCK_STREAM</span><span class="p">)</span>

  499.             <span class="bp">self</span><span class="o">.</span><span class="n">_device</span><span class="o">.</span><span class="n">connect</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">_host</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_port</span><span class="p">))</span>

  500. 

  501.             <span class="bp">self</span><span class="o">.</span><span class="n">_id</span> <span class="o">=</span> <span class="s">&#39;{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">_host</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_port</span><span class="p">)</span>

  502. 

  503.         <span class="k">except</span> <span class="n">socket</span><span class="o">.</span><span class="n">error</span><span class="p">,</span> <span class="n">err</span><span class="p">:</span>

  504.             <span class="bp">self</span><span class="o">.</span><span class="n">on_close</span><span class="p">()</span>

  505. 

  506.             <span class="k">raise</span> <span class="n">util</span><span class="o">.</span><span class="n">NoDeviceError</span><span class="p">(</span><span class="s">&#39;Error opening AD2SOCKET device at {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">_host</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_port</span><span class="p">))</span>

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

  508.             <span class="bp">self</span><span class="o">.</span><span class="n">_running</span> <span class="o">=</span> <span class="bp">True</span>

  509. 

  510.             <span class="bp">self</span><span class="o">.</span><span class="n">on_open</span><span class="p">((</span><span class="s">&#39;N/A&#39;</span><span class="p">,</span> <span class="s">&quot;AD2SOCKET&quot;</span><span class="p">))</span>

  511. 

  512.             <span class="k">if</span> <span class="ow">not</span> <span class="n">no_reader_thread</span><span class="p">:</span>

  513.                 <span class="bp">self</span><span class="o">.</span><span class="n">_read_thread</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>

  514. </div>

  515. <div class="viewcode-block" id="SocketDevice.close"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.SocketDevice.close">[docs]</a>    <span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

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

  517. <span class="sd">        Closes the device.</span>

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

  519.         <span class="bp">self</span><span class="o">.</span><span class="n">_running</span> <span class="o">=</span> <span class="bp">False</span>

  520. 

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

  522.             <span class="bp">self</span><span class="o">.</span><span class="n">_read_thread</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>

  523.             <span class="bp">self</span><span class="o">.</span><span class="n">_device</span><span class="o">.</span><span class="n">shutdown</span><span class="p">(</span><span class="n">socket</span><span class="o">.</span><span class="n">SHUT_RDWR</span><span class="p">)</span>     <span class="c"># Make sure that it closes immediately.</span>

  524.             <span class="bp">self</span><span class="o">.</span><span class="n">_device</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>

  525.         <span class="k">except</span><span class="p">:</span>

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

  527. 

  528.         <span class="bp">self</span><span class="o">.</span><span class="n">on_close</span><span class="p">()</span>

  529. </div>

  530. <div class="viewcode-block" id="SocketDevice.write"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.SocketDevice.write">[docs]</a>    <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>

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

  532. <span class="sd">        Writes data to the device.</span>

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

  534.         <span class="n">data_sent</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_device</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>

  535. 

  536.         <span class="k">if</span> <span class="n">data_sent</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>

  537.             <span class="k">raise</span> <span class="n">util</span><span class="o">.</span><span class="n">CommError</span><span class="p">(</span><span class="s">&#39;Error while sending data.&#39;</span><span class="p">)</span>

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

  539.             <span class="bp">self</span><span class="o">.</span><span class="n">on_write</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>

  540. 

  541.         <span class="k">return</span> <span class="n">data_sent</span>

  542. </div>

  543. <div class="viewcode-block" id="SocketDevice.read"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.SocketDevice.read">[docs]</a>    <span class="k">def</span> <span class="nf">read</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

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

  545. <span class="sd">        Reads a single character from the device.</span>

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

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

  548.             <span class="n">data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_device</span><span class="o">.</span><span class="n">recv</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>

  549.         <span class="k">except</span> <span class="n">socket</span><span class="o">.</span><span class="n">error</span><span class="p">,</span> <span class="n">err</span><span class="p">:</span>

  550.             <span class="k">raise</span> <span class="n">util</span><span class="o">.</span><span class="n">CommError</span><span class="p">(</span><span class="s">&#39;Error while reading from device: {0}&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">err</span><span class="p">)))</span>

  551. 

  552.         <span class="k">return</span> <span class="n">data</span>

  553. </div>

  554. <div class="viewcode-block" id="SocketDevice.read_line"><a class="viewcode-back" href="../../pyad2usb.html#pyad2usb.devices.SocketDevice.read_line">[docs]</a>    <span class="k">def</span> <span class="nf">read_line</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mf">0.0</span><span class="p">):</span>

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

  556. <span class="sd">        Reads a line from the device.</span>

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

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

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

  560. 

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

  562. 

  563.         <span class="n">got_line</span> <span class="o">=</span> <span class="bp">False</span>

  564.         <span class="n">ret</span> <span class="o">=</span> <span class="bp">None</span>

  565. 

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

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

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

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

  570. 

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

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

  573.                 <span class="n">buf</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_device</span><span class="o">.</span><span class="n">recv</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>

  574. 

  575.                 <span class="k">if</span> <span class="n">buf</span> <span class="o">!=</span> <span class="s">&#39;&#39;</span><span class="p">:</span>

  576.                     <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span> <span class="o">+=</span> <span class="n">buf</span>

  577. 

  578.                     <span class="k">if</span> <span class="n">buf</span> <span class="o">==</span> <span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">:</span>

  579.                         <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>

  580.                             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span> <span class="o">==</span> <span class="s">&quot;</span><span class="se">\r</span><span class="s">&quot;</span><span class="p">:</span>

  581.                                 <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span><span class="p">[:</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span>

  582. 

  583.                                 <span class="c"># ignore if we just got \r\n with nothing else in the buffer.</span>

  584.                                 <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>

  585.                                     <span class="n">got_line</span> <span class="o">=</span> <span class="bp">True</span>

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

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

  588.                             <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>

  589. 

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

  591. 

  592.         <span class="k">except</span> <span class="n">socket</span><span class="o">.</span><span class="n">error</span><span class="p">,</span> <span class="n">err</span><span class="p">:</span>

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

  594. 

  595.             <span class="k">raise</span> <span class="n">util</span><span class="o">.</span><span class="n">CommError</span><span class="p">(</span><span class="s">&#39;Error reading from Socket device: {0}&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">err</span><span class="p">)))</span>

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

  597.             <span class="k">if</span> <span class="n">got_line</span><span class="p">:</span>

  598.                 <span class="n">ret</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span>

  599.                 <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span> <span class="o">=</span> <span class="s">&#39;&#39;</span>

  600. 

  601.                 <span class="bp">self</span><span class="o">.</span><span class="n">on_read</span><span class="p">(</span><span class="n">ret</span><span class="p">)</span>

  602. 

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

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

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

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

  607.                 <span class="k">raise</span> <span class="n">util</span><span class="o">.</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>

  608. 

  609.         <span class="k">return</span> <span class="n">ret</span></div></div>

  610. </pre></div>

  611. 

  612.           </div>

  613.         </div>

  614.       </div>

  615.       <div class="sphinxsidebar">

  616.         <div class="sphinxsidebarwrapper">

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

  618.   <h3>Quick search</h3>

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

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

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

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

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

  624.     </form>

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

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

  627.     </p>

  628. </div>

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

  630.         </div>

  631.       </div>

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

  633.     </div>

  634.     <div class="related">

  635.       <h3>Navigation</h3>

  636.       <ul>

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

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

  639.              >index</a></li>

  640.         <li class="right" >

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

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

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

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

  645.       </ul>

  646.     </div>

  647.     <div class="footer">

  648.         &copy; Copyright 2013, Author.

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

  650.     </div>

  651.   </body>

  652. </html>