1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>alarmdecoder.messages — alarmdecoder documentation</title>
<link rel="stylesheet" href="../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="top" title="alarmdecoder documentation" href="../../index.html" />
<link rel="up" title="Module code" href="../index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../index.html">alarmdecoder documentation</a> »</li>
<li><a href="../index.html" accesskey="U">Module code</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for alarmdecoder.messages</h1><div class="highlight"><pre>
<span class="sd">"""</span>
<span class="sd">Message representations received from the panel through the `AlarmDecoder`_ (AD2)</span>
<span class="sd">devices.</span>
<span class="sd">* :py:class:`Message`: The standard and most common message received from a panel.</span>
<span class="sd">* :py:class:`ExpanderMessage`: Messages received from Relay or Zone expander modules.</span>
<span class="sd">* :py:class:`RFMessage`: Message received from an RF receiver module.</span>
<span class="sd">* :py:class:`LRRMessage`: Message received from a long-range radio module.</span>
<span class="sd">.. _AlarmDecoder: http://www.alarmdecoder.com</span>
<span class="sd">.. moduleauthor:: Scott Petersen <scott@nutech.com></span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<span class="kn">from</span> <span class="nn">reprlib</span> <span class="kn">import</span> <span class="nb">repr</span>
<span class="kn">from</span> <span class="nn">.util</span> <span class="kn">import</span> <span class="n">InvalidMessageError</span>
<span class="kn">from</span> <span class="nn">.panels</span> <span class="kn">import</span> <span class="n">PANEL_TYPES</span><span class="p">,</span> <span class="n">ADEMCO</span><span class="p">,</span> <span class="n">DSC</span>
<div class="viewcode-block" id="BaseMessage"><a class="viewcode-back" href="../../alarmdecoder.html#alarmdecoder.messages.BaseMessage">[docs]</a><span class="k">class</span> <span class="nc">BaseMessage</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Base class for messages.</span>
<span class="sd"> """</span>
<span class="n">raw</span> <span class="o">=</span> <span class="bp">None</span>
<span class="sd">"""The raw message text"""</span>
<span class="n">timestamp</span> <span class="o">=</span> <span class="bp">None</span>
<span class="sd">"""The timestamp of the message"""</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Constructor</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">timestamp</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> String conversion operator.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw</span>
<div class="viewcode-block" id="BaseMessage.dict"><a class="viewcode-back" href="../../alarmdecoder.html#alarmdecoder.messages.BaseMessage.dict">[docs]</a> <span class="k">def</span> <span class="nf">dict</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Dictionary representation.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="nb">dict</span><span class="p">(</span>
<span class="n">time</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">timestamp</span><span class="p">,</span>
<span class="n">mesg</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">raw</span><span class="p">,</span>
<span class="o">**</span><span class="n">kwargs</span>
<span class="p">)</span>
</div>
<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> String representation.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dict</span><span class="p">())</span>
</div>
<div class="viewcode-block" id="Message"><a class="viewcode-back" href="../../alarmdecoder.html#alarmdecoder.messages.Message">[docs]</a><span class="k">class</span> <span class="nc">Message</span><span class="p">(</span><span class="n">BaseMessage</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Represents a message from the alarm panel.</span>
<span class="sd"> """</span>
<span class="n">ready</span> <span class="o">=</span> <span class="bp">False</span>
<span class="sd">"""Indicates whether or not the panel is in a ready state."""</span>
<span class="n">armed_away</span> <span class="o">=</span> <span class="bp">False</span>
<span class="sd">"""Indicates whether or not the panel is armed away."""</span>
<span class="n">armed_home</span> <span class="o">=</span> <span class="bp">False</span>
<span class="sd">"""Indicates whether or not the panel is armed home."""</span>
<span class="n">backlight_on</span> <span class="o">=</span> <span class="bp">False</span>
<span class="sd">"""Indicates whether or not the keypad backlight is on."""</span>
<span class="n">programming_mode</span> <span class="o">=</span> <span class="bp">False</span>
<span class="sd">"""Indicates whether or not we're in programming mode."""</span>
<span class="n">beeps</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
<span class="sd">"""Number of beeps associated with a message."""</span>
<span class="n">zone_bypassed</span> <span class="o">=</span> <span class="bp">False</span>
<span class="sd">"""Indicates whether or not a zone is bypassed."""</span>
<span class="n">ac_power</span> <span class="o">=</span> <span class="bp">False</span>
<span class="sd">"""Indicates whether or not the panel is on AC power."""</span>
<span class="n">chime_on</span> <span class="o">=</span> <span class="bp">False</span>
<span class="sd">"""Indicates whether or not the chime is enabled."""</span>
<span class="n">alarm_event_occurred</span> <span class="o">=</span> <span class="bp">False</span>
<span class="sd">"""Indicates whether or not an alarm event has occurred."""</span>
<span class="n">alarm_sounding</span> <span class="o">=</span> <span class="bp">False</span>
<span class="sd">"""Indicates whether or not an alarm is sounding."""</span>
<span class="n">battery_low</span> <span class="o">=</span> <span class="bp">False</span>
<span class="sd">"""Indicates whether or not there is a low battery."""</span>
<span class="n">entry_delay_off</span> <span class="o">=</span> <span class="bp">False</span>
<span class="sd">"""Indicates whether or not the entry delay is enabled."""</span>
<span class="n">fire_alarm</span> <span class="o">=</span> <span class="bp">False</span>
<span class="sd">"""Indicates whether or not a fire alarm is sounding."""</span>
<span class="n">check_zone</span> <span class="o">=</span> <span class="bp">False</span>
<span class="sd">"""Indicates whether or not there are zones that require attention."""</span>
<span class="n">perimeter_only</span> <span class="o">=</span> <span class="bp">False</span>
<span class="sd">"""Indicates whether or not the perimeter is armed."""</span>
<span class="n">system_fault</span> <span class="o">=</span> <span class="bp">False</span>
<span class="sd">"""Indicates whether a system fault has occurred."""</span>
<span class="n">panel_type</span> <span class="o">=</span> <span class="n">ADEMCO</span>
<span class="sd">"""Indicates which panel type was the source of this message."""</span>
<span class="n">numeric_code</span> <span class="o">=</span> <span class="bp">None</span>
<span class="sd">"""The numeric code associated with the message."""</span>
<span class="n">text</span> <span class="o">=</span> <span class="bp">None</span>
<span class="sd">"""The human-readable text to be displayed on the panel LCD."""</span>
<span class="n">cursor_location</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
<span class="sd">"""Current cursor location on the keypad."""</span>
<span class="n">mask</span> <span class="o">=</span> <span class="mh">0xFFFFFFFF</span>
<span class="sd">"""Address mask this message is intended for."""</span>
<span class="n">bitfield</span> <span class="o">=</span> <span class="bp">None</span>
<span class="sd">"""The bitfield associated with this message."""</span>
<span class="n">panel_data</span> <span class="o">=</span> <span class="bp">None</span>
<span class="sd">"""The panel data field associated with this message."""</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Constructor</span>
<span class="sd"> :param data: message data to parse</span>
<span class="sd"> :type data: string</span>
<span class="sd"> """</span>
<span class="n">BaseMessage</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_regex</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">'^(!KPM:){0,1}(\[[a-fA-F0-9\-]+\]),([a-fA-F0-9]+),(\[[a-fA-F0-9]+\]),(".+")$'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">data</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_parse_message</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_parse_message</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Parse the message from the device.</span>
<span class="sd"> :param data: message data</span>
<span class="sd"> :type data: string</span>
<span class="sd"> :raises: :py:class:`~alarmdecoder.util.InvalidMessageError`</span>
<span class="sd"> """</span>
<span class="n">match</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_regex</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">data</span><span class="p">))</span>
<span class="k">if</span> <span class="n">match</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">InvalidMessageError</span><span class="p">(</span><span class="s">'Received invalid message: {0}'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">data</span><span class="p">))</span>
<span class="n">header</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">bitfield</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">numeric_code</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">panel_data</span><span class="p">,</span> <span class="n">alpha</span> <span class="o">=</span> <span class="n">match</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
<span class="n">is_bit_set</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">bit</span><span class="p">:</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">bitfield</span><span class="p">[</span><span class="n">bit</span><span class="p">]</span> <span class="o">==</span> <span class="s">"0"</span>
<span class="bp">self</span><span class="o">.</span><span class="n">raw</span> <span class="o">=</span> <span class="n">data</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ready</span> <span class="o">=</span> <span class="n">is_bit_set</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">armed_away</span> <span class="o">=</span> <span class="n">is_bit_set</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">armed_home</span> <span class="o">=</span> <span class="n">is_bit_set</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">backlight_on</span> <span class="o">=</span> <span class="n">is_bit_set</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">programming_mode</span> <span class="o">=</span> <span class="n">is_bit_set</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">beeps</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">bitfield</span><span class="p">[</span><span class="mi">6</span><span class="p">],</span> <span class="mi">16</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">zone_bypassed</span> <span class="o">=</span> <span class="n">is_bit_set</span><span class="p">(</span><span class="mi">7</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ac_power</span> <span class="o">=</span> <span class="n">is_bit_set</span><span class="p">(</span><span class="mi">8</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">chime_on</span> <span class="o">=</span> <span class="n">is_bit_set</span><span class="p">(</span><span class="mi">9</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">alarm_event_occurred</span> <span class="o">=</span> <span class="n">is_bit_set</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">alarm_sounding</span> <span class="o">=</span> <span class="n">is_bit_set</span><span class="p">(</span><span class="mi">11</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">battery_low</span> <span class="o">=</span> <span class="n">is_bit_set</span><span class="p">(</span><span class="mi">12</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">entry_delay_off</span> <span class="o">=</span> <span class="n">is_bit_set</span><span class="p">(</span><span class="mi">13</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fire_alarm</span> <span class="o">=</span> <span class="n">is_bit_set</span><span class="p">(</span><span class="mi">14</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">check_zone</span> <span class="o">=</span> <span class="n">is_bit_set</span><span class="p">(</span><span class="mi">15</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">perimeter_only</span> <span class="o">=</span> <span class="n">is_bit_set</span><span class="p">(</span><span class="mi">16</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">system_fault</span> <span class="o">=</span> <span class="n">is_bit_set</span><span class="p">(</span><span class="mi">17</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">bitfield</span><span class="p">[</span><span class="mi">18</span><span class="p">]</span> <span class="ow">in</span> <span class="nb">list</span><span class="p">(</span><span class="n">PANEL_TYPES</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">panel_type</span> <span class="o">=</span> <span class="n">PANEL_TYPES</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">bitfield</span><span class="p">[</span><span class="mi">18</span><span class="p">]]</span>
<span class="c"># pos 20-21 - Unused.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">text</span> <span class="o">=</span> <span class="n">alpha</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s">'"'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">mask</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">panel_data</span><span class="p">[</span><span class="mi">3</span><span class="p">:</span><span class="mi">3</span><span class="o">+</span><span class="mi">8</span><span class="p">],</span> <span class="mi">16</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">panel_type</span> <span class="ow">in</span> <span class="p">(</span><span class="n">ADEMCO</span><span class="p">,</span> <span class="n">DSC</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">int</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">panel_data</span><span class="p">[</span><span class="mi">19</span><span class="p">:</span><span class="mi">21</span><span class="p">],</span> <span class="mi">16</span><span class="p">)</span> <span class="o">&</span> <span class="mh">0x01</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
<span class="c"># Current cursor location on the alpha display.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cursor_location</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">panel_data</span><span class="p">[</span><span class="mi">21</span><span class="p">:</span><span class="mi">23</span><span class="p">],</span> <span class="mi">16</span><span class="p">)</span>
<div class="viewcode-block" id="Message.dict"><a class="viewcode-back" href="../../alarmdecoder.html#alarmdecoder.messages.Message.dict">[docs]</a> <span class="k">def</span> <span class="nf">dict</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Dictionary representation.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="nb">dict</span><span class="p">(</span>
<span class="n">time</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">timestamp</span><span class="p">,</span>
<span class="n">bitfield</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">bitfield</span><span class="p">,</span>
<span class="n">numeric_code</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">numeric_code</span><span class="p">,</span>
<span class="n">panel_data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">panel_data</span><span class="p">,</span>
<span class="n">mask</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">mask</span><span class="p">,</span>
<span class="n">ready</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ready</span><span class="p">,</span>
<span class="n">armed_away</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">armed_away</span><span class="p">,</span>
<span class="n">armed_home</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">armed_home</span><span class="p">,</span>
<span class="n">backlight_on</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">backlight_on</span><span class="p">,</span>
<span class="n">programming_mode</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">programming_mode</span><span class="p">,</span>
<span class="n">beeps</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">beeps</span><span class="p">,</span>
<span class="n">zone_bypassed</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">zone_bypassed</span><span class="p">,</span>
<span class="n">ac_power</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ac_power</span><span class="p">,</span>
<span class="n">chime_on</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">chime_on</span><span class="p">,</span>
<span class="n">alarm_event_occurred</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">alarm_event_occurred</span><span class="p">,</span>
<span class="n">alarm_sounding</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">alarm_sounding</span><span class="p">,</span>
<span class="n">battery_low</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">battery_low</span><span class="p">,</span>
<span class="n">entry_delay_off</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">entry_delay_off</span><span class="p">,</span>
<span class="n">fire_alarm</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fire_alarm</span><span class="p">,</span>
<span class="n">check_zone</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">check_zone</span><span class="p">,</span>
<span class="n">perimeter_only</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">perimeter_only</span><span class="p">,</span>
<span class="n">text</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">text</span><span class="p">,</span>
<span class="n">cursor_location</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cursor_location</span><span class="p">,</span>
<span class="o">**</span><span class="n">kwargs</span>
<span class="p">)</span>
</div></div>
<div class="viewcode-block" id="ExpanderMessage"><a class="viewcode-back" href="../../alarmdecoder.html#alarmdecoder.messages.ExpanderMessage">[docs]</a><span class="k">class</span> <span class="nc">ExpanderMessage</span><span class="p">(</span><span class="n">BaseMessage</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Represents a message from a zone or relay expansion module.</span>
<span class="sd"> """</span>
<span class="n">ZONE</span> <span class="o">=</span> <span class="mi">0</span>
<span class="sd">"""Flag indicating that the expander message relates to a Zone Expander."""</span>
<span class="n">RELAY</span> <span class="o">=</span> <span class="mi">1</span>
<span class="sd">"""Flag indicating that the expander message relates to a Relay Expander."""</span>
<span class="nb">type</span> <span class="o">=</span> <span class="bp">None</span>
<span class="sd">"""Expander message type: ExpanderMessage.ZONE or ExpanderMessage.RELAY"""</span>
<span class="n">address</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
<span class="sd">"""Address of expander"""</span>
<span class="n">channel</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
<span class="sd">"""Channel on the expander"""</span>
<span class="n">value</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
<span class="sd">"""Value associated with the message"""</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Constructor</span>
<span class="sd"> :param data: message data to parse</span>
<span class="sd"> :type data: string</span>
<span class="sd"> """</span>
<span class="n">BaseMessage</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="k">if</span> <span class="n">data</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_parse_message</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_parse_message</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Parse the raw message from the device.</span>
<span class="sd"> :param data: message data</span>
<span class="sd"> :type data: string</span>
<span class="sd"> :raises: :py:class:`~alarmdecoder.util.InvalidMessageError`</span>
<span class="sd"> """</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">header</span><span class="p">,</span> <span class="n">values</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">':'</span><span class="p">)</span>
<span class="n">address</span><span class="p">,</span> <span class="n">channel</span><span class="p">,</span> <span class="n">value</span> <span class="o">=</span> <span class="n">values</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">','</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">raw</span> <span class="o">=</span> <span class="n">data</span>
<span class="bp">self</span><span class="o">.</span><span class="n">address</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">address</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">channel</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">channel</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">InvalidMessageError</span><span class="p">(</span><span class="s">'Received invalid message: {0}'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">data</span><span class="p">))</span>
<span class="k">if</span> <span class="n">header</span> <span class="o">==</span> <span class="s">'!EXP'</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">type</span> <span class="o">=</span> <span class="n">ExpanderMessage</span><span class="o">.</span><span class="n">ZONE</span>
<span class="k">elif</span> <span class="n">header</span> <span class="o">==</span> <span class="s">'!REL'</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">type</span> <span class="o">=</span> <span class="n">ExpanderMessage</span><span class="o">.</span><span class="n">RELAY</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">InvalidMessageError</span><span class="p">(</span><span class="s">'Unknown expander message header: {0}'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">data</span><span class="p">))</span>
<div class="viewcode-block" id="ExpanderMessage.dict"><a class="viewcode-back" href="../../alarmdecoder.html#alarmdecoder.messages.ExpanderMessage.dict">[docs]</a> <span class="k">def</span> <span class="nf">dict</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Dictionary representation.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="nb">dict</span><span class="p">(</span>
<span class="n">time</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">timestamp</span><span class="p">,</span>
<span class="n">address</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">address</span><span class="p">,</span>
<span class="n">channel</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">channel</span><span class="p">,</span>
<span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">value</span><span class="p">,</span>
<span class="o">**</span><span class="n">kwargs</span>
<span class="p">)</span>
</div></div>
<div class="viewcode-block" id="RFMessage"><a class="viewcode-back" href="../../alarmdecoder.html#alarmdecoder.messages.RFMessage">[docs]</a><span class="k">class</span> <span class="nc">RFMessage</span><span class="p">(</span><span class="n">BaseMessage</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Represents a message from an RF receiver.</span>
<span class="sd"> """</span>
<span class="n">serial_number</span> <span class="o">=</span> <span class="bp">None</span>
<span class="sd">"""Serial number of the RF device."""</span>
<span class="n">value</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
<span class="sd">"""Value associated with this message."""</span>
<span class="n">battery</span> <span class="o">=</span> <span class="bp">False</span>
<span class="sd">"""Low battery indication"""</span>
<span class="n">supervision</span> <span class="o">=</span> <span class="bp">False</span>
<span class="sd">"""Supervision required indication"""</span>
<span class="n">loop</span> <span class="o">=</span> <span class="p">[</span><span class="bp">False</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">list</span><span class="p">(</span><span class="nb">range</span><span class="p">(</span><span class="mi">4</span><span class="p">))]</span>
<span class="sd">"""Loop indicators"""</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Constructor</span>
<span class="sd"> :param data: message data to parse</span>
<span class="sd"> :type data: string</span>
<span class="sd"> """</span>
<span class="n">BaseMessage</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="k">if</span> <span class="n">data</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_parse_message</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_parse_message</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Parses the raw message from the device.</span>
<span class="sd"> :param data: message data</span>
<span class="sd"> :type data: string</span>
<span class="sd"> :raises: :py:class:`~alarmdecoder.util.InvalidMessageError`</span>
<span class="sd"> """</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">raw</span> <span class="o">=</span> <span class="n">data</span>
<span class="n">_</span><span class="p">,</span> <span class="n">values</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">':'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">serial_number</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="n">values</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">','</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">value</span><span class="p">,</span> <span class="mi">16</span><span class="p">)</span>
<span class="n">is_bit_set</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">b</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">value</span> <span class="o">&</span> <span class="p">(</span><span class="mi">1</span> <span class="o"><<</span> <span class="p">(</span><span class="n">b</span> <span class="o">-</span> <span class="mi">1</span><span class="p">))</span> <span class="o">></span> <span class="mi">0</span>
<span class="c"># Bit 1 = unknown</span>
<span class="bp">self</span><span class="o">.</span><span class="n">battery</span> <span class="o">=</span> <span class="n">is_bit_set</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">supervision</span> <span class="o">=</span> <span class="n">is_bit_set</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>
<span class="c"># Bit 4 = unknown</span>
<span class="bp">self</span><span class="o">.</span><span class="n">loop</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="o">=</span> <span class="n">is_bit_set</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">loop</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">=</span> <span class="n">is_bit_set</span><span class="p">(</span><span class="mi">6</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">loop</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="o">=</span> <span class="n">is_bit_set</span><span class="p">(</span><span class="mi">7</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">loop</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="n">is_bit_set</span><span class="p">(</span><span class="mi">8</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">InvalidMessageError</span><span class="p">(</span><span class="s">'Received invalid message: {0}'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">data</span><span class="p">))</span>
<div class="viewcode-block" id="RFMessage.dict"><a class="viewcode-back" href="../../alarmdecoder.html#alarmdecoder.messages.RFMessage.dict">[docs]</a> <span class="k">def</span> <span class="nf">dict</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Dictionary representation.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="nb">dict</span><span class="p">(</span>
<span class="n">time</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">timestamp</span><span class="p">,</span>
<span class="n">serial_number</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">serial_number</span><span class="p">,</span>
<span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">value</span><span class="p">,</span>
<span class="n">battery</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">battery</span><span class="p">,</span>
<span class="n">supervision</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">supervision</span><span class="p">,</span>
<span class="o">**</span><span class="n">kwargs</span>
<span class="p">)</span>
</div></div>
<div class="viewcode-block" id="LRRMessage"><a class="viewcode-back" href="../../alarmdecoder.html#alarmdecoder.messages.LRRMessage">[docs]</a><span class="k">class</span> <span class="nc">LRRMessage</span><span class="p">(</span><span class="n">BaseMessage</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Represent a message from a Long Range Radio.</span>
<span class="sd"> """</span>
<span class="n">event_data</span> <span class="o">=</span> <span class="bp">None</span>
<span class="sd">"""Data associated with the LRR message. Usually user ID or zone."""</span>
<span class="n">partition</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
<span class="sd">"""The partition that this message applies to."""</span>
<span class="n">event_type</span> <span class="o">=</span> <span class="bp">None</span>
<span class="sd">"""The type of the event that occurred."""</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Constructor</span>
<span class="sd"> :param data: message data to parse</span>
<span class="sd"> :type data: string</span>
<span class="sd"> """</span>
<span class="n">BaseMessage</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="k">if</span> <span class="n">data</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_parse_message</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_parse_message</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Parses the raw message from the device.</span>
<span class="sd"> :param data: message data to parse</span>
<span class="sd"> :type data: string</span>
<span class="sd"> :raises: :py:class:`~alarmdecoder.util.InvalidMessageError`</span>
<span class="sd"> """</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">raw</span> <span class="o">=</span> <span class="n">data</span>
<span class="n">_</span><span class="p">,</span> <span class="n">values</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">':'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">event_data</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">partition</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">event_type</span> <span class="o">=</span> <span class="n">values</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">','</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">InvalidMessageError</span><span class="p">(</span><span class="s">'Received invalid message: {0}'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">data</span><span class="p">))</span>
<div class="viewcode-block" id="LRRMessage.dict"><a class="viewcode-back" href="../../alarmdecoder.html#alarmdecoder.messages.LRRMessage.dict">[docs]</a> <span class="k">def</span> <span class="nf">dict</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Dictionary representation.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="nb">dict</span><span class="p">(</span>
<span class="n">time</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">timestamp</span><span class="p">,</span>
<span class="n">event_data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">event_data</span><span class="p">,</span>
<span class="n">event_type</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">event_type</span><span class="p">,</span>
<span class="n">partition</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">partition</span><span class="p">,</span>
<span class="o">**</span><span class="n">kwargs</span>
<span class="p">)</span></div></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../index.html">alarmdecoder documentation</a> »</li>
<li><a href="../index.html" >Module code</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2013, Nu Tech Software Solutions, Inc..
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>
|
