mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2024-11-23 21:50:55 +01:00
252 lines
7.8 KiB
HTML
252 lines
7.8 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: Arduino command line and platformio config options</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('md_docs__command_line_config.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="PageDoc"><div class="header">
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">Arduino command line and platformio config options </div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<div class="textblock"><p><code>CONFIG_BT_NIMBLE_MAX_CONNECTIONS</code> <br />
|
||
|
|
</p>
|
||
|
|
<p>Sets the number of simultaneous connections (esp controller max is 9) <br />
|
||
|
|
</p><ul>
|
||
|
|
<li>Default value is 3 <br />
|
||
|
|
<br />
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p><code>CONFIG_BT_NIMBLE_ATT_PREFERRED_MTU</code> <br />
|
||
|
|
</p>
|
||
|
|
<p>Sets the default MTU size. <br />
|
||
|
|
</p><ul>
|
||
|
|
<li>Default value is 255 <br />
|
||
|
|
<br />
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p><code>CONFIG_BT_NIMBLE_SVC_GAP_DEVICE_NAME</code> <br />
|
||
|
|
</p>
|
||
|
|
<p>Set the default device name <br />
|
||
|
|
</p><ul>
|
||
|
|
<li>Default value is "nimble" <br />
|
||
|
|
<br />
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p><code>CONFIG_BT_NIMBLE_DEBUG</code> <br />
|
||
|
|
</p>
|
||
|
|
<p>If defined, enables debug log messages from the NimBLE host <br />
|
||
|
|
</p><ul>
|
||
|
|
<li>Uses approx. 32kB of flash memory. <br />
|
||
|
|
<br />
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p><code>CONFIG_NIMBLE_CPP_ENABLE_RETURN_CODE_TEXT</code> <br />
|
||
|
|
</p>
|
||
|
|
<p>If defined, NimBLE host return codes will be printed as text in debug log messages. <br />
|
||
|
|
</p><ul>
|
||
|
|
<li>Uses approx. 7kB of flash memory. <br />
|
||
|
|
<br />
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p><code>CONFIG_NIMBLE_CPP_ENABLE_GAP_EVENT_CODE_TEXT</code> <br />
|
||
|
|
</p>
|
||
|
|
<p>If defined, GAP event codes will be printed as text in debug log messages. <br />
|
||
|
|
</p><ul>
|
||
|
|
<li>Uses approx. 1kB of flash memory. <br />
|
||
|
|
<br />
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p><code>CONFIG_NIMBLE_CPP_ENABLE_ADVERTISMENT_TYPE_TEXT</code> <br />
|
||
|
|
</p>
|
||
|
|
<p>If defined, advertisment types will be printed as text while scanning in debug log messages. <br />
|
||
|
|
</p><ul>
|
||
|
|
<li>Uses approx. 250 bytes of flash memory. <br />
|
||
|
|
<br />
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p><code>CONFIG_BT_NIMBLE_SVC_GAP_APPEARANCE</code> <br />
|
||
|
|
</p>
|
||
|
|
<p>Set the default appearance. <br />
|
||
|
|
</p><ul>
|
||
|
|
<li>Default value is 0x00 <br />
|
||
|
|
<br />
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p><code>CONFIG_BT_NIMBLE_ROLE_CENTRAL_DISABLED</code> <br />
|
||
|
|
</p>
|
||
|
|
<p>If defined, NimBLE Client functions will not be included. <br />
|
||
|
|
</p><ul>
|
||
|
|
<li>Reduces flash size by approx. 7kB. <br />
|
||
|
|
<br />
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p><code>CONFIG_BT_NIMBLE_ROLE_OBSERVER_DISABLED</code> <br />
|
||
|
|
</p>
|
||
|
|
<p>If defined, NimBLE Scan functions will not be included. <br />
|
||
|
|
</p><ul>
|
||
|
|
<li>Reduces flash size by approx. 26kB. <br />
|
||
|
|
<br />
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p><code>CONFIG_BT_NIMBLE_ROLE_PERIPHERAL_DISABLED</code> <br />
|
||
|
|
</p>
|
||
|
|
<p>If defined NimBLE Server functions will not be included. <br />
|
||
|
|
</p><ul>
|
||
|
|
<li>Reduces flash size by approx. 16kB. <br />
|
||
|
|
<br />
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p><code>CONFIG_BT_NIMBLE_ROLE_BROADCASTER_DISABLED</code> <br />
|
||
|
|
</p>
|
||
|
|
<p>If defined, NimBLE Advertising functions will not be included. <br />
|
||
|
|
</p><ul>
|
||
|
|
<li>Reduces flash size by approx. 5kB. <br />
|
||
|
|
<br />
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p><code>CONFIG_BT_NIMBLE_MAX_BONDS</code> <br />
|
||
|
|
</p>
|
||
|
|
<p>Sets the number of devices allowed to store/bond with <br />
|
||
|
|
</p><ul>
|
||
|
|
<li>Default value is 3 <br />
|
||
|
|
<br />
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p><code>CONFIG_BT_NIMBLE_MAX_CCCDS</code> <br />
|
||
|
|
</p>
|
||
|
|
<p>Sets the maximum number of CCCD subscriptions to store <br />
|
||
|
|
</p><ul>
|
||
|
|
<li>Default value is 8 <br />
|
||
|
|
<br />
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p><code>CONFIG_BT_NIMBLE_RPA_TIMEOUT</code> <br />
|
||
|
|
</p>
|
||
|
|
<p>Sets the random address refresh time in seconds. <br />
|
||
|
|
</p><ul>
|
||
|
|
<li>Default value is 900 <br />
|
||
|
|
<br />
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p><code>CONFIG_BT_NIMBLE_MSYS1_BLOCK_COUNT</code> <br />
|
||
|
|
</p>
|
||
|
|
<p>Set the number of msys blocks For prepare write & prepare responses. 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. <br />
|
||
|
|
</p><ul>
|
||
|
|
<li>Default value is 12 <br />
|
||
|
|
<br />
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p><code>CONFIG_BT_NIMBLE_MEM_ALLOC_MODE_EXTERNAL</code> <br />
|
||
|
|
</p>
|
||
|
|
<p>Sets the NimBLE stack to use external PSRAM will be loaded <br />
|
||
|
|
</p><ul>
|
||
|
|
<li>Must be defined with a value of 1; Default is CONFIG_BT_NIMBLE_MEM_ALLOC_MODE_INTERNAL 1 <br />
|
||
|
|
<br />
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p><code>CONFIG_BT_NIMBLE_PINNED_TO_CORE</code> <br />
|
||
|
|
</p>
|
||
|
|
<p>Sets the core the NimBLE host stack will run on <br />
|
||
|
|
</p><ul>
|
||
|
|
<li>Options: 0 or 1 <br />
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p><code>CONFIG_BT_NIMBLE_TASK_STACK_SIZE</code> <br />
|
||
|
|
</p>
|
||
|
|
<p>Set the task stack size for the NimBLE core. <br />
|
||
|
|
</p><ul>
|
||
|
|
<li>Default is 4096 <br />
|
||
|
|
<br />
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div></div><!-- contents -->
|
||
|
|
</div><!-- PageDoc -->
|
||
|
|
</div><!-- doc-content -->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||
|
|
<ul>
|
||
|
|
<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>
|