http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/6e0ec54d/develop/newt/install/newt_linux/index.html ---------------------------------------------------------------------- diff --git a/develop/newt/install/newt_linux/index.html b/develop/newt/install/newt_linux/index.html index beed80e..4aea883 100644 --- a/develop/newt/install/newt_linux/index.html +++ b/develop/newt/install/newt_linux/index.html @@ -239,6 +239,14 @@ <li > + <a href="../newt_windows/">Install Newt on Windows</a> + </li> + + + + + + <li > <a href="../../../os/get_started/native_tools/">Install Native Toolchain</a> </li> @@ -407,6 +415,7 @@ <li>Install the latest stable release version of newt from a Debian source package.</li> </ol> <p>If you are installing on an amd64 platform, we recommend that you install from the binary package.</p> +<p><strong>Note:</strong> We have tested the newt tool binary and apt-get install from the runtimeco Debian package repository for Ubuntu version 16. Earlier Ubuntu versions (for example: Ubuntu 14) may have incompatibility with the repository. We recommend that you upgrade Ubuntu on your computer. </p> <p><strong>Note:</strong> See <a href="../../../faq/go_env">Setting Up an Go Environment to Contribute to Newt and Newtmgr Tools</a> if you want to: </p> <ul> <li>Use the newt tool with the latest updates from the master branch. The master branch may be unstable and we recommend that you use the latest stable release version.</li> @@ -455,11 +464,29 @@ deb-src https://raw.githubusercontent.com/runtimeco/debian-mynewt/master latest </pre></div> +<p><br> +Update the available packages: </p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$sudo apt-get update +</pre></div> + + +<p><br> +<strong>Note:</strong> If you are not using Ubuntu version 16, you may see the following errors. We recommend that you upgrade Ubuntu. We have provided instructions on how to manually download and install the binary package if you choose not to upgrade, but you will want to upgrade Ubuntu if you are installing from source.</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">W: Failed to fetch https://raw.githubusercontent.com/runtimeco/debian-mynewt/master/dists/latest/main/source/Sources HttpError404 + +W: Failed to fetch https://raw.githubusercontent.com/runtimeco/debian-mynewt/master/dists/latest/main/binary-amd64/Packages Bad header line + +W: Failed to fetch https://raw.githubusercontent.com/runtimeco/debian-mynewt/master/dists/latest/main/binary-i386/Packages HttpError404 + +E: Some index files failed to download. They have been ignored, or old ones used instead. +</pre></div> + + +<p><br></p> <p><br> </p> <h3 id="installing-the-latest-release-of-newt-from-a-binary-package">Installing the Latest Release of Newt from a Binary Package</h3> -<p>For Linux amd64 platforms, you can install the latest stable version (1.0.0) of newt from the newt Debian binary package:</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$sudo apt-get update -$sudo apt-get install newt +<p>For Linux amd64 platforms, you can install the latest stable version (1.0.0) of newt from the newt Debian binary package. </p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$sudo apt-get install newt Reading package lists... Done Building dependency tree Reading state information... Done @@ -472,6 +499,13 @@ Setting up newt (1.0.0-1) ... </pre></div> +<p><br></p> +<p><strong>Note:</strong>If you are not using Ubuntu version 16 and are not able to update the runtimeco Debian package repo on your computer successfully, you can manually download and install the newt_1.0.0-1_amd64.deb binary package as follows:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$wget https://raw.githubusercontent.com/runtimeco/debian-mynewt/master/pool/main/n/newt/newt_1.0.0-1_amd64.deb +$sudo dpkg -i newt_1.0.0-1_amd64.deb +</pre></div> + + <p><br> See <a href="#check">Checking the Installed Version of Newt</a> to verify that you are using the installed version of newt.</p> <p><br></p> @@ -625,8 +659,8 @@ Use "newt [command] --help" for more information about a command. </li> <li class="pull-right"> - <a href=../../../os/get_started/native_tools/> - Next: Install Native Toolchain + <a href=../newt_windows/> + Next: Install Newt on Windows <span class="fa fa-arrow-right"></span> </a>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/6e0ec54d/develop/newt/install/newt_mac/index.html ---------------------------------------------------------------------- diff --git a/develop/newt/install/newt_mac/index.html b/develop/newt/install/newt_mac/index.html index dc66d91..e55c510 100644 --- a/develop/newt/install/newt_mac/index.html +++ b/develop/newt/install/newt_mac/index.html @@ -239,6 +239,14 @@ <li > + <a href="../newt_windows/">Install Newt on Windows</a> + </li> + + + + + + <li > <a href="../../../os/get_started/native_tools/">Install Native Toolchain</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/6e0ec54d/develop/newt/install/newt_windows/index.html ---------------------------------------------------------------------- diff --git a/develop/newt/install/newt_windows/index.html b/develop/newt/install/newt_windows/index.html new file mode 100644 index 0000000..a744b87 --- /dev/null +++ b/develop/newt/install/newt_windows/index.html @@ -0,0 +1,611 @@ +<!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="canonical" href="http://mynewt.apache.org/newt/install/newt_windows/";> --> + <link rel="shortcut icon" href="../../../img/favicon.ico"> + + <title>Install Newt on Windows - 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";> + <link href="../../../extra.css" rel="stylesheet"> + + <!-- 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="Install Newt on Windows"> + + + <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.0.0</a> released (March 22, 2017) + </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="/latest/os/introduction">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> + + <!-- Search, Navigation and Repo links --> + <ul class="nav navbar-nav navbar-right"> + + </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="/develop/os/introduction" + selected="selected" + > + Version: develop (latest) + </option> + + <option + value="/v0_9_0/os/introduction" + + > + 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> + + + <ul> + + + + + + + + <li ><a href="../../../os/get_started/native_install_intro/">Native Install Option</a> + + + <ul> + + + + + + <li > + <a href="../newt_mac/">Install Newt on Mac</a> + </li> + + + + + + <li > + <a href="../newt_linux/">Install Newt on Linux</a> + </li> + + + + + + <li class="active"> + <a href="./">Install Newt on Windows</a> + </li> + + + + + + <li > + <a href="../../../os/get_started/native_tools/">Install Native Toolchain</a> + </li> + + + + + + <li > + <a href="../../../os/get_started/cross_tools/">Install Cross Tools for ARM</a> + </li> + + + + </ul> + + </li> + + + + + + <li > + <a href="../../../os/get_started/docker/">Docker Container Option</a> + </li> + + + + + + <li > + <a href="../../../os/get_started/project_create/">Create Your First Project</a> + </li> + + + + + + <li > + <a href="../../../os/get_started/serial_access/">Serial Port Setup</a> + </li> + + + + </ul> + + </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_intro/">Newt Tool Guide</a> + + + </li> + + + + + + + + <li ><a href="../../../newtmgr/overview/">Newt Manager Guide</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 pull-right"> + <li><a href="/develop/os/introduction">Docs</a></li> + + + + <li>» <a href="../../../os/get_started/get_started/">Basic Setup</a></li> + + + + <li>» <a href="../../../os/get_started/native_install_intro/">Native Install Option</a></li> + + + + <li>» Install Newt on Windows</li> + + + + </ul> +</div> + </div> + + <h2 id="installing-newt-on-windows">Installing Newt on Windows</h2> +<p>You can develop and build Mynewt OS applications for your target boards on the Windows platform. This page shows you how to build the newt tool from the lastest source on the master branch of the <a href="https://github.com/apache/incubator-mynewt-newt";>Mynewt newt git repository</a>. The tool is written in Go (golang).</p> +<p>In Windows, we use MinGW as the development environment to build and run Mynewt OS applications for target boards. MinGW runs the bash shell and provides a Unix-like environment. This provides a uniform way to build Mynewt OS applications. The Mynewt documentation and tutorials use Unix commands and you can use the same Unix commands on MinGW to follow the tutorials. The documentation will note any commands or behaviors that are specific to Windows.</p> +<p>This guide shows you how to perform the following:</p> +<ol> +<li>Install MSYS2/MinGW. </li> +<li>Install Git.</li> +<li>Install Go. </li> +<li>Setup the Go environment.</li> +<li>Download the source, build, and install the newt tool.</li> +</ol> +<p><br></p> +<h3 id="step-1-installing-msys2mingw">Step 1: Installing MSYS2/MinGW</h3> +<p>MSYS2/MinGW provides a bash shell and tools to build applications that run on Windows. It includes three subsystems:</p> +<ul> +<li>MSYS2 toolchain to build POSIX applications that run on Windows. </li> +<li>MinGW32 toolchains to build 32 bit native Windows applications. </li> +<li>MinGW64 toolchains to build 64 bit native Windows applications. </li> +</ul> +<p>The subsystems run the bash shell and provide a Unix-like environment. You can also run Windows applications from the shell. We will use the MinGW subsystem.</p> +<p>To install and setup MSYS2 and MinGW:</p> +<ol> +<li>Download and run the <a href="http://www.msys2.org";>MSYS2 installer</a>. Select the 64 bit version if you are running on a 64 bit platform. Follow the prompts and check the <code>Run MSYS2 now</code> checkbox on the <code>Installation Complete</code> dialog. </li> +<li> +<p>In the MSYS2 terminal, run the <code>pacman -Syuu</code> command. If you get a message to run the update again, close the terminal and run the <code>pacman -Syuu</code> command in a new terminal. </p> +<p>To start a new MSYS2 terminal, select the "MSYS2 MSYS" application from the Windows start menu.</p> +</li> +<li> +<p>Add a new user variable named <strong>MSYS2_PATH_TYPE</strong> and set the value to <strong>inherit</strong> in your Windows environment. This enables the MSYS2 and MinGW bash to inherit your Windows user <strong>Path</strong> values. </p> +<p>To add the variable, select properties for your computer > Advanced system settings > Environment Variables > New</p> +</li> +<li> +<p>Run the <code>pacman -Su vim</code> command to install the vim editor. </p> +<p><strong>Note:</strong>You can also use a Windows editor. You can access your files from the <strong>C:\<msys-install-folder>\home\<username></strong> folder, where <strong>msys-install-folder</strong> is the folder you installed MSYS2 in. For example, if you installed MSYS2 in the <strong>msys64</strong> folder, your files are stored in <strong>C:\msys64\home\<username></strong></p> +</li> +</ol> +<p>You will need to start a MinGW terminal to run the commands specified in the Mynewt documentation and tutorials. To start a MinGW terminal, select the "MSYS2 Mingw" application from the start Menu (you can use either MinGW32 or MinGW64). +In Windows, we use the MingGW subsystem to build Mynewt tools and applications. </p> +<h3 id="step-2-installing-git-for-windows">Step 2: Installing Git for Windows</h3> +<p>Download and install <a href="https://git-for-windows.github.io";>Git for Windows</a> if it is not already installed.</p> +<h3 id="step-3-installing-go">Step 3: Installing Go</h3> +<p>Download and install the latest version of <a href="https://golang.org/dl/";>Go</a>. Newt requires Go version 1.7 or higher.</p> +<h3 id="step-4-setting-up-your-go-environment">Step 4: Setting Up Your Go Environment</h3> +<p>This section describes the Go environment and how to setup a Go workspace. Go provides an environment to compile Go code, construct Go packages, and import Go code. You will use Go commands to import the newt package repository into your local Go environment. The Go language environment dictates a specific directory structure, or workspace in Go parlance. It must contain three sibling directories with the names <strong>src</strong>, <strong>pkg</strong> and <strong>bin</strong>: </p> +<ul> +<li>src contains Go source files organized into packages (one package per directory)</li> +<li>pkg contains package objects</li> +<li>bin contains the Go application executables that Go builds and installs.</li> +</ul> +<p>The <strong>GOPATH</strong> environment variable specifies the location of your workspace. To setup this workspace environment, create a <strong>dev</strong> directory and then a <strong>go</strong> directory under it. Set the GOPATH environment variable to this directory where you will clone the newt repository.</p> +<p>Start up a MinGW terminal and run the following commands to set up your Go workspace:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ cd $HOME +$ mkdir -p dev/go +$ cd dev/go +$ export GOPATH=`pwd` +</pre></div> + + +<p><br> +Add the following export statements to your ~/.bash_profile file and source the file:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">export GOPATH=$HOME/dev/go +export PATH=$GOPATH/bin:$PATH +</pre></div> + + +<p><br></p> +<h3 id="step-5-downloading-the-source-and-installing-the-newt-tool">Step 5: Downloading the Source and Installing the Newt Tool</h3> +<p>The newt Go package is <strong>mynewt.apache.org/newt/newt</strong> and is stored in the <a href="https://github.com/apache/incubator-mynewt-newt";>Apache Mynewt newt tool repository mirrored on github</a>. We use the <code>go get</code> command to download the source, build, and install the newt tool binary in the <strong>$GOPATH/bin</strong> directory. </p> +<p><br> +Download the newt package source and install the tool:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$cd $GOPATH +$go get mynewt.apache.org/newt/newt +$cd $GOPATH/src/mynewt.apache.org/newt +$ls +DISCLAIMER RELEASE_NOTES.md util +INSTALLING.md build.sh viper +LICENSE newt yaml +NOTICE newtmgr +README.md newtvm +</pre></div> + + +<p><br> +Check that the newt tool is installed and it is in your path:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ls go/bin +$ ls bin/newt +bin/newt +$which go +/home/<user>/dev/go/bin/newt +$ newt version +Apache Newt (incubating) version: 1.0.0-dev +</pre></div> + + +<p><br> +Get information about the newt tool:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$newt +Newt allows you to create your own embedded application based on the Mynewt +operating system. Newt provides both build and package management in a single +tool, which allows you to compose an embedded application, and set of +projects, and then build the necessary artifacts from those projects. For more +information on the Mynewt operating system, please visit +https://mynewt.apache.org/. + +Please use the newt help command, and specify the name of the command you want +help for, for help on how to use a specific command + +Usage: + newt [flags] + newt [command] + +Examples: + newt + newt help [<command-name>] + For help on <command-name>. If not specified, print this message. + +Available Commands: + build Build one or more targets + clean Delete build artifacts for one or more targets + create-image Add image header to target binary + debug Open debugger session to target + info Show project info + install Install project dependencies + load Load built target to board + mfg Manufacturing flash image commands + new Create a new project + pkg Create and manage packages in the current workspace + run build/create-image/download/debug <target> + size Size of target components + sync Synchronize project dependencies + target Commands to create, delete, configure, and query targets + test Executes unit tests for one or more packages + upgrade Upgrade project dependencies + vals Display valid values for the specified element type(s) + version Display the Newt version number + +Flags: + -h, --help Help for newt commands + -j, --jobs int Number of concurrent build jobs (default 4) + -l, --loglevel string Log level (default "WARN") + -o, --outfile string Filename to tee output to + -q, --quiet Be quiet; only display error output + -s, --silent Be silent; don't output anything + -v, --verbose Enable verbose output when executing commands + +Use "newt [command] --help" for more information about a command. +</pre></div> + + <div class="row"> + + + + +<ul class="nav nav-pills" style="margin-bottom: 10px"> + <li> + + <a href=../newt_linux/> + <span class="fa fa-arrow-left"></span> + Previous: Install Newt on Linux + </a> + + </li> + <li class="pull-right"> + + <a href=../../../os/get_started/native_tools/> + Next: Install Native Toolchain + <span class="fa fa-arrow-right"></span> + </a> + + </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"> + <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> + <small class="footnote"> + MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. + </small> + <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> + </div> + </div> +</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> + + </body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/6e0ec54d/develop/newtmgr/install_linux/index.html ---------------------------------------------------------------------- diff --git a/develop/newtmgr/install_linux/index.html b/develop/newtmgr/install_linux/index.html index 1ff2c9b..c4ce303 100644 --- a/develop/newtmgr/install_linux/index.html +++ b/develop/newtmgr/install_linux/index.html @@ -314,6 +314,14 @@ + + + <li > + <a href="../install_windows/">Install Newtmgr On Windows</a> + </li> + + + </ul> </li> @@ -373,7 +381,7 @@ </div> <h2 id="installing-newtmgr-on-linux">Installing Newtmgr on Linux</h2> -<p>You can install the latest stable release (1.0.0) of the newtmgr tool from a Debian binary package (amd64) or from a Debian source package. This page shows you how to:</p> +<p>You can install the latest stable release (1.0.0) of the newtmgr tool from a Debian binary package (amd64) or from a Debian source package. This page shows you how to:</p> <ol> <li> <p>Set up your computer to retrieve Debian packages from the runtimeco debian package repository. </p> @@ -385,6 +393,7 @@ <li>Install the latest stable release version of newtmgr from a Debian source package.</li> </ol> <p>If you are installing on an amd64 platform, we recommend that you install from the binary package.</p> +<p><strong>Note:</strong> We have tested the newtmgr tool binary and apt-get install from the runtimeco Debian package repository for Ubuntu version 16. Earlier Ubuntu versions (for example: Ubuntu 14) may have incompatibility with the repository. We recommend that you upgrade Ubuntu on your computer.</p> <p><strong>Note:</strong> See <a href="../../faq/go_env">Setting Up an Go Environment to Contribute to Newt and Newtmgr Tools</a> if you want to: </p> <ul> <li>Use the newtmgr tool with the latest updates from the master branch. The master branch may be unstable and we recommend that you use the latest stable release version.</li> @@ -433,11 +442,31 @@ deb-src https://raw.githubusercontent.com/runtimeco/debian-mynewt/master latest </pre></div> +<p><br> +Update the available packages:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$sudo apt-get update +</pre></div> + + +<p><br> +<strong>Note:</strong> If you are not using Ubuntu version 16, you may see the following errors. We recommend that you upgrade Ubuntu. We have provided instructions on how to manually download and install the binary package if you choose not to upgrade, but you will want to upgrade Ubuntu if you are installing from source. </p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">W: Failed to fetch https://raw.githubusercontent.com/runtimeco/debian-mynewt/master/dists/latest/main/source/Sources Ht +tpError404 + +W: Failed to fetch https://raw.githubusercontent.com/runtimeco/debian-mynewt/master/dists/latest/main/binary-amd64/Packa +ges Bad header line + +W: Failed to fetch https://raw.githubusercontent.com/runtimeco/debian-mynewt/master/dists/latest/main/binary-i386/Packag +es HttpError404 + +E: Some index files failed to download. They have been ignored, or old ones used instead. +</pre></div> + + <p><br> </p> <h3 id="installing-the-latest-release-of-newtmgr-from-a-binary-package">Installing the Latest Release of Newtmgr from a Binary Package</h3> <p>For Linux amd64 platforms, you can install the latest stable version (1.0.0) of newtmgr from the newtmgr Debian binary package:</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$sudo apt-get update -$sudo apt-get install newtmgr +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$sudo apt-get install newtmgr Reading package lists... Done Building dependency tree Reading state information... Done @@ -455,6 +484,13 @@ Setting up newtmgr (1.0.0-1) <p><br> +<strong>Note:</strong> If you are not using Ubuntu version 16 and are not able to update the runtimeco Debian package repo on your computer successfully, you can manually download and install the newtmgr_1.0.0-1_amd64.deb binary package as follows:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$wget https://raw.githubusercontent.com/runtimeco/debian-mynewt/master/pool/main/n/newtmgr/newtmgr_1.0.0-1_amd64.deb +$sudo dpkg -i newtmgr_1.0.0-1_amd64.deb +</pre></div> + + +<p><br> See <a href="#check">Checking the Installed Version of Newtmgr</a> to verify that you are using the installed version of newtmgr.</p> <p><br></p> <h3 id="installing-the-latest-stable-release-of-newtmgr-from-a-source-package">Installing the Latest Stable Release of Newtmgr from a Source Package</h3> @@ -583,8 +619,8 @@ Use "newtmgr [command] --help" for more information about a command. </li> <li class="pull-right"> - <a href=../../faq/go_env/> - Next: Setting Up Go to Contribute to Newt and Newtmgr Tools + <a href=../install_windows/> + Next: Install Newtmgr On Windows <span class="fa fa-arrow-right"></span> </a> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/6e0ec54d/develop/newtmgr/install_mac/index.html ---------------------------------------------------------------------- diff --git a/develop/newtmgr/install_mac/index.html b/develop/newtmgr/install_mac/index.html index c72def6..f5f7fa2 100644 --- a/develop/newtmgr/install_mac/index.html +++ b/develop/newtmgr/install_mac/index.html @@ -314,6 +314,14 @@ + + + <li > + <a href="../install_windows/">Install Newtmgr On Windows</a> + </li> + + + </ul> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/6e0ec54d/develop/newtmgr/install_windows/index.html ---------------------------------------------------------------------- diff --git a/develop/newtmgr/install_windows/index.html b/develop/newtmgr/install_windows/index.html new file mode 100644 index 0000000..1f5cbeb --- /dev/null +++ b/develop/newtmgr/install_windows/index.html @@ -0,0 +1,500 @@ +<!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="canonical" href="http://mynewt.apache.org/newtmgr/install_windows/";> --> + <link rel="shortcut icon" href="../../img/favicon.ico"> + + <title>Install Newtmgr On Windows - 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";> + <link href="../../extra.css" rel="stylesheet"> + + <!-- 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="Install Newtmgr On Windows"> + + + <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.0.0</a> released (March 22, 2017) + </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="/latest/os/introduction">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> + + <!-- Search, Navigation and Repo links --> + <ul class="nav navbar-nav navbar-right"> + + </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="/develop/os/introduction" + selected="selected" + > + Version: develop (latest) + </option> + + <option + value="/v0_9_0/os/introduction" + + > + 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 ><a href="../overview/">Newt Manager Guide</a> + + + <ul> + + + + + + + + <li><a href=" + ../command_list/newtmgr_config/ +">Command Guide</a> + + + </li> + + + + + + + + <li><a href=" + ../install_mac/ +">Install</a> + + + <ul> + + + + <li > + <a href="../install_mac/">Install Newtmgr On Mac OS</a> + </li> + + + + + + <li > + <a href="../install_linux/">Install Newtmgr On Linux</a> + </li> + + + + + + <li class="active"> + <a href="./">Install Newtmgr On Windows</a> + </li> + + + + </ul> + + </li> + + + + </ul> + + </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 pull-right"> + <li><a href="/develop/os/introduction">Docs</a></li> + + + + <li>» <a href="../overview/">Newt Manager Guide</a></li> + + + + <li>» <a href="../install_mac/">Install</a></li> + + + + <li>» Install Newtmgr On Windows</li> + + + + </ul> +</div> + </div> + + <h2 id="installing-newtmgr-on-windows">Installing Newtmgr on Windows</h2> +<p>You can build and install the newtmgr tool from the latest source on the master branch. Newtmgr is a Go (golang) package. This guide shows you how to install the tool from source. It assumes that you already installed the <a href="../../newt/install/newt_windows/">newt tool on Windows</a> and have the Windows development environment and Go workspace set up.</p> +<h3 id="downloading-and-installing-the-newtmgr-tool">Downloading and Installing the Newtmgr Tool</h3> +<p>The newtmgr Go package is <strong>mynewt.apache.org/newtmgr/newtmgr</strong>. It is stored in the <a href="https://github.com/apache/incubator-mynewt-newtmgr";>Apache Mynewt newtmgr tool repository mirrored on github</a>.</p> +<p>Run the <code>go get</code> command, from your Go workspace, to download, build, and install the newtmgr tool:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$cd $GOPATH +$go get mynewt.apache.org/newtmgr/newtmgr +$cd $GOPATH/src/mynewt.apache.org/newtmgr +$ls +DISCLAIMER NOTICE newtmgr +LICENSE README.md nmxact +$git status +On branch master +Your branch is up-to-date with 'origin/master'. + +nothing to commit, working directory clean +</pre></div> + + +<p><br> +Check that the newtmgr binary is installed and you are using the one from <strong>$GOPATH/bin</strong>:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ls $GOPATH/bin/newtmgr +~/dev/go/bin/newtmgr +$which newt +~/dev/go/bin/newtmgr +</pre></div> + + +<p><br> +Get information about the newtmgr tool:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$newtmgr +Newtmgr helps you manage remote devices running the Mynewt OS + +Usage: + newtmgr [flags] + newtmgr [command] + +Available Commands: + config Read or write config value on target + conn Manage newtmgr connection profiles + crash Send crash command to remote endpoint using newtmgr + datetime Manage datetime on the device + echo Send data to remote endpoint using newtmgr, and receive data back + fs Access files on device + help Help about any command + image Manage images on remote instance + log Handles log on remote instance + mpstat Read mempool statistics from a remote endpoint + reset Performs a soft reset of target device + run Run procedures on remote device + stat Read statistics from a remote endpoint + taskstat Read statistics from a remote endpoint + +Flags: + -c, --conn string connection profile to use. + -n, --devicename string name of target BLE device; overrides profile setting + -h, --help help for newtmgr + -l, --loglevel string log level to use (default "info") + -t, --timeout float timeout in seconds (partial seconds allowed) (defaul t 10) + -r, --tries int total number of tries in case of timeout (default 1) + +Use "newtmgr [command] --help" for more information about a command. +</pre></div> + + <div class="row"> + + + + +<ul class="nav nav-pills" style="margin-bottom: 10px"> + <li> + + <a href=../install_linux/> + <span class="fa fa-arrow-left"></span> + Previous: Install Newtmgr On Linux + </a> + + </li> + <li class="pull-right"> + + <a href=../../faq/go_env/> + Next: Setting Up Go to Contribute to Newt and Newtmgr Tools + <span class="fa fa-arrow-right"></span> + </a> + + </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"> + <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> + <small class="footnote"> + MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. + </small> + <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> + </div> + </div> +</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> + + </body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/6e0ec54d/develop/os/get_started/cross_tools/index.html ---------------------------------------------------------------------- diff --git a/develop/os/get_started/cross_tools/index.html b/develop/os/get_started/cross_tools/index.html index 05f0dba..e6730e5 100644 --- a/develop/os/get_started/cross_tools/index.html +++ b/develop/os/get_started/cross_tools/index.html @@ -239,6 +239,14 @@ <li > + <a href="../../../newt/install/newt_windows/">Install Newt on Windows</a> + </li> + + + + + + <li > <a href="../native_tools/">Install Native Toolchain</a> </li> @@ -399,20 +407,17 @@ </div> </div> - <h1 id="installing-cross-tools-for-arm">Installing Cross Tools for ARM</h1> -<p>This page shows how to install tools on your laptop/computer to use for direct communication (e.g. for debugging) with some ARM based HW platforms running Apache Mynewt. It shows you how to install the following tools for Mac OS X and Linux:</p> + <h1 id="installing-the-cross-tools-for-arm">Installing the Cross Tools for ARM</h1> +<p>This page shows you how to install the tools to build, run, and debug Mynewt OS applications that run on supported ARM target boards. It shows you how to install the following tools on Mac OS, Linux and Windows:</p> <ul> -<li>ARM Cross toolchain</li> -<li>Debugger to load and debug your device</li> +<li>ARM cross toolchain to compile and build Mynewt applications for the target boards.</li> +<li>Debuggers to load and debug applications on the target boards.</li> </ul> <p><br></p> -<h2 id="install-arm-cross-toolchain">Install ARM Cross Toolchain</h2> -<h3 id="install-arm-toolchain-for-mac-os-x">Install ARM Toolchain For Mac OS X</h3> -<p>Install the PX4 Toolchain and check the version installed. ARM maintains a -pre-built GNU toolchain with a GCC source branch targeted at Embedded ARM -Processors, namely Cortex-R/Cortex-M processor families. After installing, -ensure that the symbolic link installed by Homebrew points to the correct -version of the debugger.</p> +<h2 id="installing-the-arm-cross-toolchain">Installing the ARM Cross Toolchain</h2> +<p>ARM maintains a pre-built GNU toolchain with gcc and gdb targeted at Embedded ARM Processors, namely Cortex-R/Cortex-M processor families. Mynewt OS has been tested with version 4.9 of the toolchain and we recommend you install this version to get started. Mynewt OS will eventually work with multiple versions available, including the latest releases. </p> +<h3 id="installing-the-arm-toolchain-for-mac-os-x">Installing the ARM Toolchain For Mac OS X</h3> +<p>Add the <strong>PX4/homebrew-px4</strong> homebrew tap and install version 4.9 of the toolchain. After installing, check that the symbolic link that homebrew created points to the correct version of the debugger.</p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ brew tap PX4/homebrew-px4 $ brew update $ brew install gcc-arm-none-eabi-49 @@ -426,12 +431,9 @@ lrwxr-xr-x 1 aditihilbert admin 69 Sep 22 17:16 /usr/local/bin/arm-none-eabi- </pre></div> -<p><strong>Note:</strong> If no version is specified, brew will install the latest version -available. Mynewt OS will eventually work with multiple versions available, -including the latest releases. However, at present we have tested only with -this version and recommend it for getting started. </p> +<p><strong>Note:</strong> If no version is specified, brew will install the latest version available. </p> <p><br></p> -<h3 id="install-arm-toolchain-for-linux">Install ARM Toolchain For Linux</h3> +<h3 id="installing-the-arm-toolchain-for-linux">Installing the ARM Toolchain For Linux</h3> <p>On a Debian-based Linux distribution, gcc 4.9.3 for ARM can be installed with apt-get as documented below. The steps are explained in depth at <a href="https://launchpad.net/~team-gcc-arm-embedded/+archive/ubuntu/ppa";>https://launchpad.net/~team-gcc-arm-embedded/+archive/ubuntu/ppa</a>.</p> @@ -444,16 +446,30 @@ $ sudo apt-get install gdb-arm-none-eabi <p><br></p> -<h2 id="install-debugger">Install Debugger</h2> -<p>Mynewt uses, depending on the board, either the OpenOCD or SEGGER J-Link debugger. </p> -<h3 id="install-openocd">Install OpenOCD</h3> +<h3 id="installing-the-arm-toolchain-for-windows">Installing the ARM Toolchain for Windows</h3> +<p>Step 1: Download and run the <a href="https://launchpad.net/gcc-arm-embedded/4.9/4.9-2015-q2-update/+download/gcc-arm-none-eabi-4_9-2015q2-20150609-win32.exe";>installer</a> to install arm-none-eabi-gcc and arm-none-eabi-gdb. Select the default destination folder: <strong>C:\Program Files (x86)\GNU Tools ARM Embedded\4.9 2015q2</strong>. </p> +<p><strong>Note:</strong> You may select a different folder but the installation instructions use the default values.</p> +<p>Step 2: Add the path:<strong> C:\Program Files (x86)\GNU Tools ARM Embedded\4.9 2015q2\bin</strong> to your Windows <strong>Path</strong> environment variable. Note: You must add <strong>bin</strong> to the path.</p> +<p>Step 3: Check that you are using the installed versions arm-none-eabi-gcc and arm-none-eabi-gdb. Open a MinGW terminal and run the <code>which</code> commands. </p> +<p><strong>Note:</strong> You must start a new MinGW terminal to inherit the new <strong>Path</strong> values.</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ which arm-none-eabi-gcc +/c/Program Files (x86)/GNU Tools ARM Embedded/4.9 2015q2/bin/arm-none-eabi-gcc +$which arm-none-eabi-gdb +/c/Program Files (x86)/GNU Tools ARM Embedded/4.9 2015q2/bin/arm-none-eabi-gdb +</pre></div> + + +<h2 id="installing-the-debuggers">Installing the Debuggers</h2> +<p>Mynewt uses, depending on the board, either the OpenOCD or SEGGER J-Link debuggers. +<br></p> +<h3 id="installing-the-openocd-debugger">Installing the OpenOCD Debugger</h3> <p>OpenOCD (Open On-Chip Debugger) is open-source software that allows your computer to interface with the JTAG debug connector on a variety of boards. A JTAG connection lets you debug and test embedded target devices. For more on OpenOCD go to <a href="http://openocd.org";>http://openocd.org</a>.</p> -<p>OpenOCD version 0.10.0 with nrf52 support is required. A binary for this version is available to download for Mac OS and Linux.</p> +<p>OpenOCD version 0.10.0 with nrf52 support is required. A binary for this version is available to download for Mac OS, Linux, and Windows.</p> <p><br></p> -<h4 id="install-openocd-on-mac-os">Install OpenOCD on Mac OS</h4> +<h4 id="installing-openocd-on-mac-os">Installing OpenOCD on Mac OS</h4> <p>Step 1: Download the <a href="https://github.com/runtimeco/openocd-binaries/raw/master/openocd-bin-0.10.0-MacOS.tgz";>binary tarball for Mac OS</a>.</p> <p>Step 2: Change to the root directory: </p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$cd / @@ -467,7 +483,7 @@ Step 3: Untar the tarball and install into <strong> /usr/local/bin</strong>. Yo <p><br> -Step 4: Check the OpenOCD version you are using: </p> +Step 4: Check the OpenOCD version you are using. </p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$which openocd /usr/local/bin/openocd $openocd -v @@ -480,7 +496,7 @@ http://openocd.org/doc/doxygen/bugs.html <p>You should see version: <strong>0.10.0</strong>. </p> <p><br></p> -<h4 id="install-openocd-on-linux">Install OpenOCD on Linux</h4> +<h4 id="installing-openocd-on-linux">Installing OpenOCD on Linux</h4> <p>Step 1: Download the <a href="https://github.com/runtimeco/openocd-binaries/raw/master/openocd-bin-0.10.0-Linux.tgz";>binary tarball for Linux</a></p> <p>Step 2: Change to the root directory: </p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$cd / @@ -522,8 +538,31 @@ http://openocd.org/doc/doxygen/bugs.html <p><br></p> -<h3 id="install-seggar-j-link">Install SEGGAR J-Link</h3> +<h4 id="installing-openocd-on-windows">Installing OpenOCD on Windows</h4> +<p>Step 1: Download the <a href="https://github.com/runtimeco/openocd-binaries/raw/master/openocd-0.10.0.zip";>binary zip file for Windows</a>.</p> +<p>Step 2: Extract into the <strong>C:\openocd-0.10.0</strong> folder. </p> +<p>Step 3: Add the path: <strong> C:\openocd-0.10.0\bin</strong> to your Windows User <strong>Path</strong> environment variable. Note: You must add <strong>bin</strong> to the path.</p> +<p>Step 4: Check the OpenOCD version you are using. Open a new MinGW terminal and run the following commands: </p> +<p><strong>Note:</strong> You must start a new MinGW terminal to inherit the new <strong>Path</strong> values.</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$which openocd +/c/openocd-0.10.0/bin/openocd +$openocd -v +Open On-Chip Debugger 0.10.0 +Licensed under GNU GPL v2 +For bug reports, read + http://openocd.org/doc/doxygen/bugs.html +</pre></div> + + +<p>You should see version: <strong>0.10.0</strong>. </p> +<p><br></p> +<h3 id="installing-seggar-j-link">Installing SEGGAR J-Link</h3> <p>You can download and install Segger J-LINK Software and documentation pack from <a href="https://www.segger.com/jlink-software.html";>SEGGER</a>. </p> +<p><strong>Note:</strong> On Windows, perform the following after the installation:</p> +<ul> +<li>Add the installation destination folder path to your Windows user <strong>Path</strong> environment variable. You do not need to add <strong>bin</strong> to the path.</li> +<li>Open a new MinGW terminal to inherit the new <strong>Path</strong> values.</li> +</ul> <div class="row"> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/6e0ec54d/develop/os/get_started/get_started/index.html ---------------------------------------------------------------------- diff --git a/develop/os/get_started/get_started/index.html b/develop/os/get_started/get_started/index.html index 997790a..5e20921 100644 --- a/develop/os/get_started/get_started/index.html +++ b/develop/os/get_started/get_started/index.html @@ -363,7 +363,7 @@ <p>If you are curious about Mynewt and want to get a quick feel for the project, you've come to the right place. We have two options for you:</p> <p><br> <strong>Option 1 (Recommended)</strong> allows you to install the Newt tool, instances of the Mynewt OS (for simulated targets), and toolchains for developing embedded software (e.g. GNU toolchain) natively on your laptop or computer. We have tried to make the process easy. For example, for the Mac OS we created brew formulas. </p> -<p>We recommend this option if you are familiar with such environments or are concerned about performance on your machine. Follow the instructions to <a href="../native_tools/">install native tools</a> and <a href="../cross_tools/">install cross tools for ARM</a> if you prefer this option.</p> +<p>We recommend this option if you are familiar with such environments or are concerned about performance on your machine. Follow the instructions in the <a href="../native_install_intro/">Native Install Option</a> if you prefer this option.</p> <p><br></p> <p><strong>Option 2</strong> is an easy, self-contained way to get up and running with Mynewt - but has limitations! The Newt tool and build toolchains are all available in a single <a href="../docker/">All-in-one Docker Container</a> that you can install on your laptop or computer.</p> <p>However, this is not a long-term option since support is not likely for all features useful or critical to embedded systems development. For example, USB device mapping available in the Docker toolkit is no longer available in the new Docker releases. The Docker option is also typically slower than the native install option. </p> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/6e0ec54d/develop/os/get_started/native_install_intro/index.html ---------------------------------------------------------------------- diff --git a/develop/os/get_started/native_install_intro/index.html b/develop/os/get_started/native_install_intro/index.html index 816bcf4..d5fd0c5 100644 --- a/develop/os/get_started/native_install_intro/index.html +++ b/develop/os/get_started/native_install_intro/index.html @@ -239,6 +239,14 @@ <li > + <a href="../../../newt/install/newt_windows/">Install Newt on Windows</a> + </li> + + + + + + <li > <a href="../native_tools/">Install Native Toolchain</a> </li> @@ -398,25 +406,28 @@ </div> <h1 id="native-installation">Native Installation</h1> -<p>This section shows you how to install tools on Mac OS and Linux platforms to develop, build, run, and debug Mynewt OS applications. You can build Mynewt OS applications to run as a native application on your computer or to run on your target board. These tools include:</p> +<p>This section shows you how to install the tools to develop and build Mynewt OS applications on Mac OS, Linux, and Windows, and run and debug the applications on target boards. For Mac OS and Linux, you can also build Mynewt OS applications that run on Mynewt's simulated hardware. These applications run natively on Mac OS and Linux. </p> +<p>The tools you need are:</p> <ul> <li> -<p>Newt tool - Tool to create, build, load, and debug a mynewt target.</p> +<p>Newt tool: Tool to create, build, load, and debug Mynewt OS applications.</p> <ul> <li>See <a href="../../../newt/install/newt_mac/">Installing the Newt Tool on Mac OS</a> to install on Mac OS.</li> <li>See <a href="../../../newt/install/newt_linux/">Installing the Newt Tool on Linux</a> to install on Linux.</li> +<li>See <a href="../../../newt/install/newt_windows/">Installing the Newt Tool on Windows</a> to install on Windows. </li> </ul> </li> -</ul> -<p><br></p> -<ul> <li> -<p>Native toolchain - Native toolchain to build and run Mynewt OS as a native application on your computer. - (See <a href="../native_tools/">Installing Native Toolchain</a>). </p> +<p>Native toolchain: Native toolchain to compile and build Mynewt OS applications that run on Mynewt's simulated hardware on Mac OS and Linux. </p> +<p>(See <a href="../native_tools/">Installing Native Toolchain</a>). </p> </li> <li> -<p>Cross toolchain for ARM - Cross toolchain for ARM to build and run a Mynewt OS application on a target board - (See <a href="../cross_tools/">Installing Cross Tools for ARMs</a>).</p> +<p>Cross tools for ARM: </p> +<ul> +<li>Cross toolchain for ARM to compile and build Mynewt OS applications for target boards.</li> +<li>Debuggers to load and debug applications on target boards. </li> +</ul> +<p>(See <a href="../cross_tools/">Installing Cross Tools for ARMs</a>).</p> </li> </ul> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/6e0ec54d/develop/os/get_started/native_tools/index.html ---------------------------------------------------------------------- diff --git a/develop/os/get_started/native_tools/index.html b/develop/os/get_started/native_tools/index.html index d69ab06..78d6ac1 100644 --- a/develop/os/get_started/native_tools/index.html +++ b/develop/os/get_started/native_tools/index.html @@ -238,6 +238,14 @@ + <li > + <a href="../../../newt/install/newt_windows/">Install Newt on Windows</a> + </li> + + + + + <li class="active"> <a href="./">Install Native Toolchain</a> </li> @@ -399,16 +407,15 @@ </div> </div> - <h1 id="installing-native-mynewt-tools">Installing Native Mynewt Tools</h1> -<p>This page shows how to install tools for native Mynewt targets (simulated targets on your laptop/computer) without using a Docker container. In other words, it allows you to run Mynewt OS as a native application on your Mac or Linux machine to simulate a target and use the Newt tool running natively on your machine to manage the simulated target. It also allows you to run the test suites for all packages not requiring HW support. You may choose to do this instead of using the build toolchain and Newt tool available in a Docker container.</p> -<p>This page provides guidance for MAC and Linux. See the relevant sections below.</p> + <h1 id="installing-native-toolchain">Installing Native Toolchain</h1> +<p>This page shows you how to install the toolchain to build Mynewt OS applications that run native on Mac OS and Linux. The applications run on Mynewt's simulated hardware. It also allows you to run the test suites for all packages that do not require HW support. </p> +<p><strong>Note:</strong> This is not supported on Windows.</p> <p><br></p> -<h2 id="set-up-toolchain-for-mac">Set up toolchain for Mac</h2> -<h3 id="install-brew">Install Brew</h3> -<p>If you have not already installed Homebrew from the -<a href="../../../newt/install/newt_mac/"><code>newt</code> tutorials pages</a>, install it. </p> +<h2 id="setting-up-the-toolchain-for-mac">Setting Up the Toolchain for Mac</h2> +<h3 id="installing-brew">Installing Brew</h3> +<p>If you have not already installed Homebrew from the <a href="../../../newt/install/newt_mac/"><code>newt</code> tutorials pages</a>, install it. </p> <p><br></p> -<h3 id="install-gcclibc">Install gcc/libc</h3> +<h3 id="installing-gcclibc">Installing gcc/libc</h3> <p>OS X ships with a C compiler called Clang. To build applications for the Mynewt simulator with, a different compiler is used as default: gcc.</p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ brew install gcc ... @@ -463,7 +470,7 @@ compiler.path.objcopy.DARWIN.OVERWRITE: "gobjcopy" <p>A third option is to simply <strong>downgrade to gcc 5.x</strong>.</p> <p><br></p> -<h3 id="install-gdb">Install gdb</h3> +<h3 id="installing-gdb">Installing gdb</h3> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ brew install gdb ... ... @@ -478,7 +485,7 @@ executable. <a href="https://gcc.gnu.org/onlinedocs/gnat_ugn/Codesigning-the-De shows a recipe for gdb signing. Alternately you can skip this step and continue without the ability to debug your mynewt application on your PC.*</p> <p><br></p> -<h2 id="set-up-toolchain-for-linux">Set up toolchain for Linux</h2> +<h2 id="setting-up-the-toolchain-for-linux">Setting Up the Toolchain for Linux</h2> <p>The below procedure can be used to set up a Debian-based Linux system (e.g., Ubuntu). If you are running a different Linux distribution, you will need to substitute invocations of <em>apt-get</em> in the below steps with the package manager @@ -490,7 +497,7 @@ that your distro uses.</p> <p><br></p> -<h3 id="install-gdb_1">Install gdb</h3> +<h3 id="install-gdb">Install gdb</h3> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ sudo apt-get install gdb Reading package lists... Done @@ -517,9 +524,9 @@ Setting up gdb (7.7.1-0ubuntu5~14.04.2) ... <ul class="nav nav-pills" style="margin-bottom: 10px"> <li> - <a href=../../../newt/install/newt_linux/> + <a href=../../../newt/install/newt_windows/> <span class="fa fa-arrow-left"></span> - Previous: Install Newt on Linux + Previous: Install Newt on Windows </a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/6e0ec54d/develop/os/get_started/project_create/index.html ---------------------------------------------------------------------- diff --git a/develop/os/get_started/project_create/index.html b/develop/os/get_started/project_create/index.html index ee89474..3aa1740 100644 --- a/develop/os/get_started/project_create/index.html +++ b/develop/os/get_started/project_create/index.html @@ -361,24 +361,37 @@ </div> </div> - <h2 id="create-your-first-mynewt-project">Create Your First Mynewt Project</h2> -<p>This page shows how to create a Mynewt Project using the <code>newt</code> command-line tool.</p> + <h2 id="creating-your-first-mynewt-project">Creating Your First Mynewt Project</h2> +<p>This page shows you how to create a Mynewt project using the <code>newt</code> command-line tool. The project is a blinky application that toggles a pin. The application uses the Mynewt's simulated hardware and runs as a native application on Mac OS and Linux. </p> +<p><strong>Note:</strong> The Mynewt simulator is not yet supported on Windows. If you are using the native install option (not the Docker option), you will need to create the blinky application for a target board. We recommend that you read the section on creating a new project and fetching the source repository to understand the Mynewt repository structure, create a new project, and fetch the source dependencies before proceeding to one of the <a href="../../tutorials/blinky/">Blinky Tutorials</a>. </p> +<p>This guide shows you how to:</p> +<ol> +<li>Create a new project and fetch the source repository and dependecies.</li> +<li>Test the project packages (Not supported on Windows).</li> +<li>Build and run the simulated blinky application (Not supported on Windows). </li> +</ol> <p><br></p> <h3 id="prerequisites">Prerequisites</h3> <ul> <li>Have Internet connectivity to fetch remote Mynewt components.</li> -<li>Install Newt:<ul> -<li>If you have taken the native install route, see the installation instructions for <a href="../../../newt/install/newt_mac/">Mac OS</a> or for <a href="../../../newt/install/newt_linux/">Linux</a>. </li> -<li>If you have taken the Docker route, you have already installed Newt.</li> +<li>Install the newt tool: <ul> +<li>If you have taken the native install option, see the installation instructions for <a href="../../../newt/install/newt_mac/">Mac OS</a>, <a href="../../../newt/install/newt_linux/">Linux</a>, or <a href="../../../newt/install/newt_windows/">Windows</a>. </li> +<li>If you have taken the Docker option, you have already installed Newt.</li> </ul> </li> <li>Install the <a href="../native_tools/">native toolchain</a> to compile and build a Mynewt native application. </li> </ul> <p><br></p> -<h3 id="newt-new">Newt New</h3> -<p>Choose a project name. For this tutorial we will call this project <code>myproj</code>. -Enter the <code>newt new myproj</code> command. </p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt new myproj +<h3 id="creating-a-new-project-and-fetching-the-source-repository">Creating a New Project and Fetching the Source Repository</h3> +<p>This section describes how to use the newt tool to create a new project and fetch the core mynewt source repository.</p> +<p><br></p> +<h4 id="creating-a-new-project">Creating a New Project</h4> +<p>Choose a name for your project. We name the project <code>myproj</code>. </p> +<p><br> +Run the <code>newt new myproj</code> command, from your <strong>dev</strong> directory, to create a new project:</p> +<p><strong>Note:</strong> This tutorial assumes you created a <strong>dev</strong> directory under your home directory. </p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$cd ~/dev +$ newt new myproj Downloading project skeleton from apache/incubator-mynewt-blinky... Installing skeleton in myproj... Project myproj successfully created. @@ -386,9 +399,8 @@ Project myproj successfully created. <p><br></p> -<p>Newt populates this new project with a base skeleton of a new Apache Mynewt -project. It has the following structure. </p> -<p><strong>Note</strong>: If you do not have <code>tree</code>, run <code>brew install tree</code> to install on Mac OS or run <code>sudo apt-get install tree</code> to install on Linux.</p> +<p>The newt tool creates a project base directory name <strong>myproj</strong>. All newt tool commands are run from the project base directory. The newt tool populates this new project with a base skeleton of a new Apache Mynewt project in the project base directory. It has the following structure: </p> +<p><strong>Note</strong>: If you do not have <code>tree</code>, run <code>brew install tree</code> to install on Mac OS, <code>sudo apt-get install tree</code> to install on Linux, and <code>pacman -Su tree</code> from a MinGW terminal to install on Windows.</p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ cd myproj $ tree . @@ -415,24 +427,21 @@ $ tree <p><br></p> -<p>The Newt tool has installed the base files for a project comprising the following:</p> +<p>The newt tool installs the following files for a project in the project base directory:</p> <ol> <li>The file <code>project.yml</code> contains the repository list that the project uses to fetch -its packages. Your project is a collection of repositories. In this case, the project just -comprises the core mynewt repository. Later you will add more repositories -to include other mynewt components.</li> -<li>The file <code>apps/blinky/pkg.yml</code> contains the description of your application -and its package dependencies.</li> -<li>A <code>target</code> directory containing <code>my_blinky_sim</code>, a target descriptor used to -build a version of myproj. Use <code>newt target show</code> to see available build +its packages. Your project is a collection of repositories. In this case, the project only +comprises the core mynewt repository. Later, you will add more repositories to include other mynewt components.</li> +<li>The file <code>apps/blinky/pkg.yml</code> contains the description of your application and its package dependencies.</li> +<li>A <code>target</code> directory that contains the <code>my_blinky_sim</code> directory. The <code>my_blinky_sim</code> directory +a target information to build a version of myproj. Use <code>newt target show</code> to see available build targets.</li> <li>A non-buildable target called <code>unittest</code>. This is used internally by <code>newt</code> and is not a formal build target.</li> </ol> -<p><strong>NOTE:</strong> The actual code and package files are not installed -(except the template for <code>main.c</code>). See the next step for installing the packages.</p> -<p><strong>NOTE:</strong> By default newt uses the code in the master branch. This is the latest stable -code for newt. If you need to use a different branch, you can set this in the project.yml -file. </p> +<p><strong>Note:</strong> The actual code and package files are not installed (except the template for <code>main.c</code>). See the next step to install the packages.</p> +<p><br></p> +<h4 id="fetching-the-mynewt-source-repository-and-dependencies">Fetching the Mynewt Source Repository and Dependencies</h4> +<p>By default, Mynewt projects rely on a single repository: <strong>apache-mynewt-core</strong> and uses the source in the master branch. If you need to use a different branch, you need to change the <code>vers</code> value in the project.yml file: </p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">repository.apache-mynewt-core: type: github vers: 1-latest @@ -441,22 +450,18 @@ file. </p> </pre></div> -<p>Changing to 0-dev will put you on the latest master branch. <strong>This branch may not be stable and you may encounter bugs or other problems.</strong></p> -<p><br></p> -<h3 id="newt-install">Newt Install</h3> -<p>Once you've switched into your new project's directory, the next step is to fetch -any dependencies this project has. By default, all Newt projects rely on a -single remote repository, apache-mynewt-core. The <em>newt install</em> command will -fetch this repository.</p> +<p>Changing vers to 0-dev will put you on the latest master branch. <strong>This branch may not be stable and you may encounter bugs or other problems.</strong></p> +<p><br> +Run the <code>newt install</code> command, from your project base directory (myproj), to fetch the source repository and dependencies: </p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt install apache-mynewt-core </pre></div> -<p><strong>NOTE:</strong> <em>apache-mynewt-core</em> may take a while to download. To see progress, -use the <em>-v</em> (verbose) option to install. </p> +<p><strong>Note:</strong> It may take a while to download the apache-mynewt-core reposistory. Use the <em>-v</em> (verbose) option to see the installation progress.</p> <p><br></p> -<p>Once <em>newt install</em> has successfully finished, the contents of <em>apache-mynewt-core</em> will have been downloaded into your local directory. You can view them by issuing the following commands in the base directory of the new project. The actual output will depend on what is in the latest 'master' branch you have pulled from.</p> +<p>View the core of the Apache Mynewt OS that is downloaded into your local directory. </p> +<p>(The actual output will depend on what is in the latest 'master' branch)</p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ tree -L 2 repos/apache-mynewt-core/ repos/apache-mynewt-core/ @@ -568,11 +573,10 @@ repos/apache-mynewt-core/ </pre></div> -<p>As you can see, the core of the Apache Mynewt operating system has been brought -into your local directory. </p> <p><br></p> -<h3 id="test-the-projects-packages">Test the project's packages</h3> -<p>You have already built your first basic project. You can ask Newt to execute the unit tests in a package. For example, to test the <code>sys/config</code> package in the <code>apache-mynewt-core</code> repo, call newt as shown below.</p> +<h3 id="testing-the-project-packages">Testing the Project Packages</h3> +<p><strong>Note</strong>: This is not yet supported on Windows.</p> +<p>You can use the newt tool to execute the unit tests in a package. For example, run the following command to test the <code>sys/config</code> package in the <code>apache-mynewt-core</code> repo: </p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt test @apache-mynewt-core/sys/config Testing package @apache-mynewt-core/sys/config/test-fcb Compiling bootutil_misc.c @@ -606,13 +610,13 @@ All tests passed </pre></div> -<p><strong>NOTE:</strong> If you've installed the latest gcc using homebrew on your Mac, you will likely be running gcc-6. Make sure you have adjusted the compiler.yml configuration to reflect that as noted in <a href="../native_tools/">Native Install Option</a>. You can choose to downgrade to gcc-5 in order to use the default gcc compiler configuration for MyNewt.</p> -<p><strong>NOTE:</strong> If you are running the standard gcc for 64-bit machines, it does not support 32-bit. In that case you will see compilation errors. You need to install multiboot gcc (e.g. gcc-multilib if you running on a 64-bit Ubuntu).</p> +<p><strong>Note:</strong> If you installed the latest gcc using homebrew on your Mac, you are probably running gcc-6. Make sure you change the compiler.yml configuration to specify that you are using gcc-6 (See <a href="../native_tools/">Native Install Option</a>). You can also downgrade your installation to gcc-5 and use the default gcc compiler configuration for MyNewt:</p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ brew uninstall gcc-6 $ brew link gcc-5 </pre></div> +<p><strong>Note:</strong> If you are running the standard gcc for 64-bit machines, it does not support 32-bit. In that case you will see compilation errors. You need to install multilib gcc (e.g. gcc-multilib if you running on a 64-bit Ubuntu).</p> <p><br></p> <p>To test all the packages in a project, specify <code>all</code> instead of the package name.</p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt test all @@ -634,8 +638,12 @@ All tests passed <p><br></p> -<h3 id="build-the-project">Build the Project</h3> -<p>To build and run your new application, simply issue the following command:</p> +<h3 id="building-and-running-the-simulated-blinky-application">Building and Running the Simulated Blinky Application</h3> +<p>The section shows you how to build and run the blinky application to run on Mynewt's simulated hardware.</p> +<p><strong>Note</strong>: This is not yet supported on Windows. Refer to the <a href="../../tutorials/blinky/">Blinky Tutorials</a> to create a blinky application on a target boards.</p> +<p><br></p> +<h4 id="building-the-application">Building the Application</h4> +<p>To build the simulated blinky application, run <code>newt build my_blinky_sim</code>:</p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt build my_blinky_sim Building target targets/my_blinky_sim Compiling repos/apache-mynewt-core/hw/hal/src/hal_common.c @@ -657,9 +665,16 @@ Target successfully built: targets/my_blinky_sim <p><br></p> -<h3 id="run-the-project">Run the Project</h3> -<p>You can run the simulated version of your project and see the simulated LED -blink. If you are using newt docker, use <code>newt run</code> to run the simulated binary.</p> +<h4 id="running-the-blinky-application">Running the Blinky Application</h4> +<p>You can run the simulated version of your project and see the simulated LED blink. </p> +<p>If you natively install the toolchain execute the binary directly:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ ./bin/targets/my_blinky_sim/app/apps/blinky/blinky.elf +hal_gpio set pin 1 to 0 +</pre></div> + + +<p><br> +If you are using newt docker, use <code>newt run</code> to run the simulated binary.</p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt run my_blinky_sim Loading app image into slot 1 ... @@ -671,14 +686,8 @@ Reading symbols from /bin/targets/my_blinky_sim/app/apps/blinky/blinky.elf...don <p>Type <code>r</code> at the <code>(gdb)</code> prompt to run the project. You will see an output indicating that the hal_gpio pin is toggling between 1 and 0 in a simulated blink.</p> -<p>If you natively install the toolchain, you can either use <code>newt run</code> or call the binary directly. Generally, <code>newt run</code> is the expected way to call things.</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ ./bin/targets/my_blinky_sim/app/apps/blinky/blinky.elf -hal_gpio set pin 1 to 0 -</pre></div> - - <p><br></p> -<h3 id="complete">Complete</h3> +<h3 id="exploring-other-mynewt-os-features">Exploring other Mynewt OS Features</h3> <p>Congratulations, you have created your first project! The blinky application is not terribly exciting when it is run in the simulator, as there is no LED to blink. Apache Mynewt has a lot more functionality than just running simulated http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/6e0ec54d/develop/os/get_started/serial_access/index.html ---------------------------------------------------------------------- diff --git a/develop/os/get_started/serial_access/index.html b/develop/os/get_started/serial_access/index.html index ade0b64..1efa651 100644 --- a/develop/os/get_started/serial_access/index.html +++ b/develop/os/get_started/serial_access/index.html @@ -409,9 +409,17 @@ pin. Just make sure you wire Rx from the FT232H to TX on the M0 Pro, and vice-ve <p><img alt="Arduino M0 Pro Wiring" src="../pics/m0pro.png" /></p> <p><br></p> <h2 id="setup-serial-communications">Setup Serial Communications</h2> -<p>As mentioned earlier, we'll be using the built in <code>screen</code> command for this, but we'll still -need to know which serial port to connect to. So, before plugging in the FT232H Board, -check to see what USB devices are already connected:</p> +<p>You will need to know the serial port to connect to and use a terminal program to connect to the board.</p> +<h3 id="example-for-mac-os-and-linux-platforms">Example for Mac OS and Linux Platforms</h3> +<p>First check what USB devices are already connected before connecting the FT232H board to your computer. The ports are listed in the <strong>/dev</strong> directory and the format of the port name is platform dependent:</p> +<ul> +<li>Mac OS uses the format <code>tty.usbserial-<some identifier></code>. </li> +<li>Linux uses the format <code>TTYUSB<N></code>, where <code>N</code> is a number. For example, TTYUSB2.</li> +</ul> +<p><br> +This example is run on a Mac OS system. </p> +<p>Check what USB devices are already connected: +<br></p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ ls -la /dev/*usb* 0 crw-rw-rw- 1 root wheel 20, 63 Nov 23 11:13 /dev/cu.usbmodem401322 0 crw-rw-rw- 1 root wheel 20, 62 Nov 23 11:13 /dev/tty.usbmodem401322 @@ -419,7 +427,9 @@ $ </pre></div> -<p>Now, plug in the FT232H board, and run that command again:</p> +<p><br> +Plug in the FT232H board and check the ports again: +<br></p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ ls -la /dev/*usb* 0 crw-rw-rw- 1 root wheel 20, 63 Nov 23 11:13 /dev/cu.usbmodem401322 0 crw-rw-rw- 1 root wheel 20, 65 Nov 23 11:26 /dev/cu.usbserial-0020124 @@ -429,33 +439,80 @@ $ </pre></div> -<p>So the FT232H is connected to <code>/dev/tty.usbserial-0020124</code> (The number after tty.usbserial -will be different on your machine.)</p> -<p>So let's connect to it:</p> +<p><br> +The FT232H is connected to <code>/dev/tty.usbserial-0020124</code> (The number after tty.usbserial will be different on your machine.) +<br> +Use the screen command to connect to the board: +<br></p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ screen /dev/tty.usbserial-0020124 115200 </pre></div> -<p>To exit out of <code>screen</code> you'll type <code>control-A</code> followed by <code>control-\</code> and you'll +<p><br> +To exit out of <code>screen</code> you'll type <code>control-A</code> followed by <code>control-\</code> and you'll be back to a terminal prompt.</p> -<p>If you'd like to use Minicom:</p> +<p><br></p> +<p>You can also use minicom: +<br></p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ minicom -D /dev/tty.usbserial-0020124 -</pre></div> +Welcome to minicom 2.7 -<p>Welcome to minicom 2.7</p> -<p>OPTIONS: +OPTIONS: Compiled on Nov 24 2015, 16:14:21. -Port /dev/tty.usbserial-0020124, 09:57:17</p> -<p>Press Meta-Z for help on special keys -```</p> +Port /dev/tty.usbserial-0020124, 09:57:17 + +Press Meta-Z for help on special keys +</pre></div> + + +<p><br> +If there's no Mynewt app running, or the Mynewt app doesn't have the Shell and Console +enabled, you won't see anything there, but you can always refer back to this page +from later tutorials if you need to.</p> <p><br></p> +<h3 id="example-for-windows-platforms">Example for Windows Platforms</h3> +<p>First check what USB devices are already connected before connecting the FT232H board to your computer. You can locate the ports from a MinGW terminal or use the Windows Device Manager. </p> +<p>On a MinGW terminal, the ports are listed in the /dev directory and the format of the port name is <code>ttyS<N></code> where N is a number. You must map the port name to a Windows COM port: <code>/dev/ttyS<N></code> maps to <code>COM<N+1></code>. For example, <code>/dev/ttyS2</code> maps to <code>COM3</code>.</p> +<p>Check what USB devices are already connected: +<br></p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ls -l /dev/ttyS* +crw-rw-rw- 1 <user> None 117, 5 May 9 04:24 /dev/ttyS5 +$ +</pre></div> + + +<p><br> +/dev/ttyS5 maps to the Windows COM6 port. You can run Windows Device Manager to confirm:</p> +<p><br> +<img alt="Device Manager - USB Devices" src="../../../os/tutorials/pics/device_manager_no_ft232H.png" /></p> +<p><br></p> +<p>Plug in the FT232H board and check the ports again: +<br></p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ls -l /dev/ttyS* +ls -l /dev/ttyS* +crw-rw-rw- 1 <user> None 117, 10 May 9 04:55 /dev/ttyS10 +crw-rw-rw- 1 <user> None 117, 5 May 9 04:55 /dev/ttyS5 +$ +</pre></div> + + +<p><br> +The FT232H board is connected to port /dev/ttyS10 (or COM11):</p> +<p><br> +<img alt="Device Manager - FT232H" src="../../../os/tutorials/pics/device_manager_ft232H.png" /></p> +<p><br></p> +<p>We use the PuTTY terminal application to connect to the board on the COM11 port: +<br> +<img alt="PuTTY" src="../../../os/tutorials/pics/putty.png" /></p> +<p><br></p> +<p>Press Open and you should get a terminal screen titled "COM11 - PuTTY"</p> <p>If there's no Mynewt app running, or the Mynewt app doesn't have the Shell and Console enabled, you won't see anything there, but you can always refer back to this page from later tutorials if you need to.</p> +<p><br></p> <p>Now that you know how to communicate with your mynewt application, let's move on to creating one!</p> -<p><br></p> <div class="row">
