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.

alarmdecoder.event.html 7.2 KiB

11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>event Package &mdash; alarmdecoder documentation</title>
  7. <link rel="stylesheet" href="_static/default.css" type="text/css" />
  8. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT: './',
  12. VERSION: '',
  13. COLLAPSE_INDEX: false,
  14. FILE_SUFFIX: '.html',
  15. HAS_SOURCE: true
  16. };
  17. </script>
  18. <script type="text/javascript" src="_static/jquery.js"></script>
  19. <script type="text/javascript" src="_static/underscore.js"></script>
  20. <script type="text/javascript" src="_static/doctools.js"></script>
  21. <link rel="top" title="alarmdecoder documentation" href="index.html" />
  22. </head>
  23. <body>
  24. <div class="related">
  25. <h3>Navigation</h3>
  26. <ul>
  27. <li class="right" style="margin-right: 10px">
  28. <a href="genindex.html" title="General Index"
  29. accesskey="I">index</a></li>
  30. <li class="right" >
  31. <a href="py-modindex.html" title="Python Module Index"
  32. >modules</a> |</li>
  33. <li><a href="index.html">alarmdecoder documentation</a> &raquo;</li>
  34. </ul>
  35. </div>
  36. <div class="document">
  37. <div class="documentwrapper">
  38. <div class="bodywrapper">
  39. <div class="body">
  40. <div class="section" id="event-package">
  41. <h1>event Package<a class="headerlink" href="#event-package" title="Permalink to this headline">¶</a></h1>
  42. <div class="section" id="id1">
  43. <h2><tt class="xref py py-mod docutils literal"><span class="pre">event</span></tt> Package<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
  44. <span class="target" id="module-alarmdecoder.event"></span></div>
  45. <div class="section" id="module-alarmdecoder.event.event">
  46. <span id="event-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">event</span></tt> Module<a class="headerlink" href="#module-alarmdecoder.event.event" title="Permalink to this headline">¶</a></h2>
  47. <dl class="class">
  48. <dt id="alarmdecoder.event.event.Event">
  49. <em class="property">class </em><tt class="descclassname">alarmdecoder.event.event.</tt><tt class="descname">Event</tt><big>(</big><em>doc=None</em><big>)</big><a class="reference internal" href="_modules/alarmdecoder/event/event.html#Event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.event.event.Event" title="Permalink to this definition">¶</a></dt>
  50. <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
  51. </dd></dl>
  52. <dl class="class">
  53. <dt id="alarmdecoder.event.event.EventHandler">
  54. <em class="property">class </em><tt class="descclassname">alarmdecoder.event.event.</tt><tt class="descname">EventHandler</tt><big>(</big><em>event</em>, <em>obj</em><big>)</big><a class="reference internal" href="_modules/alarmdecoder/event/event.html#EventHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.event.event.EventHandler" title="Permalink to this definition">¶</a></dt>
  55. <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
  56. <dl class="method">
  57. <dt id="alarmdecoder.event.event.EventHandler.add">
  58. <tt class="descname">add</tt><big>(</big><em>func</em><big>)</big><a class="reference internal" href="_modules/alarmdecoder/event/event.html#EventHandler.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.event.event.EventHandler.add" title="Permalink to this definition">¶</a></dt>
  59. <dd><p>Add new event handler function.</p>
  60. <p>Event handler function must be defined like func(sender, earg).
  61. You can add handler also by using &#8216;+=&#8217; operator.</p>
  62. </dd></dl>
  63. <dl class="method">
  64. <dt id="alarmdecoder.event.event.EventHandler.remove">
  65. <tt class="descname">remove</tt><big>(</big><em>func</em><big>)</big><a class="reference internal" href="_modules/alarmdecoder/event/event.html#EventHandler.remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.event.event.EventHandler.remove" title="Permalink to this definition">¶</a></dt>
  66. <dd><p>Remove existing event handler function.</p>
  67. <p>You can remove handler also by using &#8216;-=&#8217; operator.</p>
  68. </dd></dl>
  69. <dl class="method">
  70. <dt id="alarmdecoder.event.event.EventHandler.fire">
  71. <tt class="descname">fire</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/alarmdecoder/event/event.html#EventHandler.fire"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alarmdecoder.event.event.EventHandler.fire" title="Permalink to this definition">¶</a></dt>
  72. <dd><p>Fire event and call all handler functions</p>
  73. <p>You can call EventHandler object itself like e(<a href="#id2"><span class="problematic" id="id3">*</span></a>args, <a href="#id4"><span class="problematic" id="id5">**</span></a>kwargs) instead of
  74. e.fire(<a href="#id6"><span class="problematic" id="id7">*</span></a>args, <a href="#id8"><span class="problematic" id="id9">**</span></a>kwargs).</p>
  75. </dd></dl>
  76. </dd></dl>
  77. </div>
  78. </div>
  79. </div>
  80. </div>
  81. </div>
  82. <div class="sphinxsidebar">
  83. <div class="sphinxsidebarwrapper">
  84. <h3><a href="index.html">Table Of Contents</a></h3>
  85. <ul>
  86. <li><a class="reference internal" href="#">event Package</a><ul>
  87. <li><a class="reference internal" href="#id1"><tt class="docutils literal"><span class="pre">event</span></tt> Package</a></li>
  88. <li><a class="reference internal" href="#module-alarmdecoder.event.event"><tt class="docutils literal"><span class="pre">event</span></tt> Module</a></li>
  89. </ul>
  90. </li>
  91. </ul>
  92. <h3>This Page</h3>
  93. <ul class="this-page-menu">
  94. <li><a href="_sources/alarmdecoder.event.txt"
  95. rel="nofollow">Show Source</a></li>
  96. </ul>
  97. <div id="searchbox" style="display: none">
  98. <h3>Quick search</h3>
  99. <form class="search" action="search.html" method="get">
  100. <input type="text" name="q" />
  101. <input type="submit" value="Go" />
  102. <input type="hidden" name="check_keywords" value="yes" />
  103. <input type="hidden" name="area" value="default" />
  104. </form>
  105. <p class="searchtip" style="font-size: 90%">
  106. Enter search terms or a module, class or function name.
  107. </p>
  108. </div>
  109. <script type="text/javascript">$('#searchbox').show(0);</script>
  110. </div>
  111. </div>
  112. <div class="clearer"></div>
  113. </div>
  114. <div class="related">
  115. <h3>Navigation</h3>
  116. <ul>
  117. <li class="right" style="margin-right: 10px">
  118. <a href="genindex.html" title="General Index"
  119. >index</a></li>
  120. <li class="right" >
  121. <a href="py-modindex.html" title="Python Module Index"
  122. >modules</a> |</li>
  123. <li><a href="index.html">alarmdecoder documentation</a> &raquo;</li>
  124. </ul>
  125. </div>
  126. <div class="footer">
  127. &copy; Copyright 2013, Nu Tech Software Solutions, Inc..
  128. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
  129. </div>
  130. </body>
  131. </html>