Skip to content

Commit

Permalink
Update readme and minor fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
rbonghi committed May 10, 2020
1 parent 415a2b7 commit ed22184
Show file tree
Hide file tree
Showing 6 changed files with 49 additions and 28 deletions.
35 changes: 28 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@

![Build](https://github.com/rbonghi/jetson_stats/workflows/Build/badge.svg) ![Docs](https://github.com/rbonghi/jetson_stats/workflows/Docs/badge.svg) ![Publish](https://github.com/rbonghi/jetson_stats/workflows/Publish/badge.svg)

**jetson-stats** is a package to **monitoring** and **control** your [NVIDIA Jetson][NVIDIA Jetson] [Xavier NX, Nano, Xavier, TX2i, TX2, TX1] embedded board. When you install jetson-stats are included:
**jetson-stats** is a package to **monitoring** and **control** your [NVIDIA Jetson][NVIDIA Jetson] [XavierNX, Nano, AGX Xavier, TX1, TX2] Works with all NVIDIA Jetson ecosystem.

When you install jetson-stats are included:
* [jtop](#jtop)
* [jetson_config](#jetson_config)
* [jetson_release](#jetson_release)
* [jetson_swap](#jetson_swap)
* [jetson_variables](#jetson_variables)

Read the [Wiki](https://github.com/rbonghi/jetson_stat/wiki) for more detailed information or read the package [documentation](https://rbonghi.github.io/jetson_stats).
Expand All @@ -25,10 +28,10 @@ _PS: Don't forget to **reboot** your board_
## [**jtop**][jtop]
It is a system monitoring utility that runs on the terminal and see and **control** realtime the status of your [NVIDIA Jetson][NVIDIA Jetson]. CPU, RAM, GPU status and frequency and other...

The prompt interface will be show like this image:
The prompt interface will be show like this image, **now clickable!**:
![jtop](https://github.com/rbonghi/jetson_stats/wiki/images/jtop.gif)

You can run the jtop with (Suggested to run with **sudo**)
You can run the jtop with (_Suggested_ to run with **sudo**)
```elm
sudo jtop
```
Expand All @@ -51,19 +54,21 @@ optional arguments:
-p PAGE, --page PAGE Open fix page
-v, --version show program's version number and exit
```
You can change page using _left_, _right_ arrow or _TAB_ to change page.
### Pages
**jtop** have four different pages to control your NVIDIA Jetson:
1. **ALL** Are collected all information about your board: CPUs status, Memory, *GPU*, disk, fan and all status about jetson_clocks, NVPmodel and other
2. **GPU** A real time GPU history about your NVIDIA Jetson
2. **MEM** A real time Memory chart and swap monitor
3. **CTRL** Enable/Disable **jetson_clocks**, **nvpmodel** or **fan** directly from here
4. **INFO** All information about libraries, CUDA, Serial Number, interfaces, ...
3. **CPU** A real time CPU plot of NVIDIA Jetson
4. **MEM** A real time Memory chart and swap monitor
5. **CTRL** Enable/Disable **jetson_clocks**, **nvpmodel** or **fan** directly from here
6. **INFO** All information about libraries, CUDA, Serial Number, interfaces, ...
### Controls
To control the your NVIDIA Jetson are available this keyboard commands:

In page **3 MEM**:
* **c** Clear cache
* **h** Enable/Disable extra swap
* **s** Enable/Disable extra swap
* **+** and **-** Increase and decrease swap size

In page **4 CTRL**:
Expand All @@ -82,6 +87,21 @@ Check _jetson-stats_ **health**, enable/disable **desktop**, enable/disable **je
The command show the status and all information about your [NVIDIA Jetson][NVIDIA Jetson]

![jtop](https://github.com/rbonghi/jetson_stats/wiki/images/jetso_release.png)
## [**jetson_swap**][jetson_swap]
Simple manager to switch on and switch off a swapfile in your jetson.

```elm
nvidia@jetson-nano:~/$ sudo jetson_swap -h
usage: createSwapFile [[[-d directory ] [-s size] -a] | [-h] | [--off]]
-d | --dir <directoryname> Directory to place swapfile
-n | --name <swapname> Name swap file
-s | --size <gigabytes>
-a | --auto Enable swap on boot in /etc/fstab
-t | --status Check if the swap is currently active
--off Switch off the swap
-h | --help This message
```

## [**jetson_variables**][jetson_variables]
This script generate the easy environment variables to know which is your Hardware version of the Jetson and which Jetpack you have already installed

Expand All @@ -90,6 +110,7 @@ This script generate the easy environment variables to know which is your Hardwa
[library]: https://github.com/rbonghi/jetson_stats/wiki/library
[jtop]: https://github.com/rbonghi/jetson_stats/wiki/jtop
[jetson_config]: https://github.com/rbonghi/jetson_stats/wiki/jetson_config
[jetson_swap]: https://github.com/rbonghi/jetson_stats/wiki/jetson_swap
[jetson_variables]: https://github.com/rbonghi/jetson_stats/wiki/jetson_variables
[jetson_release]: https://github.com/rbonghi/jetson_stats/wiki/jetson_release
[jetson_performance]: https://github.com/rbonghi/jetson_stats/wiki/jetson_performance
Expand Down
2 changes: 1 addition & 1 deletion jtop/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@
__author__ = "Raffaello Bonghi <[email protected]>"
# Version package
# https://packaging.python.org/guides/distributing-packages-using-setuptools/#choosing-a-versioning-scheme
__version__ = "2.1.0rc1"
__version__ = "2.1.0"
# EOF
2 changes: 1 addition & 1 deletion jtop/gui/lib/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@


def xterm_line(jetson):
str_xterm = " " + jetson.board["board"]["Type"]
str_xterm = " " + jetson.board["board"]["TYPE"]
nvp = jetson.nvpmodel
# if "GR3D" in jetson.stats:
# gpu = jetson.stats["GR3D"]['val']
Expand Down
18 changes: 9 additions & 9 deletions jtop/gui/pinfo.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,17 +58,17 @@ def draw(self, key, mouse):
idx += 2
# Load Board information
board = self.jetson.board["board"]
self.info_variable(start_pos + idx, posx + 2, "* Type", board["Type"])
self.info_variable(start_pos + idx, posx + 2, "* Type", board["TYPE"])
self.info_variable(start_pos + idx + 1, posx + 2, "* SOC Family", board["SOC"])
self.info_variable(start_pos + idx + 1, posx + 33, "ID", board["Chip ID"], spacing=4)
self.info_variable(start_pos + idx + 2, posx + 2, "* Module", board["Module"])
self.info_variable(start_pos + idx + 2, posx + 33, "Board", board["Board"], spacing=7)
self.info_variable(start_pos + idx + 3, posx + 2, "* Code Name", board["Code Name"])
self.info_variable(start_pos + idx + 4, posx + 2, "* Cuda ARCH", board["GPU-Arch"])
self.info_variable(start_pos + idx + 5, posx + 2, "* Serial Number", board["SN"])
self.info_variable(start_pos + idx + 1, posx + 33, "ID", board["CHIP_ID"], spacing=4)
self.info_variable(start_pos + idx + 2, posx + 2, "* Module", board["MODULE"])
self.info_variable(start_pos + idx + 2, posx + 33, "Board", board["BOARD"], spacing=7)
self.info_variable(start_pos + idx + 3, posx + 2, "* Code Name", board["CODENAME"])
self.info_variable(start_pos + idx + 4, posx + 2, "* Cuda ARCH", board["CUDA_ARCH_BIN"])
self.info_variable(start_pos + idx + 5, posx + 2, "* Serial Number", board["SERIAL_NUMBER"])
idx += 5
if board["Boardids"]:
self.info_variable(start_pos + idx + 1, posx + 2, "* Board ids", board["Boardids"])
if board["BOARDIDS"]:
self.info_variable(start_pos + idx + 1, posx + 2, "* Board ids", board["BOARDIDS"])
idx += 1
# Libraries info
library_line = start_pos + idx + 1
Expand Down
16 changes: 8 additions & 8 deletions jtop/jtop.py
Original file line number Diff line number Diff line change
Expand Up @@ -210,15 +210,15 @@ def board(self):
"""
info = {"Machine": os.environ["JETSON_MACHINE"],
"Jetpack": os.environ["JETSON_JETPACK"] + " [L4T " + os.environ["JETSON_L4T"] + "]"}
board = {"Type": os.environ["JETSON_TYPE"],
"Code Name": os.environ["JETSON_CODENAME"],
board = {"TYPE": os.environ["JETSON_TYPE"],
"CODENAME": os.environ["JETSON_CODENAME"],
"SOC": os.environ["JETSON_SOC"],
"Chip ID": os.environ["JETSON_CHIP_ID"],
"Boardids": os.environ["JETSON_BOARDIDS"],
"Module": os.environ["JETSON_MODULE"],
"Board": os.environ["JETSON_BOARD"],
"GPU-Arch": os.environ["JETSON_CUDA_ARCH_BIN"],
"SN": os.environ["JETSON_SERIAL_NUMBER"].upper()}
"CHIP_ID": os.environ["JETSON_CHIP_ID"],
"BOARDIDS": os.environ["JETSON_BOARDIDS"],
"MODULE": os.environ["JETSON_MODULE"],
"BOARD": os.environ["JETSON_BOARD"],
"CUDA_ARCH_BIN": os.environ["JETSON_CUDA_ARCH_BIN"],
"SERIAL_NUMBER": os.environ["JETSON_SERIAL_NUMBER"].upper()}
libraries = {"CUDA": os.environ["JETSON_CUDA"],
"cuDNN": os.environ["JETSON_CUDNN"],
"TensorRT": os.environ["JETSON_TENSORRT"],
Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ def run(self):
version=version,
author="Raffaello Bonghi",
author_email="[email protected]",
description="Interactive system-monitor and process viewer for all NVIDIA Jetson [Nano, AGX Xavier, TX1, TX2]",
description="Interactive system-monitor and process viewer for all NVIDIA Jetson [XavierNX, Nano, AGX Xavier, TX1, TX2]",
license='AGPL-3.0',
long_description=long_description,
long_description_content_type="text/markdown",
Expand All @@ -159,7 +159,7 @@ def run(self):
package_data={"jtop": ["jetson_variables"]},
# Define research keywords
keywords=("jetson_stats jtop python system-monitor docker \
nvidia Jetson Nano Xavier TX2 TX1 process viewer"
nvidia Jetson XavierNX Nano Xavier TX2 TX1 process viewer"
),
classifiers=["Development Status :: 5 - Production/Stable",
# Audiencence and topics
Expand Down

0 comments on commit ed22184

Please sign in to comment.