-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbackend.html
157 lines (148 loc) · 7.55 KB
/
backend.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
<!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>Light 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="playhouse — Python library for communicating with Philips Hue bridges" href="playhouse.html" />
<link rel="prev" title="Welcome to Playhouse’s 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="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="playhouse.html" title="playhouse — Python library for communicating with Philips Hue bridges"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to Playhouse’s documentation!"
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="light-server">
<h1>Light server<a class="headerlink" href="#light-server" title="Permalink to this headline">¶</a></h1>
<p>The light server takes care of the actual communication with the Hue bridges. It consists
primarily of a Tornado-based server exposing a REST-inspired API for controlling the bridges,
as well as the <a class="reference internal" href="playhouse.html#module-playhouse" title="playhouse"><tt class="xref py py-mod docutils literal"><span class="pre">playhouse</span></tt></a> module that it depends on.</p>
<p>Also included is a command-line utility that makes pairing Hue light bulbs with bridges
easier.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="playhouse.html"><tt class="docutils literal"><span class="pre">playhouse</span></tt> — Python library for communicating with Philips Hue bridges</a><ul>
<li class="toctree-l2"><a class="reference internal" href="playhouse.html#bridge-management">Bridge management</a></li>
<li class="toctree-l2"><a class="reference internal" href="playhouse.html#exception-classes">Exception classes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="playhouse.html#hue-api-errors">Hue API errors</a></li>
<li class="toctree-l3"><a class="reference internal" href="playhouse.html#other-errors">Other errors</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="lightserver.html"><tt class="docutils literal"><span class="pre">lightserver</span></tt> — Server exposing an HTTP API for controlling several Philips Hue bridges</a><ul>
<li class="toctree-l2"><a class="reference internal" href="lightserver.html#running-the-server">Running the server</a><ul>
<li class="toctree-l3"><a class="reference internal" href="lightserver.html#dependencies">Dependencies</a></li>
<li class="toctree-l3"><a class="reference internal" href="lightserver.html#setup">Setup</a></li>
<li class="toctree-l3"><a class="reference internal" href="lightserver.html#configuration-file">Configuration file</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="lightserver.html#the-api">The API</a><ul>
<li class="toctree-l3"><a class="reference internal" href="lightserver.html#responses">Responses</a></li>
<li class="toctree-l3"><a class="reference internal" href="lightserver.html#failed-requests">Failed requests</a></li>
<li class="toctree-l3"><a class="reference internal" href="lightserver.html#authentication">Authentication</a></li>
<li class="toctree-l3"><a class="reference internal" href="lightserver.html#api-methods">API methods</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="resetutil.html"><tt class="docutils literal"><span class="pre">resetutil</span></tt> — Utility for resetting Philips Hue bulbs and pairing them with bridges</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Welcome to Playhouse’s documentation!</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="playhouse.html"
title="next chapter"><tt class="docutils literal"><span class="pre">playhouse</span></tt> — Python library for communicating with Philips Hue bridges</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/backend.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="playhouse.html" title="playhouse — Python library for communicating with Philips Hue bridges"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to Playhouse’s documentation!"
>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>