1) Forgot to add customize_newtmgr.md 2) Removed Jlink from prerequisites 3) Added a note to tell user not to add mgmt/imgr package to pkg.deps if not supporting OTA upgrades.
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/9ae1e664 Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/9ae1e664 Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/9ae1e664 Branch: refs/heads/develop Commit: 9ae1e664bf1508fc499757d9bc7932a80045db95 Parents: f18e165 Author: cwanda <[email protected]> Authored: Wed Jan 25 16:48:18 2017 -0800 Committer: cwanda <[email protected]> Committed: Wed Jan 25 16:48:18 2017 -0800 ---------------------------------------------------------------------- docs/os/modules/devmgmt/customize_newtmgr.md | 55 +++++++++++++++++++++++ docs/os/tutorials/add_newtmgr.md | 8 ++-- 2 files changed, 59 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9ae1e664/docs/os/modules/devmgmt/customize_newtmgr.md ---------------------------------------------------------------------- diff --git a/docs/os/modules/devmgmt/customize_newtmgr.md b/docs/os/modules/devmgmt/customize_newtmgr.md new file mode 100644 index 0000000..3678b24 --- /dev/null +++ b/docs/os/modules/devmgmt/customize_newtmgr.md @@ -0,0 +1,55 @@ +## Customizing Newt Manager Usage with mgmt + +The **mgmt** package enables you to customize Newt Manager (in either the newtmgr or oicmgr framerwork) to only process the +commands that your application uses. The newtmgr commands are divided into management groups. +A manager package implements the commands for a group. It implements the handlers that +process the commands for the group and registers the handlers with mgmt. +When newtmgr or oicmgr receives a newtmgr command, +it looks up the handler for the command (by management group id and command id) from mgmt and calls the +handler to process the command. + +The system level management groups are listed in following table: +<table style="width:90%" align="center"> +<tt> +<td>Management Group</td> +<td>newtmgr Commands</td> +<td>Package</td> +</tt> +<tr> +<td>MGMT_GROUP_ID_DEFAULT</td> +<td>```echo``` ```taskstats``` ```mpstats``` ```datetime``` ```reset```</td> +<td>mgmt/newtmgr/nmgr_os</td> +</tr> +<tr> +<td>MGMT_GROUP_ID_IMAGE</td> +<td>```image``` </td> +<td>mgmt/imgmgr</td> +</tr> +<tr> +<td>MGMT_GROUP_ID_STATS</td> +<td>```stat``` </td> +<td>sys/stats</td> +</tr> +<tr> +<td>MGMT_GROUP_ID_CONFIG</td> +<td>```config```</td> +<td>sys/config</td> +</tr> +<tr> +<td>MGMT_GROUP_ID_LOGS</td> +<td>```log```</td> +<td>sys/log</td> +</tr> +<tr> +<td>MGMT_GROUP_ID_CRASH</td> +<td>```crash```</td> +<td>test/crash_test</td> +</tr> +<tr> +<td>MGMT_GROUP_ID_RUNTEST</td> +<td>```run```</td> +<td>test/runtest</td> +</tr> +</table> +Both newtmgr and ocimgr process the MGMT_GROUP_ID_DEFAULT commands by default. You can also +use mgmt to add user defined management group commands. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9ae1e664/docs/os/tutorials/add_newtmgr.md ---------------------------------------------------------------------- diff --git a/docs/os/tutorials/add_newtmgr.md b/docs/os/tutorials/add_newtmgr.md index 4746e6a..6e69017 100644 --- a/docs/os/tutorials/add_newtmgr.md +++ b/docs/os/tutorials/add_newtmgr.md @@ -20,7 +20,7 @@ See [Other Configuration Options](#other-configuration-options) on how to custom <br> -### Pre-Requisites +### Prerequisites Ensure that you have met the following prerequisites before continuing with this tutorial: * Installed the [newt tool](../../newt/install/newt_mac.md). @@ -28,7 +28,6 @@ Ensure that you have met the following prerequisites before continuing with this * Have Internet connectivity to fetch remote Mynewt components. * Installed the [compiler tools](../get_started/native_tools.md) to support native compiling to build the project this tutorial creates. -* Installed the [Segger JLINK package]( https://www.segger.com/jlink-software.html) to load your project on the board. * Have a cable to establish a serial USB connection between the board and the laptop. <br> @@ -267,5 +266,6 @@ Notes: * When you enable Newt Manager support, using either the newtmgr or oicmgr framework, your application automatically supports the Newt Manager `echo`, `taskstats`, `mpstats`, `datetime`, and `reset` commands. These commands cannot be configured individually. -* Currently, the `mgmt/imgmgr` package does not provide a configuration setting to enable or disable support -for the `newtmgr image` command. +* The `mgmt/imgmgr` package does not provide a configuration setting to enable or disable support +for the `newtmgr image` command. Do not specify the package in the `pkg.deps` parameter if +your device has limited flash memory and cannot support Over-The-Air (OTA) firmware upgrades.
