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

1661 lines
104 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 Alarm Decoder’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 Alarm Decoder’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="decoder-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">decoder</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">AlarmDecoder</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. <p><strong>Callback definition:</strong> <em>def callback(device)</em></p>

  66. </dd></dl>

  67. 

  68. <dl class="attribute">

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

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

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

  72. <p><strong>Callback definition:</strong> <em>def callback(device)</em></p>

  73. </dd></dl>

  74. 

  75. <dl class="attribute">

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

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

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

  79. <p><strong>Callback definition:</strong> <em>def callback(device, status)</em></p>

  80. </dd></dl>

  81. 

  82. <dl class="attribute">

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

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

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

  86. <p><strong>Callback definition:</strong> <em>def callback(device, status)</em></p>

  87. </dd></dl>

  88. 

  89. <dl class="attribute">

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

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

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

  93. <p><strong>Callback definition:</strong> <em>def callback(device, status)</em></p>

  94. </dd></dl>

  95. 

  96. <dl class="attribute">

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

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

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

  100. <p><strong>Callback definition:</strong> <em>def callback(device, status)</em></p>

  101. </dd></dl>

  102. 

  103. <dl class="attribute">

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

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

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

  107. <p><strong>Callback definition:</strong> <em>def callback(device)</em></p>

  108. </dd></dl>

  109. 

  110. <dl class="attribute">

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

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

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

  114. <p><strong>Callback definition:</strong> <em>def callback(device)</em></p>

  115. </dd></dl>

  116. 

  117. <dl class="attribute">

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

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

  120. <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">Zonetracker</span></tt></a> detects a zone fault.</p>

  121. <p><strong>Callback definition:</strong> <em>def callback(device, zone)</em></p>

  122. </dd></dl>

  123. 

  124. <dl class="attribute">

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

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

  127. <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">Zonetracker</span></tt></a> detects that a fault is restored.</p>

  128. <p><strong>Callback definition:</strong> <em>def callback(device, zone)</em></p>

  129. </dd></dl>

  130. 

  131. <dl class="attribute">

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

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

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

  135. <p><strong>Callback definition:</strong> <em>def callback(device, status)</em></p>

  136. </dd></dl>

  137. 

  138. <dl class="attribute">

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

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

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

  142. <p><strong>Callback definition:</strong> <em>def callback(device, status)</em></p>

  143. </dd></dl>

  144. 

  145. <dl class="attribute">

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

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

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

  149. <p><strong>Callback definition:</strong> <em>def callback(device, message)</em></p>

  150. </dd></dl>

  151. 

  152. <dl class="attribute">

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

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

  155. <dd><p>This event is called when standard panel <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> is received.</p>

  156. <p><strong>Callback definition:</strong> <em>def callback(device, message)</em></p>

  157. </dd></dl>

  158. 

  159. <dl class="attribute">

  160. <dt id="alarmdecoder.decoder.AlarmDecoder.on_expander_message">

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

  162. <dd><p>This event is called when an <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> is received.</p>

  163. <p><strong>Callback definition:</strong> <em>def callback(device, message)</em></p>

  164. </dd></dl>

  165. 

  166. <dl class="attribute">

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

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

  169. <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">LRRMessage</span></tt></a> is received.</p>

  170. <p><strong>Callback definition:</strong> <em>def callback(device, message)</em></p>

  171. </dd></dl>

  172. 

  173. <dl class="attribute">

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

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

  176. <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">RFMessage</span></tt></a> is received.</p>

  177. <p><strong>Callback definition:</strong> <em>def callback(device, message)</em></p>

  178. </dd></dl>

  179. 

  180. <dl class="attribute">

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

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

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

  184. <p><strong>Callback definition:</strong> <em>def callback(device)</em></p>

  185. </dd></dl>

  186. 

  187. <dl class="attribute">

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

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

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

  191. <p><strong>Callback definition:</strong> <em>def callback(device)</em></p>

  192. </dd></dl>

  193. 

  194. <dl class="attribute">

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

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

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

  198. <p><strong>Callback definition:</strong> <em>def callback(device, data)</em></p>

  199. </dd></dl>

  200. 

  201. <dl class="attribute">

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

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

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

  205. <p><strong>Callback definition:</strong> <em>def callback(device, data)</em></p>

  206. </dd></dl>

  207. 

  208. <dl class="attribute">

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

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

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

  212. </dd></dl>

  213. 

  214. <dl class="attribute">

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

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

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

  218. </dd></dl>

  219. 

  220. <dl class="attribute">

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

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

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

  224. </dd></dl>

  225. 

  226. <dl class="attribute">

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

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

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

  230. </dd></dl>

  231. 

  232. <dl class="attribute">

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

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

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

  236. </dd></dl>

  237. 

  238. <dl class="attribute">

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

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

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

  242. </dd></dl>

  243. 

  244. <dl class="attribute">

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

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

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

  248. </dd></dl>

  249. 

  250. <dl class="attribute">

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

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

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

  254. </dd></dl>

  255. 

  256. <dl class="attribute">

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

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

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

  260. </dd></dl>

  261. 

  262. <dl class="attribute">

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

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

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

  266. </dd></dl>

  267. 

  268. <dl class="attribute">

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

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

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

  272. </dd></dl>

  273. 

  274. <dl class="attribute">

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

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

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

  278. </dd></dl>

  279. 

  280. <dl class="attribute">

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

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

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

  284. </dd></dl>

  285. 

  286. <dl class="attribute">

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

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

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

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

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

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

  293. <tbody valign="top">

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

  295. </tr>

  296. </tbody>

  297. </table>

  298. </dd></dl>

  299. 

  300. <dl class="attribute">

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

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

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

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

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

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

  307. <tbody valign="top">

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

  309. </tr>

  310. </tbody>

  311. </table>

  312. </dd></dl>

  313. 

  314. <dl class="attribute">

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

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

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

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

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

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

  321. <tbody valign="top">

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

  323. </tr>

  324. </tbody>

  325. </table>

  326. </dd></dl>

  327. 

  328. <dl class="method">

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

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

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

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

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

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

  335. <tbody valign="top">

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

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

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

  339. thread should be started.</li>

  340. </ul>

  341. </td>

  342. </tr>

  343. </tbody>

  344. </table>

  345. </dd></dl>

  346. 

  347. <dl class="method">

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

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

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

  351. </dd></dl>

  352. 

  353. <dl class="method">

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

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

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

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

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

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

  360. <tbody valign="top">

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

  362. </tr>

  363. </tbody>

  364. </table>

  365. </dd></dl>

  366. 

  367. <dl class="method">

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

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

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

  371. </dd></dl>

  372. 

  373. <dl class="method">

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

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

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

  377. </dd></dl>

  378. 

  379. <dl class="method">

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

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

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

  383. </dd></dl>

  384. 

  385. <dl class="method">

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

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

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

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

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

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

  392. <tbody valign="top">

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

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

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

  396. </ul>

  397. </td>

  398. </tr>

  399. </tbody>

  400. </table>

  401. </dd></dl>

  402. 

  403. <dl class="method">

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

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

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

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

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

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

  410. <tbody valign="top">

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

  412. </tr>

  413. </tbody>

  414. </table>

  415. </dd></dl>

  416. 

  417. </dd></dl>

  418. 

  419. </div>

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

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

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

  423. <ul class="simple">

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

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

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

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

  428. </ul>

  429. <dl class="class">

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

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

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

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

  434. <dl class="attribute">

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

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

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

  438. <p><strong>Callback definition:</strong> <em>def callback(device)</em></p>

  439. </dd></dl>

  440. 

  441. <dl class="attribute">

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

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

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

  445. <p><strong>Callback definition:</strong> def callback(device)*</p>

  446. </dd></dl>

  447. 

  448. <dl class="attribute">

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

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

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

  452. <p><strong>Callback definition:</strong> def callback(device, data)*</p>

  453. </dd></dl>

  454. 

  455. <dl class="attribute">

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

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

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

  459. <p><strong>Callback definition:</strong> def callback(device, data)*</p>

  460. </dd></dl>

  461. 

  462. <dl class="attribute">

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

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

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

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

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

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

  469. <tbody valign="top">

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

  471. </tr>

  472. </tbody>

  473. </table>

  474. </dd></dl>

  475. 

  476. <dl class="method">

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

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

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

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

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

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

  483. <tbody valign="top">

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

  485. </tr>

  486. </tbody>

  487. </table>

  488. </dd></dl>

  489. 

  490. <dl class="method">

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

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

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

  494. </dd></dl>

  495. 

  496. <dl class="method">

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

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

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

  500. </dd></dl>

  501. 

  502. <dl class="class">

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

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

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

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

  507. <dl class="attribute">

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

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

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

  511. </dd></dl>

  512. 

  513. <dl class="method">

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

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

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

  517. </dd></dl>

  518. 

  519. <dl class="method">

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

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

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

  523. </dd></dl>

  524. 

  525. </dd></dl>

  526. 

  527. </dd></dl>

  528. 

  529. <dl class="class">

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

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

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

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

  534. <dl class="attribute">

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

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

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

  538. </dd></dl>

  539. 

  540. <dl class="attribute">

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

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

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

  544. </dd></dl>

  545. 

  546. <dl class="attribute">

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

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

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

  550. </dd></dl>

  551. 

  552. <dl class="classmethod">

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

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

  555. <dd><p>Returns all FTDI devices matching our vendor and product IDs.</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">Returns:</th><td class="field-body">list of devices</td>

  561. </tr>

  562. <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">CommError</span></tt></a></td>

  563. </tr>

  564. </tbody>

  565. </table>

  566. </dd></dl>

  567. 

  568. <dl class="classmethod">

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

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

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

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

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

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

  575. <tbody valign="top">

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

  577. </tr>

  578. </tbody>

  579. </table>

  580. </dd></dl>

  581. 

  582. <dl class="classmethod">

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

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

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

  586. first device.</p>

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

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

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

  590. <tbody valign="top">

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

  592. by find_all().</td>

  593. </tr>

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

  595. </tr>

  596. <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">NoDeviceError</span></tt></a></td>

  597. </tr>

  598. </tbody>

  599. </table>

  600. </dd></dl>

  601. 

  602. <dl class="classmethod">

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

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

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

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

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

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

  609. <tbody valign="top">

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

  611. <li><strong>on_attached</strong> (<em>function</em>) &#8211; function to be called when a device is attached  <strong>Callback definition:</strong> <em>def callback(thread, device)</em></li>

  612. <li><strong>on_detached</strong> (<em>function</em>) &#8211; function to be called when a device is detached  <strong>Callback definition:</strong> <em>def callback(thread, device)</em></li>

  613. </ul>

  614. </td>

  615. </tr>

  616. </tbody>

  617. </table>

  618. </dd></dl>

  619. 

  620. <dl class="classmethod">

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

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

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

  624. </dd></dl>

  625. 

  626. <dl class="attribute">

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

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

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

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

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

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

  633. <tbody valign="top">

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

  635. </tr>

  636. </tbody>

  637. </table>

  638. </dd></dl>

  639. 

  640. <dl class="attribute">

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

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

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

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

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

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

  647. <tbody valign="top">

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

  649. </tr>

  650. </tbody>

  651. </table>

  652. </dd></dl>

  653. 

  654. <dl class="attribute">

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

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

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

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

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

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

  661. <tbody valign="top">

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

  663. </tr>

  664. </tbody>

  665. </table>

  666. </dd></dl>

  667. 

  668. <dl class="method">

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

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

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

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

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

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

  675. <tbody valign="top">

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

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

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

  679. reader thread.</li>

  680. </ul>

  681. </td>

  682. </tr>

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

  684. </td>

  685. </tr>

  686. </tbody>

  687. </table>

  688. </dd></dl>

  689. 

  690. <dl class="method">

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

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

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

  694. </dd></dl>

  695. 

  696. <dl class="method">

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

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

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

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

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

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

  703. <tbody valign="top">

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

  705. </tr>

  706. <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">CommError</span></tt></a></td>

  707. </tr>

  708. </tbody>

  709. </table>

  710. </dd></dl>

  711. 

  712. <dl class="method">

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

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

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

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

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

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

  719. <tbody valign="top">

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

  721. </tr>

  722. <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">CommError</span></tt></a></td>

  723. </tr>

  724. </tbody>

  725. </table>

  726. </dd></dl>

  727. 

  728. <dl class="method">

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

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

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

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

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

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

  735. <tbody valign="top">

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

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

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

  739. reading.</li>

  740. </ul>

  741. </td>

  742. </tr>

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

  744. </td>

  745. </tr>

  746. <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">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">TimeoutError</span></tt></a></p>

  747. </td>

  748. </tr>

  749. </tbody>

  750. </table>

  751. </dd></dl>

  752. 

  753. <dl class="class">

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

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

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

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

  758. <dl class="attribute">

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

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

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

  762. <p><strong>Callback definition:</strong> def callback(thread, device*</p>

  763. </dd></dl>

  764. 

  765. <dl class="attribute">

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

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

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

  769. <p><strong>Callback definition:</strong> def callback(thread, device*</p>

  770. </dd></dl>

  771. 

  772. <dl class="method">

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

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

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

  776. </dd></dl>

  777. 

  778. <dl class="method">

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

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

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

  782. </dd></dl>

  783. 

  784. </dd></dl>

  785. 

  786. </dd></dl>

  787. 

  788. <dl class="class">

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

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

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

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

  793. <dl class="attribute">

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

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

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

  797. </dd></dl>

  798. 

  799. <dl class="staticmethod">

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

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

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

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

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

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

  806. <tbody valign="top">

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

  808. </tr>

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

  810. </tr>

  811. <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">CommError</span></tt></a></td>

  812. </tr>

  813. </tbody>

  814. </table>

  815. </dd></dl>

  816. 

  817. <dl class="attribute">

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

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

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

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

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

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

  824. <tbody valign="top">

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

  826. </tr>

  827. </tbody>

  828. </table>

  829. </dd></dl>

  830. 

  831. <dl class="method">

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

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

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

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

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

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

  838. <tbody valign="top">

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

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

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

  842. reader thread.</li>

  843. </ul>

  844. </td>

  845. </tr>

  846. <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">NoDeviceError</span></tt></a></p>

  847. </td>

  848. </tr>

  849. </tbody>

  850. </table>

  851. </dd></dl>

  852. 

  853. <dl class="method">

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

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

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

  857. </dd></dl>

  858. 

  859. <dl class="method">

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

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

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

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

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

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

  866. <tbody valign="top">

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

  868. </tr>

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

  870. </tr>

  871. </tbody>

  872. </table>

  873. </dd></dl>

  874. 

  875. <dl class="method">

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

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

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

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

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

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

  882. <tbody valign="top">

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

  884. </tr>

  885. <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">CommError</span></tt></a></td>

  886. </tr>

  887. </tbody>

  888. </table>

  889. </dd></dl>

  890. 

  891. <dl class="method">

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

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

  894. <dd><p>Reads a line from 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">Parameters:</th><td class="field-body"><ul class="first simple">

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

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

  902. reading.</li>

  903. </ul>

  904. </td>

  905. </tr>

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

  907. </td>

  908. </tr>

  909. <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">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">TimeoutError</span></tt></a></p>

  910. </td>

  911. </tr>

  912. </tbody>

  913. </table>

  914. </dd></dl>

  915. 

  916. </dd></dl>

  917. 

  918. <dl class="class">

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

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

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

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

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

  924. <dl class="attribute">

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

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

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

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

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

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

  931. <tbody valign="top">

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

  933. </tr>

  934. </tbody>

  935. </table>

  936. </dd></dl>

  937. 

  938. <dl class="attribute">

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

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

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

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

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

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

  945. <tbody valign="top">

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

  947. </tr>

  948. </tbody>

  949. </table>

  950. </dd></dl>

  951. 

  952. <dl class="attribute">

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

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

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

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

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

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

  959. <tbody valign="top">

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

  961. </tr>

  962. </tbody>

  963. </table>

  964. </dd></dl>

  965. 

  966. <dl class="attribute">

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

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

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

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

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

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

  973. <tbody valign="top">

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

  975. </tr>

  976. </tbody>

  977. </table>

  978. </dd></dl>

  979. 

  980. <dl class="attribute">

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

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

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

  984. authentication.</p>

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

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

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

  988. <tbody valign="top">

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

  990. </tr>

  991. </tbody>

  992. </table>

  993. </dd></dl>

  994. 

  995. <dl class="method">

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

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

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

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

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

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

  1002. <tbody valign="top">

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

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

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

  1006. thread.</li>

  1007. </ul>

  1008. </td>

  1009. </tr>

  1010. <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">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">CommError</span></tt></a></p>

  1011. </td>

  1012. </tr>

  1013. </tbody>

  1014. </table>

  1015. </dd></dl>

  1016. 

  1017. <dl class="method">

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

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

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

  1021. </dd></dl>

  1022. 

  1023. <dl class="method">

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

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

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

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

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

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

  1030. <tbody valign="top">

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

  1032. </tr>

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

  1034. </tr>

  1035. <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">CommError</span></tt></a></td>

  1036. </tr>

  1037. </tbody>

  1038. </table>

  1039. </dd></dl>

  1040. 

  1041. <dl class="method">

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

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

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

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

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

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

  1048. <tbody valign="top">

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

  1050. </tr>

  1051. <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">CommError</span></tt></a></td>

  1052. </tr>

  1053. </tbody>

  1054. </table>

  1055. </dd></dl>

  1056. 

  1057. <dl class="method">

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

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

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

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

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

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

  1064. <tbody valign="top">

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

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

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

  1068. reading.</li>

  1069. </ul>

  1070. </td>

  1071. </tr>

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

  1073. </td>

  1074. </tr>

  1075. <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">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">TimeoutError</span></tt></a></p>

  1076. </td>

  1077. </tr>

  1078. </tbody>

  1079. </table>

  1080. </dd></dl>

  1081. 

  1082. </dd></dl>

  1083. 

  1084. </div>

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

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

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

  1088. devices.</p>

  1089. <ul class="simple">

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

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

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

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

  1094. </ul>

  1095. <dl class="class">

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

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

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

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

  1100. <dl class="attribute">

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

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

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

  1104. </dd></dl>

  1105. 

  1106. </dd></dl>

  1107. 

  1108. <dl class="class">

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

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

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

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

  1113. <dl class="attribute">

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

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

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

  1117. </dd></dl>

  1118. 

  1119. <dl class="attribute">

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

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

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

  1123. </dd></dl>

  1124. 

  1125. <dl class="attribute">

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

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

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

  1129. </dd></dl>

  1130. 

  1131. <dl class="attribute">

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

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

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

  1135. </dd></dl>

  1136. 

  1137. <dl class="attribute">

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

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

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

  1141. </dd></dl>

  1142. 

  1143. <dl class="attribute">

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

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

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

  1147. </dd></dl>

  1148. 

  1149. <dl class="attribute">

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

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

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

  1153. </dd></dl>

  1154. 

  1155. <dl class="attribute">

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

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

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

  1159. </dd></dl>

  1160. 

  1161. <dl class="attribute">

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

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

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

  1165. </dd></dl>

  1166. 

  1167. <dl class="attribute">

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

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

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

  1171. </dd></dl>

  1172. 

  1173. <dl class="attribute">

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

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

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

  1177. </dd></dl>

  1178. 

  1179. <dl class="attribute">

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

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

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

  1183. </dd></dl>

  1184. 

  1185. <dl class="attribute">

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

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

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

  1189. </dd></dl>

  1190. 

  1191. <dl class="attribute">

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

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

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

  1195. </dd></dl>

  1196. 

  1197. <dl class="attribute">

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

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

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

  1201. </dd></dl>

  1202. 

  1203. <dl class="attribute">

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

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

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

  1207. </dd></dl>

  1208. 

  1209. <dl class="attribute">

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

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

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

  1213. </dd></dl>

  1214. 

  1215. <dl class="attribute">

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

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

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

  1219. </dd></dl>

  1220. 

  1221. <dl class="attribute">

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

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

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

  1225. </dd></dl>

  1226. 

  1227. <dl class="attribute">

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

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

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

  1231. </dd></dl>

  1232. 

  1233. <dl class="attribute">

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

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

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

  1237. </dd></dl>

  1238. 

  1239. <dl class="attribute">

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

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

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

  1243. </dd></dl>

  1244. 

  1245. </dd></dl>

  1246. 

  1247. <dl class="class">

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

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

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

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

  1252. <dl class="attribute">

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

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

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

  1256. </dd></dl>

  1257. 

  1258. <dl class="attribute">

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

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

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

  1262. </dd></dl>

  1263. 

  1264. <dl class="attribute">

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

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

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

  1268. </dd></dl>

  1269. 

  1270. <dl class="attribute">

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

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

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

  1274. </dd></dl>

  1275. 

  1276. <dl class="attribute">

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

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

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

  1280. </dd></dl>

  1281. 

  1282. <dl class="attribute">

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

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

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

  1286. </dd></dl>

  1287. 

  1288. </dd></dl>

  1289. 

  1290. <dl class="class">

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

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

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

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

  1295. <dl class="attribute">

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

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

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

  1299. </dd></dl>

  1300. 

  1301. <dl class="attribute">

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

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

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

  1305. </dd></dl>

  1306. 

  1307. <dl class="attribute">

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

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

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

  1311. </dd></dl>

  1312. 

  1313. <dl class="attribute">

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

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

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

  1317. </dd></dl>

  1318. 

  1319. <dl class="attribute">

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

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

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

  1323. </dd></dl>

  1324. 

  1325. </dd></dl>

  1326. 

  1327. <dl class="class">

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

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

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

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

  1332. <dl class="attribute">

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

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

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

  1336. </dd></dl>

  1337. 

  1338. <dl class="attribute">

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

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

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

  1342. </dd></dl>

  1343. 

  1344. <dl class="attribute">

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

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

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

  1348. </dd></dl>

  1349. 

  1350. </dd></dl>

  1351. 

  1352. </div>

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

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

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

  1356. <dl class="class">

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

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

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

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

  1361. <dl class="attribute">

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

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

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

  1365. </dd></dl>

  1366. 

  1367. <dl class="attribute">

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

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

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

  1371. </dd></dl>

  1372. 

  1373. <dl class="attribute">

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

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

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

  1377. </dd></dl>

  1378. 

  1379. <dl class="attribute">

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

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

  1382. <dd></dd></dl>

  1383. 

  1384. <dl class="attribute">

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

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

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

  1388. </dd></dl>

  1389. 

  1390. <dl class="attribute">

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

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

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

  1394. </dd></dl>

  1395. 

  1396. <dl class="attribute">

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

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

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

  1400. </dd></dl>

  1401. 

  1402. <dl class="attribute">

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

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

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

  1406. </dd></dl>

  1407. 

  1408. </dd></dl>

  1409. 

  1410. <dl class="class">

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

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

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

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

  1415. <dl class="attribute">

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

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

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

  1419. <p><strong>Callback definition:</strong> <em>def callback(device, zone)</em></p>

  1420. </dd></dl>

  1421. 

  1422. <dl class="attribute">

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

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

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

  1426. <p><strong>Callback definition:</strong> <em>def callback(device, zone)</em></p>

  1427. </dd></dl>

  1428. 

  1429. <dl class="attribute">

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

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

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

  1433. </dd></dl>

  1434. 

  1435. <dl class="attribute">

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

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

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

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

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

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

  1442. <tbody valign="top">

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

  1444. </tr>

  1445. </tbody>

  1446. </table>

  1447. </dd></dl>

  1448. 

  1449. <dl class="attribute">

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

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

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

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

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

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

  1456. <tbody valign="top">

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

  1458. </tr>

  1459. </tbody>

  1460. </table>

  1461. </dd></dl>

  1462. 

  1463. <dl class="method">

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

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

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

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

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

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

  1470. <tbody valign="top">

  1471. <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">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">ExpanderMessage</span></tt></a>) &#8211; message to use to update the zone tracking</td>

  1472. </tr>

  1473. </tbody>

  1474. </table>

  1475. </dd></dl>

  1476. 

  1477. <dl class="method">

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

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

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

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

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

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

  1484. <tbody valign="top">

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

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

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

  1488. </ul>

  1489. </td>

  1490. </tr>

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

  1492. </td>

  1493. </tr>

  1494. </tbody>

  1495. </table>

  1496. </dd></dl>

  1497. 

  1498. </dd></dl>

  1499. 

  1500. </div>

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

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

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

  1504. <dl class="exception">

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

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

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

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

  1509. </dd></dl>

  1510. 

  1511. <dl class="exception">

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

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

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

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

  1516. </dd></dl>

  1517. 

  1518. <dl class="exception">

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

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

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

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

  1523. </dd></dl>

  1524. 

  1525. <dl class="exception">

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

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

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

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

  1530. </dd></dl>

  1531. 

  1532. <dl class="class">

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

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

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

  1536. <p>Represents firmware for the <a class="reference external" href="http://www.alarmdecoder.com">AlarmDecoder</a> devices.</p>

  1537. <dl class="attribute">

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

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

  1540. <dd></dd></dl>

  1541. 

  1542. <dl class="attribute">

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

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

  1545. <dd></dd></dl>

  1546. 

  1547. <dl class="attribute">

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

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

  1550. <dd></dd></dl>

  1551. 

  1552. <dl class="attribute">

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

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

  1555. <dd></dd></dl>

  1556. 

  1557. <dl class="attribute">

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

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

  1560. <dd></dd></dl>

  1561. 

  1562. <dl class="attribute">

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

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

  1565. <dd></dd></dl>

  1566. 

  1567. <dl class="staticmethod">

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

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

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

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

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

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

  1574. <tbody valign="top">

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

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

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

  1578. </ul>

  1579. </td>

  1580. </tr>

  1581. <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">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">TimeoutError</span></tt></a></p>

  1582. </td>

  1583. </tr>

  1584. </tbody>

  1585. </table>

  1586. </dd></dl>

  1587. 

  1588. </dd></dl>

  1589. 

  1590. </div>

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

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

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

  1594. </div>

  1595. </div>

  1596. 

  1597. 

  1598.           </div>

  1599.         </div>

  1600.       </div>

  1601.       <div class="sphinxsidebar">

  1602.         <div class="sphinxsidebarwrapper">

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

  1604.   <ul>

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

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

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

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

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

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

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

  1612. </ul>

  1613. </li>

  1614. </ul>

  1615. 

  1616.   <h4>Previous topic</h4>

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

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

  1619.   <h3>This Page</h3>

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

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

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

  1623.   </ul>

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

  1625.   <h3>Quick search</h3>

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

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

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

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

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

  1631.     </form>

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

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

  1634.     </p>

  1635. </div>

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

  1637.         </div>

  1638.       </div>

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

  1640.     </div>

  1641.     <div class="related">

  1642.       <h3>Navigation</h3>

  1643.       <ul>

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

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

  1646.              >index</a></li>

  1647.         <li class="right" >

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

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

  1650.         <li class="right" >

  1651.           <a href="index.html" title="Welcome to Alarm Decoder’s documentation!"

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

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

  1654.       </ul>

  1655.     </div>

  1656.     <div class="footer">

  1657.         &copy; Copyright 2013, Nu Tech Software Solutions, Inc..

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

  1659.     </div>

  1660.   </body>

  1661. </html>