http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/e98b0c12/develop/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_dsc/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_dsc/index.html b/develop/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_dsc/index.html new file mode 100644 index 0000000..02e1c0e --- /dev/null +++ b/develop/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_dsc/index.html @@ -0,0 +1,635 @@ +<!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"> + + + <link rel="canonical" href="http://mynewt.apache.org/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_dsc/"> + <link rel="shortcut icon" href="../../../../../../img/favicon.ico"> + + <title>ble_gatts_find_dsc - Apache Mynewt</title> + + <link href="../../../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> + <link href="../../../../../../css/font-awesome-4.0.3.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=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css"> + <link href="../../../../../../extra.css" rel="stylesheet"> + + <!-- 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="ble_gatts_find_dsc"> + + + + + + + + + +<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" 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="/">Home</a> + </li> + <li + class="important" +> + <a href="/quick-start/">Quick Start</a> + </li> + <li + class="" +> + <a href="/about/">About</a> + </li> + <li + class="active" +> + <a href="/latest/os/introduction">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> + + <!-- Search, Navigation and Repo links --> + <ul class="nav navbar-nav navbar-right"> + + </ul> + </div> + </div> +</nav> + + + + <div class="container"> + + <div class="row"> + <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="top"> + <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt"> + <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="/develop/os/introduction" + selected="selected" + > + Version: develop + </option> + + <option + value="/v0_9_0/os/introduction" + + > + Version: 0.9.0 (latest) + </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 ><a href="../../../ble_gap/ble_gap/">GAP</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_gattc/ble_gattc/">GATT client</a> + + + </li> + + + + + + + + <li ><a href="../../ble_gatts/">GATT server</a> + + + <ul> + + + + + + + + <li><a href=" + ../../definitions/ble_gatts_defs/ +">Definitions</a> + + + </li> + + + + + + + + <li><a href=" + ../ble_gatts_find_chr/ +">Functions</a> + + + <ul> + + + + <li > + <a href="../ble_gatts_find_chr/">ble_gatts_find_chr</a> + </li> + + + + + + <li class="active"> + <a href="./">ble_gatts_find_dsc</a> + </li> + + + + + + <li > + <a href="../ble_gatts_find_svc/">ble_gatts_find_svc</a> + </li> + + + + + + <li > + <a href="../ble_gatts_register_svcs/">ble_gatts_register_svcs</a> + </li> + + + + </ul> + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../ble_hs_id/ble_hs_id/">Identity</a> + + + </li> + + + + + + + + <li ><a href="../../../other/other/">Other</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../../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> + + + + </ul> + + </li> + + + + + + + + <li><a href=" + ../../../../../../faq/how_to_edit_docs/ +">Appendix</a> + + + </li> + + + + </ul> +</div></div> + + <div class="show-sidebar-container"> + <button class="show-sidebar">Docs Menu</button> + </div> + + <div class="col-md-9" role="main"> + <div class="row doc-header"> + <div class="col-sm-12"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs pull-right"> + <li><a href="/develop/os/introduction">Docs</a></li> + + + + <li>» <a href="../../ble_gatts/">GATT server</a></li> + + + + <li>» <a href="../ble_gatts_find_chr/">Functions</a></li> + + + + <li>» ble_gatts_find_dsc</li> + + + + </ul> +</div> + </div> + </div> + + <h2 id="ble95gatts95find95dsc"><font color="#F2853F" style="font-size:24pt">ble_gatts_find_dsc</font></h2> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> +<span style="color: #000000">ble_gatts_find_dsc</span>(<span style="color: #A90D91">const</span> <span style="color: #A90D91">void</span> <span style="color: #000000">*svc_uuid128</span>, <span style="color: #A90D91">const</span> <span style="color: #A90D91">void</span> <span style="color: #000000">*chr_uuid128</span>, + <span style="color: #A90D91">const</span> <span style="color: #A90D91">void</span> <span style="color: #000000">*dsc_uuid128</span>, <span style="color: #A90D91">uint16_t</span> <span style="color: #000000">*out_handle</span>) +</pre></div> + + +<h3 id="description">Description</h3> +<p>Retrieves the attribute handle associated with a local GATT descriptor. </p> +<h3 id="parameters">Parameters</h3> +<table> +<thead> +<tr> +<th><em>Parameter</em></th> +<th><em>Description</em></th> +</tr> +</thead> +<tbody> +<tr> +<td>svc_uuid128</td> +<td>The UUID of the grandparent service.</td> +</tr> +<tr> +<td>chr_uuid128</td> +<td>The UUID of the parent characteristic.</td> +</tr> +<tr> +<td>dsc_uuid128</td> +<td>The UUID of the descriptor ro look up.</td> +</tr> +<tr> +<td>out_handle</td> +<td>On success, populated with the handle of the descripytor attribute. Pass null if you don't need this value.</td> +</tr> +</tbody> +</table> +<h3 id="returned-values">Returned values</h3> +<table> +<thead> +<tr> +<th><em>Value</em></th> +<th><em>Condition</em></th> +</tr> +</thead> +<tbody> +<tr> +<td>0</td> +<td>Success.</td> +</tr> +<tr> +<td>BLE_HS_ENOENT</td> +<td>The specified service, characteristic, or descriptor could not be found.</td> +</tr> +</tbody> +</table> + + <div class="row"> + + + + +<ul class="nav nav-pills" style="margin-bottom: 10px"> + <li> + + <a href=../ble_gatts_find_chr/> + <span class="fa fa-arrow-left"></span> + Previous: ble_gatts_find_chr + </a> + + </li> + <li class="pull-right"> + + <a href=../ble_gatts_find_svc/> + Next: ble_gatts_find_svc + <span class="fa fa-arrow-right"></span> + </a> + + </li> +</ul> + </div> + <div class="row"> + <footer> + <div class="row"> + <div class="col-md-12"> + + <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p> + + </div> + </div> + <div class="copyright-logos"> + <div class="row"> + <div class="col-xs-6 text-right"> + <img src="/img/apache-feather.png" alt="Apache" title="Apache"> + </div> + <div class="col-xs-6 text-left"> + <img src="/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator"> + </div> + </div> + </div> + <div class="row"> + <div class="col-md-12"> + <small class="footnote"> + MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. + </small> + </div> + </div> +</footer> + </div> + </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> + + </body> +</html> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/e98b0c12/develop/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_svc/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_svc/index.html b/develop/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_svc/index.html new file mode 100644 index 0000000..f46b11a --- /dev/null +++ b/develop/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_svc/index.html @@ -0,0 +1,626 @@ +<!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"> + + + <link rel="canonical" href="http://mynewt.apache.org/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_svc/"> + <link rel="shortcut icon" href="../../../../../../img/favicon.ico"> + + <title>ble_gatts_find_svc - Apache Mynewt</title> + + <link href="../../../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> + <link href="../../../../../../css/font-awesome-4.0.3.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=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css"> + <link href="../../../../../../extra.css" rel="stylesheet"> + + <!-- 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="ble_gatts_find_svc"> + + + + + + + + + +<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" 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="/">Home</a> + </li> + <li + class="important" +> + <a href="/quick-start/">Quick Start</a> + </li> + <li + class="" +> + <a href="/about/">About</a> + </li> + <li + class="active" +> + <a href="/latest/os/introduction">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> + + <!-- Search, Navigation and Repo links --> + <ul class="nav navbar-nav navbar-right"> + + </ul> + </div> + </div> +</nav> + + + + <div class="container"> + + <div class="row"> + <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="top"> + <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt"> + <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="/develop/os/introduction" + selected="selected" + > + Version: develop + </option> + + <option + value="/v0_9_0/os/introduction" + + > + Version: 0.9.0 (latest) + </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 ><a href="../../../ble_gap/ble_gap/">GAP</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_gattc/ble_gattc/">GATT client</a> + + + </li> + + + + + + + + <li ><a href="../../ble_gatts/">GATT server</a> + + + <ul> + + + + + + + + <li><a href=" + ../../definitions/ble_gatts_defs/ +">Definitions</a> + + + </li> + + + + + + + + <li><a href=" + ../ble_gatts_find_chr/ +">Functions</a> + + + <ul> + + + + <li > + <a href="../ble_gatts_find_chr/">ble_gatts_find_chr</a> + </li> + + + + + + <li > + <a href="../ble_gatts_find_dsc/">ble_gatts_find_dsc</a> + </li> + + + + + + <li class="active"> + <a href="./">ble_gatts_find_svc</a> + </li> + + + + + + <li > + <a href="../ble_gatts_register_svcs/">ble_gatts_register_svcs</a> + </li> + + + + </ul> + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../ble_hs_id/ble_hs_id/">Identity</a> + + + </li> + + + + + + + + <li ><a href="../../../other/other/">Other</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../../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> + + + + </ul> + + </li> + + + + + + + + <li><a href=" + ../../../../../../faq/how_to_edit_docs/ +">Appendix</a> + + + </li> + + + + </ul> +</div></div> + + <div class="show-sidebar-container"> + <button class="show-sidebar">Docs Menu</button> + </div> + + <div class="col-md-9" role="main"> + <div class="row doc-header"> + <div class="col-sm-12"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs pull-right"> + <li><a href="/develop/os/introduction">Docs</a></li> + + + + <li>» <a href="../../ble_gatts/">GATT server</a></li> + + + + <li>» <a href="../ble_gatts_find_chr/">Functions</a></li> + + + + <li>» ble_gatts_find_svc</li> + + + + </ul> +</div> + </div> + </div> + + <h2 id="ble95gatts95find95svc"><font color="#F2853F" style="font-size:24pt">ble_gatts_find_svc</font></h2> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> +<span style="color: #000000">ble_gatts_find_svc</span>(<span style="color: #A90D91">const</span> <span style="color: #A90D91">void</span> <span style="color: #000000">*uuid128</span>, <span style="color: #A90D91">uint16_t</span> <span style="color: #000000">*out_handle</span>) +</pre></div> + + +<h3 id="description">Description</h3> +<p>Retrieves the attribute handle associated with a local GATT service. </p> +<h3 id="parameters">Parameters</h3> +<table> +<thead> +<tr> +<th><em>Parameter</em></th> +<th><em>Description</em></th> +</tr> +</thead> +<tbody> +<tr> +<td>uuid128</td> +<td>The UUID of the service to look up.</td> +</tr> +<tr> +<td>out_handle</td> +<td>On success, populated with the handle of the service attribute. Pass null if you don't need this value.</td> +</tr> +</tbody> +</table> +<h3 id="returned-values">Returned values</h3> +<table> +<thead> +<tr> +<th><em>Value</em></th> +<th><em>Condition</em></th> +</tr> +</thead> +<tbody> +<tr> +<td>0</td> +<td>Success.</td> +</tr> +<tr> +<td>BLE_HS_ENOENT</td> +<td>The specified service could not be found.</td> +</tr> +</tbody> +</table> + + <div class="row"> + + + + +<ul class="nav nav-pills" style="margin-bottom: 10px"> + <li> + + <a href=../ble_gatts_find_dsc/> + <span class="fa fa-arrow-left"></span> + Previous: ble_gatts_find_dsc + </a> + + </li> + <li class="pull-right"> + + <a href=../ble_gatts_register_svcs/> + Next: ble_gatts_register_svcs + <span class="fa fa-arrow-right"></span> + </a> + + </li> +</ul> + </div> + <div class="row"> + <footer> + <div class="row"> + <div class="col-md-12"> + + <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p> + + </div> + </div> + <div class="copyright-logos"> + <div class="row"> + <div class="col-xs-6 text-right"> + <img src="/img/apache-feather.png" alt="Apache" title="Apache"> + </div> + <div class="col-xs-6 text-left"> + <img src="/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator"> + </div> + </div> + </div> + <div class="row"> + <div class="col-md-12"> + <small class="footnote"> + MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. + </small> + </div> + </div> +</footer> + </div> + </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> + + </body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/e98b0c12/develop/network/ble/ble_hs/ble_gatts/functions/ble_gatts_register_svcs/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_gatts/functions/ble_gatts_register_svcs/index.html b/develop/network/ble/ble_hs/ble_gatts/functions/ble_gatts_register_svcs/index.html new file mode 100644 index 0000000..415f507 --- /dev/null +++ b/develop/network/ble/ble_hs/ble_gatts/functions/ble_gatts_register_svcs/index.html @@ -0,0 +1,635 @@ +<!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"> + + + <link rel="canonical" href="http://mynewt.apache.org/network/ble/ble_hs/ble_gatts/functions/ble_gatts_register_svcs/"> + <link rel="shortcut icon" href="../../../../../../img/favicon.ico"> + + <title>ble_gatts_register_svcs - Apache Mynewt</title> + + <link href="../../../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> + <link href="../../../../../../css/font-awesome-4.0.3.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=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css"> + <link href="../../../../../../extra.css" rel="stylesheet"> + + <!-- 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="ble_gatts_register_svcs"> + + + + + + + + + +<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" 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="/">Home</a> + </li> + <li + class="important" +> + <a href="/quick-start/">Quick Start</a> + </li> + <li + class="" +> + <a href="/about/">About</a> + </li> + <li + class="active" +> + <a href="/latest/os/introduction">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> + + <!-- Search, Navigation and Repo links --> + <ul class="nav navbar-nav navbar-right"> + + </ul> + </div> + </div> +</nav> + + + + <div class="container"> + + <div class="row"> + <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="top"> + <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt"> + <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="/develop/os/introduction" + selected="selected" + > + Version: develop + </option> + + <option + value="/v0_9_0/os/introduction" + + > + Version: 0.9.0 (latest) + </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 ><a href="../../../ble_gap/ble_gap/">GAP</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_gattc/ble_gattc/">GATT client</a> + + + </li> + + + + + + + + <li ><a href="../../ble_gatts/">GATT server</a> + + + <ul> + + + + + + + + <li><a href=" + ../../definitions/ble_gatts_defs/ +">Definitions</a> + + + </li> + + + + + + + + <li><a href=" + ../ble_gatts_find_chr/ +">Functions</a> + + + <ul> + + + + <li > + <a href="../ble_gatts_find_chr/">ble_gatts_find_chr</a> + </li> + + + + + + <li > + <a href="../ble_gatts_find_dsc/">ble_gatts_find_dsc</a> + </li> + + + + + + <li > + <a href="../ble_gatts_find_svc/">ble_gatts_find_svc</a> + </li> + + + + + + <li class="active"> + <a href="./">ble_gatts_register_svcs</a> + </li> + + + + </ul> + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../ble_hs_id/ble_hs_id/">Identity</a> + + + </li> + + + + + + + + <li ><a href="../../../other/other/">Other</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../../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> + + + + </ul> + + </li> + + + + + + + + <li><a href=" + ../../../../../../faq/how_to_edit_docs/ +">Appendix</a> + + + </li> + + + + </ul> +</div></div> + + <div class="show-sidebar-container"> + <button class="show-sidebar">Docs Menu</button> + </div> + + <div class="col-md-9" role="main"> + <div class="row doc-header"> + <div class="col-sm-12"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs pull-right"> + <li><a href="/develop/os/introduction">Docs</a></li> + + + + <li>» <a href="../../ble_gatts/">GATT server</a></li> + + + + <li>» <a href="../ble_gatts_find_chr/">Functions</a></li> + + + + <li>» ble_gatts_register_svcs</li> + + + + </ul> +</div> + </div> + </div> + + <h2 id="ble95gatts95register95svcs"><font color="#F2853F" style="font-size:24pt">ble_gatts_register_svcs</font></h2> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> +<span style="color: #000000">ble_gatts_register_svcs</span>(<span style="color: #A90D91">const</span> <span style="color: #A90D91">struct</span> <span style="color: #000000">ble_gatt_svc_def</span> <span style="color: #000000">*svcs</span>, + <span style="color: #000000">ble_gatt_register_fn</span> <span style="color: #000000">*cb</span>, <span style="color: #A90D91">void</span> <span style="color: #000000">*cb_arg</span>) +</pre></div> + + +<h3 id="description">Description</h3> +<p>Registers a set of services, characteristics, and descriptors to be accessed by GATT clients. </p> +<h3 id="parameters">Parameters</h3> +<table> +<thead> +<tr> +<th><em>Parameter</em></th> +<th><em>Description</em></th> +</tr> +</thead> +<tbody> +<tr> +<td>svcs</td> +<td>A table of the service definitions to be registered.</td> +</tr> +<tr> +<td>cb</td> +<td>The function to call for each service, characteristic, and descriptor that gets registered.</td> +</tr> +<tr> +<td>cb_arg</td> +<td>The optional argument to pass to the callback function.</td> +</tr> +</tbody> +</table> +<h3 id="returned-values">Returned values</h3> +<table> +<thead> +<tr> +<th><em>Value</em></th> +<th><em>Condition</em></th> +</tr> +</thead> +<tbody> +<tr> +<td>0</td> +<td>Success.</td> +</tr> +<tr> +<td>BLE_HS_ENOMEM</td> +<td>Registration failed due to resource exhaustion.</td> +</tr> +<tr> +<td>BLE_HS_EINVAL</td> +<td>The service definition table contains an invalid element.</td> +</tr> +</tbody> +</table> + + <div class="row"> + + + + +<ul class="nav nav-pills" style="margin-bottom: 10px"> + <li> + + <a href=../ble_gatts_find_svc/> + <span class="fa fa-arrow-left"></span> + Previous: ble_gatts_find_svc + </a> + + </li> + <li class="pull-right"> + + <a href=../../../ble_hs_id/ble_hs_id/> + Next: Identity + <span class="fa fa-arrow-right"></span> + </a> + + </li> +</ul> + </div> + <div class="row"> + <footer> + <div class="row"> + <div class="col-md-12"> + + <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p> + + </div> + </div> + <div class="copyright-logos"> + <div class="row"> + <div class="col-xs-6 text-right"> + <img src="/img/apache-feather.png" alt="Apache" title="Apache"> + </div> + <div class="col-xs-6 text-left"> + <img src="/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator"> + </div> + </div> + </div> + <div class="row"> + <div class="col-md-12"> + <small class="footnote"> + MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. + </small> + </div> + </div> +</footer> + </div> + </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> + + </body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/e98b0c12/develop/network/ble/ble_hs/ble_hs/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_hs/index.html b/develop/network/ble/ble_hs/ble_hs/index.html new file mode 100644 index 0000000..c00aff4 --- /dev/null +++ b/develop/network/ble/ble_hs/ble_hs/index.html @@ -0,0 +1,529 @@ +<!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"> + + + <link rel="canonical" href="http://mynewt.apache.org/network/ble/ble_hs/ble_hs/"> + <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 href="../../../../css/font-awesome-4.0.3.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=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css"> + <link href="../../../../extra.css" rel="stylesheet"> + + <!-- 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"> + + + + + + + + + +<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" 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="/">Home</a> + </li> + <li + class="important" +> + <a href="/quick-start/">Quick Start</a> + </li> + <li + class="" +> + <a href="/about/">About</a> + </li> + <li + class="active" +> + <a href="/latest/os/introduction">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> + + <!-- Search, Navigation and Repo links --> + <ul class="nav navbar-nav navbar-right"> + + </ul> + </div> + </div> +</nav> + + + + <div class="container"> + + <div class="row"> + <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="top"> + <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt"> + <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="/develop/os/introduction" + selected="selected" + > + Version: develop + </option> + + <option + value="/v0_9_0/os/introduction" + + > + Version: 0.9.0 (latest) + </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 class="active"><a href="./">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 ><a href="../ble_gap/ble_gap/">GAP</a> + + + </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="../other/other/">Other</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../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> + + + + </ul> + + </li> + + + + + + + + <li><a href=" + ../../../../faq/how_to_edit_docs/ +">Appendix</a> + + + </li> + + + + </ul> +</div></div> + + <div class="show-sidebar-container"> + <button class="show-sidebar">Docs Menu</button> + </div> + + <div class="col-md-9" role="main"> + <div class="row doc-header"> + <div class="col-sm-12"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs pull-right"> + <li><a href="/develop/os/introduction">Docs</a></li> + + + + <li>» <a href="../../ble_intro/">BLE User Guide</a></li> + + + + <li>» NimBLE Host API</li> + + + + + + </ul> +</div> + </div> + </div> + + <h1 id="nimble-host">NimBLE Host</h1> +<h3 id="introduction">Introduction</h3> +<p>At a high level, the NimBLE stack is is divided into two components:</p> +<ul> +<li>Host</li> +<li>Controller</li> +</ul> +<p>This document is an API reference for the host component. If you are interested in the general structure of the NimBLE stack and its non-host components, you might want to read the <a href="../../ble_intro/">BLE introduction</a>.</p> +<p>The host sits directly below the application, and it serves as the interface to the application for all BLE operations.</p> +<h3 id="reference">Reference</h3> +<ul> +<li><a href="../ble_hs_return_codes/">NimBLE Host Return Codes</a></li> +<li><a href="../init/init/">Initialization and Configuration</a></li> +<li><a href="../ble_gap/ble_gap/">Generic Access Protocol (GAP)</a></li> +<li><a href="../ble_gattc/ble_gattc/">Generic Attribute Profile (GATT) Client</a></li> +<li><a href="../ble_gatts/ble_gatts/">Generic Attribute Profile (GATT) Server</a></li> +<li><a href="../ble_hs_id/ble_hs_id/">Identity</a></li> +<li><a href="../other/other/">Other</a></li> +</ul> + + <div class="row"> + + + + +<ul class="nav nav-pills" style="margin-bottom: 10px"> + <li> + + <a href=../../ini_stack/ble_host_ini/> + <span class="fa fa-arrow-left"></span> + Previous: Initialize host + </a> + + </li> + <li class="pull-right"> + + <a href=../ble_hs_return_codes/> + Next: Return codes + <span class="fa fa-arrow-right"></span> + </a> + + </li> +</ul> + </div> + <div class="row"> + <footer> + <div class="row"> + <div class="col-md-12"> + + <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p> + + </div> + </div> + <div class="copyright-logos"> + <div class="row"> + <div class="col-xs-6 text-right"> + <img src="/img/apache-feather.png" alt="Apache" title="Apache"> + </div> + <div class="col-xs-6 text-left"> + <img src="/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator"> + </div> + </div> + </div> + <div class="row"> + <div class="col-md-12"> + <small class="footnote"> + MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. + </small> + </div> + </div> +</footer> + </div> + </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> + + </body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/e98b0c12/develop/network/ble/ble_hs/ble_hs_id/ble_hs_id/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_hs_id/ble_hs_id/index.html b/develop/network/ble/ble_hs/ble_hs_id/ble_hs_id/index.html new file mode 100644 index 0000000..df21cbd --- /dev/null +++ b/develop/network/ble/ble_hs/ble_hs_id/ble_hs_id/index.html @@ -0,0 +1,604 @@ +<!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"> + + + <link rel="canonical" href="http://mynewt.apache.org/network/ble/ble_hs/ble_hs_id/ble_hs_id/"> + <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 href="../../../../../css/font-awesome-4.0.3.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=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css"> + <link href="../../../../../extra.css" rel="stylesheet"> + + <!-- 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"> + + + + + + + + + +<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" 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="/">Home</a> + </li> + <li + class="important" +> + <a href="/quick-start/">Quick Start</a> + </li> + <li + class="" +> + <a href="/about/">About</a> + </li> + <li + class="active" +> + <a href="/latest/os/introduction">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> + + <!-- Search, Navigation and Repo links --> + <ul class="nav navbar-nav navbar-right"> + + </ul> + </div> + </div> +</nav> + + + + <div class="container"> + + <div class="row"> + <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="top"> + <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt"> + <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="/develop/os/introduction" + selected="selected" + > + Version: develop + </option> + + <option + value="/v0_9_0/os/introduction" + + > + Version: 0.9.0 (latest) + </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 ><a href="../../ble_gap/ble_gap/">GAP</a> + + + </li> + + + + + + + + <li ><a href="../../ble_gattc/ble_gattc/">GATT client</a> + + + </li> + + + + + + + + <li ><a href="../../ble_gatts/ble_gatts/">GATT server</a> + + + </li> + + + + + + + + <li class="active"><a href="./">Identity</a> + + + <ul> + + + + + + + + <li><a href=" + ../functions/ble_hs_id_copy_addr/ +">Functions</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../other/other/">Other</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../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> + + + + </ul> + + </li> + + + + + + + + <li><a href=" + ../../../../../faq/how_to_edit_docs/ +">Appendix</a> + + + </li> + + + + </ul> +</div></div> + + <div class="show-sidebar-container"> + <button class="show-sidebar">Docs Menu</button> + </div> + + <div class="col-md-9" role="main"> + <div class="row doc-header"> + <div class="col-sm-12"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs pull-right"> + <li><a href="/develop/os/introduction">Docs</a></li> + + + + <li>» <a href="../../ble_hs/">NimBLE Host API</a></li> + + + + <li>» Identity</li> + + + + + + </ul> +</div> + </div> + </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 identity API provides facilities for querying and configuring your device's addresses. BLE's addressing scheme is quite involved; the summary that follows is only a brief introduction.</p> +<p>BLE defines four address types:</p> +<table> +<thead> +<tr> +<th>Type</th> +<th>Description</th> +<th>Identity?</th> +<th>Configured with</th> +</tr> +</thead> +<tbody> +<tr> +<td>Public</td> +<td>Address assigned by manufacturer; the three most significant bytes form the manufacturer's OUI.</td> +<td>Yes</td> +<td>N/A; read from controller at startup.</td> +</tr> +<tr> +<td>Static random</td> +<td>Randomly generated address.</td> +<td>Yes</td> +<td><em>ble_hs_id_set_rnd()</em></td> +</tr> +<tr> +<td>Resolvable private (RPA)</td> +<td>Address randomly generated from an identity address and an identity resolving key (IRK).</td> +<td>No</td> +<td>N/A; generated by controller periodically.</td> +</tr> +<tr> +<td>Non-resolvable private (NRPA)</td> +<td>Randomly generated address.</td> +<td>No</td> +<td><em>ble_hs_id_set_rnd()</em></td> +</tr> +</tbody> +</table> +<h4 id="identity-addresses">Identity Addresses</h4> +<p>The third column in the above table indicates the <em>identity</em> property of each address type. An identity address never changes, and a device can be identified by one of its unique identity addresses.</p> +<p>Non-identity addresses are used by devices supporting BLE privacy. A device using the privacy feature frequently changes its own address to a newly-generated non-identity address. By cycling its address, the device makes it impossible for eavesdroppers to track its location.</p> +<p>A device can have up to two identity addresses at once: one public and one static random. As indicated in the above table, the public identity address cannot be configured; the static random identity address can be set by calling <em>ble_hs_id_set_rnd()</em>.</p> +<p>The address type is selected on a per-GAP-procedure basis. Each time you initiate a GAP procedure, you indicate which address type the device should use for the duration of the procedure.</p> +<h3 id="header">Header</h3> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#include "host/ble_hs.h"</span> +</pre></div> + + +<h3 id="definitions">Definitions</h3> +<p>None.</p> +<h3 id="functions">Functions</h3> +<table> +<thead> +<tr> +<th>Function</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td><a href="../functions/ble_hs_id_copy_addr/">ble_hs_id_copy_addr</a></td> +<td>Retrieves one of the device's identity addresses.</td> +</tr> +<tr> +<td><a href="../functions/ble_hs_id_gen_rnd/">ble_hs_id_gen_rnd</a></td> +<td>Generates a new random address.</td> +</tr> +<tr> +<td><a href="../functions/ble_hs_id_set_rnd/">ble_hs_id_set_rnd</a></td> +<td>Sets the device's random address.</td> +</tr> +</tbody> +</table> + + <div class="row"> + + + + +<ul class="nav nav-pills" style="margin-bottom: 10px"> + <li> + + <a href=../../ble_gatts/functions/ble_gatts_register_svcs/> + <span class="fa fa-arrow-left"></span> + Previous: ble_gatts_register_svcs + </a> + + </li> + <li class="pull-right"> + + <a href=../functions/ble_hs_id_copy_addr/> + Next: ble_hs_id_copy_addr + <span class="fa fa-arrow-right"></span> + </a> + + </li> +</ul> + </div> + <div class="row"> + <footer> + <div class="row"> + <div class="col-md-12"> + + <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p> + + </div> + </div> + <div class="copyright-logos"> + <div class="row"> + <div class="col-xs-6 text-right"> + <img src="/img/apache-feather.png" alt="Apache" title="Apache"> + </div> + <div class="col-xs-6 text-left"> + <img src="/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator"> + </div> + </div> + </div> + <div class="row"> + <div class="col-md-12"> + <small class="footnote"> + MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. + </small> + </div> + </div> +</footer> + </div> + </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> + + </body> +</html> \ No newline at end of file