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

1008 lines
96 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>pyad2.devices &mdash; pyad2  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="pyad2  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">pyad2  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 pyad2.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 AD2 family.</span>

  52. 

  53. <span class="sd">.. moduleauthor:: Scott Petersen &lt;scott@nutech.com&gt;</span>

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

  55. 

  56. <span class="kn">import</span> <span class="nn">usb.core</span><span class="o">,</span> <span class="nn">usb.util</span>

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

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

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

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

  61. 

  62. <span class="kn">from</span> <span class="nn">OpenSSL</span> <span class="kn">import</span> <span class="n">SSL</span><span class="p">,</span> <span class="n">crypto</span>

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

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

  65. <span class="kn">from</span> <span class="nn">.util</span> <span class="kn">import</span> <span class="n">CommError</span><span class="p">,</span> <span class="n">TimeoutError</span><span class="p">,</span> <span class="n">NoDeviceError</span>

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

  67. 

  68. <div class="viewcode-block" id="Device"><a class="viewcode-back" href="../../pyad2.html#pyad2.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>

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

  70. <span class="sd">    Generic parent device to all AD2 products.</span>

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

  72. 

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

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

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

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

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

  78. 

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

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

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

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

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

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

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

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

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

  88. 

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

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

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

  92. <span class="sd">        Retrieve the device ID.</span>

  93. 

  94. <span class="sd">        :returns: The identification string for the device.</span>

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

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

  97. 

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

  99. <div class="viewcode-block" id="Device.id"><a class="viewcode-back" href="../../pyad2.html#pyad2.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>

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

  101. <span class="sd">        Sets the device ID.</span>

  102. 

  103. <span class="sd">        :param value: The device identification.</span>

  104. <span class="sd">        :type value: str</span>

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

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

  107. </div>

  108. <div class="viewcode-block" id="Device.is_reader_alive"><a class="viewcode-back" href="../../pyad2.html#pyad2.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>

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

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

  111. 

  112. <span class="sd">        :returns: Whether or not the reader thread is alive.</span>

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

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

  115. </div>

  116. <div class="viewcode-block" id="Device.stop_reader"><a class="viewcode-back" href="../../pyad2.html#pyad2.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>

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

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

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

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

  121. </div>

  122. <div class="viewcode-block" id="Device.close"><a class="viewcode-back" href="../../pyad2.html#pyad2.devices.Device.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>

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

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

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

  126.         <span class="k">try</span><span class="p">:</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.             <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>

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

  130. 

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

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

  133. 

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

  135. </div>

  136. <div class="viewcode-block" id="Device.ReadThread"><a class="viewcode-back" href="../../pyad2.html#pyad2.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>

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

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

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

  140. 

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

  142.         <span class="sd">&quot;&quot;&quot;Timeout for the reader thread.&quot;&quot;&quot;</span>

  143. 

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

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

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

  147. 

  148. <span class="sd">            :param device: The device used by the reader thread.</span>

  149. <span class="sd">            :type device: devices.Device</span>

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

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

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

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

  154. 

  155. <div class="viewcode-block" id="Device.ReadThread.stop"><a class="viewcode-back" href="../../pyad2.html#pyad2.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>

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

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

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

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

  160. </div>

  161. <div class="viewcode-block" id="Device.ReadThread.run"><a class="viewcode-back" href="../../pyad2.html#pyad2.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>

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

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

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

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

  166. 

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

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

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

  170. 

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

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

  173. 

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

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

  176. 

  177.                     <span class="c">#raise err</span>

  178. 

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

  180. </div></div></div>

  181. <div class="viewcode-block" id="USBDevice"><a class="viewcode-back" href="../../pyad2.html#pyad2.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>

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

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

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

  185. 

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

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

  188.     <span class="sd">&quot;&quot;&quot;Vendor ID used to recognize AD2USB devices.&quot;&quot;&quot;</span>

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

  190.     <span class="sd">&quot;&quot;&quot;Product ID used to recognize AD2USB devices.&quot;&quot;&quot;</span>

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

  192.     <span class="sd">&quot;&quot;&quot;Default baudrate for AD2USB devices.&quot;&quot;&quot;</span>

  193. 

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

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

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

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

  198. 

  199. <span class="sd">        :returns: list of devices</span>

  200. <span class="sd">        :raises: CommError</span>

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

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

  203. 

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

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

  206. 

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

  208.             <span class="k">raise</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> <span class="n">err</span><span class="p">)</span>

  209. 

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

  211. </div>

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

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

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

  215. <span class="sd">        Retrieves the interface used to connect to the device.</span>

  216. 

  217. <span class="sd">        :returns: the interface used to connect to the device.</span>

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

  219.         <span class="k">return</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">_endpoint</span><span class="p">)</span>

  220. 

  221.     <span class="nd">@interface.setter</span>

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

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

  224. <span class="sd">        Sets the interface used to connect to the device.</span>

  225. 

  226. <span class="sd">        :param value: Tuple containing the serial number and endpoint number to use.</span>

  227. <span class="sd">        :type value: tuple</span>

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

  229.         <span class="bp">self</span><span class="o">.</span><span class="n">_serial_number</span> <span class="o">=</span> <span class="n">value</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>

  230.         <span class="bp">self</span><span class="o">.</span><span class="n">_endpoint</span> <span class="o">=</span> <span class="n">value</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>

  231. </div>

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

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

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

  235. <span class="sd">        Retrieves the serial number of the device.</span>

  236. 

  237. <span class="sd">        :returns: The serial number of the device.</span>

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

  239. 

  240.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_serial_number</span>

  241. 

  242.     <span class="nd">@serial_number.setter</span>

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

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

  245. <span class="sd">        Sets the serial number of the device.</span>

  246. 

  247. <span class="sd">        :param value: The serial number of the device.</span>

  248. <span class="sd">        :type value: string</span>

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

  250.         <span class="bp">self</span><span class="o">.</span><span class="n">_serial_number</span> <span class="o">=</span> <span class="n">value</span>

  251. </div>

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

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

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

  255. <span class="sd">        Retrieves the description of the device.</span>

  256. 

  257. <span class="sd">        :returns: The description of the device.</span>

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

  259.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_description</span>

  260. 

  261.     <span class="nd">@description.setter</span>

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

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

  264. <span class="sd">        Sets the description of the device.</span>

  265. 

  266. <span class="sd">        :param value: The description of the device.</span>

  267. <span class="sd">        :type value: string</span>

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

  269.         <span class="bp">self</span><span class="o">.</span><span class="n">_description</span> <span class="o">=</span> <span class="n">value</span>

  270. </div>

  271.     <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="bp">None</span><span class="p">,</span> <span class="mi">0</span><span class="p">)):</span>

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

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

  274. 

  275. <span class="sd">        :param interface: Tuple containing the device number and endpoint number to use.</span>

  276. <span class="sd">        :type interface: tuple</span>

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

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

  279. 

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

  281.         <span class="bp">self</span><span class="o">.</span><span class="n">_serial_number</span> <span class="o">=</span> <span class="n">interface</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>

  282.         <span class="bp">self</span><span class="o">.</span><span class="n">_endpoint</span> <span class="o">=</span> <span class="n">interface</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>

  283.         <span class="bp">self</span><span class="o">.</span><span class="n">_vendor_id</span> <span class="o">=</span> <span class="n">USBDevice</span><span class="o">.</span><span class="n">FTDI_VENDOR_ID</span>

  284.         <span class="bp">self</span><span class="o">.</span><span class="n">_product_id</span> <span class="o">=</span> <span class="n">USBDevice</span><span class="o">.</span><span class="n">FTDI_PRODUCT_ID</span>

  285.         <span class="bp">self</span><span class="o">.</span><span class="n">_device_number</span> <span class="o">=</span> <span class="bp">None</span>

  286.         <span class="bp">self</span><span class="o">.</span><span class="n">_description</span> <span class="o">=</span> <span class="bp">None</span>

  287. 

  288. <div class="viewcode-block" id="USBDevice.open"><a class="viewcode-back" href="../../pyad2.html#pyad2.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">no_reader_thread</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>

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

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

  291. 

  292. <span class="sd">        :param baudrate: The baudrate to use.</span>

  293. <span class="sd">        :type baudrate: int</span>

  294. <span class="sd">        :param no_reader_thread: Whether or not to automatically start the reader thread.</span>

  295. <span class="sd">        :type no_reader_thread: bool</span>

  296. 

  297. <span class="sd">        :raises: NoDeviceError</span>

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

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

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

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

  302. 

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

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

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

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

  307.                              <span class="bp">self</span><span class="o">.</span><span class="n">_endpoint</span><span class="p">,</span>

  308.                              <span class="bp">self</span><span class="o">.</span><span class="n">_device_number</span><span class="p">,</span>

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

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

  311. 

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

  313. 

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

  315. 

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

  317.             <span class="k">raise</span> <span class="n">NoDeviceError</span><span class="p">(</span><span class="s">&#39;Error opening 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> <span class="n">err</span><span class="p">)</span>

  318. 

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

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

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

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

  323. 

  324.             <span class="bp">self</span><span class="o">.</span><span class="n">on_open</span><span class="p">()</span>

  325. </div>

  326. <div class="viewcode-block" id="USBDevice.close"><a class="viewcode-back" href="../../pyad2.html#pyad2.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>

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

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

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

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

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

  332.             <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">_device_number</span><span class="p">)</span>

  333. 

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

  335. 

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

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

  338. </div>

  339. <div class="viewcode-block" id="USBDevice.write"><a class="viewcode-back" href="../../pyad2.html#pyad2.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>

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

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

  342. 

  343. <span class="sd">        :param data: Data to write</span>

  344. <span class="sd">        :type data: str</span>

  345. 

  346. <span class="sd">        :raises: CommError</span>

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

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

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

  350. 

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

  352. 

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

  354.             <span class="k">raise</span> <span class="n">CommError</span><span class="p">(</span><span class="s">&#39;Error writing to 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> <span class="n">err</span><span class="p">)</span>

  355. </div>

  356. <div class="viewcode-block" id="USBDevice.read"><a class="viewcode-back" href="../../pyad2.html#pyad2.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>

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

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

  359. 

  360. <span class="sd">        :returns: The character read from the device.</span>

  361. <span class="sd">        :raises: CommError</span>

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

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

  364. 

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

  366.             <span class="n">ret</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>

  367. 

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

  369.             <span class="k">raise</span> <span class="n">CommError</span><span class="p">(</span><span class="s">&#39;Error 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> <span class="n">err</span><span class="p">)</span>

  370. 

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

  372. </div>

  373. <div class="viewcode-block" id="USBDevice.read_line"><a class="viewcode-back" href="../../pyad2.html#pyad2.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> <span class="n">purge_buffer</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>

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

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

  376. 

  377. <span class="sd">        :param timeout: Read timeout</span>

  378. <span class="sd">        :type timeout: float</span>

  379. <span class="sd">        :param purge_buffer: Indicates whether to purge the buffer prior to reading.</span>

  380. <span class="sd">        :type purge_buffer: bool</span>

  381. 

  382. <span class="sd">        :returns: The line that was read.</span>

  383. <span class="sd">        :raises: CommError, TimeoutError</span>

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

  385. 

  386.         <span class="k">if</span> <span class="n">purge_buffer</span><span class="p">:</span>

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

  388. 

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

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

  391. 

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

  393. 

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

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

  396. 

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

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

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

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

  401. 

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

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

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

  405. 

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

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

  408. 

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

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

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

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

  413. 

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

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

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

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

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

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

  420. 

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

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

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

  424. 

  425.             <span class="k">raise</span> <span class="n">CommError</span><span class="p">(</span><span class="s">&#39;Error 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> <span class="n">err</span><span class="p">)</span>

  426. 

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

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

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

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

  431. 

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

  433. 

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

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

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

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

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

  439. 

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

  441. 

  442. </div></div>

  443. <div class="viewcode-block" id="SerialDevice"><a class="viewcode-back" href="../../pyad2.html#pyad2.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>

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

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

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

  447. 

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

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

  450.     <span class="sd">&quot;&quot;&quot;Default baudrate for Serial devices.&quot;&quot;&quot;</span>

  451. 

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

  453. <div class="viewcode-block" id="SerialDevice.find_all"><a class="viewcode-back" href="../../pyad2.html#pyad2.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>

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

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

  456. 

  457. <span class="sd">        :param pattern: Pattern to search for when retrieving serial ports.</span>

  458. <span class="sd">        :type pattern: str</span>

  459. 

  460. <span class="sd">        :returns: list of devices</span>

  461. <span class="sd">        :raises: CommError</span>

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

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

  464. 

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

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

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

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

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

  470. 

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

  472.             <span class="k">raise</span> <span class="n">CommError</span><span class="p">(</span><span class="s">&#39;Error enumerating serial 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> <span class="n">err</span><span class="p">)</span>

  473. 

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

  475. </div>

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

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

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

  479. <span class="sd">        Retrieves the interface used to connect to the device.</span>

  480. 

  481. <span class="sd">        :returns: the interface used to connect to the device.</span>

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

  483.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_port</span>

  484. 

  485.     <span class="nd">@interface.setter</span>

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

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

  488. <span class="sd">        Sets the interface used to connect to the device.</span>

  489. 

  490. <span class="sd">        :param value: The name of the serial device.</span>

  491. <span class="sd">        :type value: string</span>

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

  493.         <span class="bp">self</span><span class="o">.</span><span class="n">_port</span> <span class="o">=</span> <span class="n">value</span>

  494. </div>

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

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

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

  498. 

  499. <span class="sd">        :param interface: The device to open.</span>

  500. <span class="sd">        :type interface: str</span>

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

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

  503. 

  504.         <span class="bp">self</span><span class="o">.</span><span class="n">_port</span> <span class="o">=</span> <span class="n">interface</span>

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

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

  507. 

  508. <div class="viewcode-block" id="SerialDevice.open"><a class="viewcode-back" href="../../pyad2.html#pyad2.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">no_reader_thread</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>

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

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

  511. 

  512. <span class="sd">        :param baudrate: The baudrate to use with the device.</span>

  513. <span class="sd">        :type baudrate: int</span>

  514. <span class="sd">        :param no_reader_thread: Whether or not to automatically start the reader thread.</span>

  515. <span class="sd">        :type no_reader_thread: bool</span>

  516. 

  517. <span class="sd">        :raises: NoDeviceError</span>

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

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

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

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

  522. 

  523.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_port</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>

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

  525. 

  526.         <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">_port</span>

  527. 

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

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

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

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

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

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

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

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

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

  537. 

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

  539.             <span class="k">raise</span> <span class="n">NoDeviceError</span><span class="p">(</span><span class="s">&#39;Error opening device on port {0}.&#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">_port</span><span class="p">),</span> <span class="n">err</span><span class="p">)</span>

  540. 

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

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

  543.             <span class="bp">self</span><span class="o">.</span><span class="n">on_open</span><span class="p">()</span>

  544. 

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

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

  547. </div>

  548. <div class="viewcode-block" id="SerialDevice.close"><a class="viewcode-back" href="../../pyad2.html#pyad2.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>

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

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

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

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

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

  554. 

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

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

  557. </div>

  558. <div class="viewcode-block" id="SerialDevice.write"><a class="viewcode-back" href="../../pyad2.html#pyad2.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>

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

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

  561. 

  562. <span class="sd">        :param data: The data to write.</span>

  563. <span class="sd">        :type data: str</span>

  564. 

  565. <span class="sd">        :raises: CommError</span>

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

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

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

  569. 

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

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

  572. 

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

  574.             <span class="k">raise</span> <span class="n">CommError</span><span class="p">(</span><span class="s">&#39;Error writing to device.&#39;</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>

  575. 

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

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

  578. </div>

  579. <div class="viewcode-block" id="SerialDevice.read"><a class="viewcode-back" href="../../pyad2.html#pyad2.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>

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

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

  582. 

  583. <span class="sd">        :returns: The character read from the device.</span>

  584. <span class="sd">        :raises: CommError</span>

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

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

  587. 

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

  589.             <span class="n">ret</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>

  590. 

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

  592.             <span class="k">raise</span> <span class="n">CommError</span><span class="p">(</span><span class="s">&#39;Error 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> <span class="n">err</span><span class="p">)</span>

  593. 

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

  595. </div>

  596. <div class="viewcode-block" id="SerialDevice.read_line"><a class="viewcode-back" href="../../pyad2.html#pyad2.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> <span class="n">purge_buffer</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>

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

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

  599. 

  600. <span class="sd">        :param timeout: The read timeout.</span>

  601. <span class="sd">        :type timeout: float</span>

  602. <span class="sd">        :param purge_buffer: Indicates whether to purge the buffer prior to reading.</span>

  603. <span class="sd">        :type purge_buffer: bool</span>

  604. 

  605. <span class="sd">        :returns: The line read.</span>

  606. <span class="sd">        :raises: CommError, TimeoutError</span>

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

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

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

  610. 

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

  612. 

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

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

  615. 

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

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

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

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

  620. 

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

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

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

  624. 

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

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

  627. 

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

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

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

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

  632. 

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

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

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

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

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

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

  639. 

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

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

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

  643. 

  644.             <span class="k">raise</span> <span class="n">CommError</span><span class="p">(</span><span class="s">&#39;Error 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> <span class="n">err</span><span class="p">)</span>

  645. 

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

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

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

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

  650. 

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

  652. 

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

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

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

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

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

  658. 

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

  660. </div></div>

  661. <div class="viewcode-block" id="SocketDevice"><a class="viewcode-back" href="../../pyad2.html#pyad2.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>

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

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

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

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

  666. 

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

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

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

  670. <span class="sd">        Retrieves the interface used to connect to the device.</span>

  671. 

  672. <span class="sd">        :returns: the interface used to connect to the device.</span>

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

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

  675. 

  676.     <span class="nd">@interface.setter</span>

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

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

  679. <span class="sd">        Sets the interface used to connect to the device.</span>

  680. 

  681. <span class="sd">        :param value: Tuple containing the device number and endpoint number to use.</span>

  682. <span class="sd">        :type value: tuple</span>

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

  684.         <span class="bp">self</span><span class="o">.</span><span class="n">_host</span> <span class="o">=</span> <span class="n">value</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>

  685.         <span class="bp">self</span><span class="o">.</span><span class="n">_port</span> <span class="o">=</span> <span class="n">value</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>

  686. </div>

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

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

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

  690. <span class="sd">        Retrieves whether or not the device is using SSL.</span>

  691. 

  692. <span class="sd">        :returns: Whether or not the device is using SSL.</span>

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

  694.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_use_ssl</span>

  695. 

  696.     <span class="nd">@ssl.setter</span>

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

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

  699. <span class="sd">        Sets whether or not SSL communication is in use.</span>

  700. 

  701. <span class="sd">        :param value: Whether or not SSL communication is in use.</span>

  702. <span class="sd">        :type value: bool</span>

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

  704.         <span class="bp">self</span><span class="o">.</span><span class="n">_use_ssl</span> <span class="o">=</span> <span class="n">value</span>

  705. </div>

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

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

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

  709. <span class="sd">        Retrieves the SSL client certificate path used for authentication.</span>

  710. 

  711. <span class="sd">        :returns: The certificate path</span>

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

  713.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ssl_certificate</span>

  714. 

  715.     <span class="nd">@ssl_certificate.setter</span>

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

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

  718. <span class="sd">        Sets the SSL client certificate to use for authentication.</span>

  719. 

  720. <span class="sd">        :param value: The path to the SSL certificate.</span>

  721. <span class="sd">        :type value: str</span>

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

  723.         <span class="bp">self</span><span class="o">.</span><span class="n">_ssl_certificate</span> <span class="o">=</span> <span class="n">value</span>

  724. </div>

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

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

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

  728. <span class="sd">        Retrieves the SSL client certificate key used for authentication.</span>

  729. 

  730. <span class="sd">        :returns: The key path</span>

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

  732.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ssl_key</span>

  733. 

  734.     <span class="nd">@ssl_key.setter</span>

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

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

  737. <span class="sd">        Sets the SSL client certificate key to use for authentication.</span>

  738. 

  739. <span class="sd">        :param value: The path to the SSL key.</span>

  740. <span class="sd">        :type value: str</span>

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

  742.         <span class="bp">self</span><span class="o">.</span><span class="n">_ssl_key</span> <span class="o">=</span> <span class="n">value</span>

  743. </div>

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

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

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

  747. <span class="sd">        Retrieves the SSL Certificate Authority certificate used for authentication.</span>

  748. 

  749. <span class="sd">        :returns: The CA path</span>

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

  751.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ssl_ca</span>

  752. 

  753.     <span class="nd">@ssl_ca.setter</span>

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

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

  756. <span class="sd">        Sets the SSL Certificate Authority certificate used for authentication.</span>

  757. 

  758. <span class="sd">        :param value: The path to the SSL CA certificate.</span>

  759. <span class="sd">        :type value: str</span>

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

  761.         <span class="bp">self</span><span class="o">.</span><span class="n">_ssl_ca</span> <span class="o">=</span> <span class="n">value</span>

  762. </div>

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

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

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

  766. 

  767. <span class="sd">        :param interface: Tuple containing the hostname and port of our target.</span>

  768. <span class="sd">        :type interface: tuple</span>

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

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

  771. 

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

  773.         <span class="bp">self</span><span class="o">.</span><span class="n">_use_ssl</span> <span class="o">=</span> <span class="bp">False</span>

  774.         <span class="bp">self</span><span class="o">.</span><span class="n">_ssl_certificate</span> <span class="o">=</span> <span class="bp">None</span>

  775.         <span class="bp">self</span><span class="o">.</span><span class="n">_ssl_key</span> <span class="o">=</span> <span class="bp">None</span>

  776.         <span class="bp">self</span><span class="o">.</span><span class="n">_ssl_ca</span> <span class="o">=</span> <span class="bp">None</span>

  777. 

  778. <div class="viewcode-block" id="SocketDevice.open"><a class="viewcode-back" href="../../pyad2.html#pyad2.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">no_reader_thread</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>

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

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

  781. 

  782. <span class="sd">        :param baudrate: The baudrate to use</span>

  783. <span class="sd">        :type baudrate: int</span>

  784. <span class="sd">        :param no_reader_thread: Whether or not to automatically open the reader thread.</span>

  785. <span class="sd">        :type no_reader_thread: bool</span>

  786. 

  787. <span class="sd">        :raises: NoDeviceError, CommError</span>

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

  789. 

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

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

  792. 

  793.             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_use_ssl</span><span class="p">:</span>

  794.                 <span class="bp">self</span><span class="o">.</span><span class="n">_init_ssl</span><span class="p">()</span>

  795. 

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

  797. 

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

  799. 

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

  801.             <span class="k">raise</span> <span class="n">NoDeviceError</span><span class="p">(</span><span class="s">&#39;Error opening 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> <span class="n">err</span><span class="p">)</span>

  802. 

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

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

  805. 

  806.             <span class="bp">self</span><span class="o">.</span><span class="n">on_open</span><span class="p">()</span>

  807. 

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

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

  810. </div>

  811. <div class="viewcode-block" id="SocketDevice.close"><a class="viewcode-back" href="../../pyad2.html#pyad2.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>

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

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

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

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

  816.             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">ssl</span><span class="p">:</span>

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

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

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

  820. 

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

  822. 

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

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

  825. </div>

  826. <div class="viewcode-block" id="SocketDevice.write"><a class="viewcode-back" href="../../pyad2.html#pyad2.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>

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

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

  829. 

  830. <span class="sd">        :param data: The data to write.</span>

  831. <span class="sd">        :type data: str</span>

  832. 

  833. <span class="sd">        :returns: The number of bytes sent.</span>

  834. <span class="sd">        :raises: CommError</span>

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

  836.         <span class="n">data_sent</span> <span class="o">=</span> <span class="bp">None</span>

  837. 

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

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

  840. 

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

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

  843. 

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

  845. 

  846.         <span class="k">except</span> <span class="p">(</span><span class="n">SSL</span><span class="o">.</span><span class="n">Error</span><span class="p">,</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>

  847.             <span class="k">raise</span> <span class="n">CommError</span><span class="p">(</span><span class="s">&#39;Error writing to device.&#39;</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>

  848. 

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

  850. </div>

  851. <div class="viewcode-block" id="SocketDevice.read"><a class="viewcode-back" href="../../pyad2.html#pyad2.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>

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

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

  854. 

  855. <span class="sd">        :returns: The character read from the device.</span>

  856. <span class="sd">        :raises: CommError</span>

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

  858.         <span class="n">data</span> <span class="o">=</span> <span class="bp">None</span>

  859. 

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

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

  862. 

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

  864.             <span class="k">raise</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> <span class="n">err</span><span class="p">)</span>

  865. 

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

  867. </div>

  868. <div class="viewcode-block" id="SocketDevice.read_line"><a class="viewcode-back" href="../../pyad2.html#pyad2.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> <span class="n">purge_buffer</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>

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

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

  871. 

  872. <span class="sd">        :param timeout: The read timeout.</span>

  873. <span class="sd">        :type timeout: float</span>

  874. <span class="sd">        :param purge_buffer: Indicates whether to purge the buffer prior to reading.</span>

  875. <span class="sd">        :type purge_buffer: bool</span>

  876. 

  877. <span class="sd">        :returns: The line read from the device.</span>

  878. <span class="sd">        :raises: CommError, TimeoutError</span>

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

  880. 

  881.         <span class="k">if</span> <span class="n">purge_buffer</span><span class="p">:</span>

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

  883. 

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

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

  886. 

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

  888. 

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

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

  891. 

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

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

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

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

  896. 

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

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

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

  900. 

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

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

  903. 

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

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

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

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

  908. 

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

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

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

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

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

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

  915. 

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

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

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

  919. 

  920.             <span class="k">raise</span> <span class="n">CommError</span><span class="p">(</span><span class="s">&#39;Error 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> <span class="n">err</span><span class="p">)</span>

  921. 

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

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

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

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

  926. 

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

  928. 

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

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

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

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

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

  934. 

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

  936. </div>

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

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

  939.             <span class="n">ctx</span> <span class="o">=</span> <span class="n">SSL</span><span class="o">.</span><span class="n">Context</span><span class="p">(</span><span class="n">SSL</span><span class="o">.</span><span class="n">TLSv1_METHOD</span><span class="p">)</span>

  940. 

  941.             <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ssl_key</span><span class="p">,</span> <span class="n">crypto</span><span class="o">.</span><span class="n">PKey</span><span class="p">):</span>

  942.                 <span class="n">ctx</span><span class="o">.</span><span class="n">use_privatekey</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ssl_key</span><span class="p">)</span>

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

  944.                 <span class="n">ctx</span><span class="o">.</span><span class="n">use_privatekey_file</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ssl_key</span><span class="p">)</span>

  945. 

  946.             <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ssl_certificate</span><span class="p">,</span> <span class="n">crypto</span><span class="o">.</span><span class="n">X509</span><span class="p">):</span>

  947.                 <span class="n">ctx</span><span class="o">.</span><span class="n">use_certificate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ssl_certificate</span><span class="p">)</span>

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

  949.                 <span class="n">ctx</span><span class="o">.</span><span class="n">use_certificate_file</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ssl_certificate</span><span class="p">)</span>

  950. 

  951.             <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ssl_ca</span><span class="p">,</span> <span class="n">crypto</span><span class="o">.</span><span class="n">X509</span><span class="p">):</span>

  952.                 <span class="n">store</span> <span class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span class="n">get_cert_store</span><span class="p">()</span>

  953.                 <span class="n">store</span><span class="o">.</span><span class="n">add_cert</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ssl_ca</span><span class="p">)</span>

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

  955.                 <span class="n">ctx</span><span class="o">.</span><span class="n">load_verify_locations</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ssl_ca</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>

  956. 

  957.             <span class="n">ctx</span><span class="o">.</span><span class="n">set_verify</span><span class="p">(</span><span class="n">SSL</span><span class="o">.</span><span class="n">VERIFY_PEER</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_verify_ssl_callback</span><span class="p">)</span>

  958. 

  959.             <span class="bp">self</span><span class="o">.</span><span class="n">_device</span> <span class="o">=</span> <span class="n">SSL</span><span class="o">.</span><span class="n">Connection</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_device</span><span class="p">)</span>

  960. 

  961.         <span class="k">except</span> <span class="n">SSL</span><span class="o">.</span><span class="n">Error</span><span class="p">,</span> <span class="n">err</span><span class="p">:</span>

  962.             <span class="k">raise</span> <span class="n">CommError</span><span class="p">(</span><span class="s">&#39;Error setting up SSL connection.&#39;</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>

  963. 

  964.     <span class="k">def</span> <span class="nf">_verify_ssl_callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">connection</span><span class="p">,</span> <span class="n">x509</span><span class="p">,</span> <span class="n">errnum</span><span class="p">,</span> <span class="n">errdepth</span><span class="p">,</span> <span class="n">ok</span><span class="p">):</span>

  965.         <span class="k">return</span> <span class="n">ok</span></div>

  966. </pre></div>

  967. 

  968.           </div>

  969.         </div>

  970.       </div>

  971.       <div class="sphinxsidebar">

  972.         <div class="sphinxsidebarwrapper">

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

  974.   <h3>Quick search</h3>

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

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

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

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

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

  980.     </form>

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

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

  983.     </p>

  984. </div>

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

  986.         </div>

  987.       </div>

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

  989.     </div>

  990.     <div class="related">

  991.       <h3>Navigation</h3>

  992.       <ul>

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

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

  995.              >index</a></li>

  996.         <li class="right" >

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

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

  999.         <li><a href="../../index.html">pyad2  documentation</a> &raquo;</li>

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

  1001.       </ul>

  1002.     </div>

  1003.     <div class="footer">

  1004.         &copy; Copyright 2013, Author.

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

  1006.     </div>

  1007.   </body>

  1008. </html>