specchioriflesso/USB_Host_Shield_2.0
1
Fork 0
mirror of https://github.com/felis/USB_Host_Shield_2.0.git synced 2024-03-22 11:31:26 +01:00
Code Issues Projects Releases Packages Wiki Activity
USB_Host_Shield_2.0/class_s_p_p.html
Lauszus d4710bb19d deploy: b435996557
2021-03-23 11:43:48 +00:00

629 lines
34 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>USB Host Shield 2.0: SPP Class Reference</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="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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="imageStyle.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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">USB Host Shield 2.0
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="class_s_p_p-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SPP Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_s_p_p_8h_source.html">SPP.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for SPP:</div>
<div class="dyncontent">
<div class="center"><img src="class_s_p_p__inherit__graph.png" border="0" usemap="#_s_p_p_inherit__map" alt="Inheritance graph"/></div>
<map name="_s_p_p_inherit__map" id="_s_p_p_inherit__map">
<area shape="rect" title=" " alt="" coords="111,80,158,107"/>
<area shape="rect" href="class_bluetooth_service.html" title=" " alt="" coords="5,5,139,32"/>
<area shape="rect" title=" " alt="" coords="163,5,232,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for SPP:</div>
<div class="dyncontent">
<div class="center"><img src="class_s_p_p__coll__graph.png" border="0" usemap="#_s_p_p_coll__map" alt="Collaboration graph"/></div>
<map name="_s_p_p_coll__map" id="_s_p_p_coll__map">
<area shape="rect" title=" " alt="" coords="344,336,391,363"/>
<area shape="rect" href="class_bluetooth_service.html" title=" " alt="" coords="207,260,341,287"/>
<area shape="rect" href="class_b_t_d.html" title=" " alt="" coords="249,171,299,197"/>
<area shape="rect" href="class_u_s_b_device_config.html" title=" " alt="" coords="5,81,140,108"/>
<area shape="rect" href="class_usb_config_xtracter.html" title=" " alt="" coords="164,81,304,108"/>
<area shape="rect" href="class_u_s_b.html" title=" " alt="" coords="328,81,377,108"/>
<area shape="rect" href="class_m_a_x3421e.html" title=" " alt="" coords="307,5,399,32"/>
<area shape="rect" href="struct_ep_info.html" title=" " alt="" coords="401,81,464,108"/>
<area shape="rect" title=" " alt="" coords="365,260,434,287"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6842e2b7f66024eecc151e3bdbfc7e94"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_p.html#a6842e2b7f66024eecc151e3bdbfc7e94">SPP</a> (<a class="el" href="class_b_t_d.html">BTD</a> *p, const char *name=&quot;Arduino&quot;, const char *pin=&quot;0000&quot;)</td></tr>
<tr class="separator:a6842e2b7f66024eecc151e3bdbfc7e94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac90f0765c478bd624cee3b8d493d8432"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_p.html#ac90f0765c478bd624cee3b8d493d8432">operator bool</a> ()</td></tr>
<tr class="separator:ac90f0765c478bd624cee3b8d493d8432"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Serial port profile (SPP) Print functions</div></td></tr>
<tr class="memitem:a731eb43856854b6a406e9cfa3f9e57a4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_p.html#a731eb43856854b6a406e9cfa3f9e57a4">available</a> (void)</td></tr>
<tr class="separator:a731eb43856854b6a406e9cfa3f9e57a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a235d75f40a32a5905fd8fedcc37aa350"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_p.html#a235d75f40a32a5905fd8fedcc37aa350">flush</a> (void)</td></tr>
<tr class="separator:a235d75f40a32a5905fd8fedcc37aa350"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3149d75ba4646ba5b5428c465e983144"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_p.html#a3149d75ba4646ba5b5428c465e983144">peek</a> (void)</td></tr>
<tr class="separator:a3149d75ba4646ba5b5428c465e983144"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae8dc037e845480f582afea57b858b95"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_p.html#aae8dc037e845480f582afea57b858b95">read</a> (void)</td></tr>
<tr class="separator:aae8dc037e845480f582afea57b858b95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fb231316ca9b1028322d2d2188b27b0"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_p.html#a6fb231316ca9b1028322d2d2188b27b0">write</a> (uint8_t data)</td></tr>
<tr class="separator:a6fb231316ca9b1028322d2d2188b27b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8bb421b7d948c3ffefc23aef95813192"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_p.html#a8bb421b7d948c3ffefc23aef95813192">write</a> (const uint8_t *data, size_t size)</td></tr>
<tr class="separator:a8bb421b7d948c3ffefc23aef95813192"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ca8c34757efb43a449cf8b3c7672e23"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_p.html#a4ca8c34757efb43a449cf8b3c7672e23">discard</a> (void)</td></tr>
<tr class="separator:a4ca8c34757efb43a449cf8b3c7672e23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6c20e303965056403ae5aef1d228858"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_p.html#ab6c20e303965056403ae5aef1d228858">send</a> (void)</td></tr>
<tr class="separator:ab6c20e303965056403ae5aef1d228858"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_bluetooth_service"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_bluetooth_service')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_bluetooth_service.html">BluetoothService</a></td></tr>
<tr class="memitem:a410c7df1e49328de23a89921c89f9573 inherit pub_methods_class_bluetooth_service"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bluetooth_service.html#a410c7df1e49328de23a89921c89f9573">BluetoothService</a> (<a class="el" href="class_b_t_d.html">BTD</a> *p)</td></tr>
<tr class="separator:a410c7df1e49328de23a89921c89f9573 inherit pub_methods_class_bluetooth_service"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a488e219cf0a90d39e643615b1f12e91f inherit pub_methods_class_bluetooth_service"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bluetooth_service.html#a488e219cf0a90d39e643615b1f12e91f">attachOnInit</a> (void(*funcOnInit)(void))</td></tr>
<tr class="separator:a488e219cf0a90d39e643615b1f12e91f inherit pub_methods_class_bluetooth_service"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ade5d4f0ab50ddcad14f75fce4450a028"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_p.html#ade5d4f0ab50ddcad14f75fce4450a028">connected</a></td></tr>
<tr class="separator:ade5d4f0ab50ddcad14f75fce4450a028"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
BluetoothService implementation</h2></td></tr>
<tr class="memitem:a2b4b1f85f553c6a2fdd523e50c75c7b0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_p.html#a2b4b1f85f553c6a2fdd523e50c75c7b0">disconnect</a> ()</td></tr>
<tr class="separator:a2b4b1f85f553c6a2fdd523e50c75c7b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abdfe9453fb82781bec53a191c2e9fb1d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_p.html#abdfe9453fb82781bec53a191c2e9fb1d">ACLData</a> (uint8_t *ACLData)</td></tr>
<tr class="separator:abdfe9453fb82781bec53a191c2e9fb1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2de67ee7ad1be9d2f3daf7dc08dc5f90"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_p.html#a2de67ee7ad1be9d2f3daf7dc08dc5f90">Run</a> ()</td></tr>
<tr class="separator:a2de67ee7ad1be9d2f3daf7dc08dc5f90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2c661bd46cd2d74bd29c4c771cd2ef0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_p.html#ae2c661bd46cd2d74bd29c4c771cd2ef0">Reset</a> ()</td></tr>
<tr class="separator:ae2c661bd46cd2d74bd29c4c771cd2ef0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8355e2e1423e4986536e65c375bcb1e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_p.html#af8355e2e1423e4986536e65c375bcb1e">onInit</a> ()</td></tr>
<tr class="separator:af8355e2e1423e4986536e65c375bcb1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_class_bluetooth_service"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_bluetooth_service')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_bluetooth_service.html">BluetoothService</a></td></tr>
<tr class="memitem:a2a3674a4bb5d409840995eabe07049bd inherit pro_methods_class_bluetooth_service"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bluetooth_service.html#a2a3674a4bb5d409840995eabe07049bd">checkHciHandle</a> (uint8_t *buf, uint16_t handle)</td></tr>
<tr class="separator:a2a3674a4bb5d409840995eabe07049bd inherit pro_methods_class_bluetooth_service"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_class_bluetooth_service"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_bluetooth_service')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_bluetooth_service.html">BluetoothService</a></td></tr>
<tr class="memitem:a321393d44ce59213fa1c7498c247d5ff inherit pro_attribs_class_bluetooth_service"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bluetooth_service.html#a321393d44ce59213fa1c7498c247d5ff">pFuncOnInit</a> )(void)</td></tr>
<tr class="separator:a321393d44ce59213fa1c7498c247d5ff inherit pro_attribs_class_bluetooth_service"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa67faf901f78a55a202945a20f6d778a inherit pro_attribs_class_bluetooth_service"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_b_t_d.html">BTD</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bluetooth_service.html#aa67faf901f78a55a202945a20f6d778a">pBtd</a></td></tr>
<tr class="separator:aa67faf901f78a55a202945a20f6d778a inherit pro_attribs_class_bluetooth_service"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67b1db67c05d0bbdcd9c992135455437 inherit pro_attribs_class_bluetooth_service"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bluetooth_service.html#a67b1db67c05d0bbdcd9c992135455437">hci_handle</a></td></tr>
<tr class="separator:a67b1db67c05d0bbdcd9c992135455437 inherit pro_attribs_class_bluetooth_service"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78a1a893ec9c2db32e42bc2271c4a4f2 inherit pro_attribs_class_bluetooth_service"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bluetooth_service.html#a78a1a893ec9c2db32e42bc2271c4a4f2">l2cap_event_flag</a></td></tr>
<tr class="separator:a78a1a893ec9c2db32e42bc2271c4a4f2 inherit pro_attribs_class_bluetooth_service"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad643db609c7e2e3fae8904dbc7991262 inherit pro_attribs_class_bluetooth_service"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bluetooth_service.html#ad643db609c7e2e3fae8904dbc7991262">identifier</a></td></tr>
<tr class="separator:ad643db609c7e2e3fae8904dbc7991262 inherit pro_attribs_class_bluetooth_service"><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>This <a class="el" href="class_bluetooth_service.html">BluetoothService</a> class implements the Serial Port Protocol (<a class="el" href="class_s_p_p.html">SPP</a>). It inherits the Arduino Stream class. This allows it to use all the standard Arduino print and stream functions. </p>
<p class="definition">Definition at line <a class="el" href="_s_p_p_8h_source.html#l00055">55</a> of file <a class="el" href="_s_p_p_8h_source.html">SPP.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a6842e2b7f66024eecc151e3bdbfc7e94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6842e2b7f66024eecc151e3bdbfc7e94">&#9670;&nbsp;</a></span>SPP()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPP::SPP </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_b_t_d.html">BTD</a> *&#160;</td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em> = <code>&quot;Arduino&quot;</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>pin</em> = <code>&quot;0000&quot;</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for the <a class="el" href="class_s_p_p.html">SPP</a> class. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>Pointer to <a class="el" href="class_b_t_d.html">BTD</a> class instance. </td></tr>
<tr><td class="paramname">name</td><td>Set the name to <a class="el" href="class_b_t_d.html#a0359c0c158c864c27319810cbd1534f9">BTD::btdName</a>. If argument is omitted, then "Arduino" will be used. </td></tr>
<tr><td class="paramname">pin</td><td>Write the pin to <a class="el" href="class_b_t_d.html#a215cb939c01ed3ff56db37841224546c">BTD::btdPin</a>. If argument is omitted, then "0000" will be used. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_s_p_p_8cpp_source.html#l00045">45</a> of file <a class="el" href="_s_p_p_8cpp_source.html">SPP.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2b4b1f85f553c6a2fdd523e50c75c7b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b4b1f85f553c6a2fdd523e50c75c7b0">&#9670;&nbsp;</a></span>disconnect()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SPP::disconnect </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used this to disconnect the virtual serial port. </p>
<p>Implements <a class="el" href="class_bluetooth_service.html#a7bb2c8cccf3f2931629ead9becc51ec9">BluetoothService</a>.</p>
<p class="definition">Definition at line <a class="el" href="_s_p_p_8cpp_source.html#l00072">72</a> of file <a class="el" href="_s_p_p_8cpp_source.html">SPP.cpp</a>.</p>
</div>
</div>
<a id="ac90f0765c478bd624cee3b8d493d8432"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac90f0765c478bd624cee3b8d493d8432">&#9670;&nbsp;</a></span>operator bool()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">SPP::operator bool </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to provide Boolean tests for the class. </p><dl class="section return"><dt>Returns</dt><dd>Return true if <a class="el" href="class_s_p_p.html">SPP</a> communication is connected. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_s_p_p_8h_source.html#l00074">74</a> of file <a class="el" href="_s_p_p_8h_source.html">SPP.h</a>.</p>
</div>
</div>
<a id="a731eb43856854b6a406e9cfa3f9e57a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a731eb43856854b6a406e9cfa3f9e57a4">&#9670;&nbsp;</a></span>available()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int SPP::available </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get number of bytes waiting to be read. </p><dl class="section return"><dt>Returns</dt><dd>Return the number of bytes ready to be read. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_s_p_p_8cpp_source.html#l00797">797</a> of file <a class="el" href="_s_p_p_8cpp_source.html">SPP.cpp</a>.</p>
</div>
</div>
<a id="a235d75f40a32a5905fd8fedcc37aa350"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a235d75f40a32a5905fd8fedcc37aa350">&#9670;&nbsp;</a></span>flush()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SPP::flush </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Send out all bytes in the buffer. </p>
<p class="definition">Definition at line <a class="el" href="_s_p_p_8h_source.html#l00088">88</a> of file <a class="el" href="_s_p_p_8h_source.html">SPP.h</a>.</p>
</div>
</div>
<a id="a3149d75ba4646ba5b5428c465e983144"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3149d75ba4646ba5b5428c465e983144">&#9670;&nbsp;</a></span>peek()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int SPP::peek </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to read the next value in the buffer without advancing to the next one. </p><dl class="section return"><dt>Returns</dt><dd>Return the byte. Will return -1 if no bytes are available. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_s_p_p_8cpp_source.html#l00805">805</a> of file <a class="el" href="_s_p_p_8cpp_source.html">SPP.cpp</a>.</p>
</div>
</div>
<a id="aae8dc037e845480f582afea57b858b95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae8dc037e845480f582afea57b858b95">&#9670;&nbsp;</a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int SPP::read </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to read the buffer. </p><dl class="section return"><dt>Returns</dt><dd>Return the byte. Will return -1 if no bytes are available. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_s_p_p_8cpp_source.html#l00811">811</a> of file <a class="el" href="_s_p_p_8cpp_source.html">SPP.cpp</a>.</p>
</div>
</div>
<a id="a6fb231316ca9b1028322d2d2188b27b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6fb231316ca9b1028322d2d2188b27b0">&#9670;&nbsp;</a></span>write() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t SPP::write </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes the byte to send to a buffer. The message is send when either <a class="el" href="class_s_p_p.html#ab6c20e303965056403ae5aef1d228858">send()</a> or after Usb.Task() is called. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>The byte to write. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Return the number of bytes written. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_s_p_p_8cpp_source.html#l00742">742</a> of file <a class="el" href="_s_p_p_8cpp_source.html">SPP.cpp</a>.</p>
</div>
</div>
<a id="a8bb421b7d948c3ffefc23aef95813192"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8bb421b7d948c3ffefc23aef95813192">&#9670;&nbsp;</a></span>write() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t SPP::write </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes the bytes to send to a buffer. The message is send when either <a class="el" href="class_s_p_p.html#ab6c20e303965056403ae5aef1d228858">send()</a> or after Usb.Task() is called. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>The data array to send. </td></tr>
<tr><td class="paramname">size</td><td>Size of the data. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Return the number of bytes written. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_s_p_p_8cpp_source.html#l00754">754</a> of file <a class="el" href="_s_p_p_8cpp_source.html">SPP.cpp</a>.</p>
</div>
</div>
<a id="a4ca8c34757efb43a449cf8b3c7672e23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ca8c34757efb43a449cf8b3c7672e23">&#9670;&nbsp;</a></span>discard()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SPP::discard </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Discard all the bytes in the buffer. </p>
<p class="definition">Definition at line <a class="el" href="_s_p_p_8cpp_source.html#l00801">801</a> of file <a class="el" href="_s_p_p_8cpp_source.html">SPP.cpp</a>.</p>
</div>
</div>
<a id="ab6c20e303965056403ae5aef1d228858"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6c20e303965056403ae5aef1d228858">&#9670;&nbsp;</a></span>send()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SPP::send </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This will send all the bytes in the buffer. This is called whenever Usb.Task() is called, but can also be called via this function. </p>
<p class="definition">Definition at line <a class="el" href="_s_p_p_8cpp_source.html#l00769">769</a> of file <a class="el" href="_s_p_p_8cpp_source.html">SPP.cpp</a>.</p>
</div>
</div>
<a id="abdfe9453fb82781bec53a191c2e9fb1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdfe9453fb82781bec53a191c2e9fb1d">&#9670;&nbsp;</a></span>ACLData()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SPP::ACLData </td>
<td>(</td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>ACLData</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to pass acldata to the services. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ACLData</td><td>Incoming acldata. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="class_bluetooth_service.html#a9740e997198485c9629a146a9c981043">BluetoothService</a>.</p>
<p class="definition">Definition at line <a class="el" href="_s_p_p_8cpp_source.html#l00084">84</a> of file <a class="el" href="_s_p_p_8cpp_source.html">SPP.cpp</a>.</p>
</div>
</div>
<a id="a2de67ee7ad1be9d2f3daf7dc08dc5f90"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2de67ee7ad1be9d2f3daf7dc08dc5f90">&#9670;&nbsp;</a></span>Run()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SPP::Run </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to establish the connection automatically. </p>
<p>Implements <a class="el" href="class_bluetooth_service.html#a16df27af39d09963cf0d43910d92ff4c">BluetoothService</a>.</p>
<p class="definition">Definition at line <a class="el" href="_s_p_p_8cpp_source.html#l00423">423</a> of file <a class="el" href="_s_p_p_8cpp_source.html">SPP.cpp</a>.</p>
</div>
</div>
<a id="ae2c661bd46cd2d74bd29c4c771cd2ef0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2c661bd46cd2d74bd29c4c771cd2ef0">&#9670;&nbsp;</a></span>Reset()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SPP::Reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Use this to reset the service. </p>
<p>Implements <a class="el" href="class_bluetooth_service.html#aa7c81841d4e898e9dc91533da6d7ab64">BluetoothService</a>.</p>
<p class="definition">Definition at line <a class="el" href="_s_p_p_8cpp_source.html#l00060">60</a> of file <a class="el" href="_s_p_p_8cpp_source.html">SPP.cpp</a>.</p>
</div>
</div>
<a id="af8355e2e1423e4986536e65c375bcb1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8355e2e1423e4986536e65c375bcb1e">&#9670;&nbsp;</a></span>onInit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SPP::onInit </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when a device is successfully initialized. Use attachOnInit(void (*funcOnInit)(void)) to call your own function. This is useful for instance if you want to set the LEDs in a specific way. </p>
<p>Implements <a class="el" href="class_bluetooth_service.html#a34d08d56c560c892c9684133f69b971b">BluetoothService</a>.</p>
<p class="definition">Definition at line <a class="el" href="_s_p_p_8cpp_source.html#l00433">433</a> of file <a class="el" href="_s_p_p_8cpp_source.html">SPP.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ade5d4f0ab50ddcad14f75fce4450a028"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade5d4f0ab50ddcad14f75fce4450a028">&#9670;&nbsp;</a></span>connected</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool SPP::connected</td>
</tr>
</table>
</div><div class="memdoc">
<p>Variable used to indicate if the connection is established. </p>
<p class="definition">Definition at line <a class="el" href="_s_p_p_8h_source.html#l00078">78</a> of file <a class="el" href="_s_p_p_8h_source.html">SPP.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_s_p_p_8h_source.html">SPP.h</a></li>
<li><a class="el" href="_s_p_p_8cpp_source.html">SPP.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink