Skip to content

Commit

Permalink
MyoBridge Firmware now sends status updates periodically. Updated doc…
Browse files Browse the repository at this point in the history
…umentation.
  • Loading branch information
Valentin Roland committed Oct 1, 2015
1 parent 78c1211 commit d4fba5e
Show file tree
Hide file tree
Showing 119 changed files with 12,579 additions and 11,680 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -123,13 +123,40 @@
<tr class="memitem:a2bfc7d4d0031c6072a4b948650f032e0"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_myo_bridge_8cpp.html#a2bfc7d4d0031c6072a4b948650f032e0">myo_pose_strings</a> []</td></tr>
<tr class="memdesc:a2bfc7d4d0031c6072a4b948650f032e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Supported poses. <a href="#a2bfc7d4d0031c6072a4b948650f032e0">More...</a><br /></td></tr>
<tr class="separator:a2bfc7d4d0031c6072a4b948650f032e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2cee2fd79f21439b0a972372602f5374"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_myo_bridge_8cpp.html#a2cee2fd79f21439b0a972372602f5374">myo_connection_state_strings</a> []</td></tr>
<tr class="memdesc:a2cee2fd79f21439b0a972372602f5374"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connection States. <a href="#a2cee2fd79f21439b0a972372602f5374">More...</a><br /></td></tr>
<tr class="separator:a2cee2fd79f21439b0a972372602f5374"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Implementation file of the <a class="el" href="class_myo_bridge.html">MyoBridge</a> class. </p>
<dl class="section author"><dt>Author</dt><dd>Valentin Roland (webmaster at vroland.de) </dd></dl>
<dl class="section date"><dt>Date</dt><dd>September-October 2015 This file is part of the <a class="el" href="class_myo_bridge.html">MyoBridge</a> project. <a class="el" href="class_myo_bridge.html">MyoBridge</a> is a firmware for the CC2541/40 from Texas Instruments, particularly on the HM-11 BLE Module that comes with a high-level Arduino library. This file belongs to the Arduino library. It provides easy access to the basic functionality of <a class="el" href="class_myo_bridge.html">MyoBridge</a> and fast access to Myo Armband sensor data and events. Because the main focus is ease of use, this library may not cover all possible use cases of the <a class="el" href="class_myo_bridge.html">MyoBridge</a> Firmware and the Myo Armband itself.</dd></dl>
<p>This project is developed for research and educational purposes at Victoria University of Wellington, School of Engineering and Computer Science. </p>
</div><h2 class="groupheader">Variable Documentation</h2>
<a class="anchor" id="a2cee2fd79f21439b0a972372602f5374"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* myo_connection_state_strings[]</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">{</div>
<div class="line"> <span class="stringliteral">&quot;CONN_STATUS_UNKNOWN&quot;</span>,</div>
<div class="line"> <span class="stringliteral">&quot;CONN_STATUS_INIT&quot;</span>,</div>
<div class="line"> <span class="stringliteral">&quot;CONN_STATUS_SCANNING&quot;</span>,</div>
<div class="line"> <span class="stringliteral">&quot;CONN_STATUS_CONNECTING&quot;</span>,</div>
<div class="line"> <span class="stringliteral">&quot;CONN_STATUS_DISCOVERING&quot;</span>,</div>
<div class="line"> <span class="stringliteral">&quot;CONN_STATUS_BRIDGE_SETUP&quot;</span>,</div>
<div class="line"> <span class="stringliteral">&quot;CONN_STATUS_READY&quot;</span>,</div>
<div class="line"> <span class="stringliteral">&quot;CONN_STATUS_LOST&quot;</span>,</div>
<div class="line">}</div>
</div><!-- fragment -->
<p>Connection States. </p>

