-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi.html
196 lines (170 loc) · 8.35 KB
/
api.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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>Neurobooth-OS Documentation — neurobooth-os documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
<script type="text/javascript" src="_static/js/jquery-1.11.0.min.js "></script>
<script type="text/javascript" src="_static/js/jquery-fix.js "></script>
<script type="text/javascript" src="_static/bootstrap-3.3.7/js/bootstrap.min.js "></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js "></script>
</head><body>
<div id="navbar" class="navbar navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">
neurobooth-os</a>
<span class="navbar-text navbar-version pull-left"><b>0.1.dev0</b></span>
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li><a href="#">API</a></li>
<li><a href="https://github.com/neurobooth/neurobooth-os">GitHub</a></li>
<li class="dropdown globaltoc-container">
<a role="button"
id="dLabelGlobalToc"
data-toggle="dropdown"
data-target="#"
href="index.html">Site <b class="caret"></b></a>
<ul class="dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc"></ul>
</li>
<li class="dropdown">
<a role="button"
id="dLabelLocalToc"
data-toggle="dropdown"
data-target="#"
href="#">Page <b class="caret"></b></a>
<ul class="dropdown-menu localtoc"
role="menu"
aria-labelledby="dLabelLocalToc"><ul>
<li><a class="reference internal" href="#">Neurobooth-OS Documentation</a><ul>
<li><a class="reference internal" href="#network-communication-neurobooth-os-netcomm">Network Communication <code class="xref py py-mod docutils literal notranslate"><span class="pre">neurobooth_os.netcomm</span></code>:</a></li>
<li><a class="reference internal" href="#mock">Mock</a></li>
<li><a class="reference internal" href="#lsl">LSL</a></li>
<li><a class="reference internal" href="#graphical-user-interface">Graphical User Interface</a></li>
</ul>
</li>
</ul>
</ul>
</li>
<li class="hidden-sm">
<div id="sourcelink">
<a href="_sources/api.rst.txt"
rel="nofollow">Source</a>
</div></li>
</ul>
<form class="navbar-form navbar-right" action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="body col-md-12 content" role="main">
<section id="neurobooth-os-documentation">
<span id="api-documentation"></span><h1>Neurobooth-OS Documentation<a class="headerlink" href="#neurobooth-os-documentation" title="Permalink to this headline">¶</a></h1>
<section id="network-communication-neurobooth-os-netcomm">
<h2>Network Communication <code class="xref py py-mod docutils literal notranslate"><span class="pre">neurobooth_os.netcomm</span></code>:<a class="headerlink" href="#network-communication-neurobooth-os-netcomm" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/neurobooth_os.netcomm.start_server.html#neurobooth_os.netcomm.start_server" title="neurobooth_os.netcomm.start_server"><code class="xref py py-obj docutils literal notranslate"><span class="pre">start_server</span></code></a>(node_name[, save_pid_txt])</p></td>
<td><p>Makes a network call to run script serv_{node_name}.bat</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/neurobooth_os.netcomm.get_client_messages.html#neurobooth_os.netcomm.get_client_messages" title="neurobooth_os.netcomm.get_client_messages"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_client_messages</span></code></a>(s1[, port, host])</p></td>
<td><p>Create socket server and get messages from clients.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/neurobooth_os.netcomm.get_fprint.html#neurobooth_os.netcomm.get_fprint" title="neurobooth_os.netcomm.get_fprint"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_fprint</span></code></a>(current_node[, target_node])</p></td>
<td><p>Return function to capture prints for sending to target_node.</p></td>
</tr>
</tbody>
</table>
</section>
<section id="mock">
<h2>Mock<a class="headerlink" href="#mock" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/neurobooth_os.mock.insert_mock_rows.html#neurobooth_os.mock.insert_mock_rows" title="neurobooth_os.mock.insert_mock_rows"><code class="xref py py-obj docutils literal notranslate"><span class="pre">insert_mock_rows</span></code></a>(conn_mock)</p></td>
<td><p>Create mock database using SSH Tunnel.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/neurobooth_os.mock.delete_mock_rows.html#neurobooth_os.mock.delete_mock_rows" title="neurobooth_os.mock.delete_mock_rows"><code class="xref py py-obj docutils literal notranslate"><span class="pre">delete_mock_rows</span></code></a>(conn_mock)</p></td>
<td><p>Delete rows in mock database with primary key starting with mock.</p></td>
</tr>
</tbody>
</table>
</section>
<section id="lsl">
<h2>LSL<a class="headerlink" href="#lsl" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
</tbody>
</table>
<p>create_lsl_inlets</p>
</section>
<section id="graphical-user-interface">
<h2>Graphical User Interface<a class="headerlink" href="#graphical-user-interface" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/neurobooth_os.gui.gui.html#neurobooth_os.gui.gui" title="neurobooth_os.gui.gui"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gui</span></code></a>([remote, database])</p></td>
<td><p>Start the Graphical User Interface.</p></td>
</tr>
</tbody>
</table>
</section>
</section>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<p class="pull-right">
<a href="#">Back to top</a>
</p>
<p>
© Copyright 2021, Neurobooth Developers.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.0.2.<br/>
</p>
</div>
</footer>
</body>
</html>