Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
<!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>python-openzwave &mdash; python-openzwave 0.3.0-alpha1 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:     '0.3.0-alpha1',
        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="python-openzwave 0.3.0-alpha1 documentation" 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">python-openzwave 0.3.0-alpha1 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="python-openzwave">
<h1>python-openzwave<a class="headerlink" href="#python-openzwave" title="Permalink to this headline">¶</a></h1>
<p>This is the new generation of python-openzwave.</p>
<p>python-openzwave is a python wrapper for the openzwave library.
It&#8217;s also contains an api (object representation of Zwave network) and ozwsh (a shell like manager using the api).</p>
<p>You can install python-openzwave in 3 ways :</p>
<blockquote>
<div><ul class="simple">
<li>From repository : you need to install mercurial, subversion and the common builds tools. Look at INSTALL_REPO to do such installation</li>
<li>From an archive : you don&#8217;t need to install mercurial, subversion. Only the common builds tools are needed. Look at INSTALL_ARCH to do such installation</li>
<li>From scratch : if you can&#8217;t build python-openzwave automatically or you are using windows or MacOS X. Look at INSTALL_MAN to do such installation</li>
</ul>
</div></blockquote>
<div class="section" id="migrating-from-python-openzwave-0-2-x-to-0-3-0">
<h2>Migrating from python-openzwave 0.2.X to 0.3.0<a class="headerlink" href="#migrating-from-python-openzwave-0-2-x-to-0-3-0" title="Permalink to this headline">¶</a></h2>
<p>This version (0.3.0) is under development, do not use it in a production environnement.</p>
<p>I need to update source tree of python-openzwave and modules&#8217;s names because of a bug in setuptools : <a class="reference external" href="https://bitbucket.org/pypa/setuptools/issue/230/develop-mode-does-not-respect-src">https://bitbucket.org/pypa/setuptools/issue/230/develop-mode-does-not-respect-src</a> .
Sorry for that.</p>
<p>So, before building python-openzwave, you must uninstall the old version :</p>
<div class="highlight-bash"><div class="highlight"><pre>sudo make uninstall
</pre></div>
</div>
<p>After that, reinstall python-openzwave using your prefered method.</p>
<p>About cython : I&#8217;ve made many tests using the cython installed via pip : (0.20, 0.21 and 0.22).
Compilation is ok but a segfault appears when launching the tests. Please remove it.</p>
<div class="highlight-bash"><div class="highlight"><pre>sudo pip uninstall Cython
</pre></div>
</div>
<p>And reinstall the one provided with your distribution</p>
<div class="highlight-bash"><div class="highlight"><pre>sudo make deps
</pre></div>
</div>
<p>If you have problems, please submit an issue with :</p>
<blockquote>
<div><ul class="simple">
<li>cython -V</li>
<li>the content of the directory /usr/local/lib/python2.7/dist-packages/ (for python2.7)</li>
<li>the content of /usr/local/lib/python2.7/dist-packages/easy-install.pth (for python 2.7)</li>
</ul>
</div></blockquote>
</div>
<div class="section" id="testing-python-openzwave">
<h2>Testing python-openzwave<a class="headerlink" href="#testing-python-openzwave" title="Permalink to this headline">¶</a></h2>
<p>After installing python-openzwave, you can run tests :</p>
<div class="highlight-bash"><div class="highlight"><pre>sudo make tests
</pre></div>
</div>
</div>
<div class="section" id="documentation">
<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2>
<p>You can browse the documentation here : <a class="reference external" href="http://bibi21000.gallet.info/python-openzwave.html">http://bibi21000.gallet.info/python-openzwave.html</a>.</p>
</div>
<div class="section" id="to-do">
<h2>To do<a class="headerlink" href="#to-do" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>Improve tests : add virtual nodes and controllers to pass test on travis</li>
<li>...</li>
</ul>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">python-openzwave</a><ul>
<li><a class="reference internal" href="#migrating-from-python-openzwave-0-2-x-to-0-3-0">Migrating from python-openzwave 0.2.X to 0.3.0</a></li>
<li><a class="reference internal" href="#testing-python-openzwave">Testing python-openzwave</a></li>
<li><a class="reference internal" href="#documentation">Documentation</a></li>
<li><a class="reference internal" href="#to-do">To do</a></li>
</ul>
</li>
</ul>

  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/README.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<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">python-openzwave 0.3.0-alpha1 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012,2013,2014,2015, bibi21000.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
    </div>
  </body>
</html>