-
Notifications
You must be signed in to change notification settings - Fork 0
/
sri-doc.html
370 lines (237 loc) · 12.8 KB
/
sri-doc.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
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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
<!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>Server Real-Time Interface — 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="next" title="LuckyClient" href="client-doc.html" />
<link rel="prev" title="Ringbuffer" href="ringbuf-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 current"><a class="current reference internal" href="#">Server Real-Time Interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="client-doc.html">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>Server Real-Time Interface</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/sri-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="server-real-time-interface">
<h1>Server Real-Time Interface<a class="headerlink" href="#server-real-time-interface" title="Permalink to this headline">¶</a></h1>
<p>The SRI implements an interface between LuckyServer and LuckyMain</p>
<p>The LuckyMain runs a continuous loop. At the start of every loop, it reads the current target conditions from the primary conditions stored in a cond_pair. These target conditions are e.g. the target phase, frequency and power threshold.</p>
<p>This primary condition is shared with the LuckyServer, i.e. it can be written and read from by this external process. While the LuckyServer writes into this condition, LuckyMain uses the secondary. LuckyMain checks during each loop whether primary and secondary are equal, and if this is not the case, overwrites the secondary settings with a copy of the primary settings.</p>
<p>The memory segment shared with LuckyServer is identified by the SHARED_CONDITION_KEY. Additionally, be default, all code in this software uses the standard_cond_pair. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Defines</p>
<dl class="macro">
<dt>
<code class="sig-name descname">SHARED_CONDITION_KEY</code></dt>
<dd><p>the key used to identify the shared memory writable for LuckyServer </p>
</dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Functions</p>
<dl class="function">
<dt>
<a class="reference internal" href="#_CPPv49condition" title="condition">condition</a> *<code class="sig-name descname">create_condition</code><span class="sig-paren">(</span>int <em>key</em><span class="sig-paren">)</span><br /></dt>
<dd><p>create a struct storing conditions in shared memory <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">key</span></code>: the key to identify the shared memory </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt>
<a class="reference internal" href="#_CPPv49cond_pair" title="cond_pair">cond_pair</a> *<code class="sig-name descname">create_cond_pair</code><span class="sig-paren">(</span><span class="sig-paren">)</span><br /></dt>
<dd><p>create a pair of conditions storing primary and secondary conditions </p>
</dd></dl>
<dl class="function">
<dt>
int <code class="sig-name descname">compare_conditions</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv49condition" title="condition">condition</a> <em>a</em>, <a class="reference internal" href="#_CPPv49condition" title="condition">condition</a> <em>b</em><span class="sig-paren">)</span><br /></dt>
<dd><p>compare two conditions for equality <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>0 in case of inequality, 1 otherwise </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">a</span></code>: the first conditions </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">b</span></code>: the other conditions </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt>
char *<code class="sig-name descname">condition_to_string</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv49condition" title="condition">condition</a> <em>cond</em><span class="sig-paren">)</span><br /></dt>
<dd></dd></dl>
<dl class="function">
<dt>
void <code class="sig-name descname">print_condition</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv49condition" title="condition">condition</a> <em>cond</em><span class="sig-paren">)</span><br /></dt>
<dd><p>print the parameters of a condition to stdout <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">cond</span></code>: the condition to print </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt>
int <code class="sig-name descname">init_mutex</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv49condition" title="condition">condition</a> *<em>a</em>, <a class="reference internal" href="#_CPPv49condition" title="condition">condition</a> *<em>b</em><span class="sig-paren">)</span><br /></dt>
<dd></dd></dl>
<dl class="function">
<dt>
int <code class="sig-name descname">unlock_mutex</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv49condition" title="condition">condition</a> *<em>cond</em><span class="sig-paren">)</span><br /></dt>
<dd></dd></dl>
<dl class="function">
<dt>
int <code class="sig-name descname">lock_mutex</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv49condition" title="condition">condition</a> *<em>cond</em><span class="sig-paren">)</span><br /></dt>
<dd></dd></dl>
<dl class="function">
<dt>
int <code class="sig-name descname">trylock_mutex</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv49condition" title="condition">condition</a> *<em>cond</em><span class="sig-paren">)</span><br /></dt>
<dd></dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Variables</p>
<dl class="member">
<dt>
<a class="reference internal" href="#_CPPv49condition" title="condition">condition</a> <code class="sig-name descname">standard_cond</code><br /></dt>
<dd></dd></dl>
<dl class="member">
<dt>
<a class="reference internal" href="#_CPPv49cond_pair" title="cond_pair">cond_pair</a> <code class="sig-name descname">standard_cond_pair</code><br /></dt>
<dd></dd></dl>
<dl class="member">
<dt>
size_t <code class="sig-name descname">shm_size</code><br /></dt>
<dd></dd></dl>
</div>
<dl class="class">
<dt>
<em class="property">struct </em><code class="sig-name descname">condition</code><br /></dt>
<dd><em>#include <sri.h></em><p>A structure containing the current settings of the EtherCat Main </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Members</p>
<dl class="member">
<dt>
int <code class="sig-name descname">target_phase</code><br /></dt>
<dd><p>the target phase in degree </p>
</dd></dl>
<dl class="member">
<dt>
int <code class="sig-name descname">target_frequency</code><br /></dt>
<dd><p>the target frequency in Hz </p>
</dd></dl>
<dl class="member">
<dt>
int <code class="sig-name descname">threshold</code><br /></dt>
<dd><p>the target threshold in a.u. </p>
</dd></dl>
<dl class="member">
<dt>
int <code class="sig-name descname">trigger</code><br /></dt>
<dd><p>the current state of the trigger </p>
</dd></dl>
<dl class="member">
<dt>
pthread_mutex_t <code class="sig-name descname">mutx</code><br /></dt>
<dd><p>the mutex is either locked or unlocked </p>
</dd></dl>
</div>
</dd></dl>
<dl class="class">
<dt>
<em class="property">struct </em><code class="sig-name descname">cond_pair</code><br /></dt>
<dd><em>#include <sri.h></em><p>A double-tier buffer to ensure that the EtherCat always runs with a stable set of conditions <p>Main will use the primary condition in every loop, unless the primary is locked by a mutex in which case it will fall back to the secondary condition. The primary condition is only locked when the LuckyServer is currently writing into or reading from it. The secondary condition is a copy of the primary condition which can only be changed by LuckyMain </p>
</p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Members</p>
<dl class="member">
<dt>
<a class="reference internal" href="#_CPPv49condition" title="condition">condition</a> <code class="sig-name descname">primary</code><br /></dt>
<dd><p>the primary condition shared between LuckyMain and LuckyServer </p>
</dd></dl>
<dl class="member">
<dt>
<a class="reference internal" href="#_CPPv49condition" title="condition">condition</a> <code class="sig-name descname">secondary</code><br /></dt>
<dd><p>the secondary condition is a stable copy of primary and private to LuckyMain </p>
</dd></dl>
</div>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="client-doc.html" class="btn btn-neutral float-right" title="LuckyClient" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="ringbuf-doc.html" class="btn btn-neutral float-left" title="Ringbuffer" 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>