2021-08-05 01:02:30 +00:00
<!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" />
2022-01-15 15:23:57 -07:00
< meta name = "generator" content = "Doxygen 1.9.1" />
2021-08-05 01:02:30 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" />
2022-07-31 11:38:16 -06:00
< title > esp-nimble-cpp: K:/Users/Ryan/Desktop/test_idf/components/esp-nimble-cpp/src/NimBLEUtils.h Source File</ title >
2021-08-05 01:02:30 +00:00
< 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 style = "height: 56px;" >
< td id = "projectalign" style = "padding-left: 0.5em;" >
2022-01-15 15:23:57 -07:00
< div id = "projectname" > esp-nimble-cpp
2022-07-31 11:38:16 -06:00
  < span id = "projectnumber" > 1.4.0</ span >
2021-08-05 01:02:30 +00:00
</ div >
</ td >
</ tr >
</ tbody >
</ table >
</ div >
<!-- end header part -->
2022-01-15 15:23:57 -07:00
<!-- Generated by Doxygen 1.9.1 -->
2021-08-05 01:02:30 +00:00
< 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' );
/* @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&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 >
</ 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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$ ( 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" >
< iframe src = "javascript:void(0)" frameborder = "0"
name = "MSearchResults" id = "MSearchResults" >
</ iframe >
</ 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 name = "l00001" ></ a >< span class = "lineno" > 1</ span >   < span class = "comment" > /*</ span ></ div >
< div class = "line" >< a name = "l00002" ></ a >< span class = "lineno" > 2</ span >   < span class = "comment" > * NimBLEUtils.h</ span ></ div >
< div class = "line" >< a name = "l00003" ></ a >< span class = "lineno" > 3</ span >   < span class = "comment" > *</ span ></ div >
< div class = "line" >< a name = "l00004" ></ a >< span class = "lineno" > 4</ span >   < span class = "comment" > * Created: on Jan 25 2020</ span ></ div >
< div class = "line" >< a name = "l00005" ></ a >< span class = "lineno" > 5</ span >   < span class = "comment" > * Author H2zero</ span ></ div >
< div class = "line" >< a name = "l00006" ></ a >< span class = "lineno" > 6</ span >   < span class = "comment" > *</ span ></ div >
< div class = "line" >< a name = "l00007" ></ a >< span class = "lineno" > 7</ span >   < span class = "comment" > */</ span ></ div >
< 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 >
2022-01-15 15:23:57 -07:00
< 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 >
2021-08-05 01:02:30 +00:00
< div class = "line" >< a name = "l00020" ></ a >< span class = "lineno" > 20</ span >   </ div >
2022-01-15 15:23:57 -07:00
< 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 >
2022-07-31 11:38:16 -06:00
< div class = "line" >< a name = "l00032" ></ a >< span class = "lineno" > 32</ span >   < span class = "keywordtype" > void</ span > *buf;</ div >
2022-01-15 15:23:57 -07:00
< 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 >
2021-08-05 01:02:30 +00:00
</ 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 >
2022-01-15 15:23:57 -07:00
< 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 >
2021-08-05 01:02:30 +00:00
</ ul >
</ div >
</ body >
</ html >
