Google Git
Sign in
apache / mynewt-site / 8528acea806ecedcedbaec90568a1524b3ae623d / . / v0_9_0 / newtmgr / overview / index.html
blob: 0b9e5e4021d8db30fe42ab1ac1dff108e2cd1c13 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- This is broken by doc revisioning.
-->
<link rel="shortcut icon" href="../../img/favicon.ico">
<title>toc - 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="toc">
<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="../../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="
../../network/ble/ble_intro/
">BLE User Guide</a>
</li>
<li ><a href="../../newt/newt_intro/">Newt Tool Guide</a>
</li>
<li class="active"><a href="./">Newt Manager Guide</a>
<ul>
<li >
<a href="../installing/">Install</a>
</li>
</ul>
</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>&raquo; Newt Manager Guide</li>
<li>&raquo; <a href="os/introduction/">Mynewt Documentation</a></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="newt-manager">Newt Manager</h2>
<p>Newt Manager (newtmgr) is the application tool that enables a user to communicate with and manage remote instances of Mynewt OS. </p>
<h2 id="description">Description</h2>
<h2 id="command-list">Command List</h2>
<h3 id="available-high-level-commands">Available high-level commands</h3>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> help Lists commands and flags available
conn Manage newtmgr connection profiles
echo Send data to remote endpoint using newtmgr, and receive data back
image Manage images on remote instance
stat Read statistics from a remote endpoint
taskstats Read statistics from a remote endpoint
mpstats Read statistics from a remote endpoint
config Read or write config value on target
</code></pre></div>
<h3 id="available-flags">Available Flags</h3>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> -c, --connection string connection profile to use.
-l, --loglevel string log level to use (default WARN.)
</code></pre></div>
<p>Examples</p>
<table>
<thead>
<tr>
<th>Sub-command</th>
<th>Usage</th>
<th>Explanation</th>
</tr>
</thead>
<tbody>
<tr>
<td>newtmgr -caditi03 taskstats</td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="help"><em>help</em></h3>
<h4 id="usage">Usage:</h4>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> newtmgr help [input1]
</code></pre></div>
<p>You can also use "newtmgr [command] --help" to display the help text for a newtmgr command.</p>
<p>Flags:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> -c, --connection string connection profile to use.
-l, --loglevel string log level to use (default WARN.)
</code></pre></div>
<p>Examples</p>
<table>
<thead>
<tr>
<th>Sub-command</th>
<th>Available Flags</th>
<th>Explanation</th>
</tr>
</thead>
<tbody>
<tr>
<td>taskstats</td>
<td>newtmgr -cprofile1 taskstats</td>
<td>Run the taskstats subcommand on the device connected via the 'profile1' connection</td>
</tr>
</tbody>
</table>
<h3 id="conn"><em>conn</em></h3>
<h4 id="usage_1">Usage:</h4>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> newtmgr conn [flags]
newtmgr conn [command]
</code></pre></div>
<p>Available commands: </p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> add Add a newtmgr connection profile
delete Delete a newtmgr connection profile
show Show newtmgr connection profiles
</code></pre></div>
<p>Flags:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> -c, --conn string connection profile to use.
-l, --loglevel string log level to use (default WARN.)
</code></pre></div>
<p>Description</p>
<table>
<thead>
<tr>
<th>Sub-command</th>
<th>Explanation</th>
</tr>
</thead>
<tbody>
<tr>
<td>add</td>
<td>Adds a connection profile. A properly defined profile needs a name, a connection type, and the physical or virtual port to be used for communication.</td>
</tr>
<tr>
<td>delete</td>
<td>Deletes a connection profile associated with the given name</td>
</tr>
<tr>
<td>show</td>
<td>List the specified or all the connection profiles with the name, connection type, and the controlling terminal or port.</td>
</tr>
</tbody>
</table>
<p>Examples</p>
<table>
<thead>
<tr>
<th>Sub-command</th>
<th>Usage</th>
<th>Explanation</th>
</tr>
</thead>
<tbody>
<tr>
<td>add</td>
<td>newtmgr conn add myserial02 type=serial connstring=/dev/ttys002</td>
<td>Adds a newtmgr connection profile for the serial port /dev/ttys002 and names it 'myserial02'</td>
</tr>
<tr>
<td>delete</td>
<td>newtmgr conn delete myserial02</td>
<td>Deletes the connection profile named 'myserial02'</td>
</tr>
<tr>
<td>show</td>
<td>newtmgr conn show myserial01</td>
<td>Shows the details of the profile named 'myserial01'</td>
</tr>
<tr>
<td>show</td>
<td>newtmgr conn show</td>
<td>Shows all the current profiles defined</td>
</tr>
</tbody>
</table>
<h3 id="echo"><em>echo</em></h3>
<h4 id="usage_2">Usage:</h4>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> newtmgr echo [flags] [text]
</code></pre></div>
<p>This command sends the text to the remote device at the other end of the connection specified with the -c flag and outputs the text when it gets a response from the device. If the device is not responding or if the connection profile is invalid it displays errors. </p>
<p>Flags:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> -c, --conn string connection profile to use.
-l, --loglevel string log level to use (default WARN.)
</code></pre></div>
<p>Examples</p>
<table>
<thead>
<tr>
<th>Sub-command</th>
<th>Usage</th>
<th>Explanation</th>
</tr>
</thead>
<tbody>
<tr>
<td>echo</td>
<td>newtmgr echo -c profile01 hello</td>
<td>Sends the string 'hello' to the remote device over the connection profile 'profile01' and receives the string back and displays it.</td>
</tr>
</tbody>
</table>
<h3 id="image"><em>image</em></h3>
<h4 id="usage_3">Usage:</h4>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> newtmgr image [flags]
newtmgr image [command]
</code></pre></div>
<p>Available commands: </p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> list Show target images
upload Upload image to target
boot Which image to boot
fileupload Upload file to target
filedownload Download file from target
</code></pre></div>
<p>Flags:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> -c, --conn string connection profile to use.
-l, --loglevel string log level to use (default WARN.)
</code></pre></div>
<p>Description</p>
<table>
<thead>
<tr>
<th>Sub-command</th>
<th>Explanation</th>
</tr>
</thead>
<tbody>
<tr>
<td>list</td>
<td>Adds a connection profile. A properly defined profile needs a name, a connection type, and the physical or virtual port to be used for communication.</td>
</tr>
<tr>
<td>upload</td>
<td>Deletes a connection profile associated with the given name</td>
</tr>
<tr>
<td>boot</td>
<td>Specify the image to boot</td>
</tr>
<tr>
<td>fileupload</td>
<td>upload file to the remote target</td>
</tr>
<tr>
<td>filedownload</td>
<td>download/retrieve file from remote target</td>
</tr>
</tbody>
</table>
<p>Examples</p>
<table>
<thead>
<tr>
<th>Sub-command</th>
<th>Usage</th>
<th>Explanation</th>
</tr>
</thead>
<tbody>
<tr>
<td>list</td>
<td>newtmgr list</td>
<td></td>
</tr>
<tr>
<td>upload</td>
<td>newtmgr upload</td>
<td></td>
</tr>
<tr>
<td>boot</td>
<td>newtmgr boot</td>
<td></td>
</tr>
<tr>
<td>fileupload</td>
<td>newtmgr fileupload</td>
<td></td>
</tr>
<tr>
<td>filedownload</td>
<td>newtmgr filedownload</td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="stat"><em>stat</em></h3>
<h4 id="usage_4">Usage:</h4>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> newtmgr stat [flags]
newtmgr stat [command]
</code></pre></div>
<p>Flags:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> -c, --conn string connection profile to use.
-l, --loglevel string log level to use (default WARN.)
</code></pre></div>
<p>Examples</p>
<table>
<thead>
<tr>
<th>Sub-command</th>
<th>Usage</th>
<th>Explanation</th>
</tr>
</thead>
<tbody>
<tr>
<td>stat</td>
<td>newtmgr stat</td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="taskstats"><em>taskstats</em></h3>
<h4 id="usage_5">Usage:</h4>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> newtmgr taskstats [flags]
newtmgr taskstats [command]
</code></pre></div>
<p>Lists all the tasks running on the remote endpoint at the end of the specified connection and for each task lists statistics such as priority, task id, runtime (how long the task has been running in ms), context switch count, stack size allocated, actual stack usage, last sanity checkin, next sanity check-in. </p>
<p>Flags:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code> -c, --conn string connection profile to use.
-l, --loglevel string log level to use (default WARN.)
</code></pre></div>
<p>Examples</p>
<table>
<thead>
<tr>
<th>Sub-command</th>
<th>Usage</th>
<th>Explanation</th>
</tr>
</thead>
<tbody>
<tr>
<td>stat</td>
<td>newtmgr taskstats -c profile01</td>
<td>Lists all the tasks running on the remote device at the end of connection named 'profile01'</td>
</tr>
</tbody>
</table>
<p>Example output</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$ newtmgr -c profile01 taskstats
Return Code = 0
idle (prio=255 tid=0 runtime=3299340 cswcnt=280342 stksize=1024 stkusage=1000 last_checkin=0 next_checkin=0)
os_sanity (prio=254 tid=1 runtime=0 cswcnt=3287 stksize=1024 stkusage=1000 last_checkin=0 next_checkin=0)
shell (prio=3 tid=2 runtime=0 cswcnt=165 stksize=1024 stkusage=1000 last_checkin=0 next_checkin=0)
uart_poller (prio=0 tid=3 runtime=0 cswcnt=279368 stksize=1024 stkusage=1000 last_checkin=0 next_checkin=0)
newtmgr (prio=4 tid=4 runtime=0 cswcnt=14 stksize=1024 stkusage=1000 last_checkin=0 next_checkin=0)
task1 (prio=1 tid=5 runtime=0 cswcnt=3287 stksize=1024 stkusage=1000 last_checkin=0 next_checkin=0)
task2 (prio=2 tid=6 runtime=0 cswcnt=3287 stksize=1024 stkusage=1000 last_checkin=0 next_checkin=0)
</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>