v1_2_0/network/ble/btshell/btshell_GAP/index.html - mynewt-site - Git at Google

 <!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 btshell - 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 btshell">


         <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" selected="selected" >
     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></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="../../ble_setup/ble_setup_intro/">NimBLE Setup</a>


     </li>


     <li ><a href="../../ble_hs/ble_hs/">NimBLE Host API</a>


     </li>


     <li ><a href="../../bletiny/bletiny_api/">bletiny app Usage API</a>


     </li>


     <li ><a href="../btshell_api/">btshell app Usage API</a>


     <ul>


   <li class="active">
     <a href="./">GAP in btshell</a>
   </li>


   <li >
     <a href="../btshell_GATT/">GATT in btshell</a>
   </li>


   <li >
     <a href="../btshell_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="
   ../../../../newt/install/prev_releases/
 ">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>&raquo; <a href="network/ble/btshell/btshell_api/">btshell app Usage API</a></li>


           <li>&raquo; <a href="network/ble/ble_intro/">BLE User Guide</a></li>


           <li>&raquo; <a href="os/introduction/">Mynewt Documentation</a></li>


         <li>&raquo; GAP in btshell</li>


       <li class="wy-breadcrumbs-aside">

           <a href="https://github.com/apache/mynewt-site/blob/master/docs/network/ble/btshell/btshell_GAP.md"
             class="icon icon-github"> Edit on GitHub</a>

       </li>

   </ul>
 </div>
                         </div>


                             <div class="alert alert-warning">
                                 <p>
                                     Version 1.2.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-btshell">GAP API for btshell</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>advertise conn=non discov=x</code></td>
 </tr>
 <tr>
 <td></td>
 <td>Observation Procedure</td>
 <td><code>scan duration=x passive=x filter=x</code></td>
 </tr>
 <tr>
 <td>2</td>
 <td>Non-Discoverable mode</td>
 <td><code>advertise conn=x discov=non</code></td>
 </tr>
 <tr>
 <td></td>
 <td>Limited Discoverable mode</td>
 <td><code>advertise conn=x discov=ltd</code></td>
 </tr>
 <tr>
 <td></td>
 <td>General Discoverable mode</td>
 <td><code>advertise conn=x discov=gen</code></td>
 </tr>
 <tr>
 <td></td>
 <td>Limited Discovery procedure</td>
 <td><code>scan duration=x discov=ltd passive=0 filter=no_wl</code></td>
 </tr>
 <tr>
 <td></td>
 <td>General Discovery procedure</td>
 <td><code>scan duration=x discov=gen passive=0 filter=no_wl</code></td>
 </tr>
 <tr>
 <td></td>
 <td>Name Discovery procedure</td>
 <td><code>scan duration=x</code> <br> <code>scan cancel</code> <br> <code>connect peer_addr_type=x peer_addr=x</code> <br> <code>gatt-read conn=x uuid=0x2a00</code></td>
 </tr>
 <tr>
 <td>3</td>
 <td>Non-connectable mode</td>
 <td><code>advertise conn=non discov=x</code></td>
 </tr>
 <tr>
 <td></td>
 <td>Directed connectable mode</td>
 <td><code>advertise conn=dir [own_addr_type=x] [discov=x] [duration=x]</code></td>
 </tr>
 <tr>
 <td></td>
 <td>Undirected connectable mode</td>
 <td><code>advertise conn=und [own_addr_type=x] [discov=x] [duration=x]</code></td>
 </tr>
 <tr>
 <td></td>
 <td>Auto connection establishment procedure</td>
 <td><code>white-list addr_type=x addr=x [addr_type=y addr=y] [...]</code> <br> <code>connect addr_type=wl</code></td>
 </tr>
 <tr>
 <td></td>
 <td>General connection establishment procedure</td>
 <td><code>scan duration=x</code> <br> <code>scan cancel</code> <br> <code>connect peer_addr_type=x peer_addr=x</code></td>
 </tr>
 <tr>
 <td></td>
 <td>Selective connection establishment procedure</td>
 <td><code>white-list addr_type=x addr=x [addr_type=y addr=y] [...]</code> <br> <code>scan filter=use_wl duration=x</code> <br> <code>scan cancel</code> <br> <code>connect peer_addr_type=x peer_addr=x [own_addr_type=x]</code></td>
 </tr>
 <tr>
 <td></td>
 <td>Direct connection establishment procedure</td>
 <td><code>connect addr_type=x addr=x [params]</code></td>
 </tr>
 <tr>
 <td></td>
 <td>Connection parameter update procedure</td>
 <td><code>conn-update-params conn=x &lt;params&gt;</code></td>
 </tr>
 <tr>
 <td></td>
 <td>Terminate connection procedure</td>
 <td><code>disconnect conn=x</code></td>
 </tr>
 <tr>
 <td>4</td>
 <td>Non-Bondable mode</td>
 <td><code>security-set-data bonding=0</code> [*]</td>
 </tr>
 <tr>
 <td></td>
 <td>Bondable mode</td>
 <td><code>security-set-data bonding=1</code> [*]</td>
 </tr>
 <tr>
 <td></td>
 <td>Bonding procedure</td>
 <td><code>security-start conn=x</code> [*]</td>
 </tr>
 </tbody>
 </table>
 <p><strong>[*]</strong> Security is disabled by default in btshell.  To use the bonding modes and procedures, add <code>BLE_SM_LEGACY: 1</code> or <code>BLE_SM_SC: 1</code> to your syscfg.yml file depending on your needs.</p>
 <p><br></p>
 <h3 id="address-types">Address Types</h3>
 <table>
 <thead>
 <tr>
 <th><em>btshell string</em></th>
 <th><em>Description</em></th>
 <th><em>Notes</em></th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>public</td>
 <td>Public address.</td>
 <td></td>
 </tr>
 <tr>
 <td>random</td>
 <td>Random static address.</td>
 <td></td>
 </tr>
 <tr>
 <td>rpa_pub</td>
 <td>Resolvable private address, public identity.</td>
 <td>Not available for all commands.</td>
 </tr>
 <tr>
 <td>rpa_rnd</td>
 <td>Resolvable private address, random static identity.</td>
 <td>Not available for all commands.</td>
 </tr>
 <tr>
 <td>wl</td>
 <td>Use white list; ignore peer_addr parameter.</td>
 <td>Only availble for "connect" command.</td>
 </tr>
 </tbody>
 </table>
 <h3 id="connection-types">Connection Types</h3>
 <p>Bluetooth Specification Version 5.0 allows for different types of connections:</p>
 <table>
 <thead>
 <tr>
 <th><em>Description</em></th>
 <th><em>btshell ext parameter value</em></th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>Legacy connection</td>
 <td>none</td>
 </tr>
 <tr>
 <td>Extended connection with 1M PHY</td>
 <td>1M</td>
 </tr>
 <tr>
 <td>Extended connection with coded PHY</td>
 <td>coded</td>
 </tr>
 <tr>
 <td>Extended connection with both 1M and coded PHY</td>
 <td>both</td>
 </tr>
 <tr>
 <td>Extended connection with 1M, 2M and coded PHYs</td>
 <td>all</td>
 </tr>
 </tbody>
 </table>
 <h3 id="connection-parameters">Connection Parameters</h3>
 <p>Connection parameter definitions can be found in Section 7.8.12 of the BLUETOOTH SPECIFICATION Version 5.0 [Vol 2, Part E].</p>
 <p>Connection parameters for all types of connections:</p>
 <table>
 <thead>
 <tr>
 <th><em>Name</em></th>
 <th><em>Description</em></th>
 <th><em>btshell string</em></th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>Connection Type</td>
 <td>Parameter indicating the type of connection</td>
 <td>extended</td>
 </tr>
 <tr>
 <td>Peer_Address_Type</td>
 <td>Whether the peer is using a public or random address (see Address types table).</td>
 <td>peer_addr_type</td>
 </tr>
 <tr>
 <td>Peer_Address</td>
 <td>The 6-byte device address of the peer; ignored if white list is used</td>
 <td>peer_addr</td>
 </tr>
 <tr>
 <td>Own_Address_Type</td>
 <td>The type of address to use when initiating the connection (see Address types table)</td>
 <td>own_addr_type</td>
 </tr>
 <tr>
 <td>Duration</td>
 <td>Number of milliseconds before aborting the connect attempt</td>
 <td>duration</td>
 </tr>
 </tbody>
 </table>
 <p>Connection parameters for legacy and 1M PHY extended connection:</p>
 <table>
 <thead>
 <tr>
 <th><em>Name</em></th>
 <th><em>Description</em></th>
 <th><em>btshell string</em></th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>LE_Scan_Interval</td>
 <td>Recommendation from the Host on how long the Controller should scan</td>
 <td>scan_interval</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>Conn_Interval_Min</td>
 <td>Defines minimum allowed connection interval</td>
 <td>interval_min</td>
 </tr>
 <tr>
 <td>Conn_Interval_Max</td>
 <td>Defines maximum allowed connection interval</td>
 <td>interval_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>Minimum_CE_Length</td>
 <td>Informative parameter providing the Controller with the expected minimum length of the connection event</td>
 <td>min_conn_event_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_conn_event_len</td>
 </tr>
 </tbody>
 </table>
 <p>Extended Connection parameters for coded PHY connection:</p>
 <table>
 <thead>
 <tr>
 <th><em>Name</em></th>
 <th><em>Description</em></th>
 <th><em>btshell string</em></th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>LE_Scan_Interval</td>
 <td>Recommendation from the Host on how long the Controller should scan</td>
 <td>coded_scan_interval</td>
 </tr>
 <tr>
 <td>LE_Scan_Window</td>
 <td>Recommendation from the Host on how frequently the Controller should scan</td>
 <td>coded_scan_window</td>
 </tr>
 <tr>
 <td>Conn_Interval_Min</td>
 <td>Defines minimum allowed connection interval</td>
 <td>coded_interval_min</td>
 </tr>
 <tr>
 <td>Conn_Interval_Max</td>
 <td>Defines maximum allowed connection interval</td>
 <td>coded_interval_max</td>
 </tr>
 <tr>
 <td>Conn_Latency</td>
 <td>Defines the maximum allowed connection latency</td>
 <td>coded_latency</td>
 </tr>
 <tr>
 <td>Supervision_Timeout</td>
 <td>Link supervision timeout for the connection.</td>
 <td>coded_timeout</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>coded_min_conn_event_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>coded_max_conn_event_len</td>
 </tr>
 </tbody>
 </table>
 <p>Extended Connection parameters for 2M PHY connection:</p>
 <table>
 <thead>
 <tr>
 <th><em>Name</em></th>
 <th><em>Description</em></th>
 <th><em>btshell string</em></th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>Conn_Interval_Min</td>
 <td>Defines minimum allowed connection interval</td>
 <td>2M_interval_min</td>
 </tr>
 <tr>
 <td>Conn_Interval_Max</td>
 <td>Defines maximum allowed connection interval</td>
 <td>2M_interval_max</td>
 </tr>
 <tr>
 <td>Conn_Latency</td>
 <td>Defines the maximum allowed connection latency</td>
 <td>2M_latency</td>
 </tr>
 <tr>
 <td>Supervision_Timeout</td>
 <td>Link supervision timeout for the connection.</td>
 <td>2M_timeout</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>2M_min_conn_event_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>2M_max_conn_event_len</td>
 </tr>
 </tbody>
 </table>
 <h3 id="scan-types">Scan Types</h3>
 <p>Bluetooth Specification Version 5.0 allows for different types of scan:</p>
 <table>
 <thead>
 <tr>
 <th><em>Description</em></th>
 <th><em>btshell ext parameter value</em></th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>Legacy scan</td>
 <td>none</td>
 </tr>
 <tr>
 <td>Extended scan with 1M PHY</td>
 <td>1M</td>
 </tr>
 <tr>
 <td>Extended scan with coded PHY</td>
 <td>coded</td>
 </tr>
 <tr>
 <td>Extended scan with both 1M and coded PHY</td>
 <td>both</td>
 </tr>
 </tbody>
 </table>
 <h3 id="scan-parameters">Scan Parameters</h3>
 <p>Scan parameter definitions can be found in Section 7.8.10 of the BLUETOOTH SPECIFICATION Version 5.0 [Vol 2, Part E].</p>
 <table>
 <thead>
 <tr>
 <th><em>Name</em></th>
 <th><em>Description</em></th>
 <th><em>btshell string</em></th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>Scan Type</td>
 <td>Parameter indicating the type of scan</td>
 <td>extended</td>
 </tr>
 <tr>
 <td>LE_Scan_Type</td>
 <td>Controls the type of scan to perform (passive or active)</td>
 <td>passive</td>
 </tr>
 <tr>
 <td>LE_Scan_Interval</td>
 <td>Recommendation from the Host on how long the Controller should scan</td>
 <td>interval</td>
 </tr>
 <tr>
 <td>LE_Scan_Window</td>
 <td>Recommendation from the Host on how frequently the Controller should scan</td>
 <td>window</td>
 </tr>
 <tr>
 <td>Scanning_Filter_Policy</td>
 <td>Policy about which advertising packets to accept</td>
 <td>filter</td>
 </tr>
 <tr>
 <td>Duration</td>
 <td>Number of milliseconds before canceling scan procedure</td>
 <td>duration</td>
 </tr>
 <tr>
 <td>Limited</td>
 <td>Limited scan procedure</td>
 <td>limited</td>
 </tr>
 <tr>
 <td>No duplicates</td>
 <td>Filter out duplicates in shell output</td>
 <td>nodups</td>
 </tr>
 <tr>
 <td>Own_Address_Type</td>
 <td>The type of address to use when scanning (see Address types table)</td>
 <td>own_addr_type</td>
 </tr>
 </tbody>
 </table>
 <p>Extended Scan parameters:</p>
 <table>
 <thead>
 <tr>
 <th><em>Name</em></th>
 <th><em>Description</em></th>
 <th><em>btshell string</em></th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>Duration</td>
 <td>Number of milliseconds before canceling scan procedure</td>
 <td>extended_duration</td>
 </tr>
 <tr>
 <td>Period</td>
 <td>Period in which scan should be enabled for specified duration</td>
 <td>extended_period</td>
 </tr>
 <tr>
 <td>LE_Scan_Type</td>
 <td>Controls the type of scan to perform (passive or active)</td>
 <td>longrange_passive</td>
 </tr>
 <tr>
 <td>LE_Scan_Interval</td>
 <td>Recommendation from the Host on how long the Controller should scan</td>
 <td>longrange_interval</td>
 </tr>
 <tr>
 <td>LE_Scan_Window</td>
 <td>Recommendation from the Host on how frequently the Controller should scan</td>
 <td>longrange_window</td>
 </tr>
 </tbody>
 </table>
 <h3 id="advertisment-parameters">Advertisment Parameters</h3>
 <table>
 <thead>
 <tr>
 <th><em>btshell string</em></th>
 <th><em>Description</em></th>
 <th><em>Notes</em></th>
 <th><em>Default</em></th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>conn</td>
 <td>Connectable mode</td>
 <td>See Connectable Modes table.</td>
 <td>und</td>
 </tr>
 <tr>
 <td>discov</td>
 <td>Discoverable mode</td>
 <td>See Discoverable Modes table.</td>
 <td>gen</td>
 </tr>
 <tr>
 <td>own_addr_type</td>
 <td>The type of address to advertise with</td>
 <td>See Address Types table.</td>
 <td>public</td>
 </tr>
 <tr>
 <td>peer_addr_type</td>
 <td>The peer's address type</td>
 <td>Only used for directed advertising; see Address Types table.</td>
 <td>public</td>
 </tr>
 <tr>
 <td>peer_addr</td>
 <td>The peer's address</td>
 <td>Only used for directed advertising</td>
 <td>N/A</td>
 </tr>
 <tr>
 <td>channel_map</td>
 <td></td>
 <td></td>
 <td>0</td>
 </tr>
 <tr>
 <td>filter</td>
 <td>The filter policy</td>
 <td>See Advertisement Filter Policies table.</td>
 <td>none</td>
 </tr>
 <tr>
 <td>interval_min</td>
 <td></td>
 <td>units=0.625ms</td>
 <td>non: 100ms; und/dir: 30ms</td>
 </tr>
 <tr>
 <td>interval_max</td>
 <td></td>
 <td>units=0.625ms</td>
 <td>non: 150ms; und/dir: 60ms</td>
 </tr>
 <tr>
 <td>high_duty</td>
 <td>Whether to use high-duty-cycle</td>
 <td>0/1</td>
 <td>0</td>
 </tr>
 <tr>
 <td>duration</td>
 <td></td>
 <td>Milliseconds</td>
 <td>Forever</td>
 </tr>
 </tbody>
 </table>
 <p>Extended Advertising parameters:</p>
 <table>
 <thead>
 <tr>
 <th><em>btshell string</em></th>
 <th><em>Description</em></th>
 <th><em>Notes</em></th>
 <th><em>Default</em></th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>tx_power</td>
 <td>Maximum power level at which the advertising packets are to be transmitted</td>
 <td>-127 - 127 dBm</td>
 <td>127 (Host has no preference)</td>
 </tr>
 <tr>
 <td>primary_phy</td>
 <td>PHY on which the advertising packets are transmitted on the primary advertising channel</td>
 <td></td>
 <td>none</td>
 </tr>
 <tr>
 <td>secondary_phy</td>
 <td>PHY on which the advertising packets are transmitted on the secondary advertising channel</td>
 <td></td>
 <td>primary_phy</td>
 </tr>
 </tbody>
 </table>
 <h3 id="advertising-phy-types">Advertising PHY Types</h3>
 <table>
 <thead>
 <tr>
 <th><em>Description</em></th>
 <th><em>btshell parameter value</em></th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>Legacy advertising</td>
 <td>none</td>
 </tr>
 <tr>
 <td>Extended advertising with 1M PHY</td>
 <td>1M</td>
 </tr>
 <tr>
 <td>Extended advertising with 2M PHY</td>
 <td>2M</td>
 </tr>
 <tr>
 <td>Extended advertising with coded PHY</td>
 <td>coded</td>
 </tr>
 </tbody>
 </table>
 <h3 id="advertisement-filter-policies">Advertisement Filter Policies</h3>
 <table>
 <thead>
 <tr>
 <th><em>btshell string</em></th>
 <th><em>Description</em></th>
 <th><em>Notes</em></th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>none</td>
 <td>No filtering. No whitelist used.</td>
 <td>Default</td>
 </tr>
 <tr>
 <td>scan</td>
 <td>Process all connection requests but only scans from white list.</td>
 <td></td>
 </tr>
 <tr>
 <td>conn</td>
 <td>Process all scan request but only connection requests from white list.</td>
 <td></td>
 </tr>
 <tr>
 <td>both</td>
 <td>Ignore all scan and connection requests unless in white list.</td>
 <td></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 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>