| <!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>GAP in bletiny - 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="GAP in bletiny"> |
| |
| |
| <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.11.0, Apache NimBLE 1.6.0 </a> released (September 7, 2023) |
| </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_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" > |
| Version: 1.0.0 |
| </option> |
| <option value="/v0_9_0/os/introduction" selected="selected" > |
| 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="../../bletiny_api/">API for bletiny app</a> |
| |
| |
| <ul> |
| |
| |
| |
| |
| |
| <li class="active"> |
| <a href="./">GAP in bletiny</a> |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../bletiny_GATT/">GATT in bletiny</a> |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../bletiny_advdata/">Advertisement Data Fields</a> |
| </li> |
| |
| |
| |
| </ul> |
| |
| </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/how_to_edit_docs/ |
| ">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>» <a href="network/ble/bletiny_api/">API for bletiny app</a></li> |
| |
| |
| |
| <li>» <a href="network/ble/ble_intro/">BLE User Guide</a></li> |
| |
| |
| |
| <li>» <a href="os/introduction/">Mynewt Documentation</a></li> |
| |
| |
| |
| <li>» GAP in bletiny</li> |
| |
| |
| |
| </ul> |
| </div> |
| </div> |
| |
| |
| |
| |
| <div class="alert alert-warning"> |
| <p> |
| Version 0.9.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="gap-api-for-bletiny">GAP API for bletiny</h2> |
| <p><br></p> |
| <p>Generic Access Profile (GAP) defines the generic procedures related to discovery of Bluetooth devices (idle mode procedures) and link management aspects of connecting to Bluetooth devices (connecting mode procedures). It also defines procedures related to use of different security levels. </p> |
| <p>Several different modes and procedures may be performed simultaneously over an LE physical transport. The following modes and procedures are defined for use over an LE physical transport:</p> |
| <ol> |
| <li><strong>Broadcast mode and observation procedure</strong><ul> |
| <li>These allow two devices to communicate in a unidirectional connectionless manner using the advertising events.</li> |
| </ul> |
| </li> |
| <li><strong>Discovery modes and procedures</strong><ul> |
| <li>All devices shall be in either non-discoverable mode or one of the discoverable modes.</li> |
| <li>A device in the discoverable mode shall be in either the general discoverable mode or the limited discoverable mode.</li> |
| <li>A device in non-discoverable mode will not be discovered by any device that is performing either the general discovery procedure or the limited discovery procedure.</li> |
| </ul> |
| </li> |
| <li><strong>Connection modes and procedures</strong><ul> |
| <li>allow a device to establish a connection to another device.</li> |
| <li>allow updating of parameters of the connection </li> |
| <li>allow termination of the connection </li> |
| </ul> |
| </li> |
| <li><strong>Bonding modes and procedures</strong><ul> |
| <li>Bonding allows two connected devices to exchange and store security and identity information to create a trusted relationship. </li> |
| <li>Bonding can occur only between two devices in bondable mode.</li> |
| </ul> |
| </li> |
| </ol> |
| <p><br></p> |
| <h3 id="usage-api">Usage API</h3> |
| <table> |
| <thead> |
| <tr> |
| <th><strong>Item No.</strong></th> |
| <th><strong>Modes and Procedures</strong></th> |
| <th><strong>nimBLE command</strong></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>1</td> |
| <td>Broadcast Mode</td> |
| <td><code>b adv conn=non disc=x</code></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>Observation Procedure</td> |
| <td><code>b scan dur=x disc=x type=x filt=x</code></td> |
| </tr> |
| <tr> |
| <td>2</td> |
| <td>Non-Discoverable mode</td> |
| <td><code>b adv conn=x disc=non</code></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>Limited Discoverable mode</td> |
| <td><code>b adv conn=x disc=ltd</code></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>General Discoverable mode</td> |
| <td><code>b adv conn=x disc=gen</code></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>Limited Discovery procedure</td> |
| <td><code>b scan dur=x disc=ltd type=active filt=no_wl</code></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>General Discovery procedure</td> |
| <td><code>b scan dur=x disc=gen type=active filt=no_wl</code></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>Name Discovery procedure</td> |
| <td>UNSUPPORTED</td> |
| </tr> |
| <tr> |
| <td>3</td> |
| <td>Non-connectable mode</td> |
| <td><code>b adv conn=non disc=x</code></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>Directed connectable mode</td> |
| <td><code>b adv conn=dir disc=x addr_type=x addr=x</code></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>Undirected connectable mode</td> |
| <td><code>b adv conn=und disc=x</code></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>Auto connection establishment procedure</td> |
| <td><code>b wl addr_type=x addr=x</code></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>Auto connection establishment procedure</td> |
| <td><code>b conn addr_type=wl</code></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>General connection establishment procedure</td> |
| <td>AVAILABLE SOON</td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>Selective connection establishment procedure</td> |
| <td>AVAILABLE SOON</td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>Direct connection establishment procedure</td> |
| <td><code>b conn addr_type=x addr=x [params]</code></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>Connection parameter update procedure</td> |
| <td><code>b update conn=x <params></code></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>Terminate connection procedure</td> |
| <td><code>b term conn=x</code></td> |
| </tr> |
| <tr> |
| <td>4</td> |
| <td>Non-Bondable mode</td> |
| <td>AVAILABLE SOON</td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>Bondable mode</td> |
| <td>AVAILABLE SOON</td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>Bonding procedure</td> |
| <td>AVAILABLE SOON</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><br></p> |
| <h3 id="connection-parameters">Connection Parameters</h3> |
| <p>The Connection parameter definitions can be found in Section 7.8.12 of the BLUETOOTH SPECIFICATION Version 4.2 [Vol 2, Part E].</p> |
| <table> |
| <thead> |
| <tr> |
| <th><strong>Name</strong></th> |
| <th><strong>Description</strong></th> |
| <th><strong>nimBLE parameter</strong></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>Minimum connection interval</td> |
| <td>Defines minimum allowed connection interval</td> |
| <td>itvl_min</td> |
| </tr> |
| <tr> |
| <td>Maximum connection interval</td> |
| <td>Defines maximum allowed connection interval</td> |
| <td>itvl_max</td> |
| </tr> |
| <tr> |
| <td>Conn_Latency</td> |
| <td>Defines the maximum allowed connection latency</td> |
| <td>latency</td> |
| </tr> |
| <tr> |
| <td>Supervision_Timeout</td> |
| <td>Link supervision timeout for the connection.</td> |
| <td>timeout</td> |
| </tr> |
| <tr> |
| <td>LE_Scan_Interval</td> |
| <td>Recommendation from the Host on how long the Controller should scan</td> |
| <td>scan_itvl</td> |
| </tr> |
| <tr> |
| <td>LE_Scan_Window</td> |
| <td>Recommendation from the Host on how frequently the Controller should scan</td> |
| <td>scan_window</td> |
| </tr> |
| <tr> |
| <td>Minimum_CE_Length</td> |
| <td>Informative parameter providing the Controller with the expected minimum length of the connection event</td> |
| <td>min_ce_len</td> |
| </tr> |
| <tr> |
| <td>Maximum_CE_Length</td> |
| <td>Informative parameter providing the Controller with the expected maximum length of the connection event</td> |
| <td>max_ce_len</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="advertisement-data-fields">Advertisement data fields</h3> |
| |
| <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> |
