You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by GitBox <gi...@apache.org> on 2018/01/18 03:11:17 UTC
[GitHub] aditihilbert closed pull request #744: docs: remove newtmgr from core
aditihilbert closed pull request #744: docs: remove newtmgr from core
URL: https://github.com/apache/mynewt-core/pull/744
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/docs/newtmgr/command_list/newtmgr_config.rst b/docs/newtmgr/command_list/newtmgr_config.rst
deleted file mode 100644
index 42137b821..000000000
--- a/docs/newtmgr/command_list/newtmgr_config.rst
+++ /dev/null
@@ -1,56 +0,0 @@
-newtmgr config
----------------
-
-Read and write config values on a device.
-
-Usage:
-^^^^^^
-
-.. code-block:: console
-
- newtmgr config <var-name> [var-value] -c <conn_profile> [flags]
-
-Global Flags:
-^^^^^^^^^^^^^
-
-.. code-block:: console
-
- -c, --conn string connection profile to use
- -h, --help help for newtmgr
- -l, --loglevel string log level to use (default "info")
- --name string name of target BLE device; overrides profile setting
- -t, --timeout float timeout in seconds (partial seconds allowed) (default 10)
- -r, --tries int total number of tries in case of timeout (default 1)
-
-Description
-^^^^^^^^^^^
-
-Reads and sets the value for the ``var-name`` config variable on a
-device. Specify a ``var-value`` to set the value for the ``var-name``
-variable. Newtmgr uses the ``conn_profile`` connection profile to
-connect to the device.
-
-Examples
-^^^^^^^^
-
-+----------------+--------------------------+--------------------+
-| Sub-command | Usage | Explanation |
-+================+==========================+====================+
-| newtmgr config | Reads the ``myvar`` |
-| myvar -c | config variable value |
-| profile01 | from a device. Newtmgr |
-| | connects to the device |
-| | over a connection |
-| | specified in the |
-| | ``profile01`` connection |
-| | profile. |
-+----------------+--------------------------+--------------------+
-| newtmgr config | Sets the ``myvar`` |
-| myvar 2 -c | config variable to the |
-| profile01 | value ``2`` on a device. |
-| | Newtmgr connects to the |
-| | device over a connection |
-| | specified in the |
-| | ``profile01`` connection |
-| | profile. |
-+----------------+--------------------------+--------------------+
diff --git a/docs/newtmgr/command_list/newtmgr_conn.rst b/docs/newtmgr/command_list/newtmgr_conn.rst
deleted file mode 100644
index afa8f1061..000000000
--- a/docs/newtmgr/command_list/newtmgr_conn.rst
+++ /dev/null
@@ -1,626 +0,0 @@
-newtmgr conn
--------------
-
-Manage newtmgr connection profiles.
-
-Usage:
-^^^^^^
-
-.. code-block:: console
-
- newtmgr conn [command] [flags]
-
-Flags:
-^^^^^^
-
-Global Flags:
-^^^^^^^^^^^^^
-
-.. code-block:: console
-
- -c, --conn string connection profile to use
- -l, --loglevel string log level to use (default "info")
- --name string name of target BLE device; overrides profile setting
- -t, --timeout float timeout in seconds (partial seconds allowed) (default 10)
- -r, --tries int total number of tries in case of timeout (default 1)
-
-Description
-^^^^^^^^^^^
-
-The conn command provides subcommands to add, delete, and view
-connection profiles. A connection profile specifies information on how
-to connect and communicate with a remote device. Newtmgr commands use
-the information from a connection profile to send newtmgr requests to
-remote devices.
-
-+---------------+---------------+
-| Sub-command | Explanation |
-+===============+===============+
-+---------------+---------------+
-
-add \| The newtmgr conn add <conn\_profile> <var-name=value ...> command
-creates a connection profile named ``conn_profile``. The command
-requires the ``conn_profile`` name and a list of, space separated,
-var-name=value pairs. The var-names are: ``type``, and ``connstring``.
-The valid values for each var-name parameter are:
-
-.. raw:: html
-
- <ul>
-
-.. raw:: html
-
- <li>
-
-``type``: The connection type. Valid values are:
-
-.. raw:: html
-
- <ul>
-
-.. raw:: html
-
- <li>
-
-**serial**: Newtmgr protocol over a serial connection.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-**oic\_serial**: OIC protocol over a serial connection.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-**udp**:newtmgr protocol over UDP.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-**oic\_udp**: OIC protocol over UDP.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-**ble** newtmgr protocol over BLE. This type uses native OS BLE support
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-**oic\_ble**: OIC protocol over BLE. This type uses native OS BLE
-support.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-**bhd**: newtmgr protocol over BLE. This type uses the blehostd
-implementation.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-**oic\_bhd**: OIC protocol over BLE. This type uses the blehostd
-implementation.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- </ul>
-
-\ **Note:** newtmgr does not support BLE on Windows.
-
-.. raw:: html
-
- <li>
-
-``connstring``: The physical or virtual address for the connection. The
-format of the ``connstring`` value depends on the connection ``type``
-value as follows:
-
-.. raw:: html
-
- <ul>
-
-.. raw:: html
-
- <li>
-
-**serial** and **oic\_serial**: A quoted string with two, comma
-separated, ``attribute=value`` pairs. The attribute names and value
-format for each attribute are:
-
-.. raw:: html
-
- <ul>
-
-.. raw:: html
-
- <li>
-
-``dev``: (Required) The name of the serial port to use. For example:
-**/dev/ttyUSB0** on a Linux platform or **COM1** on a Windows platform .
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-``baud``: (Optional) A number that specifies the buad rate for the
-connection. Defaults to **115200** if the attribute is not specified.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- </ul>
-
-Example: connstring="dev=/dev/ttyUSB0, baud=9600" **Note:** The 1.0
-format, which only requires a serial port name, is still supported. For
-example, ``connstring=/dev/ttyUSB0``.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-**udp** and **oic\_udp**: The peer ip address and port number that the
-newtmgr or oicmgr on the remote device is listening on. It must be of
-the form: **[<ip-address>]:<port-number>**.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-**ble** and **oic\_ble**: The format is a quoted string of, comma
-separated, ``attribute=value`` pairs. The attribute names and the value
-for each attribute are:
-
-.. raw:: html
-
- <ul>
-
-.. raw:: html
-
- <li>
-
-``peer_name``: A string that specifies the name the peer BLE device
-advertises.\ **Note**: If this attribute is specified, you do not need
-to specify a value for the ``peer_id`` attribute.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-``peer_id``: The peer BLE device address or UUID. The format depends on
-the OS that the newtmgr tool is running on:
-
-.. raw:: html
-
- <ul>
-
-.. raw:: html
-
- </li>
-
-**Linux**: 6 byte BLE address. Each byte must be a hexidecimal number
-and separated by a colon.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-**MacOS**: 128 bit UUID.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- </ul>
-
-\ **Note**: This value is only used when a peer name is not specified
-for the connection profile or with the ``--name`` flag option.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-``ctlr_name``: (Optional) Controller name. This value depends on the OS
-that the newtmgr tool is running on.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- </ul>
-
-\ **Notes**:
-
-.. raw:: html
-
- <ul>
-
-.. raw:: html
-
- <li>
-
-You must specify ``connstring=" "`` if you do not specify any attribute
-values.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-You can use the ``--name`` flag to specify a device name when you issue
-a newtmgr command that communicates with a BLE device. You can use this
-flag to override or in lieu of specifying a ``peer_name`` or ``peer_id``
-attribute in the connection profile.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- </ul>
-
-.. raw:: html
-
- <li>
-
-**bhd** and **oic\_bhd**: The format is a quoted string of, comma
-separated, ``attribute=value`` pairs. The attribute names and the value
-format for each attribute are:
-
-.. raw:: html
-
- <ul>
-
-.. raw:: html
-
- <li>
-
-``peer_name``: A string that specifies the name the peer BLE device
-advertises. \ **Note**: If this attribute is specified, you do not need
-to specify values for the ``peer_addr`` and ``peer_addr_type``
-attributes.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-``peer_addr``: A 6 byte peer BLE device address. Each byte must be a
-hexidecimal number and separated by a colon. You must also specify a
-``peer_addr_type`` value for the device address. \ **Note:** This value
-is only used when a peer name is not specified for the connection
-profile or with the ``--name`` flag option.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-``peer_addr_type``: The peer address type. Valid values are:
-
-.. raw:: html
-
- <ul>
-
-.. raw:: html
-
- <li>
-
-**public**: Public address assigned by the manufacturer.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-**random**: Static random address.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-**rpa\_pub**: Resolvable Private Address with public identity address.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-**rpa\_rnd**: Resolvable Private Address with static random identity
-address.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- </ul>
-
-\ **Note:** This value is only used when a peer name is not specified
-for the connection profile or with the ``--name`` flag option.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-``own_addr_type``: (Optional) The address type of the BLE controller for
-the host that the newtmgr tool is running on. See the ``peer_addr_type``
-attribute for valid values. Defaults to **random**.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-``ctlr_path``: The path of the port that is used to connect the BLE
-controller to the host that the newtmgr tool is running on.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- </ul>
-
- **Note**: You can use the ``--name`` flag to specify a device name when
-you issue a newtmgr command that communicates with a BLE device. You can
-use this flag to override or in lieu of specifying a ``peer_name`` or
-``peer_addr`` attribute in the connection profile.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- </ul>
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- </ul>
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- </ul>
-
-delete \| The newtmgr conn delete <conn\_profile> command deletes the
-``conn_profile`` connection profile. show \| The newtmgr conn show
-[conn\_profile] command shows the information for the ``conn_profile``
-connection profile. It shows information for all the connection profiles
-if ``conn_profile`` is not specified.
-
-Examples
-^^^^^^^^
-
-+----------------+--------------------------+--------------------+
-| Sub-command | Usage | Explanation |
-+================+==========================+====================+
-| add | newtmgr conn add | Creates a |
-| | myserial02 | connection |
-| | type=oic\_serial | profile, named |
-| | connstring=/dev/ttys002 | ``myserial02``, to |
-| | | communicate over a |
-| | | serial connection |
-| | | at 115200 baud |
-| | | rate with the |
-| | | oicmgr on a device |
-| | | that is connected |
-| | | to the host on |
-| | | port /dev/ttys002. |
-+----------------+--------------------------+--------------------+
-| add | newtmgr conn add | Creates a |
-| | myserial03 type=serial | connection |
-| | connstring="dev=/dev/tty | profile, named |
-| | s003, | ``myserial03``, to |
-| | baud=57600" | communicate over a |
-| | | serial connection |
-| | | at 57600 baud rate |
-| | | with the newtmgr |
-| | | on a device that |
-| | | is connected to |
-| | | the host on port |
-| | | /dev/ttys003. |
-+----------------+--------------------------+--------------------+
-| add | newtmgr conn add | Creates a |
-| | myudp5683 | connection |
-| | type=oic\_udpconnstring= | profile, named |
-| | [127.0.0.1]:5683 | ``myudp5683``, to |
-| | | communicate over |
-| | | UDP with the |
-| | | oicmgr on a device |
-| | | listening on |
-| | | localhost and port |
-| | | 5683. |
-+----------------+--------------------------+--------------------+
-| add | newtmgr conn add | Creates a |
-| | mybleprph type=ble | connection |
-| | connstring="peer\_name=n | profile, named |
-| | imble-bleprph" | ``mybleprph``, to |
-| | | communicate over |
-| | | BLE, using the |
-| | | native OS BLE |
-| | | support, with the |
-| | | newtmgr on a |
-| | | device named |
-| | | ``nimble-bleprph`` |
-| | | . |
-+----------------+--------------------------+--------------------+
-| add | newtmgr conn add | Creates a |
-| | mybletype=ble | connection |
-| | connstring=" " | profile, named |
-| | | ``myble``, to |
-| | | communicate over |
-| | | BLE, using the |
-| | | native OS BLE |
-| | | support, with the |
-| | | newtmgr on a |
-| | | device. You must |
-| | | use the ``--name`` |
-| | | flag to specify |
-| | | the device name |
-| | | when you issue a |
-| | | newtmgr command |
-| | | that communicates |
-| | | with the device. |
-+----------------+--------------------------+--------------------+
-| add | newtmgr conn add | Creates a |
-| | myblehostd type=oic\_bhd | connection |
-| | connstring="peer\_name=n | profile, named |
-| | imble-bleprph,ctlr\_path | ``myblehostd``, to |
-| | =/dev/cu.usbmodem14221" | communicate over |
-| | | BLE, using the |
-| | | blehostd |
-| | | implementation, |
-| | | with the oicmgr on |
-| | | a device named |
-| | | ``nimble-bleprph`` |
-| | | . |
-| | | The BLE controller |
-| | | is connected to |
-| | | the host on USB |
-| | | port |
-| | | /dev/cu.usbmodem14 |
-| | | 211 |
-| | | and uses static |
-| | | random address. |
-+----------------+--------------------------+--------------------+
-| delete | newtmgr conn delete | Deletes the |
-| | myserial02 | connection profile |
-| | | named |
-| | | ``myserial02`` |
-+----------------+--------------------------+--------------------+
-| delete | newtmgr conn delete | Deletes the |
-| | myserial02 | connection profile |
-| | | named |
-| | | ``myserial02`` |
-+----------------+--------------------------+--------------------+
-| show | newtmgr conn show | Displays the |
-| | myserial01 | information for |
-| | | the ``myserial01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-| show | newtmgr conn show | Displays the |
-| | | information for |
-| | | all connection |
-| | | profiles. |
-+----------------+--------------------------+--------------------+
diff --git a/docs/newtmgr/command_list/newtmgr_crash.rst b/docs/newtmgr/command_list/newtmgr_crash.rst
deleted file mode 100644
index 82fa01efa..000000000
--- a/docs/newtmgr/command_list/newtmgr_crash.rst
+++ /dev/null
@@ -1,55 +0,0 @@
-newtmgr crash
---------------
-
-Send a crash command to a device.
-
-Usage:
-^^^^^^
-
-.. code-block:: console
-
- newtmgr crash <assert|div0|jump0|ref0|wdog> -c <conn_profile> [flags]
-
-Global Flags:
-^^^^^^^^^^^^^
-
-.. code-block:: console
-
- -c, --conn string connection profile to use
- -h, --help help for newtmgr
- -l, --loglevel string log level to use (default "info")
- --name string name of target BLE device; overrides profile setting
- -t, --timeout float timeout in seconds (partial seconds allowed) (default 10)
- -r, --tries int total number of tries in case of timeout (default 1)
-
-Description
-^^^^^^^^^^^
-
-Sends a crash command to a device to run one of the following crash
-tests: ``div0``, ``jump0``, ``ref0``, ``assert``, ``wdog``. Newtmgr uses
-the ``conn_profile`` connection profile to connect to the device.
-
-Examples
-^^^^^^^^
-
-+----------------+--------------------------+--------------------+
-| Sub-command | Usage | Explanation |
-+================+==========================+====================+
-| newtmgr crash | Sends a request to a |
-| div0-c | device to execute a |
-| profile01 | divide by 0 test. |
-| | Newtmgr connects to the |
-| | device over a connection |
-| | specified in the |
-| | ``profile01`` connection |
-| | profile. |
-+----------------+--------------------------+--------------------+
-| newtmgr crash | Sends a request to a |
-| ref0-c | device to execute a nil |
-| profile01 | pointer reference test. |
-| | Newtmgr connects to the |
-| | device over a connection |
-| | specified in the |
-| | ``profile01`` connection |
-| | profile. |
-+----------------+--------------------------+--------------------+
diff --git a/docs/newtmgr/command_list/newtmgr_datetime.rst b/docs/newtmgr/command_list/newtmgr_datetime.rst
deleted file mode 100644
index 08504b441..000000000
--- a/docs/newtmgr/command_list/newtmgr_datetime.rst
+++ /dev/null
@@ -1,66 +0,0 @@
-newtmgr datetime
------------------
-
-Manage datetime on a device.
-
-Usage:
-^^^^^^
-
-.. code-block:: console
-
- newtmgr datetime [rfc-3339-date-string] -c <conn_profile> [flags]
-
-Global Flags:
-^^^^^^^^^^^^^
-
-.. code-block:: console
-
- -c, --conn string connection profile to use
- -h, --help help for newtmgr
- -l, --loglevel string log level to use (default "info")
- --name string name of target BLE device; overrides profile setting
- -t, --timeout float timeout in seconds (partial seconds allowed) (default 10)
- -r, --tries int total number of tries in case of timeout (default 1)
-
-Description
-^^^^^^^^^^^
-
-Reads or sets the datetime on a device. Specify a ``datetime-value`` in
-the command to set the datetime on the device. Newtmgr uses the
-``conn_profile`` connection profile to connect to the device.
-
-**Note**: You must specify the ``datetime-value`` in the RFC 3339
-format.
-
-Examples
-^^^^^^^^
-
-+----------------+--------------------------+--------------------+
-| Sub-command | Usage | Explanation |
-+================+==========================+====================+
-| newtmgr | Reads the datetime value |
-| datetime-c | from a device. Newtmgr |
-| profile01 | connects to the device |
-| | over a connection |
-| | specified in the |
-| | ``profile01`` connection |
-| | profile. |
-+----------------+--------------------------+--------------------+
-| newtmgr | Sets the datetime on a |
-| datetime | device to March 1st 2017 |
-| 2017-03-01T22: | 22:44:00 UTC. Newtmgr |
-| 44:00-c | connects to the device |
-| profile01 | over a connection |
-| | specified in the |
-| | ``profile01`` connection |
-| | profile. |
-+----------------+--------------------------+--------------------+
-| newtmgr | Sets the datetime on a |
-| datetime | device to March 1st 2017 |
-| 2017-03-01T22: | 22:44:00 PST. Newtmgr |
-| 44:00-08:00-c | connects to the device |
-| profile01 | over a connection |
-| | specified in the |
-| | ``profile01`` connection |
-| | profile. |
-+----------------+--------------------------+--------------------+
diff --git a/docs/newtmgr/command_list/newtmgr_echo.rst b/docs/newtmgr/command_list/newtmgr_echo.rst
deleted file mode 100644
index 770b52b95..000000000
--- a/docs/newtmgr/command_list/newtmgr_echo.rst
+++ /dev/null
@@ -1,45 +0,0 @@
-newtmgr echo
--------------
-
-Send data to a device and display the echoed back data.
-
-Usage:
-^^^^^^
-
-.. code-block:: console
-
- newtmgr echo <text> -c <conn_profile> [flags]
-
-Global Flags:
-^^^^^^^^^^^^^
-
-.. code-block:: console
-
- -c, --conn string connection profile to use
- -h, --help help for newtmgr
- -l, --loglevel string log level to use (default "info")
- --name string name of target BLE device; overrides profile setting
- -t, --timeout float timeout in seconds (partial seconds allowed) (default 10)
- -r, --tries int total number of tries in case of timeout (default 1)
-
-Description
-^^^^^^^^^^^
-
-Sends the ``text`` to a device and outputs the text response from the
-device. Newtmgr uses the ``conn_profile`` connection profile to connect
-to the device.
-
-Examples
-^^^^^^^^
-
-+----------------+--------------------------+--------------------+
-| Sub-command | Usage | Explanation |
-+================+==========================+====================+
-| newtmgr echo | Sends the text 'hello' |
-| hello-c | to a device and displays |
-| profile01 | the echoed back data. |
-| | Newtmgr connects to the |
-| | device over a connection |
-| | specified in the |
-| | ``profile01`` profile. |
-+----------------+--------------------------+--------------------+
diff --git a/docs/newtmgr/command_list/newtmgr_fs.rst b/docs/newtmgr/command_list/newtmgr_fs.rst
deleted file mode 100644
index cae4df2b5..000000000
--- a/docs/newtmgr/command_list/newtmgr_fs.rst
+++ /dev/null
@@ -1,87 +0,0 @@
-newtmgr fs
-----------
-
-Access files on a device.
-
-Usage:
-^^^^^^
-
-.. code-block:: console
-
- newtmgr fs [command] -c <conn_profile> [flags]
-
-Global Flags:
-^^^^^^^^^^^^^
-
-.. code-block:: console
-
- -c, --conn string connection profile to use
- -h, --help help for newtmgr
- -l, --loglevel string log level to use (default "info")
- --name string name of target BLE device; overrides profile setting
- -t, --timeout float timeout in seconds (partial seconds allowed) (default 10)
- -r, --tries int total number of tries in case of timeout (default 1)
-
-Description
-^^^^^^^^^^^
-
-The fs command provides the subcommands to download a file from and
-upload a file to a device. Newtmgr uses the ``conn_profile`` connection
-profile to connect to the device.
-
-+----------------+---------------------------+
-| Sub-command | Explanation |
-+================+===========================+
-| download | The newtmgr download |
-| | <src-filename> |
-| | <dst-filename> command |
-| | downloads the file named |
-| | <src-filename> from a |
-| | device and names it |
-| | <dst-filename> on your |
-| | host. |
-+----------------+---------------------------+
-| upload | The newtmgr upload |
-| | <src-filename> |
-| | <dst-filename> command |
-| | uploads the file named |
-| | <src-filename> to a |
-| | device and names the file |
-| | <dst-filename> on the |
-| | device. |
-+----------------+---------------------------+
-
-Examples
-^^^^^^^^
-
-+----------------+--------------------------+--------------------+
-| Sub-command | Usage | Explanation |
-+================+==========================+====================+
-| download | newtmgr fs download | Downloads the file |
-| | /cfg/mfg mfg.txt -c | name ``/cfg/mfg`` |
-| | profile01 | from a device and |
-| | | names the file |
-| | | ``mfg.txt`` on |
-| | | your host. Newtmgr |
-| | | connects to the |
-| | | device over a |
-| | | connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-| upload | newtmgr fs upload | Uploads the file |
-| | mymfg.txt /cfg/mfg -c | name ``mymfg.txt`` |
-| | profile01 | to a device and |
-| | | names the file |
-| | | ``cfg/mfg`` on the |
-| | | device. Newtmgr |
-| | | connects to the |
-| | | device over a |
-| | | connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
diff --git a/docs/newtmgr/command_list/newtmgr_image.rst b/docs/newtmgr/command_list/newtmgr_image.rst
deleted file mode 100644
index 5ff8e8e40..000000000
--- a/docs/newtmgr/command_list/newtmgr_image.rst
+++ /dev/null
@@ -1,274 +0,0 @@
-newtmgr image
---------------
-
-Manage images on a device.
-
-Usage:
-^^^^^^
-
-.. code-block:: console
-
- newtmgr image [command] -c <connection_profile> [flags]
-
-Flags:
-^^^^^^
-
-The coredownload subcommand uses the following local flags:
-
-.. code-block:: console
-
- -n, --bytes uint32 Number of bytes of the core to download
- -e, --elfify Create an ELF file
- --offset unint32 Offset of the core file to start the download
-
-Global Flags:
-^^^^^^^^^^^^^^^^^^^
-
-
-.. code-block:: console
-
- -c, --conn string connection profile to use
- -h, --help help for newtmgr
- -l, --loglevel string log level to use (default "info")
- --name string name of target BLE device; overrides profile setting
- -t, --timeout float timeout in seconds (partial seconds allowed) (default 10)
- -r, --tries int total number of tries in case of timeout (default 1)
-
-Description
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The image command provides subcommands to manage core and image files on a device. Newtmgr uses the ``conn_profile``
-connection profile to connect to the device.
-
-+----------------+---------------------------+
-| Sub-command | Explanation |
-+================+===========================+
-| confirm | The newtmgr image confirm |
-| | [hex-image-hash] command |
-| | makes an image setup |
-| | permanent on a device. If |
-| | a ``hex-image-hash`` hash |
-| | value is specified, |
-| | Mynewt permanently |
-| | switches to the image |
-| | identified by the hash |
-| | value. If a hash value is |
-| | not specified, the |
-| | current image is made |
-| | permanent. |
-+----------------+---------------------------+
-| coreconvert | The newtmgr image |
-| | coreconvert |
-| | <core-filename> |
-| | <elf-file> command |
-| | converts the |
-| | ``core-filename`` core |
-| | file to an ELF format and |
-| | names it ``elf-file``. |
-| | **Note**: This command |
-| | does not download the |
-| | core file from a device. |
-| | The core file must exist |
-| | on your host. |
-+----------------+---------------------------+
-| coredownload | The newtmgr image |
-| | coredownload |
-| | <core-filename> command |
-| | downloads the core file |
-| | from a device and names |
-| | the file |
-| | ``core-filename`` on your |
-| | host. Use the local flags |
-| | under Flags to customize |
-| | the command. |
-+----------------+---------------------------+
-| coreerase | The newtmgr image |
-| | coreerase command erases |
-| | the core file on a |
-| | device. |
-+----------------+---------------------------+
-| corelist | The newtmgr image |
-| | corelist command lists |
-| | the core(s) on a device. |
-+----------------+---------------------------+
-| erase | The newtmgr image erase |
-| | command erases an unused |
-| | image from the secondary |
-| | image slot on a device. |
-| | The image cannot be |
-| | erased if the image is a |
-| | confirmed image, is |
-| | marked for test on the |
-| | next reboot, or is an |
-| | active image for a split |
-| | image setup. |
-+----------------+---------------------------+
-| list | The newtmgr image list |
-| | command displays |
-| | information for the |
-| | images on a device. |
-+----------------+---------------------------+
-| test | The newtmgr test |
-| | <hex-image-hash> command |
-| | tests the image, |
-| | identified by the |
-| | ``hex-image-hash`` hash |
-| | value, on next reboot. |
-+----------------+---------------------------+
-| upload | The newtmgr image upload |
-| | <image-file> command |
-| | uploads the |
-| | ``image-file`` image file |
-| | to a device. |
-+----------------+---------------------------+
-
-Examples
-^^^^^^^^
-
-+----------------+--------------------------+--------------------+
-| Sub-command | Usage | Explanation |
-+================+==========================+====================+
-| confirm | newtmgr confirm-c | Makes the current |
-| | profile01 | image setup on a |
-| | | device permanent. |
-| | | Newtmgr connects |
-| | | to the device over |
-| | | a connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-| confirm | newtmgr | Makes the image, |
-| | confirmbe9699809a049...7 | identified by the |
-| | 3d77f-c | ``be9699809a049... |
-| | profile01 | 73d77f`` |
-| | | hash value, setup |
-| | | on a device |
-| | | permanent. Newtmgr |
-| | | connects to the |
-| | | device over a |
-| | | connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-| coreconvert | newtmgr image | Converts the |
-| | coreconvert mycore | ``mycore`` file to |
-| | mycore.elf | the ELF format and |
-| | | saves it in the |
-| | | ``mycore.elf`` |
-| | | file. |
-+----------------+--------------------------+--------------------+
-| coredownload | newtmgr image | Downloads the core |
-| | coredownload mycore -c | from a device and |
-| | profile01 | saves it in the |
-| | | ``mycore`` file. |
-| | | Newtmgr connects |
-| | | to the device over |
-| | | a connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-| coredownload | newtmgr image | Downloads the core |
-| | coredownload mycore -e | from a device, |
-| | -c profile01 | converts the core |
-| | | file into the ELF |
-| | | format, and saves |
-| | | it in the |
-| | | ``mycore`` file. |
-| | | Newtmgr connects |
-| | | to the device over |
-| | | a connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-| coredownload | newtmgr image | Downloads 30 |
-| | coredownload mycore | bytes, starting at |
-| | --offset 10 -n 30-c | offset 10, of the |
-| | profile01 | core from a device |
-| | | and saves it in |
-| | | the ``mycore`` |
-| | | file. Newtmgr |
-| | | connects to the |
-| | | device over a |
-| | | connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-| coreerase | newtmgr image coreerase | Erases the core |
-| | -c profile01 | file on a device. |
-| | | Newtmgr connects |
-| | | to the device over |
-| | | a connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-| corelist | newtmgr image corelist-c | Lists the core |
-| | profile01 | files on a device. |
-| | | Newtmgr connects |
-| | | to the device over |
-| | | a connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-| erase | newtmgr image erase-c | Erases the image, |
-| | profile01 | if unused, from |
-| | | the secondary |
-| | | image slot on a |
-| | | device. Newtmgr |
-| | | connects to the |
-| | | device over a |
-| | | connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-| list | newtmgr image list-c | Lists the images |
-| | profile01 | on a device. |
-| | | Newtmgr connects |
-| | | to the device over |
-| | | a connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-| test | newtmgr image test | Tests the image, |
-| | be9699809a049...73d77f | identified by the |
-| | | ``be9699809a049... |
-| | | 73d77f`` |
-| | | hash value, during |
-| | | the next reboot on |
-| | | a device. Newtmgr |
-| | | connects to the |
-| | | device over a |
-| | | connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-| upload | newtmgr image upload | Uploads the |
-| | bletiny.img-c profile01 | ``bletiny.img`` |
-| | | image to a device. |
-| | | Newtmgr connects |
-| | | to the device over |
-| | | a connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
diff --git a/docs/newtmgr/command_list/newtmgr_logs.rst b/docs/newtmgr/command_list/newtmgr_logs.rst
deleted file mode 100644
index 1eb53aba6..000000000
--- a/docs/newtmgr/command_list/newtmgr_logs.rst
+++ /dev/null
@@ -1,217 +0,0 @@
-newtmgr log
-------------
-
-Manage logs on a device.
-
-Usage:
-^^^^^^
-
-.. code-block:: console
-
- newtmgr log [command] -c <conn_profile> [flags]
-
-Global Flags:
-^^^^^^^^^^^^^
-
-.. code-block:: console
-
- -c, --conn string connection profile to use
- -h, --help help for newtmgr
- -l, --loglevel string log level to use (default "info")
- --name string name of target BLE device; overrides profile setting
- -t, --timeout float timeout in seconds (partial seconds allowed) (default 10)
- -r, --tries int total number of tries in case of timeout (default 1)
-
-Description
-^^^^^^^^^^^
-
-The log command provides subcommands to manage logs on a device. Newtmgr
-uses the ``conn_profile`` connection profile to connect to the device.
-
-+----------------+---------------------------+
-| Sub-command | Explanation |
-+================+===========================+
-| clear | The newtmgr log clear |
-| | command clears the logs |
-| | on a device. |
-+----------------+---------------------------+
-| level\_list | The newtmgr level\_list |
-| | command shows the log |
-| | levels on a device. |
-+----------------+---------------------------+
-| list | The newtmgr log list |
-| | command shows the log |
-| | names on a device. |
-+----------------+---------------------------+
-| module\_list | The newtmgr log |
-| | module\_list command |
-| | shows the log module |
-| | names on a device. |
-+----------------+---------------------------+
-
-show \| The newtmgr log show command displays logs on a device. The
-command format is: newtmgr log show [log\_name [min-index
-[min-timestamp]]] -c <conn\_profile>The following optional parameters
-can be used to filter the logs to display:
-
-.. raw:: html
-
- <ul>
-
-.. raw:: html
-
- <li>
-
-**log\_name**: Name of log to display. If log\_name is not specified,
-all logs are displayed.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-**min-index**: Minimum index of the log entries to display. This value
-is only valid when a log\_name is specified. The value can be ``last``
-or a number. If the value is ``last``, only the last log entry is
-displayed. If the value is a number, log entries with an index equal to
-or higher than min-index are displayed.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- <li>
-
-**min-timestamp**: Minimum timestamp of log entries to display. The
-value is only valid if min-index is specified and is not the value
-``last``. Only log entries with a timestamp equal to or later than
-min-timestamp are displayed. Log entries with a timestamp equal to
-min-timestamp are only displayed if the log entry index is equal to or
-higher than min-index.
-
-.. raw:: html
-
- </li>
-
-.. raw:: html
-
- </ul>
-
-Examples
-^^^^^^^^
-
-+----------------+--------------------------+--------------------+
-| Sub-command | Usage | Explanation |
-+================+==========================+====================+
-| clear | newtmgr log clear-c | Clears the logs on |
-| | profile01 | a device. Newtmgr |
-| | | connects to the |
-| | | device over a |
-| | | connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-| level\_list | newtmgr log level\_list | Shows the log |
-| | -c profile01 | levels on a |
-| | | device. Newtmgr |
-| | | connects to the |
-| | | device over a |
-| | | connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-| list | newtmgr log list-c | Shows the log |
-| | profile01 | names on a device. |
-| | | Newtmgr connects |
-| | | to the device over |
-| | | a connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-| module\_list | newtmgr log | Shows the log |
-| | module\_list-c profile01 | module names on a |
-| | | device. Newtmgr |
-| | | connects to the |
-| | | device over a |
-| | | connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-| show | newtmgr log show -c | Displays all logs |
-| | profile01 | on a device. |
-| | | Newtmgr connects |
-| | | to the device over |
-| | | a connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-| show | newtmgr log show | Displays all log |
-| | reboot\_log -c profile01 | entries for the |
-| | | reboot\_log on a |
-| | | device. Newtmgr |
-| | | connects to the |
-| | | device over a |
-| | | connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-| show | newtmgr log show | Displays the last |
-| | reboot\_log last -c | entry from the |
-| | profile01 | reboot\_log on a |
-| | | device. Newtmgr |
-| | | connects to the |
-| | | device over a |
-| | | connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-| show | newtmgr log show | Displays the |
-| | reboot\_log 2 -c | reboot\_log log |
-| | profile01 | entries with an |
-| | | index 2 and higher |
-| | | on a device. |
-| | | Newtmgr connects |
-| | | to the device over |
-| | | a connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-| show | newtmgr log show | Displays the |
-| | reboot\_log 5 123456 -c | reboot\_log log |
-| | profile01 | entries with a |
-| | | timestamp higher |
-| | | than 123456 and |
-| | | log entries with a |
-| | | timestamp equal to |
-| | | 123456 and an |
-| | | index equal to or |
-| | | higher than 5. |
-| | | Newtmgr connects |
-| | | to the device over |
-| | | a connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
diff --git a/docs/newtmgr/command_list/newtmgr_mpstats.rst b/docs/newtmgr/command_list/newtmgr_mpstats.rst
deleted file mode 100644
index 6bdf6fac9..000000000
--- a/docs/newtmgr/command_list/newtmgr_mpstats.rst
+++ /dev/null
@@ -1,76 +0,0 @@
-newtmgr mpstat
----------------
-
-Read memory pool statistics from a device.
-
-Usage:
-^^^^^^
-
-.. code-block:: console
-
- newtmgr mpstat -c <conn_profile> [flags]
-
-Global Flags:
-^^^^^^^^^^^^^
-
-.. code-block:: console
-
- -c, --conn string connection profile to use
- -h, --help help for newtmgr
- -l, --loglevel string log level to use (default "info")
- --name string name of target BLE device; overrides profile setting
- -t, --timeout float timeout in seconds (partial seconds allowed) (default 10)
- -r, --tries int total number of tries in case of timeout (default 1)
-
-Description
-^^^^^^^^^^^
-
-Reads and displays the memory pool statistics from a device. Newtmgr
-uses the ``conn_profile`` connection profile to connect to the device.
-It lists the following statistics for each memory pool:
-
-- **name**: Memory pool name
-- **blksz**: Size (number of bytes) of each memory block
-- **cnt**: Number of blocks allocated for the pool
-- **free**: Number of free blocks
-- **min**: The lowest number of free blocks that were available
-
-Examples
-^^^^^^^^
-
-+----------------+--------------------------+--------------------+
-| Sub-command | Usage | Explanation |
-+================+==========================+====================+
-| newtmgr mpstat | Reads and displays the |
-| -c profile01 | memory pool statistics |
-| | from a device. Newtmgr |
-| | connects to the device |
-| | over a connection |
-| | specified in the |
-| | ``profile01`` connection |
-| | profile. |
-+----------------+--------------------------+--------------------+
-
-Here is an example output for the ``myble`` application from the
-`Enabling Newt Manager in any app </os/tutorials/add_newtmgr.html>`__
-tutiorial:
-
-.. code-block:: console
-
- $ newtmgr mpstat -c myserial
- name blksz cnt free min
- ble_att_svr_entry_pool 20 75 0 0
- ble_att_svr_prep_entry_pool 12 64 64 64
- ble_gap_update 24 1 1 1
- ble_gattc_proc_pool 56 4 4 4
- ble_gatts_clt_cfg_pool 12 2 1 1
- ble_hci_ram_evt_hi_pool 72 2 2 1
- ble_hci_ram_evt_lo_pool 72 8 8 8
- ble_hs_conn_pool 92 1 1 1
- ble_hs_hci_ev_pool 16 10 10 9
- ble_l2cap_chan_pool 28 3 3 3
- ble_l2cap_sig_proc_pool 20 1 1 1
- bletiny_chr_pool 36 64 64 64
- bletiny_dsc_pool 28 64 64 64
- bletiny_svc_pool 36 32 32 32
- msys_1 292 12 9 6
diff --git a/docs/newtmgr/command_list/newtmgr_reset.rst b/docs/newtmgr/command_list/newtmgr_reset.rst
deleted file mode 100644
index b84cc9aa7..000000000
--- a/docs/newtmgr/command_list/newtmgr_reset.rst
+++ /dev/null
@@ -1,43 +0,0 @@
-newtmgr reset
---------------
-
-Send a reset request to a device.
-
-Usage:
-^^^^^^
-
-.. code-block:: console
-
- newtmgr reset -c <conn_profile> [flags]
-
-Global Flags:
-^^^^^^^^^^^^^
-
-.. code-block:: console
-
- -c, --conn string connection profile to use
- -h, --help help for newtmgr
- -l, --loglevel string log level to use (default "info")
- --name string name of target BLE device; overrides profile setting
- -t, --timeout float timeout in seconds (partial seconds allowed) (default 10)
- -r, --tries int total number of tries in case of timeout (default 1)
-
-Description
-^^^^^^^^^^^
-
-Resets a device. Newtmgr uses the ``conn_profile`` connection profile to
-connect to the device.
-
-Examples
-^^^^^^^^
-
-+----------------+--------------------------+--------------------+
-| Sub-command | Usage | Explanation |
-+================+==========================+====================+
-| newtmgr | Resets a device. Newtmgr |
-| reset-c | connects to the device |
-| profile01 | over a connection |
-| | specified in the |
-| | ``profile01`` connection |
-| | profile. |
-+----------------+--------------------------+--------------------+
diff --git a/docs/newtmgr/command_list/newtmgr_run.rst b/docs/newtmgr/command_list/newtmgr_run.rst
deleted file mode 100644
index 1aa58354f..000000000
--- a/docs/newtmgr/command_list/newtmgr_run.rst
+++ /dev/null
@@ -1,96 +0,0 @@
-newtmgr run
-------------
-
-Run test procedures on a device.
-
-Usage:
-^^^^^^
-
-.. code-block:: console
-
- newtmgr run [command] -c <conn_profile> [flags]
-
-Global Flags:
-^^^^^^^^^^^^^
-
-.. code-block:: console
-
- -c, --conn string connection profile to use
- -h, --help help for newtmgr
- -l, --loglevel string log level to use (default "info")
- --name string name of target BLE device; overrides profile setting
- -t, --timeout float timeout in seconds (partial seconds allowed) (default 10)
- -r, --tries int total number of tries in case of timeout (default 1)
-
-Description
-^^^^^^^^^^^
-
-The run command provides subcommands to run test procedures on a device.
-Newtmgr uses the ``conn_profile`` connection profile to connect to the
-device.
-
-+----------------+---------------------------+
-| Sub-command | Explanation |
-+================+===========================+
-| list | The newtmgr run list |
-| | command lists the |
-| | registered tests on a |
-| | device. |
-+----------------+---------------------------+
-| test | The newtmgr run test |
-| | [all\|testname] |
-| | [token-value] command |
-| | runs the ``testname`` |
-| | test or all tests on a |
-| | device. All tests are run |
-| | if ``all`` or no |
-| | ``testname`` is |
-| | specified. If a |
-| | ``token-value`` is |
-| | specified, the token |
-| | value is output with the |
-| | log messages. |
-+----------------+---------------------------+
-
-Examples
-^^^^^^^^
-
-+----------------+--------------------------+--------------------+
-| Sub-command | Usage | Explanation |
-+================+==========================+====================+
-| list | newtmgr runlist -c | Lists all the |
-| | profile01 | registered tests |
-| | | on a device. |
-| | | Newtmgr connects |
-| | | to the device over |
-| | | a connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-| test | newtmgr run test | Runs all the tests |
-| | all201612161220-c | on a device. |
-| | profile01 | Outputs the |
-| | | ``201612161220`` |
-| | | token with the log |
-| | | messages. Newtmgr |
-| | | connects to the |
-| | | device over a |
-| | | connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-| test | newtmgr run test | Runs the |
-| | mynewtsanity-c profile01 | ``mynewtsanity`` |
-| | | test on a device. |
-| | | Newtmgr connects |
-| | | to the device over |
-| | | a connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
diff --git a/docs/newtmgr/command_list/newtmgr_stat.rst b/docs/newtmgr/command_list/newtmgr_stat.rst
deleted file mode 100644
index bb98ad0ce..000000000
--- a/docs/newtmgr/command_list/newtmgr_stat.rst
+++ /dev/null
@@ -1,135 +0,0 @@
-newtmgr stat
-------------
-
-Read statistics from a device.
-
-Usage:
-^^^^^^
-
-.. code-block:: console
-
- newtmgr stat <stats_name> -c <conn_profile> [flags]
- newtmgr stat [command] -c <conn_profile> [flags]
-
-Global Flags:
-^^^^^^^^^^^^^
-
-.. code-block:: console
-
- -c, --conn string connection profile to use
- -h, --help help for newtmgr
- -l, --loglevel string log level to use (default "info")
- --name string name of target BLE device; overrides profile setting
- -t, --timeout float timeout in seconds (partial seconds allowed) (default 10)
- -r, --tries int total number of tries in case of timeout (default 1)
-
-Description
-^^^^^^^^^^^
-
-Displays statistic for the Stats named ``stats_name`` from a device. You
-can use the ``list`` subcommand to get a list of the Stats names from
-the device. Newtmgr uses the ``conn_profile`` connection profile to
-connect to the device.
-
-+----------------+--------------------------+
-| Sub-command | Explanation |
-+================+==========================+
-| The newtmgr |
-| stat command |
-| displays the |
-| statistics for |
-| the |
-| ``stats_name`` |
-| Stats from a |
-| device. |
-+----------------+--------------------------+
-| list | The newtmgr stat list |
-| | command displays the |
-| | list of Stats names from |
-| | a device. |
-+----------------+--------------------------+
-
-Examples
-^^^^^^^^
-
-+----------------+--------------------------+--------------------+
-| Sub-command | Usage | Explanation |
-+================+==========================+====================+
-| newtmgr stat | Displays the ``ble_att`` |
-| ble\_att -c | statistics on a device. |
-| profile01 | Newtmgr connects to the |
-| | device over a connection |
-| | specified in the |
-| | ``profile01`` connection |
-| | profile. |
-+----------------+--------------------------+--------------------+
-| list | newtmgr stat list -c | Displays the list |
-| | profile01 | of Stats names |
-| | | from a device. |
-| | | Newtmgr connects |
-| | | to the device over |
-| | | a connection |
-| | | specified in the |
-| | | ``profile01`` |
-| | | connection |
-| | | profile. |
-+----------------+--------------------------+--------------------+
-
-Here are some example outputs for the ``myble`` application from the
-`Enabling Newt Manager in any app </os/tutorials/add_newtmgr.html>`__
-tutiorial:
-
-The statistics for the ble\_att Stats:
-
-.. code-block:: console
-
-
- $ newtmgr stat ble_att -c myserial
- stat group: ble_att
- 0 error_rsp_rx
- 0 error_rsp_tx
- 0 exec_write_req_rx
- 0 exec_write_req_tx
- 0 exec_write_rsp_rx
- 0 exec_write_rsp_tx
- 0 find_info_req_rx
- 0 find_info_req_tx
- 0 find_info_rsp_rx
- 0 find_info_rsp_tx
- 0 find_type_value_req_rx
- 0 find_type_value_req_tx
- 0 find_type_value_rsp_rx
- 0 find_type_value_rsp_tx
-
- ...
-
- 0 read_rsp_rx
- 0 read_rsp_tx
- 0 read_type_req_rx
- 0 read_type_req_tx
- 0 read_type_rsp_rx
- 0 read_type_rsp_tx
- 0 write_cmd_rx
- 0 write_cmd_tx
- 0 write_req_rx
- 0 write_req_tx
- 0 write_rsp_rx
- 0 write_rsp_tx
-
-The list of Stats names using the list subcommand:
-
-.. code-block:: console
-
-
- $ newtmgr stat list -c myserial
- stat groups:
- ble_att
- ble_gap
- ble_gattc
- ble_gatts
- ble_hs
- ble_l2cap
- ble_ll
- ble_ll_conn
- ble_phy
- stat
diff --git a/docs/newtmgr/command_list/newtmgr_taskstats.rst b/docs/newtmgr/command_list/newtmgr_taskstats.rst
deleted file mode 100644
index ce2cb0959..000000000
--- a/docs/newtmgr/command_list/newtmgr_taskstats.rst
+++ /dev/null
@@ -1,67 +0,0 @@
-newtmgr taskstat
------------------
-
-Read task statistics from a device.
-
-Usage:
-^^^^^^
-
-.. code-block:: console
-
- newtmgr taskstat -c <conn_profile> [flags]
-
-Global Flags:
-^^^^^^^^^^^^^
-
-.. code-block:: console
-
- -c, --conn string connection profile to use
- -h, --help help for newtmgr
- -l, --loglevel string log level to use (default "info")
- --name string name of target BLE device; overrides profile setting
- -t, --timeout float timeout in seconds (partial seconds allowed) (default 10)
- -r, --tries int total number of tries in case of timeout (default 1)
-
-Description
-^^^^^^^^^^^
-
-Reads and displays the task statistics from a device. Newtmgr uses the
-``conn_profile`` connection profile to connect to the device. It lists
-the following statistics for each task:
-
-- **task**: Task name
-- **pri**: Task priority
-- **runtime**: The time (ms) that the task has been running for
-- **csw**: Number of times the task has switched context
-- **stksz**: Stack size allocated for the task
-- **stkuse**: Actual stack size the task uses
-- **last\_checkin**: Last sanity checkin with the `Sanity
- Task </os/core_os/sanity/sanity.html>`__
-- **next\_checkin**: Next sanity checkin
-
-Examples
-^^^^^^^^
-
-+----------------+--------------------------+--------------------+
-| Sub-command | Usage | Explanation |
-+================+==========================+====================+
-| newtmgr | Reads and displays the |
-| taskstat-c | task statistics from a |
-| profile0 | device. Newtmgr connects |
-| | to the device over a |
-| | connection specified in |
-| | the ``profile01`` |
-| | connection profile. |
-+----------------+--------------------------+--------------------+
-
-Here is an example output for the ``myble`` application from the
-`Enabling Newt Manager in any app </os/tutorials/add_newtmgr.html>`__
-tutiorial:
-
-.. code-block:: console
-
- $ newtmgr taskstat -c myserial
- task pri tid runtime csw stksz stkuse last_checkin next_checkin
- ble_ll 0 2 0 12 80 58 0 0
- idle 255 0 16713 95 64 31 0 0
- main 127 1 2 81 512 275 0 0
diff --git a/docs/newtmgr/install_linux.rst b/docs/newtmgr/install_linux.rst
deleted file mode 100644
index 46fd93b85..000000000
--- a/docs/newtmgr/install_linux.rst
+++ /dev/null
@@ -1,248 +0,0 @@
-Installing Newtmgr on Linux
----------------------------
-
-You can install the latest release (1.3.0) of the newtmgr tool from a
-Debian binary package (amd64). You can also download and build the
-latest release version of newtmgr from source.
-
-This page shows you how to:
-
-1. Set up your computer to download Debian binary packages from the
- runtimeco APT repository.
-
- **Note:** The key for signing the repository has changed. If you set
- up your computer before release 1.1.0, you will need to download and
- import the public key again.
-
-2. Install the latest release version of newtmgr from a Debian binary
- package. You can use apt-get to install the package or manually
- download and install the Debian binary package.
-
-3. Download, build, and install the latest release version of newtmgr
- from source.
-
-See `Installing Previous Releases of Newtgmr </newtmgr/prev_releases>`__
-to install an earlier version of newtmgr.
-
-If you are installing on an amd64 platform, we recommend that you
-install from the binary package.
-
-**Note:** We have tested the newtmgr tool binary and apt-get install
-from the runtimeco APT repository for Ubuntu version 16. Earlier Ubuntu
-versions (for example: Ubuntu 14) may have incompatibility with the
-repository. You can manually download and install the Debian binary
-package.
-
-**Note:** See :doc:`Setting Up a Go Environment to Contribute to Newt and
-Newtmgr Tools </misc/go_env>` if you want to:
-
-- 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.
-- Contribute to the newtmgr tool.
-
-Setting Up Your Computer to use apt-get to Install the Package
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The newtmgr Debian packages are stored in a private APT repository on
-**https://github/runtimeco/debian-mynewt**. To use apt-get, you must set
-up the following on your computer to retrieve packages from the
-repository:
-
-**Note**: You only need to perform this setup once on your computer.
-However, if you previously downloaded and imported the public key for
-the runtimeco APT repository, you will need to perform step 2 again as
-the key has changed.
-
-1. Install the ``apt-transport-https`` package to use HTTPS to retrieve
- packages.
-2. Download the public key for the runtimeco APT repository and import
- the key into the apt keychain.
-3. Add the repository for the binary and source packages to the apt
- source list.
-
-1. Install the apt-transport-https package:
-
-.. code-block:: console
-
- $sudo apt-get update
- $sudo apt-get install apt-transport-https
-
-2. Download the public key for the runtimeco apt repo (**Note:** There
-is a ``-`` after ``apt-key add``):
-
-.. code-block:: console
-
- wget -qO - https://raw.githubusercontent.com/runtimeco/debian-mynewt/master/mynewt.gpg.key | sudo apt-key add -
-
-3. Add the repository for the binary packages to the ``mynewt.list``
-apt source list file.
-
-.. code-block:: console
-
- $sudo -s
- [sudo] password for <user>:
- root$ cat > /etc/apt/sources.list.d/mynewt.list <<EOF
- deb https://raw.githubusercontent.com/runtimeco/debian-mynewt/master latest main
- EOF
- root$exit
-
-**Note:** Do not forget to exit the root shell.
-
-4. Verify the content of the source list file:
-
-.. code-block:: console
-
- $more /etc/apt/sources.list.d/mynewt.list
- deb https://raw.githubusercontent.com/runtimeco/debian-mynewt/master latest main
-
-5. Update the available packages:
-
-.. code-block:: console
-
- $sudo apt-get update
-
- **Note:** If you are not using Ubuntu version 16, you may see the
-following errors. We have provided instructions on how to manually
-download and install the binary package.
-
-.. code-block:: console
-
-
- W: Failed to fetch https://raw.githubusercontent.com/runtimeco/debian-mynewt/master/dists/latest/main/source/Sources Ht
- tpError404
-
-Installing the Latest Release of Newtmgr from a Binary Package
-~~~~~~~~~~~~~~~
-
-
-You can use either apt-get to install the package, or manually download
-and install the Debian binary package.
-
-Method 1: Using apt-get to Upgrade or to Install
-^^^^^^^^^^^^^^^^^^^
-
-
-Run the following commands to upgrade or install the latest version of
-newtmgr:
-
-.. code-block:: console
-
-
- $ sudo apt-get update
- $ sudo apt-get install newtmgr
-
-Method 2: Downloading and Installing the Debian Package Manually
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Download and install the package manually.
-
-.. code-block:: console
-
- $wget https://raw.githubusercontent.com/runtimeco/debian-mynewt/master/pool/main/n/newtmgr/newtmgr_1.3.0-1_amd64.deb
- $sudo dpkg -i newtmgr_1.3.0-1_amd64.deb
-
-See `Checking the Installed Version of Newtmgr <#check>`__ to verify
-that you are using the installed version of newtmgr.
-
-Installing the Latest Release Version of Newtmgr from Source
-~~~~~~~~~~~~~~~
-
-
-If you are running Linux on a different architecture, you can build and
-install the latest release version of newtmgr from source.
-
-1. Download and install the latest version of
-`Go <https://golang.org/dl/>`__. Newtmgr requires Go version 1.7.6 or
-higher.
-
-2. Create a Go workspace in the /tmp directory:
-
-.. code-block:: console
-
-
- $ cd /tmp
- $ mkdir go
- $ cd go
- $ export GOPATH=/tmp/go
-
-3. Run ``go get`` to download the newtmgr source. Note that ``go get``
-pulls down the HEAD from the master branch in git, builds, and installs
-newtmgr.
-
-.. code-block:: console
-
-
- $ go get mynewt.apache.org/newtmgr/newtmgr
- $ ls -l /tmp/go/bin/newtmgr
- -rwxr-xr-x 1 user staff 17884488 Jul 29 16:25 /tmp/go/bin/newtmgr
-
-4. Check out the source from the latest release version:
-
-.. code-block:: console
-
-
- $ cd src/mynewt.apache.org/newtmgr
- $ git checkout mynewt_1_3_0_tag
- Note: checking out 'mynewt_1_3_0_tag'.
-
-5. Build newtmgr from the latest release version:
-
-.. code-block:: console
-
-
- $ cd newtmgr
- $ go install
- $ ls /tmp/go/bin/newtmgr
- -rwxr-xr-x 1 user staff 17888680 Jul 29 16:28 /tmp/go/bin/newtmgr
-
-6. If you have a Go workspace, remember to reset your GOPATH to your Go
-workspace.
-
-7. Copy the newtmgr executable to a bin directory in your path. You can
-put it in the /usr/bin or the $GOPATH/bin directory.
-
-Checking the Latest Version of Newtmgr is Installed
-~~~~~~~~~~~~~~~
-
-
-1. Run ``which newtmgr`` to verify that you are using the installed
-version of newtmgr.
-
-2. Get information about the newtmgr tool:
-
-.. code-block:: console
-
-
- $newtmgr
- Newtmgr helps you manage remote devices running the Mynewt OS
-
- Usage:
- newtmgr [flags]
- newtmgr [command]
-
- Available Commands:
- config Read or write a config value on a device
- conn Manage newtmgr connection profiles
- crash Send a crash command to a device
- datetime Manage datetime on a device
- echo Send data to a device and display the echoed back data
- fs Access files on a device
- help Help about any command
- image Manage images on a device
- log Manage logs on a device
- mpstat Read mempool statistics from a device
- reset Perform a soft reset of a device
- run Run test procedures on a device
- stat Read statistics from a device
- taskstat Read task statistics from a device
-
- Flags:
- -c, --conn string connection profile to use
- -h, --help help for newtmgr
- -l, --loglevel string log level to use (default "info")
- --name string name of target BLE device; overrides profile setting
- -t, --timeout float timeout in seconds (partial seconds allowed) (default 10)
- -r, --tries int total number of tries in case of timeout (default 1)
-
- Use "newtmgr [command] --help" for more information about a command.
diff --git a/docs/newtmgr/install_mac.rst b/docs/newtmgr/install_mac.rst
deleted file mode 100644
index 09b4a45e9..000000000
--- a/docs/newtmgr/install_mac.rst
+++ /dev/null
@@ -1,176 +0,0 @@
-Installing Newtmgr on Mac OS
-----------------------------
-
-Newtmgr is supported on Mac OS X 64 bit platforms and has been tested on
-Mac OS 10.11 and higher.
-
-This page shows you how to install the following versions of newtmgr:
-
-- Upgrade to or install the latest release version (1.3.0).
-- Install the latest from the master branch (unstable).
-
-See `Installing Previous Releases of Newtmgr </newtmgr/prev_releases>`__
-to install an earlier version of newtmgr.
-
-**Note:** If you would like to contribute to the newtmgr tool, see
-:doc:`Setting Up Go Environment to Contribute to Newt and Newtmgr
-Tools </misc/go_env>`.
-
-Adding the Mynewt Homebrew Tap
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-You should have added the **runtimeco/homebrew-mynewt** tap when you
-installed the **newt** tool. Run the following commands if you have not
-done so:
-
-.. code-block:: console
-
-
- $ brew tap runtimeco/homebrew-mynewt
- $ brew update
-
-Upgrading to or Installing the Latest Release Version
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Perform the following to upgrade or install the latest release version
-of newtmgr.
-
-Upgrading to the Latest Release Version of Newtmgr
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-If you have installed an earlier version of newtmgr using brew, run the
-following commands to upgrade to the latest version of newtmgr:
-
-.. code-block:: console
-
-
- $ brew update
- $ brew upgrade mynewt-newtmgr
-
-Installing the Latest Release Version of Newtmgr
-^^^^^^^^^^^^^^^^^^^
-
-
-Run the following command to install the latest release version of
-newtmgr:
-
-.. code-block:: console
-
-
- $ brew update
- $ brew install mynewt-newtmgr
- ==> Installing mynewt-newtmgr from runtimeco/mynewt
- ==> Downloading https://github.com/runtimeco/binary-releases/raw/master/mynewt-newt-tools_1.3.0/mynewt-newtmgr-1.3.0.sierra.bottle.tar.gz
- ==> Downloading from https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.3.0/mynewt-newtmgr-1.3.0.sierra.bottle.tar.gz
- ######################################################################## 100.0%
- ==> Pouring mynewt-newtmgr-1.3.0.sierra.bottle.tar.gz
- ? /usr/local/Cellar/mynewt-newtmgr/1.3.0: 3 files, 17.3MB
-
- **Notes:** Homebrew bottles for newtmgr 1.3.0 are available for Mac OS
-Sierra, El Captian. If you are running an earlier version of Mac OS, the
-installation will install the latest version of Go and compile newtmgr
-locally.
-
-Checking the Installed Version
-~~~~~~~~~~~~~~~
-
-
-Check that you are using the installed version of newtmgr:
-
-.. code-block:: console
-
- $which newtmgr
- /usr/local/bin/newtmgr
- ls -l /usr/local/bin/newtmgr
- lrwxr-xr-x 1 user staff 42 Sep 11 21:15 /usr/local/bin/newtmgr -> ../Cellar/mynewt-newtmgr/1.3.0/bin/newtmgr
-
-**Note:** If you previously built newtmgr from source and the output of
-``which newtmgr`` shows
-":math:`GOPATH/bin/newtmgr", you will need to move "`\ GOPATH/bin" after
-"/usr/local/bin" for your PATH in ~/.bash\_profile, and source
-~/.bash\_profile.
-
-Get information about newtmgr:
-
-.. code-block:: console
-
-
- $ newtmgr help
- Usage:
- newtmgr [flags]
- newtmgr [command]
-
- Available Commands:
- config Read or write a config value on a device
- conn Manage newtmgr connection profiles
- crash Send a crash command to a device
- datetime Manage datetime on a device
- echo Send data to a device and display the echoed back data
- fs Access files on a device
- help Help about any command
- image Manage images on a device
- log Manage logs on a device
- mpstat Read mempool statistics from a device
- reset Perform a soft reset of a device
- run Run test procedures on a device
- stat Read statistics from a device
- taskstat Read task statistics from a device
-
- Flags:
- -c, --conn string connection profile to use
- -h, --help help for newtmgr
- -l, --loglevel string log level to use (default "info")
- --name string name of target BLE device; overrides profile setting
- -t, --timeout float timeout in seconds (partial seconds allowed) (default 10)
- -r, --tries int total number of tries in case of timeout (default 1)
-
- Use "newtmgr [command] --help" for more information about a command.
-
-Installing Newtmgr from the Master Branch
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-We recommend that you use the latest release version of newtmgr. If you
-would like to use the master branch with the latest updates, you can
-install newtmgr from the HEAD of the master branch.
-
-\*\* Notes: \*\*
-
-- The master branch may be unstable.
-- This installation will install the latest version of Go on your
- computer, if it is not installed, and compile newtmgr locally.
-
-If you already installed newtgmr, unlink the current version:
-
-.. code-block:: console
-
- $brew unlink mynewt-newtmgr
-
-Install the latest unstable version of newtmgr from the master branch:
-
-.. code-block:: console
-
- $brew install mynewt-newtmgr --HEAD
- ==> Installing mynewt-newtmgr from runtimeco/mynewt
- ==> Cloning https://github.com/apache/mynewt-newtmgr.git
- Cloning into '/Users/wanda/Library/Caches/Homebrew/mynewt-newtmgr--git'...
- remote: Counting objects: 2169, done.
- remote: Compressing objects: 100% (1752/1752), done.
- remote: Total 2169 (delta 379), reused 2042 (delta 342), pack-reused 0
- Receiving objects: 100% (2169/2169), 8.13 MiB | 5.47 MiB/s, done.
- Resolving deltas: 100% (379/379), done.
- ==> Checking out branch master
- ==> go get github.com/currantlabs/ble
- ==> go get github.com/raff/goble
- ==> go get github.com/mgutz/logxi/v1
- ==> go install
- ? /usr/local/Cellar/mynewt-newtmgr/HEAD-2d5217f: 3 files, 17.3MB, built in 1 minute 10 seconds
-
-To switch back to the latest stable release version of newtmgr, you can
-run:
-
-.. code-block:: console
-
- $brew switch mynewt-newtmgr 1.3.0
- Cleaning /usr/local/Cellar/mynewt-newtmgr/1.3.0
- Cleaning /usr/local/Cellar/mynewt-newtmgr/HEAD-2d5217f
- 1 links created for /usr/local/Cellar/mynewt-newtmgr/1.3.0
diff --git a/docs/newtmgr/install_windows.rst b/docs/newtmgr/install_windows.rst
deleted file mode 100644
index e7954e513..000000000
--- a/docs/newtmgr/install_windows.rst
+++ /dev/null
@@ -1,169 +0,0 @@
-Installing Newtmgr on Windows
------------------------------
-
-This guide shows you how to install the latest release of newtmgr from
-binary or from source. The tool is written in Go (golang).
-
-It assumes that you have already installed the `newt tool on
-Windows </newt/install/newt_windows/>`__ and have the Windows
-development environment set up.
-
-This guide shows you how to perform the following:
-
-1. Install latest release of newtmgr from binary.
-2. Install latest release of newtmgr from source.
-
-See `Installing Previous Releases of Newtmgr </newtmgr/prev_releases>`__
-to install an earlier version of newtgmr.
-
-**Note:** If you would like to contribute to the newtmgr tool, see
-:doc:`Setting Up Go Environment to Contribute to Newt and Newtmgr
-Tools </misc/go_env>`.
-
-Installing the Latest Release of Newtmgr Tool from Binary
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-You can install the latest release of newtmgr from binary. It has been
-tested on Windows 10 64 bit platform.
-
-1. Start a MinGW terminal.
-
-2. Download the newtmgr binary tar file:
-
-.. code-block:: console
-
-
- $ wget -P /tmp https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.3.0/newtmgr_1_3_0_windows_amd64.tar.gz
-
-3. Extract the file:
-
-- If you previously built newtmgr from the master branch, you can
- extract the file into your $GOPATH/bin directory. Note: This
- overwrites the current newtmgr.exe in the directory and assumes that
- you are using $GOPATH/bin for your Go applications.
-
- ::
-
- tar -xzf /tmp/newtmgr_1_3_0_windows_amd64.tar.gz -C $GOPATH/bin
-
-- If you are installing newtmgr for the first time and do not have Go
- setup, you can extract into /usr/bin directory:
-
- ::
-
- tar -xzf /tmp/newtmgr_1_3_0_windows_amd64.tar.gz -C /usr/bin
-
-4. Verify the installed version of newtmgr. See `Checking the Installed
-Version <#check_newtmgr>`__.
-
-Installing the Latest Release of Newtmgr from Source
-~~~~~~~~~~~~~~~
-
-
-If you have an older version of Windows or a 32 bit platform, you can
-build and install the latest release version of newtmgr from source.
-
-1. Download and install the latest version of
-`Go <https://golang.org/dl/>`__. Newtmgr requires Go version 1.7.6 or
-higher.
-
-2. Start MinGW terminal.
-
-3. Create a Go workspace in the /tmp directory:
-
-.. code-block:: console
-
-
- $ cd /tmp
- $ mkdir go
- $ cd go
- $ export GOPATH=/tmp/go
-
-4. Run ``go get`` to download the newtmgr source. Note that ``go get``
-pulls down the HEAD from the master branch in git, builds, and installs
-newtmgr.
-
-.. code-block:: console
-
-
- $ go get mynewt.apache.org/newtmgr/newtmgr
-
-**Note** If you get the following error, you may ignore it as we will
-rebuild newtmgr from the latest release version of newtmgr in the next
-step:
-
-.. code-block:: console
-
-
- # github.com/currantlabs/ble/examples/lib/dev
- ..\..\..\github.com\currantlabs\ble\examples\lib\dev\dev.go:7: undefined: DefaultDevice
-
-5. Check out the source from the latest release version:
-
-.. code-block:: console
-
-
- $ cd src/mynewt.apache.org/newtmgr
- $ git checkout mynewt_1_3_0_tag
- Note: checking out 'mynewt_1_3_0_tag'.
-
-6. Build newtmgr from the latest release version:
-
-.. code-block:: console
-
-
- $ cd newtmgr
- $ go install
- $ ls /tmp/go/bin/newtmgr.exe
- -rwxr-xr-x 1 user None 15457280 Sep 12 00:30 /tmp/go/bin/newtmgr.exe
-
-7. If you have a Go workspace, remember to reset your GOPATH to your Go
-workspace.
-
-7. Copy the newtmgr executable to a bin directory in your path. You can
-put it in the /usr/bin or the $GOPATH/bin directory.
-
-Checking the Installed Version
-~~~~~~~~~~~~~~~
-
-
-1. Run ``which newtmgr`` to verify that you are using the installed
-version of newtmgr.
-
-2. Get information about the newtmgr tool:
-
-.. code-block:: console
-
-
- $newtmgr
- Newtmgr helps you manage remote devices running the Mynewt OS
-
- Usage:
- newtmgr [flags]
- newtmgr [command]
-
- Available Commands:
- config Read or write a config value on a device
- conn Manage newtmgr connection profiles
- crash Send a crash command to a device
- datetime Manage datetime on a device
- echo Send data to a device and display the echoed back data
- fs Access files on a device
- help Help about any command
- image Manage images on a device
- log Manage logs on a device
- mpstat Read mempool statistics from a device
- reset Perform a soft reset of a device
- run Run test procedures on a device
- stat Read statistics from a device
- taskstat Read task statistics from a device
-
- Flags:
- -c, --conn string connection profile to use
- -h, --help help for newtmgr
- -l, --loglevel string log level to use (default "info")
- --name string name of target BLE device; overrides profile setting
- -t, --timeout float timeout in seconds (partial seconds allowed) (default 10)
- -r, --tries int total number of tries in case of timeout (default 1)
-
- Use "newtmgr [command] --help" for more information about a command.
diff --git a/docs/newtmgr/overview.rst b/docs/newtmgr/overview.rst
deleted file mode 100644
index 026b64501..000000000
--- a/docs/newtmgr/overview.rst
+++ /dev/null
@@ -1,42 +0,0 @@
-Newt Manager
-------------
-
-Newt Manager (newtmgr) is the application tool that enables a user to
-communicate with and manage remote devices running the Mynewt OS. It
-uses a connection profile to establish a connection with a device and
-sends command requests to the device. The tool follows the same command
-structure as the `newt tool <../newt/newt_ops.html>`__.
-
-Available high-level commands
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The following are the high-level newtmgr commands. Some of these
-commands have subcommands. You can use the -h flag to get help for each
-command. See the documentation for each command in this guide if you
-need more information and examples.
-
-.. code-block:: console
-
- Available Commands:
- config Read or write a config value on a device
- conn Manage newtmgr connection profiles
- crash Send a crash command to a device
- datetime Manage datetime on a device
- echo Send data to a device and display the echoed back data
- fs Access files on a device
- help Help about any command
- image Manage images on a device
- log Manage logs on a device
- mpstat Read mempool statistics from a device
- reset Perform a soft reset of a device
- run Run test procedures on a device
- stat Read statistics from a device
- taskstat Read task statistics from a device
-
- Flags:
- -c, --conn string connection profile to use
- -h, --help help for newtmgr
- -l, --loglevel string log level to use (default "info")
- --name string name of target BLE device; overrides profile setting
- -t, --timeout float timeout in seconds (partial seconds allowed) (default 10)
- -r, --tries int total number of tries in case of timeout (default 1)
diff --git a/docs/newtmgr/prev_releases.rst b/docs/newtmgr/prev_releases.rst
deleted file mode 100644
index 6b9b19c42..000000000
--- a/docs/newtmgr/prev_releases.rst
+++ /dev/null
@@ -1,93 +0,0 @@
-Installing Previous Releases of Newtmgr
----------------------------------------
-
-This page shows you how to install previous releases of newtmgr for Mac
-OS, Linux, and Windows.
-
-Mac OS
-~~~~~~
-
-You can install previous releases of newtmgr using
-``mynewt-newtmgr@X.Y`` Homebrew formulas, where X.Y is a version number.
-
-For example, if you want to install newtmgr 1.0, run the following
-commands:
-
-.. code-block:: console
-
-
- $ brew update
- $ brew install mynewt-newtmgr@1.0
-
-**Note:** This is a keg-only installation. newtgmr 1.0 is installed in
-/usr/local/Cellar/mynewt-newtmgr@1.0/1.0.0/bin but not symlinked into
-/usr/local/bin.
-
-If you need this version of newtmgr first in your PATH, run the
-following commands:
-
-.. code-block:: console
-
-
- $ echo 'export PATH=/usr/local/Cellar/mynewt-newtmgr@1.0/1.0.0/bin:$PATH' >> ~/.bash_profile
- $ source ~/.bash_profile
-
-You can also manually symlink into /usr/local/bin as follows:
-
-1. Unlink newtmgr if you have the latest version of newtmgr installed:
-
-.. code-block:: console
-
- $ brew unlink mynewt-newtmgr
-
-2. Link mynewt-newt@1.0 into /usr/local/bin:
-
-.. code-block:: console
-
- $ brew link -f mynewt-newtmgr@1.0
-
-Linux 1. Download the binary:
-~~~~~~~~~~~~~~~
-
-
-+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Version | Download |
-+===========+==========================================================================================================================================================+
-| 1.0.0 | `newtmgr\_1.0.0-1\_amd64.deb <https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.0.0/newtmgr_1.0.0-1_amd64.deb>`__ |
-+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 1.1.0 | `newtmgr\_1.1.0-1\_amd64.deb <https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.1.0/newtmgr_1.1.0-1_amd64.deb>`__ |
-+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-2. Run the ``sudo apt-get remove newtmgr`` command to remove the the
-current installation.
-
-3. Install the package. For example, run
-``sudo dpkg -i newtmgr_1.0.0-1_amd64.deb`` to install newtmgr 1.0.0
-
-Windows 1. Download the binary:
-~~~~~~~~~~~~~~~
-
-
-+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Version | Download |
-+===========+======================================================================================================================================================================+
-| 1.1.0 | `newtmgr\_1\_1\_0\_windows\_amd64.tar.gz <https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.1.0/newtmgr_1.1.0-1_amd64.deb>`__ |
-+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-2. Extract the file:
-
-- If you previously built newtmgr from the master branch, you can
- extract the file into your $GOPATH/bin directory. Note: This
- overwrites the current newtmgr.exe in the directory and assumes that
- you are using $GOPATH/bin for your Go applications.
-
- ::
-
- tar -xzf newtmgr_1_1_0_windows_amd64.tar.gz -C $GOPATH/bin
-
-- If you are installing newtmgr for the first time and do not have a Go
- workspace setup, you can extract into /usr/bin directory:
-
- ::
-
- tar -xzf newtmgr_1_1_0_windows_amd64.tar.gz -C /usr/bin
diff --git a/docs/newtmgr/protocol.rst b/docs/newtmgr/protocol.rst
deleted file mode 100644
index c2ae2a7ac..000000000
--- a/docs/newtmgr/protocol.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-Newt Manager Protocol
----------------------
-
-.. raw:: html
-
- <synopsis>
-
-Description
------------
-
-How it works
-------------
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services