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

1768 lines
112 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, zone)</em></p>

  87. </dd></dl>

  88. 

  89. <dl class="attribute">

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

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

  92. <dd><p>This event is called when the alarm stops sounding.</p>

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

  94. </dd></dl>

  95. 

  96. <dl class="attribute">

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

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

  99. <dd><p>This event is called when a fire is detected.</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_bypass">

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

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

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

  108. </dd></dl>

  109. 

  110. <dl class="attribute">

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

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

  113. <dd><p>This event is called when the device finishes booting.</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_config_received">

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

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

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

  122. </dd></dl>

  123. 

  124. <dl class="attribute">

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

  126. <tt class="descname">on_zone_fault</tt><a class="headerlink" href="#alarmdecoder.decoder.AlarmDecoder.on_zone_fault" 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 a zone fault.</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_zone_restore">

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

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

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

  136. </dd></dl>

  137. 

  138. <dl class="attribute">

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

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

  141. <dd><p>This event is called when the device detects a low battery.</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_panic">

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

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

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

  150. </dd></dl>

  151. 

  152. <dl class="attribute">

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

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

  155. <dd><p>This event is called when a relay is opened or closed on an expander board.</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_message">

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

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

  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_expander_message">

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

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

  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_lrr_message">

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

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

  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_rfx_message">

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

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

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

  185. </dd></dl>

  186. 

  187. <dl class="attribute">

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

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

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

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

  192. </dd></dl>

  193. 

  194. <dl class="attribute">

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

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

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

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

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

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

  206. </dd></dl>

  207. 

  208. <dl class="attribute">

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

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

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

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

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

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

  220. </dd></dl>

  221. 

  222. <dl class="attribute">

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

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

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

  226. </dd></dl>

  227. 

  228. <dl class="attribute">

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

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

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

  232. </dd></dl>

  233. 

  234. <dl class="attribute">

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

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

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

  238. </dd></dl>

  239. 

  240. <dl class="attribute">

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

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

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

  244. </dd></dl>

  245. 

  246. <dl class="attribute">

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

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

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

  250. </dd></dl>

  251. 

  252. <dl class="attribute">

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

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

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

  256. </dd></dl>

  257. 

  258. <dl class="attribute">

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

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

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

  262. </dd></dl>

  263. 

  264. <dl class="attribute">

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

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

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

  268. </dd></dl>

  269. 

  270. <dl class="attribute">

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

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

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

  274. </dd></dl>

  275. 

  276. <dl class="attribute">

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

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

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

  280. </dd></dl>

  281. 

  282. <dl class="attribute">

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

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

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

  286. </dd></dl>

  287. 

  288. <dl class="attribute">

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

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

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

  292. </dd></dl>

  293. 

  294. <dl class="attribute">

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

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

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

  298. </dd></dl>

  299. 

  300. <dl class="attribute">

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

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

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

  304. </dd></dl>

  305. 

  306. <dl class="attribute">

  307. <dt id="alarmdecoder.decoder.AlarmDecoder.mode">

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

  309. <dd><p>The panel mode that the AlarmDecoder is in.  Currently supports ADEMCO and DSC.</p>

  310. </dd></dl>

  311. 

  312. <dl class="attribute">

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

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

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

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

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

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

  319. <tbody valign="top">

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

  321. </tr>

  322. </tbody>

  323. </table>

  324. </dd></dl>

  325. 

  326. <dl class="attribute">

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

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

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

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

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

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

  333. <tbody valign="top">

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

  335. </tr>

  336. </tbody>

  337. </table>

  338. </dd></dl>

  339. 

  340. <dl class="attribute">

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

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

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

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

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

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

  347. <tbody valign="top">

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

  349. </tr>

  350. </tbody>

  351. </table>

  352. </dd></dl>

  353. 

  354. <dl class="method">

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

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

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

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

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

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

  361. <tbody valign="top">

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

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

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

  365. thread should be started.</li>

  366. </ul>

  367. </td>

  368. </tr>

  369. </tbody>

  370. </table>

  371. </dd></dl>

  372. 

  373. <dl class="method">

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

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

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

  377. </dd></dl>

  378. 

  379. <dl class="method">

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

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

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

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

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

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

  386. <tbody valign="top">

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

  388. </tr>

  389. </tbody>

  390. </table>

  391. </dd></dl>

  392. 

  393. <dl class="method">

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

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

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

  397. </dd></dl>

  398. 

  399. <dl class="method">

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

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

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

  403. </dd></dl>

  404. 

  405. <dl class="method">

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

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

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

  409. </dd></dl>

  410. 

  411. <dl class="method">

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

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

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

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

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

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

  418. <tbody valign="top">

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

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

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

  422. </ul>

  423. </td>

  424. </tr>

  425. </tbody>

  426. </table>

  427. </dd></dl>

  428. 

  429. <dl class="method">

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

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

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

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

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

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

  436. <tbody valign="top">

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

  438. </tr>

  439. </tbody>

  440. </table>

  441. </dd></dl>

  442. 

  443. </dd></dl>

  444. 

  445. </div>

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

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

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

  449. <ul class="simple">

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

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

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

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

  454. </ul>

  455. <dl class="class">

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

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

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

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

  460. <dl class="attribute">

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

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

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

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

  465. </dd></dl>

  466. 

  467. <dl class="attribute">

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

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

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

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

  472. </dd></dl>

  473. 

  474. <dl class="attribute">

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

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

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

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

  479. </dd></dl>

  480. 

  481. <dl class="attribute">

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

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

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

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

  486. </dd></dl>

  487. 

  488. <dl class="attribute">

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

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

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

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

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

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

  495. <tbody valign="top">

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

  497. </tr>

  498. </tbody>

  499. </table>

  500. </dd></dl>

  501. 

  502. <dl class="method">

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

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

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

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

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

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

  509. <tbody valign="top">

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

  511. </tr>

  512. </tbody>

  513. </table>

  514. </dd></dl>

  515. 

  516. <dl class="method">

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

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

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

  520. </dd></dl>

  521. 

  522. <dl class="method">

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

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

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

  526. </dd></dl>

  527. 

  528. <dl class="class">

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

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

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

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

  533. <dl class="attribute">

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

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

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

  537. </dd></dl>

  538. 

  539. <dl class="method">

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

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

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

  543. </dd></dl>

  544. 

  545. <dl class="method">

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

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

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

  549. </dd></dl>

  550. 

  551. </dd></dl>

  552. 

  553. </dd></dl>

  554. 

  555. <dl class="class">

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

  557. <em class="property">class </em><tt class="descclassname">alarmdecoder.devices.</tt><tt class="descname">USBDevice</tt><big>(</big><em>interface=0</em>, <em>vid=None</em>, <em>pid=None</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>

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

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

  560. <dl class="attribute">

  561. <dt id="alarmdecoder.devices.USBDevice.PRODUCT_IDS">

  562. <tt class="descname">PRODUCT_IDS</tt><em class="property"> = ((1027, 24577), (1027, 24597))</em><a class="headerlink" href="#alarmdecoder.devices.USBDevice.PRODUCT_IDS" title="Permalink to this definition">¶</a></dt>

  563. <dd><p>List of Vendor and Product IDs used to recognize <a class="reference external" href="http://www.alarmdecoder.com">AD2USB</a> devices.</p>

  564. </dd></dl>

  565. 

  566. <dl class="attribute">

  567. <dt id="alarmdecoder.devices.USBDevice.DEFAULT_VENDOR_ID">

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

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

  570. </dd></dl>

  571. 

  572. <dl class="attribute">

  573. <dt id="alarmdecoder.devices.USBDevice.DEFAULT_PRODUCT_ID">

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

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

  576. </dd></dl>

  577. 

  578. <dl class="attribute">

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

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

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

  582. </dd></dl>

  583. 

  584. <dl class="attribute">

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

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

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

  588. </dd></dl>

  589. 

  590. <dl class="attribute">

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

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

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

  594. </dd></dl>

  595. 

  596. <dl class="classmethod">

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

  598. <em class="property">classmethod </em><tt class="descname">find_all</tt><big>(</big><em>vid=None</em>, <em>pid=None</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>

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

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

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

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

  603. <tbody valign="top">

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

  605. </tr>

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

  607. </tr>

  608. </tbody>

  609. </table>

  610. </dd></dl>

  611. 

  612. <dl class="classmethod">

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

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

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

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

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

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

  619. <tbody valign="top">

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

  621. </tr>

  622. </tbody>

  623. </table>

  624. </dd></dl>

  625. 

  626. <dl class="classmethod">

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

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

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

  630. first device.</p>

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

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

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

  634. <tbody valign="top">

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

  636. by find_all().</td>

  637. </tr>

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

  639. </tr>

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

  641. </tr>

  642. </tbody>

  643. </table>

  644. </dd></dl>

  645. 

  646. <dl class="classmethod">

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

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

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

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

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

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

  653. <tbody valign="top">

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

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

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

  657. </ul>

  658. </td>

  659. </tr>

  660. </tbody>

  661. </table>

  662. </dd></dl>

  663. 

  664. <dl class="classmethod">

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

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

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

  668. </dd></dl>

  669. 

  670. <dl class="attribute">

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

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

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

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

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

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

  677. <tbody valign="top">

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

  679. </tr>

  680. </tbody>

  681. </table>

  682. </dd></dl>

  683. 

  684. <dl class="attribute">

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

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

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

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

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

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

  691. <tbody valign="top">

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

  693. </tr>

  694. </tbody>

  695. </table>

  696. </dd></dl>

  697. 

  698. <dl class="attribute">

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

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

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

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

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

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

  705. <tbody valign="top">

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

  707. </tr>

  708. </tbody>

  709. </table>

  710. </dd></dl>

  711. 

  712. <dl class="method">

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

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

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

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

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

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

  719. <tbody valign="top">

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

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

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

  723. reader thread.</li>

  724. </ul>

  725. </td>

  726. </tr>

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

  728. </td>

  729. </tr>

  730. </tbody>

  731. </table>

  732. </dd></dl>

  733. 

  734. <dl class="method">

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

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

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

  738. </dd></dl>

  739. 

  740. <dl class="method">

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

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

  743. <dd></dd></dl>

  744. 

  745. <dl class="method">

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

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

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

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

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

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

  752. <tbody valign="top">

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

  754. </tr>

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

  756. </tr>

  757. </tbody>

  758. </table>

  759. </dd></dl>

  760. 

  761. <dl class="method">

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

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

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

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

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

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

  768. <tbody valign="top">

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

  770. </tr>

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

  772. </tr>

  773. </tbody>

  774. </table>

  775. </dd></dl>

  776. 

  777. <dl class="method">

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

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

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

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

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

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

  784. <tbody valign="top">

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

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

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

  788. reading.</li>

  789. </ul>

  790. </td>

  791. </tr>

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

  793. </td>

  794. </tr>

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

  796. </td>

  797. </tr>

  798. </tbody>

  799. </table>

  800. </dd></dl>

  801. 

  802. <dl class="class">

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

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

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

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

  807. <dl class="attribute">

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

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

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

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

  812. </dd></dl>

  813. 

  814. <dl class="attribute">

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

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

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

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

  819. </dd></dl>

  820. 

  821. <dl class="method">

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

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

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

  825. </dd></dl>

  826. 

  827. <dl class="method">

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

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

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

  831. </dd></dl>

  832. 

  833. </dd></dl>

  834. 

  835. </dd></dl>

  836. 

  837. <dl class="class">

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

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

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

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

  842. <dl class="attribute">

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

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

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

  846. </dd></dl>

  847. 

  848. <dl class="staticmethod">

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

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

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

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

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

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

  855. <tbody valign="top">

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

  857. </tr>

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

  859. </tr>

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

  861. </tr>

  862. </tbody>

  863. </table>

  864. </dd></dl>

  865. 

  866. <dl class="attribute">

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

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

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

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

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

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

  873. <tbody valign="top">

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

  875. </tr>

  876. </tbody>

  877. </table>

  878. </dd></dl>

  879. 

  880. <dl class="method">

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

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

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

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

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

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

  887. <tbody valign="top">

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

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

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

  891. reader thread.</li>

  892. </ul>

  893. </td>

  894. </tr>

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

  896. </td>

  897. </tr>

  898. </tbody>

  899. </table>

  900. </dd></dl>

  901. 

  902. <dl class="method">

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

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

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

  906. </dd></dl>

  907. 

  908. <dl class="method">

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

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

  911. <dd></dd></dl>

  912. 

  913. <dl class="method">

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

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

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

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

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

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

  920. <tbody valign="top">

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

  922. </tr>

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

  924. </tr>

  925. </tbody>

  926. </table>

  927. </dd></dl>

  928. 

  929. <dl class="method">

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

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

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

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

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

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

  936. <tbody valign="top">

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

  938. </tr>

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

  940. </tr>

  941. </tbody>

  942. </table>

  943. </dd></dl>

  944. 

  945. <dl class="method">

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

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

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

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

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

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

  952. <tbody valign="top">

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

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

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

  956. reading.</li>

  957. </ul>

  958. </td>

  959. </tr>

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

  961. </td>

  962. </tr>

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

  964. </td>

  965. </tr>

  966. </tbody>

  967. </table>

  968. </dd></dl>

  969. 

  970. </dd></dl>

  971. 

  972. <dl class="class">

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

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

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

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

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

  978. <dl class="attribute">

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

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

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

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

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

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

  985. <tbody valign="top">

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

  987. </tr>

  988. </tbody>

  989. </table>

  990. </dd></dl>

  991. 

  992. <dl class="attribute">

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

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

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

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

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

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

  999. <tbody valign="top">

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

  1001. </tr>

  1002. </tbody>

  1003. </table>

  1004. </dd></dl>

  1005. 

  1006. <dl class="attribute">

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

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

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

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

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

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

  1013. <tbody valign="top">

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

  1015. </tr>

  1016. </tbody>

  1017. </table>

  1018. </dd></dl>

  1019. 

  1020. <dl class="attribute">

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

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

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

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

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

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

  1027. <tbody valign="top">

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

  1029. </tr>

  1030. </tbody>

  1031. </table>

  1032. </dd></dl>

  1033. 

  1034. <dl class="attribute">

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

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

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

  1038. authentication.</p>

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

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

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

  1042. <tbody valign="top">

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

  1044. </tr>

  1045. </tbody>

  1046. </table>

  1047. </dd></dl>

  1048. 

  1049. <dl class="method">

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

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

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

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

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

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

  1056. <tbody valign="top">

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

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

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

  1060. thread.</li>

  1061. </ul>

  1062. </td>

  1063. </tr>

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

  1065. </td>

  1066. </tr>

  1067. </tbody>

  1068. </table>

  1069. </dd></dl>

  1070. 

  1071. <dl class="method">

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

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

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

  1075. </dd></dl>

  1076. 

  1077. <dl class="method">

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

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

  1080. <dd></dd></dl>

  1081. 

  1082. <dl class="method">

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

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

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

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

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

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

  1089. <tbody valign="top">

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

  1091. </tr>

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

  1093. </tr>

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

  1095. </tr>

  1096. </tbody>

  1097. </table>

  1098. </dd></dl>

  1099. 

  1100. <dl class="method">

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

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

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

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

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

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

  1107. <tbody valign="top">

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

  1109. </tr>

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

  1111. </tr>

  1112. </tbody>

  1113. </table>

  1114. </dd></dl>

  1115. 

  1116. <dl class="method">

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

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

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

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

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

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

  1123. <tbody valign="top">

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

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

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

  1127. reading.</li>

  1128. </ul>

  1129. </td>

  1130. </tr>

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

  1132. </td>

  1133. </tr>

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

  1135. </td>

  1136. </tr>

  1137. </tbody>

  1138. </table>

  1139. </dd></dl>

  1140. 

  1141. </dd></dl>

  1142. 

  1143. </div>

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

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

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

  1147. devices.</p>

  1148. <ul class="simple">

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

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

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

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

  1153. </ul>

  1154. <dl class="class">

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

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

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

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

  1159. <dl class="attribute">

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

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

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

  1163. </dd></dl>

  1164. 

  1165. <dl class="attribute">

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

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

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

  1169. </dd></dl>

  1170. 

  1171. <dl class="method">

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

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

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

  1175. </dd></dl>

  1176. 

  1177. </dd></dl>

  1178. 

  1179. <dl class="class">

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

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

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

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

  1184. <dl class="attribute">

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

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

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

  1188. </dd></dl>

  1189. 

  1190. <dl class="attribute">

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

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

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

  1194. </dd></dl>

  1195. 

  1196. <dl class="attribute">

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

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

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

  1200. </dd></dl>

  1201. 

  1202. <dl class="attribute">

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

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

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

  1206. </dd></dl>

  1207. 

  1208. <dl class="attribute">

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

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

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

  1212. </dd></dl>

  1213. 

  1214. <dl class="attribute">

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

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

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

  1218. </dd></dl>

  1219. 

  1220. <dl class="attribute">

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

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

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

  1224. </dd></dl>

  1225. 

  1226. <dl class="attribute">

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

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

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

  1230. </dd></dl>

  1231. 

  1232. <dl class="attribute">

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

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

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

  1236. </dd></dl>

  1237. 

  1238. <dl class="attribute">

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

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

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

  1242. </dd></dl>

  1243. 

  1244. <dl class="attribute">

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

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

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

  1248. </dd></dl>

  1249. 

  1250. <dl class="attribute">

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

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

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

  1254. </dd></dl>

  1255. 

  1256. <dl class="attribute">

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

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

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

  1260. </dd></dl>

  1261. 

  1262. <dl class="attribute">

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

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

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

  1266. </dd></dl>

  1267. 

  1268. <dl class="attribute">

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

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

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

  1272. </dd></dl>

  1273. 

  1274. <dl class="attribute">

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

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

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

  1278. </dd></dl>

  1279. 

  1280. <dl class="attribute">

  1281. <dt id="alarmdecoder.messages.Message.system_fault">

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

  1283. <dd><p>Indicates whether a system fault has occurred.</p>

  1284. </dd></dl>

  1285. 

  1286. <dl class="attribute">

  1287. <dt id="alarmdecoder.messages.Message.panel_type">

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

  1289. <dd><p>Indicates which panel type was the source of this message.</p>

  1290. </dd></dl>

  1291. 

  1292. <dl class="attribute">

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

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

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

  1296. </dd></dl>

  1297. 

  1298. <dl class="attribute">

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

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

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

  1302. </dd></dl>

  1303. 

  1304. <dl class="attribute">

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

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

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

  1308. </dd></dl>

  1309. 

  1310. <dl class="attribute">

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

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

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

  1314. </dd></dl>

  1315. 

  1316. <dl class="attribute">

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

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

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

  1320. </dd></dl>

  1321. 

  1322. <dl class="attribute">

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

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

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

  1326. </dd></dl>

  1327. 

  1328. <dl class="method">

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

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

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

  1332. </dd></dl>

  1333. 

  1334. </dd></dl>

  1335. 

  1336. <dl class="class">

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

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

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

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

  1341. <dl class="attribute">

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

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

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

  1345. </dd></dl>

  1346. 

  1347. <dl class="attribute">

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

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

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

  1351. </dd></dl>

  1352. 

  1353. <dl class="attribute">

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

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

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

  1357. </dd></dl>

  1358. 

  1359. <dl class="attribute">

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

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

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

  1363. </dd></dl>

  1364. 

  1365. <dl class="attribute">

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

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

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

  1369. </dd></dl>

  1370. 

  1371. <dl class="attribute">

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

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

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

  1375. </dd></dl>

  1376. 

  1377. <dl class="method">

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

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

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

  1381. </dd></dl>

  1382. 

  1383. </dd></dl>

  1384. 

  1385. <dl class="class">

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

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

  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>Represents a message from an RF receiver.</p>

  1390. <dl class="attribute">

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

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

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

  1394. </dd></dl>

  1395. 

  1396. <dl class="attribute">

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

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

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

  1400. </dd></dl>

  1401. 

  1402. <dl class="attribute">

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

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

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

  1406. </dd></dl>

  1407. 

  1408. <dl class="attribute">

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

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

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

  1412. </dd></dl>

  1413. 

  1414. <dl class="attribute">

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

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

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

  1418. </dd></dl>

  1419. 

  1420. <dl class="method">

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

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

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

  1424. </dd></dl>

  1425. 

  1426. </dd></dl>

  1427. 

  1428. <dl class="class">

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

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

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

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

  1433. <dl class="attribute">

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

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

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

  1437. </dd></dl>

  1438. 

  1439. <dl class="attribute">

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

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

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

  1443. </dd></dl>

  1444. 

  1445. <dl class="attribute">

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

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

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

  1449. </dd></dl>

  1450. 

  1451. <dl class="method">

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

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

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

  1455. </dd></dl>

  1456. 

  1457. </dd></dl>

  1458. 

  1459. </div>

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

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

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

  1463. <dl class="class">

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

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

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

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

  1468. <dl class="attribute">

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

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

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

  1472. </dd></dl>

  1473. 

  1474. <dl class="attribute">

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

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

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

  1478. </dd></dl>

  1479. 

  1480. <dl class="attribute">

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

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

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

  1484. </dd></dl>

  1485. 

  1486. <dl class="attribute">

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

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

  1489. <dd></dd></dl>

  1490. 

  1491. <dl class="attribute">

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

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

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

  1495. </dd></dl>

  1496. 

  1497. <dl class="attribute">

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

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

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

  1501. </dd></dl>

  1502. 

  1503. <dl class="attribute">

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

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

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

  1507. </dd></dl>

  1508. 

  1509. <dl class="attribute">

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

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

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

  1513. </dd></dl>

  1514. 

  1515. </dd></dl>

  1516. 

  1517. <dl class="class">

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

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

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

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

  1522. <dl class="attribute">

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

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

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

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

  1527. </dd></dl>

  1528. 

  1529. <dl class="attribute">

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

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

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

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

  1534. </dd></dl>

  1535. 

  1536. <dl class="attribute">

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

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

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

  1540. </dd></dl>

  1541. 

  1542. <dl class="attribute">

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

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

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

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

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

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

  1549. <tbody valign="top">

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

  1551. </tr>

  1552. </tbody>

  1553. </table>

  1554. </dd></dl>

  1555. 

  1556. <dl class="attribute">

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

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

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

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

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

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

  1563. <tbody valign="top">

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

  1565. </tr>

  1566. </tbody>

  1567. </table>

  1568. </dd></dl>

  1569. 

  1570. <dl class="method">

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

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

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

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

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

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

  1577. <tbody valign="top">

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

  1579. </tr>

  1580. </tbody>

  1581. </table>

  1582. </dd></dl>

  1583. 

  1584. <dl class="method">

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

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

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

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

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

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

  1591. <tbody valign="top">

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

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

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

  1595. </ul>

  1596. </td>

  1597. </tr>

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

  1599. </td>

  1600. </tr>

  1601. </tbody>

  1602. </table>

  1603. </dd></dl>

  1604. 

  1605. </dd></dl>

  1606. 

  1607. </div>

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

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

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

  1611. <dl class="exception">

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

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

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

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

  1616. </dd></dl>

  1617. 

  1618. <dl class="exception">

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

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

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

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

  1623. </dd></dl>

  1624. 

  1625. <dl class="exception">

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

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

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

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

  1630. </dd></dl>

  1631. 

  1632. <dl class="exception">

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

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

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

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

  1637. </dd></dl>

  1638. 

  1639. <dl class="class">

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

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

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

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

  1644. <dl class="attribute">

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

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

  1647. <dd></dd></dl>

  1648. 

  1649. <dl class="attribute">

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

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

  1652. <dd></dd></dl>

  1653. 

  1654. <dl class="attribute">

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

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

  1657. <dd></dd></dl>

  1658. 

  1659. <dl class="attribute">

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

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

  1662. <dd></dd></dl>

  1663. 

  1664. <dl class="attribute">

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

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

  1667. <dd></dd></dl>

  1668. 

  1669. <dl class="attribute">

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

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

  1672. <dd></dd></dl>

  1673. 

  1674. <dl class="staticmethod">

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

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

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

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

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

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

  1681. <tbody valign="top">

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

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

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

  1685. </ul>

  1686. </td>

  1687. </tr>

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

  1689. </td>

  1690. </tr>

  1691. </tbody>

  1692. </table>

  1693. </dd></dl>

  1694. 

  1695. </dd></dl>

  1696. 

  1697. </div>

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

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

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

  1701. </div>

  1702. </div>

  1703. 

  1704. 

  1705.           </div>

  1706.         </div>

  1707.       </div>

  1708.       <div class="sphinxsidebar">

  1709.         <div class="sphinxsidebarwrapper">

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

  1711.   <ul>

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

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

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

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

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

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

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

  1719. </ul>

  1720. </li>

  1721. </ul>

  1722. 

  1723.   <h4>Previous topic</h4>

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

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

  1726.   <h3>This Page</h3>

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

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

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

  1730.   </ul>

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

  1732.   <h3>Quick search</h3>

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

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

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

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

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

  1738.     </form>

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

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

  1741.     </p>

  1742. </div>

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

  1744.         </div>

  1745.       </div>

  1746.       <div class="clearer"></div>

  1747.     </div>

  1748.     <div class="related">

  1749.       <h3>Navigation</h3>

  1750.       <ul>

  1751.         <li class="right" style="margin-right: 10px">

  1752.           <a href="genindex.html" title="General Index"

  1753.              >index</a></li>

  1754.         <li class="right" >

  1755.           <a href="py-modindex.html" title="Python Module Index"

  1756.              >modules</a> |</li>

  1757.         <li class="right" >

  1758.           <a href="index.html" title="Welcome to Alarm Decoder’s documentation!"

  1759.              >previous</a> |</li>

  1760.         <li><a href="index.html">alarmdecoder  documentation</a> &raquo;</li> 

  1761.       </ul>

  1762.     </div>

  1763.     <div class="footer">

  1764.         &copy; Copyright 2013, Nu Tech Software Solutions, Inc..

  1765.       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.

  1766.     </div>

  1767.   </body>

  1768. </html>