forked from balloob/python-openzwave
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathEXAMPLES.html
More file actions
188 lines (178 loc) · 7.68 KB
/
Copy pathEXAMPLES.html
File metadata and controls
188 lines (178 loc) · 7.68 KB
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
<!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 — 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> »</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>You don’t need to install (but building it) python-openzwave to test examples.</p>
<div class="section" id="ozwsh">
<h2>ozwsh<a class="headerlink" href="#ozwsh" title="Permalink to this headline">¶</a></h2>
<p>A shell manager for your ZWave network. It use urwid and louie python extensions.
If needed, type the following command to install them :</p>
<div class="highlight-bash"><div class="highlight"><pre>sudo pip install urwid louie
</pre></div>
</div>
<p>Start ozwsh with :</p>
<div class="highlight-bash"><div class="highlight"><pre>./ozwsh.sh --device<span class="o">=</span>/dev/yourzwavestick
</pre></div>
</div>
<p>It allows you to :</p>
<blockquote>
<div><ul class="simple">
<li>Reset controller (hard and soft) and add/remove device/controller</li>
<li>Change node informations (name, location, ... )</li>
<li>view and change values informations</li>
<li>view and change group informations</li>
<li>Full management of scenes, switches, dimmers and sensors</li>
</ul>
</div></blockquote>
<p>It’s a shell like manager. You can visit your zwave network using the
command cd. All available commands are displayed on every screens.
You can use the tab keys to switch between the view panel and the edit panel
and the up and down ones to view all informations.</p>
<p>For the developpers : this a good example on how to use the api.
Update are sent to uwird widget using louie notifications. ZWave data
updates are done in the set, add, delete, remove, ... methods.</p>
<p>There is some others examples, to test them :</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nb">cd </span>examples
./build_examples.sh
</pre></div>
</div>
<p>This will install all the needed files used by the examples in a temporary
directory.</p>
</div>
<div class="section" id="api-demo">
<h2>api_demo<a class="headerlink" href="#api-demo" title="Permalink to this headline">¶</a></h2>
<p>A test demo for the api : it list all nodes/values on your network, trying
to identify your switches, dimmers and sensors.</p>
<p>Start it with :</p>
<div class="highlight-bash"><div class="highlight"><pre>./api_demo.py --device<span class="o">=</span>/dev/yourzwavestick
</pre></div>
</div>
</div>
<div class="section" id="test-lib">
<h2>test_lib<a class="headerlink" href="#test-lib" title="Permalink to this headline">¶</a></h2>
<p>A test demo for the library : connect to the network and sniff for notifications.</p>
<p>Start it with :</p>
<div class="highlight-bash"><div class="highlight"><pre>./test_lib.py --device<span class="o">=</span>/dev/yourzwavestick --sniff<span class="o">=</span>30
</pre></div>
</div>
</div>
<div class="section" id="api-snif">
<h2>api_snif<a class="headerlink" href="#api-snif" title="Permalink to this headline">¶</a></h2>
<p>A test demo for the api : connect to the api and sniff for louie signal from it.</p>
<p>Start it with :</p>
<div class="highlight-bash"><div class="highlight"><pre>./api_sniff.py --device<span class="o">=</span>/dev/yourzwavestick --sniff<span class="o">=</span>30
</pre></div>
</div>
</div>
<div class="section" id="memory-use">
<h2>memory_use<a class="headerlink" href="#memory-use" title="Permalink to this headline">¶</a></h2>
<p>Try to evaluate the memory use of the api.</p>
<p>Start it with :</p>
<div class="highlight-bash"><div class="highlight"><pre>./memory_use.py --device<span class="o">=</span>/dev/yourzwavestick
</pre></div>
</div>
</div>
<div class="section" id="other-examples">
<h2>Other examples<a class="headerlink" href="#other-examples" title="Permalink to this headline">¶</a></h2>
<p>manager : my first try to use uwird. I don’t think I will developp it anymore.
Feel free to fork it.</p>
<p>The old directory contains examples of py-openzwave (the ancestor of python-openzwave),
feel free to upgrade them.</p>
<p>If you develop some examples using python-openzwave library, send us the sources,
they will be addes to examples.</p>
</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="#ozwsh">ozwsh</a></li>
<li><a class="reference internal" href="#api-demo">api_demo</a></li>
<li><a class="reference internal" href="#test-lib">test_lib</a></li>
<li><a class="reference internal" href="#api-snif">api_snif</a></li>
<li><a class="reference internal" href="#memory-use">memory_use</a></li>
<li><a class="reference internal" href="#other-examples">Other examples</a></li>
</ul>
</li>
</ul>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/EXAMPLES.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> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2012,2013,2014,2015, bibi21000.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>