</div>
</div>
<a class="anchor" id="a2bfc7d4d0031c6072a4b948650f032e0"></a>
<div class="memitem">
<div class="memproto">
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
var _myo_bridge_8cpp =
[
[ "myo_connection_state_strings", "_myo_bridge_8cpp.html#a2cee2fd79f21439b0a972372602f5374", null ],
[ "myo_pose_strings", "_myo_bridge_8cpp.html#a2bfc7d4d0031c6072a4b948650f032e0", null ]
];
55 changes: 55 additions & 0 deletions Arduino/libraries/MyoBridge/Documentation/html/_myo_bridge_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;Arduino.h&quot;</code><br />
<code>#include &quot;<a class="el" href="myohw_8h_source.html">myohw.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_myo_bridge_types_8h_source.html">MyoBridgeTypes.h</a>&quot;</code><br />
</div>
<p><a href="_myo_bridge_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
Expand Down Expand Up @@ -189,6 +190,20 @@
}<tr class="memdesc:a8278027227ba7e129f30757d5ff5bff0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Supported IMU motion events. <a href="_myo_bridge_8h.html#a8278027227ba7e129f30757d5ff5bff0">More...</a><br /></td></tr>
<tr class="separator:a8278027227ba7e129f30757d5ff5bff0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</td></tr>
<tr class="memitem:aaf88bddfc01bb3cb9ccf3077b1da5522"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_myo_bridge_8h.html#aaf88bddfc01bb3cb9ccf3077b1da5522">MyoConnectionStatus</a> { <br />
&#160;&#160;<a class="el" href="_myo_bridge_8h.html#aaf88bddfc01bb3cb9ccf3077b1da5522a5f3761a8396f01bdcacb45623dba35ed">CONN_STATUS_UNKNOWN</a> = MYB_STATUS_UNKNOWN,
<a class="el" href="_myo_bridge_8h.html#aaf88bddfc01bb3cb9ccf3077b1da5522aab262cf8ca1185d9b87787073edf8698">CONN_STATUS_INIT</a> = MYB_STATUS_INIT,
<a class="el" href="_myo_bridge_8h.html#aaf88bddfc01bb3cb9ccf3077b1da5522a76269105343e89eb2c909f6ee1787034">CONN_STATUS_SCANNING</a> = MYB_STATUS_SCANNING,
<a class="el" href="_myo_bridge_8h.html#aaf88bddfc01bb3cb9ccf3077b1da5522a9202b0dc4e01744bc15da3014ece5f7a">CONN_STATUS_CONNECTING</a> = MYB_STATUS_CONNECTING,
<br />
&#160;&#160;<a class="el" href="_myo_bridge_8h.html#aaf88bddfc01bb3cb9ccf3077b1da5522afa77d63ef667572f6e0446d351f3b4c0">CONN_STATUS_DISCOVERING</a> = MYB_STATUS_DISCOVERING,
<a class="el" href="_myo_bridge_8h.html#aaf88bddfc01bb3cb9ccf3077b1da5522acab5545b433b7e2cecea8f36e4c60cd6">CONN_STATUS_BRIDGE_SETUP</a> = MYB_STATUS_DISCOVERING + 1,
<a class="el" href="_myo_bridge_8h.html#aaf88bddfc01bb3cb9ccf3077b1da5522a351770c387a9606bbde492f93eb795ec">CONN_STATUS_READY</a> = MYB_STATUS_DISCOVERING + 2,
<a class="el" href="_myo_bridge_8h.html#aaf88bddfc01bb3cb9ccf3077b1da5522a5dbc4ce1e19d36050d0bd19d1ee4e0fd">CONN_STATUS_LOST</a> = MYB_STATUS_DISCOVERING + 3
<br />
}<tr class="memdesc:aaf88bddfc01bb3cb9ccf3077b1da5522"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connection States. <a href="_myo_bridge_8h.html#aaf88bddfc01bb3cb9ccf3077b1da5522">More...</a><br /></td></tr>
<tr class="separator:aaf88bddfc01bb3cb9ccf3077b1da5522"><td class="memSeparator" colspan="2">&#160;</td></tr>
</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Header declaring the <a class="el" href="class_myo_bridge.html">MyoBridge</a> class with all necessary constants and types. </p>
Expand Down Expand Up @@ -284,6 +299,46 @@ <h2 class="groupheader">Enumeration Type Documentation</h2>
</td></tr>
</table>

</div>
</div>
<a class="anchor" id="aaf88bddfc01bb3cb9ccf3077b1da5522"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="_myo_bridge_8h.html#aaf88bddfc01bb3cb9ccf3077b1da5522">MyoConnectionStatus</a></td>
</tr>
</table>
</div><div class="memdoc">

