Feature/no more sudo

.github/workflows/build.yml

@@ -18,17 +18,19 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
+        # Make group jetson_stats
+        sudo groupadd jetson_stats
         # Install test dependencies
         sudo ./tests/develop.sh -s
         # Upgrade pip
-        python -m pip install --upgrade pip
+        sudo -H python -m pip install --upgrade pip
         # Install tox
-        sudo apt-get install tox
+        sudo -H pip install tox
     - name: Display Python version
       run: python -c "import sys; print(sys.version)"
     - name: Test with tox

.github/workflows/docs.yml

@@ -16,6 +16,8 @@ jobs:
       with:
         persist-credentials: false
 
+    - name: Install jtop
+      run: python setup.py install
     - name: Sphinx Build
       # Follow: https://github.com/marketplace/actions/sphinx-build
       uses: ammaraskar/sphinx-action@0.3

.gitignore

@@ -20,5 +20,7 @@ venv/
 .cache/
 swapfile
 test.*
+*.csv
 
-.vscode/
+.vscode/
+.venv*/

docs/source/conf.py

@@ -11,6 +11,7 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 import os
 import sys
+import jtop
 sys.path.insert(0, os.path.abspath('../../'))
 
 # -- Project information -----------------------------------------------------
@@ -24,7 +25,7 @@
 author = 'Raffaello Bonghi'
 
 # The full version, including alpha/beta/rc tags
-release = '1.8.0'
+release = jtop.__version__
 
 # -- General configuration ---------------------------------------------------
 

examples/jtop_callback.py

@@ -16,24 +16,30 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 
-from jtop import jtop
+from jtop import jtop, JtopException
 
 
-def read_stats(stats):
+def read_stats(jetson):
     """
     This is your callback function where you can read all files when are availables.
     """
-    print(stats)
+    print(jetson.stats)
 
 
 if __name__ == "__main__":
-    print("Initialize jtop")
+    print("Initialize jtop callback")
     # Open the jtop
     jetson = jtop()
     # Attach a function where you can read the status of your jetson
     jetson.attach(read_stats)
 
-    # Nothing to do, now you can read
-    while True:
-        pass
+    # This try excpet will catch jtop exception
+    try:
+        # This loop will manage the jtop status all the time
+        # This is a blocking a function, if you do not want use you can use as well
+        # start: jetson.start()
+        # stop: jetson.stop()
+        jetson.loop_for_ever()
+    except JtopException as e:
+        print(e)
 # EOF

examples/jtop_control.py

@@ -0,0 +1,68 @@
+#!/usr/bin/env python
+# -*- coding: UTF-8 -*-
+# This file is part of the jetson_stats package (https://github.com/rbonghi/jetson_stats or http://rnext.it).
+# Copyright (c) 2019 Raffaello Bonghi.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+from jtop import jtop, JtopException
+
+if __name__ == "__main__":
+
+    print("Simple jtop controller")
+
+    try:
+        # All options are not blocking
+        with jtop() as jetson:
+            # Read jetson_clocks status
+            print(jetson.jetson_clocks)
+            # Set a new status
+            jetson.jetson_clocks = True
+            # Read nvpmodel
+            if jetson.nvpmodel:
+                # Read nvpmodel
+                print(jetson.nvpmodel)
+                # Set new state
+                jetson.nvpmodel = 0  # You can write the name of the model as well
+                # Wait nvpmodel changed
+                while jetson.ok():
+                    if jetson.nvpmodel.id == 0:
+                        break
+                # You can increase or decrease the nvpmodel using
+                jetson.nvpmodel += 1  # or jetson.nvpmodel = jetson.nvpmodel + 1
+                # Wait nvpmodel changed
+                while jetson.ok():
+                    if jetson.nvpmodel.id == 1:
+                        break
+            # You can control the fan
+            if jetson.fan:
+                # read fan status
+                print(jetson.fan)
+                # You can change mode and setting
+                jetson.fan.mode = 'system'
+                # Wait nvpmodel changed
+                while jetson.ok():
+                    if jetson.fan.mode == 'system':
+                        break
+                # Or you can change the fan speed
+                jetson.fan.speed = 100
+                while jetson.ok():
+                    # Print jetson fan status
+                    print(jetson.fan)
+                    # Leave when fan measure is at 100%
+                    if jetson.fan.measure == 100:
+                        break
+    except JtopException as e:
+        print(e)
+# EOF

