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

1725 lines
109 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_sending_received">

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

  183. <dd><p>This event is called when a !Sending.done message is received from the AlarmDecoder.</p>

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

  185. </dd></dl>

  186. 

  187. <dl class="attribute">

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

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

  190. <dd><p>This event is called when the device has been opened.</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_close">

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

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

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

  199. </dd></dl>

  200. 

  201. <dl class="attribute">

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

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

  204. <dd><p>This event is called when a line has been read from 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.on_write">

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

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

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

  213. </dd></dl>

  214. 

  215. <dl class="attribute">

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

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

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

  219. </dd></dl>

  220. 

  221. <dl class="attribute">

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

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

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

  225. </dd></dl>

  226. 

  227. <dl class="attribute">

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

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

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

  231. </dd></dl>

  232. 

  233. <dl class="attribute">

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

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

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

  237. </dd></dl>

  238. 

  239. <dl class="attribute">

  240. <dt id="alarmdecoder.decoder.AlarmDecoder.KEY_PANIC">

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

  242. <dd><p>Represents a panic keypress</p>

  243. </dd></dl>

  244. 

  245. <dl class="attribute">

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

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

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

  249. </dd></dl>

  250. 

  251. <dl class="attribute">

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

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

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

  255. </dd></dl>

  256. 

  257. <dl class="attribute">

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

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

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

  261. </dd></dl>

  262. 

  263. <dl class="attribute">

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

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

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

  267. </dd></dl>

  268. 

  269. <dl class="attribute">

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

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

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

  273. </dd></dl>

  274. 

  275. <dl class="attribute">

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

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

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

  279. </dd></dl>

  280. 

  281. <dl class="attribute">

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

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

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

  285. </dd></dl>

  286. 

  287. <dl class="attribute">

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

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

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

  291. </dd></dl>

  292. 

  293. <dl class="attribute">

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

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

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

  297. </dd></dl>

  298. 

  299. <dl class="attribute">

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

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

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

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

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

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

  306. <tbody valign="top">

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

  308. </tr>

  309. </tbody>

  310. </table>

  311. </dd></dl>

  312. 

  313. <dl class="attribute">

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

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

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

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

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

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

  320. <tbody valign="top">

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

  322. </tr>

  323. </tbody>

  324. </table>

  325. </dd></dl>

  326. 

  327. <dl class="attribute">

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

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

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

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

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

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

  334. <tbody valign="top">

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

  336. </tr>

  337. </tbody>

  338. </table>

  339. </dd></dl>

  340. 

  341. <dl class="method">

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

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

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

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

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

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

  348. <tbody valign="top">

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

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

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

  352. thread should be started.</li>

  353. </ul>

  354. </td>

  355. </tr>

  356. </tbody>

  357. </table>

  358. </dd></dl>

  359. 

  360. <dl class="method">

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

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

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

  364. </dd></dl>

  365. 

  366. <dl class="method">

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

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

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

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

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

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

  373. <tbody valign="top">

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

  375. </tr>

  376. </tbody>

  377. </table>

  378. </dd></dl>

  379. 

  380. <dl class="method">

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

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

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

  384. </dd></dl>

  385. 

  386. <dl class="method">

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

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

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

  390. </dd></dl>

  391. 

  392. <dl class="method">

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

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

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

  396. </dd></dl>

  397. 

  398. <dl class="method">

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

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

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

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

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

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

  405. <tbody valign="top">

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

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

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

  409. </ul>

  410. </td>

  411. </tr>

  412. </tbody>

  413. </table>

  414. </dd></dl>

  415. 

  416. <dl class="method">

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

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

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

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

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

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

  423. <tbody valign="top">

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

  425. </tr>

  426. </tbody>

  427. </table>

  428. </dd></dl>

  429. 

  430. </dd></dl>

  431. 

  432. </div>

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

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

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

  436. <ul class="simple">

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

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

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

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

  441. </ul>

  442. <dl class="class">

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

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

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

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

  447. <dl class="attribute">

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

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

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

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

  452. </dd></dl>

  453. 

  454. <dl class="attribute">

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

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

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

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

  459. </dd></dl>

  460. 

  461. <dl class="attribute">

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

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

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

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

  466. </dd></dl>

  467. 

  468. <dl class="attribute">

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

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

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

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

  473. </dd></dl>

  474. 

  475. <dl class="attribute">

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

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

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

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

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

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

  482. <tbody valign="top">

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

  484. </tr>

  485. </tbody>

  486. </table>

  487. </dd></dl>

  488. 

  489. <dl class="method">

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

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

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

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

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

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

  496. <tbody valign="top">

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

  498. </tr>

  499. </tbody>

  500. </table>

  501. </dd></dl>

  502. 

  503. <dl class="method">

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

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

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

  507. </dd></dl>

  508. 

  509. <dl class="method">

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

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

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

  513. </dd></dl>

  514. 

  515. <dl class="class">

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

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

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

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

  520. <dl class="attribute">

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

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

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

  524. </dd></dl>

  525. 

  526. <dl class="method">

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

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

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

  530. </dd></dl>

  531. 

  532. <dl class="method">

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

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

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

  536. </dd></dl>

  537. 

  538. </dd></dl>

  539. 

  540. </dd></dl>

  541. 

  542. <dl class="class">

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

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

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

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

  547. <dl class="attribute">

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

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

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

  551. </dd></dl>

  552. 

  553. <dl class="attribute">

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

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

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

  557. </dd></dl>

  558. 

  559. <dl class="attribute">

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

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

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

  563. </dd></dl>

  564. 

  565. <dl class="classmethod">

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

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

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

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

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

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

  572. <tbody valign="top">

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

  574. </tr>

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

  576. </tr>

  577. </tbody>

  578. </table>

  579. </dd></dl>

  580. 

  581. <dl class="classmethod">

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

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

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

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

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

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

  588. <tbody valign="top">

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

  590. </tr>

  591. </tbody>

  592. </table>

  593. </dd></dl>

  594. 

  595. <dl class="classmethod">

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

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

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

  599. first device.</p>

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

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

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

  603. <tbody valign="top">

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

  605. by find_all().</td>

  606. </tr>

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

  608. </tr>

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

  610. </tr>

  611. </tbody>

  612. </table>

  613. </dd></dl>

  614. 

  615. <dl class="classmethod">

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

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

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

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

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

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

  622. <tbody valign="top">

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

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

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

  626. </ul>

  627. </td>

  628. </tr>

  629. </tbody>

  630. </table>

  631. </dd></dl>

  632. 

  633. <dl class="classmethod">

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

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

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

  637. </dd></dl>

  638. 

  639. <dl class="attribute">

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

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

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

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

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

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

  646. <tbody valign="top">

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

  648. </tr>

  649. </tbody>

  650. </table>

  651. </dd></dl>

  652. 

  653. <dl class="attribute">

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

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

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

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

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

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

  660. <tbody valign="top">

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

  662. </tr>

  663. </tbody>

  664. </table>

  665. </dd></dl>

  666. 

  667. <dl class="attribute">

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

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

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

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

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

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

  674. <tbody valign="top">

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

  676. </tr>

  677. </tbody>

  678. </table>

  679. </dd></dl>

  680. 

  681. <dl class="method">

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

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

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

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

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

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

  688. <tbody valign="top">

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

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

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

  692. reader thread.</li>

  693. </ul>

  694. </td>

  695. </tr>

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

  697. </td>

  698. </tr>

  699. </tbody>

  700. </table>

  701. </dd></dl>

  702. 

  703. <dl class="method">

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

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

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

  707. </dd></dl>

  708. 

  709. <dl class="method">

  710. <dt id="alarmdecoder.devices.USBDevice.fileno">

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

  712. <dd></dd></dl>

  713. 

  714. <dl class="method">

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

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

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

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

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

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

  721. <tbody valign="top">

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

  723. </tr>

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

  725. </tr>

  726. </tbody>

  727. </table>

  728. </dd></dl>

  729. 

  730. <dl class="method">

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

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

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

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

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

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

  737. <tbody valign="top">

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

  739. </tr>

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

  741. </tr>

  742. </tbody>

  743. </table>

  744. </dd></dl>

  745. 

  746. <dl class="method">

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

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

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

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

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

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

  753. <tbody valign="top">

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

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

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

  757. reading.</li>

  758. </ul>

  759. </td>

  760. </tr>

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

  762. </td>

  763. </tr>

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

  765. </td>

  766. </tr>

  767. </tbody>

  768. </table>

  769. </dd></dl>

  770. 

  771. <dl class="class">

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

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

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

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

  776. <dl class="attribute">

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

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

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

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

  781. </dd></dl>

  782. 

  783. <dl class="attribute">

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

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

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

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

  788. </dd></dl>

  789. 

  790. <dl class="method">

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

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

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

  794. </dd></dl>

  795. 

  796. <dl class="method">

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

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

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

  800. </dd></dl>

  801. 

  802. </dd></dl>

  803. 

  804. </dd></dl>

  805. 

  806. <dl class="class">

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

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

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

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

  811. <dl class="attribute">

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

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

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

  815. </dd></dl>

  816. 

  817. <dl class="staticmethod">

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

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

  820. <dd><p>Returns all serial ports present.</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">Parameters:</th><td class="field-body"><strong>pattern</strong> (<em>string</em>) &#8211; pattern to search for when retrieving serial ports</td>

  826. </tr>

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

  828. </tr>

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

  830. </tr>

  831. </tbody>

  832. </table>

  833. </dd></dl>

  834. 

  835. <dl class="attribute">

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

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

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

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

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

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

  842. <tbody valign="top">

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

  844. </tr>

  845. </tbody>

  846. </table>

  847. </dd></dl>

  848. 

  849. <dl class="method">

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

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

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

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

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

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

  856. <tbody valign="top">

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

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

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

  860. reader thread.</li>

  861. </ul>

  862. </td>

  863. </tr>

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

  865. </td>

  866. </tr>

  867. </tbody>

  868. </table>

  869. </dd></dl>

  870. 

  871. <dl class="method">

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

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

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

  875. </dd></dl>

  876. 

  877. <dl class="method">

  878. <dt id="alarmdecoder.devices.SerialDevice.fileno">

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

  880. <dd></dd></dl>

  881. 

  882. <dl class="method">

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

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

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

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

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

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

  889. <tbody valign="top">

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

  891. </tr>

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

  893. </tr>

  894. </tbody>

  895. </table>

  896. </dd></dl>

  897. 

  898. <dl class="method">

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

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

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

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

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

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

  905. <tbody valign="top">

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

  907. </tr>

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

  909. </tr>

  910. </tbody>

  911. </table>

  912. </dd></dl>

  913. 

  914. <dl class="method">

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

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

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

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

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

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

  921. <tbody valign="top">

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

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

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

  925. reading.</li>

  926. </ul>

  927. </td>

  928. </tr>

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

  930. </td>

  931. </tr>

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

  933. </td>

  934. </tr>

  935. </tbody>

  936. </table>

  937. </dd></dl>

  938. 

  939. </dd></dl>

  940. 

  941. <dl class="class">

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

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

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

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

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

  947. <dl class="attribute">

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

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

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

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

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

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

  954. <tbody valign="top">

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

  956. </tr>

  957. </tbody>

  958. </table>

  959. </dd></dl>

  960. 

  961. <dl class="attribute">

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

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

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

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

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

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

  968. <tbody valign="top">

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

  970. </tr>

  971. </tbody>

  972. </table>

  973. </dd></dl>

  974. 

  975. <dl class="attribute">

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

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

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

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

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

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

  982. <tbody valign="top">

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

  984. </tr>

  985. </tbody>

  986. </table>

  987. </dd></dl>

  988. 

  989. <dl class="attribute">

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

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

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

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

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

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

  996. <tbody valign="top">

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

  998. </tr>

  999. </tbody>

  1000. </table>

  1001. </dd></dl>

  1002. 

  1003. <dl class="attribute">

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

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

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

  1007. authentication.</p>

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

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

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

  1011. <tbody valign="top">

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

  1013. </tr>

  1014. </tbody>

  1015. </table>

  1016. </dd></dl>

  1017. 

  1018. <dl class="method">

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

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

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

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

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

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

  1025. <tbody valign="top">

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

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

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

  1029. thread.</li>

  1030. </ul>

  1031. </td>

  1032. </tr>

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

  1034. </td>

  1035. </tr>

  1036. </tbody>

  1037. </table>

  1038. </dd></dl>

  1039. 

  1040. <dl class="method">

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

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

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

  1044. </dd></dl>

  1045. 

  1046. <dl class="method">

  1047. <dt id="alarmdecoder.devices.SocketDevice.fileno">

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

  1049. <dd></dd></dl>

  1050. 

  1051. <dl class="method">

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

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

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

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

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

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

  1058. <tbody valign="top">

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

  1060. </tr>

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

  1062. </tr>

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

  1064. </tr>

  1065. </tbody>

  1066. </table>

  1067. </dd></dl>

  1068. 

  1069. <dl class="method">

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

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

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

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

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

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

  1076. <tbody valign="top">

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

  1078. </tr>

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

  1080. </tr>

  1081. </tbody>

  1082. </table>

  1083. </dd></dl>

  1084. 

  1085. <dl class="method">

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

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

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

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

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

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

  1092. <tbody valign="top">

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

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

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

  1096. reading.</li>

  1097. </ul>

  1098. </td>

  1099. </tr>

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

  1101. </td>

  1102. </tr>

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

  1104. </td>

  1105. </tr>

  1106. </tbody>

  1107. </table>

  1108. </dd></dl>

  1109. 

  1110. </dd></dl>

  1111. 

  1112. </div>

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

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

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

  1116. devices.</p>

  1117. <ul class="simple">

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

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

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

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

  1122. </ul>

  1123. <dl class="class">

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

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

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

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

  1128. <dl class="attribute">

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

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

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

  1132. </dd></dl>

  1133. 

  1134. <dl class="attribute">

  1135. <dt id="alarmdecoder.messages.BaseMessage.timestamp">

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

  1137. <dd><p>The timestamp of the message</p>

  1138. </dd></dl>

  1139. 

  1140. <dl class="method">

  1141. <dt id="alarmdecoder.messages.BaseMessage.dict">

  1142. <tt class="descname">dict</tt><big>(</big><em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/alarmdecoder/messages.html#BaseMessage.dict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.messages.BaseMessage.dict" title="Permalink to this definition">¶</a></dt>

  1143. <dd><p>Dictionary representation.</p>

  1144. </dd></dl>

  1145. 

  1146. </dd></dl>

  1147. 

  1148. <dl class="class">

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

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

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

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

  1153. <dl class="attribute">

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

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

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

  1157. </dd></dl>

  1158. 

  1159. <dl class="attribute">

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

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

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

  1163. </dd></dl>

  1164. 

  1165. <dl class="attribute">

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

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

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

  1169. </dd></dl>

  1170. 

  1171. <dl class="attribute">

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

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

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

  1175. </dd></dl>

  1176. 

  1177. <dl class="attribute">

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

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

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

  1181. </dd></dl>

  1182. 

  1183. <dl class="attribute">

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

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

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

  1187. </dd></dl>

  1188. 

  1189. <dl class="attribute">

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

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

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

  1193. </dd></dl>

  1194. 

  1195. <dl class="attribute">

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

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

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

  1199. </dd></dl>

  1200. 

  1201. <dl class="attribute">

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

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

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

  1205. </dd></dl>

  1206. 

  1207. <dl class="attribute">

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

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

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

  1211. </dd></dl>

  1212. 

  1213. <dl class="attribute">

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

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

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

  1217. </dd></dl>

  1218. 

  1219. <dl class="attribute">

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

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

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

  1223. </dd></dl>

  1224. 

  1225. <dl class="attribute">

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

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

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

  1229. </dd></dl>

  1230. 

  1231. <dl class="attribute">

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

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

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

  1235. </dd></dl>

  1236. 

  1237. <dl class="attribute">

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

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

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

  1241. </dd></dl>

  1242. 

  1243. <dl class="attribute">

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

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

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

  1247. </dd></dl>

  1248. 

  1249. <dl class="attribute">

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

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

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

  1253. </dd></dl>

  1254. 

  1255. <dl class="attribute">

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

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

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

  1259. </dd></dl>

  1260. 

  1261. <dl class="attribute">

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

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

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

  1265. </dd></dl>

  1266. 

  1267. <dl class="attribute">

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

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

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

  1271. </dd></dl>

  1272. 

  1273. <dl class="attribute">

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

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

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

  1277. </dd></dl>

  1278. 

  1279. <dl class="attribute">

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

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

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

  1283. </dd></dl>

  1284. 

  1285. <dl class="method">

  1286. <dt id="alarmdecoder.messages.Message.dict">

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

  1288. <dd><p>Dictionary representation.</p>

  1289. </dd></dl>

  1290. 

  1291. </dd></dl>

  1292. 

  1293. <dl class="class">

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

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

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

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

  1298. <dl class="attribute">

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

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

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

  1302. </dd></dl>

  1303. 

  1304. <dl class="attribute">

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

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

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

  1308. </dd></dl>

  1309. 

  1310. <dl class="attribute">

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

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

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

  1314. </dd></dl>

  1315. 

  1316. <dl class="attribute">

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

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

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

  1320. </dd></dl>

  1321. 

  1322. <dl class="attribute">

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

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

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

  1326. </dd></dl>

  1327. 

  1328. <dl class="attribute">

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

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

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

  1332. </dd></dl>

  1333. 

  1334. <dl class="method">

  1335. <dt id="alarmdecoder.messages.ExpanderMessage.dict">

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

  1337. <dd><p>Dictionary representation.</p>

  1338. </dd></dl>

  1339. 

  1340. </dd></dl>

  1341. 

  1342. <dl class="class">

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

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

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

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

  1347. <dl class="attribute">

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

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

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

  1351. </dd></dl>

  1352. 

  1353. <dl class="attribute">

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

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

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

  1357. </dd></dl>

  1358. 

  1359. <dl class="attribute">

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

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

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

  1363. </dd></dl>

  1364. 

  1365. <dl class="attribute">

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

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

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

  1369. </dd></dl>

  1370. 

  1371. <dl class="attribute">

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

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

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

  1375. </dd></dl>

  1376. 

  1377. <dl class="method">

  1378. <dt id="alarmdecoder.messages.RFMessage.dict">

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

  1380. <dd><p>Dictionary representation.</p>

  1381. </dd></dl>

  1382. 

  1383. </dd></dl>

  1384. 

  1385. <dl class="class">

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

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

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

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

  1390. <dl class="attribute">

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

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

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

  1394. </dd></dl>

  1395. 

  1396. <dl class="attribute">

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

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

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

  1400. </dd></dl>

  1401. 

  1402. <dl class="attribute">

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

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

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

  1406. </dd></dl>

  1407. 

  1408. <dl class="method">

  1409. <dt id="alarmdecoder.messages.LRRMessage.dict">

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

  1411. <dd><p>Dictionary representation.</p>

  1412. </dd></dl>

  1413. 

  1414. </dd></dl>

  1415. 

  1416. </div>

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

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

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

  1420. <dl class="class">

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

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

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

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

  1425. <dl class="attribute">

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

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

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

  1429. </dd></dl>

  1430. 

  1431. <dl class="attribute">

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

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

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

  1435. </dd></dl>

  1436. 

  1437. <dl class="attribute">

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

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

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

  1441. </dd></dl>

  1442. 

  1443. <dl class="attribute">

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

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

  1446. <dd></dd></dl>

  1447. 

  1448. <dl class="attribute">

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

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

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

  1452. </dd></dl>

  1453. 

  1454. <dl class="attribute">

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

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

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

  1458. </dd></dl>

  1459. 

  1460. <dl class="attribute">

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

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

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

  1464. </dd></dl>

  1465. 

  1466. <dl class="attribute">

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

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

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

  1470. </dd></dl>

  1471. 

  1472. </dd></dl>

  1473. 

  1474. <dl class="class">

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

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

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

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

  1479. <dl class="attribute">

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

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

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

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

  1484. </dd></dl>

  1485. 

  1486. <dl class="attribute">

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

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

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

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

  1491. </dd></dl>

  1492. 

  1493. <dl class="attribute">

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

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

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

  1497. </dd></dl>

  1498. 

  1499. <dl class="attribute">

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

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

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

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

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

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

  1506. <tbody valign="top">

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

  1508. </tr>

  1509. </tbody>

  1510. </table>

  1511. </dd></dl>

  1512. 

  1513. <dl class="attribute">

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

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

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

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

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

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

  1520. <tbody valign="top">

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

  1522. </tr>

  1523. </tbody>

  1524. </table>

  1525. </dd></dl>

  1526. 

  1527. <dl class="method">

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

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

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

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

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

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

  1534. <tbody valign="top">

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

  1536. </tr>

  1537. </tbody>

  1538. </table>

  1539. </dd></dl>

  1540. 

  1541. <dl class="method">

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

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

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

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

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

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

  1548. <tbody valign="top">

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

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

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

  1552. </ul>

  1553. </td>

  1554. </tr>

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

  1556. </td>

  1557. </tr>

  1558. </tbody>

  1559. </table>

  1560. </dd></dl>

  1561. 

  1562. </dd></dl>

  1563. 

  1564. </div>

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

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

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

  1568. <dl class="exception">

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

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

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

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

  1573. </dd></dl>

  1574. 

  1575. <dl class="exception">

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

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

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

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

  1580. </dd></dl>

  1581. 

  1582. <dl class="exception">

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

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

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

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

  1587. </dd></dl>

  1588. 

  1589. <dl class="exception">

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

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

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

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

  1594. </dd></dl>

  1595. 

  1596. <dl class="class">

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

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

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

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

  1601. <dl class="attribute">

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

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

  1604. <dd></dd></dl>

  1605. 

  1606. <dl class="attribute">

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

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

  1609. <dd></dd></dl>

  1610. 

  1611. <dl class="attribute">

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

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

  1614. <dd></dd></dl>

  1615. 

  1616. <dl class="attribute">

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

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

  1619. <dd></dd></dl>

  1620. 

  1621. <dl class="attribute">

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

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

  1624. <dd></dd></dl>

  1625. 

  1626. <dl class="attribute">

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

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

  1629. <dd></dd></dl>

  1630. 

  1631. <dl class="staticmethod">

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

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

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

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

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

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

  1638. <tbody valign="top">

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

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

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

  1642. </ul>

  1643. </td>

  1644. </tr>

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

  1646. </td>

  1647. </tr>

  1648. </tbody>

  1649. </table>

  1650. </dd></dl>

  1651. 

  1652. </dd></dl>

  1653. 

  1654. </div>

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

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

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

  1658. </div>

  1659. </div>

  1660. 

  1661. 

  1662.           </div>

  1663.         </div>

  1664.       </div>

  1665.       <div class="sphinxsidebar">

  1666.         <div class="sphinxsidebarwrapper">

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

  1668.   <ul>

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

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

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

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

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

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

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

  1676. </ul>

  1677. </li>

  1678. </ul>

  1679. 

  1680.   <h4>Previous topic</h4>

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

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

  1683.   <h3>This Page</h3>

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

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

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

  1687.   </ul>

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

  1689.   <h3>Quick search</h3>

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

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

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

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

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

  1695.     </form>

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

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

  1698.     </p>

  1699. </div>

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

  1701.         </div>

  1702.       </div>

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

  1704.     </div>

  1705.     <div class="related">

  1706.       <h3>Navigation</h3>

  1707.       <ul>

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

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

  1710.              >index</a></li>

  1711.         <li class="right" >

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

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

  1714.         <li class="right" >

  1715.           <a href="index.html" title="Welcome to Alarm Decoder’s documentation!"

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

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

  1718.       </ul>

  1719.     </div>

  1720.     <div class="footer">

  1721.         &copy; Copyright 2013, Nu Tech Software Solutions, Inc..

  1722.       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.

  1723.     </div>

  1724.   </body>

  1725. </html>