jmg
/
alarmdecoder
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
A clone of: https://github.com/nutechsoftware/alarmdecoder This is requires as they dropped support for older firmware releases w/o building in backward compatibility code, and they had previously hardcoded pyserial to a python2 only version.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
136 Commits
2 Branches
2.3 MiB
 
Tree: 4328382492
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '4328382492'
${ noResults }
alarmdecoder/docs/_build/html/pyad2usb.html

1146 lines
65 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="module-pyad2usb.ad2usb">

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

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

  60. <dl class="class">

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

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

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

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

  65. <dl class="attribute">

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

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

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

  69. </dd></dl>

  70. 

  71. <dl class="attribute">

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

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

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

  75. </dd></dl>

  76. 

  77. <dl class="classmethod">

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

  79. <em class="property">classmethod </em><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>

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

  81. <table class="docutils field-list" frame="void" rules="none">

  82. <col class="field-name" />

  83. <col class="field-body" />

  84. <tbody valign="top">

  85. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">list of devices found</td>

  86. </tr>

  87. <tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body">util.CommError</td>

  88. </tr>

  89. </tbody>

  90. </table>

  91. </dd></dl>

  92. 

  93. <dl class="classmethod">

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

  95. <em class="property">classmethod </em><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>

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

  97. <table class="docutils field-list" frame="void" rules="none">

  98. <col class="field-name" />

  99. <col class="field-body" />

  100. <tbody valign="top">

  101. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">cached list of devices found.</td>

  102. </tr>

  103. </tbody>

  104. </table>

  105. </dd></dl>

  106. 

  107. <dl class="classmethod">

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

  109. <em class="property">classmethod </em><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>

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

  111. <table class="docutils field-list" frame="void" rules="none">

  112. <col class="field-name" />

  113. <col class="field-body" />

  114. <tbody valign="top">

  115. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>device</strong> (<em>tuple</em>) &#8211; Tuple describing the USB device to open, as returned by find_all().</td>

  116. </tr>

  117. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">AD2USB object utilizing the specified device.</td>

  118. </tr>

  119. <tr class="field-odd field"><th class="field-name">Raises :</th><td class="field-body">util.NoDeviceError</td>

  120. </tr>

  121. </tbody>

  122. </table>

  123. </dd></dl>

  124. 

  125. <dl class="method">

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

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

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

  129. </dd></dl>

  130. 

  131. <dl class="method">

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

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

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

  135. </dd></dl>

  136. 

  137. <dl class="method">

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

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

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

  141. </dd></dl>

  142. 

  143. <dl class="method">

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

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

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

  147. <table class="docutils field-list" frame="void" rules="none">

  148. <col class="field-name" />

  149. <col class="field-body" />

  150. <tbody valign="top">

  151. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>device</strong> (<em>tuple</em>) &#8211; Tuple describing the USB device to open, as returned by find_all().</td>

  152. </tr>

  153. </tbody>

  154. </table>

  155. </dd></dl>

  156. 

  157. <dl class="class">

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

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

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

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

  162. <dl class="method">

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

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

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

  166. </dd></dl>

  167. 

  168. <dl class="method">

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

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

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

  172. </dd></dl>

  173. 

  174. </dd></dl>

  175. 

  176. </dd></dl>

  177. 

  178. <dl class="class">

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

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

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

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

  183. <dl class="attribute">

  184. <dt id="pyad2usb.ad2usb.AD2USB.on_arm">

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

  186. <dd><p>Called when the panel is armed.</p>

  187. </dd></dl>

  188. 

  189. <dl class="attribute">

  190. <dt id="pyad2usb.ad2usb.AD2USB.on_disarm">

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

  192. <dd><p>Called when the panel is disarmed.</p>

  193. </dd></dl>

  194. 

  195. <dl class="attribute">

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

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

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

  199. </dd></dl>

  200. 

  201. <dl class="attribute">

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

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

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

  205. </dd></dl>

  206. 

  207. <dl class="attribute">

  208. <dt id="pyad2usb.ad2usb.AD2USB.on_fire">

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

  210. <dd><p>Called when a fire is detected.</p>

  211. </dd></dl>

  212. 

  213. <dl class="attribute">

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

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

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

  217. </dd></dl>

  218. 

  219. <dl class="attribute">

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

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

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

  223. </dd></dl>

  224. 

  225. <dl class="attribute">

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

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

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

  229. </dd></dl>

  230. 

  231. <dl class="attribute">

  232. <dt id="pyad2usb.ad2usb.AD2USB.on_zone_fault">

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

  234. <dd><p>Called when the device detects a zone fault.</p>

  235. </dd></dl>

  236. 

  237. <dl class="attribute">

  238. <dt id="pyad2usb.ad2usb.AD2USB.on_zone_restore">

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

  240. <dd><p>Called when the device detects that a fault is restored.</p>

  241. </dd></dl>

  242. 

  243. <dl class="attribute">

  244. <dt id="pyad2usb.ad2usb.AD2USB.on_low_battery">

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

  246. <dd><p>Called when the device detects a low battery.</p>

  247. </dd></dl>

  248. 

  249. <dl class="attribute">

  250. <dt id="pyad2usb.ad2usb.AD2USB.on_panic">

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

  252. <dd><p>Called when the device detects a panic.</p>

  253. </dd></dl>

  254. 

  255. <dl class="attribute">

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

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

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

  259. </dd></dl>

  260. 

  261. <dl class="attribute">

  262. <dt id="pyad2usb.ad2usb.AD2USB.on_lrr_message">

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

  264. <dd><p>Called when an LRR message is received.</p>

  265. </dd></dl>

  266. 

  267. <dl class="attribute">

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

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

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

  271. </dd></dl>

  272. 

  273. <dl class="attribute">

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

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

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

  277. </dd></dl>

  278. 

  279. <dl class="attribute">

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

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

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

  283. </dd></dl>

  284. 

  285. <dl class="attribute">

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

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

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

  289. </dd></dl>

  290. 

  291. <dl class="attribute">

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

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

  294. <dd><p>Represents panel function key #1</p>

  295. </dd></dl>

  296. 

  297. <dl class="attribute">

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

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

  300. <dd><p>Represents panel function key #2</p>

  301. </dd></dl>

  302. 

  303. <dl class="attribute">

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

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

  306. <dd><p>Represents panel function key #3</p>

  307. </dd></dl>

  308. 

  309. <dl class="attribute">

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

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

  312. <dd><p>Represents panel function key #4</p>

  313. </dd></dl>

  314. 

  315. <dl class="attribute">

  316. <dt id="pyad2usb.ad2usb.AD2USB.BATTERY_TIMEOUT">

  317. <tt class="descname">BATTERY_TIMEOUT</tt><em class="property"> = 30</em><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.BATTERY_TIMEOUT" title="Permalink to this definition">¶</a></dt>

  318. <dd><p>Timeout before the battery status reverts.</p>

  319. </dd></dl>

  320. 

  321. <dl class="attribute">

  322. <dt id="pyad2usb.ad2usb.AD2USB.FIRE_TIMEOUT">

  323. <tt class="descname">FIRE_TIMEOUT</tt><em class="property"> = 30</em><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.FIRE_TIMEOUT" title="Permalink to this definition">¶</a></dt>

  324. <dd><p>Timeout before the fire status reverts.</p>

  325. </dd></dl>

  326. 

  327. <dl class="attribute">

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

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

  330. <dd><p>The ID of the AD2USB device.</p>

  331. <table class="docutils field-list" frame="void" rules="none">

  332. <col class="field-name" />

  333. <col class="field-body" />

  334. <tbody valign="top">

  335. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The identification string for the device.</td>

  336. </tr>

  337. </tbody>

  338. </table>

  339. </dd></dl>

  340. 

  341. <dl class="method">

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

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

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

  345. <table class="docutils field-list" frame="void" rules="none">

  346. <col class="field-name" />

  347. <col class="field-body" />

  348. <tbody valign="top">

  349. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

  350. <li><strong>baudrate</strong> (<em>int</em>) &#8211; The baudrate used for the device.</li>

  351. <li><strong>interface</strong> (<em>varies depends on device type.. FIXME</em>) &#8211; The interface used for the device.</li>

  352. <li><strong>index</strong> (<em>int</em>) &#8211; Interface index.. can probably remove.  FIXME</li>

  353. <li><strong>no_reader_thread</strong> (<em>bool</em>) &#8211; Specifies whether or not the automatic reader thread should be started or not</li>

  354. </ul>

  355. </td>

  356. </tr>

  357. </tbody>

  358. </table>

  359. </dd></dl>

  360. 

  361. <dl class="method">

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

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

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

  365. </dd></dl>

  366. 

  367. <dl class="method">

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

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

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

  371. </dd></dl>

  372. 

  373. <dl class="method">

  374. <dt id="pyad2usb.ad2usb.AD2USB.save_config">

  375. <tt class="descname">save_config</tt><big>(</big><big>)</big><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.save_config" title="Permalink to this definition">¶</a></dt>

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

  377. </dd></dl>

  378. 

  379. <dl class="method">

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

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

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

  383. </dd></dl>

  384. 

  385. <dl class="method">

  386. <dt id="pyad2usb.ad2usb.AD2USB.fault_zone">

  387. <tt class="descname">fault_zone</tt><big>(</big><em>zone</em>, <em>simulate_wire_problem=False</em><big>)</big><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.fault_zone" title="Permalink to this definition">¶</a></dt>

  388. <dd><p>Faults a zone if we are emulating a zone expander.</p>

  389. <table class="docutils field-list" frame="void" rules="none">

  390. <col class="field-name" />

  391. <col class="field-body" />

  392. <tbody valign="top">

  393. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

  394. <li><strong>zone</strong> (<em>int</em>) &#8211; The zone to fault.</li>

  395. <li><strong>simulate_wire_problem</strong> (<em>bool</em>) &#8211; Whether or not to simulate a wire fault.</li>

  396. </ul>

  397. </td>

  398. </tr>

  399. </tbody>

  400. </table>

  401. </dd></dl>

  402. 

  403. <dl class="method">

  404. <dt id="pyad2usb.ad2usb.AD2USB.clear_zone">

  405. <tt class="descname">clear_zone</tt><big>(</big><em>zone</em><big>)</big><a class="headerlink" href="#pyad2usb.ad2usb.AD2USB.clear_zone" title="Permalink to this definition">¶</a></dt>

  406. <dd><p>Clears a zone if we are emulating a zone expander.</p>

  407. <table class="docutils field-list" frame="void" rules="none">

  408. <col class="field-name" />

  409. <col class="field-body" />

  410. <tbody valign="top">

  411. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>zone</strong> (<em>int</em>) &#8211; The zone to clear.</td>

  412. </tr>

  413. </tbody>

  414. </table>

  415. </dd></dl>

  416. 

  417. </dd></dl>

  418. 

  419. </div>

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

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

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

  423. <dl class="class">

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

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

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

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

  428. <dl class="attribute">

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

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

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

  432. </dd></dl>

  433. 

  434. <dl class="attribute">

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

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

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

  438. </dd></dl>

  439. 

  440. <dl class="attribute">

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

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

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

  444. </dd></dl>

  445. 

  446. <dl class="attribute">

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

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

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

  450. </dd></dl>

  451. 

  452. <dl class="attribute">

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

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

  455. <dd><p>Retrieve the device ID.</p>

  456. <table class="docutils field-list" frame="void" rules="none">

  457. <col class="field-name" />

  458. <col class="field-body" />

  459. <tbody valign="top">

  460. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The identification string for the device.</td>

  461. </tr>

  462. </tbody>

  463. </table>

  464. </dd></dl>

  465. 

  466. <dl class="method">

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

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

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

  470. <table class="docutils field-list" frame="void" rules="none">

  471. <col class="field-name" />

  472. <col class="field-body" />

  473. <tbody valign="top">

  474. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Whether or not the reader thread is alive.</td>

  475. </tr>

  476. </tbody>

  477. </table>

  478. </dd></dl>

  479. 

  480. <dl class="method">

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

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

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

  484. </dd></dl>

  485. 

  486. <dl class="class">

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

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

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

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

  491. <dl class="attribute">

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

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

  494. <dd><p>Timeout for the reader thread.</p>

  495. </dd></dl>

  496. 

  497. <dl class="method">

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

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

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

  501. </dd></dl>

  502. 

  503. <dl class="method">

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

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

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

  507. </dd></dl>

  508. 

  509. </dd></dl>

  510. 

  511. </dd></dl>

  512. 

  513. <dl class="class">

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

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

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

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

  518. <dl class="attribute">

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

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

  521. <dd><p>Vendor ID used to recognize AD2USB devices.</p>

  522. </dd></dl>

  523. 

  524. <dl class="attribute">

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

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

  527. <dd><p>Product ID used to recognize AD2USB devices.</p>

  528. </dd></dl>

  529. 

  530. <dl class="attribute">

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

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

  533. <dd><p>Default baudrate for AD2USB devices.</p>

  534. </dd></dl>

  535. 

  536. <dl class="staticmethod">

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

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

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

  540. <table class="docutils field-list" frame="void" rules="none">

  541. <col class="field-name" />

  542. <col class="field-body" />

  543. <tbody valign="top">

  544. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">list of devices</td>

  545. </tr>

  546. <tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body">util.CommError</td>

  547. </tr>

  548. </tbody>

  549. </table>

  550. </dd></dl>

  551. 

  552. <dl class="method">

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

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

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

  556. <table class="docutils field-list" frame="void" rules="none">

  557. <col class="field-name" />

  558. <col class="field-body" />

  559. <tbody valign="top">

  560. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

  561. <li><strong>baudrate</strong> (<em>int</em>) &#8211; The baudrate to use.</li>

  562. <li><strong>interface</strong> (<em>int</em>) &#8211; The interface to use.</li>

  563. <li><strong>no_reader_thread</strong> (<em>bool</em>) &#8211; Whether or not to automatically start the reader thread.</li>

  564. </ul>

  565. </td>

  566. </tr>

  567. <tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body"><p class="first last">util.NoDeviceError</p>

  568. </td>

  569. </tr>

  570. </tbody>

  571. </table>

  572. </dd></dl>

  573. 

  574. <dl class="method">

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

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

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

  578. </dd></dl>

  579. 

  580. <dl class="method">

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

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

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

  584. <table class="docutils field-list" frame="void" rules="none">

  585. <col class="field-name" />

  586. <col class="field-body" />

  587. <tbody valign="top">

  588. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<em>str</em>) &#8211; Data to write</td>

  589. </tr>

  590. <tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body">util.CommError</td>

  591. </tr>

  592. </tbody>

  593. </table>

  594. </dd></dl>

  595. 

  596. <dl class="method">

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

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

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

  600. <table class="docutils field-list" frame="void" rules="none">

  601. <col class="field-name" />

  602. <col class="field-body" />

  603. <tbody valign="top">

  604. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The character read from the device.</td>

  605. </tr>

  606. <tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body">util.CommError</td>

  607. </tr>

  608. </tbody>

  609. </table>

  610. </dd></dl>

  611. 

  612. <dl class="method">

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

  614. <tt class="descname">read_line</tt><big>(</big><em>timeout=0.0</em>, <em>purge_buffer=False</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>

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

  616. <table class="docutils field-list" frame="void" rules="none">

  617. <col class="field-name" />

  618. <col class="field-body" />

  619. <tbody valign="top">

  620. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

  621. <li><strong>timeout</strong> (<em>float</em>) &#8211; Read timeout</li>

  622. <li><strong>purge_buffer</strong> (<em>bool</em>) &#8211; Indicates whether to purge the buffer prior to reading.</li>

  623. </ul>

  624. </td>

  625. </tr>

  626. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The line that was read.</p>

  627. </td>

  628. </tr>

  629. <tr class="field-odd field"><th class="field-name">Raises :</th><td class="field-body"><p class="first last">util.CommError, util.TimeoutError</p>

  630. </td>

  631. </tr>

  632. </tbody>

  633. </table>

  634. </dd></dl>

  635. 

  636. </dd></dl>

  637. 

  638. <dl class="class">

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

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

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

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

  643. <dl class="attribute">

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

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

  646. <dd><p>Default baudrate for Serial devices.</p>

  647. </dd></dl>

  648. 

  649. <dl class="staticmethod">

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

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

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

  653. <table class="docutils field-list" frame="void" rules="none">

  654. <col class="field-name" />

  655. <col class="field-body" />

  656. <tbody valign="top">

  657. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>pattern</strong> (<em>str</em>) &#8211; Pattern to search for when retrieving serial ports.</td>

  658. </tr>

  659. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">list of devices</td>

  660. </tr>

  661. <tr class="field-odd field"><th class="field-name">Raises :</th><td class="field-body">util.CommError</td>

  662. </tr>

  663. </tbody>

  664. </table>

  665. </dd></dl>

  666. 

  667. <dl class="method">

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

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

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

  671. <table class="docutils field-list" frame="void" rules="none">

  672. <col class="field-name" />

  673. <col class="field-body" />

  674. <tbody valign="top">

  675. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

  676. <li><strong>baudrate</strong> (<em>int</em>) &#8211; The baudrate to use with the device.</li>

  677. <li><strong>interface</strong> (<em>str</em>) &#8211; The device to open.</li>

  678. <li><strong>index</strong> (<em>int</em>) &#8211; Unused.</li>

  679. <li><strong>no_reader_thread</strong> (<em>bool</em>) &#8211; Whether or not to automatically start the reader thread.</li>

  680. </ul>

  681. </td>

  682. </tr>

  683. <tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body"><p class="first last">util.NoDeviceError</p>

  684. </td>

  685. </tr>

  686. </tbody>

  687. </table>

  688. </dd></dl>

  689. 

  690. <dl class="method">

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

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

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

  694. </dd></dl>

  695. 

  696. <dl class="method">

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

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

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

  700. <table class="docutils field-list" frame="void" rules="none">

  701. <col class="field-name" />

  702. <col class="field-body" />

  703. <tbody valign="top">

  704. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<em>str</em>) &#8211; The data to write.</td>

  705. </tr>

  706. <tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body">util.CommError</td>

  707. </tr>

  708. </tbody>

  709. </table>

  710. </dd></dl>

  711. 

  712. <dl class="method">

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

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

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

  716. <table class="docutils field-list" frame="void" rules="none">

  717. <col class="field-name" />

  718. <col class="field-body" />

  719. <tbody valign="top">

  720. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The character read from the device.</td>

  721. </tr>

  722. <tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body">util.CommError</td>

  723. </tr>

  724. </tbody>

  725. </table>

  726. </dd></dl>

  727. 

  728. <dl class="method">

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

  730. <tt class="descname">read_line</tt><big>(</big><em>timeout=0.0</em>, <em>purge_buffer=False</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>

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

  732. <table class="docutils field-list" frame="void" rules="none">

  733. <col class="field-name" />

  734. <col class="field-body" />

  735. <tbody valign="top">

  736. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

  737. <li><strong>timeout</strong> (<em>float</em>) &#8211; The read timeout.</li>

  738. <li><strong>purge_buffer</strong> (<em>bool</em>) &#8211; Indicates whether to purge the buffer prior to reading.</li>

  739. </ul>

  740. </td>

  741. </tr>

  742. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The line read.</p>

  743. </td>

  744. </tr>

  745. <tr class="field-odd field"><th class="field-name">Raises :</th><td class="field-body"><p class="first last">util.CommError, util.TimeoutError</p>

  746. </td>

  747. </tr>

  748. </tbody>

  749. </table>

  750. </dd></dl>

  751. 

  752. </dd></dl>

  753. 

  754. <dl class="class">

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

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

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

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

  759. Serial to IP interface.</p>

  760. <dl class="method">

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

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

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

  764. <table class="docutils field-list" frame="void" rules="none">

  765. <col class="field-name" />

  766. <col class="field-body" />

  767. <tbody valign="top">

  768. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

  769. <li><strong>baudrate</strong> (<em>int</em>) &#8211; The baudrate to use</li>

  770. <li><strong>interface</strong> (<em>tuple</em>) &#8211; The hostname and port to connect to.</li>

  771. <li><strong>index</strong> (<em>int</em>) &#8211; Unused</li>

  772. <li><strong>no_reader_thread</strong> (<em>bool</em>) &#8211; Whether or not to automatically open the reader thread.</li>

  773. </ul>

  774. </td>

  775. </tr>

  776. <tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body"><p class="first last">util.NoDeviceError</p>

  777. </td>

  778. </tr>

  779. </tbody>

  780. </table>

  781. </dd></dl>

  782. 

  783. <dl class="method">

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

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

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

  787. </dd></dl>

  788. 

  789. <dl class="method">

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

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

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

  793. <table class="docutils field-list" frame="void" rules="none">

  794. <col class="field-name" />

  795. <col class="field-body" />

  796. <tbody valign="top">

  797. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<em>str</em>) &#8211; The data to write.</td>

  798. </tr>

  799. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The number of bytes sent.</td>

  800. </tr>

  801. <tr class="field-odd field"><th class="field-name">Raises :</th><td class="field-body">util.CommError</td>

  802. </tr>

  803. </tbody>

  804. </table>

  805. </dd></dl>

  806. 

  807. <dl class="method">

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

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

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

  811. <table class="docutils field-list" frame="void" rules="none">

  812. <col class="field-name" />

  813. <col class="field-body" />

  814. <tbody valign="top">

  815. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The character read from the device.</td>

  816. </tr>

  817. <tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body">util.CommError</td>

  818. </tr>

  819. </tbody>

  820. </table>

  821. </dd></dl>

  822. 

  823. <dl class="method">

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

  825. <tt class="descname">read_line</tt><big>(</big><em>timeout=0.0</em>, <em>purge_buffer=False</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>

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

  827. <table class="docutils field-list" frame="void" rules="none">

  828. <col class="field-name" />

  829. <col class="field-body" />

  830. <tbody valign="top">

  831. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

  832. <li><strong>timeout</strong> (<em>float</em>) &#8211; The read timeout.</li>

  833. <li><strong>purge_buffer</strong> (<em>bool</em>) &#8211; Indicates whether to purge the buffer prior to reading.</li>

  834. </ul>

  835. </td>

  836. </tr>

  837. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The line read from the device.</p>

  838. </td>

  839. </tr>

  840. <tr class="field-odd field"><th class="field-name">Raises :</th><td class="field-body"><p class="first last">util.CommError, util.TimeoutError</p>

  841. </td>

  842. </tr>

  843. </tbody>

  844. </table>

  845. </dd></dl>

  846. 

  847. </dd></dl>

  848. 

  849. </div>

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

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

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

  853. <dl class="exception">

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

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

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

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

  858. </dd></dl>

  859. 

  860. <dl class="exception">

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

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

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

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

  865. </dd></dl>

  866. 

  867. <dl class="exception">

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

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

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

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

  872. </dd></dl>

  873. 

  874. <dl class="exception">

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

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

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

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

  879. </dd></dl>

  880. 

  881. <dl class="class">

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

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

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

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

  886. <dl class="attribute">

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

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

  889. <dd></dd></dl>

  890. 

  891. <dl class="attribute">

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

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

  894. <dd></dd></dl>

  895. 

  896. <dl class="attribute">

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

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

  899. <dd></dd></dl>

  900. 

  901. <dl class="attribute">

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

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

  904. <dd></dd></dl>

  905. 

  906. <dl class="attribute">

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

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

  909. <dd></dd></dl>

  910. 

  911. <dl class="attribute">

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

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

  914. <dd></dd></dl>

  915. 

  916. <dl class="staticmethod">

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

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

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

  920. <table class="docutils field-list" frame="void" rules="none">

  921. <col class="field-name" />

  922. <col class="field-body" />

  923. <tbody valign="top">

  924. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

  925. <li><strong>filename</strong> (<em>str</em>) &#8211; The firmware filename</li>

  926. <li><strong>progress_callback</strong> (<em>function</em>) &#8211; Callback function used to report progress.</li>

  927. </ul>

  928. </td>

  929. </tr>

  930. <tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body"><p class="first last">util.NoDeviceError, util.TimeoutError</p>

  931. </td>

  932. </tr>

  933. </tbody>

  934. </table>

  935. </dd></dl>

  936. 

  937. </dd></dl>

  938. 

  939. </div>

  940. <div class="section" id="module-pyad2usb.zonetracking">

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

  942. <p>Provides zone tracking functionality for the AD2USB device family.</p>

  943. <dl class="class">

  944. <dt id="pyad2usb.zonetracking.Zone">

  945. <em class="property">class </em><tt class="descclassname">pyad2usb.zonetracking.</tt><tt class="descname">Zone</tt><big>(</big><em>zone=0</em>, <em>name=''</em>, <em>status=0</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/zonetracking.html#Zone"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.zonetracking.Zone" title="Permalink to this definition">¶</a></dt>

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

  947. <p>Representation of a panel zone.</p>

  948. <dl class="attribute">

  949. <dt id="pyad2usb.zonetracking.Zone.CLEAR">

  950. <tt class="descname">CLEAR</tt><em class="property"> = 0</em><a class="headerlink" href="#pyad2usb.zonetracking.Zone.CLEAR" title="Permalink to this definition">¶</a></dt>

  951. <dd><p>Status indicating that the zone is cleared.</p>

  952. </dd></dl>

  953. 

  954. <dl class="attribute">

  955. <dt id="pyad2usb.zonetracking.Zone.FAULT">

  956. <tt class="descname">FAULT</tt><em class="property"> = 1</em><a class="headerlink" href="#pyad2usb.zonetracking.Zone.FAULT" title="Permalink to this definition">¶</a></dt>

  957. <dd><p>Status indicating that the zone is faulted.</p>

  958. </dd></dl>

  959. 

  960. <dl class="attribute">

  961. <dt id="pyad2usb.zonetracking.Zone.CHECK">

  962. <tt class="descname">CHECK</tt><em class="property"> = 2</em><a class="headerlink" href="#pyad2usb.zonetracking.Zone.CHECK" title="Permalink to this definition">¶</a></dt>

  963. <dd><p>Status indicating that there is a wiring issue with the zone.</p>

  964. </dd></dl>

  965. 

  966. <dl class="attribute">

  967. <dt id="pyad2usb.zonetracking.Zone.STATUS">

  968. <tt class="descname">STATUS</tt><em class="property"> = {0: 'CLEAR', 1: 'FAULT', 2: 'CHECK'}</em><a class="headerlink" href="#pyad2usb.zonetracking.Zone.STATUS" title="Permalink to this definition">¶</a></dt>

  969. <dd></dd></dl>

  970. 

  971. </dd></dl>

  972. 

  973. <dl class="class">

  974. <dt id="pyad2usb.zonetracking.Zonetracker">

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

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

  977. <p>Handles tracking of zone and their statuses.</p>

  978. <dl class="attribute">

  979. <dt id="pyad2usb.zonetracking.Zonetracker.on_fault">

  980. <tt class="descname">on_fault</tt><a class="headerlink" href="#pyad2usb.zonetracking.Zonetracker.on_fault" title="Permalink to this definition">¶</a></dt>

  981. <dd><p>Called when the device detects a zone fault.</p>

  982. </dd></dl>

  983. 

  984. <dl class="attribute">

  985. <dt id="pyad2usb.zonetracking.Zonetracker.on_restore">

  986. <tt class="descname">on_restore</tt><a class="headerlink" href="#pyad2usb.zonetracking.Zonetracker.on_restore" title="Permalink to this definition">¶</a></dt>

  987. <dd><p>Called when the device detects that a fault is restored.</p>

  988. </dd></dl>

  989. 

  990. <dl class="attribute">

  991. <dt id="pyad2usb.zonetracking.Zonetracker.EXPIRE">

  992. <tt class="descname">EXPIRE</tt><em class="property"> = 30</em><a class="headerlink" href="#pyad2usb.zonetracking.Zonetracker.EXPIRE" title="Permalink to this definition">¶</a></dt>

  993. <dd><p>Zone expiration timeout.</p>

  994. </dd></dl>

  995. 

  996. <dl class="method">

  997. <dt id="pyad2usb.zonetracking.Zonetracker.update">

  998. <tt class="descname">update</tt><big>(</big><em>message</em><big>)</big><a class="reference internal" href="_modules/pyad2usb/zonetracking.html#Zonetracker.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2usb.zonetracking.Zonetracker.update" title="Permalink to this definition">¶</a></dt>

  999. <dd><p>Update zone statuses based on the current message.</p>

  1000. <table class="docutils field-list" frame="void" rules="none">

  1001. <col class="field-name" />

  1002. <col class="field-body" />

  1003. <tbody valign="top">

  1004. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>message</strong> (<em>Message or ExpanderMessage</em>) &#8211; Message to use to update the zone tracking.</td>

  1005. </tr>

  1006. </tbody>

  1007. </table>

  1008. </dd></dl>

  1009. 

  1010. </dd></dl>

  1011. 

  1012. </div>

  1013. <div class="section" id="module-pyad2usb.panels">

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

  1015. <p>Representations of Panels and their templates.</p>

  1016. </div>

  1017. <div class="section" id="module-pyad2usb.messages">

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

  1019. <p>Message representations received from the panel through the AD2USB.</p>

  1020. <dl class="class">

  1021. <dt id="pyad2usb.messages.Message">

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

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

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

  1025. </dd></dl>

  1026. 

  1027. <dl class="class">

  1028. <dt id="pyad2usb.messages.ExpanderMessage">

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

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

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

  1032. <dl class="attribute">

  1033. <dt id="pyad2usb.messages.ExpanderMessage.ZONE">

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

  1035. <dd></dd></dl>

  1036. 

  1037. <dl class="attribute">

  1038. <dt id="pyad2usb.messages.ExpanderMessage.RELAY">

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

  1040. <dd></dd></dl>

  1041. 

  1042. </dd></dl>

  1043. 

  1044. <dl class="class">

  1045. <dt id="pyad2usb.messages.RFMessage">

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

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

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

  1049. </dd></dl>

  1050. 

  1051. <dl class="class">

  1052. <dt id="pyad2usb.messages.LRRMessage">

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

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

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

  1056. </dd></dl>

  1057. 

  1058. </div>

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

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

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

  1062. <ul>

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

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

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

  1066. </ul>

  1067. </li>

  1068. </ul>

  1069. </div>

  1070. </div>

  1071. </div>

  1072. 

  1073. 

  1074.           </div>

  1075.         </div>

  1076.       </div>

  1077.       <div class="sphinxsidebar">

  1078.         <div class="sphinxsidebarwrapper">

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

  1080.   <ul>

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

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

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

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

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

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

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

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

  1089. </ul>

  1090. </li>

  1091. </ul>

  1092. </li>

  1093. </ul>

  1094. 

  1095.   <h4>Previous topic</h4>

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

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

  1098.   <h4>Next topic</h4>

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

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

  1101.   <h3>This Page</h3>

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

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

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

  1105.   </ul>

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

  1107.   <h3>Quick search</h3>

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

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

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

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

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

  1113.     </form>

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

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

  1116.     </p>

  1117. </div>

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

  1119.         </div>

  1120.       </div>

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

  1122.     </div>

  1123.     <div class="related">

  1124.       <h3>Navigation</h3>

  1125.       <ul>

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

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

  1128.              >index</a></li>

  1129.         <li class="right" >

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

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

  1132.         <li class="right" >

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

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

  1135.         <li class="right" >

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

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

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

  1139.       </ul>

  1140.     </div>

  1141.     <div class="footer">

  1142.         &copy; Copyright 2013, Author.

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

  1144.     </div>

  1145.   </body>

  1146. </html>