forked from h2zero/esp-nimble-cpp
v1.3.2
This commit is contained in:
1 parent
c51c0f2cf5
commit
6ae5666f7a
259 files changed
+4332
-4672
No files matched your search
@@ -3,9 +3,9 @@
|
||||
<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.9.0"/>
|
||||
<meta name="generator" content="Doxygen 1.9.1"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>esp-nimble-cpp / NimBLE-Arduino: src/NimBLEUtils.h Source File</title>
|
||||
<title>esp-nimble-cpp: K:/Users/Ryan/Desktop/thermo-git/components/esp-nimble-cpp/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>
|
||||
@@ -25,8 +25,8 @@
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
|
||||
 <span id="projectnumber">1.3.1</span>
|
||||
<div id="projectname">esp-nimble-cpp
|
||||
 <span id="projectnumber">1.3.2</span>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -34,7 +34,7 @@
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.9.0 -->
|
||||
<!-- Generated by Doxygen 1.9.1 -->
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
||||
@@ -96,53 +96,59 @@ $(document).ready(function(){initNavTree('_nim_b_l_e_utils_8h_source.html','');
|
||||
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div>
|
||||
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#ifndef COMPONENTS_NIMBLEUTILS_H_</span></div>
|
||||
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define COMPONENTS_NIMBLEUTILS_H_</span></div>
|
||||
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "sdkconfig.h"</span></div>
|
||||
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
|
||||
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  </div>
|
||||
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "host/ble_gap.h"</span></div>
|
||||
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  </div>
|
||||
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">/**** FIX COMPILATION ****/</span></div>
|
||||
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#undef min</span></div>
|
||||
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#undef max</span></div>
|
||||
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">/**************************/</span></div>
|
||||
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div>
|
||||
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "<a class="code" href="nimconfig_8h.html">nimconfig.h</a>"</span></div>
|
||||
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
|
||||
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  </div>
|
||||
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#if defined(CONFIG_NIMBLE_CPP_IDF)</span></div>
|
||||
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include "host/ble_gap.h"</span></div>
|
||||
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#else</span></div>
|
||||
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "nimble/nimble/host/include/host/ble_gap.h"</span></div>
|
||||
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
|
||||
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <string></span></div>
|
||||
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
||||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
|
||||
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keywordtype">void</span> *pATT;</div>
|
||||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  TaskHandle_t task;</div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keywordtype">int</span> rc;</div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  std::string *buf;</div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> } ble_task_data_t;</div>
|
||||
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
|
||||
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
|
||||
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_utils.html"> 34</a></span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_utils.html">NimBLEUtils</a> {</div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">public</span>:</div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_utils.html#a27df310308e72c477a3fda7a65806e01">dumpGapEvent</a>(ble_gap_event *event, <span class="keywordtype">void</span> *arg);</div>
|
||||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="class_nim_b_l_e_utils.html#afb2df39418324f93a2477e314883ccae">gapEventToString</a>(uint8_t eventType);</div>
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">static</span> <span class="keywordtype">char</span>* <a class="code" href="class_nim_b_l_e_utils.html#a6382edb7e8e4030b4fc65d463fa2a886">buildHexData</a>(uint8_t* target, <span class="keyword">const</span> uint8_t* source, uint8_t length);</div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="class_nim_b_l_e_utils.html#a6de9354eeba9f126aa14cfa7ed43cda4">advTypeToString</a>(uint8_t advType);</div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="class_nim_b_l_e_utils.html#a9885eda5c51477aefc0ba9e1c96d5a34">returnCodeToString</a>(<span class="keywordtype">int</span> rc);</div>
|
||||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="class_nim_b_l_e_utils.html#ae521f9a6363c03e42da2f76f64ea431e">checkConnParams</a>(ble_gap_conn_params* params);</div>
|
||||
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> };</div>
|
||||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
|
||||
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
|
||||
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#endif </span><span class="comment">// CONFIG_BT_ENABLED</span></div>
|
||||
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#endif </span><span class="comment">// COMPONENTS_NIMBLEUTILS_H_</span></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:34</div></div>
|
||||
<div class="ttc" id="aclass_nim_b_l_e_utils_html_a27df310308e72c477a3fda7a65806e01"><div class="ttname"><a href="class_nim_b_l_e_utils.html#a27df310308e72c477a3fda7a65806e01">NimBLEUtils::dumpGapEvent</a></div><div class="ttdeci">static void dumpGapEvent(ble_gap_event *event, void *arg)</div><div class="ttdoc">Utility function to log the gap event info.</div><div class="ttdef"><b>Definition:</b> NimBLEUtils.cpp:418</div></div>
|
||||
<div class="ttc" id="aclass_nim_b_l_e_utils_html_a6382edb7e8e4030b4fc65d463fa2a886"><div class="ttname"><a href="class_nim_b_l_e_utils.html#a6382edb7e8e4030b4fc65d463fa2a886">NimBLEUtils::buildHexData</a></div><div class="ttdeci">static char * buildHexData(uint8_t *target, const uint8_t *source, uint8_t length)</div><div class="ttdoc">Create a hex representation of data.</div><div class="ttdef"><b>Definition:</b> NimBLEUtils.cpp:385</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:355</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:62</div></div>
|
||||
<div class="ttc" id="aclass_nim_b_l_e_utils_html_ae521f9a6363c03e42da2f76f64ea431e"><div class="ttname"><a href="class_nim_b_l_e_utils.html#ae521f9a6363c03e42da2f76f64ea431e">NimBLEUtils::checkConnParams</a></div><div class="ttdeci">static int checkConnParams(ble_gap_conn_params *params)</div><div class="ttdoc">A function for checking validity of connection parameters.</div><div class="ttdef"><b>Definition:</b> NimBLEUtils.cpp:24</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:430</div></div>
|
||||
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">/**** FIX COMPILATION ****/</span></div>
|
||||
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#undef min</span></div>
|
||||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#undef max</span></div>
|
||||
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">/**************************/</span></div>
|
||||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <string></span></div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
|
||||
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordtype">void</span> *pATT;</div>
|
||||
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  TaskHandle_t task;</div>
|
||||
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordtype">int</span> rc;</div>
|
||||
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  std::string *buf;</div>
|
||||
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> } ble_task_data_t;</div>
|
||||
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_utils.html"> 39</a></span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_utils.html">NimBLEUtils</a> {</div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">public</span>:</div>
|
||||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_utils.html#a27df310308e72c477a3fda7a65806e01">dumpGapEvent</a>(ble_gap_event *event, <span class="keywordtype">void</span> *arg);</div>
|
||||
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="class_nim_b_l_e_utils.html#afb2df39418324f93a2477e314883ccae">gapEventToString</a>(uint8_t eventType);</div>
|
||||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">static</span> <span class="keywordtype">char</span>* <a class="code" href="class_nim_b_l_e_utils.html#a6382edb7e8e4030b4fc65d463fa2a886">buildHexData</a>(uint8_t* target, <span class="keyword">const</span> uint8_t* source, uint8_t length);</div>
|
||||
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="class_nim_b_l_e_utils.html#a6de9354eeba9f126aa14cfa7ed43cda4">advTypeToString</a>(uint8_t advType);</div>
|
||||
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="class_nim_b_l_e_utils.html#a9885eda5c51477aefc0ba9e1c96d5a34">returnCodeToString</a>(<span class="keywordtype">int</span> rc);</div>
|
||||
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="class_nim_b_l_e_utils.html#ae521f9a6363c03e42da2f76f64ea431e">checkConnParams</a>(ble_gap_conn_params* params);</div>
|
||||
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> };</div>
|
||||
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
|
||||
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
|
||||
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#endif </span><span class="comment">// CONFIG_BT_ENABLED</span></div>
|
||||
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#endif </span><span class="comment">// COMPONENTS_NIMBLEUTILS_H_</span></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:39</div></div>
|
||||
<div class="ttc" id="aclass_nim_b_l_e_utils_html_a27df310308e72c477a3fda7a65806e01"><div class="ttname"><a href="class_nim_b_l_e_utils.html#a27df310308e72c477a3fda7a65806e01">NimBLEUtils::dumpGapEvent</a></div><div class="ttdeci">static void dumpGapEvent(ble_gap_event *event, void *arg)</div><div class="ttdoc">Utility function to log the gap event info.</div><div class="ttdef"><b>Definition:</b> NimBLEUtils.cpp:421</div></div>
|
||||
<div class="ttc" id="aclass_nim_b_l_e_utils_html_a6382edb7e8e4030b4fc65d463fa2a886"><div class="ttname"><a href="class_nim_b_l_e_utils.html#a6382edb7e8e4030b4fc65d463fa2a886">NimBLEUtils::buildHexData</a></div><div class="ttdeci">static char * buildHexData(uint8_t *target, const uint8_t *source, uint8_t length)</div><div class="ttdoc">Create a hex representation of data.</div><div class="ttdef"><b>Definition:</b> NimBLEUtils.cpp:388</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:357</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:63</div></div>
|
||||
<div class="ttc" id="aclass_nim_b_l_e_utils_html_ae521f9a6363c03e42da2f76f64ea431e"><div class="ttname"><a href="class_nim_b_l_e_utils.html#ae521f9a6363c03e42da2f76f64ea431e">NimBLEUtils::checkConnParams</a></div><div class="ttdeci">static int checkConnParams(ble_gap_conn_params *params)</div><div class="ttdoc">A function for checking validity of connection parameters.</div><div class="ttdef"><b>Definition:</b> NimBLEUtils.cpp:25</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:436</div></div>
|
||||
<div class="ttc" id="animconfig_8h_html"><div class="ttname"><a href="nimconfig_8h.html">nimconfig.h</a></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.0 </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.1 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
Reference in new issue
Block a user