| |
| |
| <!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>Installing Newtmgr on Windows — 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="Install" href="index.html"/> |
| <link rel="next" title="Installing Previous Releases of Newtmgr" href="prev_releases.html"/> |
| <link rel="prev" title="Installing Newtmgr on Linux" href="install_linux.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">Install</a> / |
| |
| Installing Newtmgr on Windows |
| |
| <div class="sourcelink"> |
| <a href="https://github.com/apache/mynewt-newtmgr/edit/master/docs/install/install_windows.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" > |
| 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"><a class="reference internal" href="../command_list/index.html">Command List</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="index.html">Install</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="install_mac.html">Installing Newtmgr on Mac OS</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="install_linux.html">Installing Newtmgr on Linux</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">Installing Newtmgr on Windows</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="prev_releases.html">Installing Previous Releases of Newtmgr</a></li> |
| </ul> |
| </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=""> |
| <div class="rst-content"> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="installing-newtmgr-on-windows"> |
| <h1>Installing Newtmgr on Windows<a class="headerlink" href="#installing-newtmgr-on-windows" title="Permalink to this headline">ΒΆ</a></h1> |
| <p>This guide shows you how to install the latest release of newtmgr from |
| binary or from source. The tool is written in Go (golang).</p> |
| <p>It assumes that you have already installed the <a class="reference internal" href="../../newt/install/newt_windows.html"><span class="doc">newt tool on |
| Windows</span></a> and have the Windows |
| development environment set up.</p> |
| <p>This guide shows you how to perform the following:</p> |
| <ol class="arabic simple"> |
| <li><p>Install latest release of newtmgr from binary.</p></li> |
| <li><p>Install latest release of newtmgr from source.</p></li> |
| </ol> |
| <div class="contents local topic" id="contents"> |
| <ul class="simple"> |
| <li><p><a class="reference internal" href="#installing-the-latest-release-of-newtmgr-tool-from-binary" id="id1">Installing the Latest Release of Newtmgr Tool from Binary</a></p></li> |
| <li><p><a class="reference internal" href="#installing-the-latest-release-of-newtmgr-from-source" id="id2">Installing the Latest Release of Newtmgr from Source</a></p></li> |
| <li><p><a class="reference internal" href="#checking-the-installed-version" id="id3">Checking the Installed Version</a></p></li> |
| </ul> |
| </div> |
| <p>See <a class="reference internal" href="prev_releases.html"><span class="doc">Installing Previous Releases of Newtmgr</span></a> |
| to install an earlier version of newtgmr.</p> |
| <p><strong>Note:</strong> If you would like to contribute to the newtmgr tool, see |
| <a class="reference internal" href="../../misc/go_env.html"><span class="doc">Contributing to Newt or Newtmgr Tools</span></a>.</p> |
| <div class="section" id="installing-the-latest-release-of-newtmgr-tool-from-binary"> |
| <h2><a class="toc-backref" href="#id1">Installing the Latest Release of Newtmgr Tool from Binary</a><a class="headerlink" href="#installing-the-latest-release-of-newtmgr-tool-from-binary" title="Permalink to this headline">ΒΆ</a></h2> |
| <p>You can install the latest release of newtmgr from binary. It has been |
| tested on Windows 10 64 bit platform.</p> |
| <ol class="arabic"> |
| <li><p>Start a MinGW terminal.</p></li> |
| <li><p>Download the newtmgr binary tar file from one of the mirror sites .:</p> |
| <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>wget<span class="w"> </span>-P<span class="w"> </span>/tmp<span class="w"> </span>http://www.apache.org/dyn/closer.lua/mynewt/apache-mynewt-1.4.1/apache-mynewt-newtmgr-bin-windows-1.4.1.tgz |
| </pre></div> |
| </div> |
| </li> |
| <li><p>Extract the file:</p> |
| <ul> |
| <li><p>If you previously built newtmgr from the master branch, you can |
| extract the file into your $GOPATH/bin directory. Note: This |
| overwrites the current newtmgr.exe in the directory and assumes that |
| you are using $GOPATH/bin for your Go applications.</p> |
| <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">tar -xzf /tmp/apache-mynewt-newtmgr-bin-windows-1.4.1.tgz -C $GOPATH/bin</span> |
| </pre></div> |
| </div> |
| </li> |
| <li><p>If you are installing newtmgr for the first time and do not have Go |
| setup, you can extract into /usr/bin directory:</p> |
| <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">tar -xzf /tmp/apache-mynewt-newtmgr-bin-windows-1.4.1.tgz -C /usr/bin</span> |
| </pre></div> |
| </div> |
| </li> |
| </ul> |
| </li> |
| <li><p>Verify the installed version of newtmgr. See <a class="reference external" href="#check_newtmgr">Checking the Installed |
| Version</a>.</p></li> |
| </ol> |
| </div> |
| <div class="section" id="installing-the-latest-release-of-newtmgr-from-source"> |
| <h2><a class="toc-backref" href="#id2">Installing the Latest Release of Newtmgr from Source</a><a class="headerlink" href="#installing-the-latest-release-of-newtmgr-from-source" title="Permalink to this headline">ΒΆ</a></h2> |
| <p>If you have an older version of Windows or a 32 bit platform, you can |
| build and install the latest release version of newtmgr from source.</p> |
| <ol class="arabic"> |
| <li><p>Download and install the latest version of |
| <a class="reference external" href="https://golang.org/dl/">Go</a>. Newtmgr requires Go version 1.7.6 or |
| higher.</p></li> |
| <li><p>Start MinGW terminal.</p></li> |
| <li><p>Create a Go workspace in the /tmp directory:</p> |
| <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>/tmp |
| <span class="gp">$ </span>mkdir<span class="w"> </span>go |
| <span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>go |
| <span class="gp">$ </span><span class="nb">export</span><span class="w"> </span><span class="nv">GOPATH</span><span class="o">=</span>/tmp/go |
| </pre></div> |
| </div> |
| </li> |
| <li><p>Run <code class="docutils literal notranslate"><span class="pre">go</span> <span class="pre">get</span></code> to download the newtmgr source. Note that <code class="docutils literal notranslate"><span class="pre">go</span> <span class="pre">get</span></code> |
| pulls down the HEAD from the master branch in git, builds, and installs |
| newtmgr.</p> |
| <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>go<span class="w"> </span>get<span class="w"> </span>mynewt.apache.org/newtmgr/newtmgr |
| </pre></div> |
| </div> |
| <p><strong>Note</strong> If you get the following error, you may ignore it as we will |
| rebuild newtmgr from the latest release version of newtmgr in the next |
| step:</p> |
| <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp"># </span>github.com/currantlabs/ble/examples/lib/dev |
| <span class="go">..\..\..\github.com\currantlabs\ble\examples\lib\dev\dev.go:7: undefined: DefaultDevice</span> |
| </pre></div> |
| </div> |
| </li> |
| <li><p>Check out the source from the latest release version:</p> |
| <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>src/mynewt.apache.org/newtmgr |
| <span class="gp">$ </span>git<span class="w"> </span>checkout<span class="w"> </span>mynewt_1_4_1_tag |
| <span class="go">Note: checking out 'mynewt_1_4_1_tag'.</span> |
| </pre></div> |
| </div> |
| </li> |
| <li><p>Build newtmgr from the latest release version:</p> |
| <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>newtmgr |
| <span class="gp">$ </span><span class="nv">GO111MODULE</span><span class="o">=</span>on<span class="w"> </span>go<span class="w"> </span>install |
| <span class="gp">$ </span>ls<span class="w"> </span>/tmp/go/bin/newtmgr.exe |
| <span class="go">-rwxr-xr-x 1 user None 15457280 Sep 12 00:30 /tmp/go/bin/newtmgr.exe</span> |
| </pre></div> |
| </div> |
| </li> |
| <li><p>If you have a Go workspace, remember to reset your GOPATH to your Go |
| workspace.</p></li> |
| <li><p>Copy the newtmgr executable to a bin directory in your path. You can |
| put it in the /usr/bin or the $GOPATH/bin directory.</p></li> |
| </ol> |
| </div> |
| <div class="section" id="checking-the-installed-version"> |
| <h2><a class="toc-backref" href="#id3">Checking the Installed Version</a><a class="headerlink" href="#checking-the-installed-version" title="Permalink to this headline">ΒΆ</a></h2> |
| <ol class="arabic"> |
| <li><p>Run <code class="docutils literal notranslate"><span class="pre">which</span> <span class="pre">newtmgr</span></code> to verify that you are using the installed |
| version of newtmgr.</p></li> |
| <li><p>Get information about the newtmgr tool:</p> |
| <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>newtmgr |
| <span class="go">Newtmgr helps you manage remote devices running the Mynewt OS</span> |
| |
| <span class="go">Usage:</span> |
| <span class="go"> newtmgr [flags]</span> |
| <span class="go"> newtmgr [command]</span> |
| |
| <span class="go">Available Commands:</span> |
| <span class="go"> config Read or write a config value on a device</span> |
| <span class="go"> conn Manage newtmgr connection profiles</span> |
| <span class="go"> crash Send a crash command to a device</span> |
| <span class="go"> datetime Manage datetime on a device</span> |
| <span class="go"> echo Send data to a device and display the echoed back data</span> |
| <span class="go"> fs Access files on a device</span> |
| <span class="go"> help Help about any command</span> |
| <span class="go"> image Manage images on a device</span> |
| <span class="go"> log Manage logs on a device</span> |
| <span class="go"> mpstat Read mempool statistics from a device</span> |
| <span class="go"> reset Perform a soft reset of a device</span> |
| <span class="go"> run Run test procedures on a device</span> |
| <span class="go"> stat Read statistics from a device</span> |
| <span class="go"> taskstat Read task statistics from a device</span> |
| |
| <span class="go">Flags:</span> |
| <span class="go"> -c, --conn string connection profile to use</span> |
| <span class="go"> -h, --help help for newtmgr</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> |
| |
| <span class="go">Use "newtmgr [command] --help" for more information about a command.</span> |
| </pre></div> |
| </div> |
| </li> |
| </ol> |
| </div> |
| </div> |
| |
| |
| </div> |
| </div> |
| |
| <div class="rst-footer-buttons row" role="navigation" aria-label="footer navigation"> |
| |
| <a href="prev_releases.html" class="btn btn-neutral float-right" title="Installing Previous Releases of Newtmgr" accesskey="n">Next: Installing Previous Releases of Newtmgr <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="install_linux.html" class="btn btn-neutral" title="Installing Newtmgr on Linux" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous: Installing Newtmgr on Linux</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> |
