| |
| |
| <!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"> |
| |
| |
| |
| |
| <title>newtmgr conn — Apache Mynewt latest documentation</title> |
| |
| |
| |
| |
| <link rel="shortcut icon" href="../../_static/mynewt-logo-only-newt32x32.png"/> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> |
| |
| |
| <link rel="stylesheet" href="../../_static/css/sphinx_theme.css" type="text/css" /> |
| |
| <link rel="stylesheet" href="../../_static/css/bootstrap-3.0.3.min.css" type="text/css" /> |
| |
| <link rel="stylesheet" href="../../_static/css/v2.css" type="text/css" /> |
| |
| <link rel="stylesheet" href="../../_static/css/custom.css" type="text/css" /> |
| |
| <link rel="stylesheet" href="../../_static/css/restructuredtext.css" type="text/css" /> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../_static/css/overrides.css" type="text/css" /> |
| <link rel="index" title="Index" |
| href="../../genindex.html"/> |
| <link rel="search" title="Search" href="../../search.html"/> |
| <link rel="top" title="Apache Mynewt latest documentation" href="../../index.html"/> |
| <link rel="up" title="Command List" href="index.html"/> |
| <link rel="next" title="newtmgr crash" href="newtmgr_crash.html"/> |
| <link rel="prev" title="newtmgr config" href="newtmgr_config.html"/> |
| |
| |
| <script src="../../_static/js/modernizr.min.js"></script> |
| |
| |
| <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="not-front page-documentation" role="document" > |
| <div id="wrapper"> |
| <div class="container"> |
| <div id="banner" class="row v2-main-banner"> |
| <a class="logo-cell" href="/"> |
| <img class="logo" src="../../_static/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> |
| |
| <header> |
| <nav id="navbar" class="navbar navbar-inverse" 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> |
| <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> |
| <a href="/about/">About</a> |
| </li> |
| <li> |
| <a href="/talks/">Talks</a> |
| </li> |
| <li class="active"> |
| <a href="/documentation/">Documentation</a> |
| </li> |
| <li> |
| <a href="/download/">Download</a> |
| </li> |
| <li> |
| <a href="/community/">Community</a> |
| </li> |
| <li> |
| <a href="/events/">Events</a> |
| </li> |
| </ul> |
| |
| <!-- Search, Navigation and Repo links --> |
| <ul class="nav navbar-nav navbar-right"> |
| |
| </ul> |
| </div> |
| </div> |
| </nav> |
| </header> |
| <!-- STARTS MAIN CONTENT --> |
| <div id="main-content"> |
| |
| |
| |
| |
| |
| |
| <div id="breadcrumb"> |
| <div class="container"> |
| <a href="/documentation/">Docs</a> / |
| |
| <a href="../index.html">Newt Manager Guide</a> / |
| |
| <a href="index.html">Command List</a> / |
| |
| newtmgr conn |
| |
| <div class="sourcelink"> |
| <a href="https://github.com/apache/mynewt-newtmgr/edit/master/docs/command_list/newtmgr_conn.rst" class="icon icon-github" |
| rel="nofollow"> Edit on GitHub</a> |
| </div> |
| </div> |
| </div> |
| <!-- STARTS CONTAINER --> |
| <div class="container"> |
| <!-- STARTS .content --> |
| <div id="content" class="row"> |
| |
| <!-- STARTS .container-sidebar --> |
| <div class="container-sidebar col-xs-12 col-sm-3"> |
| <div id="docSidebar" class="sticky-container"> |
| <div role="search" class="sphinx-search"> |
| <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search documentation" class="search-documentation" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| <!-- Note: only works when deployed --> |
| <select class="form-control" onchange="if (this.value) window.location.href=this.value"> |
| <option value="/latest" selected> |
| Version: latest |
| </option> |
| <option value="/v1_11_0" > |
| Version: 1.11.0 |
| </option> |
| <option value="/v1_10_0" selected="selected" > |
| 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" > |
| Version: 0.9.0 |
| </option> |
| </select> |
| <div class="region region-sidebar"> |
| <div class="docs-menu"> |
| |
| |
| |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../../index.html">Introduction</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../get_started/index.html">Setup & Get Started</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../tutorials/tutorials.html">Tutorials</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../external_links.html">Third-party Resources</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../os/os_user_guide.html">OS User Guide</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../network/index.html">BLE User Guide</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../newt/index.html">Newt Tool Guide</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="../index.html">Newt Manager Guide</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="reference internal" href="index.html">Command List</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="newtmgr_config.html">newtmgr config</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">newtmgr conn</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="newtmgr_crash.html">newtmgr crash</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="newtmgr_datetime.html">newtmgr datetime</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="newtmgr_echo.html">newtmgr echo</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="newtmgr_fs.html">newtmgr fs</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="newtmgr_image.html">newtmgr image</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="newtmgr_logs.html">newtmgr log</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="newtmgr_mpstats.html">newtmgr mpstat</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="newtmgr_reset.html">newtmgr reset</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="newtmgr_run.html">newtmgr run</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="newtmgr_stat.html">newtmgr stat</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="newtmgr_taskstats.html">newtmgr taskstat</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../install/index.html">Install</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../mynewt_faq/index.html">Mynewt FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../misc/index.html">Appendix</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </div> |
| <!-- ENDS STICKY CONTAINER --> |
| </div> |
| <!-- ENDS .container-sidebar --> |
| |
| <div class="col-xs-12 col-sm-9"> |
| |
| <div class="alert alert-warning"> |
| <p> |
| Version 1.10.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> |
| |
| |
| |
| <div class=""> |
| <div class="rst-content"> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="newtmgr-conn"> |
| <h1>newtmgr conn<a class="headerlink" href="#newtmgr-conn" title="Permalink to this headline">¶</a></h1> |
| <p>Manage newtmgr connection profiles.</p> |
| <div class="contents local topic" id="contents"> |
| <ul class="simple"> |
| <li><p><a class="reference internal" href="#usage" id="id1">Usage:</a></p></li> |
| <li><p><a class="reference internal" href="#global-flags" id="id2">Global Flags:</a></p></li> |
| <li><p><a class="reference internal" href="#description" id="id3">Description</a></p> |
| <ul> |
| <li><p><a class="reference internal" href="#add-sub-command" id="id4">Add Sub-Command</a></p></li> |
| <li><p><a class="reference internal" href="#delete-sub-command" id="id5">Delete Sub-Command</a></p></li> |
| <li><p><a class="reference internal" href="#show-sub-command" id="id6">Show Sub-Command</a></p></li> |
| </ul> |
| </li> |
| <li><p><a class="reference internal" href="#examples" id="id7">Examples</a></p></li> |
| </ul> |
| </div> |
| <div class="section" id="usage"> |
| <h2><a class="toc-backref" href="#id1">Usage:</a><a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> |
| <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">newtmgr conn [command] [flags]</span> |
| </pre></div> |
| </div> |
| </div> |
| <div class="section" id="global-flags"> |
| <h2><a class="toc-backref" href="#id2">Global Flags:</a><a class="headerlink" href="#global-flags" title="Permalink to this headline">¶</a></h2> |
| <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">-c, --conn string connection profile to use</span> |
| <span class="go">-l, --loglevel string log level to use (default "info")</span> |
| <span class="go"> --name string name of target BLE device; overrides profile setting</span> |
| <span class="go">-t, --timeout float timeout in seconds (partial seconds allowed) (default 10)</span> |
| <span class="go">-r, --tries int total number of tries in case of timeout (default 1)</span> |
| </pre></div> |
| </div> |
| </div> |
| <div class="section" id="description"> |
| <h2><a class="toc-backref" href="#id3">Description</a><a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2> |
| <p>The conn command provides subcommands to add, delete, and view connection profiles. A connection profile specifies |
| information on how to connect and communicate with a remote device. Newtmgr commands use the information from a |
| connection profile to send newtmgr requests to remote devices.</p> |
| <div class="section" id="add-sub-command"> |
| <h3><a class="toc-backref" href="#id4">Add Sub-Command</a><a class="headerlink" href="#add-sub-command" title="Permalink to this headline">¶</a></h3> |
| <p>The <code class="docutils literal notranslate"><span class="pre">newtmgr</span> <span class="pre">conn</span> <span class="pre">add</span> <span class="pre"><conn_profile></span> <span class="pre"><var-name=value</span> <span class="pre">...></span></code> command creates a connection profile named |
| <code class="docutils literal notranslate"><span class="pre">conn_profile</span></code>. The command requires the <code class="docutils literal notranslate"><span class="pre">conn_profile</span></code> name and a list of, space separated, |
| var-name=value pairs.</p> |
| <p>The var-names are: <code class="docutils literal notranslate"><span class="pre">type</span></code>, and <code class="docutils literal notranslate"><span class="pre">connstring</span></code>. The valid values for each var-name parameter are:</p> |
| <ul> |
| <li><p><code class="docutils literal notranslate"><span class="pre">type</span></code>: |
| The connection type. Valid values are:</p> |
| <ul class="simple"> |
| <li><p><strong>serial</strong>: Newtmgr protocol over a serial connection.</p></li> |
| <li><p><strong>oic_serial</strong>: OIC protocol over a serial connection.</p></li> |
| <li><p><strong>udp</strong>:newtmgr protocol over UDP.</p></li> |
| <li><p><strong>oic_udp</strong>: OIC protocol over UDP.</p></li> |
| <li><p><strong>ble</strong> newtmgr protocol over BLE. This type uses native OS BLE support</p></li> |
| <li><p><strong>oic_ble</strong>: OIC protocol over BLE. This type uses native OS BLE support.</p></li> |
| <li><p><strong>bhd</strong>: newtmgr protocol over BLE. This type uses the blehostd implemenation.</p></li> |
| <li><p><strong>oic_bhd</strong>: OIC protocol over BLE. This type uses the blehostd implementation.</p></li> |
| </ul> |
| <p><strong>Note:</strong> newtmgr does not support BLE on Windows.</p> |
| </li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">connstring</span></code>: |
| The physical or virtual address for the connection. The format of the <code class="docutils literal notranslate"><span class="pre">connstring</span></code> value depends |
| on the connection <code class="docutils literal notranslate"><span class="pre">type</span></code> value as follows:</p> |
| <ul> |
| <li><p><strong>serial</strong> and <strong>oic_serial</strong>: A quoted string with two, comma separated, <code class="docutils literal notranslate"><span class="pre">attribute=value</span></code> pairs. |
| The attribute names and value format for each attribute are:</p> |
| <ul class="simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">dev</span></code>: (Required) The name of the serial port to use. For example: <strong>/dev/ttyUSB0</strong> on a Linux platform or |
| <strong>COM1</strong> on a Windows platform .</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">baud</span></code>: (Optional) A number that specifies the buad rate for the connection. Defaults to <strong>115200</strong> if the |
| attribute is not specified.</p></li> |
| </ul> |
| <p>Example: <code class="docutils literal notranslate"><span class="pre">connstring="dev=/dev/ttyUSB0,baud=9600"</span></code> |
| <strong>Note:</strong> The 1.0 format, which only requires a serial port name, is still supported. For example, <code class="docutils literal notranslate"><span class="pre">connstring=/dev/ttyUSB0</span></code>.</p> |
| </li> |
| <li><p><strong>udp</strong> and <strong>oic_udp</strong>: The peer ip address and port number that the newtmgr or oicmgr on the remote device is |
| listening on. It must be of the form: <strong>[<ip-address>]:<port-number></strong>.</p></li> |
| <li><p><strong>ble</strong> and <strong>oic_ble</strong>: The format is a quoted string of, comma separated, <code class="docutils literal notranslate"><span class="pre">attribute=value</span></code> pairs. The attribute |
| names and the value for each attribute are:</p> |
| <ul> |
| <li><p><code class="docutils literal notranslate"><span class="pre">peer_name</span></code>: A string that specifies the name the peer BLE device advertises. <strong>Note</strong>: If this attribute is |
| specified, you do not need to specify a value for the <code class="docutils literal notranslate"><span class="pre">peer_id</span></code> attribute.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">peer_id</span></code>: The peer BLE device address or UUID. The format depends on the OS that the newtmgr tool is running on:</p> |
| <blockquote> |
| <div><p><strong>Linux</strong>: 6 byte BLE address. Each byte must be a hexidecimal number and separated by a colon.</p> |
| <p><strong>MacOS</strong>: 128 bit UUID.</p> |
| </div></blockquote> |
| <p><strong>Note</strong>: This value is only used when a peer name is not specified for the connection profile or with the |
| <code class="docutils literal notranslate"><span class="pre">--name</span></code> flag option.</p> |
| </li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">ctlr_name</span></code>: (Optional) Controller name. This value depends on the OS that the newtmgr tool is running on.</p></li> |
| </ul> |
| <p><strong>Notes</strong>:</p> |
| <ul class="simple"> |
| <li><p>You must specify <code class="docutils literal notranslate"><span class="pre">connstring="</span> <span class="pre">"</span></code> if you do not specify any attribute values.</p></li> |
| <li><p>You can use the <code class="docutils literal notranslate"><span class="pre">--name</span></code> flag to specify a device name when you issue a newtmgr command that communicates with |
| a BLE device. You can use this flag to override or in lieu of specifying a <code class="docutils literal notranslate"><span class="pre">peer_name</span></code> or <code class="docutils literal notranslate"><span class="pre">peer_id</span></code> attribute |
| in the connection profile.</p></li> |
| </ul> |
| </li> |
| <li><p><strong>bhd</strong> and <strong>oic_bhd</strong>: The format is a quoted string of, comma separated, <code class="docutils literal notranslate"><span class="pre">attribute=value</span></code> pairs. The |
| attribute names and the value format for each attribute are:</p> |
| <ul> |
| <li><p><code class="docutils literal notranslate"><span class="pre">peer_name</span></code>: A string that specifies the name the peer BLE device advertises. |
| <strong>Note</strong>: If this attribute is specified, you do not need to specify values for the <code class="docutils literal notranslate"><span class="pre">peer_addr</span></code> and |
| <code class="docutils literal notranslate"><span class="pre">peer_addr_type</span></code> attributes.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">peer_addr</span></code>: A 6 byte peer BLE device address. Each byte must be a hexidecimal number and separated by a colon. |
| You must also specify a <code class="docutils literal notranslate"><span class="pre">peer_addr_type</span></code> value for the device address. |
| <strong>Note:</strong> This value is only used when a peer name is not specified for the connection profile or with the |
| <code class="docutils literal notranslate"><span class="pre">--name</span></code> flag option.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">peer_addr_type</span></code>: The peer address type. Valid values are:</p> |
| <ul class="simple"> |
| <li><p><strong>public</strong>: Public address assigned by the manufacturer.</p></li> |
| <li><p><strong>random</strong>: Static random address.</p></li> |
| <li><p><strong>rpa_pub</strong>: Resolvable Private Address with public identity address.</p></li> |
| <li><p><strong>rpa_rnd</strong>: Resolvable Private Address with static random identity address.</p></li> |
| </ul> |
| <p><strong>Note:</strong> This value is only used when a peer name is not specified for the connection profile or with the |
| <code class="docutils literal notranslate"><span class="pre">--name</span></code> flag option.</p> |
| </li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">own_addr_type</span></code>: (Optional) The address type of the BLE controller for the host that the newtmgr tool is |
| running on. See the <code class="docutils literal notranslate"><span class="pre">peer_addr_type</span></code> attribute for valid values. Defaults to <strong>random</strong>.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">ctlr_path</span></code>: The path of the port that is used to connect the BLE controller to the host that the newtmgr tool is |
| running on.</p></li> |
| </ul> |
| </li> |
| </ul> |
| <p><strong>Note</strong>: You can use the <code class="docutils literal notranslate"><span class="pre">--name</span></code> flag to specify a device name when you issue a newtmgr command that communicates |
| with a BLE device. You can use this flag to override or in lieu of specifying a <code class="docutils literal notranslate"><span class="pre">peer_name</span></code> or <code class="docutils literal notranslate"><span class="pre">peer_addr</span></code> |
| attribute in the connection profile.</p> |
| </li> |
| </ul> |
| </div> |
| <div class="section" id="delete-sub-command"> |
| <h3><a class="toc-backref" href="#id5">Delete Sub-Command</a><a class="headerlink" href="#delete-sub-command" title="Permalink to this headline">¶</a></h3> |
| <p>The <code class="docutils literal notranslate"><span class="pre">newtmgr</span> <span class="pre">conn</span> <span class="pre">delete</span> <span class="pre"><conn_profile></span></code> command deletes the <code class="docutils literal notranslate"><span class="pre">conn_profile</span></code> connection profile.</p> |
| </div> |
| <div class="section" id="show-sub-command"> |
| <h3><a class="toc-backref" href="#id6">Show Sub-Command</a><a class="headerlink" href="#show-sub-command" title="Permalink to this headline">¶</a></h3> |
| <p>The <code class="docutils literal notranslate"><span class="pre">newtmgr</span> <span class="pre">conn</span> <span class="pre">show</span> <span class="pre">[conn_profile]</span></code> command shows the information for the <code class="docutils literal notranslate"><span class="pre">conn_profile</span></code> connection profile. |
| It shows information for all the connection profiles if <code class="docutils literal notranslate"><span class="pre">conn_profile</span></code> is not specified.</p> |
| </div> |
| </div> |
| <div class="section" id="examples"> |
| <h2><a class="toc-backref" href="#id7">Examples</a><a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2> |
| <table class="docutils align-default"> |
| <colgroup> |
| <col style="width: 4%" /> |
| <col style="width: 29%" /> |
| <col style="width: 67%" /> |
| </colgroup> |
| <thead> |
| <tr class="row-odd"><th class="head"><p>Sub-command</p></th> |
| <th class="head"><p>Usage</p></th> |
| <th class="head"><p>Explanation</p></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="row-even"><td><p>add</p></td> |
| <td><p><code class="docutils literal notranslate"><span class="pre">newtmgr</span> <span class="pre">conn</span> <span class="pre">add</span> <span class="pre">myserial02</span> <span class="pre">type=oic_serial</span> <span class="pre">connstring=/dev/ttys002</span></code></p></td> |
| <td><p>Creates a connection profile, named <code class="docutils literal notranslate"><span class="pre">myserial02</span></code>, to communicate over a serial connection at 115200 baud rate with the oicmgr on a device that is connected to the host on port /dev/ttys002.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p>add</p></td> |
| <td><p><code class="docutils literal notranslate"><span class="pre">newtmgr</span> <span class="pre">conn</span> <span class="pre">add</span> <span class="pre">myserial03</span> <span class="pre">type=serial</span> <span class="pre">connstring="dev=/dev/ttys003,</span> <span class="pre">baud=57600"</span></code></p></td> |
| <td><p>Creates a connection profile, named <code class="docutils literal notranslate"><span class="pre">myserial03</span></code>, to communicate over a serial connection at 57600 baud rate with the newtmgr on a device that is connected to the host on port /dev/ttys003.</p></td> |
| </tr> |
| <tr class="row-even"><td><p>add</p></td> |
| <td><p><code class="docutils literal notranslate"><span class="pre">newtmgr</span> <span class="pre">conn</span> <span class="pre">add</span> <span class="pre">myudp5683</span> <span class="pre">type=oic_udpconnstring=[127.0.0.1]:5683</span></code></p></td> |
| <td><p>Creates a connection profile, named <code class="docutils literal notranslate"><span class="pre">myudp5683</span></code>, to communicate over UDP with the oicmgr on a device listening on localhost and port 5683.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p>add</p></td> |
| <td><p><code class="docutils literal notranslate"><span class="pre">newtmgr</span> <span class="pre">conn</span> <span class="pre">add</span> <span class="pre">mybleprph</span> <span class="pre">type=ble</span> <span class="pre">connstring="peer_name=nimble-bleprph"</span></code></p></td> |
| <td><p>Creates a connection profile, named <code class="docutils literal notranslate"><span class="pre">mybleprph</span></code>, to communicate over BLE, using the native OS BLE support, with the newtmgr on a device named <code class="docutils literal notranslate"><span class="pre">nimble-bleprph</span></code>.</p></td> |
| </tr> |
| <tr class="row-even"><td><p>add</p></td> |
| <td><p><code class="docutils literal notranslate"><span class="pre">newtmgr</span> <span class="pre">conn</span> <span class="pre">add</span> <span class="pre">mybletype=ble</span> <span class="pre">connstring="</span> <span class="pre">"</span></code></p></td> |
| <td><p>Creates a connection profile, named <code class="docutils literal notranslate"><span class="pre">myble</span></code>, to communicate over BLE, using the native OS BLE support, with the newtmgr on a device. You must use the <code class="docutils literal notranslate"><span class="pre">--name</span></code> flag to specify the device name when you issue a newtmgr command that communicates with the device.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p>add</p></td> |
| <td><p><code class="docutils literal notranslate"><span class="pre">newtmgr</span> <span class="pre">conn</span> <span class="pre">add</span> <span class="pre">myblehostd</span> <span class="pre">type=oic_bhd</span> <span class="pre">connstring="peer_name=nimble-bleprph,ctlr_path=/dev/cu.usbmodem14221"</span></code></p></td> |
| <td><p>Creates a connection profile, named <code class="docutils literal notranslate"><span class="pre">myblehostd</span></code>, to communicate over BLE, using the blehostd implementation, with the oicmgr on a device named <code class="docutils literal notranslate"><span class="pre">nimble-bleprph</span></code>. The BLE controller is connected to the host on USB port /dev/cu.usbmodem14211 and uses static random address.</p></td> |
| </tr> |
| <tr class="row-even"><td><p>delete</p></td> |
| <td><p><code class="docutils literal notranslate"><span class="pre">newtmgr</span> <span class="pre">conn</span> <span class="pre">delete</span> <span class="pre">myserial02</span></code></p></td> |
| <td><p>Deletes the connection profile named <code class="docutils literal notranslate"><span class="pre">myserial02</span></code></p></td> |
| </tr> |
| <tr class="row-odd"><td><p>delete</p></td> |
| <td><p><code class="docutils literal notranslate"><span class="pre">newtmgr</span> <span class="pre">conn</span> <span class="pre">delete</span> <span class="pre">myserial02</span></code></p></td> |
| <td><p>Deletes the connection profile named <code class="docutils literal notranslate"><span class="pre">myserial02</span></code></p></td> |
| </tr> |
| <tr class="row-even"><td><p>show</p></td> |
| <td><p><code class="docutils literal notranslate"><span class="pre">newtmgr</span> <span class="pre">conn</span> <span class="pre">show</span> <span class="pre">myserial01</span></code></p></td> |
| <td><p>Displays the information for the <code class="docutils literal notranslate"><span class="pre">myserial01</span></code> connection profile.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p>show</p></td> |
| <td><p><code class="docutils literal notranslate"><span class="pre">newtmgr</span> <span class="pre">conn</span> <span class="pre">show</span></code></p></td> |
| <td><p>Displays the information for all connection profiles.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| |
| |
| </div> |
| </div> |
| |
| <div class="rst-footer-buttons row" role="navigation" aria-label="footer navigation"> |
| |
| <a href="newtmgr_crash.html" class="btn btn-neutral float-right" title="newtmgr crash" accesskey="n">Next: newtmgr crash <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="newtmgr_config.html" class="btn btn-neutral" title="newtmgr config" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous: newtmgr config</a> |
| |
| </div> |
| |
| </div> |
| </div> |
| </div> |
| <!-- ENDS CONTENT SECTION --> |
| </div> |
| <!-- ENDS .content --> |
| </div> |
| </div> |
| <footer> |
| <div class="container"> |
| <div class="row"> |
| <div class="col-xs-12"> |
| |
| <p class="copyright">Apache Mynewt is available under Apache License, version 2.0.</p> |
| |
| </div> |
| <div class="col-xs-12"> |
| <div class="logos"> |
| <img src="../../_static/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> |
| <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> |
| <a href=""> |
| <img src="../../_static/img/add_to_slack.png" alt="Slack Icon" title="Join our Slack Community" /> |
| </a> |
| </div> |
| </div> |
| </div> |
| </div> |
| </footer> |
| </div> |
| <!-- ENDS #wrapper --> |
| |
| |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT:'../../', |
| VERSION:'latest', |
| COLLAPSE_INDEX:false, |
| FILE_SUFFIX:'.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '.txt', |
| LINK_SUFFIX: '.html' |
| }; |
| </script> |
| <script type="text/javascript" src="../../_static/jquery.js"></script> |
| <script type="text/javascript" src="../../_static/underscore.js"></script> |
| <script type="text/javascript" src="../../_static/doctools.js"></script> |
| <script type="text/javascript" src="../../_static/js/bootstrap-3.0.3.min.js"></script> |
| <script type="text/javascript" src="../../_static/js/affix.js"></script> |
| <script type="text/javascript" src="../../_static/js/main.js"></script> |
| |
| |
| |
| </body> |
| </html> |