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

691 lines
44 KiB
Raw Blame History 

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

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

  3. 

  4. 

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

  6.   <head>

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

  8.     

  9.     <title>pyad2usb Package &mdash; pyad2usb  documentation</title>

  10.     

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

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

  13.     

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

  15.       var DOCUMENTATION_OPTIONS = {

  16.         URL_ROOT:    './',

  17.         VERSION:     '',

  18.         COLLAPSE_INDEX: false,

  19.         FILE_SUFFIX: '.html',

  20.         HAS_SOURCE:  true

  21.       };

  22.     </script>

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

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

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

  26.     <link rel="top" title="pyad2usb  documentation" href="index.html" />

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

  28.     <link rel="prev" title="Welcome to pyad2usb’s documentation!" href="index.html" /> 

  29.   </head>

  30.   <body>

  31.     <div class="related">

  32.       <h3>Navigation</h3>

  33.       <ul>

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

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

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

  37.         <li class="right" >

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

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

  40.         <li class="right" >

  41.           <a href="pyad2usb.event.html" title="event Package"

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

  43.         <li class="right" >

  44.           <a href="index.html" title="Welcome to pyad2usb’s documentation!"

  45.              accesskey="P">previous</a> |</li>

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

  47.       </ul>

  48.     </div>  

  49. 

  50.     <div class="document">

  51.       <div class="documentwrapper">

  52.         <div class="bodywrapper">

  53.           <div class="body">

  54.             

  55.   <div class="section" id="pyad2usb-package">

  56. <h1>pyad2usb Package<a class="headerlink" href="#pyad2usb-package" title="Permalink to this headline">¶</a></h1>

  57. <div class="section" id="id1">

  58. <h2><tt class="xref py py-mod docutils literal"><span class="pre">pyad2usb</span></tt> Package<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>

  59. <span class="target" id="module-pyad2usb.__init__"></span><p>The PyAD2USB module.</p>

  60. </div>

  61. <div class="section" id="module-pyad2usb.ad2usb">

  62. <span id="ad2usb-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">ad2usb</span></tt> Module<a class="headerlink" href="#module-pyad2usb.ad2usb" title="Permalink to this headline">¶</a></h2>

  63. <p>Provides the full AD2USB class and factory.</p>

  64. <dl class="class">

  65. <dt id="pyad2usb.ad2usb.AD2USB">

  66. <em class="property">class </em><tt class="descclassname">pyad2usb.ad2usb.</tt><tt class="descname">AD2USB</tt><big>(</big><em>device</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/ad2usb.html#AD2USB"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB" title="Permalink to this definition">¶</a></dt>

  67. <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>

  68. <p>High-level wrapper around AD2USB/AD2SERIAL devices.</p>

  69. <dl class="attribute">

  70. <dt id="pyad2usb.ad2usb.AD2USB.F1">

  71. <tt class="descname">F1</tt><em class="property"> = u'\x01\x01\x01'</em><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.F1" title="Permalink to this definition">¶</a></dt>

  72. <dd></dd></dl>

  73. 

  74. <dl class="attribute">

  75. <dt id="pyad2usb.ad2usb.AD2USB.F2">

  76. <tt class="descname">F2</tt><em class="property"> = u'\x02\x02\x02'</em><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.F2" title="Permalink to this definition">¶</a></dt>

  77. <dd></dd></dl>

  78. 

  79. <dl class="attribute">

  80. <dt id="pyad2usb.ad2usb.AD2USB.F3">

  81. <tt class="descname">F3</tt><em class="property"> = u'\x03\x03\x03'</em><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.F3" title="Permalink to this definition">¶</a></dt>

  82. <dd></dd></dl>

  83. 

  84. <dl class="attribute">

  85. <dt id="pyad2usb.ad2usb.AD2USB.F4">

  86. <tt class="descname">F4</tt><em class="property"> = u'\x04\x04\x04'</em><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.F4" title="Permalink to this definition">¶</a></dt>

  87. <dd></dd></dl>

  88. 

  89. <dl class="method">

  90. <dt id="pyad2usb.ad2usb.AD2USB.close">

  91. <tt class="descname">close</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2usb/ad2usb.html#AD2USB.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.close" title="Permalink to this definition">¶</a></dt>

  92. <dd><p>Closes the device.</p>

  93. </dd></dl>

  94. 

  95. <dl class="method">

  96. <dt id="pyad2usb.ad2usb.AD2USB.get_config">

  97. <tt class="descname">get_config</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2usb/ad2usb.html#AD2USB.get_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.get_config" title="Permalink to this definition">¶</a></dt>

  98. <dd><p>Retrieves the configuration from the device.</p>

  99. </dd></dl>

  100. 

  101. <dl class="attribute">

  102. <dt id="pyad2usb.ad2usb.AD2USB.id">

  103. <tt class="descname">id</tt><a class="reference internal" href="_modules/pyad2usb/ad2usb.html#AD2USB.id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.id" title="Permalink to this definition">¶</a></dt>

  104. <dd></dd></dl>

  105. 

  106. <dl class="attribute">

  107. <dt id="pyad2usb.ad2usb.AD2USB.on_alarm">

  108. <tt class="descname">on_alarm</tt><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.on_alarm" title="Permalink to this definition">¶</a></dt>

  109. <dd><p>Called when the alarm is triggered.</p>

  110. </dd></dl>

  111. 

  112. <dl class="attribute">

  113. <dt id="pyad2usb.ad2usb.AD2USB.on_boot">

  114. <tt class="descname">on_boot</tt><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.on_boot" title="Permalink to this definition">¶</a></dt>

  115. <dd><p>Called when the device finishes bootings.</p>

  116. </dd></dl>

  117. 

  118. <dl class="attribute">

  119. <dt id="pyad2usb.ad2usb.AD2USB.on_bypass">

  120. <tt class="descname">on_bypass</tt><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.on_bypass" title="Permalink to this definition">¶</a></dt>

  121. <dd><p>Called when a zone is bypassed.</p>

  122. </dd></dl>

  123. 

  124. <dl class="attribute">

  125. <dt id="pyad2usb.ad2usb.AD2USB.on_close">

  126. <tt class="descname">on_close</tt><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.on_close" title="Permalink to this definition">¶</a></dt>

  127. <dd><p>Called when the device has been closed.</p>

  128. </dd></dl>

  129. 

  130. <dl class="attribute">

  131. <dt id="pyad2usb.ad2usb.AD2USB.on_config_received">

  132. <tt class="descname">on_config_received</tt><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.on_config_received" title="Permalink to this definition">¶</a></dt>

  133. <dd><p>Called when the device receives its configuration.</p>

  134. </dd></dl>

  135. 

  136. <dl class="attribute">

  137. <dt id="pyad2usb.ad2usb.AD2USB.on_message">

  138. <tt class="descname">on_message</tt><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.on_message" title="Permalink to this definition">¶</a></dt>

  139. <dd><p>Called when a message has been received from the device.</p>

  140. </dd></dl>

  141. 

  142. <dl class="attribute">

  143. <dt id="pyad2usb.ad2usb.AD2USB.on_open">

  144. <tt class="descname">on_open</tt><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.on_open" title="Permalink to this definition">¶</a></dt>

  145. <dd><p>Called when the device has been opened.</p>

  146. </dd></dl>

  147. 

  148. <dl class="attribute">

  149. <dt id="pyad2usb.ad2usb.AD2USB.on_power_changed">

  150. <tt class="descname">on_power_changed</tt><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.on_power_changed" title="Permalink to this definition">¶</a></dt>

  151. <dd><p>Called when panel power switches between AC and DC.</p>

  152. </dd></dl>

  153. 

  154. <dl class="attribute">

  155. <dt id="pyad2usb.ad2usb.AD2USB.on_read">

  156. <tt class="descname">on_read</tt><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.on_read" title="Permalink to this definition">¶</a></dt>

  157. <dd><p>Called when a line has been read from the device.</p>

  158. </dd></dl>

  159. 

  160. <dl class="attribute">

  161. <dt id="pyad2usb.ad2usb.AD2USB.on_status_changed">

  162. <tt class="descname">on_status_changed</tt><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.on_status_changed" title="Permalink to this definition">¶</a></dt>

  163. <dd><p>Called when the panel status changes.</p>

  164. </dd></dl>

  165. 

  166. <dl class="attribute">

  167. <dt id="pyad2usb.ad2usb.AD2USB.on_write">

  168. <tt class="descname">on_write</tt><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.on_write" title="Permalink to this definition">¶</a></dt>

  169. <dd><p>Called when data has been written to the device.</p>

  170. </dd></dl>

  171. 

  172. <dl class="method">

  173. <dt id="pyad2usb.ad2usb.AD2USB.open">

  174. <tt class="descname">open</tt><big>(</big><em>baudrate=None</em>, <em>interface=None</em>, <em>index=None</em>, <em>no_reader_thread=False</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/ad2usb.html#AD2USB.open"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.open" title="Permalink to this definition">¶</a></dt>

  175. <dd><p>Opens the device.</p>

  176. </dd></dl>

  177. 

  178. <dl class="method">

  179. <dt id="pyad2usb.ad2usb.AD2USB.reboot">

  180. <tt class="descname">reboot</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2usb/ad2usb.html#AD2USB.reboot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.reboot" title="Permalink to this definition">¶</a></dt>

  181. <dd><p>Reboots the device.</p>

  182. </dd></dl>

  183. 

  184. <dl class="method">

  185. <dt id="pyad2usb.ad2usb.AD2USB.set_config">

  186. <tt class="descname">set_config</tt><big>(</big><em>settings</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/ad2usb.html#AD2USB.set_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.set_config" title="Permalink to this definition">¶</a></dt>

  187. <dd><p>Sets configuration entries on the device.</p>

  188. </dd></dl>

  189. 

  190. </dd></dl>

  191. 

  192. <dl class="class">

  193. <dt id="pyad2usb.ad2usb.ExpanderMessage">

  194. <em class="property">class </em><tt class="descclassname">pyad2usb.ad2usb.</tt><tt class="descname">ExpanderMessage</tt><big>(</big><em>data=None</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/ad2usb.html#ExpanderMessage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.ad2usb.ExpanderMessage" title="Permalink to this definition">¶</a></dt>

  195. <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>

  196. <p>Represents a message from a zone or relay expansion module.</p>

  197. <dl class="attribute">

  198. <dt id="pyad2usb.ad2usb.ExpanderMessage.RELAY">

  199. <tt class="descname">RELAY</tt><em class="property"> = 1</em><a class="headerlink" href="#pyad2usb.ad2usb.ExpanderMessage.RELAY" title="Permalink to this definition">¶</a></dt>

  200. <dd></dd></dl>

  201. 

  202. <dl class="attribute">

  203. <dt id="pyad2usb.ad2usb.ExpanderMessage.ZONE">

  204. <tt class="descname">ZONE</tt><em class="property"> = 0</em><a class="headerlink" href="#pyad2usb.ad2usb.ExpanderMessage.ZONE" title="Permalink to this definition">¶</a></dt>

  205. <dd></dd></dl>

  206. 

  207. </dd></dl>

  208. 

  209. <dl class="class">

  210. <dt id="pyad2usb.ad2usb.LRRMessage">

  211. <em class="property">class </em><tt class="descclassname">pyad2usb.ad2usb.</tt><tt class="descname">LRRMessage</tt><big>(</big><em>data=None</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/ad2usb.html#LRRMessage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.ad2usb.LRRMessage" title="Permalink to this definition">¶</a></dt>

  212. <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>

  213. <p>Represent a message from a Long Range Radio.</p>

  214. </dd></dl>

  215. 

  216. <dl class="class">

  217. <dt id="pyad2usb.ad2usb.Message">

  218. <em class="property">class </em><tt class="descclassname">pyad2usb.ad2usb.</tt><tt class="descname">Message</tt><big>(</big><em>data=None</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/ad2usb.html#Message"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.ad2usb.Message" title="Permalink to this definition">¶</a></dt>

  219. <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>

  220. <p>Represents a message from the alarm panel.</p>

  221. </dd></dl>

  222. 

  223. <dl class="class">

  224. <dt id="pyad2usb.ad2usb.Overseer">

  225. <em class="property">class </em><tt class="descclassname">pyad2usb.ad2usb.</tt><tt class="descname">Overseer</tt><big>(</big><em>attached_event=None</em>, <em>detached_event=None</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/ad2usb.html#Overseer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.ad2usb.Overseer" title="Permalink to this definition">¶</a></dt>

  226. <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>

  227. <p>Factory for creation of AD2USB devices as well as provide4s attach/detach events.&#8221;</p>

  228. <dl class="class">

  229. <dt id="pyad2usb.ad2usb.Overseer.DetectThread">

  230. <em class="property">class </em><tt class="descname">DetectThread</tt><big>(</big><em>overseer</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/ad2usb.html#Overseer.DetectThread"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.ad2usb.Overseer.DetectThread" title="Permalink to this definition">¶</a></dt>

  231. <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">threading.Thread</span></tt></p>

  232. <p>Thread that handles detection of added/removed devices.</p>

  233. <dl class="method">

  234. <dt id="pyad2usb.ad2usb.Overseer.DetectThread.run">

  235. <tt class="descname">run</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2usb/ad2usb.html#Overseer.DetectThread.run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.ad2usb.Overseer.DetectThread.run" title="Permalink to this definition">¶</a></dt>

  236. <dd><p>The actual detection process.</p>

  237. </dd></dl>

  238. 

  239. <dl class="method">

  240. <dt id="pyad2usb.ad2usb.Overseer.DetectThread.stop">

  241. <tt class="descname">stop</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2usb/ad2usb.html#Overseer.DetectThread.stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.ad2usb.Overseer.DetectThread.stop" title="Permalink to this definition">¶</a></dt>

  242. <dd><p>Stops the thread.</p>

  243. </dd></dl>

  244. 

  245. </dd></dl>

  246. 

  247. <dl class="method">

  248. <dt id="pyad2usb.ad2usb.Overseer.close">

  249. <tt class="descclassname">Overseer.</tt><tt class="descname">close</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2usb/ad2usb.html#Overseer.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.ad2usb.Overseer.close" title="Permalink to this definition">¶</a></dt>

  250. <dd><p>Clean up and shut down.</p>

  251. </dd></dl>

  252. 

  253. <dl class="classmethod">

  254. <dt id="pyad2usb.ad2usb.Overseer.create">

  255. <em class="property">classmethod </em><tt class="descclassname">Overseer.</tt><tt class="descname">create</tt><big>(</big><em>device=None</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/ad2usb.html#Overseer.create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.ad2usb.Overseer.create" title="Permalink to this definition">¶</a></dt>

  256. <dd><p>Factory method that returns the requested AD2USB device, or the first device.</p>

  257. </dd></dl>

  258. 

  259. <dl class="classmethod">

  260. <dt id="pyad2usb.ad2usb.Overseer.devices">

  261. <em class="property">classmethod </em><tt class="descclassname">Overseer.</tt><tt class="descname">devices</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2usb/ad2usb.html#Overseer.devices"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.ad2usb.Overseer.devices" title="Permalink to this definition">¶</a></dt>

  262. <dd><p>Returns a cached list of AD2USB devices located on the system.</p>

  263. </dd></dl>

  264. 

  265. <dl class="classmethod">

  266. <dt id="pyad2usb.ad2usb.Overseer.find_all">

  267. <em class="property">classmethod </em><tt class="descclassname">Overseer.</tt><tt class="descname">find_all</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2usb/ad2usb.html#Overseer.find_all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.ad2usb.Overseer.find_all" title="Permalink to this definition">¶</a></dt>

  268. <dd><p>Returns all AD2USB devices located on the system.</p>

  269. </dd></dl>

  270. 

  271. <dl class="method">

  272. <dt id="pyad2usb.ad2usb.Overseer.get_device">

  273. <tt class="descclassname">Overseer.</tt><tt class="descname">get_device</tt><big>(</big><em>device=None</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/ad2usb.html#Overseer.get_device"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.ad2usb.Overseer.get_device" title="Permalink to this definition">¶</a></dt>

  274. <dd><p>Factory method that returns the requested AD2USB device, or the first device.</p>

  275. </dd></dl>

  276. 

  277. <dl class="attribute">

  278. <dt id="pyad2usb.ad2usb.Overseer.on_attached">

  279. <tt class="descclassname">Overseer.</tt><tt class="descname">on_attached</tt><a class="headerlink" href="#pyad2usb.ad2usb.Overseer.on_attached" title="Permalink to this definition">¶</a></dt>

  280. <dd><p>Called when an AD2USB device has been detected.</p>

  281. </dd></dl>

  282. 

  283. <dl class="attribute">

  284. <dt id="pyad2usb.ad2usb.Overseer.on_detached">

  285. <tt class="descclassname">Overseer.</tt><tt class="descname">on_detached</tt><a class="headerlink" href="#pyad2usb.ad2usb.Overseer.on_detached" title="Permalink to this definition">¶</a></dt>

  286. <dd><p>Called when an AD2USB device has been removed.</p>

  287. </dd></dl>

  288. 

  289. <dl class="method">

  290. <dt id="pyad2usb.ad2usb.Overseer.start">

  291. <tt class="descclassname">Overseer.</tt><tt class="descname">start</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2usb/ad2usb.html#Overseer.start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.ad2usb.Overseer.start" title="Permalink to this definition">¶</a></dt>

  292. <dd><p>Starts the detection thread, if not already running.</p>

  293. </dd></dl>

  294. 

  295. <dl class="method">

  296. <dt id="pyad2usb.ad2usb.Overseer.stop">

  297. <tt class="descclassname">Overseer.</tt><tt class="descname">stop</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2usb/ad2usb.html#Overseer.stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.ad2usb.Overseer.stop" title="Permalink to this definition">¶</a></dt>

  298. <dd><p>Stops the detection thread.</p>

  299. </dd></dl>

  300. 

  301. </dd></dl>

  302. 

  303. <dl class="class">

  304. <dt id="pyad2usb.ad2usb.RFMessage">

  305. <em class="property">class </em><tt class="descclassname">pyad2usb.ad2usb.</tt><tt class="descname">RFMessage</tt><big>(</big><em>data=None</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/ad2usb.html#RFMessage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.ad2usb.RFMessage" title="Permalink to this definition">¶</a></dt>

  306. <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>

  307. <p>Represents a message from an RF receiver.</p>

  308. </dd></dl>

  309. 

  310. </div>

  311. <div class="section" id="module-pyad2usb.devices">

  312. <span id="devices-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">devices</span></tt> Module<a class="headerlink" href="#module-pyad2usb.devices" title="Permalink to this headline">¶</a></h2>

  313. <p>Contains different types of devices belonging to the AD2USB family.</p>

  314. <dl class="class">

  315. <dt id="pyad2usb.devices.Device">

  316. <em class="property">class </em><tt class="descclassname">pyad2usb.devices.</tt><tt class="descname">Device</tt><a class="reference internal" href="_modules/pyad2usb/devices.html#Device"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.Device" title="Permalink to this definition">¶</a></dt>

  317. <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>

  318. <p>Generic parent device to all AD2USB products.</p>

  319. <dl class="class">

  320. <dt id="pyad2usb.devices.Device.ReadThread">

  321. <em class="property">class </em><tt class="descname">ReadThread</tt><big>(</big><em>device</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#Device.ReadThread"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.Device.ReadThread" title="Permalink to this definition">¶</a></dt>

  322. <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">threading.Thread</span></tt></p>

  323. <p>Reader thread which processes messages from the device.</p>

  324. <dl class="attribute">

  325. <dt id="pyad2usb.devices.Device.ReadThread.READ_TIMEOUT">

  326. <tt class="descname">READ_TIMEOUT</tt><em class="property"> = 10</em><a class="headerlink" href="#pyad2usb.devices.Device.ReadThread.READ_TIMEOUT" title="Permalink to this definition">¶</a></dt>

  327. <dd></dd></dl>

  328. 

  329. <dl class="method">

  330. <dt id="pyad2usb.devices.Device.ReadThread.run">

  331. <tt class="descname">run</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#Device.ReadThread.run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.Device.ReadThread.run" title="Permalink to this definition">¶</a></dt>

  332. <dd><p>The actual read process.</p>

  333. </dd></dl>

  334. 

  335. <dl class="method">

  336. <dt id="pyad2usb.devices.Device.ReadThread.stop">

  337. <tt class="descname">stop</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#Device.ReadThread.stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.Device.ReadThread.stop" title="Permalink to this definition">¶</a></dt>

  338. <dd><p>Stops the running thread.</p>

  339. </dd></dl>

  340. 

  341. </dd></dl>

  342. 

  343. <dl class="attribute">

  344. <dt id="pyad2usb.devices.Device.id">

  345. <tt class="descclassname">Device.</tt><tt class="descname">id</tt><a class="reference internal" href="_modules/pyad2usb/devices.html#Device.id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.Device.id" title="Permalink to this definition">¶</a></dt>

  346. <dd></dd></dl>

  347. 

  348. <dl class="method">

  349. <dt id="pyad2usb.devices.Device.is_reader_alive">

  350. <tt class="descclassname">Device.</tt><tt class="descname">is_reader_alive</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#Device.is_reader_alive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.Device.is_reader_alive" title="Permalink to this definition">¶</a></dt>

  351. <dd><p>Indicates whether or not the reader thread is alive.</p>

  352. </dd></dl>

  353. 

  354. <dl class="attribute">

  355. <dt id="pyad2usb.devices.Device.on_close">

  356. <tt class="descclassname">Device.</tt><tt class="descname">on_close</tt><a class="headerlink" href="#pyad2usb.devices.Device.on_close" title="Permalink to this definition">¶</a></dt>

  357. <dd><p>Called when the device has been closed</p>

  358. </dd></dl>

  359. 

  360. <dl class="attribute">

  361. <dt id="pyad2usb.devices.Device.on_open">

  362. <tt class="descclassname">Device.</tt><tt class="descname">on_open</tt><a class="headerlink" href="#pyad2usb.devices.Device.on_open" title="Permalink to this definition">¶</a></dt>

  363. <dd><p>Called when the device has been opened</p>

  364. </dd></dl>

  365. 

  366. <dl class="attribute">

  367. <dt id="pyad2usb.devices.Device.on_read">

  368. <tt class="descclassname">Device.</tt><tt class="descname">on_read</tt><a class="headerlink" href="#pyad2usb.devices.Device.on_read" title="Permalink to this definition">¶</a></dt>

  369. <dd><p>Called when a line has been read from the device</p>

  370. </dd></dl>

  371. 

  372. <dl class="attribute">

  373. <dt id="pyad2usb.devices.Device.on_write">

  374. <tt class="descclassname">Device.</tt><tt class="descname">on_write</tt><a class="headerlink" href="#pyad2usb.devices.Device.on_write" title="Permalink to this definition">¶</a></dt>

  375. <dd><p>Called when data has been written to the device</p>

  376. </dd></dl>

  377. 

  378. <dl class="method">

  379. <dt id="pyad2usb.devices.Device.stop_reader">

  380. <tt class="descclassname">Device.</tt><tt class="descname">stop_reader</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#Device.stop_reader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.Device.stop_reader" title="Permalink to this definition">¶</a></dt>

  381. <dd><p>Stops the reader thread.</p>

  382. </dd></dl>

  383. 

  384. </dd></dl>

  385. 

  386. <dl class="class">

  387. <dt id="pyad2usb.devices.SerialDevice">

  388. <em class="property">class </em><tt class="descclassname">pyad2usb.devices.</tt><tt class="descname">SerialDevice</tt><big>(</big><em>interface=None</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#SerialDevice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.SerialDevice" title="Permalink to this definition">¶</a></dt>

  389. <dd><p>Bases: <a class="reference internal" href="#pyad2usb.devices.Device" title="pyad2usb.devices.Device"><tt class="xref py py-class docutils literal"><span class="pre">pyad2usb.devices.Device</span></tt></a></p>

  390. <p>AD2USB or AD2SERIAL device exposed with the pyserial interface.</p>

  391. <dl class="attribute">

  392. <dt id="pyad2usb.devices.SerialDevice.BAUDRATE">

  393. <tt class="descname">BAUDRATE</tt><em class="property"> = 19200</em><a class="headerlink" href="#pyad2usb.devices.SerialDevice.BAUDRATE" title="Permalink to this definition">¶</a></dt>

  394. <dd></dd></dl>

  395. 

  396. <dl class="method">

  397. <dt id="pyad2usb.devices.SerialDevice.close">

  398. <tt class="descname">close</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#SerialDevice.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.SerialDevice.close" title="Permalink to this definition">¶</a></dt>

  399. <dd><p>Closes the device.</p>

  400. </dd></dl>

  401. 

  402. <dl class="staticmethod">

  403. <dt id="pyad2usb.devices.SerialDevice.find_all">

  404. <em class="property">static </em><tt class="descname">find_all</tt><big>(</big><em>pattern=None</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#SerialDevice.find_all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.SerialDevice.find_all" title="Permalink to this definition">¶</a></dt>

  405. <dd><p>Returns all serial ports present.</p>

  406. </dd></dl>

  407. 

  408. <dl class="method">

  409. <dt id="pyad2usb.devices.SerialDevice.open">

  410. <tt class="descname">open</tt><big>(</big><em>baudrate=19200</em>, <em>interface=None</em>, <em>index=None</em>, <em>no_reader_thread=False</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#SerialDevice.open"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.SerialDevice.open" title="Permalink to this definition">¶</a></dt>

  411. <dd><p>Opens the device.</p>

  412. </dd></dl>

  413. 

  414. <dl class="method">

  415. <dt id="pyad2usb.devices.SerialDevice.read">

  416. <tt class="descname">read</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#SerialDevice.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.SerialDevice.read" title="Permalink to this definition">¶</a></dt>

  417. <dd><p>Reads a single character from the device.</p>

  418. </dd></dl>

  419. 

  420. <dl class="method">

  421. <dt id="pyad2usb.devices.SerialDevice.read_line">

  422. <tt class="descname">read_line</tt><big>(</big><em>timeout=0.0</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#SerialDevice.read_line"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.SerialDevice.read_line" title="Permalink to this definition">¶</a></dt>

  423. <dd><p>Reads a line from the device.</p>

  424. </dd></dl>

  425. 

  426. <dl class="method">

  427. <dt id="pyad2usb.devices.SerialDevice.write">

  428. <tt class="descname">write</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#SerialDevice.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.SerialDevice.write" title="Permalink to this definition">¶</a></dt>

  429. <dd><p>Writes data to the device.</p>

  430. </dd></dl>

  431. 

  432. </dd></dl>

  433. 

  434. <dl class="class">

  435. <dt id="pyad2usb.devices.SocketDevice">

  436. <em class="property">class </em><tt class="descclassname">pyad2usb.devices.</tt><tt class="descname">SocketDevice</tt><big>(</big><em>interface=('localhost'</em>, <em>10000)</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#SocketDevice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.SocketDevice" title="Permalink to this definition">¶</a></dt>

  437. <dd><p>Bases: <a class="reference internal" href="#pyad2usb.devices.Device" title="pyad2usb.devices.Device"><tt class="xref py py-class docutils literal"><span class="pre">pyad2usb.devices.Device</span></tt></a></p>

  438. <p>Device that supports communication with an AD2USB that is exposed via ser2sock or another

  439. Serial to IP interface.</p>

  440. <dl class="method">

  441. <dt id="pyad2usb.devices.SocketDevice.close">

  442. <tt class="descname">close</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#SocketDevice.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.SocketDevice.close" title="Permalink to this definition">¶</a></dt>

  443. <dd><p>Closes the device.</p>

  444. </dd></dl>

  445. 

  446. <dl class="method">

  447. <dt id="pyad2usb.devices.SocketDevice.open">

  448. <tt class="descname">open</tt><big>(</big><em>baudrate=None</em>, <em>interface=None</em>, <em>index=0</em>, <em>no_reader_thread=False</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#SocketDevice.open"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.SocketDevice.open" title="Permalink to this definition">¶</a></dt>

  449. <dd><p>Opens the device.</p>

  450. </dd></dl>

  451. 

  452. <dl class="method">

  453. <dt id="pyad2usb.devices.SocketDevice.read">

  454. <tt class="descname">read</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#SocketDevice.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.SocketDevice.read" title="Permalink to this definition">¶</a></dt>

  455. <dd><p>Reads a single character from the device.</p>

  456. </dd></dl>

  457. 

  458. <dl class="method">

  459. <dt id="pyad2usb.devices.SocketDevice.read_line">

  460. <tt class="descname">read_line</tt><big>(</big><em>timeout=0.0</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#SocketDevice.read_line"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.SocketDevice.read_line" title="Permalink to this definition">¶</a></dt>

  461. <dd><p>Reads a line from the device.</p>

  462. </dd></dl>

  463. 

  464. <dl class="method">

  465. <dt id="pyad2usb.devices.SocketDevice.write">

  466. <tt class="descname">write</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#SocketDevice.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.SocketDevice.write" title="Permalink to this definition">¶</a></dt>

  467. <dd><p>Writes data to the device.</p>

  468. </dd></dl>

  469. 

  470. </dd></dl>

  471. 

  472. <dl class="class">

  473. <dt id="pyad2usb.devices.USBDevice">

  474. <em class="property">class </em><tt class="descclassname">pyad2usb.devices.</tt><tt class="descname">USBDevice</tt><big>(</big><em>vid=1027</em>, <em>pid=24577</em>, <em>serial=None</em>, <em>description=None</em>, <em>interface=0</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#USBDevice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.USBDevice" title="Permalink to this definition">¶</a></dt>

  475. <dd><p>Bases: <a class="reference internal" href="#pyad2usb.devices.Device" title="pyad2usb.devices.Device"><tt class="xref py py-class docutils literal"><span class="pre">pyad2usb.devices.Device</span></tt></a></p>

  476. <p>AD2USB device exposed with PyFTDI&#8217;s interface.</p>

  477. <dl class="attribute">

  478. <dt id="pyad2usb.devices.USBDevice.BAUDRATE">

  479. <tt class="descname">BAUDRATE</tt><em class="property"> = 115200</em><a class="headerlink" href="#pyad2usb.devices.USBDevice.BAUDRATE" title="Permalink to this definition">¶</a></dt>

  480. <dd></dd></dl>

  481. 

  482. <dl class="attribute">

  483. <dt id="pyad2usb.devices.USBDevice.FTDI_PRODUCT_ID">

  484. <tt class="descname">FTDI_PRODUCT_ID</tt><em class="property"> = 24577</em><a class="headerlink" href="#pyad2usb.devices.USBDevice.FTDI_PRODUCT_ID" title="Permalink to this definition">¶</a></dt>

  485. <dd></dd></dl>

  486. 

  487. <dl class="attribute">

  488. <dt id="pyad2usb.devices.USBDevice.FTDI_VENDOR_ID">

  489. <tt class="descname">FTDI_VENDOR_ID</tt><em class="property"> = 1027</em><a class="headerlink" href="#pyad2usb.devices.USBDevice.FTDI_VENDOR_ID" title="Permalink to this definition">¶</a></dt>

  490. <dd></dd></dl>

  491. 

  492. <dl class="method">

  493. <dt id="pyad2usb.devices.USBDevice.close">

  494. <tt class="descname">close</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#USBDevice.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.USBDevice.close" title="Permalink to this definition">¶</a></dt>

  495. <dd><p>Closes the device.</p>

  496. </dd></dl>

  497. 

  498. <dl class="staticmethod">

  499. <dt id="pyad2usb.devices.USBDevice.find_all">

  500. <em class="property">static </em><tt class="descname">find_all</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#USBDevice.find_all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.USBDevice.find_all" title="Permalink to this definition">¶</a></dt>

  501. <dd><p>Returns all FTDI devices matching our vendor and product IDs.</p>

  502. </dd></dl>

  503. 

  504. <dl class="method">

  505. <dt id="pyad2usb.devices.USBDevice.open">

  506. <tt class="descname">open</tt><big>(</big><em>baudrate=115200</em>, <em>interface=None</em>, <em>index=0</em>, <em>no_reader_thread=False</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#USBDevice.open"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.USBDevice.open" title="Permalink to this definition">¶</a></dt>

  507. <dd><p>Opens the device.</p>

  508. </dd></dl>

  509. 

  510. <dl class="method">

  511. <dt id="pyad2usb.devices.USBDevice.read">

  512. <tt class="descname">read</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#USBDevice.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.USBDevice.read" title="Permalink to this definition">¶</a></dt>

  513. <dd><p>Reads a single character from the device.</p>

  514. </dd></dl>

  515. 

  516. <dl class="method">

  517. <dt id="pyad2usb.devices.USBDevice.read_line">

  518. <tt class="descname">read_line</tt><big>(</big><em>timeout=0.0</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#USBDevice.read_line"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.USBDevice.read_line" title="Permalink to this definition">¶</a></dt>

  519. <dd><p>Reads a line from the device.</p>

  520. </dd></dl>

  521. 

  522. <dl class="method">

  523. <dt id="pyad2usb.devices.USBDevice.write">

  524. <tt class="descname">write</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/devices.html#USBDevice.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.devices.USBDevice.write" title="Permalink to this definition">¶</a></dt>

  525. <dd><p>Writes data to the device.</p>

  526. </dd></dl>

  527. 

  528. </dd></dl>

  529. 

  530. </div>

  531. <div class="section" id="module-pyad2usb.util">

  532. <span id="util-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">util</span></tt> Module<a class="headerlink" href="#module-pyad2usb.util" title="Permalink to this headline">¶</a></h2>

  533. <p>Provides utility classes for the AD2USB devices.</p>

  534. <dl class="exception">

  535. <dt id="pyad2usb.util.CommError">

  536. <em class="property">exception </em><tt class="descclassname">pyad2usb.util.</tt><tt class="descname">CommError</tt><a class="reference internal" href="_modules/pyad2usb/util.html#CommError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.util.CommError" title="Permalink to this definition">¶</a></dt>

  537. <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></tt></p>

  538. <p>There was an error communicating with the device.</p>

  539. </dd></dl>

  540. 

  541. <dl class="class">

  542. <dt id="pyad2usb.util.Firmware">

  543. <em class="property">class </em><tt class="descclassname">pyad2usb.util.</tt><tt class="descname">Firmware</tt><a class="reference internal" href="_modules/pyad2usb/util.html#Firmware"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.util.Firmware" title="Permalink to this definition">¶</a></dt>

  544. <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>

  545. <p>Represents firmware for the AD2USB/AD2SERIAL devices.</p>

  546. <dl class="attribute">

  547. <dt id="pyad2usb.util.Firmware.STAGE_BOOT">

  548. <tt class="descname">STAGE_BOOT</tt><em class="property"> = 2</em><a class="headerlink" href="#pyad2usb.util.Firmware.STAGE_BOOT" title="Permalink to this definition">¶</a></dt>

  549. <dd></dd></dl>

  550. 

  551. <dl class="attribute">

  552. <dt id="pyad2usb.util.Firmware.STAGE_DONE">

  553. <tt class="descname">STAGE_DONE</tt><em class="property"> = 5</em><a class="headerlink" href="#pyad2usb.util.Firmware.STAGE_DONE" title="Permalink to this definition">¶</a></dt>

  554. <dd></dd></dl>

  555. 

  556. <dl class="attribute">

  557. <dt id="pyad2usb.util.Firmware.STAGE_LOAD">

  558. <tt class="descname">STAGE_LOAD</tt><em class="property"> = 3</em><a class="headerlink" href="#pyad2usb.util.Firmware.STAGE_LOAD" title="Permalink to this definition">¶</a></dt>

  559. <dd></dd></dl>

  560. 

  561. <dl class="attribute">

  562. <dt id="pyad2usb.util.Firmware.STAGE_START">

  563. <tt class="descname">STAGE_START</tt><em class="property"> = 0</em><a class="headerlink" href="#pyad2usb.util.Firmware.STAGE_START" title="Permalink to this definition">¶</a></dt>

  564. <dd></dd></dl>

  565. 

  566. <dl class="attribute">

  567. <dt id="pyad2usb.util.Firmware.STAGE_UPLOADING">

  568. <tt class="descname">STAGE_UPLOADING</tt><em class="property"> = 4</em><a class="headerlink" href="#pyad2usb.util.Firmware.STAGE_UPLOADING" title="Permalink to this definition">¶</a></dt>

  569. <dd></dd></dl>

  570. 

  571. <dl class="attribute">

  572. <dt id="pyad2usb.util.Firmware.STAGE_WAITING">

  573. <tt class="descname">STAGE_WAITING</tt><em class="property"> = 1</em><a class="headerlink" href="#pyad2usb.util.Firmware.STAGE_WAITING" title="Permalink to this definition">¶</a></dt>

  574. <dd></dd></dl>

  575. 

  576. <dl class="staticmethod">

  577. <dt id="pyad2usb.util.Firmware.upload">

  578. <em class="property">static </em><tt class="descname">upload</tt><big>(</big><em>dev</em>, <em>filename</em>, <em>progress_callback=None</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/util.html#Firmware.upload"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.util.Firmware.upload" title="Permalink to this definition">¶</a></dt>

  579. <dd><p>Uploads firmware to an AD2USB/AD2SERIAL device.</p>

  580. </dd></dl>

  581. 

  582. </dd></dl>

  583. 

  584. <dl class="exception">

  585. <dt id="pyad2usb.util.InvalidMessageError">

  586. <em class="property">exception </em><tt class="descclassname">pyad2usb.util.</tt><tt class="descname">InvalidMessageError</tt><a class="reference internal" href="_modules/pyad2usb/util.html#InvalidMessageError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.util.InvalidMessageError" title="Permalink to this definition">¶</a></dt>

  587. <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></tt></p>

  588. <p>The format of the panel message was invalid.</p>

  589. </dd></dl>

  590. 

  591. <dl class="exception">

  592. <dt id="pyad2usb.util.NoDeviceError">

  593. <em class="property">exception </em><tt class="descclassname">pyad2usb.util.</tt><tt class="descname">NoDeviceError</tt><a class="reference internal" href="_modules/pyad2usb/util.html#NoDeviceError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.util.NoDeviceError" title="Permalink to this definition">¶</a></dt>

  594. <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></tt></p>

  595. <p>No devices found.</p>

  596. </dd></dl>

  597. 

  598. <dl class="exception">

  599. <dt id="pyad2usb.util.TimeoutError">

  600. <em class="property">exception </em><tt class="descclassname">pyad2usb.util.</tt><tt class="descname">TimeoutError</tt><a class="reference internal" href="_modules/pyad2usb/util.html#TimeoutError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.util.TimeoutError" title="Permalink to this definition">¶</a></dt>

  601. <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></tt></p>

  602. <p>There was a timeout while trying to communicate with the device.</p>

  603. </dd></dl>

  604. 

  605. </div>

  606. <div class="section" id="subpackages">

  607. <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>

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

  609. <ul>

  610. <li class="toctree-l1"><a class="reference internal" href="pyad2usb.event.html">event Package</a><ul>

  611. <li class="toctree-l2"><a class="reference internal" href="pyad2usb.event.html#id1"><tt class="docutils literal"><span class="pre">event</span></tt> Package</a></li>

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

  613. </ul>

  614. </li>

  615. </ul>

  616. </div>

  617. </div>

  618. </div>

  619. 

  620. 

  621.           </div>

  622.         </div>

  623.       </div>

  624.       <div class="sphinxsidebar">

  625.         <div class="sphinxsidebarwrapper">

  626.   <h3><a href="index.html">Table Of Contents</a></h3>

  627.   <ul>

  628. <li><a class="reference internal" href="#">pyad2usb Package</a><ul>

  629. <li><a class="reference internal" href="#id1"><tt class="docutils literal"><span class="pre">pyad2usb</span></tt> Package</a></li>

  630. <li><a class="reference internal" href="#module-pyad2usb.ad2usb"><tt class="docutils literal"><span class="pre">ad2usb</span></tt> Module</a></li>

  631. <li><a class="reference internal" href="#module-pyad2usb.devices"><tt class="docutils literal"><span class="pre">devices</span></tt> Module</a></li>

  632. <li><a class="reference internal" href="#module-pyad2usb.util"><tt class="docutils literal"><span class="pre">util</span></tt> Module</a></li>

  633. <li><a class="reference internal" href="#subpackages">Subpackages</a><ul>

  634. </ul>

  635. </li>

  636. </ul>

  637. </li>

  638. </ul>

  639. 

  640.   <h4>Previous topic</h4>

  641.   <p class="topless"><a href="index.html"

  642.                         title="previous chapter">Welcome to pyad2usb&#8217;s documentation!</a></p>

  643.   <h4>Next topic</h4>

  644.   <p class="topless"><a href="pyad2usb.event.html"

  645.                         title="next chapter">event Package</a></p>

  646.   <h3>This Page</h3>

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

  648.     <li><a href="_sources/pyad2usb.txt"

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

  650.   </ul>

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

  652.   <h3>Quick search</h3>

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

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

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

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

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

  658.     </form>

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

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

  661.     </p>

  662. </div>

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

  664.         </div>

  665.       </div>

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

  667.     </div>

  668.     <div class="related">

  669.       <h3>Navigation</h3>

  670.       <ul>

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

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

  673.              >index</a></li>

  674.         <li class="right" >

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

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

  677.         <li class="right" >

  678.           <a href="pyad2usb.event.html" title="event Package"

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

  680.         <li class="right" >

  681.           <a href="index.html" title="Welcome to pyad2usb’s documentation!"

  682.              >previous</a> |</li>

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

  684.       </ul>

  685.     </div>

  686.     <div class="footer">

  687.         &copy; Copyright 2013, Author.

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

  689.     </div>

  690.   </body>

  691. </html>