Google Git
Sign in
apache / mynewt-site / 8528acea806ecedcedbaec90568a1524b3ae623d / . / v1_3_0 / network / ble / btshell / btshell_GATT / index.html
blob: 42e5213816a9469ef022b4d4d15689922f04bec4 [file] [log] [blame]
<!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>GATT 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="GATT 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" selected="selected" >
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></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="../btshell_api/">btshell Usage API</a>
<ul>
<li >
<a href="../btshell_GAP/">GAP in btshell</a>
</li>
<li class="active">
<a href="./">GATT in btshell</a>
</li>
<li >
<a href="../btshell_advdata/">Advertisement Data Fields</a>
</li>
</ul>
</li>
<li ><a href="../../ble_mesh/">Bluetooth Mesh</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="
../../../../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 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; GATT in btshell</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/apache/mynewt-site/blob/master/docs/network/ble/btshell/btshell_GATT.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
</div>
</div>
<div class="alert alert-warning">
<p>
Version 1.3.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="gatt-feature-api-for-btshell">GATT feature API for btshell</h2>
<p><br></p>
<p>GATT(GENERIC ATTRIBUTE PROFILE) describes a service framework using the Attribute Protocol for discovering services, and for reading and writing characteristic values on a peer device. There are 11 features defined in the GATT Profile, and each of the features is mapped to procedures and sub-procedures: </p>
<h3 id="available-commands">Available commands</h3>
<p>Parameters default values (if applicable) are marked red.</p>
<h2 id="configuration">Configuration</h2>
<table>
<thead>
<tr>
<th><strong>Command</strong></th>
<th><strong>Parmeters</strong></th>
<th>** Possible values**</th>
<th><strong>Description</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>gatt-discover-characteristic</strong></td>
<td></td>
<td></td>
<td>Discover GATT characteristics</td>
</tr>
<tr>
<td></td>
<td>conn</td>
<td>[UINT16]</td>
<td>Connection handle</td>
</tr>
<tr>
<td></td>
<td>uuid</td>
<td>[UINT16]</td>
<td>Characteristic UUID</td>
</tr>
<tr>
<td></td>
<td>start</td>
<td>[UINT16]</td>
<td>Discovery start handle</td>
</tr>
<tr>
<td></td>
<td>end</td>
<td>[UINT16]</td>
<td>Discovery end handle</td>
</tr>
<tr>
<td><strong>gatt-discover-descriptor</strong></td>
<td></td>
<td></td>
<td>Discover GATT descriptors</td>
</tr>
<tr>
<td></td>
<td>conn</td>
<td>[UINT16]</td>
<td>Connection handle</td>
</tr>
<tr>
<td></td>
<td>start</td>
<td>[UINT16]</td>
<td>Discovery start handle</td>
</tr>
<tr>
<td></td>
<td>end</td>
<td>[UINT16]</td>
<td>Discovery end handle</td>
</tr>
<tr>
<td><strong>gatt-discover-service</strong></td>
<td></td>
<td></td>
<td>Discover services</td>
</tr>
<tr>
<td></td>
<td>conn</td>
<td>[UINT16]</td>
<td>Connection handle</td>
</tr>
<tr>
<td></td>
<td>uuid16</td>
<td>[UINT16]</td>
<td>Service UUID</td>
</tr>
<tr>
<td><strong>gatt-discover-full</strong></td>
<td></td>
<td></td>
<td>Discover services, characteristic and descriptors</td>
</tr>
<tr>
<td></td>
<td>conn</td>
<td>[UINT16]</td>
<td>Connection handle</td>
</tr>
<tr>
<td><strong>gatt-find-included-services</strong></td>
<td></td>
<td></td>
<td>Find included services</td>
</tr>
<tr>
<td></td>
<td>conn</td>
<td>[UINT16]</td>
<td>Connection handle</td>
</tr>
<tr>
<td></td>
<td>start</td>
<td>[UINT16]</td>
<td>Discovery start handle</td>
</tr>
<tr>
<td></td>
<td>end</td>
<td>[UINT16]</td>
<td>Discovery end handle</td>
</tr>
<tr>
<td><strong>gatt-exchange-mtu</strong></td>
<td></td>
<td></td>
<td>Initiate ATT MTU exchange procedure</td>
</tr>
<tr>
<td></td>
<td>conn</td>
<td>[UINT16]</td>
<td>Connection handle</td>
</tr>
<tr>
<td><strong>gatt-read</strong></td>
<td></td>
<td></td>
<td>Read attribute</td>
</tr>
<tr>
<td></td>
<td>conn</td>
<td>[UINT16]</td>
<td>Connection handle</td>
</tr>
<tr>
<td></td>
<td>long</td>
<td>[<code>0</code>-1]</td>
<td>Long read</td>
</tr>
<tr>
<td></td>
<td>attr</td>
<td>[UINT16]</td>
<td>Attribute handle</td>
</tr>
<tr>
<td></td>
<td>offset</td>
<td>[UINT16]</td>
<td>Long read offset value</td>
</tr>
<tr>
<td></td>
<td>uuid</td>
<td>[UINT16]</td>
<td>Characteristic UUID</td>
</tr>
<tr>
<td></td>
<td>start</td>
<td>[UINT16]</td>
<td>Discovery start handle</td>
</tr>
<tr>
<td></td>
<td>end</td>
<td>[UINT16]</td>
<td>Discovery end handle</td>
</tr>
<tr>
<td><strong>gatt-notify</strong></td>
<td></td>
<td></td>
<td>Send notification or indication to all subscribed peers</td>
</tr>
<tr>
<td></td>
<td>attr</td>
<td>[UINT16]</td>
<td>Attribute handle</td>
</tr>
<tr>
<td><strong>gatt-service-changed</strong></td>
<td></td>
<td></td>
<td>Send Services Changed notification</td>
</tr>
<tr>
<td></td>
<td>start</td>
<td>[UINT16]</td>
<td>Start handle</td>
</tr>
<tr>
<td></td>
<td>end</td>
<td>[UINT16]</td>
<td>End handle</td>
</tr>
<tr>
<td><strong>gatt-service-visibility</strong></td>
<td></td>
<td></td>
<td>Set service visibility</td>
</tr>
<tr>
<td></td>
<td>handle</td>
<td>[UINT16]</td>
<td>Service handle</td>
</tr>
<tr>
<td></td>
<td>visibility</td>
<td>[<code>0</code>-1]</td>
<td>Service visibility</td>
</tr>
<tr>
<td><strong>gatt-show</strong></td>
<td></td>
<td></td>
<td>Show remote devices discovered databases structure</td>
</tr>
<tr>
<td><strong>gatt-show-local</strong></td>
<td></td>
<td></td>
<td>Show local database structure</td>
</tr>
<tr>
<td><strong>gatt-write</strong></td>
<td></td>
<td></td>
<td>Write attribute</td>
</tr>
<tr>
<td></td>
<td>conn</td>
<td>[UINT16]</td>
<td>Connection handle</td>
</tr>
<tr>
<td></td>
<td>no_rsp</td>
<td>[<code>0</code>-1]</td>
<td>Use Write Without Response</td>
</tr>
<tr>
<td></td>
<td>long</td>
<td>[<code>0</code>-1]</td>
<td>Use Long Write procedure</td>
</tr>
<tr>
<td></td>
<td>attr</td>
<td>[UINT16]</td>
<td>Attribute handle</td>
</tr>
<tr>
<td></td>
<td>offset</td>
<td>[UINT16]</td>
<td>Long write offset value</td>
</tr>
<tr>
<td></td>
<td>value</td>
<td>XX:XX:XX...</td>
<td>Data to write</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>