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

1521 lines
83 KiB
Raw Blame History 

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

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

  3. 

  4. 

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

  6.   <head>

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

  8.     

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

  10.     

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

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

  13.     

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

  15.       var DOCUMENTATION_OPTIONS = {

  16.         URL_ROOT:    './',

  17.         VERSION:     '',

  18.         COLLAPSE_INDEX: false,

  19.         FILE_SUFFIX: '.html',

  20.         HAS_SOURCE:  true

  21.       };

  22.     </script>

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

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

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

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

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

  28.     <link rel="prev" title="Welcome to pyad2’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="pyad2.event.html" title="event Package"

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

  43.         <li class="right" >

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

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

  46.         <li><a href="index.html">pyad2  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="pyad2-package">

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

  57. <div class="section" id="module-pyad2.ad2">

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

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

  60. <dl class="class">

  61. <dt id="pyad2.ad2.AD2Factory">

  62. <em class="property">class </em><tt class="descclassname">pyad2.ad2.</tt><tt class="descname">AD2Factory</tt><big>(</big><em>attached_event=None</em>, <em>detached_event=None</em><big>)</big><a class="reference internal" href="_modules/pyad2/ad2.html#AD2Factory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.ad2.AD2Factory" 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 provides attach/detach events.&#8221;</p>

  65. <dl class="attribute">

  66. <dt id="pyad2.ad2.AD2Factory.on_attached">

  67. <tt class="descname">on_attached</tt><a class="headerlink" href="#pyad2.ad2.AD2Factory.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="pyad2.ad2.AD2Factory.on_detached">

  73. <tt class="descname">on_detached</tt><a class="headerlink" href="#pyad2.ad2.AD2Factory.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="pyad2.ad2.AD2Factory.find_all">

  79. <em class="property">classmethod </em><tt class="descname">find_all</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2/ad2.html#AD2Factory.find_all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.ad2.AD2Factory.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">CommError</td>

  88. </tr>

  89. </tbody>

  90. </table>

  91. </dd></dl>

  92. 

  93. <dl class="classmethod">

  94. <dt id="pyad2.ad2.AD2Factory.devices">

  95. <em class="property">classmethod </em><tt class="descname">devices</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2/ad2.html#AD2Factory.devices"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.ad2.AD2Factory.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="pyad2.ad2.AD2Factory.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/pyad2/ad2.html#AD2Factory.create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.ad2.AD2Factory.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">NoDeviceError</td>

  120. </tr>

  121. </tbody>

  122. </table>

  123. </dd></dl>

  124. 

  125. <dl class="method">

  126. <dt id="pyad2.ad2.AD2Factory.close">

  127. <tt class="descname">close</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2/ad2.html#AD2Factory.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.ad2.AD2Factory.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="pyad2.ad2.AD2Factory.start">

  133. <tt class="descname">start</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2/ad2.html#AD2Factory.start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.ad2.AD2Factory.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="pyad2.ad2.AD2Factory.stop">

  139. <tt class="descname">stop</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2/ad2.html#AD2Factory.stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.ad2.AD2Factory.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="pyad2.ad2.AD2Factory.get_device">

  145. <tt class="descname">get_device</tt><big>(</big><em>device=None</em><big>)</big><a class="reference internal" href="_modules/pyad2/ad2.html#AD2Factory.get_device"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.ad2.AD2Factory.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="pyad2.ad2.AD2Factory.DetectThread">

  159. <em class="property">class </em><tt class="descname">DetectThread</tt><big>(</big><em>factory</em><big>)</big><a class="reference internal" href="_modules/pyad2/ad2.html#AD2Factory.DetectThread"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.ad2.AD2Factory.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="pyad2.ad2.AD2Factory.DetectThread.stop">

  164. <tt class="descname">stop</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2/ad2.html#AD2Factory.DetectThread.stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.ad2.AD2Factory.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="pyad2.ad2.AD2Factory.DetectThread.run">

  170. <tt class="descname">run</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2/ad2.html#AD2Factory.DetectThread.run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.ad2.AD2Factory.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="pyad2.ad2.AD2">

  180. <em class="property">class </em><tt class="descclassname">pyad2.ad2.</tt><tt class="descname">AD2</tt><big>(</big><em>device</em><big>)</big><a class="reference internal" href="_modules/pyad2/ad2.html#AD2"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.ad2.AD2" 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 AD2 devices.</p>

  183. <dl class="attribute">

  184. <dt id="pyad2.ad2.AD2.on_arm">

  185. <tt class="descname">on_arm</tt><a class="headerlink" href="#pyad2.ad2.AD2.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="pyad2.ad2.AD2.on_disarm">

  191. <tt class="descname">on_disarm</tt><a class="headerlink" href="#pyad2.ad2.AD2.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="pyad2.ad2.AD2.on_power_changed">

  197. <tt class="descname">on_power_changed</tt><a class="headerlink" href="#pyad2.ad2.AD2.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="pyad2.ad2.AD2.on_alarm">

  203. <tt class="descname">on_alarm</tt><a class="headerlink" href="#pyad2.ad2.AD2.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="pyad2.ad2.AD2.on_fire">

  209. <tt class="descname">on_fire</tt><a class="headerlink" href="#pyad2.ad2.AD2.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="pyad2.ad2.AD2.on_bypass">

  215. <tt class="descname">on_bypass</tt><a class="headerlink" href="#pyad2.ad2.AD2.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="pyad2.ad2.AD2.on_boot">

  221. <tt class="descname">on_boot</tt><a class="headerlink" href="#pyad2.ad2.AD2.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="pyad2.ad2.AD2.on_config_received">

  227. <tt class="descname">on_config_received</tt><a class="headerlink" href="#pyad2.ad2.AD2.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="pyad2.ad2.AD2.on_zone_fault">

  233. <tt class="descname">on_zone_fault</tt><a class="headerlink" href="#pyad2.ad2.AD2.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="pyad2.ad2.AD2.on_zone_restore">

  239. <tt class="descname">on_zone_restore</tt><a class="headerlink" href="#pyad2.ad2.AD2.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="pyad2.ad2.AD2.on_low_battery">

  245. <tt class="descname">on_low_battery</tt><a class="headerlink" href="#pyad2.ad2.AD2.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="pyad2.ad2.AD2.on_panic">

  251. <tt class="descname">on_panic</tt><a class="headerlink" href="#pyad2.ad2.AD2.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="pyad2.ad2.AD2.on_relay_changed">

  257. <tt class="descname">on_relay_changed</tt><a class="headerlink" href="#pyad2.ad2.AD2.on_relay_changed" title="Permalink to this definition">¶</a></dt>

  258. <dd><p>Called when a relay is opened or closed on an expander board.</p>

  259. </dd></dl>

  260. 

  261. <dl class="attribute">

  262. <dt id="pyad2.ad2.AD2.on_message">

  263. <tt class="descname">on_message</tt><a class="headerlink" href="#pyad2.ad2.AD2.on_message" title="Permalink to this definition">¶</a></dt>

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

  265. </dd></dl>

  266. 

  267. <dl class="attribute">

  268. <dt id="pyad2.ad2.AD2.on_lrr_message">

  269. <tt class="descname">on_lrr_message</tt><a class="headerlink" href="#pyad2.ad2.AD2.on_lrr_message" title="Permalink to this definition">¶</a></dt>

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

  271. </dd></dl>

  272. 

  273. <dl class="attribute">

  274. <dt id="pyad2.ad2.AD2.on_rfx_message">

  275. <tt class="descname">on_rfx_message</tt><a class="headerlink" href="#pyad2.ad2.AD2.on_rfx_message" title="Permalink to this definition">¶</a></dt>

  276. <dd><p>Called when an RFX message is received.</p>

  277. </dd></dl>

  278. 

  279. <dl class="attribute">

  280. <dt id="pyad2.ad2.AD2.on_open">

  281. <tt class="descname">on_open</tt><a class="headerlink" href="#pyad2.ad2.AD2.on_open" title="Permalink to this definition">¶</a></dt>

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

  283. </dd></dl>

  284. 

  285. <dl class="attribute">

  286. <dt id="pyad2.ad2.AD2.on_close">

  287. <tt class="descname">on_close</tt><a class="headerlink" href="#pyad2.ad2.AD2.on_close" title="Permalink to this definition">¶</a></dt>

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

  289. </dd></dl>

  290. 

  291. <dl class="attribute">

  292. <dt id="pyad2.ad2.AD2.on_read">

  293. <tt class="descname">on_read</tt><a class="headerlink" href="#pyad2.ad2.AD2.on_read" title="Permalink to this definition">¶</a></dt>

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

  295. </dd></dl>

  296. 

  297. <dl class="attribute">

  298. <dt id="pyad2.ad2.AD2.on_write">

  299. <tt class="descname">on_write</tt><a class="headerlink" href="#pyad2.ad2.AD2.on_write" title="Permalink to this definition">¶</a></dt>

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

  301. </dd></dl>

  302. 

  303. <dl class="attribute">

  304. <dt id="pyad2.ad2.AD2.F1">

  305. <tt class="descname">F1</tt><em class="property"> = u'\x01\x01\x01'</em><a class="headerlink" href="#pyad2.ad2.AD2.F1" title="Permalink to this definition">¶</a></dt>

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

  307. </dd></dl>

  308. 

  309. <dl class="attribute">

  310. <dt id="pyad2.ad2.AD2.F2">

  311. <tt class="descname">F2</tt><em class="property"> = u'\x02\x02\x02'</em><a class="headerlink" href="#pyad2.ad2.AD2.F2" title="Permalink to this definition">¶</a></dt>

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

  313. </dd></dl>

  314. 

  315. <dl class="attribute">

  316. <dt id="pyad2.ad2.AD2.F3">

  317. <tt class="descname">F3</tt><em class="property"> = u'\x03\x03\x03'</em><a class="headerlink" href="#pyad2.ad2.AD2.F3" title="Permalink to this definition">¶</a></dt>

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

  319. </dd></dl>

  320. 

  321. <dl class="attribute">

  322. <dt id="pyad2.ad2.AD2.F4">

  323. <tt class="descname">F4</tt><em class="property"> = u'\x04\x04\x04'</em><a class="headerlink" href="#pyad2.ad2.AD2.F4" title="Permalink to this definition">¶</a></dt>

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

  325. </dd></dl>

  326. 

  327. <dl class="attribute">

  328. <dt id="pyad2.ad2.AD2.BATTERY_TIMEOUT">

  329. <tt class="descname">BATTERY_TIMEOUT</tt><em class="property"> = 30</em><a class="headerlink" href="#pyad2.ad2.AD2.BATTERY_TIMEOUT" title="Permalink to this definition">¶</a></dt>

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

  331. </dd></dl>

  332. 

  333. <dl class="attribute">

  334. <dt id="pyad2.ad2.AD2.FIRE_TIMEOUT">

  335. <tt class="descname">FIRE_TIMEOUT</tt><em class="property"> = 30</em><a class="headerlink" href="#pyad2.ad2.AD2.FIRE_TIMEOUT" title="Permalink to this definition">¶</a></dt>

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

  337. </dd></dl>

  338. 

  339. <dl class="attribute">

  340. <dt id="pyad2.ad2.AD2.id">

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

  342. <dd><p>The ID of the AD2 device.</p>

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

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

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

  346. <tbody valign="top">

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

  348. </tr>

  349. </tbody>

  350. </table>

  351. </dd></dl>

  352. 

  353. <dl class="method">

  354. <dt id="pyad2.ad2.AD2.open">

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

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

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

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

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

  360. <tbody valign="top">

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

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

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

  364. </ul>

  365. </td>

  366. </tr>

  367. </tbody>

  368. </table>

  369. </dd></dl>

  370. 

  371. <dl class="method">

  372. <dt id="pyad2.ad2.AD2.close">

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

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

  375. </dd></dl>

  376. 

  377. <dl class="method">

  378. <dt id="pyad2.ad2.AD2.send">

  379. <tt class="descname">send</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/pyad2/ad2.html#AD2.send"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.ad2.AD2.send" title="Permalink to this definition">¶</a></dt>

  380. <dd><p>Sends data to the AD2 device.</p>

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

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

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

  384. <tbody valign="top">

  385. <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 send.</td>

  386. </tr>

  387. </tbody>

  388. </table>

  389. </dd></dl>

  390. 

  391. <dl class="method">

  392. <dt id="pyad2.ad2.AD2.get_config">

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

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

  395. </dd></dl>

  396. 

  397. <dl class="method">

  398. <dt id="pyad2.ad2.AD2.save_config">

  399. <tt class="descname">save_config</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pyad2/ad2.html#AD2.save_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.ad2.AD2.save_config" title="Permalink to this definition">¶</a></dt>

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

  401. </dd></dl>

  402. 

  403. <dl class="method">

  404. <dt id="pyad2.ad2.AD2.reboot">

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

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

  407. </dd></dl>

  408. 

  409. <dl class="method">

  410. <dt id="pyad2.ad2.AD2.fault_zone">

  411. <tt class="descname">fault_zone</tt><big>(</big><em>zone</em>, <em>simulate_wire_problem=False</em><big>)</big><a class="reference internal" href="_modules/pyad2/ad2.html#AD2.fault_zone"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.ad2.AD2.fault_zone" title="Permalink to this definition">¶</a></dt>

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

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

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

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

  416. <tbody valign="top">

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

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

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

  420. </ul>

  421. </td>

  422. </tr>

  423. </tbody>

  424. </table>

  425. </dd></dl>

  426. 

  427. <dl class="method">

  428. <dt id="pyad2.ad2.AD2.clear_zone">

  429. <tt class="descname">clear_zone</tt><big>(</big><em>zone</em><big>)</big><a class="reference internal" href="_modules/pyad2/ad2.html#AD2.clear_zone"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.ad2.AD2.clear_zone" title="Permalink to this definition">¶</a></dt>

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

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

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

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

  434. <tbody valign="top">

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

  436. </tr>

  437. </tbody>

  438. </table>

  439. </dd></dl>

  440. 

  441. </dd></dl>

  442. 

  443. </div>

  444. <div class="section" id="module-pyad2.devices">

  445. <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-pyad2.devices" title="Permalink to this headline">¶</a></h2>

  446. <p>Contains different types of devices belonging to the AD2 family.</p>

  447. <dl class="class">

  448. <dt id="pyad2.devices.Device">

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

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

  451. <p>Generic parent device to all AD2 products.</p>

  452. <dl class="attribute">

  453. <dt id="pyad2.devices.Device.on_open">

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

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

  456. </dd></dl>

  457. 

  458. <dl class="attribute">

  459. <dt id="pyad2.devices.Device.on_close">

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

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

  462. </dd></dl>

  463. 

  464. <dl class="attribute">

  465. <dt id="pyad2.devices.Device.on_read">

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

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

  468. </dd></dl>

  469. 

  470. <dl class="attribute">

  471. <dt id="pyad2.devices.Device.on_write">

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

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

  474. </dd></dl>

  475. 

  476. <dl class="attribute">

  477. <dt id="pyad2.devices.Device.id">

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

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

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

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

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

  483. <tbody valign="top">

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

  485. </tr>

  486. </tbody>

  487. </table>

  488. </dd></dl>

  489. 

  490. <dl class="method">

  491. <dt id="pyad2.devices.Device.is_reader_alive">

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

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

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

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

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

  497. <tbody valign="top">

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

  499. </tr>

  500. </tbody>

  501. </table>

  502. </dd></dl>

  503. 

  504. <dl class="method">

  505. <dt id="pyad2.devices.Device.stop_reader">

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

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

  508. </dd></dl>

  509. 

  510. <dl class="method">

  511. <dt id="pyad2.devices.Device.close">

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

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

  514. </dd></dl>

  515. 

  516. <dl class="class">

  517. <dt id="pyad2.devices.Device.ReadThread">

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

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

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

  521. <dl class="attribute">

  522. <dt id="pyad2.devices.Device.ReadThread.READ_TIMEOUT">

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

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

  525. </dd></dl>

  526. 

  527. <dl class="method">

  528. <dt id="pyad2.devices.Device.ReadThread.stop">

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

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

  531. </dd></dl>

  532. 

  533. <dl class="method">

  534. <dt id="pyad2.devices.Device.ReadThread.run">

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

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

  537. </dd></dl>

  538. 

  539. </dd></dl>

  540. 

  541. </dd></dl>

  542. 

  543. <dl class="class">

  544. <dt id="pyad2.devices.USBDevice">

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

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

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

  548. <dl class="attribute">

  549. <dt id="pyad2.devices.USBDevice.FTDI_VENDOR_ID">

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

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

  552. </dd></dl>

  553. 

  554. <dl class="attribute">

  555. <dt id="pyad2.devices.USBDevice.FTDI_PRODUCT_ID">

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

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

  558. </dd></dl>

  559. 

  560. <dl class="attribute">

  561. <dt id="pyad2.devices.USBDevice.BAUDRATE">

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

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

  564. </dd></dl>

  565. 

  566. <dl class="staticmethod">

  567. <dt id="pyad2.devices.USBDevice.find_all">

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

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

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

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

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

  573. <tbody valign="top">

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

  575. </tr>

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

  577. </tr>

  578. </tbody>

  579. </table>

  580. </dd></dl>

  581. 

  582. <dl class="attribute">

  583. <dt id="pyad2.devices.USBDevice.interface">

  584. <tt class="descname">interface</tt><a class="reference internal" href="_modules/pyad2/devices.html#USBDevice.interface"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.devices.USBDevice.interface" title="Permalink to this definition">¶</a></dt>

  585. <dd><p>Retrieves the interface used to connect to the device.</p>

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

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

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

  589. <tbody valign="top">

  590. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the interface used to connect to the device.</td>

  591. </tr>

  592. </tbody>

  593. </table>

  594. </dd></dl>

  595. 

  596. <dl class="attribute">

  597. <dt id="pyad2.devices.USBDevice.serial_number">

  598. <tt class="descname">serial_number</tt><a class="reference internal" href="_modules/pyad2/devices.html#USBDevice.serial_number"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.devices.USBDevice.serial_number" title="Permalink to this definition">¶</a></dt>

  599. <dd><p>Retrieves the serial number of 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 serial number of the device.</td>

  605. </tr>

  606. </tbody>

  607. </table>

  608. </dd></dl>

  609. 

  610. <dl class="attribute">

  611. <dt id="pyad2.devices.USBDevice.description">

  612. <tt class="descname">description</tt><a class="reference internal" href="_modules/pyad2/devices.html#USBDevice.description"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.devices.USBDevice.description" title="Permalink to this definition">¶</a></dt>

  613. <dd><p>Retrieves the description of the device.</p>

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

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

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

  617. <tbody valign="top">

  618. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The description of the device.</td>

  619. </tr>

  620. </tbody>

  621. </table>

  622. </dd></dl>

  623. 

  624. <dl class="method">

  625. <dt id="pyad2.devices.USBDevice.open">

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

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

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

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

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

  631. <tbody valign="top">

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

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

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

  635. </ul>

  636. </td>

  637. </tr>

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

  639. </td>

  640. </tr>

  641. </tbody>

  642. </table>

  643. </dd></dl>

  644. 

  645. <dl class="method">

  646. <dt id="pyad2.devices.USBDevice.close">

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

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

  649. </dd></dl>

  650. 

  651. <dl class="method">

  652. <dt id="pyad2.devices.USBDevice.write">

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

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

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

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

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

  658. <tbody valign="top">

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

  660. </tr>

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

  662. </tr>

  663. </tbody>

  664. </table>

  665. </dd></dl>

  666. 

  667. <dl class="method">

  668. <dt id="pyad2.devices.USBDevice.read">

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

  670. <dd><p>Reads a single character from 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">Returns:</th><td class="field-body">The character read from the device.</td>

  676. </tr>

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

  678. </tr>

  679. </tbody>

  680. </table>

  681. </dd></dl>

  682. 

  683. <dl class="method">

  684. <dt id="pyad2.devices.USBDevice.read_line">

  685. <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/pyad2/devices.html#USBDevice.read_line"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.devices.USBDevice.read_line" title="Permalink to this definition">¶</a></dt>

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

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

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

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

  690. <tbody valign="top">

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

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

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

  694. </ul>

  695. </td>

  696. </tr>

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

  698. </td>

  699. </tr>

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

  701. </td>

  702. </tr>

  703. </tbody>

  704. </table>

  705. </dd></dl>

  706. 

  707. </dd></dl>

  708. 

  709. <dl class="class">

  710. <dt id="pyad2.devices.SerialDevice">

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

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

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

  714. <dl class="attribute">

  715. <dt id="pyad2.devices.SerialDevice.BAUDRATE">

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

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

  718. </dd></dl>

  719. 

  720. <dl class="staticmethod">

  721. <dt id="pyad2.devices.SerialDevice.find_all">

  722. <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/pyad2/devices.html#SerialDevice.find_all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.devices.SerialDevice.find_all" title="Permalink to this definition">¶</a></dt>

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

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

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

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

  727. <tbody valign="top">

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

  729. </tr>

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

  731. </tr>

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

  733. </tr>

  734. </tbody>

  735. </table>

  736. </dd></dl>

  737. 

  738. <dl class="attribute">

  739. <dt id="pyad2.devices.SerialDevice.interface">

  740. <tt class="descname">interface</tt><a class="reference internal" href="_modules/pyad2/devices.html#SerialDevice.interface"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.devices.SerialDevice.interface" title="Permalink to this definition">¶</a></dt>

  741. <dd><p>Retrieves the interface used to connect to the device.</p>

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

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

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

  745. <tbody valign="top">

  746. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the interface used to connect to the device.</td>

  747. </tr>

  748. </tbody>

  749. </table>

  750. </dd></dl>

  751. 

  752. <dl class="method">

  753. <dt id="pyad2.devices.SerialDevice.open">

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

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

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

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

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

  759. <tbody valign="top">

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

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

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

  763. </ul>

  764. </td>

  765. </tr>

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

  767. </td>

  768. </tr>

  769. </tbody>

  770. </table>

  771. </dd></dl>

  772. 

  773. <dl class="method">

  774. <dt id="pyad2.devices.SerialDevice.close">

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

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

  777. </dd></dl>

  778. 

  779. <dl class="method">

  780. <dt id="pyad2.devices.SerialDevice.write">

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

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

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

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

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

  786. <tbody valign="top">

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

  788. </tr>

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

  790. </tr>

  791. </tbody>

  792. </table>

  793. </dd></dl>

  794. 

  795. <dl class="method">

  796. <dt id="pyad2.devices.SerialDevice.read">

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

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

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

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

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

  802. <tbody valign="top">

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

  804. </tr>

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

  806. </tr>

  807. </tbody>

  808. </table>

  809. </dd></dl>

  810. 

  811. <dl class="method">

  812. <dt id="pyad2.devices.SerialDevice.read_line">

  813. <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/pyad2/devices.html#SerialDevice.read_line"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.devices.SerialDevice.read_line" title="Permalink to this definition">¶</a></dt>

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

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

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

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

  818. <tbody valign="top">

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

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

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

  822. </ul>

  823. </td>

  824. </tr>

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

  826. </td>

  827. </tr>

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

  829. </td>

  830. </tr>

  831. </tbody>

  832. </table>

  833. </dd></dl>

  834. 

  835. </dd></dl>

  836. 

  837. <dl class="class">

  838. <dt id="pyad2.devices.SocketDevice">

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

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

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

  842. Serial to IP interface.</p>

  843. <dl class="attribute">

  844. <dt id="pyad2.devices.SocketDevice.interface">

  845. <tt class="descname">interface</tt><a class="reference internal" href="_modules/pyad2/devices.html#SocketDevice.interface"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.devices.SocketDevice.interface" title="Permalink to this definition">¶</a></dt>

  846. <dd><p>Retrieves the interface used to connect to the device.</p>

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

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

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

  850. <tbody valign="top">

  851. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the interface used to connect to the device.</td>

  852. </tr>

  853. </tbody>

  854. </table>

  855. </dd></dl>

  856. 

  857. <dl class="attribute">

  858. <dt id="pyad2.devices.SocketDevice.ssl">

  859. <tt class="descname">ssl</tt><a class="reference internal" href="_modules/pyad2/devices.html#SocketDevice.ssl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.devices.SocketDevice.ssl" title="Permalink to this definition">¶</a></dt>

  860. <dd><p>Retrieves whether or not the device is using SSL.</p>

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

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

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

  864. <tbody valign="top">

  865. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Whether or not the device is using SSL.</td>

  866. </tr>

  867. </tbody>

  868. </table>

  869. </dd></dl>

  870. 

  871. <dl class="attribute">

  872. <dt id="pyad2.devices.SocketDevice.ssl_certificate">

  873. <tt class="descname">ssl_certificate</tt><a class="reference internal" href="_modules/pyad2/devices.html#SocketDevice.ssl_certificate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.devices.SocketDevice.ssl_certificate" title="Permalink to this definition">¶</a></dt>

  874. <dd><p>Retrieves the SSL client certificate path used for authentication.</p>

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

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

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

  878. <tbody valign="top">

  879. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The certificate path</td>

  880. </tr>

  881. </tbody>

  882. </table>

  883. </dd></dl>

  884. 

  885. <dl class="attribute">

  886. <dt id="pyad2.devices.SocketDevice.ssl_key">

  887. <tt class="descname">ssl_key</tt><a class="reference internal" href="_modules/pyad2/devices.html#SocketDevice.ssl_key"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.devices.SocketDevice.ssl_key" title="Permalink to this definition">¶</a></dt>

  888. <dd><p>Retrieves the SSL client certificate key used for authentication.</p>

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

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

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

  892. <tbody valign="top">

  893. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The key path</td>

  894. </tr>

  895. </tbody>

  896. </table>

  897. </dd></dl>

  898. 

  899. <dl class="attribute">

  900. <dt id="pyad2.devices.SocketDevice.ssl_ca">

  901. <tt class="descname">ssl_ca</tt><a class="reference internal" href="_modules/pyad2/devices.html#SocketDevice.ssl_ca"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.devices.SocketDevice.ssl_ca" title="Permalink to this definition">¶</a></dt>

  902. <dd><p>Retrieves the SSL Certificate Authority certificate used for authentication.</p>

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

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

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

  906. <tbody valign="top">

  907. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The CA path</td>

  908. </tr>

  909. </tbody>

  910. </table>

  911. </dd></dl>

  912. 

  913. <dl class="method">

  914. <dt id="pyad2.devices.SocketDevice.open">

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

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

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

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

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

  920. <tbody valign="top">

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

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

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

  924. </ul>

  925. </td>

  926. </tr>

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

  928. </td>

  929. </tr>

  930. </tbody>

  931. </table>

  932. </dd></dl>

  933. 

  934. <dl class="method">

  935. <dt id="pyad2.devices.SocketDevice.close">

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

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

  938. </dd></dl>

  939. 

  940. <dl class="method">

  941. <dt id="pyad2.devices.SocketDevice.write">

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

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

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

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

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

  947. <tbody valign="top">

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

  949. </tr>

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

  951. </tr>

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

  953. </tr>

  954. </tbody>

  955. </table>

  956. </dd></dl>

  957. 

  958. <dl class="method">

  959. <dt id="pyad2.devices.SocketDevice.read">

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

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

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

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

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

  965. <tbody valign="top">

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

  967. </tr>

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

  969. </tr>

  970. </tbody>

  971. </table>

  972. </dd></dl>

  973. 

  974. <dl class="method">

  975. <dt id="pyad2.devices.SocketDevice.read_line">

  976. <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/pyad2/devices.html#SocketDevice.read_line"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.devices.SocketDevice.read_line" title="Permalink to this definition">¶</a></dt>

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

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

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

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

  981. <tbody valign="top">

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

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

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

  985. </ul>

  986. </td>

  987. </tr>

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

  989. </td>

  990. </tr>

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

  992. </td>

  993. </tr>

  994. </tbody>

  995. </table>

  996. </dd></dl>

  997. 

  998. </dd></dl>

  999. 

  1000. </div>

  1001. <div class="section" id="module-pyad2.util">

  1002. <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-pyad2.util" title="Permalink to this headline">¶</a></h2>

  1003. <p>Provides utility classes for the AD2 devices.</p>

  1004. <dl class="exception">

  1005. <dt id="pyad2.util.NoDeviceError">

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

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

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

  1009. </dd></dl>

  1010. 

  1011. <dl class="exception">

  1012. <dt id="pyad2.util.CommError">

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

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

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

  1016. </dd></dl>

  1017. 

  1018. <dl class="exception">

  1019. <dt id="pyad2.util.TimeoutError">

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

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

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

  1023. </dd></dl>

  1024. 

  1025. <dl class="exception">

  1026. <dt id="pyad2.util.InvalidMessageError">

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

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

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

  1030. </dd></dl>

  1031. 

  1032. <dl class="class">

  1033. <dt id="pyad2.util.Firmware">

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

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

  1036. <p>Represents firmware for the AD2 devices.</p>

  1037. <dl class="attribute">

  1038. <dt id="pyad2.util.Firmware.STAGE_START">

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

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

  1041. 

  1042. <dl class="attribute">

  1043. <dt id="pyad2.util.Firmware.STAGE_WAITING">

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

  1045. <dd></dd></dl>

  1046. 

  1047. <dl class="attribute">

  1048. <dt id="pyad2.util.Firmware.STAGE_BOOT">

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

  1050. <dd></dd></dl>

  1051. 

  1052. <dl class="attribute">

  1053. <dt id="pyad2.util.Firmware.STAGE_LOAD">

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

  1055. <dd></dd></dl>

  1056. 

  1057. <dl class="attribute">

  1058. <dt id="pyad2.util.Firmware.STAGE_UPLOADING">

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

  1060. <dd></dd></dl>

  1061. 

  1062. <dl class="attribute">

  1063. <dt id="pyad2.util.Firmware.STAGE_DONE">

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

  1065. <dd></dd></dl>

  1066. 

  1067. <dl class="staticmethod">

  1068. <dt id="pyad2.util.Firmware.upload">

  1069. <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/pyad2/util.html#Firmware.upload"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.util.Firmware.upload" title="Permalink to this definition">¶</a></dt>

  1070. <dd><p>Uploads firmware to an AD2 device.</p>

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

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

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

  1074. <tbody valign="top">

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

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

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

  1078. </ul>

  1079. </td>

  1080. </tr>

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

  1082. </td>

  1083. </tr>

  1084. </tbody>

  1085. </table>

  1086. </dd></dl>

  1087. 

  1088. </dd></dl>

  1089. 

  1090. </div>

  1091. <div class="section" id="module-pyad2.zonetracking">

  1092. <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-pyad2.zonetracking" title="Permalink to this headline">¶</a></h2>

  1093. <p>Provides zone tracking functionality for the AD2 device family.</p>

  1094. <dl class="class">

  1095. <dt id="pyad2.zonetracking.Zone">

  1096. <em class="property">class </em><tt class="descclassname">pyad2.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/pyad2/zonetracking.html#Zone"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyad2.zonetracking.Zone" title="Permalink to this definition">¶</a></dt>

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

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

  1099. <dl class="attribute">

  1100. <dt id="pyad2.zonetracking.Zone.CLEAR">

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

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

  1103. </dd></dl>

  1104. 

  1105. <dl class="attribute">

  1106. <dt id="pyad2.zonetracking.Zone.FAULT">

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

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

  1109. </dd></dl>

  1110. 

  1111. <dl class="attribute">

  1112. <dt id="pyad2.zonetracking.Zone.CHECK">

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

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

  1115. </dd></dl>

  1116. 

  1117. <dl class="attribute">

  1118. <dt id="pyad2.zonetracking.Zone.STATUS">

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

  1120. <dd></dd></dl>

  1121. 

  1122. </dd></dl>

  1123. 

  1124. <dl class="class">

  1125. <dt id="pyad2.zonetracking.Zonetracker">

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

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

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

  1129. <dl class="attribute">

  1130. <dt id="pyad2.zonetracking.Zonetracker.on_fault">

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

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

  1133. </dd></dl>

  1134. 

  1135. <dl class="attribute">

  1136. <dt id="pyad2.zonetracking.Zonetracker.on_restore">

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

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

  1139. </dd></dl>

  1140. 

  1141. <dl class="attribute">

  1142. <dt id="pyad2.zonetracking.Zonetracker.EXPIRE">

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

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

  1145. </dd></dl>

  1146. 

  1147. <dl class="method">

  1148. <dt id="pyad2.zonetracking.Zonetracker.update">

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

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

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

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

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

  1154. <tbody valign="top">

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

  1156. </tr>

  1157. </tbody>

  1158. </table>

  1159. </dd></dl>

  1160. 

  1161. </dd></dl>

  1162. 

  1163. </div>

  1164. <div class="section" id="module-pyad2.panels">

  1165. <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-pyad2.panels" title="Permalink to this headline">¶</a></h2>

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

  1167. </div>

  1168. <div class="section" id="module-pyad2.messages">

  1169. <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-pyad2.messages" title="Permalink to this headline">¶</a></h2>

  1170. <p>Message representations received from the panel through the AD2 devices.</p>

  1171. <dl class="class">

  1172. <dt id="pyad2.messages.BaseMessage">

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

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

  1175. <p>Base class for messages.</p>

  1176. <dl class="attribute">

  1177. <dt id="pyad2.messages.BaseMessage.raw">

  1178. <tt class="descname">raw</tt><em class="property"> = None</em><a class="headerlink" href="#pyad2.messages.BaseMessage.raw" title="Permalink to this definition">¶</a></dt>

  1179. <dd><p>The raw message text</p>

  1180. </dd></dl>

  1181. 

  1182. </dd></dl>

  1183. 

  1184. <dl class="class">

  1185. <dt id="pyad2.messages.Message">

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

  1187. <dd><p>Bases: <a class="reference internal" href="#pyad2.messages.BaseMessage" title="pyad2.messages.BaseMessage"><tt class="xref py py-class docutils literal"><span class="pre">pyad2.messages.BaseMessage</span></tt></a></p>

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

  1189. <dl class="attribute">

  1190. <dt id="pyad2.messages.Message.ready">

  1191. <tt class="descname">ready</tt><em class="property"> = False</em><a class="headerlink" href="#pyad2.messages.Message.ready" title="Permalink to this definition">¶</a></dt>

  1192. <dd><p>Indicates whether or not the panel is in a ready state</p>

  1193. </dd></dl>

  1194. 

  1195. <dl class="attribute">

  1196. <dt id="pyad2.messages.Message.armed_away">

  1197. <tt class="descname">armed_away</tt><em class="property"> = False</em><a class="headerlink" href="#pyad2.messages.Message.armed_away" title="Permalink to this definition">¶</a></dt>

  1198. <dd><p>Indicates whether or not the panel is armed away</p>

  1199. </dd></dl>

  1200. 

  1201. <dl class="attribute">

  1202. <dt id="pyad2.messages.Message.armed_home">

  1203. <tt class="descname">armed_home</tt><em class="property"> = False</em><a class="headerlink" href="#pyad2.messages.Message.armed_home" title="Permalink to this definition">¶</a></dt>

  1204. <dd><p>Indicates whether or not the panel is armed home</p>

  1205. </dd></dl>

  1206. 

  1207. <dl class="attribute">

  1208. <dt id="pyad2.messages.Message.backlight_on">

  1209. <tt class="descname">backlight_on</tt><em class="property"> = False</em><a class="headerlink" href="#pyad2.messages.Message.backlight_on" title="Permalink to this definition">¶</a></dt>

  1210. <dd><p>Indicates whether or not the keypad backlight is on</p>

  1211. </dd></dl>

  1212. 

  1213. <dl class="attribute">

  1214. <dt id="pyad2.messages.Message.programming_mode">

  1215. <tt class="descname">programming_mode</tt><em class="property"> = False</em><a class="headerlink" href="#pyad2.messages.Message.programming_mode" title="Permalink to this definition">¶</a></dt>

  1216. <dd><p>Indicates whether or not we&#8217;re in programming mode</p>

  1217. </dd></dl>

  1218. 

  1219. <dl class="attribute">

  1220. <dt id="pyad2.messages.Message.beeps">

  1221. <tt class="descname">beeps</tt><em class="property"> = -1</em><a class="headerlink" href="#pyad2.messages.Message.beeps" title="Permalink to this definition">¶</a></dt>

  1222. <dd><p>Number of beeps associated with a message</p>

  1223. </dd></dl>

  1224. 

  1225. <dl class="attribute">

  1226. <dt id="pyad2.messages.Message.zone_bypassed">

  1227. <tt class="descname">zone_bypassed</tt><em class="property"> = False</em><a class="headerlink" href="#pyad2.messages.Message.zone_bypassed" title="Permalink to this definition">¶</a></dt>

  1228. <dd><p>Indicates whether or not a zone is bypassed</p>

  1229. </dd></dl>

  1230. 

  1231. <dl class="attribute">

  1232. <dt id="pyad2.messages.Message.ac_power">

  1233. <tt class="descname">ac_power</tt><em class="property"> = False</em><a class="headerlink" href="#pyad2.messages.Message.ac_power" title="Permalink to this definition">¶</a></dt>

  1234. <dd><p>Indicates whether or not the panel is on AC power</p>

  1235. </dd></dl>

  1236. 

  1237. <dl class="attribute">

  1238. <dt id="pyad2.messages.Message.chime_on">

  1239. <tt class="descname">chime_on</tt><em class="property"> = False</em><a class="headerlink" href="#pyad2.messages.Message.chime_on" title="Permalink to this definition">¶</a></dt>

  1240. <dd><p>Indicates whether or not the chime is enabled</p>

  1241. </dd></dl>

  1242. 

  1243. <dl class="attribute">

  1244. <dt id="pyad2.messages.Message.alarm_event_occurred">

  1245. <tt class="descname">alarm_event_occurred</tt><em class="property"> = False</em><a class="headerlink" href="#pyad2.messages.Message.alarm_event_occurred" title="Permalink to this definition">¶</a></dt>

  1246. <dd><p>Indicates whether or not an alarm event has occurred</p>

  1247. </dd></dl>

  1248. 

  1249. <dl class="attribute">

  1250. <dt id="pyad2.messages.Message.alarm_sounding">

  1251. <tt class="descname">alarm_sounding</tt><em class="property"> = False</em><a class="headerlink" href="#pyad2.messages.Message.alarm_sounding" title="Permalink to this definition">¶</a></dt>

  1252. <dd><p>Indicates whether or not an alarm is sounding</p>

  1253. </dd></dl>

  1254. 

  1255. <dl class="attribute">

  1256. <dt id="pyad2.messages.Message.battery_low">

  1257. <tt class="descname">battery_low</tt><em class="property"> = False</em><a class="headerlink" href="#pyad2.messages.Message.battery_low" title="Permalink to this definition">¶</a></dt>

  1258. <dd><p>Indicates whether or not there is a low battery</p>

  1259. </dd></dl>

  1260. 

  1261. <dl class="attribute">

  1262. <dt id="pyad2.messages.Message.entry_delay_off">

  1263. <tt class="descname">entry_delay_off</tt><em class="property"> = False</em><a class="headerlink" href="#pyad2.messages.Message.entry_delay_off" title="Permalink to this definition">¶</a></dt>

  1264. <dd><p>Indicates whether or not the entry delay is enabled</p>

  1265. </dd></dl>

  1266. 

  1267. <dl class="attribute">

  1268. <dt id="pyad2.messages.Message.fire_alarm">

  1269. <tt class="descname">fire_alarm</tt><em class="property"> = False</em><a class="headerlink" href="#pyad2.messages.Message.fire_alarm" title="Permalink to this definition">¶</a></dt>

  1270. <dd><p>Indicates whether or not a fire alarm is sounding</p>

  1271. </dd></dl>

  1272. 

  1273. <dl class="attribute">

  1274. <dt id="pyad2.messages.Message.check_zone">

  1275. <tt class="descname">check_zone</tt><em class="property"> = False</em><a class="headerlink" href="#pyad2.messages.Message.check_zone" title="Permalink to this definition">¶</a></dt>

  1276. <dd><p>Indicates whether or not there are zones that require attention.</p>

  1277. </dd></dl>

  1278. 

  1279. <dl class="attribute">

  1280. <dt id="pyad2.messages.Message.perimeter_only">

  1281. <tt class="descname">perimeter_only</tt><em class="property"> = False</em><a class="headerlink" href="#pyad2.messages.Message.perimeter_only" title="Permalink to this definition">¶</a></dt>

  1282. <dd><p>Indicates whether or not the perimeter is armed</p>

  1283. </dd></dl>

  1284. 

  1285. <dl class="attribute">

  1286. <dt id="pyad2.messages.Message.numeric_code">

  1287. <tt class="descname">numeric_code</tt><em class="property"> = None</em><a class="headerlink" href="#pyad2.messages.Message.numeric_code" title="Permalink to this definition">¶</a></dt>

  1288. <dd><p>The numeric code associated with the message</p>

  1289. </dd></dl>

  1290. 

  1291. <dl class="attribute">

  1292. <dt id="pyad2.messages.Message.text">

  1293. <tt class="descname">text</tt><em class="property"> = None</em><a class="headerlink" href="#pyad2.messages.Message.text" title="Permalink to this definition">¶</a></dt>

  1294. <dd><p>The human-readable text to be displayed on the panel LCD</p>

  1295. </dd></dl>

  1296. 

  1297. <dl class="attribute">

  1298. <dt id="pyad2.messages.Message.cursor_location">

  1299. <tt class="descname">cursor_location</tt><em class="property"> = -1</em><a class="headerlink" href="#pyad2.messages.Message.cursor_location" title="Permalink to this definition">¶</a></dt>

  1300. <dd><p>Current cursor location on the keypad</p>

  1301. </dd></dl>

  1302. 

  1303. <dl class="attribute">

  1304. <dt id="pyad2.messages.Message.mask">

  1305. <tt class="descname">mask</tt><em class="property"> = None</em><a class="headerlink" href="#pyad2.messages.Message.mask" title="Permalink to this definition">¶</a></dt>

  1306. <dd><p>Address mask this message is intended for</p>

  1307. </dd></dl>

  1308. 

  1309. <dl class="attribute">

  1310. <dt id="pyad2.messages.Message.bitfield">

  1311. <tt class="descname">bitfield</tt><em class="property"> = None</em><a class="headerlink" href="#pyad2.messages.Message.bitfield" title="Permalink to this definition">¶</a></dt>

  1312. <dd><p>The bitfield associated with this message</p>

  1313. </dd></dl>

  1314. 

  1315. <dl class="attribute">

  1316. <dt id="pyad2.messages.Message.panel_data">

  1317. <tt class="descname">panel_data</tt><em class="property"> = None</em><a class="headerlink" href="#pyad2.messages.Message.panel_data" title="Permalink to this definition">¶</a></dt>

  1318. <dd><p>The panel data field associated with this message</p>

  1319. </dd></dl>

  1320. 

  1321. </dd></dl>

  1322. 

  1323. <dl class="class">

  1324. <dt id="pyad2.messages.ExpanderMessage">

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

  1326. <dd><p>Bases: <a class="reference internal" href="#pyad2.messages.BaseMessage" title="pyad2.messages.BaseMessage"><tt class="xref py py-class docutils literal"><span class="pre">pyad2.messages.BaseMessage</span></tt></a></p>

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

  1328. <dl class="attribute">

  1329. <dt id="pyad2.messages.ExpanderMessage.ZONE">

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

  1331. <dd><p>Flag indicating that the expander message relates to a Zone Expander.</p>

  1332. </dd></dl>

  1333. 

  1334. <dl class="attribute">

  1335. <dt id="pyad2.messages.ExpanderMessage.RELAY">

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

  1337. <dd><p>Flag indicating that the expander message relates to a Relay Expander.</p>

  1338. </dd></dl>

  1339. 

  1340. <dl class="attribute">

  1341. <dt id="pyad2.messages.ExpanderMessage.type">

  1342. <tt class="descname">type</tt><em class="property"> = None</em><a class="headerlink" href="#pyad2.messages.ExpanderMessage.type" title="Permalink to this definition">¶</a></dt>

  1343. <dd><p>Expander message type: ExpanderMessage.ZONE or ExpanderMessage.RELAY</p>

  1344. </dd></dl>

  1345. 

  1346. <dl class="attribute">

  1347. <dt id="pyad2.messages.ExpanderMessage.address">

  1348. <tt class="descname">address</tt><em class="property"> = -1</em><a class="headerlink" href="#pyad2.messages.ExpanderMessage.address" title="Permalink to this definition">¶</a></dt>

  1349. <dd><p>Address of expander</p>

  1350. </dd></dl>

  1351. 

  1352. <dl class="attribute">

  1353. <dt id="pyad2.messages.ExpanderMessage.channel">

  1354. <tt class="descname">channel</tt><em class="property"> = -1</em><a class="headerlink" href="#pyad2.messages.ExpanderMessage.channel" title="Permalink to this definition">¶</a></dt>

  1355. <dd><p>Channel on the expander</p>

  1356. </dd></dl>

  1357. 

  1358. <dl class="attribute">

  1359. <dt id="pyad2.messages.ExpanderMessage.value">

  1360. <tt class="descname">value</tt><em class="property"> = -1</em><a class="headerlink" href="#pyad2.messages.ExpanderMessage.value" title="Permalink to this definition">¶</a></dt>

  1361. <dd><p>Value associated with the message</p>

  1362. </dd></dl>

  1363. 

  1364. </dd></dl>

  1365. 

  1366. <dl class="class">

  1367. <dt id="pyad2.messages.RFMessage">

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

  1369. <dd><p>Bases: <a class="reference internal" href="#pyad2.messages.BaseMessage" title="pyad2.messages.BaseMessage"><tt class="xref py py-class docutils literal"><span class="pre">pyad2.messages.BaseMessage</span></tt></a></p>

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

  1371. <dl class="attribute">

  1372. <dt id="pyad2.messages.RFMessage.x">

  1373. <tt class="descname">x</tt><em class="property"> = 3</em><a class="headerlink" href="#pyad2.messages.RFMessage.x" title="Permalink to this definition">¶</a></dt>

  1374. <dd></dd></dl>

  1375. 

  1376. <dl class="attribute">

  1377. <dt id="pyad2.messages.RFMessage.serial_number">

  1378. <tt class="descname">serial_number</tt><em class="property"> = None</em><a class="headerlink" href="#pyad2.messages.RFMessage.serial_number" title="Permalink to this definition">¶</a></dt>

  1379. <dd><p>Serial number of the RF device</p>

  1380. </dd></dl>

  1381. 

  1382. <dl class="attribute">

  1383. <dt id="pyad2.messages.RFMessage.value">

  1384. <tt class="descname">value</tt><em class="property"> = -1</em><a class="headerlink" href="#pyad2.messages.RFMessage.value" title="Permalink to this definition">¶</a></dt>

  1385. <dd><p>Value associated with this message</p>

  1386. </dd></dl>

  1387. 

  1388. <dl class="attribute">

  1389. <dt id="pyad2.messages.RFMessage.battery">

  1390. <tt class="descname">battery</tt><em class="property"> = False</em><a class="headerlink" href="#pyad2.messages.RFMessage.battery" title="Permalink to this definition">¶</a></dt>

  1391. <dd><p>Battery low indication</p>

  1392. </dd></dl>

  1393. 

  1394. <dl class="attribute">

  1395. <dt id="pyad2.messages.RFMessage.supervision">

  1396. <tt class="descname">supervision</tt><em class="property"> = False</em><a class="headerlink" href="#pyad2.messages.RFMessage.supervision" title="Permalink to this definition">¶</a></dt>

  1397. <dd><p>Supervision required indication</p>

  1398. </dd></dl>

  1399. 

  1400. <dl class="attribute">

  1401. <dt id="pyad2.messages.RFMessage.loop">

  1402. <tt class="descname">loop</tt><em class="property"> = [False, False, False, False]</em><a class="headerlink" href="#pyad2.messages.RFMessage.loop" title="Permalink to this definition">¶</a></dt>

  1403. <dd><p>Loop indicators</p>

  1404. </dd></dl>

  1405. 

  1406. </dd></dl>

  1407. 

  1408. <dl class="class">

  1409. <dt id="pyad2.messages.LRRMessage">

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

  1411. <dd><p>Bases: <a class="reference internal" href="#pyad2.messages.BaseMessage" title="pyad2.messages.BaseMessage"><tt class="xref py py-class docutils literal"><span class="pre">pyad2.messages.BaseMessage</span></tt></a></p>

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

  1413. <dl class="attribute">

  1414. <dt id="pyad2.messages.LRRMessage.event_data">

  1415. <tt class="descname">event_data</tt><em class="property"> = None</em><a class="headerlink" href="#pyad2.messages.LRRMessage.event_data" title="Permalink to this definition">¶</a></dt>

  1416. <dd><p>Data associated with the LRR message.  Usually user ID or zone.</p>

  1417. </dd></dl>

  1418. 

  1419. <dl class="attribute">

  1420. <dt id="pyad2.messages.LRRMessage.partition">

  1421. <tt class="descname">partition</tt><em class="property"> = -1</em><a class="headerlink" href="#pyad2.messages.LRRMessage.partition" title="Permalink to this definition">¶</a></dt>

  1422. <dd><p>The partition that this message applies to</p>

  1423. </dd></dl>

  1424. 

  1425. <dl class="attribute">

  1426. <dt id="pyad2.messages.LRRMessage.event_type">

  1427. <tt class="descname">event_type</tt><em class="property"> = None</em><a class="headerlink" href="#pyad2.messages.LRRMessage.event_type" title="Permalink to this definition">¶</a></dt>

  1428. <dd><p>The type of the event that occurred</p>

  1429. </dd></dl>

  1430. 

  1431. </dd></dl>

  1432. 

  1433. </div>

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

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

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

  1437. <ul>

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

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

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

  1441. </ul>

  1442. </li>

  1443. </ul>

  1444. </div>

  1445. </div>

  1446. </div>

  1447. 

  1448. 

  1449.           </div>

  1450.         </div>

  1451.       </div>

  1452.       <div class="sphinxsidebar">

  1453.         <div class="sphinxsidebarwrapper">

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

  1455.   <ul>

  1456. <li><a class="reference internal" href="#">pyad2 Package</a><ul>

  1457. <li><a class="reference internal" href="#module-pyad2.ad2"><tt class="docutils literal"><span class="pre">ad2</span></tt> Module</a></li>

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

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

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

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

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

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

  1464. </ul>

  1465. </li>

  1466. </ul>

  1467. </li>

  1468. </ul>

  1469. 

  1470.   <h4>Previous topic</h4>

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

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

  1473.   <h4>Next topic</h4>

  1474.   <p class="topless"><a href="pyad2.event.html"

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

  1476.   <h3>This Page</h3>

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

  1478.     <li><a href="_sources/pyad2.txt"

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

  1480.   </ul>

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

  1482.   <h3>Quick search</h3>

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

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

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

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

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

  1488.     </form>

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

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

  1491.     </p>

  1492. </div>

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

  1494.         </div>

  1495.       </div>

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

  1497.     </div>

  1498.     <div class="related">

  1499.       <h3>Navigation</h3>

  1500.       <ul>

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

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

  1503.              >index</a></li>

  1504.         <li class="right" >

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

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

  1507.         <li class="right" >

  1508.           <a href="pyad2.event.html" title="event Package"

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

  1510.         <li class="right" >

  1511.           <a href="index.html" title="Welcome to pyad2’s documentation!"

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

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

  1514.       </ul>

  1515.     </div>

  1516.     <div class="footer">

  1517.         &copy; Copyright 2013, Author.

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

  1519.     </div>

  1520.   </body>

  1521. </html>