| <!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>BLE HCI interface - 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="BLE HCI interface"> |
| |
| |
| <div class="container"> |
| <div class="row v2-main-banner"> |
| <a class="logo-cell" href="/"> |
| <img class="logo" src="/img/logo.png"> |
| </a> |
| <div class="tagline-cell"> |
| <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> |
| </div> |
| <div class="news-cell"> |
| <div class="well"> |
| <h4>Latest News:</h4> <a href="/download">Apache Mynewt 1.12.0, Apache NimBLE 1.7.0 </a> released (April 4, 2024) |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| <nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" role="navigation"> |
| <div class="container"> |
| <!-- Collapsed navigation --> |
| <div class="navbar-header"> |
| <!-- Expander button --> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| </div> |
| |
| <!-- Expanded navigation --> |
| <div class="navbar-collapse collapse"> |
| <!-- Main navigation --> |
| <ul class="nav navbar-nav navbar-right"> |
| <li |
| class="" |
| > |
| <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> |
| </li> |
| <li |
| class="important" |
| > |
| <a href="/quick-start/">Quick Start</a> |
| </li> |
| <li |
| class="" |
| > |
| <a href="/about/">About</a> |
| </li> |
| <li |
| class="" |
| > |
| <a href="/talks/">Talks</a> |
| </li> |
| <li |
| class="active" |
| > |
| <a href="/documentation/">Documentation</a> |
| </li> |
| <li |
| class="" |
| > |
| <a href="/download/">Download</a> |
| </li> |
| <li |
| class="" |
| > |
| <a href="/community/">Community</a> |
| </li> |
| <li |
| class="" |
| > |
| <a href="/events/">Events</a> |
| </li> |
| </ul> |
| |
| </div> |
| </div> |
| </nav> |
| |
| |
| |
| <div class="container"> |
| |
| <div class="row"> |
| <div class="col-md-3 v2-sidebar sidebar-container"><div id="docSidebar" class="hidden-print" role="complementary"> |
| <div class="top"> |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get"> |
| <div class="form-group"> |
| <input type="text" name="q" class="form-control" placeholder="Search documentation" /> |
| </div> |
| </form> |
| </div> |
| </div> |
| <ul class="toc-nav"> |
| <li class="doc-version"><select class="form-control" onchange="if (this.value) window.location.href=this.value"> |
| <option value="/latest"> |
| Version: master |
| </option> |
| <option value="/v1_12_0/" > |
| Version: 1.12.0 |
| </option> |
| <option value="/v1_11_0/" > |
| Version: 1.11.0 |
| </option> |
| <option value="/v1_10_0/" > |
| Version: 1.10.0 |
| </option> |
| <option value="/v1_9_0/" > |
| Version: 1.9.0 |
| </option> |
| <option value="/v1_8_0/" > |
| Version: 1.8.0 |
| </option> |
| <option value="/v1_7_0/" > |
| Version: 1.7.0 |
| </option> |
| <option value="/v1_6_0/" > |
| Version: 1.6.0 |
| </option> |
| <option value="/v1_5_0/" > |
| Version: 1.5.0 |
| </option> |
| <option value="/v1_4_0/" > |
| Version: 1.4.0 |
| </option> |
| <option value="/v1_3_0/os/introduction" > |
| Version: 1.3.0 |
| </option> |
| <option value="/v1_2_0/os/introduction" > |
| Version: 1.2.0 |
| </option> |
| <option value="/v1_1_0/os/introduction" > |
| Version: 1.1.0 |
| </option> |
| <option value="/v1_0_0/os/introduction" selected="selected" > |
| Version: 1.0.0 |
| </option> |
| <option value="/v0_9_0/os/introduction" > |
| Version: 0.9.0 |
| </option> |
| </select></li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../../introduction/">Mynewt Documentation</a> |
| |
| |
| <ul> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../../get_started/get_started/">Basic Setup</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../../get_started/vocabulary/">Concepts</a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../tutorials/">Tutorials</a> |
| |
| |
| <ul> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../blinky/">Project Blinky</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../repo/add_repos/">Work with repositories</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../project-slinky/">Project Slinky for Remote Comms</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../ibeacon/">BLE iBeacon</a> |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../eddystone/">BLE Eddystone</a> |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../add_newtmgr/">Enable Newt Manager in any app</a> |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../add_shell/">Enable the OS Shell and Console</a> |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../tasks_lesson/">Tasks and Priority Management</a> |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../unit_test/">Write a Test Suite for a Package</a> |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../event_queue/">Events and Event Queues</a> |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../bletiny_project/">BLE app to check stats via console</a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../bleprph/bleprph-intro/">BLE peripheral project</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| <li class="active"> |
| <a href="./">BLE HCI interface</a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li><a href=" |
| ../air_quality_sensor/ |
| ">Air-quality Sensor project</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../nrf52_adc/">Add an Analog Sensor</a> |
| </li> |
| |
| |
| |
| </ul> |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../../os_user_guide/">OS User Guide</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li><a href=" |
| ../../../network/ble/ble_intro/ |
| ">BLE User Guide</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../../../newt/newt_intro/">Newt Tool Guide</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../../../newtmgr/overview/">Newt Manager Guide</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../../../known_issues/">Known Issues</a> |
| </li> |
| |
| |
| |
| </ul> |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li><a href=" |
| ../../../faq/go_env/ |
| ">Appendix</a> |
| |
| |
| </li> |
| |
| |
| |
| </ul> |
| </div></div> |
| |
| <div class="col-md-9" role="main"> |
| <div class="doc-header"> |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="/documentation/">Docs</a></li> |
| |
| |
| |
| <li>» <a href="os/tutorials/tutorials/">Tutorials</a></li> |
| |
| |
| |
| <li>» <a href="os/introduction/">Mynewt Documentation</a></li> |
| |
| |
| |
| <li>» BLE HCI interface</li> |
| |
| |
| |
| </ul> |
| </div> |
| </div> |
| |
| |
| |
| |
| |
| |
| <div class="alert alert-warning"> |
| <p> |
| Version 1.0.0 is not the most recent version of the Apache Mynewt |
| documentation. Click <a href="/latest">here</a> to read the latest |
| version. |
| </p> |
| </div> |
| |
| |
| |
| <h2 id="use-hci-access-to-nimble-controller">Use HCI access to NimBLE controller</h2> |
| <p><br></p> |
| <p>This tutorial explains how to use the example application <code>blehci</code> included in the NimBLE stack to talk to the Mynewt NimBLE controller via the Host Controller Interface. You may build the Mynewt image using a laptop running any OS of your choice - Mac, Linux, or Windows.</p> |
| <p>The host used in this specific example is the BlueZ Bluetooth stack. Since BlueZ is a Bluetooth stack for Linux kernel-based family of operating system, the tutorial expects a computer running Linux OS and with BlueZ installed to talk to the board with the Mynewt image.</p> |
| <p><br></p> |
| <h3 id="prerequisites">Prerequisites</h3> |
| <p>Ensure that you meet the following prerequisites before continuing with one of the tutorials.</p> |
| <ul> |
| <li>Have Internet connectivity to fetch remote Mynewt components.</li> |
| <li>Have a board with BLE radio that is supported by Mynewt. We will use an nRF52 Dev board in this tutorial.</li> |
| <li>Have a USB TTL Serial Cable that supports hardware flow control such as ones found at <a href="http://www.ftdichip.com/Products/Cables/USBTTLSerial.htm">http://www.ftdichip.com/Products/Cables/USBTTLSerial.htm</a> to establish a serial USB connection between the board and the laptop.</li> |
| <li>Install the newt tool and toolchains (See <a href="/os/get_started/get_started.md">Basic Setup</a>).</li> |
| <li>Install a BLE host such as BlueZ on a Linux machine to talk to the nrf52 board running Mynewt. Use <code>sudo apt-get install bluez</code> to install it on your Linux machine. </li> |
| </ul> |
| <p><br></p> |
| <h3 id="create-a-project">Create a project</h3> |
| <p>Use the newt tool to create a new project directory containing a skeletal Mynewt framework. Change into the newly created directory. </p> |
| <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$ newt new blehciproj |
| Downloading project skeleton from apache/incubator-mynewt-blinky... |
| Installing skeleton in blehciproj ... |
| Project blehciproj successfully created. |
| $ cd mblehciproj |
| |
| $ newt install |
| apache-mynewt-core |
| </code></pre></div> |
| |
| <p><br></p> |
| <h3 id="create-targets">Create targets</h3> |
| <p>You will create two targets - one for the bootloader, the other for the application. Then you will add the definitions for them. Note that you are using the example app <code>blehci</code> for the application target. Set the bsp correctly (nrf52pdk or nrf52dk depending on whether the board is the preview kit or the dev kit, respectively).</p> |
| <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$ newt target create nrf52_boot |
| $ newt target set nrf52_boot app=@apache-mynewt-core/apps/boot |
| $ newt target set nrf52_boot bsp=@apache-mynewt-core/hw/bsp/nrf52dk |
| $ newt target set nrf52_boot build_profile=optimized |
| </code></pre></div> |
| |
| <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$ newt target create myble2 |
| $ newt target set myble2 bsp=@apache-mynewt-core/hw/bsp/nrf52dk |
| $ newt target set myble2 app=@apache-mynewt-core/apps/blehci |
| $ newt target set myble2 build_profile=optimized |
| </code></pre></div> |
| |
| <p><br></p> |
| <p>Check that the targets are defined correctly.</p> |
| <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$ newt target show |
| targets/my_blinky_sim |
| app=apps/blinky |
| bsp=@apache-mynewt-core/hw/bsp/native |
| build_profile=debug |
| targets/myble2 |
| app=@apache-mynewt-core/apps/blehci |
| bsp=@apache-mynewt-core/hw/bsp/nrf52dk |
| build_profile=optimized |
| targets/nrf52_boot |
| app=@apache-mynewt-core/apps/boot |
| bsp=@apache-mynewt-core/hw/bsp/nrf52dk |
| build_profile=optimized |
| </code></pre></div> |
| |
| <p><br></p> |
| <h3 id="build-targets">Build targets</h3> |
| <p>Then build the two targets.</p> |
| <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$ newt build nrf52_boot |
| <snip> |
| Linking ~/dev/blehciproj/bin/targets/nrf52_boot/app/apps/boot/boot.elf |
| Target successfully built: targets/nrf52_boot |
| |
| $ newt build myble2 |
| <snip> |
| Linking ~/dev/blehciproj/bin/targets/myble2/app/apps/blehci/blehci.elf |
| Target successfully built: targets/myble2 |
| $ |
| </code></pre></div> |
| |
| <p><br></p> |
| <h3 id="create-the-app-image">Create the app image</h3> |
| <p>Generate a signed application image for the <code>myble2</code> target. The version number is arbitrary.</p> |
| <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$ newt create-image myble2 1.0.0 |
| App image succesfully generated: ~/dev/blehciproj/bin/targets/myble2/app/apps/bletiny/bletiny.img |
| </code></pre></div> |
| |
| <p><br></p> |
| <h3 id="load-the-bootloader-and-the-application-image">Load the bootloader and the application image</h3> |
| <p>Make sure the USB connector is in place and the power LED on the board is lit. Use the Power ON/OFF switch to reset the board after loading the image.</p> |
| <p>Load the bootloader:</p> |
| <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$ newt load nrf52_boot |
| Loading bootloader |
| $ |
| </code></pre></div> |
| |
| <p><br> |
| Load the application image:</p> |
| <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$ newt load myble2 |
| Loading app image into slot 1 |
| $ |
| </code></pre></div> |
| |
| <p><br></p> |
| <h3 id="establish-serial-connection">Establish serial connection</h3> |
| <p>Attach a serial port to your board by connecting the USB TTL Serial Cable. This should create /dev/ttyUSB0 (or similar) on your machine. </p> |
| <p><strong>Note</strong> Certain Linux OS versions have been observed to detect the nrf52 board as a mass storage device and the console access doesn’t work properly. In that case try powering the nrf52 board from your monitor or something other than your Linux computer/laptop when you set up the serial port for HCI communication.</p> |
| <p><br></p> |
| <h3 id="open-bluetooth-monitor-btmon">Open Bluetooth monitor btmon</h3> |
| <p><code>btmon</code> is a BlueZ test tool to display all HCI commands and events in a human readable format. Start the btmon tool in a terminal window. </p> |
| <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$ sudo btmon |
| [sudo] password for admin: |
| Bluetooth monitor ver 5.37 |
| </code></pre></div> |
| |
| <p><br></p> |
| <h3 id="attach-the-blehci-device-to-bluez">Attach the blehci device to BlueZ</h3> |
| <p>In a different terminal, attach the blehci device to the BlueZ daemon (substitute the correct /dev filename for ttyUSB0).</p> |
| <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$ sudo btattach -B /dev/ttyUSB0 -S 1000000 |
| Attaching BR/EDR controller to /dev/ttyUSB0 |
| Switched line discipline from 0 to 15 |
| Device index 1 attached |
| </code></pre></div> |
| |
| <p>The baud rate used to connect to the controller may be changed by overriding the default value of 1000000 in the <code>net/nimble/transport/uart/syscfg.yml</code>. Settings in the serial transport <code>syscfg.yml</code> file can be overridden by a higher priority package such as the application. So, for example, you may set the <code>BLE_HCI_UART_BAUD</code> to a different value in <code>apps/blehci/syscfg.yml</code>.</p> |
| <p>If there is no CTS/RTS lines present in the test environment, flow control should be turned off. This can be done with |
| -N option for btattach. <strong>Note:</strong> -N option came with BlueZ ver 5.44.</p> |
| <p><br></p> |
| <h3 id="start-btmgmt-to-send-commands">Start btmgmt to send commands</h3> |
| <p>In a third terminal, start btmgmt. This tool allows you to send commands to the blehci controller. Use the index number that shows up when you <code>btattach</code> in the previous step.</p> |
| <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$ sudo btmgmt --index 1 |
| [sudo] password for admin: |
| </code></pre></div> |
| |
| <p>Set your device address (you can substitute any static random address here).</p> |
| <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>[hci1]# static-addr cc:11:11:11:11:11 |
| Static address successfully set |
| </code></pre></div> |
| |
| <p>Initialize the controller.</p> |
| <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>[hci1]# power on |
| hci1 Set Powered complete, settings: powered le static-addr |
| </code></pre></div> |
| |
| <p>Begin scanning.</p> |
| <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>[hci1]# find -l |
| Discovery started |
| hci1 type 6 discovering on |
| hci1 dev_found: 58:EF:77:C8:8D:17 type LE Random rssi -78 flags 0x0000 |
| AD flags 0x06 |
| eir_len 23 |
| <snip> |
| </code></pre></div> |
| |
| <div class="row"> |
| |
| |
| |
| |
| <ul class="nav nav-pills" style="margin-bottom: 10px"> |
| <li> |
| |
| </li> |
| <li class="pull-right"> |
| |
| </li> |
| </ul> |
| </div> |
| <footer class="row"> |
| <div class="col-xs-12"> |
| |
| <p class="copyright">Apache Mynewt (incubating) is available under Apache License, version 2.0.</p> |
| |
| </div> |
| <div class="col-xs-12"> |
| <div class="logos"> |
| <a href="https://www.apache.org/"> |
| <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> |
| </a> |
| <p> |
| Copyright © 2015-2021 The Apache Software Foundation.<br> |
| <small class="footnote"> |
| Apache Mynewt, Mynewt, Apache, the Apache feather logo, and the Apache Mynewt |
| project logo are either registered trademarks or trademarks of the Apache |
| Software Foundation in the United States and other countries. |
| </small> |
| </p> |
| <a href=""> |
| <img src="https://www.countit.com/images/add_to_slack.png" alt="Slack Icon" title="Join our Slack Community" /> |
| </a> |
| </div> |
| </div> |
| <a href="https://www.apache.org/licenses/"> |
| <button class="button-footer-asf"> |
| License |
| </button> |
| </a> |
| <a href="https://www.apache.org/foundation/sponsorship.html"> |
| <button class="button-footer-asf"> |
| Sponsorship |
| </button> |
| </a> |
| <a href="https://www.apache.org/foundation/thanks.html"> |
| <button class="button-footer-asf"> |
| Thanks |
| </button> |
| </a> |
| <a href="https://www.apache.org/security/"> |
| <button class="button-footer-asf"> |
| Security |
| </button> |
| </a> |
| <a href="https://apache.org/events/current-event"> |
| <button class="button-footer-asf"> |
| ASF Events |
| </button> |
| </a> |
| </footer> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| <script src="../../../js/jquery-1.10.2.min.js"></script> |
| <script src="../../../js/bootstrap-3.0.3.min.js"></script> |
| <script src="../../../js/highlight.pack.js"></script> |
| <script src="../../../js/base.js"></script> |
| <script src="../../../js/custom.js"></script> |
| <script src="search/main.js"></script> |
| |
| </body> |
| </html> |
