-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathstructure.html
266 lines (162 loc) · 8.83 KB
/
structure.html
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
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Projekt Structure — Braubar 0.1 Dokumentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="top" title="Braubar 0.1 Dokumentation" href="index.html"/>
<link rel="prev" title="Installation" href="install.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> Braubar
<img src="_static/braubar_logo.png" class="logo" />
</a>
<div class="version">
0.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Hardware.html">Hardware Requirements</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Projekt Structure</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#braubar-pi">braubar-pi</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#brewdaemon">Brewdaemon</a></li>
<li class="toctree-l3"><a class="reference internal" href="#socketserver">Socketserver</a></li>
<li class="toctree-l3"><a class="reference internal" href="#flask-webserver">Flask-Webserver</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#braubar-temp">braubar-temp</a></li>
<li class="toctree-l2"><a class="reference internal" href="#eg-pm2-lan">EG-PM2-LAN</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Braubar</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Projekt Structure</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/structure.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="projekt-structure">
<span id="projekt-structure"></span><h1>Projekt Structure<a class="headerlink" href="#projekt-structure" title="Link zu dieser Überschrift">¶</a></h1>
<p>Generally Braubar is divided into three parts:</p>
<ul class="simple">
<li><strong>braubar-pi</strong>: Controling and displaying information on a Raspberry Pi</li>
<li><strong>braubar-temp</strong>: Temperature sensor that sends temperature values via UDP on Port 50505</li>
<li><strong>EG-PM2-LAN</strong>: Power-strip to switch the magnet valve or your stove on and off.</li>
</ul>
<div class="section" id="braubar-pi">
<span id="braubar-pi"></span><h2>braubar-pi<a class="headerlink" href="#braubar-pi" title="Link zu dieser Überschrift">¶</a></h2>
<p>braubar-pi is mainly written in python and aims to be used in python >3.4. It consits of three different modules with different roles:</p>
<ul class="simple">
<li>Brewdaemon</li>
<li>Socketserver</li>
<li>Flask-Webserver</li>
</ul>
<div class="section" id="brewdaemon">
<span id="brewdaemon"></span><h3>Brewdaemon<a class="headerlink" href="#brewdaemon" title="Link zu dieser Überschrift">¶</a></h3>
<p>The Brewdaemon manages the whole application, keeps track of the different states, computes a PID output, switches the power-switch and writes everything in a SQLite database.</p>
</div>
<div class="section" id="socketserver">
<span id="socketserver"></span><h3>Socketserver<a class="headerlink" href="#socketserver" title="Link zu dieser Überschrift">¶</a></h3>
<p>Starts a socket-server on port 50505 and listens for packages from <strong>braubar-temp</strong>-project. After receiving a package the values will be written in a temporary log file, which will be read every two seconds by <strong>Brewdaemon</strong>.</p>
</div>
<div class="section" id="flask-webserver">
<span id="flask-webserver"></span><h3>Flask-Webserver<a class="headerlink" href="#flask-webserver" title="Link zu dieser Überschrift">¶</a></h3>
<p>Overview of the current state, shows a temperature-plot with three graphs:</p>
<ul class="simple">
<li>real temperature curve</li>
<li>desired temperature curve</li>
<li>PID output scaled to a output from 0-100.</li>
</ul>
<p>Also it is possible to go to the next state.</p>
</div>
</div>
<div class="section" id="braubar-temp">
<span id="braubar-temp"></span><h2>braubar-temp<a class="headerlink" href="#braubar-temp" title="Link zu dieser Überschrift">¶</a></h2>
<p>As mentioned before, braubar-temp is a ethernet temperature sensor. The attached sensor is a <em>ds18b20</em> sensor for temperature measurement.</p>
<p>In the current setting the sensor yields a value every 750ms. Therefore it sends at maximum every second a new value, only if the temperature changed.</p>
<p>The ethernet package looks like the following listing. The start- and end-sync bytes help to ensure that we got a correct package. In the future the end sync should be changed to a CRC to check the payload.</p>
<div class="highlight-python"><div class="highlight"><pre><span></span>+------------------+------------+-----------+---------+----------------+
| start-sync-bytes | temp value | sensor id | heating | end sync bytes |
+------------------+------------+-----------+---------+----------------+
</pre></div>
</div>
<p>Braubar-temp requieres a DHCP-server to obtain a IP-address.</p>
</div>
<div class="section" id="eg-pm2-lan">
<span id="eg-pm2-lan"></span><h2>EG-PM2-LAN<a class="headerlink" href="#eg-pm2-lan" title="Link zu dieser Überschrift">¶</a></h2>
<p>An easy to use power-switch that can be controlled with HTTP calls.
The responsible script for controlling the power-switch is <code class="docutils literal"><span class="pre">braubar-pi/braubar/service/powerstrip.py</span></code></p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="install.html" class="btn btn-neutral" title="Installation" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2016, Oliver Fesseler.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.1',
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>
<script type="text/javascript" src="_static/translations.js"></script>
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>