| |
| |
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| |
| |
| |
| <title>NimBLE Host GAP Reference — Apache Mynewt latest documentation</title> |
| |
| |
| |
| |
| <link rel="shortcut icon" href="../../_static/mynewt-logo-only-newt32x32.png"/> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> |
| |
| |
| <link rel="stylesheet" href="../../_static/css/sphinx_theme.css" type="text/css" /> |
| |
| <link rel="stylesheet" href="../../_static/css/bootstrap-3.0.3.min.css" type="text/css" /> |
| |
| <link rel="stylesheet" href="../../_static/css/v2.css" type="text/css" /> |
| |
| <link rel="stylesheet" href="../../_static/css/custom.css" type="text/css" /> |
| |
| <link rel="stylesheet" href="../../_static/css/restructuredtext.css" type="text/css" /> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../_static/css/overrides.css" type="text/css" /> |
| <link rel="index" title="Index" |
| href="../../genindex.html"/> |
| <link rel="search" title="Search" href="../../search.html"/> |
| <link rel="top" title="Apache Mynewt latest documentation" href="../../index.html"/> |
| <link rel="up" title="NimBLE Host" href="ble_hs.html"/> |
| <link rel="next" title="NimBLE Host GATT Client Reference" href="ble_gattc.html"/> |
| <link rel="prev" title="NimBLE Host Return Codes" href="ble_hs_return_codes.html"/> |
| |
| |
| <script src="../../_static/js/modernizr.min.js"></script> |
| |
| |
| <script> |
| (function(i, s, o, g, r, a, m) { |
| i["GoogleAnalyticsObject"] = r; |
| (i[r] = |
| i[r] || |
| function() { |
| (i[r].q = i[r].q || []).push(arguments); |
| }), |
| (i[r].l = 1 * new Date()); |
| (a = s.createElement(o)), (m = s.getElementsByTagName(o)[0]); |
| a.async = 1; |
| a.src = g; |
| m.parentNode.insertBefore(a, m); |
| })(window, document, "script", "//www.google-analytics.com/analytics.js", "ga"); |
| |
| ga("create", "UA-72162311-1", "auto"); |
| ga("send", "pageview"); |
| </script> |
| |
| |
| </head> |
| |
| <body class="not-front page-documentation" role="document" > |
| <div id="wrapper"> |
| <div class="container"> |
| <div id="banner" class="row v2-main-banner"> |
| <a class="logo-cell" href="/"> |
| <img class="logo" src="../../_static/img/logo.png"> |
| </a> |
| <div class="tagline-cell"> |
| <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> |
| </div> |
| <div class="news-cell"> |
| <div class="well"> |
| <h4>Latest News:</h4> <a href="/download">Apache Mynewt 1.11.0, Apache NimBLE 1.6.0 </a> released September 7, 2023) |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <header> |
| <nav id="navbar" class="navbar navbar-inverse" role="navigation"> |
| <div class="container"> |
| <!-- Collapsed navigation --> |
| <div class="navbar-header"> |
| <!-- Expander button --> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| </div> |
| |
| <!-- Expanded navigation --> |
| <div class="navbar-collapse collapse"> |
| <!-- Main navigation --> |
| <ul class="nav navbar-nav navbar-right"> |
| <li> |
| <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> |
| </li> |
| <li class="important"> |
| <a href="/quick-start/">Quick Start</a> |
| </li> |
| <li> |
| <a href="/about/">About</a> |
| </li> |
| <li> |
| <a href="/talks/">Talks</a> |
| </li> |
| <li class="active"> |
| <a href="/documentation/">Documentation</a> |
| </li> |
| <li> |
| <a href="/download/">Download</a> |
| </li> |
| <li> |
| <a href="/community/">Community</a> |
| </li> |
| <li> |
| <a href="/events/">Events</a> |
| </li> |
| </ul> |
| |
| <!-- Search, Navigation and Repo links --> |
| <ul class="nav navbar-nav navbar-right"> |
| |
| </ul> |
| </div> |
| </div> |
| </nav> |
| </header> |
| <!-- STARTS MAIN CONTENT --> |
| <div id="main-content"> |
| |
| |
| |
| |
| |
| |
| <div id="breadcrumb"> |
| <div class="container"> |
| <a href="/documentation/">Docs</a> / |
| |
| <a href="../index.html">BLE User Guide</a> / |
| |
| <a href="ble_hs.html">NimBLE Host</a> / |
| |
| NimBLE Host GAP Reference |
| |
| <div class="sourcelink"> |
| <a href="https://github.com/apache/mynewt-nimble/edit/master/docs/ble_hs/ble_gap.rst" class="icon icon-github" |
| rel="nofollow"> Edit on GitHub</a> |
| </div> |
| </div> |
| </div> |
| <!-- STARTS CONTAINER --> |
| <div class="container"> |
| <!-- STARTS .content --> |
| <div id="content" class="row"> |
| |
| <!-- STARTS .container-sidebar --> |
| <div class="container-sidebar col-xs-12 col-sm-3"> |
| <div id="docSidebar" class="sticky-container"> |
| <div role="search" class="sphinx-search"> |
| <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search documentation" class="search-documentation" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| <!-- Note: only works when deployed --> |
| <select class="form-control" onchange="if (this.value) window.location.href=this.value"> |
| <option value="/latest" selected> |
| Version: latest |
| </option> |
| <option value="/v1_11_0" > |
| Version: 1.11.0 |
| </option> |
| <option value="/v1_10_0" > |
| Version: 1.10.0 |
| </option> |
| <option value="/v1_9_0" > |
| Version: 1.9.0 |
| </option> |
| <option value="/v1_8_0" selected="selected" > |
| Version: 1.8.0 |
| </option> |
| <option value="/v1_7_0" > |
| Version: 1.7.0 |
| </option> |
| <option value="/v1_6_0" > |
| Version: 1.6.0 |
| </option> |
| <option value="/v1_5_0" > |
| Version: 1.5.0 |
| </option> |
| <option value="/v1_4_0" > |
| Version: 1.4.0 |
| </option> |
| <option value="/v1_3_0/os/introduction" > |
| Version: 1.3.0 |
| </option> |
| <option value="/v1_2_0/os/introduction" > |
| Version: 1.2.0 |
| </option> |
| <option value="/v1_1_0/os/introduction" > |
| Version: 1.1.0 |
| </option> |
| <option value="/v1_0_0/os/introduction" > |
| Version: 1.0.0 |
| </option> |
| <option value="/v0_9_0/os/introduction" > |
| Version: 0.9.0 |
| </option> |
| </select> |
| <div class="region region-sidebar"> |
| <div class="docs-menu"> |
| |
| |
| |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../../index.html">Introduction</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../get_started/index.html">Setup & Get Started</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../tutorials/tutorials.html">Tutorials</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../external_links.html">Third-party Resources</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../os/os_user_guide.html">OS User Guide</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="../index.html">BLE User Guide</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="../ble_sec.html">NimBLE Security</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../ble_setup/ble_setup_intro.html">NimBLE Setup</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="ble_hs.html">NimBLE Host</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="ble_hs_return_codes.html">Return Codes</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">GAP</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="ble_gattc.html">GATT Client</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="ble_gatts.html">GATT Server</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="ble_hs_id.html">Identity</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="ble_att.html">ATT</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../btshell/btshell_api.html">btshell Usage API</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../mesh/index.html">Bluetooth Mesh</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../newt/index.html">Newt Tool Guide</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../newtmgr/index.html">Newt Manager Guide</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../mynewt_faq/index.html">Mynewt FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../misc/index.html">Appendix</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </div> |
| <!-- ENDS STICKY CONTAINER --> |
| </div> |
| <!-- ENDS .container-sidebar --> |
| |
| <div class="col-xs-12 col-sm-9"> |
| |
| <div class="alert alert-warning"> |
| <p> |
| Version 1.8.0 is not the most recent version of the |
| Apache Mynewt documentation. Click <a href="/latest">here</a> to |
| read the latest version. |
| </p> |
| </div> |
| |
| |
| |
| <div class=""> |
| <div class="rst-content"> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="nimble-host-gap-reference"> |
| <h1>NimBLE Host GAP Reference<a class="headerlink" href="#nimble-host-gap-reference" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="introduction"> |
| <h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2> |
| <p>The Generic Access Profile (GAP) is responsible for all connecting, advertising, scanning, and connection updating operations.</p> |
| </div> |
| <div class="section" id="api"> |
| <h2>API<a class="headerlink" href="#api" title="Permalink to this headline">¶</a></h2> |
| <dl class="c type"> |
| <dt id="c.ble_gap_event_fn"> |
| <span class="target" id="group__bt__host__gap_1ga7360972a9e9fb525c5c2038feae32a74"></span><em class="property"><span class="pre">typedef</span> </em><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_event_fn</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#c.ble_gap_event" title="ble_gap_event"><span class="pre">ble_gap_event</span></a> <span class="pre">*</span><em><span class="pre">event</span></em>, <span class="pre">void</span> <span class="pre">*</span><em><span class="pre">arg</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_event_fn" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_conn_find"> |
| <span class="target" id="group__bt__host__gap_1ga94220fc148825c35eb70b97c6f045da0"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_conn_find</span></code><span class="sig-paren">(</span><span class="pre">uint16_t</span> <em><span class="pre">handle</span></em>, <em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#c.ble_gap_conn_desc" title="ble_gap_conn_desc"><span class="pre">ble_gap_conn_desc</span></a> <span class="pre">*</span><em><span class="pre">out_desc</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_conn_find" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Searches for a connection with the specified handle. </p> |
| <p>If a matching connection is found, the supplied connection descriptor is filled correspondingly.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success, BLE_HS_ENOTCONN if no matching connection was found. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">handle</span></code>: The connection handle to search for. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">out_desc</span></code>: On success, this is populated with information relating to the matching connection. Pass NULL if you don’t need this information.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_conn_find_by_addr"> |
| <span class="target" id="group__bt__host__gap_1ga0d9808970bb7936f14f930ebfed1db75"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_conn_find_by_addr</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">const</span></em> <span class="pre">ble_addr_t</span> <span class="pre">*</span><em><span class="pre">addr</span></em>, <em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#c.ble_gap_conn_desc" title="ble_gap_conn_desc"><span class="pre">ble_gap_conn_desc</span></a> <span class="pre">*</span><em><span class="pre">out_desc</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_conn_find_by_addr" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Searches for a connection with a peer with the specified address. </p> |
| <p>If a matching connection is found, the supplied connection descriptor is filled correspondingly.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success, BLE_HS_ENOTCONN if no matching connection was found. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">addr</span></code>: The ble address of a connected peer device to search for. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">out_desc</span></code>: On success, this is populated with information relating to the matching connection. Pass NULL if you don’t need this information.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_set_event_cb"> |
| <span class="target" id="group__bt__host__gap_1ga3d61bb87c27e1f7518b24d684d06cf76"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_set_event_cb</span></code><span class="sig-paren">(</span><span class="pre">uint16_t</span> <em><span class="pre">conn_handle</span></em>, <a class="reference internal" href="#c.ble_gap_event_fn" title="ble_gap_event_fn"><span class="pre">ble_gap_event_fn</span></a> <span class="pre">*</span><em><span class="pre">cb</span></em>, <span class="pre">void</span> <span class="pre">*</span><em><span class="pre">cb_arg</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_set_event_cb" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Configures a connection to use the specified GAP event callback. </p> |
| <p>A connection’s GAP event callback is first specified when the connection is created, either via advertising or initiation. This function replaces the callback that was last configured.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success, BLE_HS_ENOTCONN if there is no connection with the specified handle. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">conn_handle</span></code>: The handle of the connection to configure. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">cb</span></code>: The callback to associate with the connection. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">cb_arg</span></code>: An optional argument that the callback receives.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_adv_start"> |
| <span class="target" id="group__bt__host__gap_1gae8e3b25bf7737b53539f5eb0212a7fb6"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_adv_start</span></code><span class="sig-paren">(</span><span class="pre">uint8_t</span> <em><span class="pre">own_addr_type</span></em>, <em class="property"><span class="pre">const</span></em> <span class="pre">ble_addr_t</span> <span class="pre">*</span><em><span class="pre">direct_addr</span></em>, <span class="pre">int32_t</span> <em><span class="pre">duration_ms</span></em>, <em class="property"><span class="pre">const</span></em> <em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#c.ble_gap_adv_params" title="ble_gap_adv_params"><span class="pre">ble_gap_adv_params</span></a> <span class="pre">*</span><em><span class="pre">adv_params</span></em>, <a class="reference internal" href="#c.ble_gap_event_fn" title="ble_gap_event_fn"><span class="pre">ble_gap_event_fn</span></a> <span class="pre">*</span><em><span class="pre">cb</span></em>, <span class="pre">void</span> <span class="pre">*</span><em><span class="pre">cb_arg</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_adv_start" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Start advertising. </p> |
| <p>This function configures and start advertising procedure.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success, error code on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">own_addr_type</span></code>: The type of address the stack should use for itself. Valid values are:<ul> |
| <li><p>BLE_OWN_ADDR_PUBLIC</p></li> |
| <li><p>BLE_OWN_ADDR_RANDOM</p></li> |
| <li><p>BLE_OWN_ADDR_RPA_PUBLIC_DEFAULT</p></li> |
| <li><p>BLE_OWN_ADDR_RPA_RANDOM_DEFAULT </p></li> |
| </ul> |
| </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">direct_addr</span></code>: The peer’s address for directed advertising. This parameter shall be non-NULL if directed advertising is being used. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">duration_ms</span></code>: The duration of the advertisement procedure. On expiration, the procedure ends and a BLE_GAP_EVENT_ADV_COMPLETE event is reported. Units are milliseconds. Specify BLE_HS_FOREVER for no expiration. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">adv_params</span></code>: Additional arguments specifying the particulars of the advertising procedure. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">cb</span></code>: The callback to associate with this advertising procedure. If advertising ends, the event is reported through this callback. If advertising results in a connection, the connection inherits this callback as its event-reporting mechanism. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">cb_arg</span></code>: The optional argument to pass to the callback function.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_adv_stop"> |
| <span class="target" id="group__bt__host__gap_1ga6527f37b9e1e87219110d90aea2bd2d3"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_adv_stop</span></code><span class="sig-paren">(</span><span class="pre">void</span><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_adv_stop" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Stops the currently-active advertising procedure. </p> |
| <p>A success return code indicates that advertising has been fully aborted and a new advertising procedure can be initiated immediately.</p> |
| <p>NOTE: If the caller is running in the same task as the NimBLE host, or if it is running in a higher priority task than that of the host, care must be taken when restarting advertising. Under these conditions, the following is <em>not</em> a reliable method to restart advertising: <a class="reference internal" href="#group__bt__host__gap_1ga6527f37b9e1e87219110d90aea2bd2d3"><span class="std std-ref">ble_gap_adv_stop()</span></a> <a class="reference internal" href="#group__bt__host__gap_1gae8e3b25bf7737b53539f5eb0212a7fb6"><span class="std std-ref">ble_gap_adv_start()</span></a></p> |
| <p>Instead, the call to <code class="docutils literal notranslate"><a class="reference internal" href="#group__bt__host__gap_1gae8e3b25bf7737b53539f5eb0212a7fb6"><span class="std std-ref"><span class="pre">ble_gap_adv_start()</span></span></a></code> must be made in a separate event context. That is, <code class="docutils literal notranslate"><a class="reference internal" href="#group__bt__host__gap_1gae8e3b25bf7737b53539f5eb0212a7fb6"><span class="std std-ref"><span class="pre">ble_gap_adv_start()</span></span></a></code> must be called asynchronously by enqueueing an event on the current task’s event queue. See <a class="reference external" href="https://github.com/apache/mynewt-nimble/pull/211">https://github.com/apache/mynewt-nimble/pull/211</a> for more information.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success, BLE_HS_EALREADY if there is no active advertising procedure, other error code on failure. </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_adv_active"> |
| <span class="target" id="group__bt__host__gap_1gaa2e0b44b1ac8a54090a060454d5a0c53"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_adv_active</span></code><span class="sig-paren">(</span><span class="pre">void</span><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_adv_active" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Indicates whether an advertisement procedure is currently in progress. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 if no advertisement procedure in progress, 1 otherwise. </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_adv_set_data"> |
| <span class="target" id="group__bt__host__gap_1gaeaecc10aedc911acc0cce9e4c99b050d"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_adv_set_data</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">const</span></em> <span class="pre">uint8_t</span> <span class="pre">*</span><em><span class="pre">data</span></em>, <span class="pre">int</span> <em><span class="pre">data_len</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_adv_set_data" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Configures the data to include in subsequent advertisements. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on succes, BLE_HS_EBUSY if advertising is in progress, other error code on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">data</span></code>: Buffer containing the advertising data. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">data_len</span></code>: The size of the advertising data, in bytes.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_adv_rsp_set_data"> |
| <span class="target" id="group__bt__host__gap_1ga411b084235bd7331b6f36de68d6cce60"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_adv_rsp_set_data</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">const</span></em> <span class="pre">uint8_t</span> <span class="pre">*</span><em><span class="pre">data</span></em>, <span class="pre">int</span> <em><span class="pre">data_len</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_adv_rsp_set_data" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Configures the data to include in subsequent scan responses. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on succes, BLE_HS_EBUSY if advertising is in progress, other error code on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">data</span></code>: Buffer containing the scan response data. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">data_len</span></code>: The size of the response data, in bytes.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_adv_set_fields"> |
| <span class="target" id="group__bt__host__gap_1ga77e6868a6c58e6d62f2509f3ebf13dd9"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_adv_set_fields</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">const</span></em> <em class="property"><span class="pre">struct</span></em> <span class="pre">ble_hs_adv_fields</span> <span class="pre">*</span><em><span class="pre">rsp_fields</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_adv_set_fields" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Configures the fields to include in subsequent advertisements. </p> |
| <p>This is a convenience wrapper for <a class="reference internal" href="#group__bt__host__gap_1gaeaecc10aedc911acc0cce9e4c99b050d"><span class="std std-ref">ble_gap_adv_set_data()</span></a>.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success, BLE_HS_EBUSY if advertising is in progress, BLE_HS_EMSGSIZE if the specified data is too large to fit in an advertisement, other error code on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">adv_fields</span></code>: Specifies the advertisement data.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_adv_rsp_set_fields"> |
| <span class="target" id="group__bt__host__gap_1gacaa5a4a6c24edc2c8c1ad024a7ed501c"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_adv_rsp_set_fields</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">const</span></em> <em class="property"><span class="pre">struct</span></em> <span class="pre">ble_hs_adv_fields</span> <span class="pre">*</span><em><span class="pre">rsp_fields</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_adv_rsp_set_fields" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Configures the fields to include in subsequent scan responses. </p> |
| <p>This is a convenience wrapper for <a class="reference internal" href="#group__bt__host__gap_1ga411b084235bd7331b6f36de68d6cce60"><span class="std std-ref">ble_gap_adv_rsp_set_data()</span></a>.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success, BLE_HS_EBUSY if advertising is in progress, BLE_HS_EMSGSIZE if the specified data is too large to fit in a scan response, other error code on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">adv_fields</span></code>: Specifies the scan response data.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_ext_adv_configure"> |
| <span class="target" id="group__bt__host__gap_1ga91352fd79e243d75fadc3705cb004dd8"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_ext_adv_configure</span></code><span class="sig-paren">(</span><span class="pre">uint8_t</span> <em><span class="pre">instance</span></em>, <em class="property"><span class="pre">const</span></em> <em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#c.ble_gap_ext_adv_params" title="ble_gap_ext_adv_params"><span class="pre">ble_gap_ext_adv_params</span></a> <span class="pre">*</span><em><span class="pre">params</span></em>, <span class="pre">int8_t</span> <span class="pre">*</span><em><span class="pre">selected_tx_power</span></em>, <a class="reference internal" href="#c.ble_gap_event_fn" title="ble_gap_event_fn"><span class="pre">ble_gap_event_fn</span></a> <span class="pre">*</span><em><span class="pre">cb</span></em>, <span class="pre">void</span> <span class="pre">*</span><em><span class="pre">cb_arg</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_ext_adv_configure" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Configure extended advertising instance. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; nonzero on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">instance</span></code>: Instance ID </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">params</span></code>: Additional arguments specifying the particulars of the advertising. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">selected_tx_power</span></code>: Selected advertising transmit power will be stored in that param if non-NULL. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">cb</span></code>: The callback to associate with this advertising procedure. Advertising complete event is reported through this callback </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">cb_arg</span></code>: The optional argument to pass to the callback function.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_ext_adv_set_addr"> |
| <span class="target" id="group__bt__host__gap_1ga848bb4422cde2a9fb65240d1cf55a3a0"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_ext_adv_set_addr</span></code><span class="sig-paren">(</span><span class="pre">uint8_t</span> <em><span class="pre">instance</span></em>, <em class="property"><span class="pre">const</span></em> <span class="pre">ble_addr_t</span> <span class="pre">*</span><em><span class="pre">addr</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_ext_adv_set_addr" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Set random address for configured advertising instance. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; nonzero on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">instance</span></code>: Instance ID </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">addr</span></code>: Random address to be set</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_ext_adv_start"> |
| <span class="target" id="group__bt__host__gap_1ga918ef5aff3cf95b4de7b603663af5344"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_ext_adv_start</span></code><span class="sig-paren">(</span><span class="pre">uint8_t</span> <em><span class="pre">instance</span></em>, <span class="pre">int</span> <em><span class="pre">duration</span></em>, <span class="pre">int</span> <em><span class="pre">max_events</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_ext_adv_start" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Start advertising instance. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success, error code on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">instance</span></code>: Instance ID </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">duration</span></code>: The duration of the advertisement procedure. On expiration, the procedure ends and a BLE_GAP_EVENT_ADV_COMPLETE event is reported. Units are 10 milliseconds. Specify 0 for no expiration. @params max_events Number of advertising events that should be sent before advertising ends and a BLE_GAP_EVENT_ADV_COMPLETE event is reported. Specify 0 for no limit.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_ext_adv_stop"> |
| <span class="target" id="group__bt__host__gap_1ga681c1e735964de1cd1de73a0a4893a9f"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_ext_adv_stop</span></code><span class="sig-paren">(</span><span class="pre">uint8_t</span> <em><span class="pre">instance</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_ext_adv_stop" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Stops advertising procedure for specified instance. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success, BLE_HS_EALREADY if there is no active advertising procedure for instance, other error code on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">instance</span></code>: Instance ID</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_ext_adv_set_data"> |
| <span class="target" id="group__bt__host__gap_1ga865bfc674633d460efab81cd9142a815"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_ext_adv_set_data</span></code><span class="sig-paren">(</span><span class="pre">uint8_t</span> <em><span class="pre">instance</span></em>, <em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="../../os/core_os/mbuf/mbuf.html#c.os_mbuf" title="os_mbuf"><span class="pre">os_mbuf</span></a> <span class="pre">*</span><em><span class="pre">data</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_ext_adv_set_data" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Configures the data to include in advertisements packets for specified advertising instance. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success or error code on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">instance</span></code>: Instance ID </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">data</span></code>: Chain containing the advertising data.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_ext_adv_rsp_set_data"> |
| <span class="target" id="group__bt__host__gap_1gabb6eae8db47bf89b30a04fcfab365745"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_ext_adv_rsp_set_data</span></code><span class="sig-paren">(</span><span class="pre">uint8_t</span> <em><span class="pre">instance</span></em>, <em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="../../os/core_os/mbuf/mbuf.html#c.os_mbuf" title="os_mbuf"><span class="pre">os_mbuf</span></a> <span class="pre">*</span><em><span class="pre">data</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_ext_adv_rsp_set_data" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Configures the data to include in subsequent scan responses for specified advertisign instance. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success or error code on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">instance</span></code>: Instance ID </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">data</span></code>: Chain containing the scan response data.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_ext_adv_remove"> |
| <span class="target" id="group__bt__host__gap_1ga4830dcadf63143feb8b2ff6d16293810"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_ext_adv_remove</span></code><span class="sig-paren">(</span><span class="pre">uint8_t</span> <em><span class="pre">instance</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_ext_adv_remove" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Remove existing advertising instance. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success, BLE_HS_EBUSY if advertising is in progress, other error code on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">instance</span></code>: Instance ID</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_ext_adv_clear"> |
| <span class="target" id="group__bt__host__gap_1ga316cbb55ff7e01798e49f2a5f7a275a8"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_ext_adv_clear</span></code><span class="sig-paren">(</span><span class="pre">void</span><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_ext_adv_clear" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Clear all existing advertising instances. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success, BLE_HS_EBUSY if advertising is in progress, other error code on failure. </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_periodic_adv_configure"> |
| <span class="target" id="group__bt__host__gap_1gac6f4036aafed46310811cff2829293e9"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_periodic_adv_configure</span></code><span class="sig-paren">(</span><span class="pre">uint8_t</span> <em><span class="pre">instance</span></em>, <em class="property"><span class="pre">const</span></em> <em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#c.ble_gap_periodic_adv_params" title="ble_gap_periodic_adv_params"><span class="pre">ble_gap_periodic_adv_params</span></a> <span class="pre">*</span><em><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_periodic_adv_configure" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Configure periodic advertising for specified advertising instance. </p> |
| <p>This is allowed only for instances configured as non-announymous, non-connectable and non-scannable.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; nonzero on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">instance</span></code>: Instance ID </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">params</span></code>: Additional arguments specifying the particulars of periodic advertising.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_periodic_adv_start"> |
| <span class="target" id="group__bt__host__gap_1ga04a1485e292101e2fa57dddf6e76adb8"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_periodic_adv_start</span></code><span class="sig-paren">(</span><span class="pre">uint8_t</span> <em><span class="pre">instance</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_periodic_adv_start" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Start periodic advertising for specified advertising instance. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success, error code on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">instance</span></code>: Instance ID</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_periodic_adv_stop"> |
| <span class="target" id="group__bt__host__gap_1ga15a7bdcb86f4cb0f4013af205a1d6e49"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_periodic_adv_stop</span></code><span class="sig-paren">(</span><span class="pre">uint8_t</span> <em><span class="pre">instance</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_periodic_adv_stop" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Stop periodic advertising for specified advertising instance. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success, error code on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">instance</span></code>: Instance ID</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_periodic_adv_set_data"> |
| <span class="target" id="group__bt__host__gap_1ga49bdb3182fdb567d0dea2b88f29e6625"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_periodic_adv_set_data</span></code><span class="sig-paren">(</span><span class="pre">uint8_t</span> <em><span class="pre">instance</span></em>, <em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="../../os/core_os/mbuf/mbuf.html#c.os_mbuf" title="os_mbuf"><span class="pre">os_mbuf</span></a> <span class="pre">*</span><em><span class="pre">data</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_periodic_adv_set_data" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Configures the data to include in periodic advertisements for specified advertising instance. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success or error code on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">instance</span></code>: Instance ID </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">data</span></code>: Chain containing the periodic advertising data.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_periodic_adv_sync_create"> |
| <span class="target" id="group__bt__host__gap_1ga09a29500f67632e8f9f3e16ddc221c03"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_periodic_adv_sync_create</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">const</span></em> <span class="pre">ble_addr_t</span> <span class="pre">*</span><em><span class="pre">addr</span></em>, <span class="pre">uint8_t</span> <em><span class="pre">adv_sid</span></em>, <em class="property"><span class="pre">const</span></em> <em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#c.ble_gap_periodic_sync_params" title="ble_gap_periodic_sync_params"><span class="pre">ble_gap_periodic_sync_params</span></a> <span class="pre">*</span><em><span class="pre">params</span></em>, <a class="reference internal" href="#c.ble_gap_event_fn" title="ble_gap_event_fn"><span class="pre">ble_gap_event_fn</span></a> <span class="pre">*</span><em><span class="pre">cb</span></em>, <span class="pre">void</span> <span class="pre">*</span><em><span class="pre">cb_arg</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_periodic_adv_sync_create" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Performs the Synchronization procedure with periodic advertiser. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; nonzero on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">addr</span></code>: Peer address to synchronize with. If NULL than peers from periodic list are used. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">adv_sid</span></code>: Advertiser Set ID </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">params</span></code>: Additional arguments specifying the particulars of the synchronization procedure. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">cb</span></code>: The callback to associate with this synchrnization procedure. BLE_GAP_EVENT_PERIODIC_REPORT events are reported only by this callback. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">cb_arg</span></code>: The optional argument to pass to the callback function.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_periodic_adv_sync_create_cancel"> |
| <span class="target" id="group__bt__host__gap_1ga7f3b2260e21633f9b125192b2825156c"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_periodic_adv_sync_create_cancel</span></code><span class="sig-paren">(</span><span class="pre">void</span><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_periodic_adv_sync_create_cancel" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Cancel pending synchronization procedure. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; nonzero on failure. </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_periodic_adv_sync_terminate"> |
| <span class="target" id="group__bt__host__gap_1ga0c88d0e48c261c91869e33fc574edab5"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_periodic_adv_sync_terminate</span></code><span class="sig-paren">(</span><span class="pre">uint16_t</span> <em><span class="pre">sync_handle</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_periodic_adv_sync_terminate" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Terminate synchronization procedure. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; nonzero on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">sync_handle</span></code>: Handle identifying synchronization to terminate.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_periodic_adv_sync_reporting"> |
| <span class="target" id="group__bt__host__gap_1gac98dccc64116bb42b047a6c2bcf2a9a1"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_periodic_adv_sync_reporting</span></code><span class="sig-paren">(</span><span class="pre">uint16_t</span> <em><span class="pre">sync_handle</span></em>, <span class="pre">bool</span> <em><span class="pre">enable</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_periodic_adv_sync_reporting" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Disable or enable periodic reports for specified sync. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; nonzero on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">sync_handle</span></code>: Handle identifying synchronization. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">enable</span></code>: If reports should be enabled.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_periodic_adv_sync_transfer"> |
| <span class="target" id="group__bt__host__gap_1gadf569691fcb6d9f9f50d328a2f6af5e2"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_periodic_adv_sync_transfer</span></code><span class="sig-paren">(</span><span class="pre">uint16_t</span> <em><span class="pre">sync_handle</span></em>, <span class="pre">uint16_t</span> <em><span class="pre">conn_handle</span></em>, <span class="pre">uint16_t</span> <em><span class="pre">service_data</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_periodic_adv_sync_transfer" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Initialize sync transfer procedure for specified handles. </p> |
| <p>This allows to transfer periodic sync to which host is synchronized.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; nonzero on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">sync_handle</span></code>: Handle identifying synchronization. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">conn_handle</span></code>: Handle identifying connection. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">service_data</span></code>: Sync transfer service data</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_periodic_adv_sync_set_info"> |
| <span class="target" id="group__bt__host__gap_1ga0e0d15c7da436c2ee8fed152217eb726"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_periodic_adv_sync_set_info</span></code><span class="sig-paren">(</span><span class="pre">uint8_t</span> <em><span class="pre">instance</span></em>, <span class="pre">uint16_t</span> <em><span class="pre">conn_handle</span></em>, <span class="pre">uint16_t</span> <em><span class="pre">service_data</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_periodic_adv_sync_set_info" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Initialize set info transfer procedure for specified handles. </p> |
| <p>This allows to transfer periodic sync which is being advertised by host.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; nonzero on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">instance</span></code>: Advertising instance with periodic adv enabled. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">conn_handle</span></code>: Handle identifying connection. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">service_data</span></code>: Sync transfer service data</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_periodic_adv_sync_receive"> |
| <span class="target" id="group__bt__host__gap_1ga15114d22d9434004e6c6bd04a680770f"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_periodic_adv_sync_receive</span></code><span class="sig-paren">(</span><span class="pre">uint16_t</span> <em><span class="pre">conn_handle</span></em>, <em class="property"><span class="pre">const</span></em> <em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#c.ble_gap_periodic_sync_params" title="ble_gap_periodic_sync_params"><span class="pre">ble_gap_periodic_sync_params</span></a> <span class="pre">*</span><em><span class="pre">params</span></em>, <a class="reference internal" href="#c.ble_gap_event_fn" title="ble_gap_event_fn"><span class="pre">ble_gap_event_fn</span></a> <span class="pre">*</span><em><span class="pre">cb</span></em>, <span class="pre">void</span> <span class="pre">*</span><em><span class="pre">cb_arg</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_periodic_adv_sync_receive" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Enables or disables sync transfer reception on specified connection. </p> |
| <p>When sync transfer arrives, BLE_GAP_EVENT_PERIODIC_TRANSFER is sent to the user. After that, sync transfer reception on that connection is terminated and user needs to call this API again when expect to receive next sync transfers.</p> |
| <p>Note: If ACL connection gets disconnected before sync transfer arrived, user will not receive BLE_GAP_EVENT_PERIODIC_TRANSFER. Instead, sync transfer reception is terminated by the host automatically.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; nonzero on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">conn_handle</span></code>: Handle identifying connection. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">params</span></code>: Parameters for enabled sync transfer reception. Specify NULL to disable reception. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">cb</span></code>: The callback to associate with this synchronization procedure. BLE_GAP_EVENT_PERIODIC_REPORT events are reported only by this callback. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">cb_arg</span></code>: The optional argument to pass to the callback function.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_add_dev_to_periodic_adv_list"> |
| <span class="target" id="group__bt__host__gap_1ga72293fde494c36cb3faaec7d415c19c0"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_add_dev_to_periodic_adv_list</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">const</span></em> <span class="pre">ble_addr_t</span> <span class="pre">*</span><em><span class="pre">peer_addr</span></em>, <span class="pre">uint8_t</span> <em><span class="pre">adv_sid</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_add_dev_to_periodic_adv_list" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Add peer device to periodic synchronization list. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; nonzero on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">addr</span></code>: Peer address to add to list. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">adv_sid</span></code>: Advertiser Set ID</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_rem_dev_from_periodic_adv_list"> |
| <span class="target" id="group__bt__host__gap_1ga78268dec6e2a9472fa5af7036816c74c"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_rem_dev_from_periodic_adv_list</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">const</span></em> <span class="pre">ble_addr_t</span> <span class="pre">*</span><em><span class="pre">peer_addr</span></em>, <span class="pre">uint8_t</span> <em><span class="pre">adv_sid</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_rem_dev_from_periodic_adv_list" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Remove peer device from periodic synchronization list. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; nonzero on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">addr</span></code>: Peer address to remove from list. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">adv_sid</span></code>: Advertiser Set ID</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_clear_periodic_adv_list"> |
| <span class="target" id="group__bt__host__gap_1gad09cdfbffddc1ddce4384dd2ef4eecc6"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_clear_periodic_adv_list</span></code><span class="sig-paren">(</span><span class="pre">void</span><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_clear_periodic_adv_list" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Clear periodic synchrnization list. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; nonzero on failure. </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_read_periodic_adv_list_size"> |
| <span class="target" id="group__bt__host__gap_1gade8d7c7d66b96a66e3c6a50fa1147986"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_read_periodic_adv_list_size</span></code><span class="sig-paren">(</span><span class="pre">uint8_t</span> <span class="pre">*</span><em><span class="pre">per_adv_list_size</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_read_periodic_adv_list_size" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Get periodic synchronization list size. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; nonzero on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">per_adv_list_size</span></code>: On success list size is stored here.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_disc"> |
| <span class="target" id="group__bt__host__gap_1ga68715d965ae8b502a15113d461666f2a"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_disc</span></code><span class="sig-paren">(</span><span class="pre">uint8_t</span> <em><span class="pre">own_addr_type</span></em>, <span class="pre">int32_t</span> <em><span class="pre">duration_ms</span></em>, <em class="property"><span class="pre">const</span></em> <em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#c.ble_gap_disc_params" title="ble_gap_disc_params"><span class="pre">ble_gap_disc_params</span></a> <span class="pre">*</span><em><span class="pre">disc_params</span></em>, <a class="reference internal" href="#c.ble_gap_event_fn" title="ble_gap_event_fn"><span class="pre">ble_gap_event_fn</span></a> <span class="pre">*</span><em><span class="pre">cb</span></em>, <span class="pre">void</span> <span class="pre">*</span><em><span class="pre">cb_arg</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_disc" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Performs the Limited or General Discovery Procedures. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; nonzero on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">own_addr_type</span></code>: The type of address the stack should use for itself when sending scan requests. Valid values are:<ul> |
| <li><p>BLE_ADDR_TYPE_PUBLIC</p></li> |
| <li><p>BLE_ADDR_TYPE_RANDOM</p></li> |
| <li><p>BLE_ADDR_TYPE_RPA_PUB_DEFAULT</p></li> |
| <li><p>BLE_ADDR_TYPE_RPA_RND_DEFAULT This parameter is ignored unless active scanning is being used. </p></li> |
| </ul> |
| </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">duration_ms</span></code>: The duration of the discovery procedure. On expiration, the procedure ends and a BLE_GAP_EVENT_DISC_COMPLETE event is reported. Units are milliseconds. Specify BLE_HS_FOREVER for no expiration. Specify 0 to use stack defaults. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">disc_params</span></code>: Additional arguments specifying the particulars of the discovery procedure. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">cb</span></code>: The callback to associate with this discovery procedure. Advertising reports and discovery termination events are reported through this callback. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">cb_arg</span></code>: The optional argument to pass to the callback function.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_ext_disc"> |
| <span class="target" id="group__bt__host__gap_1ga9e2a8549b599dc7a715c100f4f01e989"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_ext_disc</span></code><span class="sig-paren">(</span><span class="pre">uint8_t</span> <em><span class="pre">own_addr_type</span></em>, <span class="pre">uint16_t</span> <em><span class="pre">duration</span></em>, <span class="pre">uint16_t</span> <em><span class="pre">period</span></em>, <span class="pre">uint8_t</span> <em><span class="pre">filter_duplicates</span></em>, <span class="pre">uint8_t</span> <em><span class="pre">filter_policy</span></em>, <span class="pre">uint8_t</span> <em><span class="pre">limited</span></em>, <em class="property"><span class="pre">const</span></em> <em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#c.ble_gap_ext_disc_params" title="ble_gap_ext_disc_params"><span class="pre">ble_gap_ext_disc_params</span></a> <span class="pre">*</span><em><span class="pre">uncoded_params</span></em>, <em class="property"><span class="pre">const</span></em> <em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#c.ble_gap_ext_disc_params" title="ble_gap_ext_disc_params"><span class="pre">ble_gap_ext_disc_params</span></a> <span class="pre">*</span><em><span class="pre">coded_params</span></em>, <a class="reference internal" href="#c.ble_gap_event_fn" title="ble_gap_event_fn"><span class="pre">ble_gap_event_fn</span></a> <span class="pre">*</span><em><span class="pre">cb</span></em>, <span class="pre">void</span> <span class="pre">*</span><em><span class="pre">cb_arg</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_ext_disc" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Performs the Limited or General Extended Discovery Procedures. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; nonzero on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">own_addr_type</span></code>: The type of address the stack should use for itself when sending scan requests. Valid values are:<ul> |
| <li><p>BLE_ADDR_TYPE_PUBLIC</p></li> |
| <li><p>BLE_ADDR_TYPE_RANDOM</p></li> |
| <li><p>BLE_ADDR_TYPE_RPA_PUB_DEFAULT</p></li> |
| <li><p>BLE_ADDR_TYPE_RPA_RND_DEFAULT This parameter is ignored unless active scanning is being used. </p></li> |
| </ul> |
| </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">duration</span></code>: The duration of the discovery procedure. On expiration, if period is set to 0, the procedure ends and a BLE_GAP_EVENT_DISC_COMPLETE event is reported. Units are 10 milliseconds. Specify 0 for no expiration. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">period</span></code>: Time interval from when the Controller started its last Scan Duration until it begins the subsequent Scan Duration. Specify 0 to scan continuously. Units are 1.28 second. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">limited</span></code>: If limited discovery procedure should be used. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">uncoded_params</span></code>: Additional arguments specifying the particulars of the discovery procedure for uncoded PHY. If NULL is provided no scan is performed for this PHY. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">coded_params</span></code>: Additional arguments specifying the particulars of the discovery procedure for coded PHY. If NULL is provided no scan is performed for this PHY. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">cb</span></code>: The callback to associate with this discovery procedure. Advertising reports and discovery termination events are reported through this callback. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">cb_arg</span></code>: The optional argument to pass to the callback function.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_disc_cancel"> |
| <span class="target" id="group__bt__host__gap_1ga814032c24cfb68ad70b36de072971883"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_disc_cancel</span></code><span class="sig-paren">(</span><span class="pre">void</span><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_disc_cancel" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Cancels the discovery procedure currently in progress. </p> |
| <p>A success return code indicates that scanning has been fully aborted; a new discovery or connect procedure can be initiated immediately.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; BLE_HS_EALREADY if there is no discovery procedure to cancel; Other nonzero on unexpected error. </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_disc_active"> |
| <span class="target" id="group__bt__host__gap_1ga4c1776c11403ad403f28692f28cc2682"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_disc_active</span></code><span class="sig-paren">(</span><span class="pre">void</span><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_disc_active" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Indicates whether a discovery procedure is currently in progress. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0: No discovery procedure in progress; 1: Discovery procedure in progress. </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_connect"> |
| <span class="target" id="group__bt__host__gap_1gacf7d2c2888aff7f473f3e806c7e7a059"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_connect</span></code><span class="sig-paren">(</span><span class="pre">uint8_t</span> <em><span class="pre">own_addr_type</span></em>, <em class="property"><span class="pre">const</span></em> <span class="pre">ble_addr_t</span> <span class="pre">*</span><em><span class="pre">peer_addr</span></em>, <span class="pre">int32_t</span> <em><span class="pre">duration_ms</span></em>, <em class="property"><span class="pre">const</span></em> <em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#c.ble_gap_conn_params" title="ble_gap_conn_params"><span class="pre">ble_gap_conn_params</span></a> <span class="pre">*</span><em><span class="pre">params</span></em>, <a class="reference internal" href="#c.ble_gap_event_fn" title="ble_gap_event_fn"><span class="pre">ble_gap_event_fn</span></a> <span class="pre">*</span><em><span class="pre">cb</span></em>, <span class="pre">void</span> <span class="pre">*</span><em><span class="pre">cb_arg</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_connect" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Initiates a connect procedure. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; BLE_HS_EALREADY if a connection attempt is already in progress; BLE_HS_EBUSY if initiating a connection is not possible because scanning is in progress; BLE_HS_EDONE if the specified peer is already connected; Other nonzero on error. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">own_addr_type</span></code>: The type of address the stack should use for itself during connection establishment.<ul> |
| <li><p>BLE_OWN_ADDR_PUBLIC</p></li> |
| <li><p>BLE_OWN_ADDR_RANDOM</p></li> |
| <li><p>BLE_OWN_ADDR_RPA_PUBLIC_DEFAULT</p></li> |
| <li><p>BLE_OWN_ADDR_RPA_RANDOM_DEFAULT </p></li> |
| </ul> |
| </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">peer_addr</span></code>: The address of the peer to connect to. If this parameter is NULL, the white list is used. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">duration_ms</span></code>: The duration of the discovery procedure. On expiration, the procedure ends and a BLE_GAP_EVENT_DISC_COMPLETE event is reported. Units are milliseconds. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">conn_params</span></code>: Additional arguments specifying the particulars of the connect procedure. Specify null for default values. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">cb</span></code>: The callback to associate with this connect procedure. When the connect procedure completes, the result is reported through this callback. If the connect procedure succeeds, the connection inherits this callback as its event-reporting mechanism. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">cb_arg</span></code>: The optional argument to pass to the callback function.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_ext_connect"> |
| <span class="target" id="group__bt__host__gap_1gaac2a3ac7b226072d98300f6fac089791"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_ext_connect</span></code><span class="sig-paren">(</span><span class="pre">uint8_t</span> <em><span class="pre">own_addr_type</span></em>, <em class="property"><span class="pre">const</span></em> <span class="pre">ble_addr_t</span> <span class="pre">*</span><em><span class="pre">peer_addr</span></em>, <span class="pre">int32_t</span> <em><span class="pre">duration_ms</span></em>, <span class="pre">uint8_t</span> <em><span class="pre">phy_mask</span></em>, <em class="property"><span class="pre">const</span></em> <em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#c.ble_gap_conn_params" title="ble_gap_conn_params"><span class="pre">ble_gap_conn_params</span></a> <span class="pre">*</span><em><span class="pre">phy_1m_conn_params</span></em>, <em class="property"><span class="pre">const</span></em> <em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#c.ble_gap_conn_params" title="ble_gap_conn_params"><span class="pre">ble_gap_conn_params</span></a> <span class="pre">*</span><em><span class="pre">phy_2m_conn_params</span></em>, <em class="property"><span class="pre">const</span></em> <em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#c.ble_gap_conn_params" title="ble_gap_conn_params"><span class="pre">ble_gap_conn_params</span></a> <span class="pre">*</span><em><span class="pre">phy_coded_conn_params</span></em>, <a class="reference internal" href="#c.ble_gap_event_fn" title="ble_gap_event_fn"><span class="pre">ble_gap_event_fn</span></a> <span class="pre">*</span><em><span class="pre">cb</span></em>, <span class="pre">void</span> <span class="pre">*</span><em><span class="pre">cb_arg</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_ext_connect" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Initiates an extended connect procedure. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; BLE_HS_EALREADY if a connection attempt is already in progress; BLE_HS_EBUSY if initiating a connection is not possible because scanning is in progress; BLE_HS_EDONE if the specified peer is already connected; Other nonzero on error. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">own_addr_type</span></code>: The type of address the stack should use for itself during connection establishment.<ul> |
| <li><p>BLE_OWN_ADDR_PUBLIC</p></li> |
| <li><p>BLE_OWN_ADDR_RANDOM</p></li> |
| <li><p>BLE_OWN_ADDR_RPA_PUBLIC_DEFAULT</p></li> |
| <li><p>BLE_OWN_ADDR_RPA_RANDOM_DEFAULT </p></li> |
| </ul> |
| </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">peer_addr</span></code>: The address of the peer to connect to. If this parameter is NULL, the white list is used. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">duration_ms</span></code>: The duration of the discovery procedure. On expiration, the procedure ends and a BLE_GAP_EVENT_DISC_COMPLETE event is reported. Units are milliseconds. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">phy_mask</span></code>: Define on which PHYs connection attempt should be done </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">phy_1m_conn_params</span></code>: Additional arguments specifying the particulars of the connect procedure. When BLE_GAP_LE_PHY_1M_MASK is set in phy_mask this parameter can be specify to null for default values. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">phy_2m_conn_params</span></code>: Additional arguments specifying the particulars of the connect procedure. When BLE_GAP_LE_PHY_2M_MASK is set in phy_mask this parameter can be specify to null for default values. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">phy_coded_conn_params</span></code>: Additional arguments specifying the particulars of the connect procedure. When BLE_GAP_LE_PHY_CODED_MASK is set in phy_mask this parameter can be specify to null for default values. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">cb</span></code>: The callback to associate with this connect procedure. When the connect procedure completes, the result is reported through this callback. If the connect procedure succeeds, the connection inherits this callback as its event-reporting mechanism. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">cb_arg</span></code>: The optional argument to pass to the callback function.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_conn_cancel"> |
| <span class="target" id="group__bt__host__gap_1ga8c83cd50d3d5b3cbd29f5a4cc09e997f"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_conn_cancel</span></code><span class="sig-paren">(</span><span class="pre">void</span><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_conn_cancel" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Aborts a connect procedure in progress. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; BLE_HS_EALREADY if there is no active connect procedure. Other nonzero on error. </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_conn_active"> |
| <span class="target" id="group__bt__host__gap_1ga74b0d090cfe7745b624dd57fc1c7f8e9"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_conn_active</span></code><span class="sig-paren">(</span><span class="pre">void</span><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_conn_active" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Indicates whether a connect procedure is currently in progress. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0: No connect procedure in progress; 1: Connect procedure in progress. </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_terminate"> |
| <span class="target" id="group__bt__host__gap_1gadf70a7fbdee2e6f3afedd064ec243540"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_terminate</span></code><span class="sig-paren">(</span><span class="pre">uint16_t</span> <em><span class="pre">conn_handle</span></em>, <span class="pre">uint8_t</span> <em><span class="pre">hci_reason</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_terminate" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Terminates an established connection. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; BLE_HS_ENOTCONN if there is no connection with the specified handle; Other nonzero on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">conn_handle</span></code>: The handle corresponding to the connection to terminate. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">hci_reason</span></code>: The HCI error code to indicate as the reason for termination.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_wl_set"> |
| <span class="target" id="group__bt__host__gap_1ga08675d23050f114ea92b1c9d123b474a"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_wl_set</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">const</span></em> <span class="pre">ble_addr_t</span> <span class="pre">*</span><em><span class="pre">addrs</span></em>, <span class="pre">uint8_t</span> <em><span class="pre">white_list_count</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_wl_set" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Overwrites the controller’s white list with the specified contents. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; nonzero on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">addrs</span></code>: The entries to write to the white list. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">white_list_count</span></code>: The number of entries in the white list.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_update_params"> |
| <span class="target" id="group__bt__host__gap_1gaed6dd4a7b1b97fb338c21f77b158fb61"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_update_params</span></code><span class="sig-paren">(</span><span class="pre">uint16_t</span> <em><span class="pre">conn_handle</span></em>, <em class="property"><span class="pre">const</span></em> <em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#c.ble_gap_upd_params" title="ble_gap_upd_params"><span class="pre">ble_gap_upd_params</span></a> <span class="pre">*</span><em><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_update_params" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Initiates a connection parameter update procedure. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; BLE_HS_ENOTCONN if the there is no connection with the specified handle; BLE_HS_EALREADY if a connection update procedure for this connection is already in progress; BLE_HS_EINVAL if requested parameters are invalid; Other nonzero on error. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">conn_handle</span></code>: The handle corresponding to the connection to update. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">params</span></code>: The connection parameters to attempt to update to.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_security_initiate"> |
| <span class="target" id="group__bt__host__gap_1gaa349cfb0648b930563430aa6d75d76e1"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_security_initiate</span></code><span class="sig-paren">(</span><span class="pre">uint16_t</span> <em><span class="pre">conn_handle</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_security_initiate" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Initiates the GAP security procedure. </p> |
| <p>Depending on connection role and stored security information this function will start appropriate security procedure (pairing or encryption).</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; BLE_HS_ENOTCONN if the there is no connection with the specified handle; BLE_HS_EALREADY if an security procedure for this connection is already in progress; Other nonzero on error. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">conn_handle</span></code>: The handle corresponding to the connection to secure.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_pair_initiate"> |
| <span class="target" id="group__bt__host__gap_1gae29480fff75b3c4710e3f0fc337e245f"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_pair_initiate</span></code><span class="sig-paren">(</span><span class="pre">uint16_t</span> <em><span class="pre">conn_handle</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_pair_initiate" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Initiates the GAP pairing procedure as a master. </p> |
| <p>This is for testing only and should not be used by application. Use <a class="reference internal" href="#group__bt__host__gap_1gaa349cfb0648b930563430aa6d75d76e1"><span class="std std-ref">ble_gap_security_initiate()</span></a> instead.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; BLE_HS_ENOTCONN if the there is no connection with the specified handle; BLE_HS_EALREADY if an pairing procedure for this connection is already in progress; Other nonzero on error. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">conn_handle</span></code>: The handle corresponding to the connection to start pairing on.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_encryption_initiate"> |
| <span class="target" id="group__bt__host__gap_1gaadde004c235ce9ea77cdc45a9c20919b"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_encryption_initiate</span></code><span class="sig-paren">(</span><span class="pre">uint16_t</span> <em><span class="pre">conn_handle</span></em>, <span class="pre">uint8_t</span> <em><span class="pre">key_size</span></em>, <em class="property"><span class="pre">const</span></em> <span class="pre">uint8_t</span> <span class="pre">*</span><em><span class="pre">ltk</span></em>, <span class="pre">uint16_t</span> <em><span class="pre">ediv</span></em>, <span class="pre">uint64_t</span> <em><span class="pre">rand_val</span></em>, <span class="pre">int</span> <em><span class="pre">auth</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_encryption_initiate" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Initiates the GAP encryption procedure as a master. </p> |
| <p>This is for testing only and should not be used by application. Use <a class="reference internal" href="#group__bt__host__gap_1gaa349cfb0648b930563430aa6d75d76e1"><span class="std std-ref">ble_gap_security_initiate()</span></a> instead.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; BLE_HS_ENOTCONN if the there is no connection with the specified handle; BLE_HS_EALREADY if an encryption procedure for this connection is already in progress; Other nonzero on error. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">conn_handle</span></code>: The handle corresponding to the connection to start encryption. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">key_size</span></code>: Encryption key size </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">ltk</span></code>: Long Term Key to be used for encryption. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">udiv</span></code>: Encryption Diversifier for LTK </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">rand_val</span></code>: Random Value for EDIV and LTK </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">auth</span></code>: If LTK provided is authenticated.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_conn_rssi"> |
| <span class="target" id="group__bt__host__gap_1ga3c1fff364d54008f110ee2dda5e91502"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_conn_rssi</span></code><span class="sig-paren">(</span><span class="pre">uint16_t</span> <em><span class="pre">conn_handle</span></em>, <span class="pre">int8_t</span> <span class="pre">*</span><em><span class="pre">out_rssi</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_conn_rssi" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Retrieves the most-recently measured RSSI for the specified connection. </p> |
| <p>A connection’s RSSI is updated whenever a data channel PDU is received.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; A BLE host HCI return code if the controller rejected the request; A BLE host core return code on unexpected error. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">conn_handle</span></code>: Specifies the connection to query. </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">out_rssi</span></code>: On success, the retrieved RSSI is written here.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_unpair"> |
| <span class="target" id="group__bt__host__gap_1gad8e872075697adadc894983bb2a7f75e"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_unpair</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">const</span></em> <span class="pre">ble_addr_t</span> <span class="pre">*</span><em><span class="pre">peer_addr</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_unpair" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Unpairs a device with the specified address. </p> |
| <p>The keys related to that peer device are removed from storage and peer address is removed from the resolve list from the controller. If a peer is connected, the connection is terminated.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; A BLE host HCI return code if the controller rejected the request; A BLE host core return code on unexpected error. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">peer_addr</span></code>: Address of the device to be unpaired</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_unpair_oldest_peer"> |
| <span class="target" id="group__bt__host__gap_1ga100cff9499ee3808528872532d4ca3c8"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_unpair_oldest_peer</span></code><span class="sig-paren">(</span><span class="pre">void</span><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_unpair_oldest_peer" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Unpairs the oldest bonded peer device. </p> |
| <p>The keys related to that peer device are removed from storage and peer address is removed from the resolve list from the controller. If a peer is connected, the connection is terminated.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; A BLE host HCI return code if the controller rejected the request; A BLE host core return code on unexpected error. </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_set_priv_mode"> |
| <span class="target" id="group__bt__host__gap_1gaf01746bdc50b8d453443193d6dc79ca5"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_set_priv_mode</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">const</span></em> <span class="pre">ble_addr_t</span> <span class="pre">*</span><em><span class="pre">peer_addr</span></em>, <span class="pre">uint8_t</span> <em><span class="pre">priv_mode</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_set_priv_mode" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Set privacy mode for specified peer device. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; nonzero on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">peer_addr</span></code>: Peer device address </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">priv_mode</span></code>: Privacy mode to be used. Can be one of following constants:<ul> |
| <li><p>BLE_GAP_PRIVATE_MODE_NETWORK</p></li> |
| <li><p>BLE_GAP_PRIVATE_MODE_DEVICE</p></li> |
| </ul> |
| </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_read_le_phy"> |
| <span class="target" id="group__bt__host__gap_1ga5f33308d3601a587aa381264d15fad8d"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_read_le_phy</span></code><span class="sig-paren">(</span><span class="pre">uint16_t</span> <em><span class="pre">conn_handle</span></em>, <span class="pre">uint8_t</span> <span class="pre">*</span><em><span class="pre">tx_phy</span></em>, <span class="pre">uint8_t</span> <span class="pre">*</span><em><span class="pre">rx_phy</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_read_le_phy" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Read PHYs used for specified connection. </p> |
| <p>On success output parameters are filled with information about used PHY type.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; nonzero on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">conn_handle</span></code>: Connection handle </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">tx_phy</span></code>: TX PHY used. Can be one of following constants:<ul> |
| <li><p>BLE_GAP_LE_PHY_1M</p></li> |
| <li><p>BLE_GAP_LE_PHY_2M</p></li> |
| <li><p>BLE_GAP_LE_PHY_CODED </p></li> |
| </ul> |
| </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">rx_phy</span></code>: RX PHY used. Can be one of following constants:<ul> |
| <li><p>BLE_GAP_LE_PHY_1M</p></li> |
| <li><p>BLE_GAP_LE_PHY_2M</p></li> |
| <li><p>BLE_GAP_LE_PHY_CODED</p></li> |
| </ul> |
| </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_set_prefered_default_le_phy"> |
| <span class="target" id="group__bt__host__gap_1ga4bc636cdf41f03b8cd3a9d2929f496e2"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_set_prefered_default_le_phy</span></code><span class="sig-paren">(</span><span class="pre">uint8_t</span> <em><span class="pre">tx_phys_mask</span></em>, <span class="pre">uint8_t</span> <em><span class="pre">rx_phys_mask</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_set_prefered_default_le_phy" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Set preferred default PHYs to be used for connections. </p> |
| <p>@params tx_phys_mask Preferred TX PHY. Can be mask of following constants:<ul class="simple"> |
| <li><p>BLE_GAP_LE_PHY_1M_MASK</p></li> |
| <li><p>BLE_GAP_LE_PHY_2M_MASK</p></li> |
| <li><p>BLE_GAP_LE_PHY_CODED_MASK</p></li> |
| <li><p>BLE_GAP_LE_PHY_ANY_MASK @params rx_phys_mask Preferred RX PHY. Can be mask of following constants:</p></li> |
| <li><p>BLE_GAP_LE_PHY_1M_MASK</p></li> |
| <li><p>BLE_GAP_LE_PHY_2M_MASK</p></li> |
| <li><p>BLE_GAP_LE_PHY_CODED_MASK</p></li> |
| <li><p>BLE_GAP_LE_PHY_ANY_MASK</p></li> |
| </ul> |
| </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; nonzero on failure. </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_set_prefered_le_phy"> |
| <span class="target" id="group__bt__host__gap_1gacbb4c5e409d4a3d59e6307cb80f05a19"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_set_prefered_le_phy</span></code><span class="sig-paren">(</span><span class="pre">uint16_t</span> <em><span class="pre">conn_handle</span></em>, <span class="pre">uint8_t</span> <em><span class="pre">tx_phys_mask</span></em>, <span class="pre">uint8_t</span> <em><span class="pre">rx_phys_mask</span></em>, <span class="pre">uint16_t</span> <em><span class="pre">phy_opts</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_set_prefered_le_phy" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Set preferred PHYs to be used for connection. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success; nonzero on failure. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">conn_handle</span></code>: Connection handle @params tx_phys_mask Preferred TX PHY. Can be mask of following constants:<ul> |
| <li><p>BLE_GAP_LE_PHY_1M_MASK</p></li> |
| <li><p>BLE_GAP_LE_PHY_2M_MASK</p></li> |
| <li><p>BLE_GAP_LE_PHY_CODED_MASK</p></li> |
| <li><p>BLE_GAP_LE_PHY_ANY_MASK @params rx_phys_mask Preferred RX PHY. Can be mask of following constants:</p></li> |
| <li><p>BLE_GAP_LE_PHY_1M_MASK</p></li> |
| <li><p>BLE_GAP_LE_PHY_2M_MASK</p></li> |
| <li><p>BLE_GAP_LE_PHY_CODED_MASK</p></li> |
| <li><p>BLE_GAP_LE_PHY_ANY_MASK </p></li> |
| </ul> |
| </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">phy_opts</span></code>: Additional PHY options. Valid values are:<ul> |
| <li><p>BLE_GAP_LE_PHY_CODED_ANY</p></li> |
| <li><p>BLE_GAP_LE_PHY_CODED_S2</p></li> |
| <li><p>BLE_GAP_LE_PHY_CODED_S8</p></li> |
| </ul> |
| </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_event_listener_register"> |
| <span class="target" id="group__bt__host__gap_1gaf48af24d6a395bb63087020274afca2f"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_event_listener_register</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#c.ble_gap_event_listener" title="ble_gap_event_listener"><span class="pre">ble_gap_event_listener</span></a> <span class="pre">*</span><em><span class="pre">listener</span></em>, <a class="reference internal" href="#c.ble_gap_event_fn" title="ble_gap_event_fn"><span class="pre">ble_gap_event_fn</span></a> <span class="pre">*</span><em><span class="pre">fn</span></em>, <span class="pre">void</span> <span class="pre">*</span><em><span class="pre">arg</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_event_listener_register" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Registers listener for GAP events. </p> |
| <p>On success listener structure will be initialized automatically and does not need to be initialized prior to calling this function. To change callback and/or argument unregister listener first and register it again.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success BLE_HS_EINVAL if no callback is specified BLE_HS_EALREADY if listener is already registered </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">listener</span></code>: Listener structure </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">fn</span></code>: Callback function </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">arg</span></code>: Callback argument</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c function"> |
| <dt id="c.ble_gap_event_listener_unregister"> |
| <span class="target" id="group__bt__host__gap_1gae18a854bb9b36c62e63264840e49c03b"></span><span class="pre">int</span> <code class="sig-name descname"><span class="pre">ble_gap_event_listener_unregister</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#c.ble_gap_event_listener" title="ble_gap_event_listener"><span class="pre">ble_gap_event_listener</span></a> <span class="pre">*</span><em><span class="pre">listener</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.ble_gap_event_listener_unregister" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Unregisters listener for GAP events. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>0 on success BLE_HS_ENOENT if listener was not registered </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">listener</span></code>: Listener structure</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_ADV_FAST_INTERVAL1_MIN"> |
| <span class="target" id="group__bt__host__gap_1ga6a076a7ab94d83f4b1e31c5538f12349"></span><code class="sig-name descname"><span class="pre">BLE_GAP_ADV_FAST_INTERVAL1_MIN</span></code><a class="headerlink" href="#c.BLE_GAP_ADV_FAST_INTERVAL1_MIN" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>30 ms. </p> |
| </dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_ADV_FAST_INTERVAL1_MAX"> |
| <span class="target" id="group__bt__host__gap_1gada0596c3f32ff589e2b5bf3ab0081143"></span><code class="sig-name descname"><span class="pre">BLE_GAP_ADV_FAST_INTERVAL1_MAX</span></code><a class="headerlink" href="#c.BLE_GAP_ADV_FAST_INTERVAL1_MAX" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>60 ms. </p> |
| </dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_ADV_FAST_INTERVAL2_MIN"> |
| <span class="target" id="group__bt__host__gap_1gaa3f4eff28cc018a4f85432fc09ea0b5b"></span><code class="sig-name descname"><span class="pre">BLE_GAP_ADV_FAST_INTERVAL2_MIN</span></code><a class="headerlink" href="#c.BLE_GAP_ADV_FAST_INTERVAL2_MIN" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>100 ms. </p> |
| </dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_ADV_FAST_INTERVAL2_MAX"> |
| <span class="target" id="group__bt__host__gap_1gacffd8246db183b7c606a50a529782803"></span><code class="sig-name descname"><span class="pre">BLE_GAP_ADV_FAST_INTERVAL2_MAX</span></code><a class="headerlink" href="#c.BLE_GAP_ADV_FAST_INTERVAL2_MAX" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>150 ms. </p> |
| </dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_SCAN_FAST_INTERVAL_MIN"> |
| <span class="target" id="group__bt__host__gap_1ga96027813c5f4dd81bab70835c6ad2545"></span><code class="sig-name descname"><span class="pre">BLE_GAP_SCAN_FAST_INTERVAL_MIN</span></code><a class="headerlink" href="#c.BLE_GAP_SCAN_FAST_INTERVAL_MIN" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>30 ms; active scanning. </p> |
| </dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_SCAN_FAST_INTERVAL_MAX"> |
| <span class="target" id="group__bt__host__gap_1ga059b44cd967bb83054f10607dc951557"></span><code class="sig-name descname"><span class="pre">BLE_GAP_SCAN_FAST_INTERVAL_MAX</span></code><a class="headerlink" href="#c.BLE_GAP_SCAN_FAST_INTERVAL_MAX" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>60 ms; active scanning. </p> |
| </dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_LIM_DISC_SCAN_INT"> |
| <span class="target" id="group__bt__host__gap_1ga2536c1c7a0420bff7dd3a2ebf11e2aa1"></span><code class="sig-name descname"><span class="pre">BLE_GAP_LIM_DISC_SCAN_INT</span></code><a class="headerlink" href="#c.BLE_GAP_LIM_DISC_SCAN_INT" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>11.25 ms; limited discovery interval. </p> |
| </dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_LIM_DISC_SCAN_WINDOW"> |
| <span class="target" id="group__bt__host__gap_1ga08ccd5164d3492ddd82718a80f5b90e4"></span><code class="sig-name descname"><span class="pre">BLE_GAP_LIM_DISC_SCAN_WINDOW</span></code><a class="headerlink" href="#c.BLE_GAP_LIM_DISC_SCAN_WINDOW" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>11.25 ms; limited discovery window (not from the spec). </p> |
| </dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_SCAN_FAST_WINDOW"> |
| <span class="target" id="group__bt__host__gap_1gacd89b242ac740cd60d19b2ecc0177cdd"></span><code class="sig-name descname"><span class="pre">BLE_GAP_SCAN_FAST_WINDOW</span></code><a class="headerlink" href="#c.BLE_GAP_SCAN_FAST_WINDOW" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>30 ms; active scanning. </p> |
| </dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_SCAN_FAST_PERIOD"> |
| <span class="target" id="group__bt__host__gap_1ga40c7f4758b1562db263273b9a0954cad"></span><code class="sig-name descname"><span class="pre">BLE_GAP_SCAN_FAST_PERIOD</span></code><a class="headerlink" href="#c.BLE_GAP_SCAN_FAST_PERIOD" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_SCAN_SLOW_INTERVAL1"> |
| <span class="target" id="group__bt__host__gap_1ga348dd6e7bd4af3cd54285d5ff5be8afc"></span><code class="sig-name descname"><span class="pre">BLE_GAP_SCAN_SLOW_INTERVAL1</span></code><a class="headerlink" href="#c.BLE_GAP_SCAN_SLOW_INTERVAL1" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>1.28 seconds; background scanning. </p> |
| </dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_SCAN_SLOW_WINDOW1"> |
| <span class="target" id="group__bt__host__gap_1ga89be29fa5147b049dc515b6eed63b350"></span><code class="sig-name descname"><span class="pre">BLE_GAP_SCAN_SLOW_WINDOW1</span></code><a class="headerlink" href="#c.BLE_GAP_SCAN_SLOW_WINDOW1" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>11.25 ms; background scanning. </p> |
| </dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_DISC_DUR_DFLT"> |
| <span class="target" id="group__bt__host__gap_1ga9cbc6c3a181b60f82618fc30809639b6"></span><code class="sig-name descname"><span class="pre">BLE_GAP_DISC_DUR_DFLT</span></code><a class="headerlink" href="#c.BLE_GAP_DISC_DUR_DFLT" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>10.24 seconds. </p> |
| </dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_CONN_DUR_DFLT"> |
| <span class="target" id="group__bt__host__gap_1ga445b1303688ad40fb68f4fa5ba7ea233"></span><code class="sig-name descname"><span class="pre">BLE_GAP_CONN_DUR_DFLT</span></code><a class="headerlink" href="#c.BLE_GAP_CONN_DUR_DFLT" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>30 seconds (not from the spec). </p> |
| </dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_CONN_PAUSE_CENTRAL"> |
| <span class="target" id="group__bt__host__gap_1ga4d5b8ae45597abdd61ecd978407349bd"></span><code class="sig-name descname"><span class="pre">BLE_GAP_CONN_PAUSE_CENTRAL</span></code><a class="headerlink" href="#c.BLE_GAP_CONN_PAUSE_CENTRAL" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>1 second. </p> |
| </dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_CONN_PAUSE_PERIPHERAL"> |
| <span class="target" id="group__bt__host__gap_1ga1b5f5314372a3bc57df933e86ee06518"></span><code class="sig-name descname"><span class="pre">BLE_GAP_CONN_PAUSE_PERIPHERAL</span></code><a class="headerlink" href="#c.BLE_GAP_CONN_PAUSE_PERIPHERAL" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>5 seconds. </p> |
| </dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_INITIAL_CONN_ITVL_MIN"> |
| <span class="target" id="group__bt__host__gap_1ga6722c2a9a059ece31f1c859529b15a95"></span><code class="sig-name descname"><span class="pre">BLE_GAP_INITIAL_CONN_ITVL_MIN</span></code><a class="headerlink" href="#c.BLE_GAP_INITIAL_CONN_ITVL_MIN" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_INITIAL_CONN_ITVL_MAX"> |
| <span class="target" id="group__bt__host__gap_1gac34f5076a71820b9e5a53e57f0cb3d2d"></span><code class="sig-name descname"><span class="pre">BLE_GAP_INITIAL_CONN_ITVL_MAX</span></code><a class="headerlink" href="#c.BLE_GAP_INITIAL_CONN_ITVL_MAX" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_ADV_DFLT_CHANNEL_MAP"> |
| <span class="target" id="group__bt__host__gap_1gad8d2f5f784022164f9c60e8bbd4687f0"></span><code class="sig-name descname"><span class="pre">BLE_GAP_ADV_DFLT_CHANNEL_MAP</span></code><a class="headerlink" href="#c.BLE_GAP_ADV_DFLT_CHANNEL_MAP" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Default channels mask: all three channels are used. </p> |
| </dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_INITIAL_CONN_LATENCY"> |
| <span class="target" id="group__bt__host__gap_1ga5584f665ab0a01adb83fcd41dfc646c0"></span><code class="sig-name descname"><span class="pre">BLE_GAP_INITIAL_CONN_LATENCY</span></code><a class="headerlink" href="#c.BLE_GAP_INITIAL_CONN_LATENCY" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_INITIAL_SUPERVISION_TIMEOUT"> |
| <span class="target" id="group__bt__host__gap_1ga89e8232d0561a06a34680209ba58f388"></span><code class="sig-name descname"><span class="pre">BLE_GAP_INITIAL_SUPERVISION_TIMEOUT</span></code><a class="headerlink" href="#c.BLE_GAP_INITIAL_SUPERVISION_TIMEOUT" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_INITIAL_CONN_MIN_CE_LEN"> |
| <span class="target" id="group__bt__host__gap_1ga3b3b34be64dfa2beaead9be4c055210a"></span><code class="sig-name descname"><span class="pre">BLE_GAP_INITIAL_CONN_MIN_CE_LEN</span></code><a class="headerlink" href="#c.BLE_GAP_INITIAL_CONN_MIN_CE_LEN" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_INITIAL_CONN_MAX_CE_LEN"> |
| <span class="target" id="group__bt__host__gap_1ga207460e5fbf71f41e78675e27f3c2cfd"></span><code class="sig-name descname"><span class="pre">BLE_GAP_INITIAL_CONN_MAX_CE_LEN</span></code><a class="headerlink" href="#c.BLE_GAP_INITIAL_CONN_MAX_CE_LEN" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_ROLE_MASTER"> |
| <span class="target" id="group__bt__host__gap_1ga83a790e46d6ff63dfcdee17024af580d"></span><code class="sig-name descname"><span class="pre">BLE_GAP_ROLE_MASTER</span></code><a class="headerlink" href="#c.BLE_GAP_ROLE_MASTER" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_ROLE_SLAVE"> |
| <span class="target" id="group__bt__host__gap_1ga54958630e8e6036a451b4fb6dcf9abff"></span><code class="sig-name descname"><span class="pre">BLE_GAP_ROLE_SLAVE</span></code><a class="headerlink" href="#c.BLE_GAP_ROLE_SLAVE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_CONNECT"> |
| <span class="target" id="group__bt__host__gap_1gad1f8d498fa341ba7d4cbcfe445f0394b"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_CONNECT</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_CONNECT" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_DISCONNECT"> |
| <span class="target" id="group__bt__host__gap_1ga55ba44bd9e485d24aee65ba030974514"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_DISCONNECT</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_DISCONNECT" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_CONN_UPDATE"> |
| <span class="target" id="group__bt__host__gap_1gac5046c2c4243c57ed33f4442a8f613ad"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_CONN_UPDATE</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_CONN_UPDATE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_CONN_UPDATE_REQ"> |
| <span class="target" id="group__bt__host__gap_1ga7a2ec515705445341d553942a1a2668e"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_CONN_UPDATE_REQ</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_CONN_UPDATE_REQ" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_L2CAP_UPDATE_REQ"> |
| <span class="target" id="group__bt__host__gap_1ga0dbb977a5fe132a805dff024f6c068f8"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_L2CAP_UPDATE_REQ</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_L2CAP_UPDATE_REQ" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_TERM_FAILURE"> |
| <span class="target" id="group__bt__host__gap_1gab6c6d6b5a9a3d70bab7476a77dd34e99"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_TERM_FAILURE</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_TERM_FAILURE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_DISC"> |
| <span class="target" id="group__bt__host__gap_1ga32de2fe50d04cd542b78f17e7625d808"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_DISC</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_DISC" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_DISC_COMPLETE"> |
| <span class="target" id="group__bt__host__gap_1gacda82432f3fee50ddc5b5d5038d35016"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_DISC_COMPLETE</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_DISC_COMPLETE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_ADV_COMPLETE"> |
| <span class="target" id="group__bt__host__gap_1ga4fdf351cd21f1de72b96d1c827fb8934"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_ADV_COMPLETE</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_ADV_COMPLETE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_ENC_CHANGE"> |
| <span class="target" id="group__bt__host__gap_1ga7df7e7542e8ad2f0da8fa4d2f6cf670d"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_ENC_CHANGE</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_ENC_CHANGE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_PASSKEY_ACTION"> |
| <span class="target" id="group__bt__host__gap_1ga3999b71788077cf2eee353eb160263fd"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_PASSKEY_ACTION</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_PASSKEY_ACTION" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_NOTIFY_RX"> |
| <span class="target" id="group__bt__host__gap_1gaf160ef5aaf133b4baf00318111e25842"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_NOTIFY_RX</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_NOTIFY_RX" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_NOTIFY_TX"> |
| <span class="target" id="group__bt__host__gap_1gab5e0a0c47b40519d59027c26db4058ae"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_NOTIFY_TX</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_NOTIFY_TX" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_SUBSCRIBE"> |
| <span class="target" id="group__bt__host__gap_1ga6cfcbedd53d09b31b45147173cd39740"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_SUBSCRIBE</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_SUBSCRIBE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_MTU"> |
| <span class="target" id="group__bt__host__gap_1gadabadc59077c0c2aa0f0c58e11fb0977"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_MTU</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_MTU" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_IDENTITY_RESOLVED"> |
| <span class="target" id="group__bt__host__gap_1ga37255f5190520425d038dee11b1d6592"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_IDENTITY_RESOLVED</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_IDENTITY_RESOLVED" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_REPEAT_PAIRING"> |
| <span class="target" id="group__bt__host__gap_1gab914c0dac2d864154d4e12959ec0e04d"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_REPEAT_PAIRING</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_REPEAT_PAIRING" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_PHY_UPDATE_COMPLETE"> |
| <span class="target" id="group__bt__host__gap_1gaf94d3e0539f1637743c1b08e02f07ad7"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_PHY_UPDATE_COMPLETE</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_PHY_UPDATE_COMPLETE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_EXT_DISC"> |
| <span class="target" id="group__bt__host__gap_1ga62f0b925adccefc779cfe0ceb8db1155"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_EXT_DISC</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_EXT_DISC" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_PERIODIC_SYNC"> |
| <span class="target" id="group__bt__host__gap_1ga2f0a9b941c1c3e137b6679f5d0f6f28a"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_PERIODIC_SYNC</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_PERIODIC_SYNC" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_PERIODIC_REPORT"> |
| <span class="target" id="group__bt__host__gap_1ga2f98e11e53173fe2da243de2cd6fe3b6"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_PERIODIC_REPORT</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_PERIODIC_REPORT" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_PERIODIC_SYNC_LOST"> |
| <span class="target" id="group__bt__host__gap_1gacbed72d7f68be0d01984a7a495823470"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_PERIODIC_SYNC_LOST</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_PERIODIC_SYNC_LOST" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_SCAN_REQ_RCVD"> |
| <span class="target" id="group__bt__host__gap_1gabe33341ba9822580cfd62a56562d4fee"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_SCAN_REQ_RCVD</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_SCAN_REQ_RCVD" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EVENT_PERIODIC_TRANSFER"> |
| <span class="target" id="group__bt__host__gap_1gab08166fb457c2d1631e389d19345bc5b"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EVENT_PERIODIC_TRANSFER</span></code><a class="headerlink" href="#c.BLE_GAP_EVENT_PERIODIC_TRANSFER" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_SUBSCRIBE_REASON_WRITE"> |
| <span class="target" id="group__bt__host__gap_1gaf2e99ccbc0dbac2a09128da9a35db2e3"></span><code class="sig-name descname"><span class="pre">BLE_GAP_SUBSCRIBE_REASON_WRITE</span></code><a class="headerlink" href="#c.BLE_GAP_SUBSCRIBE_REASON_WRITE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Peer’s CCCD subscription state changed due to a descriptor write. </p> |
| </dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_SUBSCRIBE_REASON_TERM"> |
| <span class="target" id="group__bt__host__gap_1ga34836adfaef5cedb760b374dc526cdb6"></span><code class="sig-name descname"><span class="pre">BLE_GAP_SUBSCRIBE_REASON_TERM</span></code><a class="headerlink" href="#c.BLE_GAP_SUBSCRIBE_REASON_TERM" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Peer’s CCCD subscription state cleared due to connection termination. </p> |
| </dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_SUBSCRIBE_REASON_RESTORE"> |
| <span class="target" id="group__bt__host__gap_1gacfc0243ccfeed07926f536071f2236db"></span><code class="sig-name descname"><span class="pre">BLE_GAP_SUBSCRIBE_REASON_RESTORE</span></code><a class="headerlink" href="#c.BLE_GAP_SUBSCRIBE_REASON_RESTORE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Peer’s CCCD subscription state changed due to restore from persistence (bonding restored). </p> |
| </dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_REPEAT_PAIRING_RETRY"> |
| <span class="target" id="group__bt__host__gap_1gaf4870fa047e929ab9fc22749163bdd42"></span><code class="sig-name descname"><span class="pre">BLE_GAP_REPEAT_PAIRING_RETRY</span></code><a class="headerlink" href="#c.BLE_GAP_REPEAT_PAIRING_RETRY" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_REPEAT_PAIRING_IGNORE"> |
| <span class="target" id="group__bt__host__gap_1gaa7ee6468c223e6a9962fe5b1f7ca172e"></span><code class="sig-name descname"><span class="pre">BLE_GAP_REPEAT_PAIRING_IGNORE</span></code><a class="headerlink" href="#c.BLE_GAP_REPEAT_PAIRING_IGNORE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EXT_ADV_DATA_STATUS_COMPLETE"> |
| <span class="target" id="group__bt__host__gap_1ga8401a66865bd4799c468a931d105317c"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EXT_ADV_DATA_STATUS_COMPLETE</span></code><a class="headerlink" href="#c.BLE_GAP_EXT_ADV_DATA_STATUS_COMPLETE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EXT_ADV_DATA_STATUS_INCOMPLETE"> |
| <span class="target" id="group__bt__host__gap_1ga661d0d8fac94c150368139ea7ce6f4c1"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EXT_ADV_DATA_STATUS_INCOMPLETE</span></code><a class="headerlink" href="#c.BLE_GAP_EXT_ADV_DATA_STATUS_INCOMPLETE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_EXT_ADV_DATA_STATUS_TRUNCATED"> |
| <span class="target" id="group__bt__host__gap_1ga5407e601a0d32a284d751a4b32a5f79e"></span><code class="sig-name descname"><span class="pre">BLE_GAP_EXT_ADV_DATA_STATUS_TRUNCATED</span></code><a class="headerlink" href="#c.BLE_GAP_EXT_ADV_DATA_STATUS_TRUNCATED" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_CONN_MODE_NON"> |
| <span class="target" id="group__bt__host__gap_1gad0f992ebf6098ea8468edabfd5c78c32"></span><code class="sig-name descname"><span class="pre">BLE_GAP_CONN_MODE_NON</span></code><a class="headerlink" href="#c.BLE_GAP_CONN_MODE_NON" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_CONN_MODE_DIR"> |
| <span class="target" id="group__bt__host__gap_1ga2d0e7f9aa460c056f1a43993c7c9215f"></span><code class="sig-name descname"><span class="pre">BLE_GAP_CONN_MODE_DIR</span></code><a class="headerlink" href="#c.BLE_GAP_CONN_MODE_DIR" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_CONN_MODE_UND"> |
| <span class="target" id="group__bt__host__gap_1ga6a11b3abac7339f53d0c9d0ed20844b3"></span><code class="sig-name descname"><span class="pre">BLE_GAP_CONN_MODE_UND</span></code><a class="headerlink" href="#c.BLE_GAP_CONN_MODE_UND" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_DISC_MODE_NON"> |
| <span class="target" id="group__bt__host__gap_1ga481c1714df889f69f1a09682bc403e4c"></span><code class="sig-name descname"><span class="pre">BLE_GAP_DISC_MODE_NON</span></code><a class="headerlink" href="#c.BLE_GAP_DISC_MODE_NON" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_DISC_MODE_LTD"> |
| <span class="target" id="group__bt__host__gap_1ga50f173ea0b1b9644925083a4010a9e97"></span><code class="sig-name descname"><span class="pre">BLE_GAP_DISC_MODE_LTD</span></code><a class="headerlink" href="#c.BLE_GAP_DISC_MODE_LTD" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_DISC_MODE_GEN"> |
| <span class="target" id="group__bt__host__gap_1gac2d01d88809260e8bebaf43c14f40cc0"></span><code class="sig-name descname"><span class="pre">BLE_GAP_DISC_MODE_GEN</span></code><a class="headerlink" href="#c.BLE_GAP_DISC_MODE_GEN" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_PRIVATE_MODE_NETWORK"> |
| <span class="target" id="group__bt__host__gap_1gaca5636685ecc4454850305159f078e2c"></span><code class="sig-name descname"><span class="pre">BLE_GAP_PRIVATE_MODE_NETWORK</span></code><a class="headerlink" href="#c.BLE_GAP_PRIVATE_MODE_NETWORK" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_PRIVATE_MODE_DEVICE"> |
| <span class="target" id="group__bt__host__gap_1ga32f330eda97d713273d5e6e3013181d6"></span><code class="sig-name descname"><span class="pre">BLE_GAP_PRIVATE_MODE_DEVICE</span></code><a class="headerlink" href="#c.BLE_GAP_PRIVATE_MODE_DEVICE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_LE_PHY_1M"> |
| <span class="target" id="group__bt__host__gap_1gaa7df87009bd8f134bc8574ff73568adb"></span><code class="sig-name descname"><span class="pre">BLE_GAP_LE_PHY_1M</span></code><a class="headerlink" href="#c.BLE_GAP_LE_PHY_1M" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_LE_PHY_2M"> |
| <span class="target" id="group__bt__host__gap_1ga01633c5f1f72b898917286361baefa67"></span><code class="sig-name descname"><span class="pre">BLE_GAP_LE_PHY_2M</span></code><a class="headerlink" href="#c.BLE_GAP_LE_PHY_2M" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_LE_PHY_CODED"> |
| <span class="target" id="group__bt__host__gap_1ga08b40baa5641861eb35fe7afccd3708f"></span><code class="sig-name descname"><span class="pre">BLE_GAP_LE_PHY_CODED</span></code><a class="headerlink" href="#c.BLE_GAP_LE_PHY_CODED" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_LE_PHY_1M_MASK"> |
| <span class="target" id="group__bt__host__gap_1gaee41a141627a7fc9a2d92a8b8cf6acb9"></span><code class="sig-name descname"><span class="pre">BLE_GAP_LE_PHY_1M_MASK</span></code><a class="headerlink" href="#c.BLE_GAP_LE_PHY_1M_MASK" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_LE_PHY_2M_MASK"> |
| <span class="target" id="group__bt__host__gap_1ga814178035e36496088a792ea22384826"></span><code class="sig-name descname"><span class="pre">BLE_GAP_LE_PHY_2M_MASK</span></code><a class="headerlink" href="#c.BLE_GAP_LE_PHY_2M_MASK" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_LE_PHY_CODED_MASK"> |
| <span class="target" id="group__bt__host__gap_1ga2309ec68b0b5ec9e77a0c12e2377e62a"></span><code class="sig-name descname"><span class="pre">BLE_GAP_LE_PHY_CODED_MASK</span></code><a class="headerlink" href="#c.BLE_GAP_LE_PHY_CODED_MASK" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_LE_PHY_ANY_MASK"> |
| <span class="target" id="group__bt__host__gap_1ga0f59f4dfd128ac08854051fd379a1d75"></span><code class="sig-name descname"><span class="pre">BLE_GAP_LE_PHY_ANY_MASK</span></code><a class="headerlink" href="#c.BLE_GAP_LE_PHY_ANY_MASK" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_LE_PHY_CODED_ANY"> |
| <span class="target" id="group__bt__host__gap_1gab254ae1623c5c6abbac8b84675586e20"></span><code class="sig-name descname"><span class="pre">BLE_GAP_LE_PHY_CODED_ANY</span></code><a class="headerlink" href="#c.BLE_GAP_LE_PHY_CODED_ANY" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_LE_PHY_CODED_S2"> |
| <span class="target" id="group__bt__host__gap_1ga20742c40adcec1fb17aa2a9c6d96a6da"></span><code class="sig-name descname"><span class="pre">BLE_GAP_LE_PHY_CODED_S2</span></code><a class="headerlink" href="#c.BLE_GAP_LE_PHY_CODED_S2" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c macro"> |
| <dt id="c.BLE_GAP_LE_PHY_CODED_S8"> |
| <span class="target" id="group__bt__host__gap_1ga08fc1c9626c46172ad159a88d78da626"></span><code class="sig-name descname"><span class="pre">BLE_GAP_LE_PHY_CODED_S8</span></code><a class="headerlink" href="#c.BLE_GAP_LE_PHY_CODED_S8" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="c struct"> |
| <dt id="c.ble_gap_sec_state"> |
| <span class="target" id="structble__gap__sec__state"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">ble_gap_sec_state</span></code><a class="headerlink" href="#c.ble_gap_sec_state" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><em>#include <ble_gap.h></em><p>Connection security state. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="c var"> |
| <dt id="c.ble_gap_sec_state.encrypted"> |
| <span class="target" id="structble__gap__sec__state_1aaf6928c2ea0d2e67031b9c7658603b8d"></span><span class="pre">unsigned</span> <code class="sig-name descname"><span class="pre">encrypted</span></code><a class="headerlink" href="#c.ble_gap_sec_state.encrypted" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>If connection is encrypted. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_sec_state.authenticated"> |
| <span class="target" id="structble__gap__sec__state_1a8b14a127153d11b63499b238a76ab2ce"></span><span class="pre">unsigned</span> <code class="sig-name descname"><span class="pre">authenticated</span></code><a class="headerlink" href="#c.ble_gap_sec_state.authenticated" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>If connection is authenticated. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_sec_state.bonded"> |
| <span class="target" id="structble__gap__sec__state_1a2d066a34d292d03f89ee7f89e74fd1b8"></span><span class="pre">unsigned</span> <code class="sig-name descname"><span class="pre">bonded</span></code><a class="headerlink" href="#c.ble_gap_sec_state.bonded" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>If connection is bonded (security information is stored) </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_sec_state.key_size"> |
| <span class="target" id="structble__gap__sec__state_1a342a95a88b50ae2525c92ef7b64c84fc"></span><span class="pre">unsigned</span> <code class="sig-name descname"><span class="pre">key_size</span></code><a class="headerlink" href="#c.ble_gap_sec_state.key_size" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Size of a key used for encryption. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="c struct"> |
| <dt id="c.ble_gap_adv_params"> |
| <span class="target" id="structble__gap__adv__params"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">ble_gap_adv_params</span></code><a class="headerlink" href="#c.ble_gap_adv_params" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><em>#include <ble_gap.h></em><p>Advertising parameters. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="c var"> |
| <dt id="c.ble_gap_adv_params.conn_mode"> |
| <span class="target" id="structble__gap__adv__params_1aa1c42761193e11c9d7a633b60573e835"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">conn_mode</span></code><a class="headerlink" href="#c.ble_gap_adv_params.conn_mode" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Advertising mode. </p> |
| <p>Can be one of following constants:<ul class="simple"> |
| <li><p>BLE_GAP_CONN_MODE_NON (non-connectable; 3.C.9.3.2).</p></li> |
| <li><p>BLE_GAP_CONN_MODE_DIR (directed-connectable; 3.C.9.3.3).</p></li> |
| <li><p>BLE_GAP_CONN_MODE_UND (undirected-connectable; 3.C.9.3.4). </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_adv_params.disc_mode"> |
| <span class="target" id="structble__gap__adv__params_1a44294c072dd057304beabc83780baa47"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">disc_mode</span></code><a class="headerlink" href="#c.ble_gap_adv_params.disc_mode" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Discoverable mode. </p> |
| <p>Can be one of following constants:<ul class="simple"> |
| <li><p>BLE_GAP_DISC_MODE_NON (non-discoverable; 3.C.9.2.2).</p></li> |
| <li><p>BLE_GAP_DISC_MODE_LTD (limited-discoverable; 3.C.9.2.3).</p></li> |
| <li><p>BLE_GAP_DISC_MODE_GEN (general-discoverable; 3.C.9.2.4). </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_adv_params.itvl_min"> |
| <span class="target" id="structble__gap__adv__params_1a3e0dba3a31c2b6b4f4a7339ebb47764b"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">itvl_min</span></code><a class="headerlink" href="#c.ble_gap_adv_params.itvl_min" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Minimum advertising interval, if 0 stack use sane defaults. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_adv_params.itvl_max"> |
| <span class="target" id="structble__gap__adv__params_1a636bdce5ad8020aed1f824eda7c816e4"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">itvl_max</span></code><a class="headerlink" href="#c.ble_gap_adv_params.itvl_max" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Maximum advertising interval, if 0 stack use sane defaults. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_adv_params.channel_map"> |
| <span class="target" id="structble__gap__adv__params_1a172466cc3c10d00453bd38ca85162510"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">channel_map</span></code><a class="headerlink" href="#c.ble_gap_adv_params.channel_map" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Advertising channel map , if 0 stack use sane defaults. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_adv_params.filter_policy"> |
| <span class="target" id="structble__gap__adv__params_1abe14b7798a82023ab077f0cbdfc9b540"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">filter_policy</span></code><a class="headerlink" href="#c.ble_gap_adv_params.filter_policy" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Advertising Filter policy. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_adv_params.high_duty_cycle"> |
| <span class="target" id="structble__gap__adv__params_1a3a14558f86b73c487c296a85ce4eab0d"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">high_duty_cycle</span></code><a class="headerlink" href="#c.ble_gap_adv_params.high_duty_cycle" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>If do High Duty cycle for Directed Advertising. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="c struct"> |
| <dt id="c.ble_gap_conn_desc"> |
| <span class="target" id="structble__gap__conn__desc"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">ble_gap_conn_desc</span></code><a class="headerlink" href="#c.ble_gap_conn_desc" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><em>#include <ble_gap.h></em><p>Connection descriptor. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="c var"> |
| <dt id="c.ble_gap_conn_desc.sec_state"> |
| <span class="target" id="structble__gap__conn__desc_1a3c71c1a24f14c2a1391d2f47d6c14894"></span><em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#c.ble_gap_sec_state" title="ble_gap_sec_state"><span class="pre">ble_gap_sec_state</span></a> <code class="sig-name descname"><span class="pre">sec_state</span></code><a class="headerlink" href="#c.ble_gap_conn_desc.sec_state" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Connection security state. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_conn_desc.our_id_addr"> |
| <span class="target" id="structble__gap__conn__desc_1a599a69fd5f1e12606d648405cc842d99"></span><span class="pre">ble_addr_t</span> <code class="sig-name descname"><span class="pre">our_id_addr</span></code><a class="headerlink" href="#c.ble_gap_conn_desc.our_id_addr" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Local identity address. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_conn_desc.peer_id_addr"> |
| <span class="target" id="structble__gap__conn__desc_1ac41be91e899fcae8c0ecd0790cbd7d1f"></span><span class="pre">ble_addr_t</span> <code class="sig-name descname"><span class="pre">peer_id_addr</span></code><a class="headerlink" href="#c.ble_gap_conn_desc.peer_id_addr" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Peer identity address. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_conn_desc.our_ota_addr"> |
| <span class="target" id="structble__gap__conn__desc_1a8f1c6bfa286ea5d85c4c5dcdbd1b67f9"></span><span class="pre">ble_addr_t</span> <code class="sig-name descname"><span class="pre">our_ota_addr</span></code><a class="headerlink" href="#c.ble_gap_conn_desc.our_ota_addr" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Local over-the-air address. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_conn_desc.peer_ota_addr"> |
| <span class="target" id="structble__gap__conn__desc_1a18a7e71eb76a98af028d39e3e98cad33"></span><span class="pre">ble_addr_t</span> <code class="sig-name descname"><span class="pre">peer_ota_addr</span></code><a class="headerlink" href="#c.ble_gap_conn_desc.peer_ota_addr" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Peer over-the-air address. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_conn_desc.conn_handle"> |
| <span class="target" id="structble__gap__conn__desc_1a7d9225e51272ee33e239f3eddf7b1380"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">conn_handle</span></code><a class="headerlink" href="#c.ble_gap_conn_desc.conn_handle" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Connection handle. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_conn_desc.conn_itvl"> |
| <span class="target" id="structble__gap__conn__desc_1ad4b20b19147e54d21ea26ad78f5ed54f"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">conn_itvl</span></code><a class="headerlink" href="#c.ble_gap_conn_desc.conn_itvl" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Connection interval. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_conn_desc.conn_latency"> |
| <span class="target" id="structble__gap__conn__desc_1a502e7ced5ee5f4f0b2aeda126994b96c"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">conn_latency</span></code><a class="headerlink" href="#c.ble_gap_conn_desc.conn_latency" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Connection latency. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_conn_desc.supervision_timeout"> |
| <span class="target" id="structble__gap__conn__desc_1a42e699ee972044595137056543a12c9b"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">supervision_timeout</span></code><a class="headerlink" href="#c.ble_gap_conn_desc.supervision_timeout" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Connection supervision timeout. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_conn_desc.role"> |
| <span class="target" id="structble__gap__conn__desc_1a34b47430256ab3bcfa33e798b4d86de2"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">role</span></code><a class="headerlink" href="#c.ble_gap_conn_desc.role" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Connection Role Possible values BLE_GAP_ROLE_SLAVE or BLE_GAP_ROLE_MASTER. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_conn_desc.master_clock_accuracy"> |
| <span class="target" id="structble__gap__conn__desc_1a763fe1323a26bb08d7e4b32e482e0b12"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">master_clock_accuracy</span></code><a class="headerlink" href="#c.ble_gap_conn_desc.master_clock_accuracy" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Master clock accuracy. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="c struct"> |
| <dt id="c.ble_gap_conn_params"> |
| <span class="target" id="structble__gap__conn__params"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">ble_gap_conn_params</span></code><a class="headerlink" href="#c.ble_gap_conn_params" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><em>#include <ble_gap.h></em><p>Connection parameters </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="c var"> |
| <dt id="c.ble_gap_conn_params.scan_itvl"> |
| <span class="target" id="structble__gap__conn__params_1ab17fee989fc6b25db207ad5908790faf"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">scan_itvl</span></code><a class="headerlink" href="#c.ble_gap_conn_params.scan_itvl" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Scan interval in 0.625ms units. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_conn_params.scan_window"> |
| <span class="target" id="structble__gap__conn__params_1aa85d56b1dfc8a701638a1de95140ae06"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">scan_window</span></code><a class="headerlink" href="#c.ble_gap_conn_params.scan_window" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Scan window in 0.625ms units. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_conn_params.itvl_min"> |
| <span class="target" id="structble__gap__conn__params_1a9f81e6bb2fad008b0eb8970193dc8126"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">itvl_min</span></code><a class="headerlink" href="#c.ble_gap_conn_params.itvl_min" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Minimum value for connection interval in 1.25ms units. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_conn_params.itvl_max"> |
| <span class="target" id="structble__gap__conn__params_1a66e6556e1572271e0130b2853f2cfe0e"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">itvl_max</span></code><a class="headerlink" href="#c.ble_gap_conn_params.itvl_max" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Maximum value for connection interval in 1.25ms units. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_conn_params.latency"> |
| <span class="target" id="structble__gap__conn__params_1a56650c947c3417554a4b01e10a26921b"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">latency</span></code><a class="headerlink" href="#c.ble_gap_conn_params.latency" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Connection latency. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_conn_params.supervision_timeout"> |
| <span class="target" id="structble__gap__conn__params_1a78d7ba66b51d19f1dfc87ab09f45c989"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">supervision_timeout</span></code><a class="headerlink" href="#c.ble_gap_conn_params.supervision_timeout" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Supervision timeout in 10ms units. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_conn_params.min_ce_len"> |
| <span class="target" id="structble__gap__conn__params_1a2c400e2e1402b2c011231d405fd77cf3"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">min_ce_len</span></code><a class="headerlink" href="#c.ble_gap_conn_params.min_ce_len" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Minimum length of connection event in 0.625ms units. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_conn_params.max_ce_len"> |
| <span class="target" id="structble__gap__conn__params_1a88e75d3a58aabe264695e6cad93787f0"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">max_ce_len</span></code><a class="headerlink" href="#c.ble_gap_conn_params.max_ce_len" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Maximum length of connection event in 0.625ms units. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="c struct"> |
| <dt id="c.ble_gap_ext_disc_params"> |
| <span class="target" id="structble__gap__ext__disc__params"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">ble_gap_ext_disc_params</span></code><a class="headerlink" href="#c.ble_gap_ext_disc_params" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><em>#include <ble_gap.h></em><p>Extended discovery parameters. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_disc_params.itvl"> |
| <span class="target" id="structble__gap__ext__disc__params_1af2173a308a916f4af6a81ac8aa5e098d"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">itvl</span></code><a class="headerlink" href="#c.ble_gap_ext_disc_params.itvl" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Scan interval in 0.625ms units. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_disc_params.window"> |
| <span class="target" id="structble__gap__ext__disc__params_1aceb39662d47bf7840a25254dee2d248e"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">window</span></code><a class="headerlink" href="#c.ble_gap_ext_disc_params.window" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Scan window in 0.625ms units. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_disc_params.passive"> |
| <span class="target" id="structble__gap__ext__disc__params_1ab9ca212e9d669839c4336b4c664a9244"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">passive</span></code><a class="headerlink" href="#c.ble_gap_ext_disc_params.passive" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>If passive scan should be used. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="c struct"> |
| <dt id="c.ble_gap_disc_params"> |
| <span class="target" id="structble__gap__disc__params"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">ble_gap_disc_params</span></code><a class="headerlink" href="#c.ble_gap_disc_params" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><em>#include <ble_gap.h></em><p>Discovery parameters. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="c var"> |
| <dt id="c.ble_gap_disc_params.itvl"> |
| <span class="target" id="structble__gap__disc__params_1a2248505bf45458de1386e7c0378ac179"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">itvl</span></code><a class="headerlink" href="#c.ble_gap_disc_params.itvl" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Scan interval in 0.625ms units. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_disc_params.window"> |
| <span class="target" id="structble__gap__disc__params_1acff9e2b0d88b0230c4ba0255d649eeff"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">window</span></code><a class="headerlink" href="#c.ble_gap_disc_params.window" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Scan window in 0.625ms units. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_disc_params.filter_policy"> |
| <span class="target" id="structble__gap__disc__params_1a2ca7738d35d9fb7773de8007fdc4004a"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">filter_policy</span></code><a class="headerlink" href="#c.ble_gap_disc_params.filter_policy" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Scan filter policy. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_disc_params.limited"> |
| <span class="target" id="structble__gap__disc__params_1a2f46f3cc4655de6fe66ca2464e9a2a70"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">limited</span></code><a class="headerlink" href="#c.ble_gap_disc_params.limited" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>If limited discovery procedure should be used. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_disc_params.passive"> |
| <span class="target" id="structble__gap__disc__params_1afcf4f91848a3f97af9c290fde1924834"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">passive</span></code><a class="headerlink" href="#c.ble_gap_disc_params.passive" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>If passive scan should be used. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_disc_params.filter_duplicates"> |
| <span class="target" id="structble__gap__disc__params_1aec31e0f80b6f9bc642a64348d6dfeb7e"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">filter_duplicates</span></code><a class="headerlink" href="#c.ble_gap_disc_params.filter_duplicates" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>If enable duplicates filtering. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="c struct"> |
| <dt id="c.ble_gap_upd_params"> |
| <span class="target" id="structble__gap__upd__params"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">ble_gap_upd_params</span></code><a class="headerlink" href="#c.ble_gap_upd_params" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><em>#include <ble_gap.h></em><p>Connection parameters update parameters. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="c var"> |
| <dt id="c.ble_gap_upd_params.itvl_min"> |
| <span class="target" id="structble__gap__upd__params_1a509dff483384862fb48f974582bd7941"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">itvl_min</span></code><a class="headerlink" href="#c.ble_gap_upd_params.itvl_min" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Minimum value for connection interval in 1.25ms units. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_upd_params.itvl_max"> |
| <span class="target" id="structble__gap__upd__params_1a1a0ee78cd9711af0564688e889209eeb"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">itvl_max</span></code><a class="headerlink" href="#c.ble_gap_upd_params.itvl_max" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Maximum value for connection interval in 1.25ms units. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_upd_params.latency"> |
| <span class="target" id="structble__gap__upd__params_1a5009d22f432e0b9b8a2903b45796884d"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">latency</span></code><a class="headerlink" href="#c.ble_gap_upd_params.latency" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Connection latency. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_upd_params.supervision_timeout"> |
| <span class="target" id="structble__gap__upd__params_1af2d9309235f8e9ea666d9a6cc5c11ce8"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">supervision_timeout</span></code><a class="headerlink" href="#c.ble_gap_upd_params.supervision_timeout" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Supervision timeout in 10ms units. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_upd_params.min_ce_len"> |
| <span class="target" id="structble__gap__upd__params_1a35343b873333c2920e5409b61bcff254"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">min_ce_len</span></code><a class="headerlink" href="#c.ble_gap_upd_params.min_ce_len" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Minimum length of connection event in 0.625ms units. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_upd_params.max_ce_len"> |
| <span class="target" id="structble__gap__upd__params_1a1b7fe9826d766c770c91762ba4087a5f"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">max_ce_len</span></code><a class="headerlink" href="#c.ble_gap_upd_params.max_ce_len" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Maximum length of connection event in 0.625ms units. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="c struct"> |
| <dt id="c.ble_gap_passkey_params"> |
| <span class="target" id="structble__gap__passkey__params"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">ble_gap_passkey_params</span></code><a class="headerlink" href="#c.ble_gap_passkey_params" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><em>#include <ble_gap.h></em><p>Passkey query. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="c var"> |
| <dt id="c.ble_gap_passkey_params.action"> |
| <span class="target" id="structble__gap__passkey__params_1afe6be075bf72527425cd761a45705fa0"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">action</span></code><a class="headerlink" href="#c.ble_gap_passkey_params.action" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Passkey action, can be one of following constants: </p> |
| <p><ul class="simple"> |
| <li><p>BLE_SM_IOACT_NONE</p></li> |
| <li><p>BLE_SM_IOACT_OOB</p></li> |
| <li><p>BLE_SM_IOACT_INPUT</p></li> |
| <li><p>BLE_SM_IOACT_DISP</p></li> |
| <li><p>BLE_SM_IOACT_NUMCMP </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_passkey_params.numcmp"> |
| <span class="target" id="structble__gap__passkey__params_1a829a82af1f9f2e5321bd578b3caa84f4"></span><span class="pre">uint32_t</span> <code class="sig-name descname"><span class="pre">numcmp</span></code><a class="headerlink" href="#c.ble_gap_passkey_params.numcmp" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Passkey to compare, valid for BLE_SM_IOACT_NUMCMP action. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="c struct"> |
| <dt id="c.ble_gap_ext_disc_desc"> |
| <span class="target" id="structble__gap__ext__disc__desc"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">ble_gap_ext_disc_desc</span></code><a class="headerlink" href="#c.ble_gap_ext_disc_desc" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><em>#include <ble_gap.h></em><p>Extended advertising report. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_disc_desc.props"> |
| <span class="target" id="structble__gap__ext__disc__desc_1ae74c4ba5eac05526d6cd18af630e0a28"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">props</span></code><a class="headerlink" href="#c.ble_gap_ext_disc_desc.props" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Report properties bitmask. </p> |
| <p><ul class="simple"> |
| <li><p>BLE_HCI_ADV_CONN_MASK</p></li> |
| <li><p>BLE_HCI_ADV_SCAN_MASK</p></li> |
| <li><p>BLE_HCI_ADV_DIRECT_MASK</p></li> |
| <li><p>BLE_HCI_ADV_SCAN_RSP_MASK</p></li> |
| <li><p>BLE_HCI_ADV_LEGACY_MASK </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_disc_desc.data_status"> |
| <span class="target" id="structble__gap__ext__disc__desc_1a3df2e0a246ce3eeb429ae635ef0cc8ed"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">data_status</span></code><a class="headerlink" href="#c.ble_gap_ext_disc_desc.data_status" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Advertising data status, can be one of following constants: </p> |
| <p><ul class="simple"> |
| <li><p>BLE_GAP_EXT_ADV_DATA_STATUS_COMPLETE</p></li> |
| <li><p>BLE_GAP_EXT_ADV_DATA_STATUS_INCOMPLETE</p></li> |
| <li><p>BLE_GAP_EXT_ADV_DATA_STATUS_TRUNCATED </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_disc_desc.legacy_event_type"> |
| <span class="target" id="structble__gap__ext__disc__desc_1abcddecd0bd6d437157975b6a693bf6f7"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">legacy_event_type</span></code><a class="headerlink" href="#c.ble_gap_ext_disc_desc.legacy_event_type" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Legacy advertising PDU type. </p> |
| <p>Valid if BLE_HCI_ADV_LEGACY_MASK props is set. Can be one of following constants:<ul class="simple"> |
| <li><p>BLE_HCI_ADV_RPT_EVTYPE_ADV_IND</p></li> |
| <li><p>BLE_HCI_ADV_RPT_EVTYPE_DIR_IND</p></li> |
| <li><p>BLE_HCI_ADV_RPT_EVTYPE_SCAN_IND</p></li> |
| <li><p>BLE_HCI_ADV_RPT_EVTYPE_NONCONN_IND</p></li> |
| <li><p>BLE_HCI_ADV_RPT_EVTYPE_SCAN_RSP </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_disc_desc.addr"> |
| <span class="target" id="structble__gap__ext__disc__desc_1add997faa4769c845475ef7e15c90a544"></span><span class="pre">ble_addr_t</span> <code class="sig-name descname"><span class="pre">addr</span></code><a class="headerlink" href="#c.ble_gap_ext_disc_desc.addr" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Advertiser address. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_disc_desc.rssi"> |
| <span class="target" id="structble__gap__ext__disc__desc_1a2459f3cade18b856f666be94b804a25a"></span><span class="pre">int8_t</span> <code class="sig-name descname"><span class="pre">rssi</span></code><a class="headerlink" href="#c.ble_gap_ext_disc_desc.rssi" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Received signal strength indication in dBm (127 if unavailable) </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_disc_desc.tx_power"> |
| <span class="target" id="structble__gap__ext__disc__desc_1af6fc6b76eadf93298cff063ad2e39b37"></span><span class="pre">int8_t</span> <code class="sig-name descname"><span class="pre">tx_power</span></code><a class="headerlink" href="#c.ble_gap_ext_disc_desc.tx_power" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Advertiser transmit power in dBm (127 if unavailable) </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_disc_desc.sid"> |
| <span class="target" id="structble__gap__ext__disc__desc_1a91778c07c20acf1ca8d9702f15d63bea"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">sid</span></code><a class="headerlink" href="#c.ble_gap_ext_disc_desc.sid" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Advertising Set ID. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_disc_desc.prim_phy"> |
| <span class="target" id="structble__gap__ext__disc__desc_1a382d42996c520169857e63171424ad85"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">prim_phy</span></code><a class="headerlink" href="#c.ble_gap_ext_disc_desc.prim_phy" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Primary advertising PHY, can be one of following constants: </p> |
| <p><ul class="simple"> |
| <li><p>BLE_HCI_LE_PHY_1M</p></li> |
| <li><p>BLE_HCI_LE_PHY_CODED </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_disc_desc.sec_phy"> |
| <span class="target" id="structble__gap__ext__disc__desc_1adacb2ec09d7a53c91209532de1c67c90"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">sec_phy</span></code><a class="headerlink" href="#c.ble_gap_ext_disc_desc.sec_phy" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Secondary advertising PHY, can be one of following constants: </p> |
| <p><ul class="simple"> |
| <li><p>BLE_HCI_LE_PHY_1M</p></li> |
| <li><p>LE_HCI_LE_PHY_2M</p></li> |
| <li><p>BLE_HCI_LE_PHY_CODED </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_disc_desc.periodic_adv_itvl"> |
| <span class="target" id="structble__gap__ext__disc__desc_1ac9ff6b243c16a9b4cd2712c47d4b3768"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">periodic_adv_itvl</span></code><a class="headerlink" href="#c.ble_gap_ext_disc_desc.periodic_adv_itvl" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Periodic advertising interval. </p> |
| <p>0 if no periodic advertising. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_disc_desc.length_data"> |
| <span class="target" id="structble__gap__ext__disc__desc_1a95f04f12fbe63ed7dd5e0002080b460d"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">length_data</span></code><a class="headerlink" href="#c.ble_gap_ext_disc_desc.length_data" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Advertising Data length. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_disc_desc.data"> |
| <span class="target" id="structble__gap__ext__disc__desc_1aee1859040d299e83105e8abcfe06968d"></span><em class="property"><span class="pre">const</span></em> <span class="pre">uint8_t</span> <span class="pre">*</span><code class="sig-name descname"><span class="pre">data</span></code><a class="headerlink" href="#c.ble_gap_ext_disc_desc.data" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Advertising data. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_disc_desc.direct_addr"> |
| <span class="target" id="structble__gap__ext__disc__desc_1a798d119deb4edec197033fee6684d5a0"></span><span class="pre">ble_addr_t</span> <code class="sig-name descname"><span class="pre">direct_addr</span></code><a class="headerlink" href="#c.ble_gap_ext_disc_desc.direct_addr" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Directed advertising address. </p> |
| <p>Valid if BLE_HCI_ADV_DIRECT_MASK props is set (BLE_ADDR_ANY otherwise). </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="c struct"> |
| <dt id="c.ble_gap_disc_desc"> |
| <span class="target" id="structble__gap__disc__desc"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">ble_gap_disc_desc</span></code><a class="headerlink" href="#c.ble_gap_disc_desc" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><em>#include <ble_gap.h></em><p>Advertising report. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="c var"> |
| <dt id="c.ble_gap_disc_desc.event_type"> |
| <span class="target" id="structble__gap__disc__desc_1a2e50ca921244468b6cc2f26df4891651"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">event_type</span></code><a class="headerlink" href="#c.ble_gap_disc_desc.event_type" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Advertising PDU type. </p> |
| <p>Can be one of following constants:<ul class="simple"> |
| <li><p>BLE_HCI_ADV_RPT_EVTYPE_ADV_IND</p></li> |
| <li><p>BLE_HCI_ADV_RPT_EVTYPE_DIR_IND</p></li> |
| <li><p>BLE_HCI_ADV_RPT_EVTYPE_SCAN_IND</p></li> |
| <li><p>BLE_HCI_ADV_RPT_EVTYPE_NONCONN_IND</p></li> |
| <li><p>BLE_HCI_ADV_RPT_EVTYPE_SCAN_RSP </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_disc_desc.length_data"> |
| <span class="target" id="structble__gap__disc__desc_1a89a746beb9bddaf307c2e3f4c27f9999"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">length_data</span></code><a class="headerlink" href="#c.ble_gap_disc_desc.length_data" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Advertising Data length. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_disc_desc.addr"> |
| <span class="target" id="structble__gap__disc__desc_1a6a67b49b8bbd80becce93504b8e72fa8"></span><span class="pre">ble_addr_t</span> <code class="sig-name descname"><span class="pre">addr</span></code><a class="headerlink" href="#c.ble_gap_disc_desc.addr" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Advertiser address. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_disc_desc.rssi"> |
| <span class="target" id="structble__gap__disc__desc_1a35f310133616439997cfe95c24c9c2c7"></span><span class="pre">int8_t</span> <code class="sig-name descname"><span class="pre">rssi</span></code><a class="headerlink" href="#c.ble_gap_disc_desc.rssi" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Received signal strength indication in dBm (127 if unavailable) </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_disc_desc.data"> |
| <span class="target" id="structble__gap__disc__desc_1a707bc53ffa9faef5dfc76ba10fafdfd9"></span><em class="property"><span class="pre">const</span></em> <span class="pre">uint8_t</span> <span class="pre">*</span><code class="sig-name descname"><span class="pre">data</span></code><a class="headerlink" href="#c.ble_gap_disc_desc.data" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Advertising data. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_disc_desc.direct_addr"> |
| <span class="target" id="structble__gap__disc__desc_1a18d387eb6a793d6992a2313de2024df7"></span><span class="pre">ble_addr_t</span> <code class="sig-name descname"><span class="pre">direct_addr</span></code><a class="headerlink" href="#c.ble_gap_disc_desc.direct_addr" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Directed advertising address. </p> |
| <p>Valid for BLE_HCI_ADV_RPT_EVTYPE_DIR_IND event type (BLE_ADDR_ANY otherwise). </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="c struct"> |
| <dt id="c.ble_gap_repeat_pairing"> |
| <span class="target" id="structble__gap__repeat__pairing"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">ble_gap_repeat_pairing</span></code><a class="headerlink" href="#c.ble_gap_repeat_pairing" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><em>#include <ble_gap.h></em><div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="c var"> |
| <dt id="c.ble_gap_repeat_pairing.conn_handle"> |
| <span class="target" id="structble__gap__repeat__pairing_1a0b614b9417ff2dd445d5328e59426dbc"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">conn_handle</span></code><a class="headerlink" href="#c.ble_gap_repeat_pairing.conn_handle" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>The handle of the relevant connection. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_repeat_pairing.cur_key_size"> |
| <span class="target" id="structble__gap__repeat__pairing_1a7a6ff52550ceaa8f652be9147e01550a"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">cur_key_size</span></code><a class="headerlink" href="#c.ble_gap_repeat_pairing.cur_key_size" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Properties of the existing bond. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_repeat_pairing.new_key_size"> |
| <span class="target" id="structble__gap__repeat__pairing_1ae3ab8cbece8e0387410c56c58c46666f"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">new_key_size</span></code><a class="headerlink" href="#c.ble_gap_repeat_pairing.new_key_size" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Properties of the imminent secure link if the pairing procedure is allowed to continue. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="c struct"> |
| <dt id="c.ble_gap_event"> |
| <span class="target" id="structble__gap__event"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">ble_gap_event</span></code><a class="headerlink" href="#c.ble_gap_event" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><em>#include <ble_gap.h></em><p>Represents a GAP-related event. </p> |
| <p>When such an event occurs, the host notifies the application by passing an instance of this structure to an application-specified callback. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="c var"> |
| <dt id="c.ble_gap_event.type"> |
| <span class="target" id="structble__gap__event_1afb0f89ef7d03f1d36556dcf0d953e749"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">type</span></code><a class="headerlink" href="#c.ble_gap_event.type" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Indicates the type of GAP event that occurred. </p> |
| <p>This is one of the BLE_GAP_EVENT codes. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_event.@32"> |
| <span class="target" id="structble__gap__event_1a7f91739e1500b9153cd4227230afa2e7"></span><em class="property"><span class="pre">union</span></em> <a class="reference internal" href="#c.ble_gap_event" title="ble_gap_event"><span class="pre">ble_gap_event</span></a><span class="pre">.</span><strong><span class="pre">[anonymous]</span></strong> <strong><span class="pre">[anonymous]</span></strong><a class="headerlink" href="#c.ble_gap_event.@32" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A discriminated union containing additional details concerning the GAP event. </p> |
| <p>The ‘type’ field indicates which member of the union is valid. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="c struct"> |
| <dt id="c.ble_gap_ext_adv_params"> |
| <span class="target" id="structble__gap__ext__adv__params"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">ble_gap_ext_adv_params</span></code><a class="headerlink" href="#c.ble_gap_ext_adv_params" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><em>#include <ble_gap.h></em><p>Extended advertising parameters </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_adv_params.connectable"> |
| <span class="target" id="structble__gap__ext__adv__params_1a69f59adfa378f64285e40be09300c31f"></span><span class="pre">unsigned</span> <span class="pre">int</span> <code class="sig-name descname"><span class="pre">connectable</span></code><a class="headerlink" href="#c.ble_gap_ext_adv_params.connectable" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>If perform connectable advertising. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_adv_params.scannable"> |
| <span class="target" id="structble__gap__ext__adv__params_1abcdc4eccbc02ee1d5ea500dddf9e3648"></span><span class="pre">unsigned</span> <span class="pre">int</span> <code class="sig-name descname"><span class="pre">scannable</span></code><a class="headerlink" href="#c.ble_gap_ext_adv_params.scannable" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>If perform scannable advertising. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_adv_params.directed"> |
| <span class="target" id="structble__gap__ext__adv__params_1aa984be410d849ec2cbd490df92fc0036"></span><span class="pre">unsigned</span> <span class="pre">int</span> <code class="sig-name descname"><span class="pre">directed</span></code><a class="headerlink" href="#c.ble_gap_ext_adv_params.directed" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>If perform directed advertising. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_adv_params.high_duty_directed"> |
| <span class="target" id="structble__gap__ext__adv__params_1aee99b7a786f0776f114f33e364de2a9a"></span><span class="pre">unsigned</span> <span class="pre">int</span> <code class="sig-name descname"><span class="pre">high_duty_directed</span></code><a class="headerlink" href="#c.ble_gap_ext_adv_params.high_duty_directed" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>If perform high-duty directed advertising. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_adv_params.legacy_pdu"> |
| <span class="target" id="structble__gap__ext__adv__params_1a93b81b5cc417b3a923609fadb2d22aea"></span><span class="pre">unsigned</span> <span class="pre">int</span> <code class="sig-name descname"><span class="pre">legacy_pdu</span></code><a class="headerlink" href="#c.ble_gap_ext_adv_params.legacy_pdu" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>If use legacy PDUs for advertising. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_adv_params.anonymous"> |
| <span class="target" id="structble__gap__ext__adv__params_1af260738929fb6260e1de88b63f088953"></span><span class="pre">unsigned</span> <span class="pre">int</span> <code class="sig-name descname"><span class="pre">anonymous</span></code><a class="headerlink" href="#c.ble_gap_ext_adv_params.anonymous" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>If perform anonymous advertising. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_adv_params.include_tx_power"> |
| <span class="target" id="structble__gap__ext__adv__params_1ad991d53a415674a71dab3378b78eb10b"></span><span class="pre">unsigned</span> <span class="pre">int</span> <code class="sig-name descname"><span class="pre">include_tx_power</span></code><a class="headerlink" href="#c.ble_gap_ext_adv_params.include_tx_power" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>If include TX power in advertising PDU. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_adv_params.scan_req_notif"> |
| <span class="target" id="structble__gap__ext__adv__params_1afa4614735c79ab23943441e3bc9180d4"></span><span class="pre">unsigned</span> <span class="pre">int</span> <code class="sig-name descname"><span class="pre">scan_req_notif</span></code><a class="headerlink" href="#c.ble_gap_ext_adv_params.scan_req_notif" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>If enable scan request notification </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_adv_params.itvl_min"> |
| <span class="target" id="structble__gap__ext__adv__params_1ad190f36cceb7e7141a760967910ff2db"></span><span class="pre">uint32_t</span> <code class="sig-name descname"><span class="pre">itvl_min</span></code><a class="headerlink" href="#c.ble_gap_ext_adv_params.itvl_min" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Minimum advertising interval in 0.625ms units, if 0 stack use sane defaults. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_adv_params.itvl_max"> |
| <span class="target" id="structble__gap__ext__adv__params_1a1ae933a83b03a719f97ba66d7b41db48"></span><span class="pre">uint32_t</span> <code class="sig-name descname"><span class="pre">itvl_max</span></code><a class="headerlink" href="#c.ble_gap_ext_adv_params.itvl_max" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Maximum advertising interval in 0.625ms units, if 0 stack use sane defaults. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_adv_params.channel_map"> |
| <span class="target" id="structble__gap__ext__adv__params_1a85bbc8d9eeb661313b7668f364ff2980"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">channel_map</span></code><a class="headerlink" href="#c.ble_gap_ext_adv_params.channel_map" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Advertising channel map , if 0 stack use sane defaults. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_adv_params.own_addr_type"> |
| <span class="target" id="structble__gap__ext__adv__params_1ab5c371eee09633dadbd8c5d60238d001"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">own_addr_type</span></code><a class="headerlink" href="#c.ble_gap_ext_adv_params.own_addr_type" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Own address type to be used by advertising instance. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_adv_params.peer"> |
| <span class="target" id="structble__gap__ext__adv__params_1ac190b63dfb6d4340b49594ec3a10175e"></span><span class="pre">ble_addr_t</span> <code class="sig-name descname"><span class="pre">peer</span></code><a class="headerlink" href="#c.ble_gap_ext_adv_params.peer" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Peer address for directed advertising, valid only if directed is set. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_adv_params.filter_policy"> |
| <span class="target" id="structble__gap__ext__adv__params_1afad0f7fd24e17e5e3f2ab51a27cdf44d"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">filter_policy</span></code><a class="headerlink" href="#c.ble_gap_ext_adv_params.filter_policy" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Advertising Filter policy. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_adv_params.primary_phy"> |
| <span class="target" id="structble__gap__ext__adv__params_1a16703bd65940759a2072d915cc1b962d"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">primary_phy</span></code><a class="headerlink" href="#c.ble_gap_ext_adv_params.primary_phy" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Primary advertising PHY to use , can be one of following constants: </p> |
| <p><ul class="simple"> |
| <li><p>BLE_HCI_LE_PHY_1M</p></li> |
| <li><p>BLE_HCI_LE_PHY_CODED </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_adv_params.secondary_phy"> |
| <span class="target" id="structble__gap__ext__adv__params_1a5ace2515a754db09745de6702f3ab284"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">secondary_phy</span></code><a class="headerlink" href="#c.ble_gap_ext_adv_params.secondary_phy" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Secondary advertising PHY to use, can be one of following constants: </p> |
| <p><ul class="simple"> |
| <li><p>BLE_HCI_LE_PHY_1M</p></li> |
| <li><p>LE_HCI_LE_PHY_2M</p></li> |
| <li><p>BLE_HCI_LE_PHY_CODED </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_adv_params.tx_power"> |
| <span class="target" id="structble__gap__ext__adv__params_1a38128d5c3ad0c38ffe5fa14e65d481f8"></span><span class="pre">int8_t</span> <code class="sig-name descname"><span class="pre">tx_power</span></code><a class="headerlink" href="#c.ble_gap_ext_adv_params.tx_power" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Preferred advertiser transmit power. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_ext_adv_params.sid"> |
| <span class="target" id="structble__gap__ext__adv__params_1aa8f974e6b355fb6cf7c61851576ed661"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">sid</span></code><a class="headerlink" href="#c.ble_gap_ext_adv_params.sid" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Advertising Set ID. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="c struct"> |
| <dt id="c.ble_gap_periodic_adv_params"> |
| <span class="target" id="structble__gap__periodic__adv__params"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">ble_gap_periodic_adv_params</span></code><a class="headerlink" href="#c.ble_gap_periodic_adv_params" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><em>#include <ble_gap.h></em><p>Periodic advertising parameters </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="c var"> |
| <dt id="c.ble_gap_periodic_adv_params.include_tx_power"> |
| <span class="target" id="structble__gap__periodic__adv__params_1a2d5ac5cb9e73ea88907a6092ebfdf9c0"></span><span class="pre">unsigned</span> <span class="pre">int</span> <code class="sig-name descname"><span class="pre">include_tx_power</span></code><a class="headerlink" href="#c.ble_gap_periodic_adv_params.include_tx_power" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>If include TX power in advertising PDU. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_periodic_adv_params.itvl_min"> |
| <span class="target" id="structble__gap__periodic__adv__params_1a81316a62af35ef6f8809ddfed393ed9c"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">itvl_min</span></code><a class="headerlink" href="#c.ble_gap_periodic_adv_params.itvl_min" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Minimum advertising interval in 0.625ms units, if 0 stack use sane defaults. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_periodic_adv_params.itvl_max"> |
| <span class="target" id="structble__gap__periodic__adv__params_1a2f572229b6d7c7135f262c51f5629fa7"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">itvl_max</span></code><a class="headerlink" href="#c.ble_gap_periodic_adv_params.itvl_max" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Maximum advertising interval in 0.625ms units, if 0 stack use sane defaults. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="c struct"> |
| <dt id="c.ble_gap_periodic_sync_params"> |
| <span class="target" id="structble__gap__periodic__sync__params"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">ble_gap_periodic_sync_params</span></code><a class="headerlink" href="#c.ble_gap_periodic_sync_params" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><em>#include <ble_gap.h></em><p>Periodic sync parameters </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="c var"> |
| <dt id="c.ble_gap_periodic_sync_params.skip"> |
| <span class="target" id="structble__gap__periodic__sync__params_1a48aafe41cada812fa65a84f6f9178314"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">skip</span></code><a class="headerlink" href="#c.ble_gap_periodic_sync_params.skip" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>The maximum number of periodic advertising events that controller can skip after a successful receive. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_periodic_sync_params.sync_timeout"> |
| <span class="target" id="structble__gap__periodic__sync__params_1a37e4c1b6be7e330d710f1113e5ecc42b"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">sync_timeout</span></code><a class="headerlink" href="#c.ble_gap_periodic_sync_params.sync_timeout" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Synchronization timeout for the periodic advertising train in 10ms units. </p> |
| </dd></dl> |
| |
| <dl class="c var"> |
| <dt id="c.ble_gap_periodic_sync_params.reports_disabled"> |
| <span class="target" id="structble__gap__periodic__sync__params_1a3ce115a3fc63f7217838b9ab6beb0273"></span><span class="pre">unsigned</span> <span class="pre">int</span> <code class="sig-name descname"><span class="pre">reports_disabled</span></code><a class="headerlink" href="#c.ble_gap_periodic_sync_params.reports_disabled" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>If reports should be initially disabled when sync is created. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="c struct"> |
| <dt id="c.ble_gap_event_listener"> |
| <span class="target" id="structble__gap__event__listener"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">ble_gap_event_listener</span></code><a class="headerlink" href="#c.ble_gap_event_listener" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><em>#include <ble_gap.h></em><p>Event listener structure. </p> |
| <p>This should be used as an opaque structure and not modified manually. </p> |
| </dd></dl> |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| </div> |
| |
| <div class="rst-footer-buttons row" role="navigation" aria-label="footer navigation"> |
| |
| <a href="ble_gattc.html" class="btn btn-neutral float-right" title="NimBLE Host GATT Client Reference" accesskey="n">Next: NimBLE Host GATT Client Reference <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="ble_hs_return_codes.html" class="btn btn-neutral" title="NimBLE Host Return Codes" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous: NimBLE Host Return Codes</a> |
| |
| </div> |
| |
| </div> |
| </div> |
| </div> |
| <!-- ENDS CONTENT SECTION --> |
| </div> |
| <!-- ENDS .content --> |
| </div> |
| </div> |
| <footer> |
| <div class="container"> |
| <div class="row"> |
| <div class="col-xs-12"> |
| |
| <p class="copyright">Apache Mynewt is available under Apache License, version 2.0.</p> |
| |
| </div> |
| <div class="col-xs-12"> |
| <div class="logos"> |
| <img src="../../_static/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> |
| <small class="footnote"> |
| Apache Mynewt, Mynewt, Apache, the Apache feather logo, and the Apache Mynewt project logo are either |
| registered trademarks or trademarks of the Apache Software Foundation in the United States and other countries. |
| </small> |
| <a href=""> |
| <img src="../../_static/img/add_to_slack.png" alt="Slack Icon" title="Join our Slack Community" /> |
| </a> |
| </div> |
| </div> |
| </div> |
| </div> |
| </footer> |
| </div> |
| <!-- ENDS #wrapper --> |
| |
| |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT:'../../', |
| VERSION:'latest', |
| COLLAPSE_INDEX:false, |
| FILE_SUFFIX:'.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '.txt', |
| LINK_SUFFIX: '.html' |
| }; |
| </script> |
| <script type="text/javascript" src="../../_static/jquery.js"></script> |
| <script type="text/javascript" src="../../_static/underscore.js"></script> |
| <script type="text/javascript" src="../../_static/doctools.js"></script> |
| <script type="text/javascript" src="../../_static/js/bootstrap-3.0.3.min.js"></script> |
| <script type="text/javascript" src="../../_static/js/affix.js"></script> |
| <script type="text/javascript" src="../../_static/js/main.js"></script> |
| |
| |
| |
| </body> |
| </html> |
