Updated Slinky tutorials for newtmgr. This closes #54
Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/7fc4a18a Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/7fc4a18a Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/7fc4a18a Branch: refs/heads/master Commit: 7fc4a18a87e64ed1cb79598f1574f91bc8ded548 Parents: 6695951 Author: aditihilbert <[email protected]> Authored: Wed Mar 16 18:51:24 2016 -0700 Committer: aditihilbert <[email protected]> Committed: Wed Mar 16 18:51:24 2016 -0700 ---------------------------------------------------------------------- docs/newtmgr/installing.md | 23 +++++++++++++++----- docs/newtmgr/project-slinky.md | 14 +++++++----- docs/newtmgr/project-target-slinky.md | 35 ++++++++++++++++++++---------- 3 files changed, 51 insertions(+), 21 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/7fc4a18a/docs/newtmgr/installing.md ---------------------------------------------------------------------- diff --git a/docs/newtmgr/installing.md b/docs/newtmgr/installing.md index 2a0e94f..8f8589d 100644 --- a/docs/newtmgr/installing.md +++ b/docs/newtmgr/installing.md @@ -5,7 +5,7 @@ This page shows you how to install newtmgr from source code. ### Install Go (golang) -If you have not already done so, install golang for your platform. +If you have not already done so, install Go for your platform. The easiest way on a MAC is to use `brew`. @@ -16,15 +16,20 @@ brew install go ==> Summary ðº /usr/local/Cellar/go/1.5.3: 5,336 files, 259.6M ``` -Alternately you can download binaries from + +<br> + +Alternatively, you can download binaries from [the golang.org site](https://golang.org/doc/install) -To test your go implementation, you can query go for its version information +To test your Go implementation, you can query Go for its version information ```no-highlight $ go version go version go1.5.3 darwin/amd64 ``` +<br> + To use go, you must set a `$GOPATH` variable in your environment. This tells go where to put all the packages it downloads, builds and runs. @@ -33,9 +38,13 @@ $ mkdir $HOME/dev $ export GOPATH=$HOME/dev/Go ``` +<br> + Its best to add this to your `.profile` so its set automatically for your environment. +<br> + ### Download the newtmgr source You will first download the source code for newt. @@ -45,6 +54,8 @@ You will first download the source code for newt. (wait a few minutes please, this sits without any indications of working) ``` +<br> + ### Building newtmgr Change into the directory where the newmgr tool was downloaded and @@ -57,11 +68,13 @@ install the newtmgr tool ... newtmgr ... ``` -Note: If the `go install` command results in errors indicating some package +<br> + +**Note:** If the `go install` command results in errors indicating some package cannot be found, do a `go get` to download all the third-party files needed from github.com and then run `go install` again. ### Add to your Path -Add your `$GOPATH/bin` directory to your path +Add your `$GOPATH/bin` directory to your path. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/7fc4a18a/docs/newtmgr/project-slinky.md ---------------------------------------------------------------------- diff --git a/docs/newtmgr/project-slinky.md b/docs/newtmgr/project-slinky.md index 71137a1..077aacc 100644 --- a/docs/newtmgr/project-slinky.md +++ b/docs/newtmgr/project-slinky.md @@ -81,7 +81,7 @@ is created. ### Run the target -* Run the executable you have build for the simulated environment. The serial port name on which the simulated target is connected is shown in the output +Run the executable you have build for the simulated environment. The serial port name on which the simulated target is connected is shown in the output when mynewt slinky starts. ```no-highlight @@ -89,10 +89,14 @@ when mynewt slinky starts. uart0 at /dev/ttys005 ``` +<br> + In this example, the slinky app opened up a com port `/dev/ttys005` -for communications with newtmgr. *NOTE: this application will block. You -will need to open a new console (or execute this in another console) to -continue the tutorial.* +for communications with newtmgr. + +**NOTE:** This application will block. You will need to open a new console (or execute this in another console) to continue the tutorial.* + +<br> ### Setting up a connection profile @@ -134,5 +138,5 @@ will echo that string back in a response to newtmgr. The response comes back as a json string. -In addition to these, uou can also examine running tasks, statistics, +In addition to these, you can also examine running tasks, statistics, logs, image status (not on sim), and configuration. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/7fc4a18a/docs/newtmgr/project-target-slinky.md ---------------------------------------------------------------------- diff --git a/docs/newtmgr/project-target-slinky.md b/docs/newtmgr/project-target-slinky.md index f66730e..e92344d 100644 --- a/docs/newtmgr/project-target-slinky.md +++ b/docs/newtmgr/project-target-slinky.md @@ -3,7 +3,7 @@ ### Objective -The goal of the project is to enable and demonstrate remote communications with the Mynewt OS via newt manager (newtmgr). We will do this through building a project with Mynewt called Slinky that runs on the STM32-E407 board. +The goal of the project is to enable and demonstrate remote communications with the Mynewt OS via newt manager (newtmgr). We will do this through a project with Mynewt called Slinky that runs on the STM32-E407 board. ### What you need @@ -26,19 +26,19 @@ The instructions assume the user is using a Bourne-compatible shell (e.g. bash o * Create a connection profile using the newtmgr tool * Use the newtmgr tool to communicate with the targets -### Installing newt +### Install newt -If you have not already installed `newt` see the +If you have not already installed `newt`, see the [newt installation instructions](../newt/tutorials/newt_mac.md) and ensure newt is installed an in your path. -### Installing newtmgr +### Install newtmgr -If you have not already installed `newtmgr` see the +If you have not already installed `newtmgr`, see the [newtmgr installation instructions](installing.md) and ensure newtmgr is installed an in your path. -### Creating a new project +### Create a new project -Instructions for creating a project are located in the [Getting Started](../os/get_started/project_create.md) section of the [Mynewt OS Manual](../os/get_started/introduction.md) +Instructions for creating a project are located in the [Getting Started](../os/get_started/project_create.md) section of the [Mynewt OS Manual](../os/get_started/introduction.md). If you already completed [sim slinky](project-slinky.md) you can skip this step. @@ -58,7 +58,9 @@ Downloading repository description for apache-mynewt-core... success! Repos successfully installed ``` -### Setting up your target builds +<br> + +### Set up your target builds Create a target for `stm32_slinky` using the native bsp. See [How to Define a Target](../newt/tutorials/define_target.md) for a detailed @@ -81,7 +83,9 @@ $ newt target set stm32_bootloader build_profile=optimized $ newt target set stm32_bootloader target.app=@apache-mynewt-core/apps/boot ``` -### Building Targets +<br> + +### Build Targets ```no-highlight $ newt build stm32_slinky @@ -108,6 +112,8 @@ App image succesfully generated: /Users/paulfdietrich/dev/slinky/bin/stm32_slink Build manifest: /Users/paulfdietrich/dev/slinky/bin/stm32_slinky/apps/slinky/manifest.json ``` +<br> + ### Using newtmgr with a remote target * First make sure the USB A-B type cable is connected to the ARM-USB-TINY-H debugger connector on the Olimex board. @@ -119,8 +125,10 @@ $ newt load stm32_bootloader $ newt load stm32_slinky ``` - You can now disconnect the debugging cable from the board. You should see the green LED blinking. If not, try powercycling the board. - +You can now disconnect the debugging cable from the board. You should see the green LED blinking. If not, try powercycling the board. + +<br> + * Now you have to set up the serial connection from your computer to the Olimex board. Locate the PC6/USART6_TX (pin#3), PC7/USART6_RX (pin#4), and GND (pin#2) of the UEXT connector on the Olimex board. More information on the UEXT connector can be found at [https://www.olimex.com/Products/Modules/UEXT/](https://www.olimex.com/Products/Modules/UEXT/). The schematic of the board can be found at [https://www.olimex.com/Products/ARM/ST/STM32-E407/resources/STM32-E407_sch.pdf](https://www.olimex.com/Products/ARM/ST/STM32-E407/resources/STM32-E407_sch.pdf) for reference.  @@ -130,6 +138,7 @@ $ newt load stm32_slinky * Connect the female TX pin of the USB-TTL serial cable to the RX of the UEXT connector on the board. * Connect the GND pin of the USB-TTL serial cable to the GND of the UEXT connector on the board. +<br> * Locate the serial connection established in the /dev directory of your computer. It should be of the type `tty.usbserial-<some identifier>`. @@ -138,6 +147,8 @@ $ newt load stm32_slinky /dev/tty.usbserial-AJ03HAQQ ``` +<br> + * You now have to define a connection profile using newtmgr. You can give it any name you want. The example below shows the connection profile being named as the very imaginative `olimex01`. ```no-highlight @@ -151,6 +162,8 @@ $ newt load stm32_slinky olimex01: type=serial, connstring='/dev/tty.usbserial-AJ03HAQQ' ``` +<br> + * Now go ahead and query the Olimex board to get responses back. The simplest command is the `echo` command to ask it to respond with the text you send it. ```no-highlight
