deploy: 95aa653

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 7de63761e13cd778e95c8d6cdada3545
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/changelog/index.rst.txt

@@ -0,0 +1,16 @@
+Changelogs
+==========
+The changelogs contains the user related function or environment updates. For a
+detailed changes list, please refer to the commit list on GitHub.
+
+Released versions of dbus-cpu
+-----------------------------
+v 0.0.2
+
+- adding GUI "CPU Monitor" under settings / firmware
+- adding memory stats to the GUI
+- adding memory stats to the API
+
+v 0.0.1
+
+- initial release for beta testing

_sources/index.rst.txt

@@ -0,0 +1,52 @@
+Welcome to dbus-cpu !
+=====================
+
+.. image:: image/main.png
+    :align: center
+    :scale: 71%
+
+The basic idea is that dbus-cpu will show some CPU stats on the GUI. This is a
+driver for Venus OS devices (any GX device sold by Victron or a Raspberry Pi
+running the Venus OS image).
+
+.. warning:: Expert functionality! You should be sure about what you are doing.
+             I do not take any responsibility for any damage or loss of data.
+
+Content index
+^^^^^^^^^^^^
+.. toctree::
+    :maxdepth: 2
+
+    installation/index
+    usage/index
+    changelog/index
+
+Known limitations
+-----------------
+The driver ist tested on a Venus GX (FW 3.x). It will not run on Venus OS version
+lower to 3.0 and does not support beta versions with the new UI from 3.20 on.
+
+Reporting issues
+----------------
+To improve quality and usability any feedback is highly welcome! To maintain a good
+transparency and professional work for my, please respect the following
+recommendations how to feed back.
+
+.. note:: Please report issues / bugs here:
+
+          https://github.com/mworion/dbus-cpu/issues.
+
+          And if you have feature requests discussions or for all other topics of
+          interest there is a good place to start here:
+
+          https://github.com/mworion/dbus-cpu/discussions
+
+In case of a bug report please have a good description (maybe a screenshot if it‘s
+related to GUI) and add the log file(s). Normally you just could drop the log file
+(or PNG in case of a screen shot) directly to the webpage issues on GitHub. In
+some cases GitHub does not accept the file format. In this case, please zip them
+and drop the zipped file. This will work. If you have multiple files, please
+don‘t zip them to one file! I need them separated and zipped causes more work.
+
+If changes are made due to a feedback, new releases will have a link to the closed
+issues on GitHub.

_sources/installation/index.rst.txt

@@ -0,0 +1,57 @@
+Driver installation
+===================
+
+.. warning:: The driver is only tested with Venus OS > 3.00 and < v3.3. It will
+             not work with Venus OS other than that.
+
+Install or update over SSH
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. note:: Requires root access.
+
+Log into your Venus OS device using a SSH client like Putty or bash and run
+these commands to start the installer:
+
+.. code-block:: bash
+
+   wget -O /tmp/install.sh https://raw.githubusercontent.com/mworion/dbus-cpu/master/install-target.sh
+   bash /tmp/install.sh
+
+The installer will download the latest released version of the driver and installs
+it on your system. The location of the install will be in
+
+.. code-block:: bash
+
+   /data/etc/dbus-cpu
+
+The installer will also create a service file for the driver and enable it. All
+the installations to the system will be done from this origin with symlinks.
+
+In addition the installer will add lines to
+
+.. code-block:: bash
+
+   /data/rc.local
+
+to keep the installation persistent over reboots und firmware updates of the venus
+system. Uninstall will remove this entry.
+
+Last the installer will backup / add some files to the GUI system to make the GUI
+aware of the more detailed information provided by dbus-cpu. Uninstall will
+remove these files and changes.
+
+You could customize the installation by editing the script. All scripts are located
+in the same directory:
+
+.. code-block:: bash
+
+   /data/etc/dbus-cpu/scripts
+
+Settings
+^^^^^^^^
+Basically no settings could be made as the driver is designed to be plug and play.
+
+Behavior
+^^^^^^^^
+dbus-cpu will start automatically after installation. It will read CPU stats
+(usage, memory) from /proc/stat and /proc/meminfo and publish them on the D-Bus.
+

_sources/usage/index.rst.txt

@@ -0,0 +1,9 @@
+Usage
+=====
+
+Once installed and running, the dbus-cpu is shown in the Venus device beside
+under settings / firmware. dbus-cpu does not write or actively change values.
+
+.. image:: image/stats.png
+    :align: center
+    :scale: 71%