/
group__advanced__funcs.html
executable file
·215 lines (204 loc) · 11.5 KB
/
group__advanced__funcs.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
<!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/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>MyoBridge Library: Functions for Advanced Usage</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="mblogo_200.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MyoBridge Library
 <span id="projectnumber">1.0</span>
</div>
<div id="projectbrief">A high-level Arduino library to work with MyoBridge Firmware for the HM-11 SoC.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__advanced__funcs.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Functions for Advanced Usage</div> </div>
</div><!--header-->
<div class="contents">
<p>These functions represent advanced functionality of the <a class="el" href="class_myo_bridge.html">MyoBridge</a> library and should only be used by users with knowledge about the Myo Bluetooth Protocol and the <a class="el" href="class_myo_bridge.html">MyoBridge</a> firmware.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga38ee56d816b6016b2eefc3581c6eb1ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_myo_bridge_8h.html#aa37476b945410b138d2a66c88ededf26">MyoBridgeSignal</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__advanced__funcs.html#ga38ee56d816b6016b2eefc3581c6eb1ee">MyoBridge::sendCommand</a> (uint8_t *pData)</td></tr>
<tr class="memdesc:ga38ee56d816b6016b2eefc3581c6eb1ee"><td class="mdescLeft"> </td><td class="mdescRight">send a command as defined in <a class="el" href="_myo_bridge_types_8h.html" title="Header file of MyoBridge Typedefs, Constants, Enums, Etc. for use with Arduino. ">MyoBridgeTypes.h</a> to the <a class="el" href="class_myo_bridge.html">MyoBridge</a>. <a href="#ga38ee56d816b6016b2eefc3581c6eb1ee">More...</a><br /></td></tr>
<tr class="separator:ga38ee56d816b6016b2eefc3581c6eb1ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga69b60ac309ea1e0170484325d63a04a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_myo_bridge_8h.html#aa37476b945410b138d2a66c88ededf26">MyoBridgeSignal</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__advanced__funcs.html#ga69b60ac309ea1e0170484325d63a04a7">MyoBridge::sendConfirmedCommand</a> (uint8_t *pData)</td></tr>
<tr class="memdesc:ga69b60ac309ea1e0170484325d63a04a7"><td class="mdescLeft"> </td><td class="mdescRight">Sends a command and waits for write confirmation. <a href="#ga69b60ac309ea1e0170484325d63a04a7">More...</a><br /></td></tr>
<tr class="separator:ga69b60ac309ea1e0170484325d63a04a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga52ae472dcf995d2806e7eb190f4b214b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_myo_bridge_8h.html#aa37476b945410b138d2a66c88ededf26">MyoBridgeSignal</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__advanced__funcs.html#ga52ae472dcf995d2806e7eb190f4b214b">MyoBridge::enableAllMessages</a> ()</td></tr>
<tr class="memdesc:ga52ae472dcf995d2806e7eb190f4b214b"><td class="mdescLeft"> </td><td class="mdescRight">Enables BLE Notifications and Indications for all relevant characteristics. <a href="#ga52ae472dcf995d2806e7eb190f4b214b">More...</a><br /></td></tr>
<tr class="separator:ga52ae472dcf995d2806e7eb190f4b214b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1d5259d0651474d18909eb2f5c24b36b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_myo_bridge_8h.html#aa37476b945410b138d2a66c88ededf26">MyoBridgeSignal</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__advanced__funcs.html#ga1d5259d0651474d18909eb2f5c24b36b">MyoBridge::disableAllMessages</a> ()</td></tr>
<tr class="memdesc:ga1d5259d0651474d18909eb2f5c24b36b"><td class="mdescLeft"> </td><td class="mdescRight">Disables BLE Notifications and Indications for all relevant characteristics. <a href="#ga1d5259d0651474d18909eb2f5c24b36b">More...</a><br /></td></tr>
<tr class="separator:ga1d5259d0651474d18909eb2f5c24b36b"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>These functions represent advanced functionality of the <a class="el" href="class_myo_bridge.html">MyoBridge</a> library and should only be used by users with knowledge about the Myo Bluetooth Protocol and the <a class="el" href="class_myo_bridge.html">MyoBridge</a> firmware. </p>
<p>Use the <a class="el" href="_myo_bridge_types_8h.html" title="Header file of MyoBridge Typedefs, Constants, Enums, Etc. for use with Arduino. ">MyoBridgeTypes.h</a> header for command types, Enumerations and constants you might want to use and also consider the <a class="el" href="class_myo_bridge.html">MyoBridge</a> and Myo Bluetooth Protocol documentations. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga1d5259d0651474d18909eb2f5c24b36b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_myo_bridge_8h.html#aa37476b945410b138d2a66c88ededf26">MyoBridgeSignal</a> MyoBridge::disableAllMessages </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Disables BLE Notifications and Indications for all relevant characteristics. </p>
<p>This includes IMU Data, IMU Events, Classifier Events, and EMG Data. </p>
</div>
</div>
<a class="anchor" id="ga52ae472dcf995d2806e7eb190f4b214b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_myo_bridge_8h.html#aa37476b945410b138d2a66c88ededf26">MyoBridgeSignal</a> MyoBridge::enableAllMessages </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables BLE Notifications and Indications for all relevant characteristics. </p>
<p>This includes IMU Data, IMU Events, Classifier Events, and EMG Data. </p>
</div>
</div>
<a class="anchor" id="ga38ee56d816b6016b2eefc3581c6eb1ee"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_myo_bridge_8h.html#aa37476b945410b138d2a66c88ededf26">MyoBridgeSignal</a> MyoBridge::sendCommand </td>
<td>(</td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>pData</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>send a command as defined in <a class="el" href="_myo_bridge_types_8h.html" title="Header file of MyoBridge Typedefs, Constants, Enums, Etc. for use with Arduino. ">MyoBridgeTypes.h</a> to the <a class="el" href="class_myo_bridge.html">MyoBridge</a>. </p>
</div>
</div>
<a class="anchor" id="ga69b60ac309ea1e0170484325d63a04a7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_myo_bridge_8h.html#aa37476b945410b138d2a66c88ededf26">MyoBridgeSignal</a> MyoBridge::sendConfirmedCommand </td>
<td>(</td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>pData</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sends a command and waits for write confirmation. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.10 </li>
</ul>
</div>
</body>
</html>