From 0391b24d282a53fb250133c0e97be3842a386fef Mon Sep 17 00:00:00 2001
From: Onkel Andy <onkelandy@hotmail.com>
Date: Sun, 17 Sep 2023 23:17:08 +0200
Subject: [PATCH 1/5] jsonread plugin: clean up and improve web interface
 (using internal datatables, etc.)

---
 jsonread/webif/__init__.py          |  23 +++----
 jsonread/webif/templates/index.html | 102 +++++++++++-----------------
 2 files changed, 48 insertions(+), 77 deletions(-)

diff --git a/jsonread/webif/__init__.py b/jsonread/webif/__init__.py
index f7bf64677..f71cb20dd 100755
--- a/jsonread/webif/__init__.py
+++ b/jsonread/webif/__init__.py
@@ -26,15 +26,12 @@
 import datetime
 import time
 import os
+import json
 
 from lib.item import Items
 from lib.model.smartplugin import SmartPluginWebIf
 
 
-# ------------------------------------------
-#    Webinterface of the plugin
-# ------------------------------------------
-
 import cherrypy
 import csv
 from jinja2 import Environment, FileSystemLoader
@@ -69,8 +66,10 @@ def index(self, reload=None):
         :return: contents of the template after beeing rendered
         """
         tmpl = self.tplenv.get_template('index.html')
+        pagelength = self.plugin.get_parameter_value('webif_pagelength')
         # add values to be passed to the Jinja2 template eg: tmpl.render(p=self.plugin, interface=interface, ...)
         return tmpl.render(p=self.plugin,
+                           webif_pagelength=pagelength,
                            items=self.plugin._items,
                            item_count=0)
 
@@ -89,14 +88,10 @@ def get_data_html(self, dataSet=None):
             # get the new data
             data = {}
 
-            # data['item'] = {}
-            # for i in self.plugin.items:
-            #     data['item'][i]['value'] = self.plugin.getitemvalue(i)
-            #
-            # return it as json the the web page
-            # try:
-            #     return json.dumps(data)
-            # except Exception as e:
-            #     self.logger.error("get_data_html exception: {}".format(e))
+            for item in self.plugin._items.keys():
+                data[item.property.path] = item.property.value
+            try:
+                return json.dumps(data)
+            except Exception as e:
+                self.logger.error("get_data_html exception: {}".format(e))
         return {}
-
diff --git a/jsonread/webif/templates/index.html b/jsonread/webif/templates/index.html
index d8c1918f3..5e977be97 100755
--- a/jsonread/webif/templates/index.html
+++ b/jsonread/webif/templates/index.html
@@ -3,7 +3,7 @@
 {% set logo_frame = false %}
 
 <!-- set update_interval to a value > 0 (in milliseconds) to enable periodic data updates -->
-{% set update_interval = 0 %}
+{% set update_interval = 30000 %}
 
 <!--
 	Additional script tag for plugin specific javascript code go into this block
@@ -14,37 +14,42 @@
 		if (dataSet === 'devices_info' || dataSet === null) {
 			var objResponse = JSON.parse(response);
 			myProto = document.getElementById(dataSet);
-			for (var device in objResponse) {
-				/*
-				shngInsertText (device+'_source', objResponse[device]['source']);
-				shngInsertText (device+'_powerState', objResponse[device]['powerState']);
-				*/
+			for (item in objResponse) {
+				shngInsertText (item+'_value', objResponse[item], "itemtable", 10);
 			}
 		}
 	}
 </script>
-
-/*
- * The combined file was created by the DataTables downloader builder:
- *   https://datatables.net/download
- *
- * To rebuild or modify this file with the latest versions of the included
- * software please visit:
- *   https://datatables.net/download/#dt/dt-1.10.21/fh-3.1.7/r-2.2.5
- *
- * Included libraries:
- *   DataTables 1.10.21, FixedHeader 3.1.7, Responsive 2.2.5
- */
-<link rel="stylesheet" type="text/css" href="static/datatables.css">
-<script type="text/javascript" charset="utf8" src="static/datatables.js"></script>
-
 <script>
-$(document).ready( function () {
-    $('#itemtable').DataTable( {
-        "paging": false,
-        fixedHeader: true
-        } );
-} );
+	  $(document).ready( function () {
+			$(window).trigger('datatables_defaults');
+			try {
+				table = $('#itemtable').DataTable( {
+					columnDefs: [
+					{
+						title: '',
+						targets: 0, "className": ""
+					},
+					{
+						title: '{{ _("Item") }}',
+						targets: 1, "className": "item"
+					},
+					{
+						title: '{{ _("jsonread_filter") }}',
+						targets: 2, "className": "send"
+					},
+					{
+						title: '{{ _("Wert") }}',
+						targets: 3, "className": "remote"
+					}
+					].concat($.fn.dataTable.defaults.columnDefs)
+				});
+			}
+			catch (e) {
+				console.log("Datatable JS not loaded, showing standard table without reorder option " +e);
+			}
+
+		});
 </script>
 {% endblock pluginscripts %}
 
@@ -66,27 +71,8 @@
 </table>
 {% endblock headtable %}
 
-
-<!--
-	Additional buttons for the web interface (if any are needed) - displayed below the headtable-section
--->
-{% block buttons %}
-{% if 1==2 %}
-	<div>
-		<button id="btn1" class="btn btn-shng btn-sm" name="scan" onclick="shngPost('', {learn: 'on'})"><i class="fas fa-question"></i>&nbsp;&nbsp;&nbsp;{{ _('nach Devices suchen') }}&nbsp;</button>
-	</div>
-{% endif %}
-{% endblock %}
-
-<!--
-	Define the number of tabs for the body of the web interface (1 - 3)
--->
 {% set tabcount = 3 %}
 
-
-<!--
-	Set the tab that will be visible on start, if another tab that 1 is wanted (1 - 3)
--->
 {% set item_count = p._items|length %}
 {% if item_count==0 %}
 	{% set start_tab = 1 %}
@@ -111,28 +97,19 @@
 -->
 {% set tab2title = "<strong>" ~ item_count ~ " " ~ _("Items definiert") ~ "</strong>" %}
 {% block bodytab2 %}
-<div class="table-responsive" style="margin-left: 3px; margin-right: 3px;" class="row">
-	<div class="col-sm-12">
-		<table id="itemtable" class="table table-striped table-hover">
-			<thead>
-				<tr>
-					<th style="border-bottom: 1px solid var(--shng-border);">{{ _('Item') }}</th>
-					<th style="border-bottom: 1px solid var(--shng-border);">{{ _('jsonread_filter') }}</th>
-					<th style="border-bottom: 1px solid var(--shng-border); width: 100;">{{ _('Wert') }}</th>
-					</tr>
-			</thead>
+
+		<table id="itemtable">
 			<tbody>
 			{% for item in p._items %}
-				<tr>
-					<td class="py-1">{{ item._path }}</td>
-					<td class="py-1">{{ p.get_iattr_value(item.conf, 'jsonread_filter') }}</td>
-					<td class="py-1">{{ item() }}</td>
+				<tr><td></td>
+					<td class="py-1" id="{{ item }}_path">{{ item._path }}</td>
+					<td class="py-1" id="{{ item }}_filter">{{ p.get_iattr_value(item.conf, 'jsonread_filter') }}</td>
+					<td class="py-1" id="{{ item }}_value">{{ item() }}</td>
 				</tr>
 			{% endfor %}
 			</tbody>
 		</table>
-	</div>
-</div>
+
 {% endblock bodytab2 %}
 
 <!--
@@ -144,4 +121,3 @@
 	<pre>{{ p._lastresultjq }}</pre>
 </div>
 {% endblock bodytab3 %}
-

From 1bf74173e91ca0fecb733d453fc40ee3a323d3b7 Mon Sep 17 00:00:00 2001
From: Onkel Andy <onkelandy@hotmail.com>
Date: Sun, 17 Sep 2023 23:17:39 +0200
Subject: [PATCH 2/5] jsonread plugin: bump version to 1.0.3, make status
 "ready" (tested successfully)

---
 jsonread/__init__.py | 4 ++--
 jsonread/plugin.yaml | 7 +++----
 2 files changed, 5 insertions(+), 6 deletions(-)

diff --git a/jsonread/__init__.py b/jsonread/__init__.py
index a9de4f4e1..d357c7dbd 100755
--- a/jsonread/__init__.py
+++ b/jsonread/__init__.py
@@ -30,11 +30,11 @@
 import pyjq
 from lib.model.smartplugin import SmartPlugin
 from lib.item import Items
-
 from .webif import WebInterface
 
+
 class JSONREAD(SmartPlugin):
-    PLUGIN_VERSION = "1.0.2"
+    PLUGIN_VERSION = "1.0.3"
 
     def __init__(self, sh):
         """
