This closes #162. newtmgr command list update
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/404f42d1 Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/404f42d1 Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/404f42d1 Branch: refs/heads/master Commit: 404f42d1dc4076b8e87b4e16022bbf1445c42164 Parents: 17287ac Author: aditihilbert <[email protected]> Authored: Fri Mar 17 14:27:17 2017 -0700 Committer: aditihilbert <[email protected]> Committed: Fri Mar 17 14:27:17 2017 -0700 ---------------------------------------------------------------------- docs/newtmgr/command_list/newtmgr_config.md | 28 +++++++ docs/newtmgr/command_list/newtmgr_conn.md | 36 +++++++++ docs/newtmgr/command_list/newtmgr_crash.md | 28 +++++++ docs/newtmgr/command_list/newtmgr_datetime.md | 30 ++++++++ docs/newtmgr/command_list/newtmgr_echo.md | 26 +++++++ docs/newtmgr/command_list/newtmgr_fs.md | 32 ++++++++ docs/newtmgr/command_list/newtmgr_image.md | 56 ++++++++++++++ docs/newtmgr/command_list/newtmgr_logs.md | 39 ++++++++++ docs/newtmgr/command_list/newtmgr_mpstats.md | 56 ++++++++++++++ docs/newtmgr/command_list/newtmgr_reset.md | 26 +++++++ docs/newtmgr/command_list/newtmgr_run.md | 33 +++++++++ docs/newtmgr/command_list/newtmgr_stat.md | 82 +++++++++++++++++++++ docs/newtmgr/command_list/newtmgr_taskstats.md | 47 ++++++++++++ 13 files changed, 519 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/404f42d1/docs/newtmgr/command_list/newtmgr_config.md ---------------------------------------------------------------------- diff --git a/docs/newtmgr/command_list/newtmgr_config.md b/docs/newtmgr/command_list/newtmgr_config.md new file mode 100644 index 0000000..e3cbec2 --- /dev/null +++ b/docs/newtmgr/command_list/newtmgr_config.md @@ -0,0 +1,28 @@ +## <font color="#F2853F" style="font-size:24pt">newtmgr config </font> +Read and write config values on a device. + +#### Usage: + +```no-highlight + newtmgr config <var-name> [var-value] -c <conn_profile> [flags] +``` + +#### Global Flags: + +```no-highlight + -c, --conn string connection profile to use. + -h, --help Help for newtmgr commands + -l, --loglevel string log level to use (default "info") + -t, --trace print all bytes transmitted and received +``` + +####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 myvar -c profile01 | Reads the `myvar` config variable value from a device. Newtmgr connects to the device over a connection specified in the `profile01` connection profile. + | newtmgr config myvar 2 -c profile01 | Sets the `myvar` config variable to the value `2` on a device. Newtmgr connects to the device over a connection specified in the `profile01` connection profile. + http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/404f42d1/docs/newtmgr/command_list/newtmgr_conn.md ---------------------------------------------------------------------- diff --git a/docs/newtmgr/command_list/newtmgr_conn.md b/docs/newtmgr/command_list/newtmgr_conn.md new file mode 100644 index 0000000..7f7e5f7 --- /dev/null +++ b/docs/newtmgr/command_list/newtmgr_conn.md @@ -0,0 +1,36 @@ +## <font color="#F2853F" style="font-size:24pt">newtmgr conn </font> +Manage newtmgr connection profiles. + +#### Usage: + +```no-highlight + newtmgr conn [command] [flags] +``` + +#### Global Flags: + +```no-highlight + -c, --conn string connection profile to use. + -h, --help Help for newtmgr commands + -l, --loglevel string log level to use (default "info") + -t, --trace print all bytes transmitted and received +``` + +####Description +The conn command provides subcommands to add, delete, and view configuration profiles. + +Sub-command | Explanation +-------------| ------------------------ +add | The newtmgr conn add <conn_profile> <var-name=var-value> command creates a connection profile named `conn_profile`. A profile consists of these variables: <ul><li>`name`: Connection name. Defaults to `conn_profile` when the variable is not set in the command. </li><li>`type`: Connection type. Valid types are: `serial`, `oic_serial`, `ble`, `oic_ble`, `udp`, `oic_udp`.</li><li>`connstring`: The physical or virtual port to use for the connection.</li><li>`addrtype`: Device address type. Use with type `ble`.</li><li>`addr`: Device address. Use with type `ble`.</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 myserial02 type=serial connstring=/dev/ttys002 | Creates a connection profile for the serial port /dev/ttys002 and names it `myserial02` +delete | newtmgr conn delete myserial02 | Deletes the connection profile named `myserial02` +show | newtmgr conn show myserial01 | Displays the information for the `myserial01` connection profile. +show | newtmgr conn show | Displays the information for all connection profiles. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/404f42d1/docs/newtmgr/command_list/newtmgr_crash.md ---------------------------------------------------------------------- diff --git a/docs/newtmgr/command_list/newtmgr_crash.md b/docs/newtmgr/command_list/newtmgr_crash.md new file mode 100644 index 0000000..c51ec2e --- /dev/null +++ b/docs/newtmgr/command_list/newtmgr_crash.md @@ -0,0 +1,28 @@ +## <font color="#F2853F" style="font-size:24pt">newtmgr crash </font> +Send a crash command to a device. + + +#### Usage: + +```no-highlight + newtmgr crash <div0|jump0|ref0|assert|wdog> -c <conn_profile>; [flags] +``` + +#### Global Flags: + +```no-highlight + -c, --conn string connection profile to use. + -h, --help Help for newtmgr commands + -l, --loglevel string log level to use (default "info") + -t, --trace print all bytes transmitted and received +``` + +####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 div0<br>-c profile01 | Sends a request to a device to execute a divide by 0 test. Newtmgr connects to the device over a connection specified in the `profile01` connection profile. + | newtmgr crash ref0<br>-c profile01 | Sends a request to a device to execute a nil pointer reference test. Newtmgr connects to the device over a connection specified in the `profile01` connection profile. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/404f42d1/docs/newtmgr/command_list/newtmgr_datetime.md ---------------------------------------------------------------------- diff --git a/docs/newtmgr/command_list/newtmgr_datetime.md b/docs/newtmgr/command_list/newtmgr_datetime.md new file mode 100644 index 0000000..1aed280 --- /dev/null +++ b/docs/newtmgr/command_list/newtmgr_datetime.md @@ -0,0 +1,30 @@ +## <font color="#F2853F" style="font-size:24pt">newtmgr datetime </font> +Manage datetime on a device. + +#### Usage: + +```no-highlight + newtmgr datetime [datetime-value] -c <conn_profile> [flags] +``` + +#### Global Flags: + +```no-highlight + -c, --conn string connection profile to use. + -h, --help Help for newtmgr commands + -l, --loglevel string log level to use (default "info") + -t, --trace print all bytes transmitted and received +``` + +####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 datetime<br>-c profile01 | Reads the datetime value from a device. Newtmgr connects to the device over a connection specified in the `profile01` connection profile. + | newtmgr datetime 2017-03-01T22:44:00<br>-c profile01 | Sets the datetime on a device to March 1st 2017 22:44:00 UTC. Newtmgr connects to the device over a connection specified in the `profile01` connection profile. + | newtmgr datetime 2017-03-01T22:44:00-08:00<br>-c profile01| Sets the datetime on a device to March 1st 2017 22:44:00 PST. Newtmgr connects to the device over a connection specified in the `profile01` connection profile. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/404f42d1/docs/newtmgr/command_list/newtmgr_echo.md ---------------------------------------------------------------------- diff --git a/docs/newtmgr/command_list/newtmgr_echo.md b/docs/newtmgr/command_list/newtmgr_echo.md new file mode 100644 index 0000000..0e6c92a --- /dev/null +++ b/docs/newtmgr/command_list/newtmgr_echo.md @@ -0,0 +1,26 @@ +## <font color="#F2853F" style="font-size:24pt">newtmgr echo </font> +Send data to a device and display the echoed back data. + +#### Usage: + +```no-highlight + newtmgr echo <text> -c <conn_profile> [flags] +``` + +#### Global Flags: + +```no-highlight + -c, --conn string connection profile to use + -h, --help Help for newtmgr commands + -l, --loglevel string log level to use (default "info") + -t, --trace print all bytes transmitted and received +``` + +####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 hello<br>-c profile01 | Sends the text 'hello' to a device and displays the echoed back data. Newtmgr connects to the device over a connection specified in the `profile01` profile. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/404f42d1/docs/newtmgr/command_list/newtmgr_fs.md ---------------------------------------------------------------------- diff --git a/docs/newtmgr/command_list/newtmgr_fs.md b/docs/newtmgr/command_list/newtmgr_fs.md new file mode 100644 index 0000000..d124cff --- /dev/null +++ b/docs/newtmgr/command_list/newtmgr_fs.md @@ -0,0 +1,32 @@ +## <font color="#F2853F" style="font-size:24pt">newtmgr fs</font> +Access files on a device. + +#### Usage: + +```no-highlight + newtmgr fs [command] -c <conn_profile> [flags] +``` + +#### Global Flags: + +```no-highlight + -c, --conn string connection profile to use. + -h, --help Help for newtmgr commands + -l, --loglevel string log level to use (default "info") + -t, --trace print all bytes transmitted and received +``` + +####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 /cfg/mfg mfg.txt -c profile01 | Downloads the file name `/cfg/mfg` 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 mymfg.txt /cfg/mfg -c profile01 | Uploads the file name `mymfg.txt` 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. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/404f42d1/docs/newtmgr/command_list/newtmgr_image.md ---------------------------------------------------------------------- diff --git a/docs/newtmgr/command_list/newtmgr_image.md b/docs/newtmgr/command_list/newtmgr_image.md new file mode 100644 index 0000000..7072b60 --- /dev/null +++ b/docs/newtmgr/command_list/newtmgr_image.md @@ -0,0 +1,56 @@ +## <font color="#F2853F" style="font-size:24pt">newtmgr image </font> +Manage images on a device. + +#### Usage: + +```no-highlight + newtmgr image [command] -c <connection_profile> [flags] +``` + +#### Flags: +The coredownload subcommand uses the following local flags: + +```no-highlight + -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: + +```no-highlight + -c, --conn string connection profile to use + -h, --help Help for newtmgr commands + -l, --loglevel string log level to use (default "info") + -t, --trace print all bytes transmitted and received +``` + +####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`. <br><br> **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. +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<br>-c profile01 | Makes the current image setup on a device permanent. Newtmgr connects to the device over a connection specified in the `profile01` connection profile. +confirm | newtmgr confirm<br>be9699809a049...73d77f<br>-c profile01 | Makes the image, identified by the `be9699809a049...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 coreconvert mycore mycore.elf | Converts the `mycore` file to the ELF format and saves it in the `mycore.elf` file. +coredownload | newtmgr image coredownload <br>mycore -c profile01 | Downloads the 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. +coredownload | newtmgr image coredownload <br>mycore -e <br>-c profile01 | Downloads the core from a device, 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 coredownload <br>mycore <br>--offset 10 -n 30<br>-c profile01 | Downloads 30 bytes, starting at offset 10, of the 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 <br>-c profile01 | Erases the core file on a device. Newtmgr connects to the device over a connection specified in the `profile01` connection profile. +corelist | newtmgr image corelist<br>-c profile01 | Lists the core files on a device. Newtmgr connects to the device over a connection specified in the `profile01` connection profile. +list | newtmgr image list<br>-c profile01 | Lists the images on a device. Newtmgr connects to the device over a connection specified in the `profile01` connection profile. +test | newtmgr image test <br>be9699809a049...73d77f | Tests the image, 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 <br>upload bletiny.img<br>-c profile01 | Uploads the `bletiny.img` image to a device. Newtmgr connects to the device over a connection specified in the `profile01` connection profile. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/404f42d1/docs/newtmgr/command_list/newtmgr_logs.md ---------------------------------------------------------------------- diff --git a/docs/newtmgr/command_list/newtmgr_logs.md b/docs/newtmgr/command_list/newtmgr_logs.md new file mode 100644 index 0000000..d32205a --- /dev/null +++ b/docs/newtmgr/command_list/newtmgr_logs.md @@ -0,0 +1,39 @@ +## <font color="#F2853F" style="font-size:24pt">newtmgr log </font> +Manage logs on a device. + +#### Usage: + +```no-highlight + newtmgr log [command] [flags] +``` + +#### Global Flags: + +```no-highlight + -c, --conn string connection profile to use. + -h, --help Help for newtmgr commands + -l, --loglevel string log level to use (default "info") + -t, --trace print all bytes transmitted and received +``` + +####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 shows the logs on a device. + + +####Examples + +Sub-command | Usage | Explanation +-------------| -----------------------|----------------- +clear | newtmgr log clear<br>-c profile01 | Clears the logs on a device. Newtmgr connects to the device over a connection specified in the `profile01` connection profile. +level_list | newtmgr log level_list <br>-c profile01 | Shows the log levels on a device. Newtmgr connects to the device over a connection specified in the `profile01` connection profile. +list | newtmgr log list<br>-c profile01 | Shows the log names on a device. Newtmgr connects to the device over a connection specified in the `profile01` connection profile. +module_list | newtmgr log module_list<br>-c profile01 | Shows the log module names on a device. Newtmgr connects to the device over a connection specified in the `profile01` connection profile. +show | newtmgr log show<br>-c profile01 | Shows the logs on a device. Newtmgr connects to the device over a connection specified in the `profile01` connection profile. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/404f42d1/docs/newtmgr/command_list/newtmgr_mpstats.md ---------------------------------------------------------------------- diff --git a/docs/newtmgr/command_list/newtmgr_mpstats.md b/docs/newtmgr/command_list/newtmgr_mpstats.md new file mode 100644 index 0000000..722fa92 --- /dev/null +++ b/docs/newtmgr/command_list/newtmgr_mpstats.md @@ -0,0 +1,56 @@ +## <font color="#F2853F" style="font-size:24pt">newtmgr mpstats </font> +Read memory pool statistics from a device. + +#### Usage: + +```no-highlight + newtmgr mpstats -c <conn_profile> [flags] +``` + +#### Global Flags: + +```no-highlight + -c, --conn string connection profile to use. + -h, --help Help for newtmgr commands + -l, --loglevel string log level to use (default "info") + -t, --trace print all bytes transmitted and received +``` + +####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 mpstats -c profile01 | Reads and displays the 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.md) tutiorial: + +```no-highlight +newtmgr mpstats -c myserial +Return Code = 0 + name blksz cnt free min + ble_l2cap_sig_proc_pool 20 1 1 1 + ble_att_svr_prep_entry_pool 12 64 64 64 + ble_hci_ram_evt_hi_pool 72 2 2 1 + ble_hs_hci_ev_pool 16 10 10 9 + ble_att_svr_entry_pool 20 75 0 0 + ble_gattc_proc_pool 56 4 4 4 + bletiny_dsc_pool 28 64 64 64 + ble_hs_conn_pool 84 1 1 1 + ble_gap_update 24 1 1 1 + bletiny_svc_pool 32 32 32 32 + ble_gatts_clt_cfg_pool 12 2 1 1 + msys_1 292 12 9 6 + ble_hci_ram_evt_lo_pool 72 8 8 8 + ble_l2cap_chan_pool 24 3 3 3 + bletiny_chr_pool 36 64 64 64 +``` http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/404f42d1/docs/newtmgr/command_list/newtmgr_reset.md ---------------------------------------------------------------------- diff --git a/docs/newtmgr/command_list/newtmgr_reset.md b/docs/newtmgr/command_list/newtmgr_reset.md new file mode 100644 index 0000000..726bd6d --- /dev/null +++ b/docs/newtmgr/command_list/newtmgr_reset.md @@ -0,0 +1,26 @@ +## <font color="#F2853F" style="font-size:24pt">newtmgr reset </font> +Send a reset request to a device. + +#### Usage: + +```no-highlight + newtmgr reset <conn_profile> [flags] +``` + +#### Global Flags: + +```no-highlight + -c, --conn string connection profile to use. + -h, --help Help for newtmgr commands + -l, --loglevel string log level to use (default "info") + -t, --trace print all bytes transmitted and received +``` + +####Description +Resets a device. Newtmgr uses the `conn_profile` connection profile to connect to the device. + +####Examples + +Sub-command | Usage | Explanation +-------------| -----------------------|----------------- + | newtmgr reset<br>-c profile01 |Resets a device. Newtmgr connects to the device over a connection specified in the `profile01` connection profile. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/404f42d1/docs/newtmgr/command_list/newtmgr_run.md ---------------------------------------------------------------------- diff --git a/docs/newtmgr/command_list/newtmgr_run.md b/docs/newtmgr/command_list/newtmgr_run.md new file mode 100644 index 0000000..a28bb69 --- /dev/null +++ b/docs/newtmgr/command_list/newtmgr_run.md @@ -0,0 +1,33 @@ +## <font color="#F2853F" style="font-size:24pt">newtmgr run </font> +Run test procedures on a device. + +#### Usage: + +```no-highlight + newtmgr run [command] -c <conn_profile> [flags] +``` + +#### Global Flags: + +```no-highlight + -c, --conn string connection profile to use. + -h, --help Help for newtmgr commands + -l, --loglevel string log level to use (default "info") + -t, --trace print all bytes transmitted and received +``` + +####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 run<br>list -c profile01 | Lists all the registered tests on a device. Newtmgr connects to the device over a connection specified in the `profile01` connection profile. +test | newtmgr run <br>test all<br>201612161220<br>-c profile01 | Runs all the tests on a device. 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 <br>test mynewtsanity<br>-c profile01 | Runs the `mynewtsanity` test on a device. Newtmgr connects to the device over a connection specified in the `profile01` connection profile. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/404f42d1/docs/newtmgr/command_list/newtmgr_stat.md ---------------------------------------------------------------------- diff --git a/docs/newtmgr/command_list/newtmgr_stat.md b/docs/newtmgr/command_list/newtmgr_stat.md new file mode 100644 index 0000000..890a43b --- /dev/null +++ b/docs/newtmgr/command_list/newtmgr_stat.md @@ -0,0 +1,82 @@ +## <font color="#F2853F" style="font-size:24pt">newtmgr stat</font> +Read statistics from a device. + +#### Usage: + +```no-highlight + newtmgr stat [stats_name] -c <conn_profile> [flags] + newtmgr stat [command] -c <conn_profile> [flags] +``` + +#### Global Flags: + +```no-highlight + -c, --conn string connection profile to use. + -h, --help Help for newtmgr commands + -l, --loglevel string log level to use (default "info") + -t, --trace print all bytes transmitted and received +``` + +####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 [stats_name] command displays the statistics for the `stats_name` Stats from a device. It displays the list of Stats names if a `stats_name` value is not specified. +list | The newtmgr stat list command displays the list of Stats names from a device. + + +####Examples + +Sub-command | Usage | Explanation +-------------| -----------------------|----------------- + | newtmgr stat ble_att -c profile01 | Displays the `ble_att` statistics on a device. Newtmgr connects to the device over a connection specified in the `profile01` connection profile. + | newtmgr stat -c profile01 | Displays the list of Stats names from a device. Newtmgr connects to the device over a connection specified in the `profile01` connection profile. +list | newtmgr stat list -c profile01 | Displays the list 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.md) tutiorial: + +The statistics for the ble_att Stats: +```no-highlight + +$ newtmgr stat ble_att -c myserial +Return Code = 0 +Stats Name: ble_att + read_type_req_rx: 0 + read_rsp_rx: 0 + read_group_type_rsp_tx: 0 + prep_write_rsp_tx: 0 + find_type_value_req_tx: 0 + read_type_rsp_rx: 0 + read_mult_req_rx: 0 + notify_req_tx: 0 + indicate_req_tx: 0 + + ... + write_cmd_rx: 0 + prep_write_rsp_rx: 0 + read_type_rsp_tx: 0 + read_req_tx: 0 + read_mult_req_tx: 0 + read_group_type_req_rx: 0 + write_rsp_tx: 0 + exec_write_rsp_rx: 0 + +``` + +The list of Stats names: +```no-highlight + +$ newtmgr stat -c myserial +[stat ble_l2cap ble_att ble_gap ble_gattc ble_gatts ble_hs ble_ll_conn ble_ll ble_phy] +Return Code = 0 + +``` +The list of Stats names using the list subcommand: +```no-highlight + +$ newtmgr stat list -c myserial +[stat ble_l2cap ble_att ble_gap ble_gattc ble_gatts ble_hs ble_ll_conn ble_ll ble_phy] +Return Code = 0 + +``` http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/404f42d1/docs/newtmgr/command_list/newtmgr_taskstats.md ---------------------------------------------------------------------- diff --git a/docs/newtmgr/command_list/newtmgr_taskstats.md b/docs/newtmgr/command_list/newtmgr_taskstats.md new file mode 100644 index 0000000..3e4feea --- /dev/null +++ b/docs/newtmgr/command_list/newtmgr_taskstats.md @@ -0,0 +1,47 @@ +## <font color="#F2853F" style="font-size:24pt">newtmgr taskstats </font> +Read task statistics from a device. + +#### Usage: + +```no-highlight + newtmgr taskstats -c <conn_profile> [flags] +``` + +#### Global Flags: + +```no-highlight + -c, --conn string connection profile to use. + -h, --help Help for newtmgr commands + -l, --loglevel string log level to use (default "info") + -t, --trace print all bytes transmitted and received +``` + +####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.md) +* **next_checkin**: Next sanity checkin + + +####Examples + +Sub-command | Usage | Explanation +-------------| -----------------------|----------------- + | newtmgr taskstats<br>-c profile0 | Reads and displays the task 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.md) tutiorial: + +```no-highlight +newtmgr taskstats -c myserial +Return Code = 0 + task pri tid runtime csw stksz stkuse last_checkin next_checkin + idle 255 0 151917 47 64 34 0 0 + main 127 1 2 59 512 188 0 0 + ble_ll 0 2 0 14 80 56 0 0 +```
