ScStw/esp-nimble-cpp
2
0
Fork 0
mirror of https://github.com/h2zero/esp-nimble-cpp.git synced 2024-12-25 04:00:46 +01:00
Code Issues Projects Releases Packages Wiki Activity
esp-nimble-cpp/_nim_b_l_e_utils_8h_source.html
h2zero 887379cd3f deploy: da48844e2f
2024-12-22 00:10:12 +00:00

177 lines
18 KiB
HTML
Raw Permalink 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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>esp-nimble-cpp: /github/workspace/src/NimBLEUtils.h Source File</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>
<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" />
</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 id="projectrow">
<td id="projectalign">
<div id="projectname">esp-nimble-cpp<span id="projectnumber">&#160;2.0.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
</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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('_nim_b_l_e_utils_8h_source.html',''); initResizable(); });
/* @license-end */
</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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">NimBLEUtils.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Copyright 2020-2024 Ryan Powell &lt;ryan@nable-embedded.io&gt; and</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * esp-nimble-cpp, NimBLE-Arduino contributors.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * you may not use this file except in compliance with the License.</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * You may obtain a copy of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * limitations under the License.</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#ifndef NIMBLE_CPP_UTILS_H_</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#define NIMBLE_CPP_UTILS_H_</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include &quot;<a class="code" href="nimconfig_8h.html">nimconfig.h</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor"># include &lt;string&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_address.html">NimBLEAddress</a>;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="foldopen" id="foldopen00032" data-start="{" data-end="};">
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="struct_nim_b_l_e_task_data.html"> 32</a></span><span class="keyword">struct </span><a class="code hl_struct" href="struct_nim_b_l_e_task_data.html">NimBLETaskData</a> {</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <a class="code hl_struct" href="struct_nim_b_l_e_task_data.html">NimBLETaskData</a>(<span class="keywordtype">void</span>* pInstance = <span class="keyword">nullptr</span>, <span class="keywordtype">int</span> flags = 0, <span class="keywordtype">void</span>* buf = <span class="keyword">nullptr</span>);</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <a class="code hl_function" href="struct_nim_b_l_e_task_data.html#af2d5d10d7cc8801cf4d001f89bf301c6">~NimBLETaskData</a>();</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">void</span>* m_pInstance{<span class="keyword">nullptr</span>};</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">mutable</span> <span class="keywordtype">int</span> m_flags{0};</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">void</span>* m_pBuf{<span class="keyword">nullptr</span>};</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">mutable</span> <span class="keywordtype">void</span>* m_pHandle{<span class="keyword">nullptr</span>}; <span class="comment">// semaphore or task handle</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_utils.html">NimBLEUtils</a>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span>};</div>
</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="foldopen" id="foldopen00047" data-start="{" data-end="};">
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_utils.html"> 47</a></span><span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_utils.html">NimBLEUtils</a> {</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_function" href="class_nim_b_l_e_utils.html#afb2df39418324f93a2477e314883ccae">gapEventToString</a>(uint8_t eventType);</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">static</span> std::string <a class="code hl_function" href="class_nim_b_l_e_utils.html#a53f0b19687b0706ec48d6b630e209acb">dataToHexString</a>(<span class="keyword">const</span> uint8_t* source, uint8_t length);</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_function" href="class_nim_b_l_e_utils.html#a6de9354eeba9f126aa14cfa7ed43cda4">advTypeToString</a>(uint8_t advType);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_function" href="class_nim_b_l_e_utils.html#a9885eda5c51477aefc0ba9e1c96d5a34">returnCodeToString</a>(<span class="keywordtype">int</span> rc);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">static</span> <a class="code hl_class" href="class_nim_b_l_e_address.html">NimBLEAddress</a> <a class="code hl_function" href="class_nim_b_l_e_utils.html#a6d47cf1adecd01d0102e0feec8232538">generateAddr</a>(<span class="keywordtype">bool</span> nrpa);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_utils.html#a6b3a170f26ce51f353ff960f59739181">taskWait</a>(<span class="keyword">const</span> <a class="code hl_struct" href="struct_nim_b_l_e_task_data.html">NimBLETaskData</a>&amp; taskData, uint32_t timeout);</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_utils.html#a7b2de1e3827f9f6750550623dc6d9288">taskRelease</a>(<span class="keyword">const</span> <a class="code hl_struct" href="struct_nim_b_l_e_task_data.html">NimBLETaskData</a>&amp; taskData, <span class="keywordtype">int</span> rc = 0);</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span>};</div>
</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="preprocessor">#endif </span><span class="comment">// CONFIG_BT_ENABLED</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="preprocessor">#endif </span><span class="comment">// NIMBLE_CPP_UTILS_H_</span></div>
<div class="ttc" id="aclass_nim_b_l_e_address_html"><div class="ttname"><a href="class_nim_b_l_e_address.html">NimBLEAddress</a></div><div class="ttdoc">A BLE device address.</div><div class="ttdef"><b>Definition</b> NimBLEAddress.h:41</div></div>
<div class="ttc" id="aclass_nim_b_l_e_utils_html"><div class="ttname"><a href="class_nim_b_l_e_utils.html">NimBLEUtils</a></div><div class="ttdoc">A BLE Utility class with methods for debugging and general purpose use.</div><div class="ttdef"><b>Definition</b> NimBLEUtils.h:47</div></div>
<div class="ttc" id="aclass_nim_b_l_e_utils_html_a53f0b19687b0706ec48d6b630e209acb"><div class="ttname"><a href="class_nim_b_l_e_utils.html#a53f0b19687b0706ec48d6b630e209acb">NimBLEUtils::dataToHexString</a></div><div class="ttdeci">static std::string dataToHexString(const uint8_t *source, uint8_t length)</div><div class="ttdoc">Create a hexadecimal string representation of the input data.</div><div class="ttdef"><b>Definition</b> NimBLEUtils.cpp:546</div></div>
<div class="ttc" id="aclass_nim_b_l_e_utils_html_a6b3a170f26ce51f353ff960f59739181"><div class="ttname"><a href="class_nim_b_l_e_utils.html#a6b3a170f26ce51f353ff960f59739181">NimBLEUtils::taskWait</a></div><div class="ttdeci">static bool taskWait(const NimBLETaskData &amp;taskData, uint32_t timeout)</div><div class="ttdoc">Blocks the calling task until released or timeout.</div><div class="ttdef"><b>Definition</b> NimBLEUtils.cpp:90</div></div>
<div class="ttc" id="aclass_nim_b_l_e_utils_html_a6d47cf1adecd01d0102e0feec8232538"><div class="ttname"><a href="class_nim_b_l_e_utils.html#a6d47cf1adecd01d0102e0feec8232538">NimBLEUtils::generateAddr</a></div><div class="ttdeci">static NimBLEAddress generateAddr(bool nrpa)</div><div class="ttdoc">Generate a random BLE address.</div><div class="ttdef"><b>Definition</b> NimBLEUtils.cpp:565</div></div>
<div class="ttc" id="aclass_nim_b_l_e_utils_html_a6de9354eeba9f126aa14cfa7ed43cda4"><div class="ttname"><a href="class_nim_b_l_e_utils.html#a6de9354eeba9f126aa14cfa7ed43cda4">NimBLEUtils::advTypeToString</a></div><div class="ttdeci">static const char * advTypeToString(uint8_t advType)</div><div class="ttdoc">Convert the advertising type flag to a string.</div><div class="ttdef"><b>Definition</b> NimBLEUtils.cpp:428</div></div>
<div class="ttc" id="aclass_nim_b_l_e_utils_html_a7b2de1e3827f9f6750550623dc6d9288"><div class="ttname"><a href="class_nim_b_l_e_utils.html#a7b2de1e3827f9f6750550623dc6d9288">NimBLEUtils::taskRelease</a></div><div class="ttdeci">static void taskRelease(const NimBLETaskData &amp;taskData, int rc=0)</div><div class="ttdoc">Release a task.</div><div class="ttdef"><b>Definition</b> NimBLEUtils.cpp:117</div></div>
<div class="ttc" id="aclass_nim_b_l_e_utils_html_a9885eda5c51477aefc0ba9e1c96d5a34"><div class="ttname"><a href="class_nim_b_l_e_utils.html#a9885eda5c51477aefc0ba9e1c96d5a34">NimBLEUtils::returnCodeToString</a></div><div class="ttdeci">static const char * returnCodeToString(int rc)</div><div class="ttdoc">Converts a return code from the NimBLE stack to a text string.</div><div class="ttdef"><b>Definition</b> NimBLEUtils.cpp:133</div></div>
<div class="ttc" id="aclass_nim_b_l_e_utils_html_afb2df39418324f93a2477e314883ccae"><div class="ttname"><a href="class_nim_b_l_e_utils.html#afb2df39418324f93a2477e314883ccae">NimBLEUtils::gapEventToString</a></div><div class="ttdeci">static const char * gapEventToString(uint8_t eventType)</div><div class="ttdoc">Convert a GAP event type to a string representation.</div><div class="ttdef"><b>Definition</b> NimBLEUtils.cpp:455</div></div>
<div class="ttc" id="animconfig_8h_html"><div class="ttname"><a href="nimconfig_8h.html">nimconfig.h</a></div></div>
<div class="ttc" id="astruct_nim_b_l_e_task_data_html"><div class="ttname"><a href="struct_nim_b_l_e_task_data.html">NimBLETaskData</a></div><div class="ttdoc">A structure to hold data for a task that is waiting for a response.</div><div class="ttdef"><b>Definition</b> NimBLEUtils.h:32</div></div>
<div class="ttc" id="astruct_nim_b_l_e_task_data_html_af2d5d10d7cc8801cf4d001f89bf301c6"><div class="ttname"><a href="struct_nim_b_l_e_task_data.html#af2d5d10d7cc8801cf4d001f89bf301c6">NimBLETaskData::~NimBLETaskData</a></div><div class="ttdeci">~NimBLETaskData()</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition</b> NimBLEUtils.cpp:75</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><b>NimBLEUtils.h</b></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink