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

1225 lines
71 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="next" title="event Package" href="alarmdecoder.event.html" />

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

  29.   </head>

  30.   <body>

  31.     <div class="related">

  32.       <h3>Navigation</h3>

  33.       <ul>

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

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

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

  37.         <li class="right" >

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

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

  40.         <li class="right" >

  41.           <a href="alarmdecoder.event.html" title="event Package"

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

  43.         <li class="right" >

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

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

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

  47.       </ul>

  48.     </div>  

  49. 

  50.     <div class="document">

  51.       <div class="documentwrapper">

  52.         <div class="bodywrapper">

  53.           <div class="body">

  54.             

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

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

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

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

  59. </div>

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

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

  62. <p>Contains different types of devices belonging to the Alarm Decoder (AD2) family.</p>

  63. <dl class="class">

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

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

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

  67. <p>Generic parent device to all Alarm Decoder (AD2) products.</p>

  68. <dl class="attribute">

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

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

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

  72. </dd></dl>

  73. 

  74. <dl class="attribute">

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

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

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

  78. </dd></dl>

  79. 

  80. <dl class="attribute">

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

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

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

  84. </dd></dl>

  85. 

  86. <dl class="attribute">

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

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

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

  90. </dd></dl>

  91. 

  92. <dl class="attribute">

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

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

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

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

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

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

  99. <tbody valign="top">

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

  101. </tr>

  102. </tbody>

  103. </table>

  104. </dd></dl>

  105. 

  106. <dl class="method">

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

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

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

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

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

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

  113. <tbody valign="top">

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

  115. </tr>

  116. </tbody>

  117. </table>

  118. </dd></dl>

  119. 

  120. <dl class="method">

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

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

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

  124. </dd></dl>

  125. 

  126. <dl class="method">

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

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

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

  130. </dd></dl>

  131. 

  132. <dl class="class">

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

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

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

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

  137. <dl class="attribute">

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

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

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

  141. </dd></dl>

  142. 

  143. <dl class="method">

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

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

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

  147. </dd></dl>

  148. 

  149. <dl class="method">

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

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

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

  153. </dd></dl>

  154. 

  155. </dd></dl>

  156. 

  157. </dd></dl>

  158. 

  159. <dl class="class">

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

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

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

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

  164. <dl class="attribute">

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

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

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

  168. </dd></dl>

  169. 

  170. <dl class="attribute">

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

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

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

  174. </dd></dl>

  175. 

  176. <dl class="attribute">

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

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

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

  180. </dd></dl>

  181. 

  182. <dl class="classmethod">

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

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

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

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

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

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

  189. <tbody valign="top">

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

  191. </tr>

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

  193. </tr>

  194. </tbody>

  195. </table>

  196. </dd></dl>

  197. 

  198. <dl class="classmethod">

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

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

  201. <dd><p>Returns a cached list of AD2USB devices located on the system.</p>

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

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

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

  205. <tbody valign="top">

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

  207. </tr>

  208. </tbody>

  209. </table>

  210. </dd></dl>

  211. 

  212. <dl class="classmethod">

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

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

  215. <dd><p>Factory method that returns the requested USBDevice device, or the first device.</p>

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

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

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

  219. <tbody valign="top">

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

  221. </tr>

  222. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">USBDevice object utilizing the specified device.</td>

  223. </tr>

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

  225. </tr>

  226. </tbody>

  227. </table>

  228. </dd></dl>

  229. 

  230. <dl class="classmethod">

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

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

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

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

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

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

  237. <tbody valign="top">

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

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

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

  241. </ul>

  242. </td>

  243. </tr>

  244. </tbody>

  245. </table>

  246. </dd></dl>

  247. 

  248. <dl class="classmethod">

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

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

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

  252. </dd></dl>

  253. 

  254. <dl class="attribute">

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

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

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

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

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

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

  261. <tbody valign="top">

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

  263. </tr>

  264. </tbody>

  265. </table>

  266. </dd></dl>

  267. 

  268. <dl class="attribute">

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

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

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

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

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

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

  275. <tbody valign="top">

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

  277. </tr>

  278. </tbody>

  279. </table>

  280. </dd></dl>

  281. 

  282. <dl class="attribute">

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

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

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

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

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

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

  289. <tbody valign="top">

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

  291. </tr>

  292. </tbody>

  293. </table>

  294. </dd></dl>

  295. 

  296. <dl class="method">

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

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

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

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

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

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

  303. <tbody valign="top">

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

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

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

  307. </ul>

  308. </td>

  309. </tr>

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

  311. </td>

  312. </tr>

  313. </tbody>

  314. </table>

  315. </dd></dl>

  316. 

  317. <dl class="method">

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

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

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

  321. </dd></dl>

  322. 

  323. <dl class="method">

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

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

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

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

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

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

  330. <tbody valign="top">

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

  332. </tr>

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

  334. </tr>

  335. </tbody>

  336. </table>

  337. </dd></dl>

  338. 

  339. <dl class="method">

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

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

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

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

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

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

  346. <tbody valign="top">

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

  348. </tr>

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

  350. </tr>

  351. </tbody>

  352. </table>

  353. </dd></dl>

  354. 

  355. <dl class="method">

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

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

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

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

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

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

  362. <tbody valign="top">

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

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

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

  366. </ul>

  367. </td>

  368. </tr>

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

  370. </td>

  371. </tr>

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

  373. </td>

  374. </tr>

  375. </tbody>

  376. </table>

  377. </dd></dl>

  378. 

  379. <dl class="class">

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

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

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

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

  384. <dl class="attribute">

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

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

  387. <dd><p>Called when an AD2USB device has been detected.</p>

  388. </dd></dl>

  389. 

  390. <dl class="attribute">

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

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

  393. <dd><p>Called when an AD2USB device has been removed.</p>

  394. </dd></dl>

  395. 

  396. <dl class="method">

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

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

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

  400. </dd></dl>

  401. 

  402. <dl class="method">

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

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

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

  406. </dd></dl>

  407. 

  408. </dd></dl>

  409. 

  410. </dd></dl>

  411. 

  412. <dl class="class">

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

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

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

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

  417. <dl class="attribute">

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

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

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

  421. </dd></dl>

  422. 

  423. <dl class="staticmethod">

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

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

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

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

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

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

  430. <tbody valign="top">

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

  432. </tr>

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

  434. </tr>

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

  436. </tr>

  437. </tbody>

  438. </table>

  439. </dd></dl>

  440. 

  441. <dl class="attribute">

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

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

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

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

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

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

  448. <tbody valign="top">

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

  450. </tr>

  451. </tbody>

  452. </table>

  453. </dd></dl>

  454. 

  455. <dl class="method">

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

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

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

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

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

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

  462. <tbody valign="top">

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

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

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

  466. </ul>

  467. </td>

  468. </tr>

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

  470. </td>

  471. </tr>

  472. </tbody>

  473. </table>

  474. </dd></dl>

  475. 

  476. <dl class="method">

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

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

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

  480. </dd></dl>

  481. 

  482. <dl class="method">

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

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

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

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

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

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

  489. <tbody valign="top">

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

  491. </tr>

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

  493. </tr>

  494. </tbody>

  495. </table>

  496. </dd></dl>

  497. 

  498. <dl class="method">

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

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

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

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

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

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

  505. <tbody valign="top">

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

  507. </tr>

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

  509. </tr>

  510. </tbody>

  511. </table>

  512. </dd></dl>

  513. 

  514. <dl class="method">

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

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

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

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

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

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

  521. <tbody valign="top">

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

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

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

  525. </ul>

  526. </td>

  527. </tr>

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

  529. </td>

  530. </tr>

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

  532. </td>

  533. </tr>

  534. </tbody>

  535. </table>

  536. </dd></dl>

  537. 

  538. </dd></dl>

  539. 

  540. <dl class="class">

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

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

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

  544. <p>Device that supports communication with an Alarm Decoder (AD2) that is

  545. exposed via ser2sock or another Serial to IP interface.</p>

  546. <dl class="attribute">

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

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

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

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

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

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

  553. <tbody valign="top">

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

  555. </tr>

  556. </tbody>

  557. </table>

  558. </dd></dl>

  559. 

  560. <dl class="attribute">

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

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

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

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

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

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

  567. <tbody valign="top">

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

  569. </tr>

  570. </tbody>

  571. </table>

  572. </dd></dl>

  573. 

  574. <dl class="attribute">

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

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

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

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

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

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

  581. <tbody valign="top">

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

  583. </tr>

  584. </tbody>

  585. </table>

  586. </dd></dl>

  587. 

  588. <dl class="attribute">

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

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

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

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

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

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

  595. <tbody valign="top">

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

  597. </tr>

  598. </tbody>

  599. </table>

  600. </dd></dl>

  601. 

  602. <dl class="attribute">

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

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

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

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

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

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

  609. <tbody valign="top">

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

  611. </tr>

  612. </tbody>

  613. </table>

  614. </dd></dl>

  615. 

  616. <dl class="method">

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

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

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

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

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

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

  623. <tbody valign="top">

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

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

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

  627. </ul>

  628. </td>

  629. </tr>

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

  631. </td>

  632. </tr>

  633. </tbody>

  634. </table>

  635. </dd></dl>

  636. 

  637. <dl class="method">

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

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

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

  641. </dd></dl>

  642. 

  643. <dl class="method">

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

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

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

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

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

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

  650. <tbody valign="top">

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

  652. </tr>

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

  654. </tr>

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

  656. </tr>

  657. </tbody>

  658. </table>

  659. </dd></dl>

  660. 

  661. <dl class="method">

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

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

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

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

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

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

  668. <tbody valign="top">

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

  670. </tr>

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

  672. </tr>

  673. </tbody>

  674. </table>

  675. </dd></dl>

  676. 

  677. <dl class="method">

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

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

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

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

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

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

  684. <tbody valign="top">

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

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

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

  688. </ul>

  689. </td>

  690. </tr>

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

  692. </td>

  693. </tr>

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

  695. </td>

  696. </tr>

  697. </tbody>

  698. </table>

  699. </dd></dl>

  700. 

  701. </dd></dl>

  702. 

  703. </div>

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

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

  706. <p>Provides utility classes for the Alarm Decoder (AD2) devices.</p>

  707. <dl class="exception">

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

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

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

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

  712. </dd></dl>

  713. 

  714. <dl class="exception">

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

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

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

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

  719. </dd></dl>

  720. 

  721. <dl class="exception">

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

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

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

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

  726. </dd></dl>

  727. 

  728. <dl class="exception">

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

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

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

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

  733. </dd></dl>

  734. 

  735. <dl class="class">

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

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

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

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

  740. <dl class="attribute">

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

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

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

  744. 

  745. <dl class="attribute">

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

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

  748. <dd></dd></dl>

  749. 

  750. <dl class="attribute">

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

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

  753. <dd></dd></dl>

  754. 

  755. <dl class="attribute">

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

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

  758. <dd></dd></dl>

  759. 

  760. <dl class="attribute">

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

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

  763. <dd></dd></dl>

  764. 

  765. <dl class="attribute">

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

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

  768. <dd></dd></dl>

  769. 

  770. <dl class="staticmethod">

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

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

  773. <dd><p>Uploads firmware to an Alarm Decoder device.</p>

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

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

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

  777. <tbody valign="top">

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

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

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

  781. </ul>

  782. </td>

  783. </tr>

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

  785. </td>

  786. </tr>

  787. </tbody>

  788. </table>

  789. </dd></dl>

  790. 

  791. </dd></dl>

  792. 

  793. </div>

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

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

  796. <p>Provides zone tracking functionality for the Alarm Decoder (AD2) device family.</p>

  797. <dl class="class">

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

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

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

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

  802. <dl class="attribute">

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

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

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

  806. </dd></dl>

  807. 

  808. <dl class="attribute">

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

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

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

  812. </dd></dl>

  813. 

  814. <dl class="attribute">

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

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

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

  818. </dd></dl>

  819. 

  820. <dl class="attribute">

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

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

  823. <dd></dd></dl>

  824. 

  825. </dd></dl>

  826. 

  827. <dl class="class">

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

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

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

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

  832. <dl class="attribute">

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

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

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

  836. </dd></dl>

  837. 

  838. <dl class="attribute">

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

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

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

  842. </dd></dl>

  843. 

  844. <dl class="attribute">

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

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

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

  848. </dd></dl>

  849. 

  850. <dl class="method">

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

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

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

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

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

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

  857. <tbody valign="top">

  858. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>message</strong> (<em>Message or ExpanderMessage</em>) &#8211; Message to use to update the zone tracking.</td>

  859. </tr>

  860. </tbody>

  861. </table>

  862. </dd></dl>

  863. 

  864. </dd></dl>

  865. 

  866. </div>

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

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

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

  870. </div>

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

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

  873. <p>Message representations received from the panel through the Alarm Decoder (AD2)

  874. devices.</p>

  875. <dl class="class">

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

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

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

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

  880. <dl class="attribute">

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

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

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

  884. </dd></dl>

  885. 

  886. </dd></dl>

  887. 

  888. <dl class="class">

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

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

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

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

  893. <dl class="attribute">

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

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

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

  897. </dd></dl>

  898. 

  899. <dl class="attribute">

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

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

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

  903. </dd></dl>

  904. 

  905. <dl class="attribute">

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

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

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

  909. </dd></dl>

  910. 

  911. <dl class="attribute">

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

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

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

  915. </dd></dl>

  916. 

  917. <dl class="attribute">

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

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

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

  921. </dd></dl>

  922. 

  923. <dl class="attribute">

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

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

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

  927. </dd></dl>

  928. 

  929. <dl class="attribute">

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

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

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

  933. </dd></dl>

  934. 

  935. <dl class="attribute">

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

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

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

  939. </dd></dl>

  940. 

  941. <dl class="attribute">

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

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

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

  945. </dd></dl>

  946. 

  947. <dl class="attribute">

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

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

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

  951. </dd></dl>

  952. 

  953. <dl class="attribute">

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

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

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

  957. </dd></dl>

  958. 

  959. <dl class="attribute">

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

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

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

  963. </dd></dl>

  964. 

  965. <dl class="attribute">

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

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

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

  969. </dd></dl>

  970. 

  971. <dl class="attribute">

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

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

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

  975. </dd></dl>

  976. 

  977. <dl class="attribute">

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

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

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

  981. </dd></dl>

  982. 

  983. <dl class="attribute">

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

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

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

  987. </dd></dl>

  988. 

  989. <dl class="attribute">

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

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

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

  993. </dd></dl>

  994. 

  995. <dl class="attribute">

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

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

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

  999. </dd></dl>

  1000. 

  1001. <dl class="attribute">

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

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

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

  1005. </dd></dl>

  1006. 

  1007. <dl class="attribute">

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

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

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

  1011. </dd></dl>

  1012. 

  1013. <dl class="attribute">

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

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

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

  1017. </dd></dl>

  1018. 

  1019. <dl class="attribute">

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

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

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

  1023. </dd></dl>

  1024. 

  1025. </dd></dl>

  1026. 

  1027. <dl class="class">

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

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

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

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

  1032. <dl class="attribute">

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

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

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

  1036. </dd></dl>

  1037. 

  1038. <dl class="attribute">

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

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

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

  1042. </dd></dl>

  1043. 

  1044. <dl class="attribute">

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

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

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

  1048. </dd></dl>

  1049. 

  1050. <dl class="attribute">

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

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

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

  1054. </dd></dl>

  1055. 

  1056. <dl class="attribute">

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

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

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

  1060. </dd></dl>

  1061. 

  1062. <dl class="attribute">

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

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

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

  1066. </dd></dl>

  1067. 

  1068. </dd></dl>

  1069. 

  1070. <dl class="class">

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

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

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

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

  1075. <dl class="attribute">

  1076. <dt id="alarmdecoder.messages.RFMessage.x">

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

  1078. <dd></dd></dl>

  1079. 

  1080. <dl class="attribute">

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

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

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

  1084. </dd></dl>

  1085. 

  1086. <dl class="attribute">

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

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

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

  1090. </dd></dl>

  1091. 

  1092. <dl class="attribute">

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

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

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

  1096. </dd></dl>

  1097. 

  1098. <dl class="attribute">

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

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

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

  1102. </dd></dl>

  1103. 

  1104. <dl class="attribute">

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

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

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

  1108. </dd></dl>

  1109. 

  1110. </dd></dl>

  1111. 

  1112. <dl class="class">

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

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

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

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

  1117. <dl class="attribute">

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

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

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

  1121. </dd></dl>

  1122. 

  1123. <dl class="attribute">

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

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

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

  1127. </dd></dl>

  1128. 

  1129. <dl class="attribute">

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

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

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

  1133. </dd></dl>

  1134. 

  1135. </dd></dl>

  1136. 

  1137. </div>

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

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

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

  1141. <ul>

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

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

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

  1145. </ul>

  1146. </li>

  1147. </ul>

  1148. </div>

  1149. </div>

  1150. </div>

  1151. 

  1152. 

  1153.           </div>

  1154.         </div>

  1155.       </div>

  1156.       <div class="sphinxsidebar">

  1157.         <div class="sphinxsidebarwrapper">

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

  1159.   <ul>

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

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

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

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

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

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

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

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

  1168. </ul>

  1169. </li>

  1170. </ul>

  1171. </li>

  1172. </ul>

  1173. 

  1174.   <h4>Previous topic</h4>

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

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

  1177.   <h4>Next topic</h4>

  1178.   <p class="topless"><a href="alarmdecoder.event.html"

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

  1180.   <h3>This Page</h3>

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

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

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

  1184.   </ul>

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

  1186.   <h3>Quick search</h3>

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

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

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

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

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

  1192.     </form>

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

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

  1195.     </p>

  1196. </div>

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

  1198.         </div>

  1199.       </div>

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

  1201.     </div>

  1202.     <div class="related">

  1203.       <h3>Navigation</h3>

  1204.       <ul>

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

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

  1207.              >index</a></li>

  1208.         <li class="right" >

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

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

  1211.         <li class="right" >

  1212.           <a href="alarmdecoder.event.html" title="event Package"

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

  1214.         <li class="right" >

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

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

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

  1218.       </ul>

  1219.     </div>

  1220.     <div class="footer">

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

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

  1223.     </div>

  1224.   </body>

  1225. </html>