| <!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"> |
| |
| |
| <!-- This is broken by doc revisioning. |
| --> |
| <link rel="shortcut icon" href="../../../../../img/favicon.ico"> |
| |
| <title>toc - Apache Mynewt</title> |
| |
| <link href="../../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> |
| <link rel="stylesheet" href="../../../../../css/highlight.css"> |
| <link href="../../../../../css/base.css" rel="stylesheet"> |
| <link href="../../../../../css/custom.css" rel="stylesheet"> |
| <link href="../../../../../css/v2.css" rel="stylesheet"> |
| <link href="https://fonts.googleapis.com/css?family=Lato" rel="stylesheet"> |
| <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css"> |
| |
| <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> |
| <!--[if lt IE 9]> |
| <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script> |
| <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script> |
| <![endif]--> |
| |
| |
| <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="toc"> |
| |
| |
| <div class="container"> |
| <div class="row v2-main-banner"> |
| <a class="logo-cell" href="/"> |
| <img class="logo" src="/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.12.0, Apache NimBLE 1.7.0 </a> released (April 4, 2024) |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| <nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" 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 |
| class="" |
| > |
| <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 |
| class="" |
| > |
| <a href="/about/">About</a> |
| </li> |
| <li |
| class="" |
| > |
| <a href="/talks/">Talks</a> |
| </li> |
| <li |
| class="active" |
| > |
| <a href="/documentation/">Documentation</a> |
| </li> |
| <li |
| class="" |
| > |
| <a href="/download/">Download</a> |
| </li> |
| <li |
| class="" |
| > |
| <a href="/community/">Community</a> |
| </li> |
| <li |
| class="" |
| > |
| <a href="/events/">Events</a> |
| </li> |
| </ul> |
| |
| </div> |
| </div> |
| </nav> |
| |
| |
| |
| <div class="container"> |
| |
| <div class="row"> |
| <div class="col-md-3 v2-sidebar sidebar-container"><div id="docSidebar" class="hidden-print" role="complementary"> |
| <div class="top"> |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get"> |
| <div class="form-group"> |
| <input type="text" name="q" class="form-control" placeholder="Search documentation" /> |
| </div> |
| </form> |
| </div> |
| </div> |
| <ul class="toc-nav"> |
| <li class="doc-version"><select class="form-control" onchange="if (this.value) window.location.href=this.value"> |
| <option value="/latest"> |
| Version: master |
| </option> |
| <option value="/v1_12_0/" > |
| Version: 1.12.0 |
| </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/" > |
| 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" selected="selected" > |
| Version: 1.0.0 |
| </option> |
| <option value="/v0_9_0/os/introduction" > |
| Version: 0.9.0 |
| </option> |
| </select></li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../../../../../os/introduction/">Mynewt Documentation</a> |
| |
| |
| <ul> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../../../../../os/get_started/get_started/">Basic Setup</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../../../../../os/get_started/vocabulary/">Concepts</a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../../../../../os/tutorials/tutorials/">Tutorials</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../../../../../os/os_user_guide/">OS User Guide</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li><a href=" |
| ../../../ble_intro/ |
| ">BLE User Guide</a> |
| |
| |
| <ul> |
| |
| |
| |
| <li > |
| <a href="../../../ble_intro/">NimBLE Introduction</a> |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../../../ble_sec/">NimBLE Security</a> |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../../../nimble_setup/">Set up application</a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../../../ini_stack/ble_ini_intro/">Initialize stack</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../../ble_hs/">NimBLE Host API</a> |
| |
| |
| <ul> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../../ble_hs_return_codes/">Return codes</a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../../init/init/">Init and config</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="active"><a href="./">GAP</a> |
| |
| |
| <ul> |
| |
| |
| |
| |
| |
| |
| |
| <li><a href=" |
| ../definitions/ble_gap_defs/ |
| ">Definitions</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li><a href=" |
| ../functions/ble_gap_adv_active/ |
| ">Functions</a> |
| |
| |
| </li> |
| |
| |
| |
| </ul> |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../../ble_gattc/ble_gattc/">GATT client</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../../ble_gatts/ble_gatts/">GATT server</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../../ble_hs_id/ble_hs_id/">Identity</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../../ble_att/ble_att/">ATT</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../../other/other/">Other</a> |
| |
| |
| </li> |
| |
| |
| |
| </ul> |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../../../bletiny/bletiny_api/">bletiny app Usage API</a> |
| |
| |
| </li> |
| |
| |
| |
| </ul> |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../../../../../newt/newt_intro/">Newt Tool Guide</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../../../../../newtmgr/overview/">Newt Manager Guide</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../../../../../known_issues/">Known Issues</a> |
| </li> |
| |
| |
| |
| </ul> |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li><a href=" |
| ../../../../../faq/go_env/ |
| ">Appendix</a> |
| |
| |
| </li> |
| |
| |
| |
| </ul> |
| </div></div> |
| |
| <div class="col-md-9" role="main"> |
| <div class="doc-header"> |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="/documentation/">Docs</a></li> |
| |
| |
| |
| <li>» GAP</li> |
| |
| |
| |
| <li>» <a href="network/ble/ble_hs/ble_hs/">NimBLE Host API</a></li> |
| |
| |
| |
| <li>» <a href="network/ble/ble_intro/">BLE User Guide</a></li> |
| |
| |
| |
| <li>» <a href="os/introduction/">Mynewt Documentation</a></li> |
| |
| |
| |
| |
| |
| </ul> |
| </div> |
| </div> |
| |
| |
| |
| |
| |
| |
| <div class="alert alert-warning"> |
| <p> |
| Version 1.0.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> |
| |
| |
| |
| <h2 id="nimble-host-gap-reference"><font color="F2853F" style="font-size:24pt">NimBLE Host GAP Reference</font></h2> |
| <h3 id="introduction">Introduction</h3> |
| <p>The Generic Access Profile (GAP) is responsible for all connecting, advertising, scanning, and connection updating operations.</p> |
| <h3 id="header">Header</h3> |
| <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code><span style="color: #633820">#include</span> <span style="color: #177500">"host/ble_hs.h"</span> |
| </code></pre></div> |
| |
| <h3 id="definitions">Definitions</h3> |
| <p><a href="../definitions/ble_gap_defs/">BLE host GAP definitions</a></p> |
| <h3 id="functions">Functions</h3> |
| <table> |
| <thead> |
| <tr> |
| <th>Function</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a href="../functions/ble_gap_adv_active/">ble_gap_adv_active</a></td> |
| <td>Indicates whether an advertisement procedure is currently in progress.</td> |
| </tr> |
| <tr> |
| <td><a href="../functions/ble_gap_adv_rsp_set_fields/">ble_gap_adv_rsp_set_fields</a></td> |
| <td>Configures the data to include in subsequent scan responses.</td> |
| </tr> |
| <tr> |
| <td><a href="../functions/ble_gap_adv_set_fields/">ble_gap_adv_set_fields</a></td> |
| <td>Configures the data to include in subsequent advertisements.</td> |
| </tr> |
| <tr> |
| <td><a href="../functions/ble_gap_adv_start/">ble_gap_adv_start</a></td> |
| <td>Initiates advertising.</td> |
| </tr> |
| <tr> |
| <td><a href="../functions/ble_gap_adv_stop/">ble_gap_adv_stop</a></td> |
| <td>Stops the currently-active advertising procedure.</td> |
| </tr> |
| <tr> |
| <td><a href="../functions/ble_gap_conn_active/">ble_gap_conn_active</a></td> |
| <td>Indicates whether a connect procedure is currently in progress.</td> |
| </tr> |
| <tr> |
| <td><a href="../functions/ble_gap_conn_cancel/">ble_gap_conn_cancel</a></td> |
| <td>Aborts a connect procedure in progress.</td> |
| </tr> |
| <tr> |
| <td><a href="../functions/ble_gap_conn_find/">ble_gap_conn_find</a></td> |
| <td>Searches for a connection with the specified handle.</td> |
| </tr> |
| <tr> |
| <td><a href="../functions/ble_gap_conn_rssi/">ble_gap_conn_rssi</a></td> |
| <td>Retrieves the most-recently measured RSSI for the specified connection.</td> |
| </tr> |
| <tr> |
| <td><a href="../functions/ble_gap_connect/">ble_gap_connect</a></td> |
| <td>Initiates a connect procedure.</td> |
| </tr> |
| <tr> |
| <td><a href="../functions/ble_gap_disc/">ble_gap_disc</a></td> |
| <td>Performs the Limited or General Discovery Procedures.</td> |
| </tr> |
| <tr> |
| <td><a href="../functions/ble_gap_disc_active/">ble_gap_disc_active</a></td> |
| <td>Indicates whether a discovery procedure is currently in progress.</td> |
| </tr> |
| <tr> |
| <td><a href="../functions/ble_gap_disc_cancel/">ble_gap_disc_cancel</a></td> |
| <td>Cancels the discovery procedure currently in progress.</td> |
| </tr> |
| <tr> |
| <td><a href="../functions/ble_gap_security_initiate/">ble_gap_security_initiate</a></td> |
| <td>Initiates the GAP encryption procedure.</td> |
| </tr> |
| <tr> |
| <td><a href="../functions/ble_gap_terminate/">ble_gap_terminate</a></td> |
| <td>Terminates an established connection.</td> |
| </tr> |
| <tr> |
| <td><a href="../functions/ble_gap_update_params/">ble_gap_update_params</a></td> |
| <td>Initiates a connection parameter update procedure.</td> |
| </tr> |
| <tr> |
| <td><a href="../functions/ble_gap_wl_set/">ble_gap_wl_set</a></td> |
| <td>Overwrites the controller's white list with the specified contents.</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <div class="row"> |
| |
| |
| |
| |
| <ul class="nav nav-pills" style="margin-bottom: 10px"> |
| <li> |
| |
| </li> |
| <li class="pull-right"> |
| |
| </li> |
| </ul> |
| </div> |
| <footer class="row"> |
| <div class="col-xs-12"> |
| |
| <p class="copyright">Apache Mynewt (incubating) is available under Apache License, version 2.0.</p> |
| |
| </div> |
| <div class="col-xs-12"> |
| <div class="logos"> |
| <a href="https://www.apache.org/"> |
| <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> |
| </a> |
| <p> |
| Copyright © 2015-2021 The Apache Software Foundation.<br> |
| <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> |
| </p> |
| <a href=""> |
| <img src="https://www.countit.com/images/add_to_slack.png" alt="Slack Icon" title="Join our Slack Community" /> |
| </a> |
| </div> |
| </div> |
| <a href="https://www.apache.org/licenses/"> |
| <button class="button-footer-asf"> |
| License |
| </button> |
| </a> |
| <a href="https://www.apache.org/foundation/sponsorship.html"> |
| <button class="button-footer-asf"> |
| Sponsorship |
| </button> |
| </a> |
| <a href="https://www.apache.org/foundation/thanks.html"> |
| <button class="button-footer-asf"> |
| Thanks |
| </button> |
| </a> |
| <a href="https://www.apache.org/security/"> |
| <button class="button-footer-asf"> |
| Security |
| </button> |
| </a> |
| <a href="https://apache.org/events/current-event"> |
| <button class="button-footer-asf"> |
| ASF Events |
| </button> |
| </a> |
| </footer> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| <script src="../../../../../js/jquery-1.10.2.min.js"></script> |
| <script src="../../../../../js/bootstrap-3.0.3.min.js"></script> |
| <script src="../../../../../js/highlight.pack.js"></script> |
| <script src="../../../../../js/base.js"></script> |
| <script src="../../../../../js/custom.js"></script> |
| <script src="search/main.js"></script> |
| |
| </body> |
| </html> |
