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

1626 lines
102 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>alarmdecoder Package &mdash; alarmdecoder  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="alarmdecoder  documentation" href="index.html" />

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

  28.   </head>

  29.   <body>

  30.     <div class="related">

  31.       <h3>Navigation</h3>

  32.       <ul>

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

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

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

  36.         <li class="right" >

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

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

  39.         <li class="right" >

  40.           <a href="index.html" title="Welcome to alarmdecoder’s documentation!"

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

  42.         <li><a href="index.html">alarmdecoder  documentation</a> &raquo;</li> 

  43.       </ul>

  44.     </div>  

  45. 

  46.     <div class="document">

  47.       <div class="documentwrapper">

  48.         <div class="bodywrapper">

  49.           <div class="body">

  50.             

  51.   <div class="section" id="alarmdecoder-package">

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

  53. <div class="section" id="module-alarmdecoder.decoder">

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

  55. <p>Provides the main AlarmDecoder class.</p>

  56. <dl class="class">

  57. <dt id="alarmdecoder.decoder.AlarmDecoder">

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

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

  60. <p>High-level wrapper around <a class="reference external" href="http://www.alarmdecoder.com">Alarm Decoder</a> (AD2) devices.</p>

  61. <dl class="attribute">

  62. <dt id="alarmdecoder.decoder.AlarmDecoder.on_arm">

  63. <tt class="descname">on_arm</tt><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.on_arm" title="Permalink to this definition">¶</a></dt>

  64. <dd><p>This event is called when the panel is armed.</p>

  65. </dd></dl>

  66. 

  67. <dl class="attribute">

  68. <dt id="alarmdecoder.decoder.AlarmDecoder.on_disarm">

  69. <tt class="descname">on_disarm</tt><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.on_disarm" title="Permalink to this definition">¶</a></dt>

  70. <dd><p>This event is called when the panel is disarmed.</p>

  71. </dd></dl>

  72. 

  73. <dl class="attribute">

  74. <dt id="alarmdecoder.decoder.AlarmDecoder.on_power_changed">

  75. <tt class="descname">on_power_changed</tt><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.on_power_changed" title="Permalink to this definition">¶</a></dt>

  76. <dd><p>This event is called when panel power switches between AC and DC.</p>

  77. </dd></dl>

  78. 

  79. <dl class="attribute">

  80. <dt id="alarmdecoder.decoder.AlarmDecoder.on_alarm">

  81. <tt class="descname">on_alarm</tt><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.on_alarm" title="Permalink to this definition">¶</a></dt>

  82. <dd><p>This event is called when the alarm is triggered.</p>

  83. </dd></dl>

  84. 

  85. <dl class="attribute">

  86. <dt id="alarmdecoder.decoder.AlarmDecoder.on_fire">

  87. <tt class="descname">on_fire</tt><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.on_fire" title="Permalink to this definition">¶</a></dt>

  88. <dd><p>This event is called when a fire is detected.</p>

  89. </dd></dl>

  90. 

  91. <dl class="attribute">

  92. <dt id="alarmdecoder.decoder.AlarmDecoder.on_bypass">

  93. <tt class="descname">on_bypass</tt><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.on_bypass" title="Permalink to this definition">¶</a></dt>

  94. <dd><p>This event is called when a zone is bypassed.</p>

  95. </dd></dl>

  96. 

  97. <dl class="attribute">

  98. <dt id="alarmdecoder.decoder.AlarmDecoder.on_boot">

  99. <tt class="descname">on_boot</tt><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.on_boot" title="Permalink to this definition">¶</a></dt>

  100. <dd><p>This event is called when the device finishes booting.</p>

  101. </dd></dl>

  102. 

  103. <dl class="attribute">

  104. <dt id="alarmdecoder.decoder.AlarmDecoder.on_config_received">

  105. <tt class="descname">on_config_received</tt><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.on_config_received" title="Permalink to this definition">¶</a></dt>

  106. <dd><p>This event is called when the device receives its configuration.</p>

  107. </dd></dl>

  108. 

  109. <dl class="attribute">

  110. <dt id="alarmdecoder.decoder.AlarmDecoder.on_zone_fault">

  111. <tt class="descname">on_zone_fault</tt><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.on_zone_fault" title="Permalink to this definition">¶</a></dt>

  112. <dd><p>This event is called when <a class="reference internal" href="#alarmdecoder.zonetracking.Zonetracker" title="alarmdecoder.zonetracking.Zonetracker"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.zonetracking.Zonetracker</span></tt></a> detects a zone fault.</p>

  113. </dd></dl>

  114. 

  115. <dl class="attribute">

  116. <dt id="alarmdecoder.decoder.AlarmDecoder.on_zone_restore">

  117. <tt class="descname">on_zone_restore</tt><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.on_zone_restore" title="Permalink to this definition">¶</a></dt>

  118. <dd><p>This event is called when <a class="reference internal" href="#alarmdecoder.zonetracking.Zonetracker" title="alarmdecoder.zonetracking.Zonetracker"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.zonetracking.Zonetracker</span></tt></a> detects that a fault is restored.</p>

  119. </dd></dl>

  120. 

  121. <dl class="attribute">

  122. <dt id="alarmdecoder.decoder.AlarmDecoder.on_low_battery">

  123. <tt class="descname">on_low_battery</tt><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.on_low_battery" title="Permalink to this definition">¶</a></dt>

  124. <dd><p>This event is called when the device detects a low battery.</p>

  125. </dd></dl>

  126. 

  127. <dl class="attribute">

  128. <dt id="alarmdecoder.decoder.AlarmDecoder.on_panic">

  129. <tt class="descname">on_panic</tt><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.on_panic" title="Permalink to this definition">¶</a></dt>

  130. <dd><p>This event is called when the device detects a panic.</p>

  131. </dd></dl>

  132. 

  133. <dl class="attribute">

  134. <dt id="alarmdecoder.decoder.AlarmDecoder.on_relay_changed">

  135. <tt class="descname">on_relay_changed</tt><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.on_relay_changed" title="Permalink to this definition">¶</a></dt>

  136. <dd><p>This event is called when a relay is opened or closed on an expander board.</p>

  137. </dd></dl>

  138. 

  139. <dl class="attribute">

  140. <dt id="alarmdecoder.decoder.AlarmDecoder.on_message">

  141. <tt class="descname">on_message</tt><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.on_message" title="Permalink to this definition">¶</a></dt>

  142. <dd><p>This event is called when any message is received.</p>

  143. </dd></dl>

  144. 

  145. <dl class="attribute">

  146. <dt id="alarmdecoder.decoder.AlarmDecoder.on_lrr_message">

  147. <tt class="descname">on_lrr_message</tt><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.on_lrr_message" title="Permalink to this definition">¶</a></dt>

  148. <dd><p>This event is called when an <a class="reference internal" href="#alarmdecoder.messages.LRRMessage" title="alarmdecoder.messages.LRRMessage"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.messages.LRRMessage</span></tt></a> is received.</p>

  149. </dd></dl>

  150. 

  151. <dl class="attribute">

  152. <dt id="alarmdecoder.decoder.AlarmDecoder.on_rfx_message">

  153. <tt class="descname">on_rfx_message</tt><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.on_rfx_message" title="Permalink to this definition">¶</a></dt>

  154. <dd><p>This event is called when an <a class="reference internal" href="#alarmdecoder.messages.RFMessage" title="alarmdecoder.messages.RFMessage"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.messages.RFMessage</span></tt></a> is received.</p>

  155. </dd></dl>

  156. 

  157. <dl class="attribute">

  158. <dt id="alarmdecoder.decoder.AlarmDecoder.on_open">

  159. <tt class="descname">on_open</tt><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.on_open" title="Permalink to this definition">¶</a></dt>

  160. <dd><p>This event is called when the device has been opened.</p>

  161. </dd></dl>

  162. 

  163. <dl class="attribute">

  164. <dt id="alarmdecoder.decoder.AlarmDecoder.on_close">

  165. <tt class="descname">on_close</tt><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.on_close" title="Permalink to this definition">¶</a></dt>

  166. <dd><p>This event is called when the device has been closed.</p>

  167. </dd></dl>

  168. 

  169. <dl class="attribute">

  170. <dt id="alarmdecoder.decoder.AlarmDecoder.on_read">

  171. <tt class="descname">on_read</tt><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.on_read" title="Permalink to this definition">¶</a></dt>

  172. <dd><p>This event is called when a line has been read from the device.</p>

  173. </dd></dl>

  174. 

  175. <dl class="attribute">

  176. <dt id="alarmdecoder.decoder.AlarmDecoder.on_write">

  177. <tt class="descname">on_write</tt><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.on_write" title="Permalink to this definition">¶</a></dt>

  178. <dd><p>This event is called when data has been written to the device.</p>

  179. </dd></dl>

  180. 

  181. <dl class="attribute">

  182. <dt id="alarmdecoder.decoder.AlarmDecoder.KEY_F1">

  183. <tt class="descname">KEY_F1</tt><em class="property"> = u'\x01\x01\x01'</em><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.KEY_F1" title="Permalink to this definition">¶</a></dt>

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

  185. </dd></dl>

  186. 

  187. <dl class="attribute">

  188. <dt id="alarmdecoder.decoder.AlarmDecoder.KEY_F2">

  189. <tt class="descname">KEY_F2</tt><em class="property"> = u'\x02\x02\x02'</em><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.KEY_F2" title="Permalink to this definition">¶</a></dt>

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

  191. </dd></dl>

  192. 

  193. <dl class="attribute">

  194. <dt id="alarmdecoder.decoder.AlarmDecoder.KEY_F3">

  195. <tt class="descname">KEY_F3</tt><em class="property"> = u'\x03\x03\x03'</em><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.KEY_F3" title="Permalink to this definition">¶</a></dt>

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

  197. </dd></dl>

  198. 

  199. <dl class="attribute">

  200. <dt id="alarmdecoder.decoder.AlarmDecoder.KEY_F4">

  201. <tt class="descname">KEY_F4</tt><em class="property"> = u'\x04\x04\x04'</em><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.KEY_F4" title="Permalink to this definition">¶</a></dt>

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

  203. </dd></dl>

  204. 

  205. <dl class="attribute">

  206. <dt id="alarmdecoder.decoder.AlarmDecoder.BATTERY_TIMEOUT">

  207. <tt class="descname">BATTERY_TIMEOUT</tt><em class="property"> = 30</em><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.BATTERY_TIMEOUT" title="Permalink to this definition">¶</a></dt>

  208. <dd><p>Default timeout (in seconds) before the battery status reverts.</p>

  209. </dd></dl>

  210. 

  211. <dl class="attribute">

  212. <dt id="alarmdecoder.decoder.AlarmDecoder.FIRE_TIMEOUT">

  213. <tt class="descname">FIRE_TIMEOUT</tt><em class="property"> = 30</em><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.FIRE_TIMEOUT" title="Permalink to this definition">¶</a></dt>

  214. <dd><p>Default tTimeout (in seconds) before the fire status reverts.</p>

  215. </dd></dl>

  216. 

  217. <dl class="attribute">

  218. <dt id="alarmdecoder.decoder.AlarmDecoder.address">

  219. <tt class="descname">address</tt><em class="property"> = 18</em><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.address" title="Permalink to this definition">¶</a></dt>

  220. <dd><p>The keypad address in use by the device.</p>

  221. </dd></dl>

  222. 

  223. <dl class="attribute">

  224. <dt id="alarmdecoder.decoder.AlarmDecoder.configbits">

  225. <tt class="descname">configbits</tt><em class="property"> = 65280</em><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.configbits" title="Permalink to this definition">¶</a></dt>

  226. <dd><p>The configuration bits set on the device.</p>

  227. </dd></dl>

  228. 

  229. <dl class="attribute">

  230. <dt id="alarmdecoder.decoder.AlarmDecoder.address_mask">

  231. <tt class="descname">address_mask</tt><em class="property"> = 0</em><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.address_mask" title="Permalink to this definition">¶</a></dt>

  232. <dd><p>The address mask configured on the device.</p>

  233. </dd></dl>

  234. 

  235. <dl class="attribute">

  236. <dt id="alarmdecoder.decoder.AlarmDecoder.emulate_zone">

  237. <tt class="descname">emulate_zone</tt><em class="property"> = [False, False, False, False, False]</em><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.emulate_zone" title="Permalink to this definition">¶</a></dt>

  238. <dd><p>List containing the devices zone emulation status.</p>

  239. </dd></dl>

  240. 

  241. <dl class="attribute">

  242. <dt id="alarmdecoder.decoder.AlarmDecoder.emulate_relay">

  243. <tt class="descname">emulate_relay</tt><em class="property"> = [False, False, False, False]</em><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.emulate_relay" title="Permalink to this definition">¶</a></dt>

  244. <dd><p>List containing the devices relay emulation status.</p>

  245. </dd></dl>

  246. 

  247. <dl class="attribute">

  248. <dt id="alarmdecoder.decoder.AlarmDecoder.emulate_lrr">

  249. <tt class="descname">emulate_lrr</tt><em class="property"> = False</em><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.emulate_lrr" title="Permalink to this definition">¶</a></dt>

  250. <dd><p>The status of the devices LRR emulation.</p>

  251. </dd></dl>

  252. 

  253. <dl class="attribute">

  254. <dt id="alarmdecoder.decoder.AlarmDecoder.deduplicate">

  255. <tt class="descname">deduplicate</tt><em class="property"> = False</em><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.deduplicate" title="Permalink to this definition">¶</a></dt>

  256. <dd><p>The status of message deduplication as configured on the device.</p>

  257. </dd></dl>

  258. 

  259. <dl class="attribute">

  260. <dt id="alarmdecoder.decoder.AlarmDecoder.id">

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

  262. <dd><p>The ID of the <a class="reference external" href="http://www.alarmdecoder.com">Alarm Decoder</a> device.</p>

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

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

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

  266. <tbody valign="top">

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

  268. </tr>

  269. </tbody>

  270. </table>

  271. </dd></dl>

  272. 

  273. <dl class="attribute">

  274. <dt id="alarmdecoder.decoder.AlarmDecoder.battery_timeout">

  275. <tt class="descname">battery_timeout</tt><a class="reference internal" href="_modules/alarmdecoder/decoder.html#AlarmDecoder.battery_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.battery_timeout" title="Permalink to this definition">¶</a></dt>

  276. <dd><p>Retrieves the timeout for restoring the battery status, in seconds.</p>

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

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

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

  280. <tbody valign="top">

  281. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">battery status timeout</td>

  282. </tr>

  283. </tbody>

  284. </table>

  285. </dd></dl>

  286. 

  287. <dl class="attribute">

  288. <dt id="alarmdecoder.decoder.AlarmDecoder.fire_timeout">

  289. <tt class="descname">fire_timeout</tt><a class="reference internal" href="_modules/alarmdecoder/decoder.html#AlarmDecoder.fire_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.fire_timeout" title="Permalink to this definition">¶</a></dt>

  290. <dd><p>Retrieves the timeout for restoring the fire status, in seconds.</p>

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

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

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

  294. <tbody valign="top">

  295. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">fire status timeout</td>

  296. </tr>

  297. </tbody>

  298. </table>

  299. </dd></dl>

  300. 

  301. <dl class="method">

  302. <dt id="alarmdecoder.decoder.AlarmDecoder.open">

  303. <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/alarmdecoder/decoder.html#AlarmDecoder.open"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.open" title="Permalink to this definition">¶</a></dt>

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

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

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

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

  308. <tbody valign="top">

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

  310. <li><strong>baudrate</strong> (<em>int</em>) &#8211; baudrate used for the device.  Defaults to the lower-level device default.</li>

  311. <li><strong>no_reader_thread</strong> (<em>bool</em>) &#8211; Specifies whether or not the automatic reader

  312. thread should be started.</li>

  313. </ul>

  314. </td>

  315. </tr>

  316. </tbody>

  317. </table>

  318. </dd></dl>

  319. 

  320. <dl class="method">

  321. <dt id="alarmdecoder.decoder.AlarmDecoder.close">

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

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

  324. </dd></dl>

  325. 

  326. <dl class="method">

  327. <dt id="alarmdecoder.decoder.AlarmDecoder.send">

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

  329. <dd><p>Sends data to the <a class="reference external" href="http://www.alarmdecoder.com">Alarm Decoder</a> device.</p>

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

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

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

  333. <tbody valign="top">

  334. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<em>string</em>) &#8211; data to send</td>

  335. </tr>

  336. </tbody>

  337. </table>

  338. </dd></dl>

  339. 

  340. <dl class="method">

  341. <dt id="alarmdecoder.decoder.AlarmDecoder.get_config">

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

  343. <dd><p>Retrieves the configuration from the device.  Called automatically by <tt class="xref py py-meth docutils literal"><span class="pre">_on_open()</span></tt>.</p>

  344. </dd></dl>

  345. 

  346. <dl class="method">

  347. <dt id="alarmdecoder.decoder.AlarmDecoder.save_config">

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

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

  350. </dd></dl>

  351. 

  352. <dl class="method">

  353. <dt id="alarmdecoder.decoder.AlarmDecoder.reboot">

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

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

  356. </dd></dl>

  357. 

  358. <dl class="method">

  359. <dt id="alarmdecoder.decoder.AlarmDecoder.fault_zone">

  360. <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/alarmdecoder/decoder.html#AlarmDecoder.fault_zone"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.fault_zone" title="Permalink to this definition">¶</a></dt>

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

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

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

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

  365. <tbody valign="top">

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

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

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

  369. </ul>

  370. </td>

  371. </tr>

  372. </tbody>

  373. </table>

  374. </dd></dl>

  375. 

  376. <dl class="method">

  377. <dt id="alarmdecoder.decoder.AlarmDecoder.clear_zone">

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

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

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

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

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

  383. <tbody valign="top">

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

  385. </tr>

  386. </tbody>

  387. </table>

  388. </dd></dl>

  389. 

  390. </dd></dl>

  391. 

  392. </div>

  393. <div class="section" id="module-alarmdecoder.devices">

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

  395. <p>This module contains different types of devices belonging to the <a class="reference external" href="http://www.alarmdecoder.com">Alarm Decoder</a> (AD2) family.</p>

  396. <ul class="simple">

  397. <li><a class="reference internal" href="#alarmdecoder.devices.USBDevice" title="alarmdecoder.devices.USBDevice"><tt class="xref py py-class docutils literal"><span class="pre">USBDevice</span></tt></a>: Interfaces with the <a class="reference external" href="http://www.alarmdecoder.com">AD2USB</a> device.</li>

  398. <li><a class="reference internal" href="#alarmdecoder.devices.SerialDevice" title="alarmdecoder.devices.SerialDevice"><tt class="xref py py-class docutils literal"><span class="pre">SerialDevice</span></tt></a>: Interfaces with the <a class="reference external" href="http://www.alarmdecoder.com">AD2USB</a>, <a class="reference external" href="http://www.alarmdecoder.com">AD2SERIAL</a> or <a class="reference external" href="http://www.alarmdecoder.com">AD2PI</a>.</li>

  399. <li><a class="reference internal" href="#alarmdecoder.devices.SocketDevice" title="alarmdecoder.devices.SocketDevice"><tt class="xref py py-class docutils literal"><span class="pre">SocketDevice</span></tt></a>: Interfaces with devices exposed through <a class="reference external" href="http://github.com/nutechsoftware/ser2sock">ser2sock</a> or another IP to Serial solution.

  400. Also supports SSL if using <a class="reference external" href="http://github.com/nutechsoftware/ser2sock">ser2sock</a>.</li>

  401. </ul>

  402. <dl class="class">

  403. <dt id="alarmdecoder.devices.Device">

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

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

  406. <p>Base class for all <a class="reference external" href="http://www.alarmdecoder.com">Alarm Decoder</a> (AD2) device types.</p>

  407. <dl class="attribute">

  408. <dt id="alarmdecoder.devices.Device.on_open">

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

  410. <dd><p>This event is called when the device has been opened.</p>

  411. </dd></dl>

  412. 

  413. <dl class="attribute">

  414. <dt id="alarmdecoder.devices.Device.on_close">

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

  416. <dd><p>This event is called when the device has been closed.</p>

  417. </dd></dl>

  418. 

  419. <dl class="attribute">

  420. <dt id="alarmdecoder.devices.Device.on_read">

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

  422. <dd><p>This event is called when a line has been read from the device.</p>

  423. </dd></dl>

  424. 

  425. <dl class="attribute">

  426. <dt id="alarmdecoder.devices.Device.on_write">

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

  428. <dd><p>This event is called when data has been written to the device.</p>

  429. </dd></dl>

  430. 

  431. <dl class="attribute">

  432. <dt id="alarmdecoder.devices.Device.id">

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

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

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

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

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

  438. <tbody valign="top">

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

  440. </tr>

  441. </tbody>

  442. </table>

  443. </dd></dl>

  444. 

  445. <dl class="method">

  446. <dt id="alarmdecoder.devices.Device.is_reader_alive">

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

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

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

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

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

  452. <tbody valign="top">

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

  454. </tr>

  455. </tbody>

  456. </table>

  457. </dd></dl>

  458. 

  459. <dl class="method">

  460. <dt id="alarmdecoder.devices.Device.stop_reader">

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

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

  463. </dd></dl>

  464. 

  465. <dl class="method">

  466. <dt id="alarmdecoder.devices.Device.close">

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

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

  469. </dd></dl>

  470. 

  471. <dl class="class">

  472. <dt id="alarmdecoder.devices.Device.ReadThread">

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

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

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

  476. <dl class="attribute">

  477. <dt id="alarmdecoder.devices.Device.ReadThread.READ_TIMEOUT">

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

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

  480. </dd></dl>

  481. 

  482. <dl class="method">

  483. <dt id="alarmdecoder.devices.Device.ReadThread.stop">

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

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

  486. </dd></dl>

  487. 

  488. <dl class="method">

  489. <dt id="alarmdecoder.devices.Device.ReadThread.run">

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

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

  492. </dd></dl>

  493. 

  494. </dd></dl>

  495. 

  496. </dd></dl>

  497. 

  498. <dl class="class">

  499. <dt id="alarmdecoder.devices.USBDevice">

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

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

  502. <p><a class="reference external" href="http://www.alarmdecoder.com">AD2USB</a> device utilizing PyFTDI&#8217;s interface.</p>

  503. <dl class="attribute">

  504. <dt id="alarmdecoder.devices.USBDevice.FTDI_VENDOR_ID">

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

  506. <dd><p>Vendor ID used to recognize <a class="reference external" href="http://www.alarmdecoder.com">AD2USB</a> devices.</p>

  507. </dd></dl>

  508. 

  509. <dl class="attribute">

  510. <dt id="alarmdecoder.devices.USBDevice.FTDI_PRODUCT_ID">

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

  512. <dd><p>Product ID used to recognize <a class="reference external" href="http://www.alarmdecoder.com">AD2USB</a> devices.</p>

  513. </dd></dl>

  514. 

  515. <dl class="attribute">

  516. <dt id="alarmdecoder.devices.USBDevice.BAUDRATE">

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

  518. <dd><p>Default baudrate for <a class="reference external" href="http://www.alarmdecoder.com">AD2USB</a> devices.</p>

  519. </dd></dl>

  520. 

  521. <dl class="classmethod">

  522. <dt id="alarmdecoder.devices.USBDevice.find_all">

  523. <em class="property">classmethod </em><tt class="descname">find_all</tt><big>(</big><em>vid=1027</em>, <em>pid=24577</em><big>)</big><a class="reference internal" href="_modules/alarmdecoder/devices.html#USBDevice.find_all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.devices.USBDevice.find_all" title="Permalink to this definition">¶</a></dt>

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

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

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

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

  528. <tbody valign="top">

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

  530. </tr>

  531. <tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body"><a class="reference internal" href="#alarmdecoder.util.CommError" title="alarmdecoder.util.CommError"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.util.CommError</span></tt></a></td>

  532. </tr>

  533. </tbody>

  534. </table>

  535. </dd></dl>

  536. 

  537. <dl class="classmethod">

  538. <dt id="alarmdecoder.devices.USBDevice.devices">

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

  540. <dd><p>Returns a cached list of <a class="reference external" href="http://www.alarmdecoder.com">AD2USB</a> devices located on the system.</p>

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

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

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

  544. <tbody valign="top">

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

  546. </tr>

  547. </tbody>

  548. </table>

  549. </dd></dl>

  550. 

  551. <dl class="classmethod">

  552. <dt id="alarmdecoder.devices.USBDevice.find">

  553. <em class="property">classmethod </em><tt class="descname">find</tt><big>(</big><em>device=None</em><big>)</big><a class="reference internal" href="_modules/alarmdecoder/devices.html#USBDevice.find"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.devices.USBDevice.find" title="Permalink to this definition">¶</a></dt>

  554. <dd><p>Factory method that returns the requested <a class="reference internal" href="#alarmdecoder.devices.USBDevice" title="alarmdecoder.devices.USBDevice"><tt class="xref py py-class docutils literal"><span class="pre">USBDevice</span></tt></a> device, or the

  555. first device.</p>

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

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

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

  559. <tbody valign="top">

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

  561. by find_all().</td>

  562. </tr>

  563. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><a class="reference internal" href="#alarmdecoder.devices.USBDevice" title="alarmdecoder.devices.USBDevice"><tt class="xref py py-class docutils literal"><span class="pre">USBDevice</span></tt></a> object utilizing the specified device</td>

  564. </tr>

  565. <tr class="field-odd field"><th class="field-name">Raises :</th><td class="field-body"><a class="reference internal" href="#alarmdecoder.util.NoDeviceError" title="alarmdecoder.util.NoDeviceError"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.util.NoDeviceError</span></tt></a></td>

  566. </tr>

  567. </tbody>

  568. </table>

  569. </dd></dl>

  570. 

  571. <dl class="classmethod">

  572. <dt id="alarmdecoder.devices.USBDevice.start_detection">

  573. <em class="property">classmethod </em><tt class="descname">start_detection</tt><big>(</big><em>on_attached=None</em>, <em>on_detached=None</em><big>)</big><a class="reference internal" href="_modules/alarmdecoder/devices.html#USBDevice.start_detection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.devices.USBDevice.start_detection" title="Permalink to this definition">¶</a></dt>

  574. <dd><p>Starts the device detection thread.</p>

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

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

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

  578. <tbody valign="top">

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

  580. <li><strong>on_attached</strong> (<em>function</em>) &#8211; function to be called when a device is attached</li>

  581. <li><strong>on_detached</strong> (<em>function</em>) &#8211; function to be called when a device is detached</li>

  582. </ul>

  583. </td>

  584. </tr>

  585. </tbody>

  586. </table>

  587. </dd></dl>

  588. 

  589. <dl class="classmethod">

  590. <dt id="alarmdecoder.devices.USBDevice.stop_detection">

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

  592. <dd><p>Stops the device detection thread.</p>

  593. </dd></dl>

  594. 

  595. <dl class="attribute">

  596. <dt id="alarmdecoder.devices.USBDevice.serial_number">

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

  598. <dd><p>Retrieves the serial number of the device.</p>

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

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

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

  602. <tbody valign="top">

  603. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">serial number of the device</td>

  604. </tr>

  605. </tbody>

  606. </table>

  607. </dd></dl>

  608. 

  609. <dl class="attribute">

  610. <dt id="alarmdecoder.devices.USBDevice.description">

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

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

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

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

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

  616. <tbody valign="top">

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

  618. </tr>

  619. </tbody>

  620. </table>

  621. </dd></dl>

  622. 

  623. <dl class="attribute">

  624. <dt id="alarmdecoder.devices.USBDevice.interface">

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

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

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

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

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

  630. <tbody valign="top">

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

  632. </tr>

  633. </tbody>

  634. </table>

  635. </dd></dl>

  636. 

  637. <dl class="method">

  638. <dt id="alarmdecoder.devices.USBDevice.open">

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

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

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

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

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

  644. <tbody valign="top">

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

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

  647. <li><strong>no_reader_thread</strong> (<em>bool</em>) &#8211; whether or not to automatically start the

  648. reader thread.</li>

  649. </ul>

  650. </td>

  651. </tr>

  652. <tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body"><p class="first last"><a class="reference internal" href="#alarmdecoder.util.NoDeviceError" title="alarmdecoder.util.NoDeviceError"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.util.NoDeviceError</span></tt></a></p>

  653. </td>

  654. </tr>

  655. </tbody>

  656. </table>

  657. </dd></dl>

  658. 

  659. <dl class="method">

  660. <dt id="alarmdecoder.devices.USBDevice.close">

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

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

  663. </dd></dl>

  664. 

  665. <dl class="method">

  666. <dt id="alarmdecoder.devices.USBDevice.write">

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

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

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

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

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

  672. <tbody valign="top">

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

  674. </tr>

  675. <tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body"><a class="reference internal" href="#alarmdecoder.util.CommError" title="alarmdecoder.util.CommError"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.util.CommError</span></tt></a></td>

  676. </tr>

  677. </tbody>

  678. </table>

  679. </dd></dl>

  680. 

  681. <dl class="method">

  682. <dt id="alarmdecoder.devices.USBDevice.read">

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

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

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

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

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

  688. <tbody valign="top">

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

  690. </tr>

  691. <tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body"><a class="reference internal" href="#alarmdecoder.util.CommError" title="alarmdecoder.util.CommError"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.util.CommError</span></tt></a></td>

  692. </tr>

  693. </tbody>

  694. </table>

  695. </dd></dl>

  696. 

  697. <dl class="method">

  698. <dt id="alarmdecoder.devices.USBDevice.read_line">

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

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

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

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

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

  704. <tbody valign="top">

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

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

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

  708. reading.</li>

  709. </ul>

  710. </td>

  711. </tr>

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

  713. </td>

  714. </tr>

  715. <tr class="field-odd field"><th class="field-name">Raises :</th><td class="field-body"><p class="first last"><a class="reference internal" href="#alarmdecoder.util.CommError" title="alarmdecoder.util.CommError"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.util.CommError</span></tt></a>, <a class="reference internal" href="#alarmdecoder.util.TimeoutError" title="alarmdecoder.util.TimeoutError"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.util.TimeoutError</span></tt></a></p>

  716. </td>

  717. </tr>

  718. </tbody>

  719. </table>

  720. </dd></dl>

  721. 

  722. <dl class="class">

  723. <dt id="alarmdecoder.devices.USBDevice.DetectThread">

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

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

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

  727. <dl class="attribute">

  728. <dt id="alarmdecoder.devices.USBDevice.DetectThread.on_attached">

  729. <tt class="descname">on_attached</tt><a class="headerlink" href="#alarmdecoder.devices.USBDevice.DetectThread.on_attached" title="Permalink to this definition">¶</a></dt>

  730. <dd><p>This event is called when an <a class="reference external" href="http://www.alarmdecoder.com">AD2USB</a> device has been detected.</p>

  731. </dd></dl>

  732. 

  733. <dl class="attribute">

  734. <dt id="alarmdecoder.devices.USBDevice.DetectThread.on_detached">

  735. <tt class="descname">on_detached</tt><a class="headerlink" href="#alarmdecoder.devices.USBDevice.DetectThread.on_detached" title="Permalink to this definition">¶</a></dt>

  736. <dd><p>This event is called when an <a class="reference external" href="http://www.alarmdecoder.com">AD2USB</a> device has been removed.</p>

  737. </dd></dl>

  738. 

  739. <dl class="method">

  740. <dt id="alarmdecoder.devices.USBDevice.DetectThread.stop">

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

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

  743. </dd></dl>

  744. 

  745. <dl class="method">

  746. <dt id="alarmdecoder.devices.USBDevice.DetectThread.run">

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

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

  749. </dd></dl>

  750. 

  751. </dd></dl>

  752. 

  753. </dd></dl>

  754. 

  755. <dl class="class">

  756. <dt id="alarmdecoder.devices.SerialDevice">

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

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

  759. <p><a class="reference external" href="http://www.alarmdecoder.com">AD2USB</a>, <a class="reference external" href="http://www.alarmdecoder.com">AD2SERIAL</a> or <a class="reference external" href="http://www.alarmdecoder.com">AD2PI</a> device utilizing the PySerial interface.</p>

  760. <dl class="attribute">

  761. <dt id="alarmdecoder.devices.SerialDevice.BAUDRATE">

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

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

  764. </dd></dl>

  765. 

  766. <dl class="staticmethod">

  767. <dt id="alarmdecoder.devices.SerialDevice.find_all">

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

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

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

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

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

  773. <tbody valign="top">

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

  775. </tr>

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

  777. </tr>

  778. <tr class="field-odd field"><th class="field-name">Raises :</th><td class="field-body"><a class="reference internal" href="#alarmdecoder.util.CommError" title="alarmdecoder.util.CommError"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.util.CommError</span></tt></a></td>

  779. </tr>

  780. </tbody>

  781. </table>

  782. </dd></dl>

  783. 

  784. <dl class="attribute">

  785. <dt id="alarmdecoder.devices.SerialDevice.interface">

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

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

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

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

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

  791. <tbody valign="top">

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

  793. </tr>

  794. </tbody>

  795. </table>

  796. </dd></dl>

  797. 

  798. <dl class="method">

  799. <dt id="alarmdecoder.devices.SerialDevice.open">

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

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

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

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

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

  805. <tbody valign="top">

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

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

  808. <li><strong>no_reader_thread</strong> (<em>bool</em>) &#8211; whether or not to automatically start the

  809. reader thread.</li>

  810. </ul>

  811. </td>

  812. </tr>

  813. <tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body"><p class="first last"><a class="reference internal" href="#alarmdecoder.util.NoDeviceError" title="alarmdecoder.util.NoDeviceError"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.util.NoDeviceError</span></tt></a></p>

  814. </td>

  815. </tr>

  816. </tbody>

  817. </table>

  818. </dd></dl>

  819. 

  820. <dl class="method">

  821. <dt id="alarmdecoder.devices.SerialDevice.close">

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

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

  824. </dd></dl>

  825. 

  826. <dl class="method">

  827. <dt id="alarmdecoder.devices.SerialDevice.write">

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

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

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

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

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

  833. <tbody valign="top">

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

  835. </tr>

  836. <tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body">py:class:<cite>alarmdecoder.util.CommError</cite></td>

  837. </tr>

  838. </tbody>

  839. </table>

  840. </dd></dl>

  841. 

  842. <dl class="method">

  843. <dt id="alarmdecoder.devices.SerialDevice.read">

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

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

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

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

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

  849. <tbody valign="top">

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

  851. </tr>

  852. <tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body"><a class="reference internal" href="#alarmdecoder.util.CommError" title="alarmdecoder.util.CommError"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.util.CommError</span></tt></a></td>

  853. </tr>

  854. </tbody>

  855. </table>

  856. </dd></dl>

  857. 

  858. <dl class="method">

  859. <dt id="alarmdecoder.devices.SerialDevice.read_line">

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

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

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

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

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

  865. <tbody valign="top">

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

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

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

  869. reading.</li>

  870. </ul>

  871. </td>

  872. </tr>

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

  874. </td>

  875. </tr>

  876. <tr class="field-odd field"><th class="field-name">Raises :</th><td class="field-body"><p class="first last"><a class="reference internal" href="#alarmdecoder.util.CommError" title="alarmdecoder.util.CommError"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.util.CommError</span></tt></a>, <a class="reference internal" href="#alarmdecoder.util.TimeoutError" title="alarmdecoder.util.TimeoutError"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.util.TimeoutError</span></tt></a></p>

  877. </td>

  878. </tr>

  879. </tbody>

  880. </table>

  881. </dd></dl>

  882. 

  883. </dd></dl>

  884. 

  885. <dl class="class">

  886. <dt id="alarmdecoder.devices.SocketDevice">

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

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

  889. <p>Device that supports communication with an <a class="reference external" href="http://www.alarmdecoder.com">Alarm Decoder</a> (AD2) that is

  890. exposed via <a class="reference external" href="http://github.com/nutechsoftware/ser2sock">ser2sock</a> or another Serial to IP interface.</p>

  891. <dl class="attribute">

  892. <dt id="alarmdecoder.devices.SocketDevice.interface">

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

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

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

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

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

  898. <tbody valign="top">

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

  900. </tr>

  901. </tbody>

  902. </table>

  903. </dd></dl>

  904. 

  905. <dl class="attribute">

  906. <dt id="alarmdecoder.devices.SocketDevice.ssl">

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

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

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

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

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

  912. <tbody valign="top">

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

  914. </tr>

  915. </tbody>

  916. </table>

  917. </dd></dl>

  918. 

  919. <dl class="attribute">

  920. <dt id="alarmdecoder.devices.SocketDevice.ssl_certificate">

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

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

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

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

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

  926. <tbody valign="top">

  927. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">path to the certificate path or <tt class="xref py py-class docutils literal"><span class="pre">OpenSSL.crypto.X509</span></tt></td>

  928. </tr>

  929. </tbody>

  930. </table>

  931. </dd></dl>

  932. 

  933. <dl class="attribute">

  934. <dt id="alarmdecoder.devices.SocketDevice.ssl_key">

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

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

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

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

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

  940. <tbody valign="top">

  941. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">jpath to the SSL key or <tt class="xref py py-class docutils literal"><span class="pre">OpenSSL.crypto.PKey</span></tt></td>

  942. </tr>

  943. </tbody>

  944. </table>

  945. </dd></dl>

  946. 

  947. <dl class="attribute">

  948. <dt id="alarmdecoder.devices.SocketDevice.ssl_ca">

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

  950. <dd><p>Retrieves the SSL Certificate Authority certificate used for

  951. authentication.</p>

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

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

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

  955. <tbody valign="top">

  956. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">path to the CA certificate or <tt class="xref py py-class docutils literal"><span class="pre">OpenSSL.crypto.X509</span></tt></td>

  957. </tr>

  958. </tbody>

  959. </table>

  960. </dd></dl>

  961. 

  962. <dl class="method">

  963. <dt id="alarmdecoder.devices.SocketDevice.open">

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

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

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

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

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

  969. <tbody valign="top">

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

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

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

  973. thread.</li>

  974. </ul>

  975. </td>

  976. </tr>

  977. <tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body"><p class="first last"><a class="reference internal" href="#alarmdecoder.util.NoDeviceError" title="alarmdecoder.util.NoDeviceError"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.util.NoDeviceError</span></tt></a>, <a class="reference internal" href="#alarmdecoder.util.CommError" title="alarmdecoder.util.CommError"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.util.CommError</span></tt></a></p>

  978. </td>

  979. </tr>

  980. </tbody>

  981. </table>

  982. </dd></dl>

  983. 

  984. <dl class="method">

  985. <dt id="alarmdecoder.devices.SocketDevice.close">

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

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

  988. </dd></dl>

  989. 

  990. <dl class="method">

  991. <dt id="alarmdecoder.devices.SocketDevice.write">

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

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

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

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

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

  997. <tbody valign="top">

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

  999. </tr>

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

  1001. </tr>

  1002. <tr class="field-odd field"><th class="field-name">Raises :</th><td class="field-body"><a class="reference internal" href="#alarmdecoder.util.CommError" title="alarmdecoder.util.CommError"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.util.CommError</span></tt></a></td>

  1003. </tr>

  1004. </tbody>

  1005. </table>

  1006. </dd></dl>

  1007. 

  1008. <dl class="method">

  1009. <dt id="alarmdecoder.devices.SocketDevice.read">

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

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

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

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

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

  1015. <tbody valign="top">

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

  1017. </tr>

  1018. <tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body"><a class="reference internal" href="#alarmdecoder.util.CommError" title="alarmdecoder.util.CommError"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.util.CommError</span></tt></a></td>

  1019. </tr>

  1020. </tbody>

  1021. </table>

  1022. </dd></dl>

  1023. 

  1024. <dl class="method">

  1025. <dt id="alarmdecoder.devices.SocketDevice.read_line">

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

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

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

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

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

  1031. <tbody valign="top">

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

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

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

  1035. reading.</li>

  1036. </ul>

  1037. </td>

  1038. </tr>

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

  1040. </td>

  1041. </tr>

  1042. <tr class="field-odd field"><th class="field-name">Raises :</th><td class="field-body"><p class="first last"><a class="reference internal" href="#alarmdecoder.util.CommError" title="alarmdecoder.util.CommError"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.util.CommError</span></tt></a>, <a class="reference internal" href="#alarmdecoder.util.TimeoutError" title="alarmdecoder.util.TimeoutError"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.util.TimeoutError</span></tt></a></p>

  1043. </td>

  1044. </tr>

  1045. </tbody>

  1046. </table>

  1047. </dd></dl>

  1048. 

  1049. </dd></dl>

  1050. 

  1051. </div>

  1052. <div class="section" id="module-alarmdecoder.messages">

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

  1054. <p>Message representations received from the panel through the <a class="reference external" href="http://www.alarmdecoder.com">Alarm Decoder</a> (AD2)

  1055. devices.</p>

  1056. <ul class="simple">

  1057. <li><a class="reference internal" href="#alarmdecoder.messages.Message" title="alarmdecoder.messages.Message"><tt class="xref py py-class docutils literal"><span class="pre">Message</span></tt></a>: The standard and most common message received from a panel.</li>

  1058. <li><a class="reference internal" href="#alarmdecoder.messages.ExpanderMessage" title="alarmdecoder.messages.ExpanderMessage"><tt class="xref py py-class docutils literal"><span class="pre">ExpanderMessage</span></tt></a>: Messages received from Relay or Zone expander modules.</li>

  1059. <li><a class="reference internal" href="#alarmdecoder.messages.RFMessage" title="alarmdecoder.messages.RFMessage"><tt class="xref py py-class docutils literal"><span class="pre">RFMessage</span></tt></a>: Message received from an RF receiver module.</li>

  1060. <li><a class="reference internal" href="#alarmdecoder.messages.LRRMessage" title="alarmdecoder.messages.LRRMessage"><tt class="xref py py-class docutils literal"><span class="pre">LRRMessage</span></tt></a>: Message received from a long-range radio module.</li>

  1061. </ul>

  1062. <dl class="class">

  1063. <dt id="alarmdecoder.messages.BaseMessage">

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

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

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

  1067. <dl class="attribute">

  1068. <dt id="alarmdecoder.messages.BaseMessage.raw">

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

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

  1071. </dd></dl>

  1072. 

  1073. </dd></dl>

  1074. 

  1075. <dl class="class">

  1076. <dt id="alarmdecoder.messages.Message">

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

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

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

  1080. <dl class="attribute">

  1081. <dt id="alarmdecoder.messages.Message.ready">

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

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

  1084. </dd></dl>

  1085. 

  1086. <dl class="attribute">

  1087. <dt id="alarmdecoder.messages.Message.armed_away">

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

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

  1090. </dd></dl>

  1091. 

  1092. <dl class="attribute">

  1093. <dt id="alarmdecoder.messages.Message.armed_home">

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

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

  1096. </dd></dl>

  1097. 

  1098. <dl class="attribute">

  1099. <dt id="alarmdecoder.messages.Message.backlight_on">

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

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

  1102. </dd></dl>

  1103. 

  1104. <dl class="attribute">

  1105. <dt id="alarmdecoder.messages.Message.programming_mode">

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

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

  1108. </dd></dl>

  1109. 

  1110. <dl class="attribute">

  1111. <dt id="alarmdecoder.messages.Message.beeps">

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

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

  1114. </dd></dl>

  1115. 

  1116. <dl class="attribute">

  1117. <dt id="alarmdecoder.messages.Message.zone_bypassed">

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

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

  1120. </dd></dl>

  1121. 

  1122. <dl class="attribute">

  1123. <dt id="alarmdecoder.messages.Message.ac_power">

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

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

  1126. </dd></dl>

  1127. 

  1128. <dl class="attribute">

  1129. <dt id="alarmdecoder.messages.Message.chime_on">

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

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

  1132. </dd></dl>

  1133. 

  1134. <dl class="attribute">

  1135. <dt id="alarmdecoder.messages.Message.alarm_event_occurred">

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

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

  1138. </dd></dl>

  1139. 

  1140. <dl class="attribute">

  1141. <dt id="alarmdecoder.messages.Message.alarm_sounding">

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

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

  1144. </dd></dl>

  1145. 

  1146. <dl class="attribute">

  1147. <dt id="alarmdecoder.messages.Message.battery_low">

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

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

  1150. </dd></dl>

  1151. 

  1152. <dl class="attribute">

  1153. <dt id="alarmdecoder.messages.Message.entry_delay_off">

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

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

  1156. </dd></dl>

  1157. 

  1158. <dl class="attribute">

  1159. <dt id="alarmdecoder.messages.Message.fire_alarm">

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

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

  1162. </dd></dl>

  1163. 

  1164. <dl class="attribute">

  1165. <dt id="alarmdecoder.messages.Message.check_zone">

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

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

  1168. </dd></dl>

  1169. 

  1170. <dl class="attribute">

  1171. <dt id="alarmdecoder.messages.Message.perimeter_only">

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

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

  1174. </dd></dl>

  1175. 

  1176. <dl class="attribute">

  1177. <dt id="alarmdecoder.messages.Message.numeric_code">

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

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

  1180. </dd></dl>

  1181. 

  1182. <dl class="attribute">

  1183. <dt id="alarmdecoder.messages.Message.text">

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

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

  1186. </dd></dl>

  1187. 

  1188. <dl class="attribute">

  1189. <dt id="alarmdecoder.messages.Message.cursor_location">

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

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

  1192. </dd></dl>

  1193. 

  1194. <dl class="attribute">

  1195. <dt id="alarmdecoder.messages.Message.mask">

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

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

  1198. </dd></dl>

  1199. 

  1200. <dl class="attribute">

  1201. <dt id="alarmdecoder.messages.Message.bitfield">

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

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

  1204. </dd></dl>

  1205. 

  1206. <dl class="attribute">

  1207. <dt id="alarmdecoder.messages.Message.panel_data">

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

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

  1210. </dd></dl>

  1211. 

  1212. </dd></dl>

  1213. 

  1214. <dl class="class">

  1215. <dt id="alarmdecoder.messages.ExpanderMessage">

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

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

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

  1219. <dl class="attribute">

  1220. <dt id="alarmdecoder.messages.ExpanderMessage.ZONE">

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

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

  1223. </dd></dl>

  1224. 

  1225. <dl class="attribute">

  1226. <dt id="alarmdecoder.messages.ExpanderMessage.RELAY">

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

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

  1229. </dd></dl>

  1230. 

  1231. <dl class="attribute">

  1232. <dt id="alarmdecoder.messages.ExpanderMessage.type">

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

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

  1235. </dd></dl>

  1236. 

  1237. <dl class="attribute">

  1238. <dt id="alarmdecoder.messages.ExpanderMessage.address">

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

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

  1241. </dd></dl>

  1242. 

  1243. <dl class="attribute">

  1244. <dt id="alarmdecoder.messages.ExpanderMessage.channel">

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

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

  1247. </dd></dl>

  1248. 

  1249. <dl class="attribute">

  1250. <dt id="alarmdecoder.messages.ExpanderMessage.value">

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

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

  1253. </dd></dl>

  1254. 

  1255. </dd></dl>

  1256. 

  1257. <dl class="class">

  1258. <dt id="alarmdecoder.messages.RFMessage">

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

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

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

  1262. <dl class="attribute">

  1263. <dt id="alarmdecoder.messages.RFMessage.serial_number">

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

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

  1266. </dd></dl>

  1267. 

  1268. <dl class="attribute">

  1269. <dt id="alarmdecoder.messages.RFMessage.value">

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

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

  1272. </dd></dl>

  1273. 

  1274. <dl class="attribute">

  1275. <dt id="alarmdecoder.messages.RFMessage.battery">

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

  1277. <dd><p>Low battery indication</p>

  1278. </dd></dl>

  1279. 

  1280. <dl class="attribute">

  1281. <dt id="alarmdecoder.messages.RFMessage.supervision">

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

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

  1284. </dd></dl>

  1285. 

  1286. <dl class="attribute">

  1287. <dt id="alarmdecoder.messages.RFMessage.loop">

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

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

  1290. </dd></dl>

  1291. 

  1292. </dd></dl>

  1293. 

  1294. <dl class="class">

  1295. <dt id="alarmdecoder.messages.LRRMessage">

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

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

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

  1299. <dl class="attribute">

  1300. <dt id="alarmdecoder.messages.LRRMessage.event_data">

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

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

  1303. </dd></dl>

  1304. 

  1305. <dl class="attribute">

  1306. <dt id="alarmdecoder.messages.LRRMessage.partition">

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

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

  1309. </dd></dl>

  1310. 

  1311. <dl class="attribute">

  1312. <dt id="alarmdecoder.messages.LRRMessage.event_type">

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

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

  1315. </dd></dl>

  1316. 

  1317. </dd></dl>

  1318. 

  1319. </div>

  1320. <div class="section" id="module-alarmdecoder.zonetracking">

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

  1322. <p>Provides zone tracking functionality for the <a class="reference external" href="http://www.alarmdecoder.com">Alarm Decoder</a> (AD2) device family.</p>

  1323. <dl class="class">

  1324. <dt id="alarmdecoder.zonetracking.Zone">

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

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

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

  1328. <dl class="attribute">

  1329. <dt id="alarmdecoder.zonetracking.Zone.CLEAR">

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

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

  1332. </dd></dl>

  1333. 

  1334. <dl class="attribute">

  1335. <dt id="alarmdecoder.zonetracking.Zone.FAULT">

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

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

  1338. </dd></dl>

  1339. 

  1340. <dl class="attribute">

  1341. <dt id="alarmdecoder.zonetracking.Zone.CHECK">

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

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

  1344. </dd></dl>

  1345. 

  1346. <dl class="attribute">

  1347. <dt id="alarmdecoder.zonetracking.Zone.STATUS">

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

  1349. <dd></dd></dl>

  1350. 

  1351. <dl class="attribute">

  1352. <dt id="alarmdecoder.zonetracking.Zone.zone">

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

  1354. <dd><p>Zone ID</p>

  1355. </dd></dl>

  1356. 

  1357. <dl class="attribute">

  1358. <dt id="alarmdecoder.zonetracking.Zone.name">

  1359. <tt class="descname">name</tt><em class="property"> = ''</em><a class="headerlink" href="#alarmdecoder.zonetracking.Zone.name" title="Permalink to this definition">¶</a></dt>

  1360. <dd><p>Zone name</p>

  1361. </dd></dl>

  1362. 

  1363. <dl class="attribute">

  1364. <dt id="alarmdecoder.zonetracking.Zone.status">

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

  1366. <dd><p>Zone status</p>

  1367. </dd></dl>

  1368. 

  1369. <dl class="attribute">

  1370. <dt id="alarmdecoder.zonetracking.Zone.timestamp">

  1371. <tt class="descname">timestamp</tt><em class="property"> = None</em><a class="headerlink" href="#alarmdecoder.zonetracking.Zone.timestamp" title="Permalink to this definition">¶</a></dt>

  1372. <dd><p>Timestamp of last update</p>

  1373. </dd></dl>

  1374. 

  1375. </dd></dl>

  1376. 

  1377. <dl class="class">

  1378. <dt id="alarmdecoder.zonetracking.Zonetracker">

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

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

  1381. <p>Handles tracking of zones and their statuses.</p>

  1382. <dl class="attribute">

  1383. <dt id="alarmdecoder.zonetracking.Zonetracker.on_fault">

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

  1385. <dd><p>This event is called when the device detects a zone fault.</p>

  1386. </dd></dl>

  1387. 

  1388. <dl class="attribute">

  1389. <dt id="alarmdecoder.zonetracking.Zonetracker.on_restore">

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

  1391. <dd><p>This event is called when the device detects that a fault is restored.</p>

  1392. </dd></dl>

  1393. 

  1394. <dl class="attribute">

  1395. <dt id="alarmdecoder.zonetracking.Zonetracker.EXPIRE">

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

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

  1398. </dd></dl>

  1399. 

  1400. <dl class="attribute">

  1401. <dt id="alarmdecoder.zonetracking.Zonetracker.zones">

  1402. <tt class="descname">zones</tt><a class="headerlink" href="#alarmdecoder.zonetracking.Zonetracker.zones" title="Permalink to this definition">¶</a></dt>

  1403. <dd><p>Returns the current list of zones being tracked.</p>

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

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

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

  1407. <tbody valign="top">

  1408. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">dictionary of <a class="reference internal" href="#alarmdecoder.zonetracking.Zone" title="alarmdecoder.zonetracking.Zone"><tt class="xref py py-class docutils literal"><span class="pre">Zone</span></tt></a> being tracked</td>

  1409. </tr>

  1410. </tbody>

  1411. </table>

  1412. </dd></dl>

  1413. 

  1414. <dl class="attribute">

  1415. <dt id="alarmdecoder.zonetracking.Zonetracker.faulted">

  1416. <tt class="descname">faulted</tt><a class="headerlink" href="#alarmdecoder.zonetracking.Zonetracker.faulted" title="Permalink to this definition">¶</a></dt>

  1417. <dd><p>Retrieves the current list of faulted zones.</p>

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

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

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

  1421. <tbody valign="top">

  1422. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">list of faulted zones</td>

  1423. </tr>

  1424. </tbody>

  1425. </table>

  1426. </dd></dl>

  1427. 

  1428. <dl class="method">

  1429. <dt id="alarmdecoder.zonetracking.Zonetracker.update">

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

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

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

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

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

  1435. <tbody valign="top">

  1436. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>message</strong> (<a class="reference internal" href="#alarmdecoder.messages.Message" title="alarmdecoder.messages.Message"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.messages.Message</span></tt></a> or <a class="reference internal" href="#alarmdecoder.messages.ExpanderMessage" title="alarmdecoder.messages.ExpanderMessage"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.messages.ExpanderMessage</span></tt></a>) &#8211; message to use to update the zone tracking</td>

  1437. </tr>

  1438. </tbody>

  1439. </table>

  1440. </dd></dl>

  1441. 

  1442. <dl class="method">

  1443. <dt id="alarmdecoder.zonetracking.Zonetracker.expander_to_zone">

  1444. <tt class="descname">expander_to_zone</tt><big>(</big><em>address</em>, <em>channel</em><big>)</big><a class="reference internal" href="_modules/alarmdecoder/zonetracking.html#Zonetracker.expander_to_zone"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.zonetracking.Zonetracker.expander_to_zone" title="Permalink to this definition">¶</a></dt>

  1445. <dd><p>Convert an address and channel into a zone number.</p>

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

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

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

  1449. <tbody valign="top">

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

  1451. <li><strong>address</strong> (<em>int</em>) &#8211; expander address</li>

  1452. <li><strong>channel</strong> (<em>int</em>) &#8211; channel</li>

  1453. </ul>

  1454. </td>

  1455. </tr>

  1456. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">zone number associated with an address and channel</p>

  1457. </td>

  1458. </tr>

  1459. </tbody>

  1460. </table>

  1461. </dd></dl>

  1462. 

  1463. </dd></dl>

  1464. 

  1465. </div>

  1466. <div class="section" id="module-alarmdecoder.util">

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

  1468. <p>Provides utility classes for the <a class="reference external" href="http://www.alarmdecoder.com">Alarm Decoder</a> (AD2) devices.</p>

  1469. <dl class="exception">

  1470. <dt id="alarmdecoder.util.NoDeviceError">

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

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

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

  1474. </dd></dl>

  1475. 

  1476. <dl class="exception">

  1477. <dt id="alarmdecoder.util.CommError">

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

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

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

  1481. </dd></dl>

  1482. 

  1483. <dl class="exception">

  1484. <dt id="alarmdecoder.util.TimeoutError">

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

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

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

  1488. </dd></dl>

  1489. 

  1490. <dl class="exception">

  1491. <dt id="alarmdecoder.util.InvalidMessageError">

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

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

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

  1495. </dd></dl>

  1496. 

  1497. <dl class="class">

  1498. <dt id="alarmdecoder.util.Firmware">

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

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

  1501. <p>Represents firmware for the Alarm Decoder devices.</p>

  1502. <dl class="attribute">

  1503. <dt id="alarmdecoder.util.Firmware.STAGE_START">

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

  1505. <dd></dd></dl>

  1506. 

  1507. <dl class="attribute">

  1508. <dt id="alarmdecoder.util.Firmware.STAGE_WAITING">

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

  1510. <dd></dd></dl>

  1511. 

  1512. <dl class="attribute">

  1513. <dt id="alarmdecoder.util.Firmware.STAGE_BOOT">

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

  1515. <dd></dd></dl>

  1516. 

  1517. <dl class="attribute">

  1518. <dt id="alarmdecoder.util.Firmware.STAGE_LOAD">

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

  1520. <dd></dd></dl>

  1521. 

  1522. <dl class="attribute">

  1523. <dt id="alarmdecoder.util.Firmware.STAGE_UPLOADING">

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

  1525. <dd></dd></dl>

  1526. 

  1527. <dl class="attribute">

  1528. <dt id="alarmdecoder.util.Firmware.STAGE_DONE">

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

  1530. <dd></dd></dl>

  1531. 

  1532. <dl class="staticmethod">

  1533. <dt id="alarmdecoder.util.Firmware.upload">

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

  1535. <dd><p>Uploads firmware to an <a class="reference external" href="http://www.alarmdecoder.com">Alarm Decoder</a> device.</p>

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

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

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

  1539. <tbody valign="top">

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

  1541. <li><strong>filename</strong> (<em>string</em>) &#8211; firmware filename</li>

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

  1543. </ul>

  1544. </td>

  1545. </tr>

  1546. <tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body"><p class="first last"><a class="reference internal" href="#alarmdecoder.util.NoDeviceError" title="alarmdecoder.util.NoDeviceError"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.util.NoDeviceError</span></tt></a>, <a class="reference internal" href="#alarmdecoder.util.TimeoutError" title="alarmdecoder.util.TimeoutError"><tt class="xref py py-class docutils literal"><span class="pre">alarmdecoder.util.TimeoutError</span></tt></a></p>

  1547. </td>

  1548. </tr>

  1549. </tbody>

  1550. </table>

  1551. </dd></dl>

  1552. 

  1553. </dd></dl>

  1554. 

  1555. </div>

  1556. <div class="section" id="module-alarmdecoder.panels">

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

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

  1559. </div>

  1560. </div>

  1561. 

  1562. 

  1563.           </div>

  1564.         </div>

  1565.       </div>

  1566.       <div class="sphinxsidebar">

  1567.         <div class="sphinxsidebarwrapper">

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

  1569.   <ul>

  1570. <li><a class="reference internal" href="#">alarmdecoder Package</a><ul>

  1571. <li><a class="reference internal" href="#module-alarmdecoder.decoder"><tt class="docutils literal"><span class="pre">alarmdecoder</span></tt> Module</a></li>

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

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

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

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

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

  1577. </ul>

  1578. </li>

  1579. </ul>

  1580. 

  1581.   <h4>Previous topic</h4>

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

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

  1584.   <h3>This Page</h3>

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

  1586.     <li><a href="_sources/alarmdecoder.txt"

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

  1588.   </ul>

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

  1590.   <h3>Quick search</h3>

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

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

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

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

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

  1596.     </form>

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

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

  1599.     </p>

  1600. </div>

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

  1602.         </div>

  1603.       </div>

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

  1605.     </div>

  1606.     <div class="related">

  1607.       <h3>Navigation</h3>

  1608.       <ul>

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

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

  1611.              >index</a></li>

  1612.         <li class="right" >

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

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

  1615.         <li class="right" >

  1616.           <a href="index.html" title="Welcome to alarmdecoder’s documentation!"

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

  1618.         <li><a href="index.html">alarmdecoder  documentation</a> &raquo;</li> 

  1619.       </ul>

  1620.     </div>

  1621.     <div class="footer">

  1622.         &copy; Copyright 2013, Nu Tech Software Solutions, Inc..

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

  1624.     </div>

  1625.   </body>

  1626. </html>