<p>Connection States. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="aaf88bddfc01bb3cb9ccf3077b1da5522a5f3761a8396f01bdcacb45623dba35ed"></a>CONN_STATUS_UNKNOWN&#160;</td><td class="fielddoc">
<p>Status of the Bluetooth module is unknown. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="aaf88bddfc01bb3cb9ccf3077b1da5522aab262cf8ca1185d9b87787073edf8698"></a>CONN_STATUS_INIT&#160;</td><td class="fielddoc">
<p>The Bluetooth module is initializing. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="aaf88bddfc01bb3cb9ccf3077b1da5522a76269105343e89eb2c909f6ee1787034"></a>CONN_STATUS_SCANNING&#160;</td><td class="fielddoc">
<p>The Bluetooth module is scanning for the Myo. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="aaf88bddfc01bb3cb9ccf3077b1da5522a9202b0dc4e01744bc15da3014ece5f7a"></a>CONN_STATUS_CONNECTING&#160;</td><td class="fielddoc">
<p>The Bluetooth module is connecting to the Myo. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="aaf88bddfc01bb3cb9ccf3077b1da5522afa77d63ef667572f6e0446d351f3b4c0"></a>CONN_STATUS_DISCOVERING&#160;</td><td class="fielddoc">
<p>The Bluetooth module is discovering the Myo's Bluetooth LE profile. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="aaf88bddfc01bb3cb9ccf3077b1da5522acab5545b433b7e2cecea8f36e4c60cd6"></a>CONN_STATUS_BRIDGE_SETUP&#160;</td><td class="fielddoc">
<p><a class="el" href="class_myo_bridge.html">MyoBridge</a> sets up connection parameters and retrieves information. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="aaf88bddfc01bb3cb9ccf3077b1da5522a351770c387a9606bbde492f93eb795ec"></a>CONN_STATUS_READY&#160;</td><td class="fielddoc">
<p><a class="el" href="class_myo_bridge.html">MyoBridge</a> is ready to use! </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="aaf88bddfc01bb3cb9ccf3077b1da5522a5dbc4ce1e19d36050d0bd19d1ee4e0fd"></a>CONN_STATUS_LOST&#160;</td><td class="fielddoc">
<p><a class="el" href="class_myo_bridge.html">MyoBridge</a> lost the connection. You can't use this connection any more, unless you call begin() again. </p>
</td></tr>
</table>

</div>
</div>
<a class="anchor" id="ac6f991d21a293b773c554e8ad659885f"></a>
Expand Down
10 changes: 10 additions & 0 deletions Arduino/libraries/MyoBridge/Documentation/html/_myo_bridge_8h.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,16 @@ var _myo_bridge_8h =
[ "ERR_INVALID_PACKET", "_myo_bridge_8h.html#aa37476b945410b138d2a66c88ededf26a36e0745b01cab96525b0d51f9b7109ae", null ],
[ "ERR_NO_PACKET", "_myo_bridge_8h.html#aa37476b945410b138d2a66c88ededf26a2573d9bef98f9d6ddef12282caf0f81a", null ]
] ],
[ "MyoConnectionStatus", "_myo_bridge_8h.html#aaf88bddfc01bb3cb9ccf3077b1da5522", [
[ "CONN_STATUS_UNKNOWN", "_myo_bridge_8h.html#aaf88bddfc01bb3cb9ccf3077b1da5522a5f3761a8396f01bdcacb45623dba35ed", null ],
[ "CONN_STATUS_INIT", "_myo_bridge_8h.html#aaf88bddfc01bb3cb9ccf3077b1da5522aab262cf8ca1185d9b87787073edf8698", null ],
[ "CONN_STATUS_SCANNING", "_myo_bridge_8h.html#aaf88bddfc01bb3cb9ccf3077b1da5522a76269105343e89eb2c909f6ee1787034", null ],
[ "CONN_STATUS_CONNECTING", "_myo_bridge_8h.html#aaf88bddfc01bb3cb9ccf3077b1da5522a9202b0dc4e01744bc15da3014ece5f7a", null ],
[ "CONN_STATUS_DISCOVERING", "_myo_bridge_8h.html#aaf88bddfc01bb3cb9ccf3077b1da5522afa77d63ef667572f6e0446d351f3b4c0", null ],
[ "CONN_STATUS_BRIDGE_SETUP", "_myo_bridge_8h.html#aaf88bddfc01bb3cb9ccf3077b1da5522acab5545b433b7e2cecea8f36e4c60cd6", null ],
[ "CONN_STATUS_READY", "_myo_bridge_8h.html#aaf88bddfc01bb3cb9ccf3077b1da5522a351770c387a9606bbde492f93eb795ec", null ],
[ "CONN_STATUS_LOST", "_myo_bridge_8h.html#aaf88bddfc01bb3cb9ccf3077b1da5522a5dbc4ce1e19d36050d0bd19d1ee4e0fd", null ]
] ],
[ "MyoEMGMode", "_myo_bridge_8h.html#ac6f991d21a293b773c554e8ad659885f", [
[ "EMG_MODE_NONE", "_myo_bridge_8h.html#ac6f991d21a293b773c554e8ad659885fa150f89f9b7bdfa8b34b3e144adb6f6ef", null ],
[ "EMG_MODE_SEND", "_myo_bridge_8h.html#ac6f991d21a293b773c554e8ad659885faef9f5b238f86d1b034fe05b54d007a5b", null ],
Expand Down
Loading

0 comments on commit d4fba5e

Please sign in to comment.