| <!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>Enable remote comms on sim device - 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="Enable remote comms on sim device"> |
| |
| |
| <div class="container"> |
| <div class="row v2-main-banner"> |
| <a class="logo-cell" href="/"> |
| <img class="logo" src="/img/logo.png"> |
| </a> |
| <div class="tagline-cell"> |
| <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> |
| </div> |
| <div class="news-cell"> |
| <div class="well"> |
| <h4>Latest News:</h4> <a href="/download">Apache Mynewt 1.11.0, Apache NimBLE 1.6.0 </a> released (September 7, 2023) |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| <nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" role="navigation"> |
| <div class="container"> |
| <!-- Collapsed navigation --> |
| <div class="navbar-header"> |
| <!-- Expander button --> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| </div> |
| |
| <!-- Expanded navigation --> |
| <div class="navbar-collapse collapse"> |
| <!-- Main navigation --> |
| <ul class="nav navbar-nav navbar-right"> |
| <li |
| class="" |
| > |
| <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> |
| </li> |
| <li |
| class="important" |
| > |
| <a href="/quick-start/">Quick Start</a> |
| </li> |
| <li |
| class="" |
| > |
| <a href="/about/">About</a> |
| </li> |
| <li |
| class="" |
| > |
| <a href="/talks/">Talks</a> |
| </li> |
| <li |
| class="active" |
| > |
| <a href="/documentation/">Documentation</a> |
| </li> |
| <li |
| class="" |
| > |
| <a href="/download/">Download</a> |
| </li> |
| <li |
| class="" |
| > |
| <a href="/community/">Community</a> |
| </li> |
| <li |
| class="" |
| > |
| <a href="/events/">Events</a> |
| </li> |
| </ul> |
| |
| </div> |
| </div> |
| </nav> |
| |
| |
| |
| <div class="container"> |
| |
| <div class="row"> |
| <div class="col-md-3 v2-sidebar sidebar-container"><div id="docSidebar" class="hidden-print" role="complementary"> |
| <div class="top"> |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get"> |
| <div class="form-group"> |
| <input type="text" name="q" class="form-control" placeholder="Search documentation" /> |
| </div> |
| </form> |
| </div> |
| </div> |
| <ul class="toc-nav"> |
| <li class="doc-version"><select class="form-control" onchange="if (this.value) window.location.href=this.value"> |
| <option value="/latest"> |
| Version: master |
| </option> |
| <option value="/v1_11_0/" > |
| Version: 1.11.0 |
| </option> |
| <option value="/v1_10_0/" > |
| Version: 1.10.0 |
| </option> |
| <option value="/v1_9_0/" > |
| Version: 1.9.0 |
| </option> |
| <option value="/v1_8_0/" > |
| Version: 1.8.0 |
| </option> |
| <option value="/v1_7_0/" > |
| Version: 1.7.0 |
| </option> |
| <option value="/v1_6_0/" > |
| Version: 1.6.0 |
| </option> |
| <option value="/v1_5_0/" > |
| Version: 1.5.0 |
| </option> |
| <option value="/v1_4_0/" > |
| Version: 1.4.0 |
| </option> |
| <option value="/v1_3_0/os/introduction" > |
| Version: 1.3.0 |
| </option> |
| <option value="/v1_2_0/os/introduction" > |
| Version: 1.2.0 |
| </option> |
| <option value="/v1_1_0/os/introduction" > |
| Version: 1.1.0 |
| </option> |
| <option value="/v1_0_0/os/introduction" > |
| Version: 1.0.0 |
| </option> |
| <option value="/v0_9_0/os/introduction" selected="selected" > |
| Version: 0.9.0 |
| </option> |
| </select></li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../../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=" |
| ../arduino_zero/ |
| ">Project Blinky</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li ><a href="../repo/add_repos/">Work with repositories</a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../unit_test/">Write a Test Suite for a Package</a> |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../air_quality_sensor/">Air-quality Sensor project</a> |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../event_queue/">Add task to manage multiple events</a> |
| </li> |
| |
| |
| |
| |
| |
| <li class="active"> |
| <a href="./">Enable remote comms on sim device</a> |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../project-target-slinky/">Enable remote comms on STM32 board</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 > |
| <a href="../ibeacon/">BLE iBeacon</a> |
| </li> |
| |
| |
| |
| |
| |
| <li > |
| <a href="../blehci_project/">BLE HCI interface</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/how_to_edit_docs/ |
| ">Appendix</a> |
| |
| |
| </li> |
| |
| |
| |
| </ul> |
| </div></div> |
| |
| <div class="col-md-9" role="main"> |
| <div class="doc-header"> |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="/documentation/">Docs</a></li> |
| |
| |
| |
| <li>» <a href="os/tutorials/tutorials/">Tutorials</a></li> |
| |
| |
| |
| <li>» <a href="os/introduction/">Mynewt Documentation</a></li> |
| |
| |
| |
| <li>» Enable remote comms on sim device</li> |
| |
| |
| |
| </ul> |
| </div> |
| </div> |
| |
| |
| |
| |
| <div class="alert alert-warning"> |
| <p> |
| Version 0.9.0 is not the most recent version of the Apache Mynewt |
| documentation. Click <a href="/latest">here</a> to read the latest |
| version. |
| </p> |
| </div> |
| |
| |
| |
| |
| |
| <h2 id="project-sim-slinky">Project Sim Slinky</h2> |
| <h3 id="objective">Objective</h3> |
| <p>The goal of the project is to enable and demonstrate remote communications with the Mynewt OS via newt manager (newtmgr). We will do this through building a project with Mynewt called Slinky that runs via the native platform. </p> |
| <h3 id="what-you-need">What you need</h3> |
| <p>1.Personal Computer</p> |
| <p>The instructions assume the user is using a Bourne-compatible shell (e.g. bash or zsh) on your computer. The given instructions have been tested with the following releases of operating systems:</p> |
| <ul> |
| <li>Mac: OS X Yosemite Version 10.10.5</li> |
| </ul> |
| <h3 id="overview-of-steps">Overview of steps</h3> |
| <ul> |
| <li>Install dependencies</li> |
| <li>Define a target using the newt tool</li> |
| <li>Build executables for the targets using the newt tool</li> |
| <li>Set up serial connection with the targets </li> |
| <li>Create a connection profile using the newtmgr tool</li> |
| <li>Use the newtmgr tool to communicate with the targets</li> |
| </ul> |
| <h3 id="installing-newt">Installing newt</h3> |
| <p>If you have not already installed <code>newt</code> see the |
| <a href="../get_started/get_started/">newt installation instructions</a> and ensure newt is installed an in your path.</p> |
| <h3 id="installing-newtmgr">Installing newtmgr</h3> |
| <p>If you have not already installed <code>newtmgr</code> see the |
| <a href="../../newtmgr/installing/">newtmgr installation instructions</a> and ensure newtmgr is installed an in your path.</p> |
| <h3 id="creating-a-new-project">Creating a new project</h3> |
| <p>Instructions for creating a project are located in the <a href="../get_started/project_create/">Basic Setup</a> section of the <a href="../introduction/">Mynewt Documentation</a></p> |
| <p>We will list only the steps here for brevity. We will name the project |
| <code>slinky</code>.</p> |
| <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> $ newt new slinky |
| Downloading project skeleton from apache/incubator-mynewt-blinky... |
| ... |
| Installing skeleton in slink... |
| Project slink successfully created |
| $ cd slinky |
| $ newt install -v |
| Downloading repository description for apache-mynewt-core... success! |
| ... |
| Repos successfully installed |
| </code></pre></div> |
| |
| <h3 id="setting-up-your-target-build">Setting up your target build</h3> |
| <p>Create a target for <code>slinky</code> using the native bsp. We will list only the steps and suppress the tool output here for brevity.</p> |
| <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> $ newt target create sim_slinky |
| $ newt target set sim_slinky bsp=@apache-mynewt-core/hw/bsp/native |
| $ newt target set sim_slinky build_profile=debug |
| $ newt target set sim_slinky app=@apache-mynewt-core/apps/slinky |
| </code></pre></div> |
| |
| <h3 id="building-your-target">Building Your target</h3> |
| <p>To build your target, use <code>newt build</code>. When complete, an executable file |
| is created.</p> |
| <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> $ newt build sim_slinky |
| Compiling main.c |
| ... |
| Linking slinky.elf |
| App successfully built: ~/dev/slinky/bin/sim_slinky/apps/slinky/slinky.elf |
| </code></pre></div> |
| |
| <h3 id="run-the-target">Run the target</h3> |
| <p>Run the executable you have build for the simulated environment. The serial port name on which the simulated target is connected is shown in the output |
| when mynewt slinky starts.</p> |
| <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> $ ~/dev/slinky/bin/sim_slinky/apps/slinky/slinky.elf |
| uart0 at /dev/ttys005 |
| </code></pre></div> |
| |
| <p><br></p> |
| <p>In this example, the slinky app opened up a com port <code>/dev/ttys005</code> |
| for communications with newtmgr. </p> |
| <p><strong>NOTE:</strong> This application will block. You will need to open a new console (or execute this in another console) to continue the tutorial.*</p> |
| <p><br></p> |
| <h3 id="setting-up-a-connection-profile">Setting up a connection profile</h3> |
| <p>You will now set up a connection profile using <code>newtmgr</code> for the serial port connection and start communicating with the simulated remote device.</p> |
| <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> $ newtmgr conn add sim1 type=serial connstring=/dev/ttys005 |
| Connection profile sim1 successfully added |
| $ newtmgr conn show |
| Connection profiles: |
| sim1: type=serial, connstring='/dev/ttys007' |
| </code></pre></div> |
| |
| <h3 id="executing-newtmgr-commands-with-the-target">Executing newtmgr commands with the target</h3> |
| <p>You can now use connection profile <code>sim1</code> to talk to the running sim_blinky. |
| As an example, we will query the running mynewt OS for the usage of its |
| memory pools. </p> |
| <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> $ newtmgr -c sim1 mpstats |
| Return Code = 0 |
| nffs_cache_inode_pool (blksize=36 nblocks=4 nfree=4) |
| nffs_cache_block_pool (blksize=32 nblocks=64 nfree=64) |
| nffs_dir_pool (blksize=8 nblocks=4 nfree=4) |
| default_mbuf_data (blksize=256 nblocks=10 nfree=8) |
| nffs_file_pool (blksize=12 nblocks=4 nfree=4) |
| nffs_inode_entry_pool (blksize=24 nblocks=100 nfree=98) |
| nffs_block_entry_pool (blksize=12 nblocks=100 nfree=100) |
| </code></pre></div> |
| |
| <p>As a test command, you can send an arbitrary string to the target and it |
| will echo that string back in a response to newtmgr.</p> |
| <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> $ newtmgr -c sim1 echo "Hello Mynewt" |
| {"r": "Hello Mynewt"} |
| </code></pre></div> |
| |
| <p>The response comes back as a json string.</p> |
| <p>In addition to these, you can also examine running tasks, statistics, |
| logs, image status (not on sim), and configuration.</p> |
| |
| <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> |