diff --git a/jsonread/plugin.yaml b/jsonread/plugin.yaml
index 62243ca86..8612dc37d 100755
--- a/jsonread/plugin.yaml
+++ b/jsonread/plugin.yaml
@@ -6,13 +6,13 @@ plugin:
         de: 'json Parser Plugin basierend auf jq'
         en: 'json parser plugin based on jq'
     maintainer: Torsten Dreyer
-    tester: none (yet)
-    state: develop
+    tester: onkelandy
+    state: ready
     keywords: json jq
     documentation: http://smarthomeng.de/user/plugins_doc/config/not-yet.html
     support: https://knx-user-forum.de/forum/supportforen/smarthome-py/not-yet
 
-    version: 1.0.2                 # Plugin version
+    version: 1.0.3                 # Plugin version
     sh_minversion: 1.4             # minimum shNG version to use this plugin
     #sh_maxversion:                # maximum shNG version to use this plugin (leave empty if latest)
     #py_minversion: 3.6            # minimum Python version to use for this plugin
@@ -61,4 +61,3 @@ logic_parameters: NONE
 
 plugin_functions: NONE
     # Definition of function interface of the plugin
-

From c992a26b7cc826da51239d7accddf1d77e501cc3 Mon Sep 17 00:00:00 2001
From: Onkel Andy <onkelandy@hotmail.com>
Date: Mon, 18 Sep 2023 15:11:07 +0200
Subject: [PATCH 3/5] jsonread plugin: extend automatic webif update

