mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2024-12-26 04:30:46 +01:00
209 lines
18 KiB
HTML
209 lines
18 KiB
HTML
<!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.9.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>esp-nimble-cpp / NimBLE-Arduino: src/nimconfig.h File 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="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;">
|
|
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
|
|
 <span id="projectnumber">1.3.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.0 -->
|
|
<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('nimconfig_8h.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="summary">
|
|
<a href="#define-members">Macros</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">nimconfig.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a href="nimconfig_8h_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:a2ea633774bbf41ac57b314875f16d5f9"><td class="memItemLeft" align="right" valign="top"><a id="a2ea633774bbf41ac57b314875f16d5f9"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nimconfig_8h.html#a2ea633774bbf41ac57b314875f16d5f9">CONFIG_BT_NIMBLE_MAX_CONNECTIONS</a>   3</td></tr>
|
|
<tr class="memdesc:a2ea633774bbf41ac57b314875f16d5f9"><td class="mdescLeft"> </td><td class="mdescRight">Un-comment to change the number of simultaneous connections (esp controller max is 9) <br /></td></tr>
|
|
<tr class="separator:a2ea633774bbf41ac57b314875f16d5f9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8fa28ebea6e979630359a2acde3ae578"><td class="memItemLeft" align="right" valign="top"><a id="a8fa28ebea6e979630359a2acde3ae578"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nimconfig_8h.html#a8fa28ebea6e979630359a2acde3ae578">CONFIG_BT_NIMBLE_ATT_PREFERRED_MTU</a>   255</td></tr>
|
|
<tr class="memdesc:a8fa28ebea6e979630359a2acde3ae578"><td class="mdescLeft"> </td><td class="mdescRight">Un-comment to change the default MTU size. <br /></td></tr>
|
|
<tr class="separator:a8fa28ebea6e979630359a2acde3ae578"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7b98160e6904e45e99e28a7fcc6b2a3a"><td class="memItemLeft" align="right" valign="top"><a id="a7b98160e6904e45e99e28a7fcc6b2a3a"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nimconfig_8h.html#a7b98160e6904e45e99e28a7fcc6b2a3a">CONFIG_BT_NIMBLE_SVC_GAP_DEVICE_NAME</a>   "nimble"</td></tr>
|
|
<tr class="memdesc:a7b98160e6904e45e99e28a7fcc6b2a3a"><td class="mdescLeft"> </td><td class="mdescRight">Un-comment to change default device name. <br /></td></tr>
|
|
<tr class="separator:a7b98160e6904e45e99e28a7fcc6b2a3a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeebbc5c476d2a6de28f2d9ebf2948cb5"><td class="memItemLeft" align="right" valign="top"><a id="aeebbc5c476d2a6de28f2d9ebf2948cb5"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nimconfig_8h.html#aeebbc5c476d2a6de28f2d9ebf2948cb5">CONFIG_BT_NIMBLE_DEBUG</a></td></tr>
|
|
<tr class="memdesc:aeebbc5c476d2a6de28f2d9ebf2948cb5"><td class="mdescLeft"> </td><td class="mdescRight">Un-comment to see debug log messages from the NimBLE host Uses approx. 32kB of flash memory. <br /></td></tr>
|
|
<tr class="separator:aeebbc5c476d2a6de28f2d9ebf2948cb5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a136a5d626ac04aa780c6ec07ee88d242"><td class="memItemLeft" align="right" valign="top"><a id="a136a5d626ac04aa780c6ec07ee88d242"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nimconfig_8h.html#a136a5d626ac04aa780c6ec07ee88d242">CONFIG_NIMBLE_CPP_ENABLE_RETURN_CODE_TEXT</a></td></tr>
|
|
<tr class="memdesc:a136a5d626ac04aa780c6ec07ee88d242"><td class="mdescLeft"> </td><td class="mdescRight">Un-comment to see NimBLE host return codes as text debug log messages. Uses approx. 7kB of flash memory. <br /></td></tr>
|
|
<tr class="separator:a136a5d626ac04aa780c6ec07ee88d242"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a97b51f4248845f6225806eadbab3bcdb"><td class="memItemLeft" align="right" valign="top"><a id="a97b51f4248845f6225806eadbab3bcdb"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nimconfig_8h.html#a97b51f4248845f6225806eadbab3bcdb">CONFIG_NIMBLE_CPP_ENABLE_GAP_EVENT_CODE_TEXT</a></td></tr>
|
|
<tr class="memdesc:a97b51f4248845f6225806eadbab3bcdb"><td class="mdescLeft"> </td><td class="mdescRight">Un-comment to see GAP event codes as text in debug log messages. Uses approx. 1kB of flash memory. <br /></td></tr>
|
|
<tr class="separator:a97b51f4248845f6225806eadbab3bcdb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a07c0fd3908c3466e9f4835f85d913880"><td class="memItemLeft" align="right" valign="top"><a id="a07c0fd3908c3466e9f4835f85d913880"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nimconfig_8h.html#a07c0fd3908c3466e9f4835f85d913880">CONFIG_NIMBLE_CPP_ENABLE_ADVERTISMENT_TYPE_TEXT</a></td></tr>
|
|
<tr class="memdesc:a07c0fd3908c3466e9f4835f85d913880"><td class="mdescLeft"> </td><td class="mdescRight">Un-comment to see advertisment types as text while scanning in debug log messages. Uses approx. 250 bytes of flash memory. <br /></td></tr>
|
|
<tr class="separator:a07c0fd3908c3466e9f4835f85d913880"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a300d3f8ff48d217a1a2b6608454dfadb"><td class="memItemLeft" align="right" valign="top"><a id="a300d3f8ff48d217a1a2b6608454dfadb"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nimconfig_8h.html#a300d3f8ff48d217a1a2b6608454dfadb">CONFIG_BT_NIMBLE_SVC_GAP_APPEARANCE</a>   0x0</td></tr>
|
|
<tr class="memdesc:a300d3f8ff48d217a1a2b6608454dfadb"><td class="mdescLeft"> </td><td class="mdescRight">Un-comment to change the default GAP appearance. <br /></td></tr>
|
|
<tr class="separator:a300d3f8ff48d217a1a2b6608454dfadb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6ebb331a6664a3863fb2a57b91a6cd2d"><td class="memItemLeft" align="right" valign="top"><a id="a6ebb331a6664a3863fb2a57b91a6cd2d"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nimconfig_8h.html#a6ebb331a6664a3863fb2a57b91a6cd2d">CONFIG_BT_NIMBLE_ROLE_CENTRAL_DISABLED</a></td></tr>
|
|
<tr class="memdesc:a6ebb331a6664a3863fb2a57b91a6cd2d"><td class="mdescLeft"> </td><td class="mdescRight">Un-comment if not using NimBLE Client functions <br />
|
|
Reduces flash size by approx. 7kB. <br /></td></tr>
|
|
<tr class="separator:a6ebb331a6664a3863fb2a57b91a6cd2d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab91646223e52e5c24f1004a0ed21b829"><td class="memItemLeft" align="right" valign="top"><a id="ab91646223e52e5c24f1004a0ed21b829"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nimconfig_8h.html#ab91646223e52e5c24f1004a0ed21b829">CONFIG_BT_NIMBLE_ROLE_OBSERVER_DISABLED</a></td></tr>
|
|
<tr class="memdesc:ab91646223e52e5c24f1004a0ed21b829"><td class="mdescLeft"> </td><td class="mdescRight">Un-comment if not using NimBLE Scan functions <br />
|
|
Reduces flash size by approx. 26kB. <br /></td></tr>
|
|
<tr class="separator:ab91646223e52e5c24f1004a0ed21b829"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a677d7e75eef5bc96e8d0b4c659db90b0"><td class="memItemLeft" align="right" valign="top"><a id="a677d7e75eef5bc96e8d0b4c659db90b0"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nimconfig_8h.html#a677d7e75eef5bc96e8d0b4c659db90b0">CONFIG_BT_NIMBLE_ROLE_PERIPHERAL_DISABLED</a></td></tr>
|
|
<tr class="memdesc:a677d7e75eef5bc96e8d0b4c659db90b0"><td class="mdescLeft"> </td><td class="mdescRight">Un-comment if not using NimBLE Server functions <br />
|
|
Reduces flash size by approx. 16kB. <br /></td></tr>
|
|
<tr class="separator:a677d7e75eef5bc96e8d0b4c659db90b0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2a6b4f35f8975778ac2aac5ff169cbda"><td class="memItemLeft" align="right" valign="top"><a id="a2a6b4f35f8975778ac2aac5ff169cbda"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nimconfig_8h.html#a2a6b4f35f8975778ac2aac5ff169cbda">CONFIG_BT_NIMBLE_ROLE_BROADCASTER_DISABLED</a></td></tr>
|
|
<tr class="memdesc:a2a6b4f35f8975778ac2aac5ff169cbda"><td class="mdescLeft"> </td><td class="mdescRight">Un-comment if not using NimBLE Advertising functions <br />
|
|
Reduces flash size by approx. 5kB. <br /></td></tr>
|
|
<tr class="separator:a2a6b4f35f8975778ac2aac5ff169cbda"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a11ebe4c94e55f9e710be03169b91f964"><td class="memItemLeft" align="right" valign="top"><a id="a11ebe4c94e55f9e710be03169b91f964"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nimconfig_8h.html#a11ebe4c94e55f9e710be03169b91f964">CONFIG_BT_NIMBLE_MAX_BONDS</a>   3</td></tr>
|
|
<tr class="memdesc:a11ebe4c94e55f9e710be03169b91f964"><td class="mdescLeft"> </td><td class="mdescRight">Un-comment to change the number of devices allowed to store/bond with. <br /></td></tr>
|
|
<tr class="separator:a11ebe4c94e55f9e710be03169b91f964"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abdc3219ca772a22427beed33477ea252"><td class="memItemLeft" align="right" valign="top"><a id="abdc3219ca772a22427beed33477ea252"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nimconfig_8h.html#abdc3219ca772a22427beed33477ea252">CONFIG_BT_NIMBLE_MAX_CCCDS</a>   8</td></tr>
|
|
<tr class="memdesc:abdc3219ca772a22427beed33477ea252"><td class="mdescLeft"> </td><td class="mdescRight">Un-comment to change the maximum number of CCCD subscriptions to store. <br /></td></tr>
|
|
<tr class="separator:abdc3219ca772a22427beed33477ea252"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9d22f9f555a2180787ccec86aa10dc24"><td class="memItemLeft" align="right" valign="top"><a id="a9d22f9f555a2180787ccec86aa10dc24"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nimconfig_8h.html#a9d22f9f555a2180787ccec86aa10dc24">CONFIG_BT_NIMBLE_RPA_TIMEOUT</a>   900</td></tr>
|
|
<tr class="memdesc:a9d22f9f555a2180787ccec86aa10dc24"><td class="mdescLeft"> </td><td class="mdescRight">Un-comment to change the random address refresh time (in seconds) <br /></td></tr>
|
|
<tr class="separator:a9d22f9f555a2180787ccec86aa10dc24"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2f0eb3c3124a34b191a70908dc5af441"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nimconfig_8h.html#a2f0eb3c3124a34b191a70908dc5af441">CONFIG_BT_NIMBLE_MSYS1_BLOCK_COUNT</a>   12</td></tr>
|
|
<tr class="memdesc:a2f0eb3c3124a34b191a70908dc5af441"><td class="mdescLeft"> </td><td class="mdescRight">Un-comment to change the number of MSYS buffers available. <a href="nimconfig_8h.html#a2f0eb3c3124a34b191a70908dc5af441">More...</a><br /></td></tr>
|
|
<tr class="separator:a2f0eb3c3124a34b191a70908dc5af441"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1f39f56a0fe8a36ef7823a7c3e1c6e3b"><td class="memItemLeft" align="right" valign="top"><a id="a1f39f56a0fe8a36ef7823a7c3e1c6e3b"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nimconfig_8h.html#a1f39f56a0fe8a36ef7823a7c3e1c6e3b">CONFIG_BT_NIMBLE_MEM_ALLOC_MODE_EXTERNAL</a>   1</td></tr>
|
|
<tr class="memdesc:a1f39f56a0fe8a36ef7823a7c3e1c6e3b"><td class="mdescLeft"> </td><td class="mdescRight">Un-comment to use external PSRAM for the NimBLE host. <br /></td></tr>
|
|
<tr class="separator:a1f39f56a0fe8a36ef7823a7c3e1c6e3b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab86912bde65d198f2f7aa7f83ef11ee8"><td class="memItemLeft" align="right" valign="top"><a id="ab86912bde65d198f2f7aa7f83ef11ee8"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nimconfig_8h.html#ab86912bde65d198f2f7aa7f83ef11ee8">CONFIG_BT_NIMBLE_PINNED_TO_CORE</a>   0</td></tr>
|
|
<tr class="memdesc:ab86912bde65d198f2f7aa7f83ef11ee8"><td class="mdescLeft"> </td><td class="mdescRight">Un-comment to change the core NimBLE host runs on. <br /></td></tr>
|
|
<tr class="separator:ab86912bde65d198f2f7aa7f83ef11ee8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a227a536958a284235daf409b2b3d1766"><td class="memItemLeft" align="right" valign="top"><a id="a227a536958a284235daf409b2b3d1766"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nimconfig_8h.html#a227a536958a284235daf409b2b3d1766">CONFIG_BT_NIMBLE_TASK_STACK_SIZE</a>   4096</td></tr>
|
|
<tr class="memdesc:a227a536958a284235daf409b2b3d1766"><td class="mdescLeft"> </td><td class="mdescRight">Un-comment to change the stack size for the NimBLE host task. <br /></td></tr>
|
|
<tr class="separator:a227a536958a284235daf409b2b3d1766"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>IGNORE THIS FILE IF USING ESP-IDF, USE MENUCONFIG TO SET NIMBLE OPTIONS.</p>
|
|
<p>The config options here are for doxygen documentation only. </p>
|
|
</div><h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="a2f0eb3c3124a34b191a70908dc5af441"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2f0eb3c3124a34b191a70908dc5af441">◆ </a></span>CONFIG_BT_NIMBLE_MSYS1_BLOCK_COUNT</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define CONFIG_BT_NIMBLE_MSYS1_BLOCK_COUNT   12</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Un-comment to change the number of MSYS buffers available. </p>
|
|
<p>MSYS is a system level mbuf registry. For prepare write & prepare <br />
|
|
responses MBUFs are allocated out of msys_1 pool. This may need to be increased if<br />
|
|
you are sending large blocks of data with a low MTU. E.g: 512 bytes with 23 MTU will fail. </p>
|
|
|
|
</div>
|
|
</div>
|
|
</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"><a class="el" href="nimconfig_8h.html">nimconfig.h</a></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>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|