-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclient-doc.html
More file actions
324 lines (205 loc) · 14.1 KB
/
client-doc.html
File metadata and controls
324 lines (205 loc) · 14.1 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
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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
<!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>LuckyClient — LuckyLoop 0.1.0 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="Server Real-Time Interface" href="sri-doc.html" />
</head>
<body class="wy-body-for-nav">
<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"> LuckyLoop
</a>
<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">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="ringbuf-doc.html">Ringbuffer</a></li>
<li class="toctree-l1"><a class="reference internal" href="sri-doc.html">Server Real-Time Interface</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">LuckyClient</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">LuckyLoop</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>LuckyClient</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/client-doc.rst.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="luckyclient">
<h1>LuckyClient<a class="headerlink" href="#luckyclient" title="Permalink to this headline">¶</a></h1>
<p><a class="reference external" href="https://nc-loop.github.io/_htmlcov/index.html">Coverage Report</a></p>
<span class="target" id="module-luckyloop.client"></span><p>LuckyClient is the python interface to remote control LuckyLoop over TCP/IP</p>
<p class="rubric">Example</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">luckyloop.client</span> <span class="kn">import</span> <span class="n">LuckyClient</span>
<span class="n">lucky</span> <span class="o">=</span> <span class="n">LuckyClient</span><span class="p">()</span>
<span class="n">lucky</span><span class="o">.</span><span class="n">frequency</span> <span class="o">=</span> <span class="mi">20</span> <span class="n">sets</span> <span class="n">the</span> <span class="n">target</span> <span class="n">frequency</span> <span class="n">to</span> <span class="mi">20</span>
<span class="n">lucky</span><span class="o">.</span><span class="n">phase</span> <span class="o">=</span> <span class="mi">2</span> <span class="c1"># sets the target phase to 2</span>
<span class="n">lucky</span><span class="o">.</span><span class="n">trigger</span><span class="p">()</span> <span class="c1"># triggers immediatly</span>
</pre></div>
</div>
<dl class="class">
<dt id="luckyloop.client.LuckyClient">
<em class="property">class </em><code class="sig-name descname">LuckyClient</code><span class="sig-paren">(</span><em class="sig-param">host='127.0.0.1'</em>, <em class="sig-param">port=1219</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/luckyloop/client.html#LuckyClient"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#luckyloop.client.LuckyClient" title="Permalink to this definition">¶</a></dt>
<dd><p>Allows to remote control the LuckyLoop</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>host</strong> (<em>str</em>) – defaults to 127.0.0.1, but should be set in production to the ip-adress of the LuckyLoop device</p></li>
<li><p><strong>port</strong> (<em>int</em>) – defaults to 1219 because LuckyServer has the acronym LS and L is 12th character in alphabet and S is the 19th.</p></li>
</ul>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>For safety reasons, parameters like target frequency and phase are not set during initialization of the client, as this could interrupt an ongoing process on LuckyLoop when an user tries to reconnect. All parameters have be set explicitly after initialization.</p>
</div>
<dl class="method">
<dt id="luckyloop.client.LuckyClient.enquire">
<code class="sig-name descname">enquire</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/luckyloop/client.html#LuckyClient.enquire"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#luckyloop.client.LuckyClient.enquire" title="Permalink to this definition">¶</a></dt>
<dd><p>enquire about the current status and version of LuckyLoop</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>]</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="luckyloop.client.LuckyClient.frequency">
<em class="property">property </em><code class="sig-name descname">frequency</code><a class="headerlink" href="#luckyloop.client.LuckyClient.frequency" title="Permalink to this definition">¶</a></dt>
<dd><p>the frequency for which LuckyLoop calculates phase and power</p>
<p>LuckyLoop calculates phase and amplitude continually for a specific frequency. Change this target_frequency</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>target_frequency</strong> – an integer of at least 1 Hz</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="luckyloop.client.LuckyClient.phase">
<em class="property">property </em><code class="sig-name descname">phase</code><a class="headerlink" href="#luckyloop.client.LuckyClient.phase" title="Permalink to this definition">¶</a></dt>
<dd><p>the phase at which LuckyLoop triggers.</p>
<p>set the corresponding target frequency with <a class="reference internal" href="#luckyloop.client.LuckyClient.frequency" title="luckyloop.client.LuckyClient.frequency"><code class="xref py py-meth docutils literal notranslate"><span class="pre">frequency()</span></code></a></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>target_phase</strong> – an integer between -180 and +180</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="luckyloop.client.LuckyClient.query">
<code class="sig-name descname">query</code><span class="sig-paren">(</span><em class="sig-param">message</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/luckyloop/client.html#LuckyClient.query"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#luckyloop.client.LuckyClient.query" title="Permalink to this definition">¶</a></dt>
<dd><p>send and receive a message to LuckyLoop</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code>]</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="luckyloop.client.LuckyClient.shutdown">
<code class="sig-name descname">shutdown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/luckyloop/client.html#LuckyClient.shutdown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#luckyloop.client.LuckyClient.shutdown" title="Permalink to this definition">¶</a></dt>
<dd><p>shuts LuckyLoop down gracefully</p>
</dd></dl>
<dl class="method">
<dt id="luckyloop.client.LuckyClient.threshold">
<em class="property">property </em><code class="sig-name descname">threshold</code><a class="headerlink" href="#luckyloop.client.LuckyClient.threshold" title="Permalink to this definition">¶</a></dt>
<dd><p>the power threshold for which LuckyLoop would trigger</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>threshold</strong> – an integer larger or equal to 0</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Currently not being used by LuckyLoop</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="luckyloop.client.LuckyClient.trigger">
<code class="sig-name descname">trigger</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/luckyloop/client.html#LuckyClient.trigger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#luckyloop.client.LuckyClient.trigger" title="Permalink to this definition">¶</a></dt>
<dd><p>LuckyLoop will trigger once the conditions are met</p>
<p>While set, LuckyLoop will, once the required conditions are met, pull OUT1 to 5V for one cycle (i.e. 1ms). After LuckyLoop has triggered, trigger status field is set to 0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The effective target frequency and phase can be changed with(<a class="reference internal" href="#luckyloop.client.LuckyClient.frequency" title="luckyloop.client.LuckyClient.frequency"><code class="xref py py-meth docutils literal notranslate"><span class="pre">frequency()</span></code></a> & <a class="reference internal" href="#luckyloop.client.LuckyClient.phase" title="luckyloop.client.LuckyClient.phase"><code class="xref py py-meth docutils literal notranslate"><span class="pre">phase()</span></code></a>) anytime. To prevent a racing condition, set them prior to calling <a class="reference internal" href="#luckyloop.client.LuckyClient.trigger" title="luckyloop.client.LuckyClient.trigger"><code class="xref py py-meth docutils literal notranslate"><span class="pre">trigger()</span></code></a>.</p>
</div>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>You can see whether LuckyLoop has triggered by calling <a class="reference internal" href="#luckyloop.client.LuckyClient.enquire" title="luckyloop.client.LuckyClient.enquire"><code class="xref py py-meth docutils literal notranslate"><span class="pre">enquire()</span></code></a> continually until the trigger status field is 0, e.g. with <code class="code docutils literal notranslate"><span class="pre">client.enquire()["trigger"]</span> <span class="pre">==</span> <span class="pre">0</span></code></p>
</div>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="sri-doc.html" class="btn btn-neutral float-left" title="Server Real-Time Interface" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2020, Translational Neurosurgery
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/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">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>