---
 jsonread/webif/__init__.py          |  7 +++++--
 jsonread/webif/templates/index.html | 12 +++++++-----
 2 files changed, 12 insertions(+), 7 deletions(-)

diff --git a/jsonread/webif/__init__.py b/jsonread/webif/__init__.py
index f71cb20dd..e0fde734b 100755
--- a/jsonread/webif/__init__.py
+++ b/jsonread/webif/__init__.py
@@ -70,6 +70,7 @@ def index(self, reload=None):
         # add values to be passed to the Jinja2 template eg: tmpl.render(p=self.plugin, interface=interface, ...)
         return tmpl.render(p=self.plugin,
                            webif_pagelength=pagelength,
+                           update_interval=self.plugin._cycle * 1000,
                            items=self.plugin._items,
                            item_count=0)
 
@@ -86,10 +87,12 @@ def get_data_html(self, dataSet=None):
         """
         if dataSet is None:
             # get the new data
-            data = {}
+            data = {'items': {}, 'laststr': '', 'lastjq': ''}
 
             for item in self.plugin._items.keys():
-                data[item.property.path] = item.property.value
+                data['items'][item.property.path] = item.property.value
+            data['laststr'] = self.plugin._lastresultstr
+            data['lastjq'] = self.plugin._lastresultjq
             try:
                 return json.dumps(data)
             except Exception as e:
diff --git a/jsonread/webif/templates/index.html b/jsonread/webif/templates/index.html
index 5e977be97..dcb1f0348 100755
--- a/jsonread/webif/templates/index.html
+++ b/jsonread/webif/templates/index.html
@@ -3,7 +3,7 @@
 {% set logo_frame = false %}
 
 <!-- set update_interval to a value > 0 (in milliseconds) to enable periodic data updates -->
-{% set update_interval = 30000 %}
+{% set update_interval = update_interval %}
 
 <!--
 	Additional script tag for plugin specific javascript code go into this block
@@ -14,9 +14,11 @@
 		if (dataSet === 'devices_info' || dataSet === null) {
 			var objResponse = JSON.parse(response);
 			myProto = document.getElementById(dataSet);
-			for (item in objResponse) {
-				shngInsertText (item+'_value', objResponse[item], "itemtable", 10);
+			for (item in objResponse['items']) {
+				shngInsertText (item+'_value', objResponse['items'][item], "itemtable", 10);
 			}
+			shngInsertText ('laststr', objResponse['laststr'], null, 2);
+			shngInsertText ('lastjq', objResponse['lastjq'], null, 2);
 		}
 	}
 </script>
@@ -87,7 +89,7 @@
 {% set tab1title = "<strong>" ~ _("Letzte Auslesung") ~ "</strong>" %}
 {% block bodytab1 %}
 <div class="container-fluid m-2">
-	<pre>{{ p._lastresultstr }}</pre>
+	<pre id="laststr">{{ p._lastresultstr }}</pre>
 </div>
 {% endblock bodytab1 %}
 
@@ -118,6 +120,6 @@
 {% set tab3title = "<strong>" ~ _("Letzte Auslesung einfache jq Abfragesyntax") ~ "</strong>" %}
 {% block bodytab3 %}
 <div class="container-fluid m-2">
-	<pre>{{ p._lastresultjq }}</pre>
+	<pre id="lastjq">{{ p._lastresultjq }}</pre>
 </div>
 {% endblock bodytab3 %}

From 6a5efe38e1b4edab5df011865de5da22b946e8fa Mon Sep 17 00:00:00 2001
From: Onkel Andy <onkelandy@hotmail.com>
Date: Tue, 19 Sep 2023 00:01:10 +0200
Subject: [PATCH 4/5] jsonread plugin: update locale

---
 jsonread/locale.yaml | 14 ++++++--------
 1 file changed, 6 insertions(+), 8 deletions(-)

diff --git a/jsonread/locale.yaml b/jsonread/locale.yaml
index c0984a9ee..ee2846628 100755
--- a/jsonread/locale.yaml
+++ b/jsonread/locale.yaml
@@ -1,10 +1,8 @@
 # translations for the web interface
 plugin_translations:
-    # Translations for the plugin specially for the web interface
-    'Wert 2':         {'de': '=', 'en': 'Value 2'}
-    'Wert 4':         {'de': '=', 'en': 'Value 4'}
-
-    # Alternative format for translations of longer texts:
-    'Hier kommt der Inhalt des Webinterfaces hin.':
-        de: '='
-        en: 'Here goes the content of the web interface.'
+    'Item':                                       {'de': '=', 'en': '='}
+    'jsonread_filter':                            {'de': '=', 'en': '='}
+    'Wert':                                       {'de': '=', 'en': 'Value'}
+    'Letzte Auslesung':                           {'de': '=', 'en': 'Last Reading'}
+    'Items definiert':                            {'de': '=', 'en': 'Items defined'}
+    'Letzte Auslesung einfache jq Abfragesyntax': {'de': '=', 'en': 'Last Reading simple jq query syntax'}

From a86a472f93e542fe09531bcbf3efa3f4182f07cd Mon Sep 17 00:00:00 2001
From: Onkel Andy <onkelandy@hotmail.com>
Date: Tue, 19 Sep 2023 00:23:10 +0200
Subject: [PATCH 5/5] jsonread plugin: add datatableAdditional class to webif
 table

---
 jsonread/webif/templates/index.html | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/jsonread/webif/templates/index.html b/jsonread/webif/templates/index.html
index dcb1f0348..4302c869d 100755
--- a/jsonread/webif/templates/index.html
+++ b/jsonread/webif/templates/index.html
@@ -100,7 +100,7 @@
 {% set tab2title = "<strong>" ~ item_count ~ " " ~ _("Items definiert") ~ "</strong>" %}
 {% block bodytab2 %}
 
-		<table id="itemtable">
+		<table id="itemtable" class="dataTableAdditional">
 			<tbody>
 			{% for item in p._items %}
 				<tr><td></td>