-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathfrontend.html
More file actions
191 lines (182 loc) · 9.56 KB
/
frontend.html
File metadata and controls
191 lines (182 loc) · 9.56 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
189
190
191
<!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>Web server — Playhouse 0.1 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.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>
<link rel="top" title="Playhouse 0.1 documentation" href="index.html" />
<link rel="next" title="Configuration" href="configuration.html" />
<link rel="prev" title="resetutil — Utility for resetting Philips Hue bulbs and pairing them with bridges" href="resetutil.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="http-routingtable.html" title="HTTP Routing Table"
>routing table</a> |</li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="configuration.html" title="Configuration"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="resetutil.html" title="resetutil — Utility for resetting Philips Hue bulbs and pairing them with bridges"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Playhouse 0.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="web-server">
<h1>Web server<a class="headerlink" href="#web-server" title="Permalink to this headline">¶</a></h1>
<p>The Web server is the frontend that the users communicate with. It is
a Tornado-based web server that communicates with the Light server. It
handles the queue, the current game or animation, and is able to setup
the installation through the <a class="reference internal" href="configuration.html#config"><em>Configuration</em></a></p>
<p>The server is started by executing <tt class="docutils literal"><span class="pre">python</span> <span class="pre">src/webserver</span></tt>.</p>
<p>Dependencies:</p>
<ol class="arabic simple">
<li>Python >= 3.4</li>
<li>python-tornado</li>
<li>python-pillow (optional, for animations)</li>
</ol>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#the-configuration-interface">The configuration interface</a><ul>
<li class="toctree-l3"><a class="reference internal" href="configuration.html#setup">Setup</a></li>
<li class="toctree-l3"><a class="reference internal" href="configuration.html#settings">Settings</a></li>
<li class="toctree-l3"><a class="reference internal" href="configuration.html#bridges">Bridges</a></li>
<li class="toctree-l3"><a class="reference internal" href="configuration.html#grid">Grid</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#the-configuration-file">The configuration file</a><ul>
<li class="toctree-l3"><a class="reference internal" href="configuration.html#attributes">Attributes</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="games.html">Game API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="games.html#lifetime-of-a-game">Lifetime of a game</a><ul>
<li class="toctree-l3"><a class="reference internal" href="games.html#setup-undoing-setup">Setup & undoing setup</a></li>
<li class="toctree-l3"><a class="reference internal" href="games.html#game-implementation">Game implementation</a></li>
<li class="toctree-l3"><a class="reference internal" href="games.html#metadata">Metadata</a></li>
<li class="toctree-l3"><a class="reference internal" href="games.html#class-variables">Class variables</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="games.html#utility-functions">Utility functions</a><ul>
<li class="toctree-l3"><a class="reference internal" href="games.html#lamp-related-methods-methods-on-game">Lamp-related methods (methods on <tt class="docutils literal"><span class="pre">Game</span></tt>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="games.html#utility-methods-methods-on-game">Utility methods (methods on <tt class="docutils literal"><span class="pre">Game</span></tt>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="games.html#utility-functions-functions-on-lightgames">Utility functions (functions on <tt class="docutils literal"><span class="pre">lightgames</span></tt>)</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="games.html#simplegame">SimpleGame</a><ul>
<li class="toctree-l3"><a class="reference internal" href="games.html#template">Template</a></li>
<li class="toctree-l3"><a class="reference internal" href="games.html#utility-methods-methods-on-simplegame">Utility methods (methods on <tt class="docutils literal"><span class="pre">SimpleGame</span></tt>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="games.html#utility-functions-functions-on-simplegame">Utility functions (functions on <tt class="docutils literal"><span class="pre">simplegame</span></tt>)</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="animations.html">Animations</a><ul>
<li class="toctree-l2"><a class="reference internal" href="animations.html#technical-details">Technical details</a><ul>
<li class="toctree-l3"><a class="reference internal" href="animations.html#settings">Settings</a></li>
<li class="toctree-l3"><a class="reference internal" href="animations.html#the-animation-loop">The animation loop</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="animations.html#creating-animations">Creating animations</a><ul>
<li class="toctree-l3"><a class="reference internal" href="animations.html#limitations">Limitations</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="queue.html">Queue</a><ul>
<li class="toctree-l2"><a class="reference internal" href="queue.html#communication">Communication</a></li>
<li class="toctree-l2"><a class="reference internal" href="queue.html#usage-in-games">Usage in games</a></li>
<li class="toctree-l2"><a class="reference internal" href="queue.html#internal-methods">Internal methods</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="resetutil.html"
title="previous chapter"><tt class="docutils literal"><span class="pre">resetutil</span></tt> — Utility for resetting Philips Hue bulbs and pairing them with bridges</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="configuration.html"
title="next chapter">Configuration</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/frontend.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="http-routingtable.html" title="HTTP Routing Table"
>routing table</a> |</li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="configuration.html" title="Configuration"
>next</a> |</li>
<li class="right" >
<a href="resetutil.html" title="resetutil — Utility for resetting Philips Hue bulbs and pairing them with bridges"
>previous</a> |</li>
<li><a href="index.html">Playhouse 0.1 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2014, John Eriksson, Arvid Fahlström Myrman, Jonas Höglund, Hannes Leskelä, Christian Lidström, Mattias Palo, Markus Videll, Tomas Wickman, Emil Öhman.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>