examples/jtop_logger.py

@@ -0,0 +1,56 @@
+#!/usr/bin/env python
+# -*- coding: UTF-8 -*-
+# This file is part of the jetson_stats package (https://github.com/rbonghi/jetson_stats or http://rnext.it).
+# Copyright (c) 2019 Raffaello Bonghi.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+from jtop import jtop, JtopException
+import csv
+import argparse
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description='Simple jtop logger')
+    # Standard file to store the logs
+    parser.add_argument('--file', action="store", dest="file", default="log.csv")
+    args = parser.parse_args()
+
+    print("Simple jtop logger")
+    print("Saving log on {file}".format(file=args.file))
+
+    try:
+        with jtop() as jetson:
+            # Make csv file and setup csv
+            with open(args.file, 'w') as csvfile:
+                stats = jetson.stats
+                # Initialize cws writer
+                writer = csv.DictWriter(csvfile, fieldnames=stats.keys())
+                # Write header
+                writer.writeheader()
+                # Write first row
+                writer.writerow(stats)
+                # Start loop
+                while jetson.ok():
+                    stats = jetson.stats
+                    # Write row
+                    writer.writerow(stats)
+                    print("Log at {time}".format(time=stats['time']))
+    except JtopException as e:
+        print(e)
+    except KeyboardInterrupt:
+        print("Closed with CTRL-C")
+    except IOError:
+        print("I/O error")
+# EOF

examples/jtop_server.py

@@ -17,12 +17,12 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 
-from jtop import jtop
+from jtop import jtop, JtopException
 import socket
 import json
 import argparse
 
-parser = argparse.ArgumentParser(description='Simple Tegrastats server.')
+parser = argparse.ArgumentParser(description='Simple jtop server.')
 
 # Standard loopback interface address (localhost)
 parser.add_argument('--host', action="store", dest="host", default="127.0.0.1")
@@ -37,16 +37,16 @@
 
 if __name__ == "__main__":
 
-    print("Simple Tegrastats server")
+    print("Simple jtop server")
 
     sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
     sock.bind((args.host, args.port))
     print("Open server jtop to {}:{}".format(args.host, args.port))
     sock.listen(1)
 
-    with jtop() as jetson:
-        try:
-            while True:
+    try:
+        with jtop() as jetson:
+            while jetson.ok():
                 # Wait socket request
                 conn, addr = sock.accept()
                 print("Connected to {}".format(conn))
@@ -60,6 +60,10 @@
                     conn.send(stats.encode())
                 # Close connection
                 conn.close()
-        except Exception:
-            sock.close()
+    except JtopException as e:
+        print(e)
+    except Exception as e:
+        print(e)
+    finally:
+        sock.close()
 # EOF

examples/quick_read.py

@@ -17,29 +17,29 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 from jtop import jtop
-import time
+
 
 if __name__ == "__main__":
 
-    print("Simple Tegrastats reader")
+    print("Simple jtop reader")
 
     with jtop() as jetson:
-        while True:
+        # jetson.ok() will provide the proper update frequency
+        while jetson.ok():
             # Read tegra stats
             print(jetson.stats)
+            # nvpmodel
+            print(jetson.nvpmodel)
+            # jetson_clocks
+            print(jetson.jetson_clocks)
             # Status disk
             print(jetson.disk)
             # Status fans
-            if hasattr(jetson, 'fan'):
-                print(jetson.fan)
+            print(jetson.fan)
             # uptime
             print(jetson.uptime)
-            # nvpmodel
-            print(jetson.nvpmodel)
             # local interfaces
             print(jetson.local_interfaces)
             # boards
             print(jetson.board)
-            # Sleep before send new stat
-            time.sleep(1)
 # EOF