diff --git a/.github/workflows/builddevdoc.yml b/.github/workflows/builddevdoc.yml
index 1c9f3bb79..b2e931ce8 100755
--- a/.github/workflows/builddevdoc.yml
+++ b/.github/workflows/builddevdoc.yml
@@ -12,7 +12,7 @@ jobs:
strategy:
fail-fast: false
matrix:
- python-version: [ '3.8' ]
+ python-version: [ '3.9' ]
name: Python ${{ matrix.python-version }}
steps:
- name: update OS (Ubuntu)
diff --git a/.github/workflows/pr_unittests.yml b/.github/workflows/pr_unittests.yml
new file mode 100755
index 000000000..5348cc5e0
--- /dev/null
+++ b/.github/workflows/pr_unittests.yml
@@ -0,0 +1,67 @@
+name: "Unittests Plugins"
+#on: [workflow_dispatch, push]
+on:
+ workflow_dispatch:
+ pull_request:
+ branches:
+ - 'develop'
+
+jobs:
+ build:
+ runs-on: ubuntu-20.04 #latest
+ strategy:
+ fail-fast: false
+ matrix:
+ python-version: [ '3.7', '3.8', '3.9', '3.10', '3.11' ]
+ name: Python ${{ matrix.python-version }}
+ steps:
+ - name: Setup OS (Ubuntu)
+ run: |
+ sudo apt-get update
+ sudo apt-get install libudev-dev
+ sudo apt-get install librrd-dev libpython3-dev
+ sudo apt-get install gcc --only-upgrade
+
+ - name: Get branch name
+ run: |
+ echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
+ echo ${GITHUB_REF#refs/heads/}
+ id: extract_branch
+
+ - name: Checkout core from develop branch
+ uses: actions/checkout@v3
+ with:
+ repository: smarthomeNG/smarthome
+ ref: develop
+
+ - name: Checkout plugins from ${{steps.extract_branch.outputs.branch}} branch
+ uses: actions/checkout@v3
+ with:
+ repository: smarthomeNG/plugins
+ ref: ${{steps.extract_branch.outputs.branch}}
+ path: plugins
+
+ - name: Set up Python
+ uses: actions/setup-python@v3
+ with:
+ python-version: ${{ matrix.python-version }}
+ architecture: x64
+ - run: python3 -m pip install --upgrade pip
+
+ - name: Install requirements for unit testing
+ run: pip install -r tests/requirements.txt
+ - name: Build Requirements for SmartHomeNG
+ run: python3 tools/build_requirements.py
+ - name: Install SmartHomeNG base requirements
+ # base requirements are needed for pytest to run
+ run: pip install -r requirements/base.txt
+
+ # --- up to here, the workflow is identical for CORE and PLUGINS ---
+
+ - name: Install SmartHomeNG all requirements
+ # all requirements are needed for pytest to run plugin tests
+ run: pip install -r requirements/all.txt
+
+ - name: '>>> Run Python Unittests for PLUGINS <<<'
+ working-directory: ./plugins
+ run: pytest
diff --git a/.github/workflows/unittests.yml b/.github/workflows/unittests.yml
index ca5d25c35..9f9ce13c0 100755
--- a/.github/workflows/unittests.yml
+++ b/.github/workflows/unittests.yml
@@ -13,7 +13,7 @@ jobs:
strategy:
fail-fast: false
matrix:
- python-version: [ '3.7', '3.8', '3.9', '3.10' ]
+ python-version: [ '3.7', '3.8', '3.9', '3.10', '3.11' ]
name: Python ${{ matrix.python-version }}
steps:
- name: Setup OS (Ubuntu)
diff --git a/__init__.py b/__init__.py
index 7e1f7bf73..81149b466 100755
--- a/__init__.py
+++ b/__init__.py
@@ -1,5 +1,5 @@
def plugin_release():
- return '1.9.3'
+ return '1.9.4'
def plugin_branch():
return 'master'
diff --git a/alexa4p3/plugin.yaml b/alexa4p3/plugin.yaml
index 999e021f7..6f83c5f54 100755
--- a/alexa4p3/plugin.yaml
+++ b/alexa4p3/plugin.yaml
@@ -143,9 +143,24 @@ item_attributes:
description:
de: 'URL für das Standbild einer Kamera'
en: 'URL for the preview picture of the camera'
-# alexa_alias:
-# type: str
-# mandatory: False
-# description:
-# de: 'nur für Payload-V2 benötigt'
-# en: 'only for Payload V2 needed'
+
+ alexa_alias:
+ type: str
+ mandatory: False
+ description:
+ de: 'Alternative Alexa-Gerätenamen, um das Gerät anzusprechen'
+ en: 'alternative Alexa device names to access the device'
+
+ alexa_range_delta:
+ type: str
+ mandatory: False
+ description:
+ de: ''
+ en: ''
+
+ alexa_color_temp_delta:
+ type: str
+ mandatory: False
+ description:
+ de: ''
+ en: ''
diff --git a/avdevice/__init__.py b/avdevice/__init__.py
index 30af170a3..0b7d30c99 100755
--- a/avdevice/__init__.py
+++ b/avdevice/__init__.py
@@ -122,7 +122,6 @@ def __init__(self, smarthome):
rs232_timeout = self.get_parameter_value('rs232_timeout')
update_exclude = self.get_parameter_value('update_exclude')
statusquery = self.get_parameter_value('statusquery')
- self.webif_pagelength = self.get_parameter_value('webif_pagelength')
# Initializing all variables
self.logger.debug("Initializing {}: Resendwait: {}. Seconds to keep: {}.".format(self._name, self._resend_wait,
diff --git a/avdevice/plugin.yaml b/avdevice/plugin.yaml
index ec5f540be..8afaf1461 100755
--- a/avdevice/plugin.yaml
+++ b/avdevice/plugin.yaml
@@ -3,17 +3,17 @@ plugin:
# Global plugin attributes
type: interface # plugin type (gateway, interface, protocol, system, web)
description:
- de: 'Steuerung von diversen AV Geräten über TCP/IP und RS232 Schnittstelle'
- en: 'Controlling AV devices via TCP/IP and RS232'
+ de: 'Steuerung eines AV Gerätes über TCP/IP oder RS232 Schnittstelle'
+ en: 'Controlling AV devices via TCP/IP or RS232'
description_long:
- de: 'Steuerung von diversen AV Geräten über TCP/IP und RS232 Schnittstelle.
+ de: 'Steuerung eines AV Gerätes über TCP/IP oder RS232 Schnittstelle.
Das Plugin unterstützt eine Vielzahl von AV-Geräten und wurde mit folgenden Geräten getestet:
- Pioneer AV Receiver < 2016
- Denon AV Receiver > 2016
- Epson Projektor < 2010
- Oppo UHD Player
'
- en: 'Controlling AV devices via TCP/IP and RS232
+ en: 'Controlling AV devices via TCP/IP or RS232
The plugin supports a variety of AV devices and was tested with the following models:
- Pioneer AV Receiver < 2016
- Denon AV Receiver > 2016
@@ -28,7 +28,6 @@ plugin:
state: ready
keywords: av denon pioneer epson oppo player amp receiver projector rs232 telnet tcpip remote control
-# documentation: https://github.com/smarthomeNG/smarthome/wiki/CLI-Plugin # url of documentation (wiki) page
support: https://knx-user-forum.de/forum/supportforen/smarthome-py/1097870-neues-plugin-av-device-f%C3%BCr-yamaha-pioneer-denon-etc
version: 1.6.4 # Plugin version
@@ -269,27 +268,6 @@ parameters:
de: "Verbindet sich das Plugin, werden die Werte automatisch abgefragt, auch wenn kein Depend=Init im Item angegeben ist. Sollen nur Items abgefragt werden, bei denen das depend-Attribut auf init gesetzt ist, sollte dieser Wert auf False gestellt werden."
en: "As soon as the plugin connects to the device the values get queried automatically even if the Depend=Init is not set in the items. If you want to query only those items that are set explicitly change this value to False."
- webif_pagelength:
- type: int
- default: 0
- valid_list:
- - -1
- - 0
- - 25
- - 50
- - 100
- description:
- de: 'Anzahl an Items, die standardmäßig in einer Web Interface Tabelle pro Seite angezeigt werden.
- 0 = automatisch, -1 = alle'
- en: 'Amount of items being listed in a web interface table per page by default.
- 0 = automatic, -1 = all'
- description_long:
- de: 'Anzahl an Items, die standardmäßig in einer Web Interface Tabelle pro Seite angezeigt werden.\n
- Bei 0 wird die Tabelle automatisch an die Höhe des Browserfensters angepasst.\n
- Bei -1 werden alle Tabelleneinträge auf einer Seite angezeigt.'
- en: 'Amount of items being listed in a web interface table per page by default.\n
- 0 adjusts the table height automatically based on the height of the browser windows.\n
- -1 shows all table entries on one page.'
item_attributes:
diff --git a/avdevice/user_doc.rst b/avdevice/user_doc.rst
index 6f79f14a3..a6f1683b3 100755
--- a/avdevice/user_doc.rst
+++ b/avdevice/user_doc.rst
@@ -1,15 +1,35 @@
.. index:: Plugins; avdevice
.. index:: avdevice
+========
avdevice
-########
+========
+
+.. image:: webif/static/img/plugin_logo.png
+ :alt: plugin logo
+ :width: 300px
+ :height: 300px
+ :scale: 50 %
+ :align: left
+
+Steuerung eines AV Gerätes über TCP/IP oder RS232 Schnittstelle.
+
+Das Plugin unterstützt eine Vielzahl von AV-Geräten und wurde mit folgenden Geräten getestet:
+- Pioneer AV Receiver < 2016
+- Denon AV Receiver > 2016
+- Epson Projektor < 2010
+- Oppo UHD Player
+
Konfiguration
=============
-.. important::
+Diese Plugin Parameter und die Informationen zur Item-spezifischen Konfiguration des Plugins sind
+unter :doc:`/plugins_doc/config/avdevice` beschrieben.
+
- Die Informationen zur Konfiguration des Plugins sind unter :doc:`/plugins_doc/config/avdevice` beschrieben.
+plugin.yaml
+-----------
.. code-block:: yaml
@@ -428,8 +448,8 @@ die richtige Zuordnung eine Rolle spielt (außer bei der Angabe von {str}).
Dieses Feature befindet sich immer noch in der Entwicklung. Erfahrungen bitte im Support Thread
im KNX-Forum teilen.
-Webinterface
-============
+Web Interface
+=============
Das Webinterface kann genutzt werden, um die Items und deren Werte auf einen Blick zu sehen,
die dem Plugin zugeordner sind. Außerdem können Historien von Kommandos und Abfragen
diff --git a/avdevice/webif/__init__.py b/avdevice/webif/__init__.py
index 215caaed9..b63dd7f10 100755
--- a/avdevice/webif/__init__.py
+++ b/avdevice/webif/__init__.py
@@ -95,10 +95,7 @@ def index(self, action=None, item_id=None, item_path=None, reload=None):
keep_cleared = True
tmpl = self.tplenv.get_template('index.html')
- try:
- pagelength = self.plugin.webif_pagelength
- except Exception:
- pagelength = 100
+ 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,
config_reloaded=config_reloaded, query_cleared=query_cleared,
diff --git a/avdevice/webif/templates/index.html b/avdevice/webif/templates/index.html
index 44374c299..d86af636b 100755
--- a/avdevice/webif/templates/index.html
+++ b/avdevice/webif/templates/index.html
@@ -18,31 +18,34 @@
{% endblock pluginscripts %}
+
+{% if tr064_item_count > 0 %}
+ {% set start_tab = 1 %}
+{% endif %}
-
+
{% set tabcount = 6 %}
-{% set tab1title = _(""'AVM Items'" (" ~ avm_item_count ~ ") ") %}
+
+{% if p._fritz_device and tr064_item_count > 0 %}
+ {% set tab1title = _(""'AVM TR-064 Items'" (" ~ tr064_item_count ~ ") ") %}
+{% else %}
+ {% set tab2title = "hidden" %}
+{% endif %}
-{% if p.aha_http_interface and smarthome_item_count > 0 %}
- {% set tab2title = _(""'AVM Smarthome Items'" (" ~ smarthome_item_count ~ ") ") %}
+{% if p._fritz_home and aha_item_count > 0 %}
+ {% set tab2title = _(""'AVM AHA Items'" (" ~ aha_item_count ~ ") ") %}
{% else %}
{% set tab2title = "hidden" %}
{% endif %}
-{% if p.aha_http_interface %}
- {% set tab3title = _(""'AVM Smarthome Devices'" (" ~ len(p._fritz_device._smarthome_devices) ~ ") ") %}
+{% if p._fritz_home and len(p._fritz_home._aha_devices) > 0%}
+ {% set tab3title = _(""'AVM AHA Devices'" (" ~ len(p._fritz_home._aha_devices) ~ ") ") %}
{% else %}
{% set tab3title = "hidden" %}
{% endif %}
{% if p._call_monitor and call_monitor_item_count > 0 %}
- {% set tab4title = _(""'Call Monitor Items'" (" ~ call_monitor_item_count ~ ") ") %}
+ {% set tab4title = _(""'AVM Call Monitor Items'" (" ~ call_monitor_item_count ~ ") ") %}
{% else %}
{% set tab4title = "hidden" %}
{% endif %}
-{% set tab5title = _(""'Log-Einträge'"") %}
-
-{% set tab6title = _(""'Plugin-API'"") %}
+{% set tab5title = _(""'AVM Log-Einträge'"") %}
+{% if not maintenance %}
+ {% set tab6title = _(""'AVM Plugin-API'"") %}
+{% else %}
+ {% set tab6title = _(""'AVM Maintenance'"") %}
+{% endif %}
{% set language = p.get_sh().get_defaultlanguage() %}
@@ -136,13 +183,15 @@
{% set language = 'en' %}
{% endif %}
+
{% block headtable %}
{{ webif_pagelength }}
+
- {% if p.get_fritz_device().is_available() %}
+ {% if p._fritz_device %}
{% else %}
@@ -150,8 +199,8 @@
{{ _('Verbunden') }}
- {% set logentries = p.get_device_log_from_lua_separated() %}
{% if logentries %}
{% for logentry in logentries%}
+
{{ logentry[0] }}
{{ logentry[1] }}
@@ -352,37 +413,89 @@
{% endif %}
+
{% endblock %}
+
{% block bodytab6 %}
- {% for function, dict in p.metadata.plugin_functions.items() %}
-
-
- {{ dict['type'] }} {{ function }}({% if dict['parameters'] is not none %}{% for name, paramdict in dict['parameters'].items() %}{% if loop.index > 1 %}, {% endif %}{{ name }}: {{ paramdict['type'] }}{% endfor %}{% endif %})
-
-
- {{ dict['description'][language] }}
- {% if dict['parameters'] is not none %}
-
-
- {{ _('Parameter') }}:
-
-
-
- {% for name, paramdict in dict['parameters'].items() %}
-
Font Awesome licensed under SIL OFL 1.1 Font Awesome CSS, LESS, and Sass files are licensed under the MIT License Font Awesome icons (all icons packaged as .svg and .js files) are licensed under the CC BY 4.0 License
- MIT License
-
- Copyright (c) 2011-2016 Twitter, Inc.
-
- Permission is hereby granted, free of charge, to any person obtaining a copy
- of this software and associated documentation files (the "Software"), to deal
- in the Software without restriction, including without limitation the rights
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- copies of the Software, and to permit persons to whom the Software is
- furnished to do so, subject to the following conditions:
-
- The above copyright notice and this permission notice shall be included in all
- copies or substantial portions of the Software.
-
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- SOFTWARE.
-
-
-
-
-
-
-
Bootstrap Tree View:
-
- Copyright 2013 Jonathan Miles
-
- Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-
-
-
-
-
-
-
Bootstrap Datepicker:
-
Licensed under the Apache License v2.0 (http://www.apache.org/licenses/LICENSE-2.0)
-
-
-
-
-
-
-
CodeMirror 5.39.0:
-
- Copyright (C) 2017 by Marijn Haverbeke and others
-
- Permission is hereby granted, free of charge, to any person obtaining a copy
- of this software and associated documentation files (the "Software"), to deal
- in the Software without restriction, including without limitation the rights
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- copies of the Software, and to permit persons to whom the Software is
- furnished to do so, subject to the following conditions:
-
- The above copyright notice and this permission notice shall be included in
- all copies or substantial portions of the Software.
-
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- THE SOFTWARE.
-
-
-
-
-
-
-
Font Awesome 5.1.0 (Free)
-
- Font Awesome Free is free, open source, and GPL friendly. You can use it for
- commercial projects, open source projects, or really almost whatever you want.
- Full Font Awesome Free license: https://fontawesome.com/license.
-
- # Icons:
- CC BY 4.0 License (https://creativecommons.org/licenses/by/4.0/)
- In the Font Awesome Free download, the CC BY 4.0 license applies to all icons
- packaged as SVG and JS file types.
-
- # Fonts:
- SIL OFL 1.1 License (https://scripts.sil.org/OFL)
- In the Font Awesome Free download, the SIL OLF license applies to all icons
- packaged as web and desktop font files.
-
- # Code:
- MIT License (https://opensource.org/licenses/MIT)
- In the Font Awesome Free download, the MIT license applies to all non-font and
- non-icon files.
-
- # Attribution
- Attribution is required by MIT, SIL OLF, and CC BY licenses. Downloaded Font
- Awesome Free files already contain embedded comments with sufficient
- attribution, so you shouldn't need to do anything additional when using these
- files normally.
-
- We've kept attribution comments terse, so we ask that you do not actively work
- to remove them from files, especially code. They're a great way for folks to
- learn about Font Awesome.
-
- # Brand Icons
- All brand icons are trademarks of their respective owners. The use of these
- trademarks does not indicate endorsement of the trademark holder by Font
- Awesome, nor vice versa. **Please do not use brand logos for any purpose except
- to represent the company, product, or service to which they refer.**
-
-
-
-
-
-
-
JQuery 3.3.1:
-
- MIT License
-
- Copyright jQuery Foundation and other contributors, https://jquery.org/
-
- This software consists of voluntary contributions made by many
- individuals. For exact contribution history, see the revision history
- available at https://github.com/jquery/jquery
-
- The following license applies to all parts of this software except as
- documented below:
-
-
-
- Permission is hereby granted, free of charge, to any person obtaining
- a copy of this software and associated documentation files (the
- "Software"), to deal in the Software without restriction, including
- without limitation the rights to use, copy, modify, merge, publish,
- distribute, sublicense, and/or sell copies of the Software, and to
- permit persons to whom the Software is furnished to do so, subject to
- the following conditions:
-
- The above copyright notice and this permission notice shall be
- included in all copies or substantial portions of the Software.
-
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
- NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
- LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
- OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
- WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-
- All files located in the node_modules and external directories are
- externally maintained libraries used by this software which have their
- own licenses; we recommend you read them, as their terms may differ from
- the terms above.
- {% endif %}
- {% if loop.index %2 > 0 and loop.last %}
-
- {% endif %}
- {% if loop.index % 2 > 0 and not first %}
-
- {% else %}
- {% set first = False %}
- {% endif %}
- {% endfor %}
-
-
-
- {% if p.metadata.get_itemdefinitionlist()|length > 0 %}
-
{{ _('Plugin spezifische Item Attribute') }}:
-
-
- {{ 'Die folgenden Item Attribute werden durch das Plugin definiert:' }}
- {% set first = True %}
- {% for key in p.metadata.get_itemdefinitionlist() %}
- {% if loop.index % 2 > 0 %}
-
- {% for value in scene['values'] %}
- {% for action in value['action_list'] %}
- {% if (action == value['action_list'][0]) and (value['action_name'] != '') %}
-
-
-
{{ value['action'] }}: {{ value['action_name'] }}
-
-
-
- {% endif %}
-
-
- {% if (action == value['action_list'][0]) and (value['action_name'] == '') %}
-
{{ value['action'] }}:
- {% else %}
-
- {% endif %}
- {% if action[2] %}
-
{{ _('ja') }}
- {% else %}
-
{{ _('nein') }}
- {% endif %}
-
{{ action[0] }}
- {% if (action[3] == None) or (action[3] == action[1]) %}
-
{{ action[1] }}
- {% else %}
-
{{ action[3] }} (default: {{ action[1] }})
- {% endif %}
-
-
- {% endfor %}
- {% endfor %}
-
- {% endfor %}
- {% if not supported %}
-
diff --git a/blockly/tests/test_backend_blocklylogics.py b/blockly/tests/test_backend_blocklylogics.py
index e95b687ae..fe2bcc4e4 100755
--- a/blockly/tests/test_backend_blocklylogics.py
+++ b/blockly/tests/test_backend_blocklylogics.py
@@ -8,8 +8,9 @@
import lib.item
-from plugins.backend import WebInterface as Root
-from plugins.backend.tests.cptestcase import BaseCherryPyTestCase
+#from plugins.backend import WebInterface as Root
+#from plugins.backend.tests.cptestcase import BaseCherryPyTestCase
+from .cptestcase import BaseCherryPyTestCase
from tests.mock.core import MockSmartHome
@@ -31,9 +32,9 @@ def tearDownModule():
class TestCherryPyApp(BaseCherryPyTestCase):
def test_blockly(self):
pass
- # dummy, because tests are from the tightly coupled 1. try do integrate blockly
+ # dummy, because tests are from the tightly coupled 1. try do integrate blockly
# (before it became a seperate plugin)
-
+
# def test_backendIntegration(self):
# response = self.request('index')
# self.assertEqual(response.output_status, b'200 OK')
diff --git a/casambi/__init__.py b/casambi/__init__.py
index a944ff9d2..2e08cf23c 100755
--- a/casambi/__init__.py
+++ b/casambi/__init__.py
@@ -7,9 +7,6 @@
# https://www.smarthomeNG.de
# https://knx-user-forum.de/forum/supportforen/smarthome-py
#
-# Sample plugin for new plugins to run with SmartHomeNG version 1.4 and
-# upwards.
-#
# SmartHomeNG is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
@@ -28,6 +25,7 @@
from lib.module import Modules
from lib.model.smartplugin import *
from lib.item import Items
+from .webif import WebInterface
import threading
import requests
@@ -42,7 +40,7 @@ class Casambi(SmartPlugin):
"""
# Use VERSION = '1.0.0' for your initial plugin Release
- PLUGIN_VERSION = '1.7.5' # (must match the version specified in plugin.yaml)
+ PLUGIN_VERSION = '1.7.6' # (must match the version specified in plugin.yaml)
def __init__(self, sh):
"""
@@ -90,8 +88,8 @@ def __init__(self, sh):
self._init_complete = False
return
- self.init_webinterface()
-
+ self.init_webinterface(WebInterface)
+
return
def sessionIDValid(self):
@@ -328,8 +326,7 @@ def decodeEventData(self, receivedData):
elif method == 'unitChanged':
unitID = None
- on = None # on status represents the status of the BLE module in the device, not the light status.
- status = None
+ status = None # Health status of sensor
dimValue = None
verticalValue = None
cctValue = None
@@ -337,10 +334,11 @@ def decodeEventData(self, receivedData):
self.logger.debug("Debug Json unitChanged: {0}".format(dataJson))
if 'id' in dataJson:
unitID = int(dataJson['id'])
- if 'on' in dataJson:
- on = bool(dataJson['on'])
if 'status' in dataJson:
status = str(dataJson['status'])
+ if status != 'ok':
+ self.logger.warning(f"Sensor with ID {unitID} reported status {status}")
+
if 'controls' in dataJson:
controls = dataJson['controls']
self.logger.debug(f"Debug controls Json: {controls}")
@@ -360,15 +358,15 @@ def decodeEventData(self, receivedData):
elif type == 'CCT':
cctValue = value
-
- self.logger.debug(f"Received {method} status from unit {unitID}, on: {on}, value: {dimValue}, vertical: {verticalValue}, cct: {cctValue}.")
+ self.logger.debug(f"Received {method} status from unit {unitID}, value: {dimValue}, vertical: {verticalValue}, cct: {cctValue}.")
#Copy data into casambi item:
if unitID and (unitID in self._rx_items):
#self.logger.debug("Casambi ID found in rx item list")
# iterate over all items having this id
for item in self._rx_items[unitID]:
- if on and (item.conf['casambi_rx_key'].upper() == 'ON'):
+ #if on and (item.conf['casambi_rx_key'].upper() == 'ON'):
+ if (item.conf['casambi_rx_key'].upper() == 'ON'):
item(not (dimValue == 0), self.get_shortname())
elif item.conf['casambi_rx_key'].upper() == 'DIMMER':
item(dimValue * 100, self.get_shortname())
@@ -379,6 +377,15 @@ def decodeEventData(self, receivedData):
elif unitID and not (unitID in self._rx_items):
self.logger.warning(f"Received status information for ID {unitID} which has no equivalent item.")
+
+ elif method == 'networkUpdated':
+ self.logger.warning(f"Casambi network has been updated with persistent changes")
+ self.logger.warning(f"Debug: decodeData(), receivedData: {receivedData}")
+
+ elif method == 'networkLog':
+ self.logger.debug(f"Casambi network sent network logging information")
+ self.logger.debug(f"Debug: decodeData(), receivedData: {receivedData}")
+
else:
self.logger.warning(f"Received unknown method {method} which is not supported.")
self.logger.warning(f"Debug: decodeData(), receivedData: {receivedData}")
@@ -589,110 +596,3 @@ def update_item(self, item, caller=None, source=None, dest=None):
def get_rxItemLength(self):
return len(self._rx_items)
- def init_webinterface(self):
- """"
- Initialize the web interface for this plugin
-
- This method is only needed if the plugin is implementing a web interface
- """
- try:
- self.mod_http = Modules.get_instance().get_module(
- 'http') # try/except to handle running in a core version that does not support modules
- except:
- self.mod_http = None
- if self.mod_http == None:
- self.logger.error("Not initializing the web interface")
- return False
-
- import sys
- if not "SmartPluginWebIf" in list(sys.modules['lib.model.smartplugin'].__dict__):
- self.logger.warning("Web interface needs SmartHomeNG v1.5 and up. Not initializing the web interface")
- return False
-
- # set application configuration for cherrypy
- webif_dir = self.path_join(self.get_plugin_dir(), 'webif')
- config = {
- '/': {
- 'tools.staticdir.root': webif_dir,
- },
- '/static': {
- 'tools.staticdir.on': True,
- 'tools.staticdir.dir': 'static'
- }
- }
-
- # Register the web interface as a cherrypy app
- self.mod_http.register_webif(WebInterface(webif_dir, self),
- self.get_shortname(),
- config,
- self.get_classname(), self.get_instance_name(),
- description='')
-
- return True
-
-
-# ------------------------------------------
-# Webinterface of the plugin
-# ------------------------------------------
-
-import cherrypy
-from jinja2 import Environment, FileSystemLoader
-
-
-class WebInterface(SmartPluginWebIf):
-
- def __init__(self, webif_dir, plugin):
- """
- Initialization of instance of class WebInterface
-
- :param webif_dir: directory where the webinterface of the plugin resides
- :param plugin: instance of the plugin
- :type webif_dir: str
- :type plugin: object
- """
- self.logger = logging.getLogger(__name__)
- self.webif_dir = webif_dir
- self.plugin = plugin
- self.tplenv = self.init_template_environment()
-
- self.items = Items.get_instance()
-
- @cherrypy.expose
- def index(self, reload=None):
- """
- Build index.html for cherrypy
-
- Render the template and return the html file to be delivered to the browser
-
- :return: contents of the template after beeing rendered
- """
- tmpl = self.tplenv.get_template('index.html')
- # add values to be passed to the Jinja2 template eg: tmpl.render(p=self.plugin, interface=interface, ...)
- return tmpl.render(p=self.plugin, items=sorted(self.items.return_items(), key=lambda k: str.lower(k['_path'])))
-
-
- @cherrypy.expose
- def get_data_html(self, dataSet=None):
- """
- Return data to update the webpage
-
- For the standard update mechanism of the web interface, the dataSet to return the data for is None
-
- :param dataSet: Dataset for which the data should be returned (standard: None)
- :return: dict with the data needed to update the web page.
- """
- if dataSet is 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(f"get_data_html exception: {e}")
- return {}
-
diff --git a/casambi/plugin.yaml b/casambi/plugin.yaml
index 343b726c0..6b5833bd2 100755
--- a/casambi/plugin.yaml
+++ b/casambi/plugin.yaml
@@ -12,7 +12,7 @@ plugin:
# documentation: https://github.com/smarthomeNG/smarthome/wiki/CLI-Plugin # url of documentation (wiki) page
support: https://knx-user-forum.de/forum/supportforen/smarthome-py/1496182-supportthread-f%C3%BCr-casambi-plugin
- version: 1.7.5 # Plugin version (must match the version specified in __init__.py)
+ version: 1.7.6 # Plugin version (must match the version specified in __init__.py)
sh_minversion: 1.7 # minimum shNG version to use this plugin
# sh_maxversion: # maximum shNG version to use this plugin (leave empty if latest)
multi_instance: False # plugin supports multi instance
diff --git a/casambi/user_doc.rst b/casambi/user_doc.rst
index 92fcdb050..973f7a6fc 100755
--- a/casambi/user_doc.rst
+++ b/casambi/user_doc.rst
@@ -1,10 +1,17 @@
-.. index:: Plugins; casambi (Casambi REST API Unterstützung)
+.. index:: Plugins; casambi
.. index:: casambi
=======
casambi
=======
+.. image:: webif/static/img/plugin_logo.png
+ :alt: plugin logo
+ :width: 300px
+ :height: 300px
+ :scale: 50 %
+ :align: left
+
Dieses Plugin unterstützt Casambi und Occhio Lichter durch die Verwendung des Casambi Backend API.
Die Kommunikation erfolgt über Bluetooth Low Energy (BLE) und die Casambi Produkte sind in vielen
Geräten verbaut, beispielsweise von Occhio.
@@ -20,14 +27,13 @@ Die Informationen zur Konfiguration des Plugins sind unter :doc:`/plugins_doc/co
Gateway Hardware
================
-According to the Casambi concept, a mobile device (cell phone or tablet) is used as hardware gateway between local
-BLE network and Casambi backend.
+Das Casambi Konzept sieht vor, ein Mobilgerät (z.B. Handy oder Tablett) als Hardwaregateway zwischen dem lokalen BLE Netzwerk und dem Casambi Backend
+enzusetzen.
-Requirements
+Anforderungen
============
-
-The plugin needs a valid Casambi API key which can be obtained from Casambi under:
-support@casambi.com
+Das Casambi Plugin benötigt einen validen Casambi API key, der hier beantragt werden kann:
+``support@casambi.com``
Beispiele
@@ -134,3 +140,22 @@ Im ersten Tab werden die Items angezeigt, die das Casambi Plugin nutzen:
.. image:: assets/webif1.jpg
:class: screenshot
+
+
+Changelog
+=========
+
+V1.7.5
+ improved webinterface
+ improved command sending, if connection is no longer available (broken pipe). Resent once immediately.
+
+V1.7.4
+ added backend online status parsing to item
+ removed unjustified warning messages
+
+V1.7.3
+ added support for tunable white devices
+
+V1.7.1
+ Initial release
+
diff --git a/casambi/webif/__init__.py b/casambi/webif/__init__.py
new file mode 100755
index 000000000..fd604010b
--- /dev/null
+++ b/casambi/webif/__init__.py
@@ -0,0 +1,155 @@
+#!/usr/bin/env python3
+# vim: set encoding=utf-8 tabstop=4 softtabstop=4 shiftwidth=4 expandtab
+#########################################################################
+# Copyright 2020-
+#########################################################################
+# This file is part of SmartHomeNG.
+# https://www.smarthomeNG.de
+# https://knx-user-forum.de/forum/supportforen/smarthome-py
+#
+# Sample plugin for new plugins to run with SmartHomeNG version 1.5 and
+# upwards.
+#
+# SmartHomeNG is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# SmartHomeNG 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with SmartHomeNG. If not, see .
+#
+#########################################################################
+
+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
+from jinja2 import Environment, FileSystemLoader
+
+
+class WebInterface(SmartPluginWebIf):
+
+ def __init__(self, webif_dir, plugin):
+ """
+ Initialization of instance of class WebInterface
+
+ :param webif_dir: directory where the webinterface of the plugin resides
+ :param plugin: instance of the plugin
+ :type webif_dir: str
+ :type plugin: object
+ """
+ self.logger = plugin.logger
+ self.webif_dir = webif_dir
+ self.plugin = plugin
+ self.tplenv = self.init_template_environment()
+
+ self.items = Items.get_instance()
+
+ @cherrypy.expose
+ def index(self, reload=None, action=None, email=None, hashInput=None, code=None, tokenInput=None, mapIDInput=None):
+ """
+ Build index.html for cherrypy
+
+ Render the template and return the html file to be delivered to the browser
+
+ :return: contents of the template after beeing rendered
+ """
+ calculatedHash = ''
+ codeRequestSuccessfull = None
+ token = ''
+ configWriteSuccessfull = None
+ resetAlarmsSuccessfull = None
+ boundaryListSuccessfull = None
+
+
+
+ if action is not None:
+ if action == "generateHash":
+ ret = self.plugin.generateRandomHash()
+ calculatedHash = str(ret)
+ self.logger.info("Generate hash triggered via webinterface: {0}".format(calculatedHash))
+ elif action == "requestCode" and (email is not None) and (hashInput is not None):
+ self.logger.warning("Request Vorwerk code triggered via webinterface (Email:{0} hashInput:{1})".format(email, hashInput))
+ codeRequestSuccessfull = self.plugin.request_oauth2_code(str(hashInput))
+ elif action == "requestCode":
+ if email is None:
+ self.logger.error("Cannot request Vorwerk code as email is empty: {0}.".format(str(email)))
+ elif hash is None:
+ self.logger.error("Cannot request Vorwerk code as hash is empty: {0}.".format(str(email)))
+ elif action == "requestToken":
+ self.logger.info("Request Vorwerk token triggered via webinterface")
+ if (email is not None) and (hashInput is not None) and (code is not None) and (not code == '') :
+ token = self.plugin.request_oauth2_token(str(code), str(hashInput))
+ elif (code is None) or (code == ''):
+ self.logger.error("Request Vorwerk token: Email validation code missing.")
+ else:
+ self.logger.error("Request Vorwerk token: Missing argument.")
+ elif action =="writeToPluginConfig":
+ if (tokenInput is not None) and (not tokenInput == ''):
+ self.logger.warning("Writing token to plugin.yaml")
+ param_dict = {"token": str(tokenInput)}
+ self.plugin.update_config_section(param_dict)
+ configWriteSuccessfull = True
+ else:
+ self.logger.error("writeToPluginConfig: Missing argument.")
+ configWriteSuccessfull = False
+ elif action =="clearAlarms":
+ self.logger.warning("Resetting alarms via webinterface")
+ self.plugin.dismiss_current_alert()
+ resetAlarmsSuccessfull = True
+ elif action =="listAvailableMaps":
+ self.logger.warning("List all available maps via webinterface")
+ boundaryListSuccessfull = self.plugin.get_map_boundaries(map_id=mapIDInput)
+ else:
+ self.logger.error("Unknown command received via webinterface")
+
+ tmpl = self.tplenv.get_template('index.html')
+ # add values to be passed to the Jinja2 template eg: tmpl.render(p=self.plugin, interface=interface, ...)
+ return tmpl.render(p=self.plugin, calculatedHash=calculatedHash,
+ token=token,
+ codeRequestSuccessfull=codeRequestSuccessfull,
+ configWriteSuccessfull=configWriteSuccessfull,
+ resetAlarmsSuccessfull=resetAlarmsSuccessfull,
+ boundaryListSuccessfull=boundaryListSuccessfull,
+ items=sorted(self.items.return_items(), key=lambda k: str.lower(k['_path'])))
+
+
+ @cherrypy.expose
+ def get_data_html(self, dataSet=None):
+ """
+ Return data to update the webpage
+
+ For the standard update mechanism of the web interface, the dataSet to return the data for is None
+
+ :param dataSet: Dataset for which the data should be returned (standard: None)
+ :return: dict with the data needed to update the web page.
+ """
+ if dataSet is 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))
+ return {}
diff --git a/casambi/webif/static/img/plugin_logo.png b/casambi/webif/static/img/plugin_logo.png
new file mode 100755
index 000000000..c3ad05a45
Binary files /dev/null and b/casambi/webif/static/img/plugin_logo.png differ
diff --git a/cli/plugin.yaml b/cli/plugin.yaml
index 1976a6177..d8287f409 100755
--- a/cli/plugin.yaml
+++ b/cli/plugin.yaml
@@ -10,7 +10,7 @@ plugin:
tester: onkelandy, Sandman60, ohinckel
state: qa-passed
keywords: telnet cli command line interface remote control
- documentation: http://smarthomeng.de/user/plugins/cli/user_doc.html
+ documentation: ''
version: 1.8.2 # Plugin version
sh_minversion: 1.9.0 # minimum shNG version to use this plugin
diff --git a/cli/user_doc.rst b/cli/user_doc.rst
index e71f10669..80af9ef05 100755
--- a/cli/user_doc.rst
+++ b/cli/user_doc.rst
@@ -1,28 +1,33 @@
.. index:: Plugins; cli (CommandLine Interface)
.. index:: cli
+===
cli
-###
+===
-Konfiguration
-=============
+.. image:: webif/static/img/plugin_logo.svg
+ :alt: plugin logo
+ :width: 300px
+ :height: 300px
+ :scale: 50 %
+ :align: left
-Die Informationen zur Konfiguration des Plugins sind unter :doc:`/plugins_doc/config/cli` beschrieben.
+Dieses Plugin bietet einen Zugriff über Telnet auf SmartHomeNG.
+Über das Plugin können diverse Befehle an SmartHomeNG zur Auflistung, Debugging und Manipulation
+von Items, Logiken, Plugins und internen Objekten geschickt werden.
-Weiterführende Informationen
-============================
-Das CLI Plugin bietet einen Zugriff über Telnet auf SmartHomeNG.
+Konfiguration
+=============
-Über das Plugin können diverse Befehle an SmartHomeNG zur Auflistung, Debugging und Manipulation
-von Items, Logiken, Plugins und internen Objekten geschickt werden.
+Die Informationen zur Konfiguration des Plugins sind unter :doc:`/plugins_doc/config/cli` beschrieben.
Plugin Konfigurationsparameter
-==============================
+------------------------------
-Das Plugin kann über die folgende Konfiguration in der Datei etc/plugins.conf akitviert werden:
+Das Plugin kann über die folgende Konfiguration in der Datei etc/plugins.yaml akitviert werden:
.. code-block: yaml
cli:
@@ -129,3 +134,7 @@ CLI Befehle
| quit, q | Beendet die CLI Session |
+--------------------------+----------------------------------------------------------------------------------------------+
+Web Interface
+=============
+
+Das Webinterface zeigt nur die ingestellten Parameter des Plugins an und bietet darüber hinaus keine Funktionalität.
diff --git a/cli/webif/templates/index.html b/cli/webif/templates/index.html
index ebe5bcd27..1b31cdd8b 100755
--- a/cli/webif/templates/index.html
+++ b/cli/webif/templates/index.html
@@ -4,7 +4,7 @@
{% set update_interval = 0 %}
-
+{% set buttons = false %}
@@ -32,35 +32,20 @@
-{% endif %}
-{% endblock %}
-
diff --git a/darksky/plugin.yaml b/darksky/plugin.yaml
index 41aa4b9ac..5f08cb276 100755
--- a/darksky/plugin.yaml
+++ b/darksky/plugin.yaml
@@ -261,6 +261,10 @@ item_structs:
eval_trigger: ..time_epoch
eval: datetime.datetime.fromtimestamp(sh...time_epoch()).strftime('%HH:%MM')
+ weekday:
+ type: str
+ ds_matchstring@instance: currently/weekday
+
summary:
type: str
ds_matchstring@instance: currently/summary
diff --git a/database/__init__.py b/database/__init__.py
index ce5a78bbb..c2981012c 100755
--- a/database/__init__.py
+++ b/database/__init__.py
@@ -50,7 +50,7 @@ class Database(SmartPlugin):
"""
ALLOW_MULTIINSTANCE = True
- PLUGIN_VERSION = '1.6.3'
+ PLUGIN_VERSION = '1.6.9'
# SQL queries: {item} = item table name, {log} = log table name
# time, item_id, val_str, val_num, val_bool, changed
@@ -105,7 +105,9 @@ def __init__(self, sh, *args, **kwargs):
self.max_delete_logentries = self.get_parameter_value('max_delete_logentries')
self._default_maxage = float(self.get_parameter_value('default_maxage'))
- self.webif_pagelength = self.get_parameter_value('webif_pagelength')
+ self._copy_database = self.get_parameter_value('copy_database')
+ self._copy_database_name = self.get_parameter_value('copy_database_name')
+
self._webdata = {}
self._replace = {table: table if self._prefix == "" else self._prefix + table for table in ["log", "item"]}
@@ -116,17 +118,28 @@ def __init__(self, sh, *args, **kwargs):
self._dump_lock = threading.Lock()
self.skipping_dump = False
-
- self._handled_items = [] # items that have a 'database' attribute set
- self._items_with_maxage = [] # items that have a 'database_maxage' attribute set
- self._maxage_worklist = [] # work copy of self._items_with_maxage
- self._item_logcount = {} # dict to store the number of log records for an item
- self._items_total_entries = 0 # total number of log entries
- self._items_still_counting = False # total number of log entries
+ self._remove_older_skipped = False
+ self.lock_remove_older = False
+
+ self.orphanlist = [] # list with item names of orphant database entries
+ self._orphan_logcount = {} # dict to store the number of log records for an orphan
+ self.remove_orphan = False # set to True to remove orphans during remove_older
+ self.delete_orphan_chunk_size = 20000 # Delete x log entries for orphan items at a time
+ self._handled_items = [] # items that have a 'database' attribute set
+ self._items_with_maxage = [] # items that have a 'database_maxage' attribute set
+ self._maxage_worklist = [] # work copy of self._items_with_maxage
+ self._item_logcount = {} # dict to store the number of log records for an item
+ self._items_total_entries = 0 # total number of log entries
+ self._items_still_counting = False # total number of log entries
self.cleanup_active = False
- self.last_connect_time = 0 # mechanism for limiting db connection requests
+ self.last_connect_time = 0 # mechanism for limiting db connection requests
+ self.last_maint_connect_time = 0 # mechanism for limiting db maintenance connection requests
+
+ # Copy SQLite3 database file (if configured)
+ if self._copy_database:
+ self.copy_databasefile()
# Setup db and test if connection is possible
self._db = lib.db.Database(("" if self._prefix == "" else self._prefix.capitalize()) + "Database", self.driver, self._connect)
@@ -136,15 +149,24 @@ def __init__(self, sh, *args, **kwargs):
self._init_complete = False
return
+ # Setup db maintenance connection and test if connection is possible
+ self._db_maint = lib.db.Database(("" if self._prefix == "" else self._prefix.capitalize()) + "Database", self.driver, self._connect)
+ if self._db_maint.api_initialized == False:
+ # Error initializeng the database driver (e.g.: Python module for database driver not found)
+ self.logger.error("Initialization of database API failed for maintenance connection")
+ self._init_complete = False
+ return
+
self._db_initialized = False
+ self._db_maint_initialized = False
if not self._initialize_db():
#self._init_complete = False
#return
self.logger.debug("Init: DB could not be initialized")
pass
- self.init_webinterface(WebInterface)
+ self.init_webinterface(WebInterface)
return
@@ -154,6 +176,7 @@ def run(self):
"""
self.logger.debug("Run method called")
self._initialize_db()
+ self.build_orphanlist(True)
self._start_schedulers()
self.alive = True
@@ -167,6 +190,7 @@ def stop(self):
self._stop_schedulers()
self._dump(True)
self._db.close()
+ self._db_maint.close()
def parse_item(self, item):
@@ -331,7 +355,7 @@ def _start_schedulers(self):
self.scheduler_add('Buffer dump', self._dump, cycle=self._dump_cycle, prio=5)
if len(self._items_with_maxage) > 0:
# self.scheduler_add('Remove old', self.remove_older_than_maxage, cycle=91, prio=6)
- self.scheduler_add('Remove old', self.remove_older_than_maxage, cycle=self._removeold_cycle, prio=6)
+ self.scheduler_add('Remove old', self.remove_older_than_maxage, cycle=self._removeold_cycle, prio=7)
return
@@ -351,6 +375,41 @@ def _stop_schedulers(self):
# Database specific public functions of the plugin
# ------------------------------------------------------
+ def copy_databasefile(self):
+ """
+ For SQLite3 databases only: Copy the databasefile before it is opened
+
+ This can be used to make a backup or to use the copy for a VACUUM
+
+ :return:
+ """
+ if not self.driver.lower() == 'sqlite3':
+ self.logger.warning("Copying of database fie is only possible for SQLite3 databases")
+ param_dict = {"copy_database": False}
+ self.update_config_section(param_dict)
+ return
+
+ # get source and destination names
+ try:
+ database_name = self._connect[0]
+ database_name = database_name[9:].strip()
+ except:
+ database_name = ''
+
+ # copy the database file
+ self.logger.warning( f"Starting to copy SQLite3 database file from {database_name} to {self._copy_database_name}")
+ import shutil
+ try:
+ shutil.copy2(database_name, self._copy_database_name)
+ self.logger.warning("Finished copying SQLite3 database file")
+ except Exception as e:
+ self.logger.Error( f"Error copying SQLite3 database file: {e}")
+
+ param_dict = {"copy_database": False}
+ self.update_config_section(param_dict)
+ return
+
+
def id(self, item, create=True, cur=None):
"""
Returns the ID of the given item
@@ -366,9 +425,13 @@ def id(self, item, create=True, cur=None):
"""
try:
- id = self.readItem(str(item.id()), cur=cur)
+ item_path = str(item.id())
+ except:
+ item_path = item
+ try:
+ id = self.readItem(item_path, cur=cur)
except Exception as e:
- self.logger.warning(f"id(): No id found for item {item.id()} - Exception {e}")
+ self.logger.warning(f"id(): No id found for item {item_path} - Exception {e}")
id = None
if id is None and create == True:
@@ -379,6 +442,78 @@ def id(self, item, create=True, cur=None):
return int(id[COL_ITEM_ID])
+ def db_itemtype(self, item):
+ """
+ Returns the itemtype of the given item, determined from the item-table of the database
+
+ This is a public function of the plugin
+
+ :param item: Item to get the ID for
+
+ :return: id of the item within the database
+ :rtype: int | None
+ """
+
+ try:
+ item_path = str(item.id())
+ except:
+ item_path = item
+ try:
+ row = self.readItem(item_path, cur=None)
+ except Exception as e:
+ self.logger.warning(f"db_itemtype: No id found for item {item_path} - Exception {e}")
+ row = None
+
+ if (row is None) or (COL_ITEM_ID >= len(row)) :
+ return None
+
+ id = int(row[COL_ITEM_ID])
+ strval = row[COL_ITEM_VAL_STR]
+ numval = row[COL_ITEM_VAL_NUM]
+ boolval = row[COL_ITEM_VAL_BOOL]
+
+ if (strval is not None) and (numval is None):
+ return 'str'
+
+ if (strval is None) and (numval is not None):
+ if float(numval) != int(boolval):
+ return 'num'
+ return 'num, bool'
+
+ return 'unbekannt'
+
+
+ def db_lastchange(self, item):
+ """
+ Returns the itemtype of the given item, determined from the item-table of the database
+
+ This is a public function of the plugin
+
+ :param item: Item to get the ID for
+ :param cur: A database cursor object if available (optional)
+
+ :return: id of the item within the database
+ :rtype: int | None
+ """
+
+ try:
+ item_path = str(item.id())
+ except:
+ item_path = item
+ try:
+ row = self.readItem(item_path, cur=None)
+ except Exception as e:
+ self.logger.warning(f"db_lastchange: No id found for item {item_path} - Exception {e}")
+ row = None
+
+ if (row is None) or (COL_ITEM_ID >= len(row)):
+ return None
+
+ id = int(row[COL_ITEM_ID])
+ last_change = row[COL_ITEM_TIME]
+ return self._datetime(last_change)
+
+
def db(self):
"""
Returns the low-level database object
@@ -394,7 +529,7 @@ def db(self):
def dump(self, dumpfile, id=None, time=None, time_start=None, time_end=None, changed=None, changed_start=None,
changed_end=None, cur=None):
"""
- Creates a database dump for given criterias
+ Creates a database dump for given criterias in csv format
This is a public function of the plugin
@@ -440,6 +575,22 @@ def dump(self, dumpfile, id=None, time=None, time_start=None, time_end=None, cha
return
+ def sqlite_dump(self, dumpfile):
+
+ if self.driver.lower() != 'sqlite3':
+ self.logger.warning("SQL dump is only possible for sqlite3 databases")
+ return False
+
+ self.logger.info(f"Starting SQL file dump of the sqlite3 database to {dumpfile} ...")
+
+ with open(dumpfile, 'w') as f:
+ for line in self._db._conn.iterdump():
+ f.write(f"{line}\n")
+
+ self.logger.info("SQL file dump of sqlite3 database completed")
+ return True
+
+
def insertItem(self, name, cur=None):
"""
Create database item record for given database ID
@@ -636,19 +787,6 @@ def readOldestLog(self, id, cur=None):
params = {'id': id}
return self._fetchall("SELECT min(time) FROM {log} WHERE item_id = :id;", params, cur=cur)[0][0]
- #def readOldestLogs(self, id, cur=None):
- # """
- # Read the time of oldest log record for given database ID
- #
- # This is a public function of the plugin
- #
- # :param id: Database ID of item to read the record for
- # :param cur: A database cursor object if available (optional)
- #
- # :return: Log record for the database ID
- # """
- # params = {'id': id}
- # return self._fetchall("SELECT min(time) FROM {log} GROUP BY item_id", params, cur=cur)[0]
def readLatestLog(self, id, time=None, cur=None):
"""
@@ -754,33 +892,116 @@ def deleteLog(self, id, time=None, time_start=None, time_end=None, changed=None,
return
- def cleanup(self):
+ def build_orphanlist(self, log_activity=False):
"""
- Cleanup database
- deletes item/log records in the database if the corresponding item does not exist any more
+ Create a list of database entries which have no corresponding item in the item tree
- This is a public function of the plugin
+ called by run() once on start
:return:
"""
- self.cleanup_active = True
- self.logger.info("Database cleanup started (removal of entries without defined item)")
+ if log_activity:
+ self.logger.info("build_orphan_list: Started")
+ self.orphanitemlist = []
+ self.orphanlist = []
+
items = [item.id() for item in self._buffer]
- if not self._db.lock(60):
- self.logger.error("Can not acquire lock for database cleanup")
- self.cleanup_active = False
- return
- cur = self._db.cursor()
+ cur = self._db_maint.cursor()
try:
for item in self.readItems(cur=cur):
if item[COL_ITEM_NAME] not in items:
- self.deleteItem(item[COL_ITEM_ID], cur=cur)
+ if log_activity:
+ self.logger.info(f"- Found data for item w/o database attribute: {item[COL_ITEM_NAME]}")
+ self.orphanitemlist.append(item)
+ self.orphanlist.append(item[COL_ITEM_NAME])
except Exception as e:
- self.logger.error("Database cleanup failed: {}".format(e))
+ self.logger.error("Database build_orphan_list failed: {}".format(e))
cur.close()
- self._db.release()
- self.logger.info("Database cleanup finished")
- self.cleanup_active = False
+ self._count_orphanlogentries()
+ if log_activity:
+ self.logger.info("build_orphan_list: Finished")
+
+ return
+
+
+ def _count_orphanlogentries(self):
+ """
+ count number of log entries for all items in database
+
+ to be called by eval syntax checker
+ """
+ self.logger.info("_count_orphanlogentries: # orphan items = {}".format(len(self.orphanlist)))
+ self._items_total_entries = 0
+ for item in self.orphanlist:
+ item_id = self.id(item, create=False)
+ logcount = self.readLogCount(item_id)
+ logcount_str = f"{logcount:,}".replace(',','.')
+ self.logger.info(f"Orphan {item} (id={item_id}): {logcount_str} entries")
+ self._orphan_logcount[item_id] = logcount
+
+ return
+
+
+ def _delete_orphan(self, item_path):
+ """
+ Delete orphan item or logentries it
+
+ :param item_path: path_name of the (orphan) item to work on
+ :param limit: Maximum log entries to delete
+
+ :return: True, if item was deleted; False if only logentries were deleted
+ """
+ item_id = self.id(item_path, create=False)
+ logcount = self.readLogCount(item_id)
+ if logcount == 0:
+ self.logger.info(f"_delete_orphan: Item {item_path} has no log entries")
+ cur = self._db_maint.cursor()
+ self._execute(self._prepare("DELETE FROM {item} WHERE id = :id;"), {'id': item_id}, cur=cur)
+ self.logger.info(f"_delete_orphan: Deleted item entry for {item_path}")
+ cur.close()
+ self._db_maint.commit()
+ return True
+
+ cur = self._db_maint.cursor()
+ self._execute(self._prepare("DELETE FROM {log} WHERE item_id = :id ORDER BY time ASC LIMIT :maxrecords;"), {'id': item_id, 'maxrecords': self.delete_orphan_chunk_size}, cur=cur)
+ delete_orphan_chunk_size_str = f"{self.delete_orphan_chunk_size:,}".replace(',', '.')
+ self.logger.info(f"_delete_orphan: Deleted (up to) {delete_orphan_chunk_size_str} log entries for Item {item_path}")
+ cur.close()
+ self._db_maint.commit()
+
+ return False
+
+
+ def remove_orphan_items(self):
+ """
+ Delete item and logdata of items that have no correspondance in itemtree
+ """
+ if len(self.orphanlist) == 0:
+ self.build_orphanlist()
+
+ item = self.orphanlist.pop(0)
+ if not self._delete_orphan(item):
+ self.orphanlist.append(item)
+
+ if len(self.orphanlist) == 0:
+ self.remove_orphan = False
+ self.logger.info("remove_orphan_items: Database cleanup finished")
+
+ return
+
+
+ def cleanup(self):
+ """
+ Cleanup database
+ deletes item/log records in the database if the corresponding item does not exist any more
+
+ This is a public function of the plugin
+
+ :return:
+ """
+ self.remove_orphan = True
+ self.cleanup_active = True
+ self.logger.info("Database cleanup started (removal of entries without defined item)")
return
@@ -1090,42 +1311,6 @@ def _parse_single(self, frame):
return ts
- # def _parse_ts(self, frame):
- # """
- # Parse one frame of a duration-timestamp to a duration (in seconds)
- #
- # :param frame:
- # :return:
- # """
- # minute = 60 * 1000
- # hour = 60 * minute
- # day = 24 * hour
- # week = 7 * day
- # month = 30 * day
- # year = 365 * day
- #
- # _frames = {'i': minute, 'h': hour, 'd': day, 'w': week, 'm': month, 'y': year}
- # try:
- # return int(frame)
- # except:
- # pass
- # ts = self._timestamp(self.shtime.now())
- # if frame == 'now':
- # fac = 0
- # frame = 0
- # elif frame[-1] in _frames:
- # fac = _frames[frame[-1]]
- # frame = frame[:-1]
- # else:
- # # return parameter unchaned
- # return frame
- # try:
- # ts = ts - int(float(frame) * fac)
- # except:
- # self.logger.warning("Database: Unknown time frame '{0}'".format(frame))
- # return ts
-
-
# --------------------------------------------------------
# Database buffer routines (dump, insert and remove)
# --------------------------------------------------------
@@ -1141,14 +1326,14 @@ def _dump(self, finalize=False, items=None):
:return:
"""
if self._dump_lock.acquire(timeout=60) == False:
- self.logger.warning('Skipping dump, since an other database operation running! Data is buffered and dumped later.')
+ self.logger.notice('Skipping dump, since an other database operation running! Data is buffered and dumped later.')
self.skipping_dump = True
return
self.logger.debug('Starting dump')
if self.skipping_dump:
- self.logger.warning('Dumping buffered data from skipped dump(s).')
+ self.logger.notice('Dumping buffered data from skipped dump(s).')
self.skipping_dump = False
if not self._initialize_db():
@@ -1292,12 +1477,18 @@ def remove_older_than_maxage(self):
"""
Remove log entries older than maxage of an item
- Calls by scheduler
+ Called by scheduler
"""
- if not self._db.connected():
- self.logger.warning("remove_older_than_maxage skipped as db is not connected")
+ if self.lock_remove_older:
+ if not self._remove_older_skipped:
+ self.logger.info("remove_older_than_maxage task is manually locked")
+ self._remove_older_skipped = True
return
+ if not self._db.connected():
+ self.logger.warning("remove_older_than_maxage skipped because db is not connected")
+ return False
+
# prevent creation of more than one thread
current_thread = threading.current_thread()
current_thread_name = current_thread.name
@@ -1305,16 +1496,24 @@ def remove_older_than_maxage(self):
if t is current_thread:
continue
if t.name == current_thread_name:
- self.logger.info("remove_older_than_maxage skipped as thread with this task is already running")
+ if not self._remove_older_skipped:
+ self.logger.info("remove_older_than_maxage skipped because a thread with this task is already running")
+ self._remove_older_skipped = True
return
+ self._remove_older_skipped = False
+
+ if self.remove_orphan:
+ self.remove_orphan_items()
+
+ # go to work
if self._maxage_worklist == []:
# Fill work list, if it is empty
if self._default_maxage == 0:
self._maxage_worklist = [i for i in self._items_with_maxage]
else:
self._maxage_worklist = [i for i in self._handled_items]
- self.logger.info(f"remove_older_than_maxage: Worklist filled with {len(self._items_with_maxage)} items")
+ self.logger.info(f"remove_older_: Worklist filled with {len(self._maxage_worklist)} items")
item = self._maxage_worklist.pop(0)
itempath = item.property.path
@@ -1323,9 +1522,9 @@ def remove_older_than_maxage(self):
item_id = self.id(item, create=False)
except:
if item_id is None:
- self.logger.info(f"remove_older_than_maxage: no id for item {itempath}")
+ self.logger.info(f"remove_older_: no id for item {itempath}")
else:
- self.logger.critical(f"remove_older_than_maxage: no id for item {itempath}")
+ self.logger.critical(f"remove_older_: no id for item {itempath}")
return
# it might well be that introducing database_maxage to a very old SmartHomeNG installation will try to start
@@ -1335,16 +1534,15 @@ def remove_older_than_maxage(self):
# b) to just delete a limited number of log entries
time_end = self.get_maxage_ts(item)
timestamp_end = self._timestamp(time_end)
- self.logger.info(f"remove_older_than_maxage: item = {itempath} remove older than {time_end}")
# if delete would also remove the last logged value for the item then there might be no chance for
# ``database: init`` to retrieve the latest value.
remaining = 1
if self.get_iattr_value(item.conf, 'database').lower() == 'init':
# find out if there are still log entries after deletion of the logs
- remaining = self.readLogCount(item_id,self._timestamp( time_end + datetime.timedelta(microseconds=1)))
+ remaining = self.readLogCount(item_id, time_start=self._timestamp( time_end + datetime.timedelta(microseconds=1)))
# remaining can be larger than self._item_logcount[item_id], it depends on the rate of database updates
- #self.logger.info(f"remove_older_than_maxage: item = {itempath} has attribute init with {self._item_logcount[item_id]} log entries and will have {remaining} log entries after deletion")
+ #self.logger.info(f"remove_older_: {itempath} has attribute init with {self._item_logcount[item_id]} log entries and will have {remaining} log entries after deletion")
if remaining <= 0:
# no log entries will be there after deletion, need to go back in time for the latest logentry
@@ -1352,11 +1550,15 @@ def remove_older_than_maxage(self):
if new_must_keep_timestamp is None:
return
new_must_keep_time = self._datetime(new_must_keep_timestamp)
- self.logger.info(f"remove_older_than_maxage: item = {itempath} no remaining log entry between {time_end} and now, thus can not remove log entries older than maxage, latest log is {new_must_keep_time}")
+ self.logger.info(f"remove_older_: {itempath} no remaining log entry between {time_end} and now, thus can not remove log entries older than maxage, latest log is {new_must_keep_time}")
time_end = new_must_keep_time + datetime.timedelta(microseconds=-1)
timestamp_end = self._timestamp( time_end )
- count_log_records_to_delete = self.readLogCount(item_id,time_end=self._timestamp( time_end))
+ count_log_records_to_delete = self.readLogCount(item_id, time_end=self._timestamp( time_end))
+ count_log_records_to_delete_str = f"{count_log_records_to_delete:,}".replace(',','.')
+ max_delete_logentries_str = f"{self.max_delete_logentries:,}".replace(',','.')
+ time_end_str = time_end.strftime("%d.%m.%Y - %H:%M")
+ self.logger.debug(f"remove_older_: {itempath} remove older than {time_end_str} - {count_log_records_to_delete_str} records to delete")
# prevent to many deletions with strategy b)
# assumption is made that logentries are evenly distributed over time
@@ -1364,23 +1566,22 @@ def remove_older_than_maxage(self):
# since only a linear approximation over time and counts is used, but it should do the trick
# to prevent from database lockups after setting database_maxage to old/ancient items
if count_log_records_to_delete > self.max_delete_logentries:
- old_count_log_records_to_delete = count_log_records_to_delete
- timestamp_oldest = self.readOldestLog( item_id)
- time_oldest = self._datetime( timestamp_oldest)
- timespan_deletion = timestamp_end - timestamp_oldest
- assumed_chunk_size = count_log_records_to_delete / self.max_delete_logentries
- new_deletion_timespan = timespan_deletion / assumed_chunk_size
- timestamp_end = timestamp_oldest + new_deletion_timespan
- time_end = self._datetime( timestamp_end)
- count_log_records_to_delete = self.readLogCount(item_id,time_end=self._timestamp( time_end))
- self.logger.info(f"remove_older_than_maxage: item = {itempath} old count to delete {old_count_log_records_to_delete} was higher than {self.max_delete_logentries}")
- self.logger.info(f"remove_older_than_maxage: item = {itempath} new count to delete {count_log_records_to_delete} has end {time_end}")
-
- if count_log_records_to_delete:
+ time_start_deletion = time.time()
+ cur = self._db.cursor()
+ self._execute(self._prepare("DELETE FROM {log} WHERE item_id = :id ORDER BY time ASC LIMIT :maxrecords;"), {'id': item_id, 'maxrecords': self.max_delete_logentries}, cur=cur)
+ cur.close()
+ time_used_for_deletion = time.time() - time_start_deletion
+ self.logger.info(f"remove_older_: {itempath} deleted {max_delete_logentries_str} of {count_log_records_to_delete_str} log entries - took {time_used_for_deletion:.2f} seconds, averaging {100*time_used_for_deletion/self.max_delete_logentries:.4f} seconds per 100 entries")
+
+ # Re-Add item to worklist, since there are more records to be deleted
+ self._maxage_worklist.append(item)
+
+ elif count_log_records_to_delete:
time_start_deletion = time.time()
self.deleteLog(item_id, time_end=timestamp_end, with_commit=False)
time_used_for_deletion = time.time() - time_start_deletion
- self.logger.info(f"remove_older_than_maxage: item = {itempath} deleted {count_log_records_to_delete} log entries until {time_end} took {time_used_for_deletion} seconds, averaging {time_used_for_deletion/count_log_records_to_delete} per second")
+ time_end_str = time_end.strftime("%d.%m.%Y - %H:%M")
+ self.logger.info(f"remove_older_: {itempath} deleted {count_log_records_to_delete_str} log entries until {time_end_str} took {time_used_for_deletion:.2f} seconds, averaging {100*time_used_for_deletion/count_log_records_to_delete:.4f} seconds per 100 entries")
# update the logCount for the item
logcount = self.readLogCount(item_id)
@@ -1425,6 +1626,7 @@ def _count_logentries(self):
self._item_logcount[item_id] = logcount
self._items_total_entries += logcount
self._webdata[item.id()].update({'logcount': logcount})
+ #self._webdata[item.id()].update({'logcount': f"{logcount:,}".replace(',', '.')})
self._items_still_counting = False
return
@@ -1435,6 +1637,7 @@ def _count_logentries(self):
# ------------------------------------------
def _initialize_db(self):
+ # initialize main db connection
try:
if not self._db.connected():
# limit connection requests to 20 seconds.
@@ -1453,11 +1656,34 @@ def _initialize_db(self):
{i: [self._prepare(query[0]), self._prepare(query[1])] for i, query in self._setup.items()})
self._db_initialized = True
except Exception as e:
- #self.logger.error("Database: Initialization failed: {}".format(e))
- #return False
-
self.logger.critical("Database: Initialization failed: {}".format(e))
- if self.driver.lower() == "sqlite3":
+ if self.driver.lower() == 'sqlite3':
+ self._sh.restart('SmartHomeNG (Database plugin stalled)')
+ exit(0)
+ else:
+ return False
+
+ # initialize db maintenance connection
+ try:
+ if not self._db_maint.connected():
+ # limit connection requests to 20 seconds.
+ current_time = time.time()
+ time_delta_last_maint_connect = current_time - self.last_maint_connect_time
+ self.logger.debug("DEBUG: delta {0}".format(time_delta_last_maint_connect))
+ if (time_delta_last_maint_connect > 20):
+ self.last_maint_connect_time = time.time()
+ self._db_maint.connect()
+ else:
+ self.logger.error("Database reconnect (maintenance connection) supressed: Delta time: {0}".format(time_delta_last_connect))
+ return False
+
+ if not self._db_maint_initialized:
+ self._db_maint.setup(
+ {i: [self._prepare(query[0]), self._prepare(query[1])] for i, query in self._setup.items()})
+ self._db_maint_initialized = True
+ except Exception as e:
+ self.logger.critical("Database: Initialization of maintenance connection failed: {}".format(e))
+ if self.driver.lower() == 'sqlite3':
self._sh.restart('SmartHomeNG (Database plugin stalled)')
exit(0)
else:
diff --git a/database/assets/webif1.jpg b/database/assets/webif1.jpg
deleted file mode 100755
index 145a673e8..000000000
Binary files a/database/assets/webif1.jpg and /dev/null differ
diff --git a/database/assets/webif1_1.jpg b/database/assets/webif1_1.jpg
deleted file mode 100755
index c89cd330d..000000000
Binary files a/database/assets/webif1_1.jpg and /dev/null differ
diff --git a/database/assets/webif_databaseitems.jpg b/database/assets/webif_databaseitems.jpg
new file mode 100755
index 000000000..5c9145d3d
Binary files /dev/null and b/database/assets/webif_databaseitems.jpg differ
diff --git a/database/assets/webif_details.jpg b/database/assets/webif_details.jpg
new file mode 100755
index 000000000..9af9e4972
Binary files /dev/null and b/database/assets/webif_details.jpg differ
diff --git a/database/assets/webif_orphanitems.jpg b/database/assets/webif_orphanitems.jpg
new file mode 100755
index 000000000..1a806132b
Binary files /dev/null and b/database/assets/webif_orphanitems.jpg differ
diff --git a/database/assets/webif_pluginapi.jpg b/database/assets/webif_pluginapi.jpg
new file mode 100755
index 000000000..c5c23c525
Binary files /dev/null and b/database/assets/webif_pluginapi.jpg differ
diff --git a/database/locale.yaml b/database/locale.yaml
index 42a9103f3..c9aabfa52 100755
--- a/database/locale.yaml
+++ b/database/locale.yaml
@@ -1,28 +1,38 @@
plugin_translations:
# Translations for the plugin specially for the web interface
- 'Aktionen': {'de': '=', 'en': 'Actions'}
- 'Verbunden': {'de': '=', 'en': 'Connected'}
- 'Treiber ': {'de': '=', 'en': 'Driver'}
- 'Ja': {'de': '=', 'en': 'Yes'}
- 'Nein': {'de': '=', 'en': 'No'}
- 'mit': {'de': '=', 'en': 'with'}
- 'Datenbank-Dump': {'de': '=', 'en': 'Database Dump'}
- 'Zeit': {'de': '=', 'en': 'Time'}
- 'Item ID': {'de': '=', 'en': '='}
- 'Dauer': {'de': '=', 'en': 'Duration'}
- 'Geändert': {'de': '=', 'en': 'Changed'}
- 'Übersicht': {'de': '=', 'en': 'Overview'}
- 'am': {'de': '=', 'en': 'on the'}
- 'Gesamt': {'de': '=', 'en': 'Total'}
- 'Datensätze': {'de': '=', 'en': 'Data Sets'}
- 'Aktueller Wert': {'de': '=', 'en': 'Recent Value'}
- 'ältester Wert': {'de': '=', 'en': 'oldest Value'}
- 'Typ': {'de': '=', 'en': 'Type'}
- 'Tabelle': {'de': '=', 'en': 'Table'}
+ 'Aktionen': {'de': '=', 'en': 'Actions'}
+ 'Verbunden': {'de': '=', 'en': 'Connected'}
+ 'Treiber': {'de': '=', 'en': 'Driver'}
+ 'Ja': {'de': '=', 'en': 'Yes'}
+ 'Nein': {'de': '=', 'en': 'No'}
+ 'mit': {'de': '=', 'en': 'with'}
+ 'SQL Dump': {'de': '=', 'en': '='}
+ 'CSV Dump': {'de': '=', 'en': '='}
+ 'Zeit': {'de': '=', 'en': 'Time'}
+ 'Item ID': {'de': '=', 'en': '='}
+ 'Dauer': {'de': '=', 'en': 'Duration'}
+ 'Geändert': {'de': '=', 'en': 'Changed'}
+ 'Übersicht': {'de': '=', 'en': 'Overview'}
+ 'am': {'de': '=', 'en': 'on the'}
+ 'Gesamt': {'de': '=', 'en': 'Total'}
+ 'Datensätze': {'de': '=', 'en': 'Data Sets'}
+ 'Aktueller Wert': {'de': '=', 'en': 'Recent Value'}
+ 'ältester Wert': {'de': '=', 'en': 'oldest Value'}
+ 'Letzte Änderung': {'de': '=', 'en': 'Last change'}
+ 'Typ': {'de': '=', 'en': 'Type'}
+ 'Tabelle': {'de': '=', 'en': 'Table'}
+ 'Verwaistes Item': {'de': '=', 'en': 'Orphan item'}
- 'Plugin-API': {'de': '=', 'en': 'Plugin API', 'fr': ''}
- 'Database Items': {'de': '=', 'en': '=', 'fr': ''}
- 'Parameter': {'de': '=', 'en': 'Parameters', 'fr': ''}
+ 'Plugin-API': {'de': '=', 'en': 'Plugin API'}
+ 'Database Items': {'de': '=', 'en': '='}
+ 'Verwaiste Items': {'de': '=', 'en': 'Orphan Items'}
+ 'Parameter': {'de': '=', 'en': 'Parameters'}
+
+ 'Wert': {'de': '=', 'en': 'Value'}
+ 'DB-ID': {'de': '=', 'en': '='}
+ 'VAL_NUM': {'de': 'Wert: Numerisch', 'en': 'Value: Numeric'}
+ 'VAL_STR': {'de': 'Wert: String', 'en': 'Value: String'}
+ 'VAL_BOOL': {'de': 'Wert: Boolean', 'en': 'Value: Boolean'}
'Item-ID in der Datenbank':
'de': 'Item-ID in der DB'
@@ -33,7 +43,7 @@ plugin_translations:
'Die Datenbank enthält Daten zu {dbitems} Items':
'de': '='
'en': ' The database contains data for {dbitems} items'
- 'konfiguriertes max. Altermax. Alter':
+ 'konfiguriertes max. Alter':
'de': '='
'en': 'configured max. age'
'Löschauftrag für die Einträge von Item ID {item_id} in der Tabelle "log" wurde erfolgreich initiiert!':
@@ -78,9 +88,12 @@ plugin_translations:
'Zeige Einträge vom':
'de': '='
'en': 'Show entries from'
- 'Datenbank-Cleanup':
+ 'Datenbank-Cleanup starten':
+ 'de': '='
+ 'en': 'Start Database-Cleanup'
+ 'Cleanup ist aktiv':
'de': '='
- 'en': 'Database Cleanup'
+ 'en': 'Cleanup is active'
'Datenbank-Cleanup wurde erfolgreich initiiert!':
'de': '='
'en': 'Database cleanup successfully initiated!'
@@ -90,6 +103,9 @@ plugin_translations:
'Wollen Sie alle Datensätze ohne zugehöriges Item wirklich löschen?':
'de': '='
'en': 'Do you really want to delete all data sets without corresponding item?'
+ 'Anzahl Einträge':
+ 'de': '='
+ 'en': '# of entries'
'Anzahl Einträge in LOG Tabelle für Item':
'de': '='
'en': 'Number of data sets in LOG table for item'
diff --git a/database/notizen.txt b/database/notizen.txt
new file mode 100755
index 000000000..654c5324e
--- /dev/null
+++ b/database/notizen.txt
@@ -0,0 +1,32 @@
+
+$ time sqlite3 smarthomeng_copy.db "VACUUM;"
+
+vorher: 12896934912 Nov 25 13:23 smarthomeng_copy.db
+nachher: Abgebrochen: Error: database disk image is malformed
+
+
+
+(py_38) smarthome@SmartHomeNG:/usr/local/shng_dev/var/db$ ls -l
+insgesamt 35822208
+drwxrwsr-x 2 smarthome smarthome 4096 Nov 25 12:55 alte_dbs
+-rw-r--r-- 1 smarthome smarthome 25784320 Nov 22 10:53 dbtest.db
+-rw-rw-r-- 1 smarthome smarthome 25784320 Nov 22 10:53 dbtest_kopie.db
+-rw-rw-r-- 1 smarthome smarthome 18939904 Nov 25 13:39 dbtest_vacuumed.db
+drwxrwsr-x 2 smarthome smarthome 4096 Nov 25 13:34 Sicherung
+-rw-r--r-- 1 smarthome smarthome 126976 Apr 28 2020 smarthome.db
+-rw-rw-r-- 1 smarthome smarthome 12896934912 Nov 25 13:23 smarthomeng_copy.db
+-rw-rw-r-- 1 smarthome smarthome 12896934912 Nov 25 14:28 smarthomeng.db
+-rw-rw-r-- 1 smarthome smarthome 4558032 Nov 25 14:27 smarthomeng.db-journal
+-rw-r--r-- 1 smarthome smarthome 10812834330 Nov 25 14:26 smarthomeng_dump.sql
+->
+-rw-rw-r-- 1 smarthome smarthome 12896934912 Nov 25 13:23 smarthomeng_copy.db
+-rw-rw-r-- 1 smarthome smarthome 12896934912 Nov 25 16:12 smarthomeng.db
+-rw-r--r-- 1 smarthome smarthome 10812834330 Nov 25 14:48 smarthomeng_dump.sql
+-rw-r--r-- 1 smarthome smarthome 9837748224 Nov 25 16:05 smarthomeng_neu.db
+
+smarthomeng_neu.db:
+select count() from item;
+629
+
+select count() from log;
+140.889.225
diff --git a/database/plugin.yaml b/database/plugin.yaml
index 41d5443ea..389724872 100755
--- a/database/plugin.yaml
+++ b/database/plugin.yaml
@@ -5,18 +5,18 @@ plugin:
description: # Alternative: description in multiple languages
de: 'Database plugin, mit Unterstützung für SQLite 3 und MySQL'
en: 'Database plugin, with support for SQLite 3 and MySQL'
- maintainer: ohinckel, msinn
- tester: psilo909, onkelandy, brandst, aschwith
+ maintainer: ohinckel, msinn, onkelandy
+ tester: psilo909, brandst, aschwith
state: ready
keywords: database
- documentation: http://smarthomeng.de/user/plugins/database/user_doc.html
support: https://knx-user-forum.de/forum/supportforen/smarthome-py/1021844-neues-database-plugin
- version: 1.6.3 # Plugin version
- sh_minversion: 1.8.0 # minimum shNG version to use this plugin
+ version: 1.6.9 # Plugin version
+ sh_minversion: 1.9.3.2 # minimum shNG version to use this plugin
# sh_maxversion: # maximum shNG version to use this plugin (leave empty if latest)
multi_instance: True # plugin supports multi instance
restartable: unknown
+ startorder: early # set start priority of plugin (early/normal/late)
classname: Database # class containing the plugin
parameters:
@@ -66,8 +66,8 @@ parameters:
max_delete_logentries:
type: int
- default: 1500
- valid_min: 20
+ default: 20000
+ valid_min: 1000
description:
de: "Maximal auf einmal zu löschende Anzahl an Log Einträgen mit dem database_maxage Attribut, reduziert die Belastung der Datenbank bei alten Datenbeständen"
en: "Maximum number of Logentries to delete at once with database_maxage attribute, reduces load on database with old datasets"
@@ -80,27 +80,18 @@ parameters:
de: "Falls dieser Parameter einen Wert größer 0 enthält: Standard maxage für Items, die kein maxage gesetzt haben"
en: "If this parameter is > 0: maxage for Items that don't have a maxage set."
- webif_pagelength:
- type: int
- default: 0
- valid_list:
- - -1
- - 0
- - 25
- - 50
- - 100
+ copy_database:
+ type: bool
+ default: False
+ description:
+ de: "Nur für SQLite3: Auf True setzen, um beim Start von SmartHomeNG eine Kopie der Datenbank Datei zu erzeugen"
+ en: "For SQLite3 only: Set to True to make a copy of the database file on startup of SmartHomeNG"
+
+ copy_database_name:
+ type: str
description:
- de: 'Anzahl an Items, die standardmäßig in einer Web Interface Tabelle pro Seite angezeigt werden.
- 0 = automatisch, -1 = alle'
- en: 'Amount of items being listed in a web interface table per page by default.
- 0 = automatic, -1 = all'
- description_long:
- de: 'Anzahl an Items, die standardmäßig in einer Web Interface Tabelle pro Seite angezeigt werden.\n
- Bei 0 wird die Tabelle automatisch an die Höhe des Browserfensters angepasst.\n
- Bei -1 werden alle Tabelleneinträge auf einer Seite angezeigt.'
- en: 'Amount of items being listed in a web interface table per page by default.\n
- 0 adjusts the table height automatically based on the height of the browser windows.\n
- -1 shows all table entries on one page.'
+ de: "Nur für SQLite3: Pfad/Name der Datenbank Kopie"
+ en: "For SQLite3 only: Path/Name of the copy of the database file"
item_attributes:
# Definition of item attributes defined by this plugin
diff --git a/database/user_doc.rst b/database/user_doc.rst
index 013df4b7d..d88c8ff85 100755
--- a/database/user_doc.rst
+++ b/database/user_doc.rst
@@ -5,7 +5,14 @@
database
========
-Database plugin, mit Unterstützung für SQLite 3 und MySQL.
+.. image:: webif/static/img/plugin_logo.png
+ :alt: plugin logo
+ :width: 300px
+ :height: 300px
+ :scale: 50 %
+ :align: left
+
+Database plugin, mit Unterstützung für SQLite3 und MySQL.
Verwenden Sie dieses Plugin, um Itemwerte in einer Datenbank zu speichern. Es unterstützt
verschiedene Datenbanken, die eine Python DB API 2 `_ Implementierung
@@ -24,10 +31,10 @@ Die Informationen zur Konfiguration des Plugins sind unter :doc:`/plugins_doc/co
**KEIN** **instance** Attribut konfiguriert werden darf, da sonst die Systemdaten nicht gespeichert werden und
Abfragen aus dem Admin Interface und der smartVISU ins Leere laufen und Fehlermeldungen produzieren.
-Standarmässig schreibt das Plugin vor dem Beenden von SmarthomeNG alle am Plugin registrierten Items nochmal mit aktuellem
+Standarmäßig schreibt das Plugin vor dem Beenden von SmarthomeNG alle am Plugin registrierten Items nochmal mit aktuellem
Wert in die Datenbank. Die kann durch Setzen des Item Attributes database_write_on_shutdown: False unterdrückt werden.
Ein typischer Anwendungsfall sind zum Beispiel monoton steigende Werte wie Zählerstände, die selten geschrieben werden
-und für die doppelte Einträge durch smarthomeNG Neustarts stoerend in Datenbank und optionalen Plots in einer
+und für die doppelte Einträge durch smarthomeNG Neustarts störend in Datenbank und optionalen Plots in einer
Visualisierung sind.
@@ -37,12 +44,6 @@ Web Interface
Das database Plugin verfügt über ein Webinterface, mit dessen Hilfe die Items die das Plugin nutzen
übersichtlich dargestellt werden.
-.. important::
-
- Das Webinterface des Plugins kann mit SmartHomeNG v1.4.2 und davor **nicht** genutzt werden.
- Es wird dann nicht geladen. Diese Einschränkung gilt nur für das Webinterface. Ansonsten gilt
- für das Plugin die in den Metadaten angegebene minimale SmartHomeNG Version.
-
Aufruf des Webinterfaces
------------------------
@@ -53,24 +54,138 @@ Zeile das Icon in der Spalte **Web Interface** anklicken.
Außerdem kann das Webinterface direkt über ``http://smarthome.local:8383/database`` bzw.
``http://smarthome.local:8383/database_`` aufgerufen werden.
+Das Web Interface verfügt über 3 Tabs, sowie Informationen und Buttons im Kopfbereich. Im Kopfbereich werden
+Informationen zum Zustand des Plugins und zur verwendeten Datenbank angezeigt.
+
+
+Database Items
+--------------
+
+Auf diesem Tab werden die Items angezeigt, für welche Daten in der Datenbank gespeichert werden.
+
+.. image:: assets/webif_databaseitems.jpg
+ :class: screenshot
+
+Durch einen einen Klick auf den **CSV** Button in der Zeile des Items, wird ein Download der gespeicherten Daten
+zu dem Item erzeugt.
-Beispiele
----------
+Auf dem Tab wird als **Wert** der letzte in der Datenbank gespeicherte Wert angezeigt. Um eine Historie zu sehen,
+muss rechts in der Zeile des Items auf den Button mit der Lupe geklickt werden.
-Folgende Informationen können im Webinterface angezeigt werden:
+Auf der Detail-Seite wird die Liste der gespeicherten Werte zu einem Tag angezeigt. Der anzuzeigende Tag kann rechts
+im Kalender gewählt werden.
-Oben rechts werden allgemeine Parameter zum Plugin angezeigt.
+.. image:: assets/webif_details.jpg
+ :class: screenshot
+
+Zu jedem Wert wird angezeigt, wann er gespeichert wurde und für welche Dauer er gültig war. Beim aktuellen Wert
+wird als Dauer **None** angezeigt, da der Wert noch gültig ist und die Dauer daher unbekannt ist.
+
+Durch einen Klick auf den Button **Übersicht**, kann zur Standard Anzeige des Tabs **Database Items** zurück gekehrt
+werden.
+
+
+Plugin-API
+----------
-Im ersten Tab werden die Items angezeigt, die das database Plugin nutzen:
+Auf diesem Tab werden die öffentlichen Funktionen des Plugins angezeigt, die z.B. in Logiken genutzt werden können.
+Diese Informationen sind auch in dieser Dokumentation auf der Seite mit den Konfigurationsdaten vorhanden.
-.. image:: assets/webif1.jpg
+.. image:: assets/webif_pluginapi.jpg
:class: screenshot
-Auf der Detailseite zu den Item Einträgen werden die geloggten Werte angezeigt:
-.. image:: assets/webif1_1.jpg
+Verwaiste Items
+---------------
+
+Dieses Tab wird nur angezeigt, wenn in der Datenbank verwaiste Items vorhanden sind. Verwaiste Items sind Items, zu
+denen Informationen in der Datenbank gespeichert sind, zu denen es aber im Item Tree von SmartHomeNG keine
+Entsprechungen gibt, also kein Item mit dem gleichen Pfad, welches für das database Plugin konfiguriert ist.
+
+.. image:: assets/webif_orphanitems.jpg
:class: screenshot
+Wenn die Daten zu den verwaisten Items nicht mehr benötigt werden, können diese durch klicken des Buttons
+**Datenbank-Cleanup starten** gelöscht werden.
+
+Sollen einige Daten erhalten bleiben, so müssen die Items dazu vorher in SmartHomeNG (wieder) konfiguriert werden.
+
+
+Export von Daten
+----------------
+
+Das Plugin verfügt über zwei Möglichkeiten, um Daten zu exportieren. Wobei die Zweite (SQL Dump) nur bei Verwendung
+von SQLite3 zur Verfügung steht.
+
+Der Export wird gestartet, indem einer der beiden Buttons im Kopfbereich des Plugins geklickt wird.
+Anschließend wird auf dem System auf dem SmartHomeNG läuft, lokal ein Export der Daten erzeugt und anschließend
+herunter geladen. Während die Erzeugung es Exports läuft, wird im Browser ein leeres Fenster angezeigt. Das
+Fenster muss bis zum Abschluss des Exports geöffnet bleiben. Der Export kann, je nach Datenbank Größe, bis
+zu über einer Stunde dauern. Nach Abschluss des Exports wird die Datei herunter geladen und im Fenster wird wieder das
+Web Interface des database Plugins angezeigt.
+
+
+CSV Dump
+~~~~~~~~
+
+Durch einen Klick auf den Button **CSV Dump** wird ein vollständiger Dump der in der Datenbank gespeicherten
+Informationen erzeugt und im Browser runter geladen.
+
+Die Daten in der heruntergeladenen Datei haben folgende Struktur:
+
+.. code-block:: text
+
+ item_id;item_name;time;duration;val_str;val_num;val_bool;changed;time_date;changed_date
+ 3;wohnung.kochen.kochfeldg.ma;1606258889619;17998;;217.0;1;1606258947266;2020-11-25 00:01:29.619000;2020-11-25 00:02:27.266000
+ 3;wohnung.kochen.kochfeldg.ma;1606258907617;17993;;216.0;1;1606258947266;2020-11-25 00:01:47.617000;2020-11-25 00:02:27.266000
+ 3;wohnung.kochen.kochfeldg.ma;1606258925610;5996;;217.0;1;1606258947266;2020-11-25 00:02:05.610000;2020-11-25 00:02:27.266000
+ 3;wohnung.kochen.kochfeldg.ma;1606258931606;18006;;216.0;1;1606259007370;2020-11-25 00:02:11.606000;2020-11-25 00:03:27.370000
+ 3;wohnung.kochen.kochfeldg.ma;1606258949612;5993;;217.0;1;1606259007370;2020-11-25 00:02:29.612000;2020-11-25 00:03:27.370000
+ 3;wohnung.kochen.kochfeldg.ma;1606258955605;30001;;216.0;1;1606259007370;2020-11-25 00:02:35.605000;2020-11-25 00:03:27.370000
+ 3;wohnung.kochen.kochfeldg.ma;1606258985606;53991;;217.0;1;1606259067523;2020-11-25 00:03:05.606000;2020-11-25 00:04:27.523000
+ 3;wohnung.kochen.kochfeldg.ma;1606259039597;24006;;216.0;1;1606259067523;2020-11-25 00:03:59.597000;2020-11-25 00:04:27.523000
+ 3;wohnung.kochen.kochfeldg.ma;1606259063603;11984;;217.0;1;1606259127224;2020-11-25 00:04:23.603000;2020-11-25 00:05:27.224000
+
+Es handelt sich hierbei um einen reinen Dump der Daten, nicht um ein Abbild der Datenbank Struktur.
+
+
+SQL Dump
+~~~~~~~~
+
+Im Gegensatz zum CSV Dump, wird bei einem SQL Dump die vollständige Datenbank (Daten und Struktur) herunter geladen.
+Diese Funktion steht allerdings nur bei Nutzung einer SQLite3 Datenbank zur Verfügung.
+
+Die heruntergeladene Datei hat dabei folgendes Format:
+
+.. code-block:: text
+
+ BEGIN TRANSACTION;
+ CREATE TABLE database_version(version NUMERIC, updated BIGINT, rollout TEXT, rollback TEXT);
+ INSERT INTO "database_version" VALUES(1,1518289184830,'CREATE TABLE log (time BIGINT, item_id INTEGER, duration BIGINT, val_str TEXT, val_num REAL, val_bool BOOLEAN, changed BIGINT);','DROP TABLE log;');
+ INSERT INTO "database_version" VALUES(2,1518289184835,'CREATE TABLE item (id INTEGER, name varchar(255), time BIGINT, val_str TEXT, val_num REAL, val_bool BOOLEAN, changed BIGINT);','DROP TABLE item;');
+ INSERT INTO "database_version" VALUES(3,1518289184840,'CREATE UNIQUE INDEX log_item_id_time ON log (item_id, time);','DROP INDEX log_item_id_time;');
+ INSERT INTO "database_version" VALUES(4,1518289184845,'CREATE INDEX log_item_id_changed ON log (item_id, changed);','DROP INDEX log_item_id_changed;');
+ INSERT INTO "database_version" VALUES(5,1518289184849,'CREATE UNIQUE INDEX item_id ON item (id);','DROP INDEX item_id;');
+ INSERT INTO "database_version" VALUES(6,1518289184854,'CREATE INDEX item_name ON item (name);','DROP INDEX item_name;');
+ CREATE TABLE item (id INTEGER, name varchar(255), time BIGINT, val_str TEXT, val_num REAL, val_bool BOOLEAN, changed BIGINT);
+ INSERT INTO "item" VALUES(3,'wohnung.kochen.kochfeldg.ma',1669554322161,NULL,202.0,1,1669554363596);
+
+ ...
+
+ INSERT INTO "log" VALUES(1669557938064,101,NULL,NULL,527.0,1,1669557938992);
+ INSERT INTO "log" VALUES(1669557928298,105,NULL,NULL,230.0,1,1669557939008);
+ INSERT INTO "log" VALUES(1669557928356,107,NULL,NULL,227.0,1,1669557939032);
+ INSERT INTO "log" VALUES(1669557906685,1446,NULL,'1.45',NULL,1,1669557939063);
+ INSERT INTO "log" VALUES(1669557906694,1447,NULL,'1.45',NULL,1,1669557939071);
+ CREATE UNIQUE INDEX log_item_id_time ON log (item_id, time);
+ CREATE INDEX log_item_id_changed ON log (item_id, changed);
+ CREATE UNIQUE INDEX item_id ON item (id);
+ CREATE INDEX item_name ON item (name);
+ COMMIT;
+
+Das herunter geladene SQL Skript kann in eine leere Datenbank importiert werden. Dieses kann zum Beispiel zum
+Verkleinern des Datenbank Datei nach dem Löschen einer größeren Menge von Daten genutzt werden.
+
Aufbau der Datenbank
====================
@@ -94,13 +209,13 @@ Die `item` Tabelle enthält die folgenden Spalten:
Die `log` Tabelle enthält die folgenden Spalten:
* Column `time` - Ein UNIX Zeitstempel in eine Auflösung von Mikrosekunden
- * Column `item_id` - Eine Referenz auf eine eindeutige Kennung eines Items in der Tabelle ìtem
+ * Column `item_id` - Eine Referenz auf eine eindeutige Kennung eines Items in der Tabelle `item`
* Column `duration` - Die Dauer in Mikrosekunden
* Column `val_str` - Der Itemwert als Zeichenkette wenn das Item den Typ `str` hat
* Column `val_num` - Der Itemwert als Zahl, wenn das Item den Typ `num` hat
* Column `val_bool` - Der Itemwert als Wahrheitswert, das Item den Typ `bool` oder `num` hat
* Column `changed` - Ein UNIX Zeitstempel (in einer Auflösung von Mikrosekunden) der letzen Änderung
-Es gibt aktuell nur eine Möglichkeit die Anzahl der Datensätze pro Item zu begrenzen:
+Es gibt aktuell nur eine Möglichkeit die Anzahl der Datensätze pro Item zu begrenzen:
Durch die Angabe des Item Attributs ``database_maxage`` wird das maximale Alter der Einträge eines Items begrenzt.
-Regelmässig werden Werte deren Zeitstempel älter ist als die angegebene Zeitspanne aus der Datenbank gelöscht.
\ No newline at end of file
+Regelmässig werden Werte deren Zeitstempel älter ist als die angegebene Zeitspanne aus der Datenbank gelöscht.
diff --git a/database/webif/__init__.py b/database/webif/__init__.py
index 1a70c7f39..9c9178391 100755
--- a/database/webif/__init__.py
+++ b/database/webif/__init__.py
@@ -71,10 +71,8 @@ def index(self, reload=None, action=None, item_id=None, item_path=None, time_end
:return: contents of the template after beeing rendered
"""
- try:
- pagelength = self.plugin.webif_pagelength
- except Exception:
- pagelength = 100
+ # try to get the webif pagelength from the module.yaml configuration
+ pagelength = self.plugin.get_parameter_value('webif_pagelength')
if item_path is not None:
item = self.plugin.items.return_item(item_path)
delete_triggered = False
@@ -229,17 +227,49 @@ def download_complete(self):
@cherrypy.expose
- def db_dump(self):
+ def db_csvdump(self):
"""
- returns the smarthomeNG sqlite database as download
+ returns the smarthomeNG database as download in csv format
"""
- self.plugin.dump(
- '%s/var/db/smarthomedb_%s.dump' % (self.plugin.get_sh().base_dir, self.plugin.get_instance_name()))
+ filename = 'smarthomeng'
+ extension = '_dump.csv'
+ if self.plugin.get_instance_name() == '':
+ filename += extension
+ else:
+ filename += '_' + self.plugin.get_instance_name() + extension
+ pathname = os.path.join(self.plugin.get_sh().base_dir, 'var', 'db', filename)
+
+ self.plugin.dump(pathname)
+ #self.plugin.dump(
+ # '%s/var/db/smarthomedb_%s.dump' % (self.plugin.get_sh().base_dir, self.plugin.get_instance_name()))
+
mime = 'application/octet-stream'
- return cherrypy.lib.static.serve_file(
- "%s/var/db/smarthomedb_%s.dump" % (self.plugin.get_sh().base_dir, self.plugin.get_instance_name()),
- mime, "%s/var/db/" % self.plugin.get_sh().base_dir)
+ # disposition should bie 'attachment' or 'inline'
+ return cherrypy.lib.static.serve_file(pathname, mime, disposition='attachment', name=filename)
+ #return cherrypy.lib.static.serve_file(
+ # "%s/var/db/smarthomedb_%s.dump" % (self.plugin.get_sh().base_dir, self.plugin.get_instance_name()),
+ # mime, "%s/var/db/" % self.plugin.get_sh().base_dir)
+
+ @cherrypy.expose
+ def db_sqldump(self):
+ """
+ returns the smarthomeNG sqlite database as download of a complete sql dump
+ """
+ filename = 'smarthomeng'
+ extension = '_dump.sql'
+ if self.plugin.get_instance_name() == '':
+ filename += extension
+ else:
+ filename += '_' + self.plugin.get_instance_name() + extension
+ pathname = os.path.join(self.plugin.get_sh().base_dir, 'var', 'db', filename)
+
+ if self.plugin.sqlite_dump(pathname):
+ mime = 'application/octet-stream'
+ # disposition should bie 'attachment' or 'inline'
+ return cherrypy.lib.static.serve_file(pathname, mime, disposition='attachment', name=filename)
+
+ return
@cherrypy.expose
diff --git a/database/webif/templates/base_database.html b/database/webif/templates/base_database.html
index 3e57efc8e..e477d155a 100755
--- a/database/webif/templates/base_database.html
+++ b/database/webif/templates/base_database.html
@@ -1,48 +1,81 @@
{% extends "base_plugin.html" %}
-
{% set logo_frame = false %}
-
-
-{%- block scripts %}
-{{ super() }}
+{%- block pluginscripts %}
-{%- endblock scripts %}
-
-{%- block pluginscripts %}
-
{%- endblock pluginscripts %}
-{%- block styles %}
-{{ super() }}
+{%- block pluginstyles %}
-
-{%- endblock styles %}
+{%- endblock pluginstyles %}
{% block headtable %}
-{{ webif_pagelength }}
{{ _('Die folgenden {items} Items sind dieser Instanz zugewiesen, {with_maxage} Items haben ein maxage.', vars={'items': len(p._handled_items), 'with_maxage': len(p._items_with_maxage)}) }}
@@ -80,17 +86,17 @@
-
-
{{ _('Item') }}
-
{{ _('Init') }}
-
{{ _('Typ') }}
-
{{ _('Wert') }}
-
{{ _('Item-ID in der Datenbank') }}
+
+
{{ _('Item') }}
+
{{ _('Init') }}
+
{{ _('Typ') }}
+
{{ _('Wert') }}
+
{{ _('DB-ID') }}
{% if p.count_logentries %}
-
{{ _('Anzahl Einträge') }}
+
{{ _('Anzahl Einträge') }}
{% endif %}
-
{{ _('konfiguriertes max. Alter') }}
-
{{ _('Aktionen') }}
+
{{ _('konfiguriertes max. Alter') }}
+
{{ _('Aktionen') }}
@@ -110,24 +116,25 @@
{% endif %}
{% endif %}
-
{{ item.property.path }}
-
{{ _('Init') if p.get_iattr_value(item.conf, 'database').lower() == 'init' else '-'}}
-
{{ item.property.type }}
-
{{ val }}
-
{{ p.id(item, create=False) }}
+
+
{{ item.property.path }}
+
{{ _('Init') if p.get_iattr_value(item.conf, 'database').lower() == 'init' else '-'}}
+
{{ item.property.type }}
+
{{ val }}
+
{{ p.id(item, create=False) }}
{% if p.count_logentries %}
-
{{ p._item_logcount[p.id(item, create=False)] }}
+
{{ p._item_logcount[p.id(item, create=False)] }}
{% endif %}
{% if p.get_iattr_value(item.conf, 'database_maxage') %}
-
{% if language == 'en' %}{{ data[6].strftime('%m/%d/%Y %H:%M:%S') }}{% else %}{{ data[6].strftime('%d.%m.%Y %H:%M:%S') }}{% endif %}
-
+
{% if language == 'en' %}{{ data[6].strftime('%m/%d/%Y %H:%M:%S') }}{% else %}{{ data[6].strftime('%d.%m.%Y %H:%M:%S') }}{% endif %}
+
{% if loop.index < 3 and (day is none or (day+" "+month+" "+year == now.strftime('%d %m %Y'))) %}
{% set is_disabled = true %}
{% else %}
@@ -130,98 +131,98 @@
$('#datepicker').datepicker('update', '{% if day and month and year %}{% if language == "en" %}{{ month }}/{{ day }}/{{ year }}{% else %}{{ day }}.{{ month }}.{{ year }}{% endif %}{% else %}{% if language == "en" %}{{ now.strftime('%m/%d/%Y') }}{% else %}{{ now.strftime('%d.%m.%Y') }}{% endif %}{% endif %}');
function handleUpdatedData(response, dataSet) {
- if (dataSet === 'item_details') {
- objResponse = JSON.parse(response);
- myProto = document.getElementById(dataSet);
- if (checkDate()) {
- if ( $.fn.dataTable.isDataTable('#item_details_table') ) {
- item_details_table = $('#item_details_table').DataTable();
- }
- // It's necessary to completely clear the current table and refill it later on.
- item_details_table.clear();
- let i = 1;
- let now = new Date();
- let now_day = String(now.getDate()).padStart(2, '0');
- let now_month = String((now.getMonth()+1)).padStart(2, '0');
- let now_year = String(now.getFullYear()).padStart(2, '0');
- let now_date = now_day + " " + now_month + " " + now_year;
- for (item in objResponse) {
- let item_id = objResponse[item][1];
- let item_path = "{{ item_path }}";
+ if (dataSet === 'item_details') {
+ objResponse = JSON.parse(response);
+ myProto = document.getElementById(dataSet);
+ if (checkDate()) {
+ if ( $.fn.dataTable.isDataTable('#item_details_table') ) {
+ item_details_table = $('#item_details_table').DataTable();
+ }
+ // It's necessary to completely clear the current table and refill it later on.
+ item_details_table.clear();
+ let i = 1;
+ let now = new Date();
+ let now_day = String(now.getDate()).padStart(2, '0');
+ let now_month = String((now.getMonth()+1)).padStart(2, '0');
+ let now_year = String(now.getFullYear()).padStart(2, '0');
+ let now_date = now_day + " " + now_month + " " + now_year;
+ for (item in objResponse) {
+ let item_id = objResponse[item][1];
+ let item_path = "{{ item_path }}";
- let date = new Date(Date.parse(objResponse[item][0]));
- let day = String(date.getDate()).padStart(2, '0');
- let month = String((date.getMonth()+1)).padStart(2, '0');
- let year = String(date.getFullYear()).padStart(2, '0');
- let time = String(date.getHours()).padStart(2, '0')+
- ":"+String(date.getMinutes()).padStart(2, '0')+
- ":"+String(date.getSeconds()).padStart(2, '0');
- let date_time;
- let is_disabled = null;
- if (i < 3 && (day == null || (day+" "+month+" "+year == now_date)))
- is_disabled = true;
- else
- is_disabled = false;
+ let date = new Date(Date.parse(objResponse[item][0]));
+ let day = String(date.getDate()).padStart(2, '0');
+ let month = String((date.getMonth()+1)).padStart(2, '0');
+ let year = String(date.getFullYear()).padStart(2, '0');
+ let time = String(date.getHours()).padStart(2, '0')+
+ ":"+String(date.getMinutes()).padStart(2, '0')+
+ ":"+String(date.getSeconds()).padStart(2, '0');
+ let date_time;
+ let is_disabled = null;
+ if (i < 3 && (day == null || (day+" "+month+" "+year == now_date)))
+ is_disabled = true;
+ else
+ is_disabled = false;
- {% if language == 'en' %}
- date_time = month+"/"+day+"/"+year+" "+time;
- {% else %}
- date_time = day + "." + month + "." + year + " " + time;
- {% endif %}
- let orig_duration = objResponse[item][2];
- let duration = Math.round(objResponse[item][2]/1000 * 10) / 10;
- if (orig_duration == null) {
- orig_duration = "None";
- duration = "None";
- }
- let value;
- {% if item.property.type == 'num' %}
- var tenToN = 10 ** 2;
- value = (Math.round(objResponse[item][4] * tenToN)) / tenToN;
- {% endif %}
- {% if item.property.type == 'bool' %} value = objResponse[item][5];{% endif %}
- {% if item.property.type == 'str' %} value = objResponse[item][3];{% endif %}
- {% if item.property.type == 'foo' %} value = objResponse[item][3];{% endif %}
- let changed = new Date(Date.parse(objResponse[item][6]));
- let changed_day = String(changed.getDate()).padStart(2, '0');
- let changed_month = String((changed.getMonth()+1)).padStart(2, '0');
- let changed_year = String(changed.getFullYear()).padStart(2, '0');
- let changed_time = String(changed.getHours()).padStart(2, '0')+
- ":"+String(changed.getMinutes()).padStart(2, '0')+
- ":"+String(changed.getSeconds()).padStart(2, '0');
- let changed_date_time;
- let buttons = "";
- let day_month_year = "";
- if (day && month && year) day_month_year = "&day=" + day + "&month=" + month + "&year=" + year;
- if (is_disabled)
- {
- buttons = "";
- }
+ {% if language == 'en' %}
+ date_time = month+"/"+day+"/"+year+" "+time;
+ {% else %}
+ date_time = day + "." + month + "." + year + " " + time;
+ {% endif %}
+ let orig_duration = objResponse[item][2];
+ let duration = Math.round(objResponse[item][2]/1000 * 10) / 10;
+ if (orig_duration == null) {
+ orig_duration = "None";
+ duration = "None";
+ }
+ let value;
+ {% if item.property.type == 'num' %}
+ var tenToN = 10 ** 2;
+ value = (Math.round(objResponse[item][4] * tenToN)) / tenToN;
+ {% endif %}
+ {% if item.property.type == 'bool' %} value = objResponse[item][5];{% endif %}
+ {% if item.property.type == 'str' %} value = objResponse[item][3];{% endif %}
+ {% if item.property.type == 'foo' %} value = objResponse[item][3];{% endif %}
+ let changed = new Date(Date.parse(objResponse[item][6]));
+ let changed_day = String(changed.getDate()).padStart(2, '0');
+ let changed_month = String((changed.getMonth()+1)).padStart(2, '0');
+ let changed_year = String(changed.getFullYear()).padStart(2, '0');
+ let changed_time = String(changed.getHours()).padStart(2, '0')+
+ ":"+String(changed.getMinutes()).padStart(2, '0')+
+ ":"+String(changed.getSeconds()).padStart(2, '0');
+ let changed_date_time;
+ let buttons = "";
+ let day_month_year = "";
+ if (day && month && year) day_month_year = "&day=" + day + "&month=" + month + "&year=" + year;
+ if (is_disabled)
+ {
+ buttons = "";
+ }
- else
- {
- buttons = "";
- }
- {% if language == 'en' %}
- changed_date_time = changed_month+"/"+changed_day+"/"+changed_year+" "+changed_time;
- {% else %}
- changed_date_time = changed_day + "." + changed_month + "." + changed_year + " " + changed_time;
- {% endif %}
- let entry_id = objResponse[item][0].replace("T", " ");
- let newRow = item_details_table.row.add( [ item_id, date_time, duration, value, changed_date_time, buttons ] ).draw(false).node();
- newRow.id = entry_id+"_"+orig_duration;
- $('td:eq(0)', newRow).attr('id', entry_id+'_'+orig_duration+'_id');
- $('td:eq(1)', newRow).attr('id', entry_id+'_'+orig_duration+'_time');
- $('td:eq(2)', newRow).attr('id', entry_id+'_'+orig_duration+'_duration').addClass('duration');
- $('td:eq(3)', newRow).attr('id', entry_id+'_'+orig_duration+'_value');
- $('td:eq(4)', newRow).attr('id', entry_id+'_'+orig_duration+'_changed');
- $('td:eq(5)', newRow).attr('id', entry_id+'_'+orig_duration+'_buttons');
- i += 1;
- console.log("Added new row: " + entry_id+"_"+orig_duration);
- }
- item_details_table.draw(false);
+ else
+ {
+ buttons = "";
+ }
+ {% if language == 'en' %}
+ changed_date_time = changed_month+"/"+changed_day+"/"+changed_year+" "+changed_time;
+ {% else %}
+ changed_date_time = changed_day + "." + changed_month + "." + changed_year + " " + changed_time;
+ {% endif %}
+ let entry_id = objResponse[item][0].replace("T", " ");
+ let newRow = item_details_table.row.add( [ null, item_id, date_time, duration, value, changed_date_time, buttons ] ).draw(false).node();
+ newRow.id = entry_id+"_"+orig_duration;
+ $('td:eq(1)', newRow).attr('id', entry_id+'_'+orig_duration+'_id');
+ $('td:eq(2)', newRow).attr('id', entry_id+'_'+orig_duration+'_time');
+ $('td:eq(3)', newRow).attr('id', entry_id+'_'+orig_duration+'_duration').addClass('duration');
+ $('td:eq(4)', newRow).attr('id', entry_id+'_'+orig_duration+'_value');
+ $('td:eq(5)', newRow).attr('id', entry_id+'_'+orig_duration+'_changed');
+ $('td:eq(6)', newRow).attr('id', entry_id+'_'+orig_duration+'_buttons');
+ i += 1;
+ console.log("Added new row: " + entry_id+"_"+orig_duration);
}
+ item_details_table.draw(false);
}
}
+ }
{% endblock bodytab1 %}
diff --git a/db_addon/__init__.py b/db_addon/__init__.py
new file mode 100644
index 000000000..82d733f47
--- /dev/null
+++ b/db_addon/__init__.py
@@ -0,0 +1,2874 @@
+#!/usr/bin/env python3
+# vim: set encoding=utf-8 tabstop=4 softtabstop=4 shiftwidth=4 expandtab
+#########################################################################
+# Copyright 2022- Michael Wenzel wenzel_michael@web.de
+#########################################################################
+# This file is part of SmartHomeNG.
+# https://www.smarthomeNG.de
+# https://knx-user-forum.de/forum/supportforen/smarthome-py
+#
+# This plugin provides additional functionality to mysql database
+# connected via database plugin
+#
+# SmartHomeNG is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# SmartHomeNG 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with SmartHomeNG. If not, see .
+#
+#########################################################################
+
+from lib.model.smartplugin import SmartPlugin
+from lib.item import Items
+from lib.item.item import Item
+from lib.shtime import Shtime
+from lib.plugin import Plugins
+from .webif import WebInterface
+import lib.db
+
+import sqlvalidator
+import datetime
+import time
+import re
+import queue
+from dateutil.relativedelta import relativedelta
+from typing import Union
+import threading
+
+DAY = 'day'
+WEEK = 'week'
+MONTH = 'month'
+YEAR = 'year'
+
+
+class DatabaseAddOn(SmartPlugin):
+ """
+ Main class of the Plugin. Does all plugin specific stuff and provides the update functions for the items
+ """
+
+ PLUGIN_VERSION = '1.0.0'
+
+ def __init__(self, sh):
+ """
+ Initializes the plugin.
+ """
+
+ # Call init code of parent class (SmartPlugin)
+ super().__init__()
+
+ # get item and shtime instance
+ self.shtime = Shtime.get_instance()
+ self.items = Items.get_instance()
+ self.plugins = Plugins.get_instance()
+
+ # define properties // cache dicts
+ self.current_values = {} # Dict to hold min and max value of current day / week / month / year for items
+ self.previous_values = {} # Dict to hold value of end of last day / week / month / year for items
+ self.item_cache = {} # Dict to hold item_id, oldest_log_ts and oldest_entry for items
+
+ # define properties // database, database connection, working queue and status
+ self.item_queue = queue.Queue() # Queue containing all to be executed items
+ self.work_item_queue_thread = None # Working Thread for queue
+ self._db_plugin = None # object if database plugin
+ self._db = None # object of database
+ self.connection_data = None # connection data list of database
+ self.db_driver = None # driver of the used database
+ self.db_instance = None # instance of the used database
+ self.item_attribute_search_str = 'database' # attribute, on which an item configured for database can be identified
+ self.last_connect_time = 0 # mechanism for limiting db connection requests
+ self.alive = None # Is plugin alive?
+ self.startup_finished = False # Startup of Plugin finished
+ self.suspended = False # Is plugin activity suspended
+ self._active_queue_item = '-' # String holding item path of currently executed item
+
+ # define properties // Debugs
+ self.parse_debug = False # Enable / Disable debug logging for method 'parse item'
+ self.execute_debug = False # Enable / Disable debug logging for method 'execute items'
+ self.sql_debug = False # Enable / Disable debug logging for sql stuff
+ self.onchange_debug = False # Enable / Disable debug logging for method 'handle_onchange'
+ self.prepare_debug = False # Enable / Disable debug logging for query preparation
+
+ # define properties // default mysql settings
+ self.default_connect_timeout = 60
+ self.default_net_read_timeout = 60
+
+ # define properties // plugin parameters
+ self.db_configname = self.get_parameter_value('database_plugin_config')
+ self.startup_run_delay = self.get_parameter_value('startup_run_delay')
+ self.ignore_0 = self.get_parameter_value('ignore_0')
+ self.use_oldest_entry = self.get_parameter_value('use_oldest_entry')
+
+ # init cache dicts
+ self._init_cache_dicts()
+
+ # activate debug logger
+ if self.log_level == 10: # info: 20 debug: 10
+ self.parse_debug = True
+ self.execute_debug = True
+ self.sql_debug = True
+ self.onchange_debug = True
+ self.prepare_debug = True
+
+ # init webinterface
+ self.init_webinterface(WebInterface)
+
+ def run(self):
+ """
+ Run method for the plugin
+ """
+
+ self.logger.debug("Run method called")
+
+ # check existence of db-plugin, get parameters, and init connection to db
+ if not self._check_db_existence():
+ self.logger.error(f"Check of existence of database plugin incl connection check failed. Plugin not loaded")
+ return self.deinit()
+
+ self._db = lib.db.Database("DatabaseAddOn", self.db_driver, self.connection_data)
+ if not self._db.api_initialized:
+ self.logger.error("Initialization of database API failed")
+ return self.deinit()
+
+ self.logger.debug("Initialization of database API successful")
+
+ # init db
+ if not self._initialize_db():
+ return self.deinit()
+
+ # check db connection settings
+ if self.db_driver is not None and self.db_driver.lower() == 'pymysql':
+ self._check_db_connection_setting()
+
+ # add scheduler for cyclic trigger item calculation
+ self.scheduler_add('cyclic', self.execute_due_items, prio=3, cron='5 0 0 * * *', cycle=None, value=None, offset=None, next=None)
+
+ # add scheduler to trigger items to be calculated at startup with delay
+ dt = self.shtime.now() + datetime.timedelta(seconds=(self.startup_run_delay + 3))
+ self.logger.info(f"Set scheduler for calculating startup-items with delay of {self.startup_run_delay + 3}s to {dt}.")
+ self.scheduler_add('startup', self.execute_startup_items, next=dt)
+
+ # set plugin to alive
+ self.alive = True
+
+ # start the queue consumer thread
+ self._work_item_queue_thread_startup()
+
+ def stop(self):
+ """
+ Stop method for the plugin
+ """
+
+ self.logger.debug("Stop method called")
+ self.alive = False
+ self.scheduler_remove('cyclic')
+ self._work_item_queue_thread_shutdown()
+
+ def parse_item(self, item: Item):
+ """
+ Default plugin parse_item method. Is called when the plugin is initialized.
+
+ The plugin can, corresponding to its attribute keywords, decide what to do with the item in the future, like adding it to an internal array for future reference
+ :param item: The item to process.
+ :return: If the plugin needs to be informed of an items change you should return a call back function
+ like the function update_item down below. An example when this is needed is the knx plugin
+ where parse_item returns the update_item function when the attribute knx_send is found.
+ This means that when the items value is about to be updated, the call back function is called
+ with the item, caller, source and dest as arguments and in case of the knx plugin the value
+ can be sent to the knx with a knx write function within the knx plugin.
+ """
+
+ def get_database_item() -> Item:
+ """
+ Returns item from shNG config which is an item with database attribut valid for current db_addon item
+ """
+
+ _lookup_item = item
+
+ for i in range(3):
+ if self.has_iattr(_lookup_item.conf, self.item_attribute_search_str):
+ return _lookup_item
+ else:
+ self.logger.debug(f"Attribut '{self.item_attribute_search_str}' has not been found for item={item.path()} {i + 1} level above item.")
+ _lookup_item = _lookup_item.return_parent()
+
+ def get_db_addon_item() -> bool:
+ """
+ Returns item from shNG config which is item with db_addon attribut valid for database item
+
+ """
+
+ for child in item.return_children():
+ if _check_db_addon_fct(child):
+ return True
+
+ for child_child in child.return_children():
+ if _check_db_addon_fct(child_child):
+ return True
+
+ for child_child_child in child_child.return_children():
+ if _check_db_addon_fct(child_child_child):
+ return True
+
+ return False
+
+ def _check_db_addon_fct(check_item) -> bool:
+ if self.has_iattr(check_item.conf, 'db_addon_fct'):
+ __db_addon_fct = self.get_iattr_value(check_item.conf, 'db_addon_fct').lower()
+ if onchange_attribute(__db_addon_fct):
+ self.logger.debug(f"db_addon item for database item {item.id()} found.")
+ return True
+ return False
+
+ # handle all items with db_addon_fct
+ if self.has_iattr(item.conf, 'db_addon_fct'):
+
+ if self.parse_debug:
+ self.logger.debug(f"parse item: {item.id()} due to 'db_addon_fct'")
+
+ # get attribute value
+ _db_addon_fct = self.get_iattr_value(item.conf, 'db_addon_fct').lower()
+
+ # get attribute if item should be calculated at plugin startup
+ _db_addon_startup = self.get_iattr_value(item.conf, 'db_addon_startup')
+
+ # get attribute if certain value should be ignored at db query
+ if self.has_iattr(item.conf, 'database_ignore_value'):
+ _db_addon_ignore_value = self.get_iattr_value(item.conf, 'database_ignore_value')
+ elif any(x in str(item.id()) for x in self.ignore_0):
+ _db_addon_ignore_value = 0
+ else:
+ _db_addon_ignore_value = None
+
+ # get database item
+ _database_item = get_database_item()
+
+ # return if no database_item
+ if _database_item is None:
+ self.logger.warning(f"No database item found for {item.id()}: Item ignored. Maybe you should check instance of database plugin.")
+ return
+
+ # create items configs
+ item_config_data_dict = {'db_addon': 'function', 'attribute': _db_addon_fct, 'database_item': _database_item, 'ignore_value': _db_addon_ignore_value}
+ _update_cycle = None
+
+ if self.parse_debug:
+ self.logger.debug(f"Item '{item.id()}' added with db_addon_fct={_db_addon_fct} and database_item={_database_item.id()}")
+
+ # handle items with for daily run
+ if daily_attribute(_db_addon_fct):
+ _update_cycle = 'daily'
+
+ # handle items for weekly
+ elif weekly_attribute(_db_addon_fct):
+ _update_cycle = 'weekly'
+
+ # handle items for monthly run
+ elif monthly_attribute(_db_addon_fct):
+ _update_cycle = 'monthly'
+
+ # handle items for yearly run
+ elif yearly_attribute(_db_addon_fct):
+ _update_cycle = 'yearly'
+
+ # handle static items starting with 'general_'
+ elif _db_addon_fct.startswith('general_'):
+ _update_cycle = 'static'
+
+ # handle all functions with 'summe' like waermesumme, kaeltesumme, gruenlandtemperatursumme
+ elif 'summe' in _db_addon_fct:
+ if not self.has_iattr(item.conf, 'db_addon_params'):
+ self.logger.warning(f"Item '{item.id()}' with db_addon_fct={_db_addon_fct} ignored, since parameter using 'db_addon_params' not given. Item will be ignored.")
+ return
+
+ _db_addon_params = params_to_dict(self.get_iattr_value(item.conf, 'db_addon_params'))
+ if _db_addon_params is None or 'year' not in _db_addon_params:
+ self.logger.info(f"No 'year' for evaluation via 'db_addon_params' of item {item.id()} for function {_db_addon_fct} given. Default with 'current year' will be used.")
+ _db_addon_params = {} if _db_addon_params is None else _db_addon_params
+ _db_addon_params.update({'year': 'current'})
+
+ item_config_data_dict.update({'params': _db_addon_params})
+ _update_cycle = 'daily'
+
+ # handle tagesmitteltemperatur
+ elif _db_addon_fct == 'tagesmitteltemperatur':
+ if not self.has_iattr(item.conf, 'db_addon_params'):
+ self.logger.warning(f"Item '{item.id()}' with db_addon_fct={_db_addon_fct} ignored, since parameter using 'db_addon_params' not given. Item will be ignored.")
+ return
+
+ _db_addon_params = params_to_dict(self.get_iattr_value(item.conf, 'db_addon_params'))
+ item_config_data_dict.update({'params': _db_addon_params})
+ _update_cycle = 'daily'
+
+ # handle db_request
+ elif _db_addon_fct == 'db_request':
+ if not self.has_iattr(item.conf, 'db_addon_params'):
+ self.logger.warning(f"Item '{item.id()}' with db_addon_fct={_db_addon_fct} ignored, since parameter using 'db_addon_params' not given. Item will be ignored")
+ return
+
+ _db_addon_params = self.get_iattr_value(item.conf, 'db_addon_params')
+ _db_addon_params = params_to_dict(_db_addon_params)
+ if _db_addon_params is None:
+ self.logger.warning(f"Error occurred during parsing of item attribute 'db_addon_params' of item {item.id()}. Item will be ignored.")
+ return
+
+ if self.parse_debug:
+ self.logger.debug(f"parse_item: {_db_addon_fct=} for item={item.id()}, {_db_addon_params=}")
+
+ if not any(param in _db_addon_params for param in ('func', 'timeframe')):
+ self.logger.warning(f"Item '{item.id()}' with {_db_addon_fct=} ignored, not all mandatory parameters in {_db_addon_params=} given. Item will be ignored.")
+ return
+
+ item_config_data_dict.update({'params': _db_addon_params})
+ _timeframe = _db_addon_params.get('group', None)
+ if not _timeframe:
+ _timeframe = _db_addon_params.get('timeframe', None)
+ if _timeframe == 'day':
+ _update_cycle = 'daily'
+ elif _timeframe == 'week':
+ _update_cycle = 'weekly'
+ elif _timeframe == 'month':
+ _update_cycle = 'monthly'
+ elif _timeframe == 'year':
+ _update_cycle = 'yearly'
+ else:
+ self.logger.warning(f"Item '{item.id()}' with {_db_addon_fct=} ignored. Not able to detect update cycle.")
+
+ # handle on_change items
+ elif onchange_attribute(_db_addon_fct):
+ _update_cycle = 'on-change'
+
+ # debug log item cycle
+ if self.parse_debug:
+ self.logger.debug(f"Item '{item.id()}' added to be run {_update_cycle}.")
+
+ # add item to be run on startup (onchange_items shall not be run at startup, but at first noticed change of item value; therefore remove for list of items to be run at startup)
+ if (_db_addon_startup and not onchange_attribute(_db_addon_fct)) or (_db_addon_fct.startswith('general_')):
+ if self.parse_debug:
+ self.logger.debug(f"Item '{item.id()}' added to be run on startup")
+ item_config_data_dict.update({'startup': True})
+ else:
+ item_config_data_dict.update({'startup': False})
+
+ # add item to plugin item dict
+ self.add_item(item, config_data_dict=item_config_data_dict)
+ item_config = self.get_item_config(item)
+ item_config.update({'cycle': _update_cycle})
+
+ # handle all items with db_addon_info
+ elif self.has_iattr(item.conf, 'db_addon_info'):
+ if self.parse_debug:
+ self.logger.debug(f"parse item: {item.id()} due to used item attribute 'db_addon_info'")
+ self.add_item(item, config_data_dict={'db_addon': 'info', 'attribute': f"info_{self.get_iattr_value(item.conf, 'db_addon_info').lower()}", 'startup': True})
+
+ # handle all items with db_addon_admin
+ elif self.has_iattr(item.conf, 'db_addon_admin'):
+ if self.parse_debug:
+ self.logger.debug(f"parse item: {item.id()} due to used item attribute 'db_addon_admin'")
+ self.add_item(item, config_data_dict={'db_addon': 'admin', 'attribute': f"admin_{self.get_iattr_value(item.conf, 'db_addon_admin').lower()}"})
+ return self.update_item
+
+ # Reference to 'update_item' für alle Items mit Attribut 'database', um die on_change Items zu berechnen
+ elif self.has_iattr(item.conf, self.item_attribute_search_str) and get_db_addon_item():
+ self.logger.debug(f"reference to update_item for item '{item}' will be set due to on-change")
+ self.add_item(item, config_data_dict={'db_addon': 'database'})
+ return self.update_item
+
+ def update_item(self, item, caller=None, source=None, dest=None):
+ """
+ Handle updated item
+ This method is called, if the value of an item has been updated by SmartHomeNG.
+ It should write the changed value out to the device (hardware/interface) that is managed by this plugin.
+
+ :param item: item to be updated towards the plugin
+ :param caller: if given it represents the callers name
+ :param source: if given it represents the source
+ :param dest: if given it represents the dest
+ """
+
+ if self.alive and caller != self.get_shortname():
+ # handle database items
+ if item in self._database_items:
+ # self.logger.debug(f"update_item was called with item {item.property.path} with value {item()} from caller {caller}, source {source} and dest {dest}")
+ if not self.startup_finished:
+ self.logger.info(f"Handling of 'on-change' is paused for startup. No updated will be processed.")
+ elif self.suspended:
+ self.logger.info(f"Plugin is suspended. No updated will be processed.")
+ else:
+ self.logger.info(f"+ Updated item '{item.id()}' with value {item()} will be put to queue for processing. {self.item_queue.qsize() + 1} items to do.")
+ self.item_queue.put((item, item()))
+
+ # handle admin items
+ elif self.has_iattr(item.conf, 'db_addon_admin'):
+ self.logger.debug(f"update_item was called with item {item.property.path} from caller {caller}, source {source} and dest {dest}")
+ if self.get_iattr_value(item.conf, 'db_addon_admin') == 'suspend':
+ self.suspend(item())
+ elif self.get_iattr_value(item.conf, 'db_addon_admin') == 'recalc_all':
+ self.execute_all_items()
+ item(False, self.get_shortname())
+ elif self.get_iattr_value(item.conf, 'db_addon_admin') == 'clean_cache_values':
+ self._init_cache_dicts()
+ item(False, self.get_shortname())
+
+ def execute_due_items(self) -> None:
+ """
+ Execute all items, which are due
+ """
+
+ if self.execute_debug:
+ self.logger.debug("execute_due_items called")
+
+ if not self.suspended:
+ _todo_items = self._create_due_items()
+ self.logger.info(f"{len(_todo_items)} items are due and will be calculated.")
+ [self.item_queue.put(i) for i in _todo_items]
+ else:
+ self.logger.info(f"Plugin is suspended. No items will be calculated.")
+
+ def execute_startup_items(self) -> None:
+ """
+ Execute all startup_items
+ """
+ if self.execute_debug:
+ self.logger.debug("execute_startup_items called")
+
+ if not self.suspended:
+ self.logger.info(f"{len(self._startup_items)} items will be calculated at startup.")
+ [self.item_queue.put(i) for i in self._startup_items]
+ self.startup_finished = True
+ else:
+ self.logger.info(f"Plugin is suspended. No items will be calculated.")
+
+ def execute_static_items(self) -> None:
+ """
+ Execute all static items
+ """
+ if self.execute_debug:
+ self.logger.debug("execute_static_item called")
+
+ if not self.suspended:
+ self.logger.info(f"{len(self._static_items)} items will be calculated.")
+ [self.item_queue.put(i) for i in self._static_items]
+ else:
+ self.logger.info(f"Plugin is suspended. No items will be calculated.")
+
+ def execute_info_items(self) -> None:
+ """
+ Execute all info items
+ """
+ if self.execute_debug:
+ self.logger.debug("execute_info_items called")
+
+ if not self.suspended:
+ self.logger.info(f"{len(self._static_items)} items will be calculated.")
+ [self.item_queue.put(i) for i in self._static_items]
+ else:
+ self.logger.info(f"Plugin is suspended. No items will be calculated.")
+
+ def execute_all_items(self) -> None:
+ """
+ Execute all ondemand items
+ """
+
+ if not self.suspended:
+ self.logger.info(f"Values for all {len(self._ondemand_items)} items with 'db_addon_fct' attribute, which are not 'on-change', will be calculated!")
+ [self.item_queue.put(i) for i in self._ondemand_items]
+ else:
+ self.logger.info(f"Plugin is suspended. No items will be calculated.")
+
+ def work_item_queue(self) -> None:
+ """
+ Handles item queue were all to be executed items were be placed in.
+
+ """
+
+ self.logger.info(f"work_item_queue called.")
+
+ while self.alive:
+ try:
+ queue_entry = self.item_queue.get(True, 10)
+ self.logger.info(f"{queue_entry} received.")
+ except queue.Empty:
+ self._active_queue_item = '-'
+ pass
+ else:
+ if isinstance(queue_entry, tuple):
+ item, value = queue_entry
+ self.logger.info(f"# {self.item_queue.qsize() + 1} item(s) to do. || 'on-change' item {item.id()} with {value=} will be processed.")
+ self._active_queue_item = str(item.id())
+ self.handle_onchange(item, value)
+ else:
+ self.logger.info(f"# {self.item_queue.qsize() + 1} item(s) to do. || 'on-demand' item {queue_entry.id()} will be processed.")
+ self._active_queue_item = str(queue_entry.id())
+ self.handle_ondemand(queue_entry)
+
+ def handle_ondemand(self, item: Item) -> None:
+ """
+ Calculate value for requested item, fill cache dicts and set item value.
+
+ :param item: Item for which value will be calculated
+ """
+
+ # set/get parameters
+ item_config = self.get_item_config(item)
+ _db_addon_fct = item_config['attribute']
+ _database_item = item_config.get('database_item')
+ _ignore_value = item_config.get('ignore_value')
+ _result = None
+
+ # handle info functions
+ if _db_addon_fct.startswith('info_'):
+ # handle info_db_version
+ if _db_addon_fct == 'info_db_version':
+ _result = self._get_db_version()
+
+ # handle general functions
+ elif _db_addon_fct.startswith('general_'):
+ # handle oldest_value
+ if _db_addon_fct == 'general_oldest_value':
+ _result = self._get_oldest_value(_database_item)
+
+ # handle oldest_log
+ elif _db_addon_fct == 'general_oldest_log':
+ _result = self._get_oldest_log(_database_item)
+
+ # handle item starting with 'verbrauch_'
+ elif _db_addon_fct.startswith('verbrauch_'):
+
+ if self.execute_debug:
+ self.logger.debug(f"handle_ondemand: 'verbrauch' detected.")
+
+ _result = self._handle_verbrauch(_database_item, _db_addon_fct)
+
+ if _result and _result < 0:
+ self.logger.warning(f"Result of item {item.id()} with {_db_addon_fct=} was negative. Something seems to be wrong.")
+
+ # handle item starting with 'zaehlerstand_' of format 'zaehlerstand_timeframe_timedelta' like 'zaehlerstand_woche_minus1'
+ elif _db_addon_fct.startswith('zaehlerstand_'):
+
+ if self.execute_debug:
+ self.logger.debug(f"handle_ondemand: 'zaehlerstand' detected.")
+
+ _result = self._handle_zaehlerstand(_database_item, _db_addon_fct)
+
+ # handle item starting with 'minmax_'
+ elif _db_addon_fct.startswith('minmax_'):
+
+ if self.execute_debug:
+ self.logger.debug(f"handle_ondemand: 'minmax' detected.")
+
+ _result = self._handle_min_max(_database_item, _db_addon_fct, _ignore_value)
+
+ # handle item starting with 'serie_'
+ elif _db_addon_fct.startswith('serie_'):
+ _db_addon_params = STD_REQUEST_DICT[_db_addon_fct]
+ _db_addon_params['item'] = _database_item
+
+ if self.execute_debug:
+ self.logger.debug(f"handle_ondemand: 'serie' detected with {_db_addon_params=}")
+
+ _result = self._handle_serie(_db_addon_params)
+
+ # handle kaeltesumme
+ elif _db_addon_fct == 'kaeltesumme':
+ _db_addon_params = item_config['params']
+ _db_addon_params['_database_item'] = item_config['database_item']
+
+ if self.execute_debug:
+ self.logger.debug(f"handle_ondemand: {_db_addon_fct=} detected; {_db_addon_params=}")
+
+ _result = self._handle_kaeltesumme(**_db_addon_params)
+
+ # handle waermesumme
+ elif _db_addon_fct == 'waermesumme':
+ _db_addon_params = item_config['params']
+ _db_addon_params['_database_item'] = item_config['database_item']
+
+ if self.execute_debug:
+ self.logger.debug(f"handle_ondemand: {_db_addon_fct=} detected; {_db_addon_params=}")
+
+ _result = self._handle_waermesumme(**_db_addon_params)
+
+ # handle gruenlandtempsumme
+ elif _db_addon_fct == 'gruenlandtempsumme':
+ _db_addon_params = item_config['params']
+ _db_addon_params['_database_item'] = item_config['database_item']
+
+ if self.execute_debug:
+ self.logger.debug(f"handle_ondemand: {_db_addon_fct=} detected; {_db_addon_params=}")
+
+ _result = self._handle_gruenlandtemperatursumme(**_db_addon_params)
+
+ # handle tagesmitteltemperatur
+ elif _db_addon_fct == 'tagesmitteltemperatur':
+ _db_addon_params = item_config['params']
+ _db_addon_params['_database_item'] = item_config['database_item']
+
+ if self.execute_debug:
+ self.logger.debug(f"handle_ondemand: {_db_addon_fct=} detected; {_db_addon_params=}")
+
+ _result = self._handle_tagesmitteltemperatur(**_db_addon_params)
+
+ # handle db_request
+ elif _db_addon_fct == 'db_request':
+ _db_addon_params = item_config['params']
+ _db_addon_params['îtem'] = item_config['database_item']
+
+ if self.execute_debug:
+ self.logger.debug(f"handle_ondemand: {_db_addon_fct=} detected with {_db_addon_params=}")
+
+ if _db_addon_params.keys() & {'func', 'item', 'timeframe'}:
+ _result = self._query_item(**_db_addon_params)
+ else:
+ self.logger.error(f"Attribute 'db_addon_params' not containing needed params for Item {item.id} with {_db_addon_fct=}.")
+
+ # handle everything else
+ else:
+ self.logger.warning(f"handle_ondemand: Function '{_db_addon_fct}' for item {item.id()} not defined or found.")
+ return
+
+ # log result
+ if self.execute_debug:
+ self.logger.debug(f"handle_ondemand: result is {_result} for item '{item.id()}' with '{_db_addon_fct=}'")
+
+ if _result is None:
+ self.logger.info(f" Result was None; No item value will be set.")
+ return
+
+ # set item value and put data into plugin_item_dict
+ self.logger.info(f" Item value for '{item.id()}' will be set to {_result}")
+ item_config = self.get_item_config(item)
+ item_config.update({'value': _result})
+ item(_result, self.get_shortname())
+
+ def handle_onchange(self, updated_item: Item, value: float) -> None:
+ """
+ Get item and item value for which an update has been detected, fill cache dicts and set item value.
+
+ :param updated_item: Item which has been updated
+ :param value: Value of updated item
+ """
+
+ if self.onchange_debug:
+ self.logger.debug(f"handle_onchange called with updated_item={updated_item.id()} and value={value}.")
+
+ relevant_item_list = self.get_item_list('database_item', updated_item)
+ if self.onchange_debug:
+ self.logger.debug(f"Following items where identified for update: {relevant_item_list}.")
+
+ for item in relevant_item_list:
+ item_config = self.get_item_config(item)
+ _database_item = item_config['database_item']
+ _db_addon_fct = item_config['attribute']
+ _var = _db_addon_fct.split('_')
+ _ignore_value = item_config['ignore_value']
+
+ # handle minmax on-change items like minmax_heute_max, minmax_heute_min, minmax_woche_max, minmax_woche_min.....
+ if _db_addon_fct.startswith('minmax') and len(_var) == 3 and _var[2] in ['min', 'max']:
+ _timeframe = convert_timeframe(_var[1])
+ _func = _var[2]
+ _cache_dict = self.current_values[_timeframe]
+
+ if self.onchange_debug:
+ self.logger.debug(f"handle_onchange: 'minmax' item {updated_item.id()} with {_func=} detected. Check for update of _cache_dicts and item value.")
+
+ _initial_value = False
+ _new_value = None
+
+ # make sure, that database item is in cache dict
+ if _database_item not in _cache_dict:
+ _cache_dict[_database_item] = {}
+ if _cache_dict[_database_item].get(_func, None) is None:
+ _cached_value = self._query_item(func=_func, item=_database_item, timeframe=_timeframe, start=0, end=0, ignore_value=_ignore_value)[0][1]
+ _initial_value = True
+ if self.onchange_debug:
+ self.logger.debug(f"handle_onchange: Item={updated_item.id()} with _func={_func} and _timeframe={_timeframe} not in cache dict. recent value={_cached_value}.")
+ else:
+ _cached_value = _cache_dict[_database_item][_func]
+
+ if _cached_value:
+ # check value for update of cache dict
+ if _func == 'min' and value < _cached_value:
+ _new_value = value
+ if self.onchange_debug:
+ self.logger.debug(f"handle_onchange: new value={_new_value} lower then current min_value={_cached_value}. _cache_dict will be updated")
+ elif _func == 'max' and value > _cached_value:
+ _new_value = value
+ if self.onchange_debug:
+ self.logger.debug(f"handle_onchange: new value={_new_value} higher then current max_value={_cached_value}. _cache_dict will be updated")
+ else:
+ if self.onchange_debug:
+ self.logger.debug(f"handle_onchange: new value={_new_value} will not change max/min for period.")
+ else:
+ _cached_value = value
+
+ if _initial_value and not _new_value:
+ _new_value = _cached_value
+ if self.onchange_debug:
+ self.logger.debug(f"handle_onchange: initial value for item will be set with value {_new_value}")
+
+ if _new_value:
+ _cache_dict[_database_item][_func] = _new_value
+ self.logger.info(f"Item value for '{item.id()}' with func={_func} will be set to {_new_value}")
+ item_config = self.get_item_config(item)
+ item_config.update({'value': _new_value})
+ item(_new_value, self.get_shortname())
+ else:
+ self.logger.info(f"Received value={value} is not influencing min / max value. Therefore item {item.id()} will not be changed.")
+
+ # handle verbrauch on-change items ending with heute, woche, monat, jahr
+ elif _db_addon_fct.startswith('verbrauch') and len(_var) == 2 and _var[1] in ['heute', 'woche', 'monat', 'jahr']:
+ _timeframe = convert_timeframe(_var[1])
+ _cache_dict = self.previous_values[_timeframe]
+
+ # make sure, that database item is in cache dict
+ if _database_item not in _cache_dict:
+ _cached_value = self._query_item(func='max', item=_database_item, timeframe=_timeframe, start=1, end=1, ignore_value=_ignore_value)[0][1]
+ _cache_dict[_database_item] = _cached_value
+ if self.onchange_debug:
+ self.logger.debug(f"handle_onchange: Item={updated_item.id()} with {_timeframe=} not in cache dict. Value {_cached_value} has been added.")
+ else:
+ _cached_value = _cache_dict[_database_item]
+
+ # calculate value, set item value, put data into plugin_item_dict
+ if _cached_value is not None:
+ _new_value = round(value - _cached_value, 1)
+ self.logger.info(f"Item value for '{item.id()}' will be set to {_new_value}")
+ item_config = self.get_item_config(item)
+ item_config.update({'value': _new_value})
+ item(_new_value, self.get_shortname())
+ else:
+ self.logger.info(f"Value for end of last {_timeframe} not available. No item value will be set.")
+
+ @property
+ def log_level(self):
+ return self.logger.getEffectiveLevel()
+
+ @property
+ def queue_backlog(self):
+ return self.item_queue.qsize()
+
+ @property
+ def active_queue_item(self):
+ return self._active_queue_item
+
+ @property
+ def db_version(self):
+ return self._get_db_version()
+
+ @property
+ def _startup_items(self) -> list:
+ return self.get_item_list('startup', True)
+
+ @property
+ def _onchange_items(self) -> list:
+ return self.get_item_list('cycle', 'on-change')
+
+ @property
+ def _daily_items(self) -> list:
+ return self.get_item_list('cycle', 'daily')
+
+ @property
+ def _weekly_items(self) -> list:
+ return self.get_item_list('cycle', 'weekly')
+
+ @property
+ def _monthly_items(self) -> list:
+ return self.get_item_list('cycle', 'monthly')
+
+ @property
+ def _yearly_items(self) -> list:
+ return self.get_item_list('cycle', 'yearly')
+
+ @property
+ def _static_items(self) -> list:
+ return self.get_item_list('cycle', 'static')
+
+ @property
+ def _admin_items(self) -> list:
+ return self.get_item_list('db_addon', 'admin')
+
+ @property
+ def _info_items(self) -> list:
+ return self.get_item_list('db_addon', 'info')
+
+ @property
+ def _database_items(self) -> list:
+ return self.get_item_list('db_addon', 'database')
+
+ @property
+ def _ondemand_items(self) -> list:
+ return self._daily_items + self._weekly_items + self._monthly_items + self._yearly_items + self._static_items
+
+ ##############################
+ # Public functions
+ ##############################
+
+ def gruenlandtemperatursumme(self, item: Item, year: Union[int, str]) -> Union[int, None]:
+ """
+ Query database for gruenlandtemperatursumme for given year or year/month
+ https://de.wikipedia.org/wiki/Gr%C3%BCnlandtemperatursumme
+
+ :param item: item object or item_id for which the query should be done
+ :param year: year the gruenlandtemperatursumme should be calculated for
+
+ :return: gruenlandtemperatursumme
+ """
+
+ return self._handle_gruenlandtemperatursumme(item, year)
+
+ def waermesumme(self, item: Item, year, month: Union[int, str] = None) -> Union[int, None]:
+ """
+ Query database for waermesumme for given year or year/month
+
+ :param item: item object or item_id for which the query should be done
+ :param year: year the waermesumme should be calculated for
+ :param month: month the waermesumme should be calculated for
+
+ :return: waermesumme
+ """
+
+ return self._handle_waermesumme(item, year, month)
+
+ def kaeltesumme(self, item: Item, year, month: Union[int, str] = None) -> Union[int, None]:
+ """
+ Query database for kaeltesumme for given year or year/month
+
+ :param item: item object or item_id for which the query should be done
+ :param year: year the kaeltesumme should be calculated for
+ :param month: month the kaeltesumme should be calculated for
+
+ :return: kaeltesumme
+ """
+
+ return self._handle_kaeltesumme(item, year, month)
+
+ def tagesmitteltemperatur(self, item: Item, count: int = None) -> list:
+ """
+ Query database for tagesmitteltemperatur
+
+ :param item: item object or item_id for which the query should be done
+ :param count: start of timeframe defined by number of time increments starting from now to the left (into the past)
+
+ :return: tagesmitteltemperatur
+ :rtype: list of tuples
+ """
+
+ return self._handle_tagesmitteltemperatur(_database_item=item, count=count)
+
+ def fetch_log(self, func: str, item: Item, timeframe: str, start: int = None, end: int = 0, count: int = None, group: str = None, group2: str = None, ignore_value=None) -> Union[list, None]:
+ """
+ Query database, format response and return it
+
+ :param func: function to be used at query
+ :param item: item str or item_id for which the query should be done
+ :param timeframe: time increment für definition of start, end, count (day, week, month, year)
+ :param start: start of timeframe (oldest) for query given in x time increments (default = None, meaning complete database)
+ :param end: end of timeframe (newest) for query given in x time increments (default = 0, meaning today, end of last week, end of last month, end of last year)
+ :param count: start of timeframe defined by number of time increments starting from end to the left (into the past)
+ :param group: first grouping parameter (default = None, possible values: day, week, month, year)
+ :param group2: second grouping parameter (default = None, possible values: day, week, month, year)
+ :param ignore_value: value of val_num, which will be ignored during query
+
+ :return: formatted query response
+ """
+
+ if isinstance(item, str):
+ item = self.items.return_item(item)
+ if count:
+ start, end = count_to_start(count)
+ return self._query_item(func=func, item=item, timeframe=timeframe, start=start, end=end, group=group, group2=group2, ignore_value=ignore_value)
+
+ def fetch_raw(self, query: str, params: dict = None) -> Union[list, None]:
+ """
+ Fetch database with given query string and params
+
+ :param query: database query to be executed
+ :param params: query parameters
+
+ :return: result of database query
+ """
+
+ if params is None:
+ params = {}
+
+ formatted_sql = sqlvalidator.format_sql(query)
+ sql_query = sqlvalidator.parse(formatted_sql)
+
+ if not sql_query.is_valid():
+ self.logger.error(f"fetch_raw: Validation of query failed with error: {sql_query.errors}")
+ return
+
+ return self._fetchall(query, params)
+
+ def suspend(self, state: bool = False) -> bool:
+ """
+ Will pause value evaluation of plugin
+
+ """
+
+ if state:
+ self.logger.warning("Plugin is set to 'suspended'. Queries to database will not be made until suspension is cancelled.")
+ self.suspended = True
+ self._clear_queue()
+ else:
+ self.logger.warning("Plugin suspension cancelled. Queries to database will be resumed.")
+ self.suspended = False
+
+ # write back value to item, if one exists
+ for item in self.get_item_list('db_addon', 'admin'):
+ item_config = self.get_item_config(item)
+ if item_config['attribute'] == 'suspend':
+ item(self.suspended, self.get_shortname())
+
+ return self.suspended
+
+ ##############################
+ # Support stuff
+ ##############################
+
+ def _handle_min_max(self, _database_item: Item, _db_addon_fct: str, _ignore_value):
+ """
+ Handle execution of min/max calculation
+
+ """
+
+ _var = _db_addon_fct.split('_')
+ _result = None
+ _timeframes = ['heute', 'woche', 'monat', 'jahr']
+
+ # handle all on_change functions of format 'minmax_timeframe_function' like 'minmax_heute_max'
+ if len(_var) == 3 and _var[1] in _timeframes and _var[2] in ['min', 'max']:
+ if self.execute_debug:
+ self.logger.debug(f"on-change function={_var[0]} with {_var[1]} detected; will be calculated by next change of database item")
+
+ # handle all 'last' functions in format 'minmax_last_window_function' like 'minmax_last_24h_max'
+ elif len(_var) == 4 and _var[1] == 'last' and _var[3] in ['min', 'max', 'avg']:
+ _window = _var[2]
+ _func = _var[3]
+ _timeframe = convert_timeframe(_window[-1:])
+ _timedelta = int(_window[:-1])
+
+ if self.execute_debug:
+ self.logger.debug(f"_handle_min_max: 'last' function detected. {_window=}, {_func=}")
+
+ if _timeframe in ['day', 'week', 'month', 'year']:
+ _result = self._query_item(func=_func, item=_database_item, timeframe=_timeframe, start=_timedelta, end=0, ignore_value=_ignore_value)[0][1]
+
+ # handle all functions 'min/max/avg' in format 'minmax_timeframe_timedelta_func' like 'minmax_heute_minus2_max'
+ elif len(_var) == 4 and _var[1] in _timeframes and _var[2].startswith('minus') and _var[3] in ['min', 'max', 'avg']:
+ _timeframe = convert_timeframe(_var[1]) # day, week, month, year
+ _timedelta = _var[2][-1] # 1, 2, 3, ...
+ _func = _var[3] # min, max, avg
+
+ if self.execute_debug:
+ self.logger.debug(f"_handle_min_max: _db_addon_fct={_func} detected; {_timeframe=}, {_timedelta=}")
+
+ if isinstance(_timedelta, str) and _timedelta.isdigit():
+ _timedelta = int(_timedelta)
+
+ if isinstance(_timedelta, int):
+ _result = self._query_item(func=_func, item=_database_item, timeframe=_timeframe, start=_timedelta, end=_timedelta, ignore_value=_ignore_value)[0][1]
+
+ return _result
+
+ def _handle_zaehlerstand(self, _database_item: Item, _db_addon_fct: str):
+ """
+ Handle execution of Zaehlerstand calculation
+
+ """
+
+ _var = _db_addon_fct.split('_') # zaehlerstand_heute_minus1
+ _result = None
+ _func = _var[0]
+ _timeframe = convert_timeframe(_var[1])
+ _timedelta = _var[2][-1]
+
+ if self.execute_debug:
+ self.logger.debug(f"_handle_zaehlerstand: {_func} function detected. {_timeframe=}, {_timedelta=}")
+
+ if isinstance(_timedelta, str) and _timedelta.isdigit():
+ _timedelta = int(_timedelta)
+
+ if _func == 'zaehlerstand':
+ _result = self._query_item(func='max', item=_database_item, timeframe=_timeframe, start=_timedelta, end=_timedelta)[0][1]
+
+ return _result
+
+ def _handle_verbrauch(self, _database_item: Item, _db_addon_fct: str):
+ """
+ Handle execution of verbrauch calculation
+
+ """
+
+ _var = _db_addon_fct.split('_')
+ _result = None
+
+ # handle all on_change functions of format 'verbrauch_timeframe' like 'verbrauch_heute'
+ if len(_var) == 2 and _var[1] in ['heute', 'woche', 'monat', 'jahr']:
+ if self.execute_debug:
+ self.logger.debug(f"on_change function={_var[1]} detected; will be calculated by next change of database item")
+
+ # handle all functions 'verbrauch' in format 'verbrauch_timeframe_timedelta' like 'verbrauch_heute_minus2'
+ elif len(_var) == 3 and _var[1] in ['heute', 'woche', 'monat', 'jahr'] and _var[2].startswith('minus'):
+ _timeframe = convert_timeframe(_var[1])
+ _timedelta = _var[2][-1]
+
+ if self.execute_debug:
+ self.logger.debug(f"_handle_verbrauch: '{_db_addon_fct}' function detected. {_timeframe=}, {_timedelta=}")
+
+ if isinstance(_timedelta, str) and _timedelta.isdigit():
+ _timedelta = int(_timedelta)
+
+ if isinstance(_timedelta, int):
+ _result = self._consumption_calc(_database_item, _timeframe, start=_timedelta + 1, end=_timedelta)
+
+ # handle all functions of format 'verbrauch_function_window_timeframe_timedelta' like 'verbrauch_rolling_12m_woche_minus1'
+ elif len(_var) == 5 and _var[1] == 'rolling' and _var[4].startswith('minus'):
+ _func = _var[1]
+ _window = _var[2] # 12m
+ _window_inc = int(_window[:-1]) # 12
+ _window_dur = convert_timeframe(_window[-1]) # day, week, month, year
+ _timeframe = convert_timeframe(_var[3]) # day, week, month, year
+ _timedelta = _var[4][-1] # 1
+
+ if self.execute_debug:
+ self.logger.debug(f"_handle_verbrauch: '{_func}' function detected. {_window=}, {_timeframe=}, {_timedelta=}")
+
+ if isinstance(_timedelta, str) and _timedelta.isdigit():
+ _timedelta = int(_timedelta)
+ _endtime = _timedelta
+
+ if _func == 'rolling' and _window_dur in ['day', 'week', 'month', 'year']:
+ _starttime = convert_duration(_timeframe, _window_dur) * _window_inc
+ _result = self._consumption_calc(_database_item, _timeframe, _starttime, _endtime)
+
+ # handle all functions of format 'verbrauch_timeframe_timedelta' like 'verbrauch_jahreszeitraum_minus1'
+ elif len(_var) == 3 and _var[1] == 'jahreszeitraum' and _var[2].startswith('minus'):
+ _timeframe = convert_timeframe(_var[1]) # day, week, month, year
+ _timedelta = _var[2][-1] # 1 oder 2 oder 3
+
+ if self.execute_debug:
+ self.logger.debug(f"_handle_verbrauch: '{_db_addon_fct}' function detected. {_timeframe=}, {_timedelta=}")
+
+ if isinstance(_timedelta, str) and _timedelta.isdigit():
+ _timedelta = int(_timedelta)
+
+ if isinstance(_timedelta, int):
+ _today = datetime.date.today()
+ _year = _today.year - _timedelta
+ _start_date = datetime.date(_year, 1, 1) - relativedelta(days=1) # Start ist Tag vor dem 1.1., damit Abfrage den Maximalwert von 31.12. 00:00:00 bis 1.1. 00:00:00 ergibt
+ _end_date = _today - relativedelta(years=_timedelta)
+ _start = (_today - _start_date).days
+ _end = (_today - _end_date).days
+
+ _result = self._consumption_calc(_database_item, _timeframe, _start, _end)
+
+ return _result
+
+ def _handle_serie(self, _db_addon_params: dict):
+ """
+ Handle execution of serie calculation
+
+ """
+ return self._query_item(**_db_addon_params)
+
+ def _handle_kaeltesumme(self, _database_item: Item, year: Union[int, str], month: Union[int, str] = None) -> Union[int, None]:
+ """
+ Query database for kaeltesumme for given year or year/month
+
+ :param _database_item: item object or item_id for which the query should be done
+ :param year: year the kaeltesumme should be calculated for
+ :param month: month the kaeltesumme should be calculated for
+ :return: kaeltesumme
+ """
+
+ # check validity of given year
+ if not valid_year(year):
+ self.logger.error(f"kaeltesumme: Year for item={_database_item.id()} was {year}. This is not a valid year. Query cancelled.")
+ return
+
+ if year == 'current':
+ if datetime.date.today() < datetime.date(int(datetime.date.today().year), 9, 21):
+ year = datetime.date.today().year - 1
+ else:
+ year = datetime.date.today().year
+
+ if month is None:
+ start_date = datetime.date(int(year), 9, 21)
+ end_date = datetime.date(int(year) + 1, 3, 22)
+ group2 = 'year'
+ elif valid_month(month):
+ start_date = datetime.date(int(year), int(month), 1)
+ end_date = start_date + relativedelta(months=+1) - datetime.timedelta(days=1)
+ group2 = 'month'
+ else:
+ self.logger.error(f"kaeltesumme: Month for item={_database_item.id()} was {month}. This is not a valid month. Query cancelled.")
+ return
+
+ today = datetime.date.today()
+ if start_date > today:
+ self.logger.error(f"kaeltesumme: Start time for query of item={_database_item.id()} is in future. Query cancelled.")
+ return
+
+ start = (today - start_date).days
+ end = (today - end_date).days if end_date < today else 0
+ if start < end:
+ self.logger.error(f"kaeltesumme: End time for query of item={_database_item.id()} is before start time. Query cancelled.")
+ return
+
+ _db_addon_params = STD_REQUEST_DICT.get('kaltesumme_year_month', None)
+ _db_addon_params.update({'start': start, 'end': end, 'group2': group2, 'item': _database_item})
+
+ # query db and generate values
+ _result = self._query_item(**_db_addon_params)
+ self.logger.debug(f"kaeltesumme: {_result=} for {_database_item.id()=} with {year=} and {month=}")
+
+ # calculate value
+ value = 0
+ if _result == [[None, None]]:
+ return
+ try:
+ if month:
+ value = _result[0][1]
+ else:
+ for entry in _result:
+ entry_value = entry[1]
+ if entry_value:
+ value += entry_value
+ return int(value)
+ except Exception as e:
+ self.logger.error(f"Error {e} occurred during calculation of kaeltesumme with {_result=} for {_database_item.id()=} with {year=} and {month=}")
+
+ def _handle_waermesumme(self, _database_item: Item, year: Union[int, str], month: Union[int, str] = None) -> Union[int, None]:
+ """
+ Query database for waermesumme for given year or year/month
+
+ :param _database_item: item object or item_id for which the query should be done
+ :param year: year the waermesumme should be calculated for
+ :param month: month the waermesumme should be calculated for
+ :return: waermesumme
+ """
+
+ if not valid_year(year):
+ self.logger.error(f"waermesumme: Year for item={_database_item.id()} was {year}. This is not a valid year. Query cancelled.")
+ return
+
+ if year == 'current':
+ year = datetime.date.today().year
+
+ if month is None:
+ start_date = datetime.date(int(year), 3, 20)
+ end_date = datetime.date(int(year), 9, 21)
+ group2 = 'year'
+ elif valid_month(month):
+ start_date = datetime.date(int(year), int(month), 1)
+ end_date = start_date + relativedelta(months=+1) - datetime.timedelta(days=1)
+ group2 = 'month'
+ else:
+ self.logger.error(f"waermesumme: Month for item={_database_item.id()} was {month}. This is not a valid month. Query cancelled.")
+ return
+
+ today = datetime.date.today()
+ if start_date > today:
+ self.logger.info(f"waermesumme: Start time for query of item={_database_item.id()} is in future. Query cancelled.")
+ return
+
+ start = (today - start_date).days
+ end = (today - end_date).days if end_date < today else 0
+ if start < end:
+ self.logger.error(f"waermesumme: End time for query of item={_database_item.id()} is before start time. Query cancelled.")
+ return
+
+ _db_addon_params = STD_REQUEST_DICT.get('waermesumme_year_month', None)
+ _db_addon_params.update({'start': start, 'end': end, 'group2': group2, 'item': _database_item})
+
+ # query db and generate values
+ _result = self._query_item(**_db_addon_params)[0][1]
+ self.logger.debug(f"waermesumme_year_month: {_result=} for {_database_item.id()=} with {year=} and {month=}")
+
+ # calculate value
+ if _result == [[None, None]]:
+ return
+
+ if _result is not None:
+ return int(_result)
+ else:
+ return
+
+ def _handle_gruenlandtemperatursumme(self, _database_item: Item, year: Union[int, str]) -> Union[int, None]:
+ """
+ Query database for gruenlandtemperatursumme for given year or year/month
+
+ :param _database_item: item object or item_id for which the query should be done
+ :param year: year the gruenlandtemperatursumme should be calculated for
+ :return: gruenlandtemperatursumme
+ """
+
+ if not valid_year(year):
+ self.logger.error(f"gruenlandtemperatursumme: Year for item={_database_item.id()} was {year}. This is not a valid year. Query cancelled.")
+ return
+
+ current_year = datetime.date.today().year
+
+ if year == 'current':
+ year = current_year
+
+ year = int(year)
+ year_delta = current_year - year
+ if year_delta < 0:
+ self.logger.error(f"gruenlandtemperatursumme: Start time for query of item={_database_item.id()} is in future. Query cancelled.")
+ return
+
+ _db_addon_params = STD_REQUEST_DICT.get('gts', None)
+ _db_addon_params.update({'start': year_delta, 'end': year_delta, 'item': _database_item})
+
+ # query db and generate values
+ _result = self._query_item(**_db_addon_params)
+
+ # calculate value and return it
+ if _result == [[None, None]]:
+ return
+
+ try:
+ gts = 0
+ for entry in _result:
+ dt = datetime.datetime.fromtimestamp(int(entry[0]) / 1000)
+ if dt.month == 1:
+ gts += float(entry[1]) * 0.5
+ elif dt.month == 2:
+ gts += float(entry[1]) * 0.75
+ else:
+ gts += entry[1]
+ return int(round(gts, 0))
+ except Exception as e:
+ self.logger.error(f"Error {e} occurred during calculation of gruenlandtemperatursumme with {_result=} for {_database_item.id()=}")
+
+ def _handle_tagesmitteltemperatur(self, _database_item: Item, count: int = None) -> list:
+ """
+ Query database for tagesmitteltemperatur
+
+ :param _database_item: item object or item_id for which the query should be done
+ :param count: start of timeframe defined by number of time increments starting from now to the left (into the past)
+ :return: tagesmitteltemperatur
+ """
+
+ start, end = count_to_start(count)
+ _db_addon_params = STD_REQUEST_DICT.get('tagesmittelwert_hour_days', None)
+ _db_addon_params.update({'item': _database_item, 'start': start, 'end': end})
+
+ return self._query_item(**_db_addon_params)[0][1]
+
+ def _create_due_items(self) -> list:
+ """
+ Create set of items which are due and resets cache dicts
+
+ :return: set of items, which need to be processed
+
+ """
+
+ _todo_items = set()
+ _todo_items.update(set(self._daily_items))
+ self.current_values[DAY] = {}
+ self.previous_values[DAY] = {}
+
+ # wenn jetzt Wochentag = Montag ist, werden auch die wöchentlichen Items berechnet
+ if self.shtime.now().hour == 0 and self.shtime.now().minute == 0 and self.shtime.weekday(self.shtime.today()) == 1:
+ _todo_items.update(set(self._weekly_items))
+ # self.wochenwert_dict = {}
+ # self.vorwochenendwert_dict = {}
+ self.current_values[WEEK] = {}
+ self.previous_values[WEEK] = {}
+
+ # wenn jetzt der erste Tage eines Monates ist, werden auch die monatlichen Items berechnet
+ if self.shtime.now().hour == 0 and self.shtime.now().minute == 0 and self.shtime.now().day == 1:
+ _todo_items.update(set(self._monthly_items))
+ # self.monatswert_dict = {}
+ # self.vormonatsendwert_dict = {}
+ self.current_values[MONTH] = {}
+ self.previous_values[MONTH] = {}
+
+ # wenn jetzt der erste Tage des ersten Monates eines Jahres ist, werden auch die jährlichen Items berechnet
+ if self.shtime.now().hour == 0 and self.shtime.now().minute == 0 and self.shtime.now().day == 1 and self.shtime.now().month == 1:
+ _todo_items.update(set(self._yearly_items))
+ # self.jahreswert_dict = {}
+ # self.vorjahresendwert_dict = {}
+ self.current_values[YEAR] = {}
+ self.previous_values[YEAR] = {}
+
+ return list(_todo_items)
+
+ def _check_db_existence(self) -> bool:
+ """
+ Check existence of database plugin with given config name
+
+ :return: Status of db existence
+ """
+
+ try:
+ _db_plugin = self.plugins.return_plugin(self.db_configname)
+ except Exception as e:
+ self.logger.error(f"Database plugin not loaded, Error was {e}. No need for DatabaseAddOn Plugin.")
+ return False
+ else:
+ if not _db_plugin:
+ self.logger.error(f"Database plugin not loaded or given ConfigName {self.db_configname} not correct. No need for DatabaseAddOn Plugin.")
+ return False
+ else:
+ self.logger.debug(f"Corresponding plugin 'database' with given config name '{self.db_configname}' found.")
+ self._db_plugin = _db_plugin
+ return self._get_db_parameter()
+
+ def _get_db_parameter(self) -> bool:
+ """
+ Get driver of database and connection parameter
+
+ :return: Status of db connection parameters
+ """
+
+ try:
+ self.db_driver = self._db_plugin.get_parameter_value('driver')
+ except Exception as e:
+ self.logger.error(f"Error {e} occurred during getting database plugin parameter 'driver'. DatabaseAddOn Plugin not loaded.")
+ return False
+ else:
+ if self.db_driver.lower() == 'pymysql':
+ self.logger.debug(f"Database is of type 'mysql' found.")
+ if self.db_driver.lower() == 'sqlite3':
+ self.logger.debug(f"Database is of type 'sqlite' found.")
+
+ # get database plugin parameters
+ try:
+ db_instance = self._db_plugin.get_instance_name()
+ if db_instance != "":
+ self.db_instance = db_instance
+ self.item_attribute_search_str = f"{self.item_attribute_search_str}@{self.db_instance}"
+ self.connection_data = self._db_plugin.get_parameter_value('connect') # pymsql ['host:localhost', 'user:smarthome', 'passwd:smarthome', 'db:smarthome', 'port:3306']
+ self.logger.debug(f"Database Plugin available with instance={self.db_instance} and connection={self.connection_data}")
+ except Exception as e:
+ self.logger.error(f"Error {e} occurred during getting database plugin parameters. DatabaseAddOn Plugin not loaded.")
+ return False
+ else:
+ return True
+
+ def _initialize_db(self) -> bool:
+ """
+ Initializes database connection
+
+ :return: Status of initialization
+ """
+
+ try:
+ if not self._db.connected():
+ # limit connection requests to 20 seconds.
+ current_time = time.time()
+ time_delta_last_connect = current_time - self.last_connect_time
+ # self.logger.debug(f"DEBUG: delta {time_delta_last_connect}")
+ if time_delta_last_connect > 20:
+ self.last_connect_time = time.time()
+ self._db.connect()
+ else:
+ self.logger.error(f"_initialize_db: Database reconnect suppressed: Delta time: {time_delta_last_connect}")
+ return False
+ except Exception as e:
+ self.logger.critical(f"_initialize_db: Database: Initialization failed: {e}")
+ return False
+ else:
+ return True
+
+ def _check_db_connection_setting(self) -> None:
+ """
+ Check Setting of DB connection for stable use.
+ """
+ try:
+ connect_timeout = int(self._get_db_connect_timeout()[1])
+ if connect_timeout < self.default_connect_timeout:
+ self.logger.warning(f"DB variable 'connect_timeout' should be adjusted for proper working to {self.default_connect_timeout}. Current setting is {connect_timeout}. You need to insert adequate entries into /etc/mysql/my.cnf within section [mysqld].")
+ except Exception:
+ pass
+
+ try:
+ net_read_timeout = int(self._get_db_net_read_timeout()[1])
+ if net_read_timeout < self.default_net_read_timeout:
+ self.logger.warning(f"DB variable 'net_read_timeout' should be adjusted for proper working to {self.default_net_read_timeout}. Current setting is {net_read_timeout}. You need to insert adequate entries into /etc/mysql/my.cnf within section [mysqld].")
+ except Exception:
+ pass
+
+ def _get_oldest_log(self, item: Item) -> int:
+ """
+ Get timestamp of the oldest entry of item from cache dict or get value from db and put it to cache dict
+
+ :param item: Item, for which query should be done
+ :return: timestamp of the oldest log
+ """
+
+ _oldest_log = self.item_cache.get(item, {}).get('oldest_log', None)
+
+ if _oldest_log is None:
+ item_id = self._get_itemid(item)
+ _oldest_log = self._read_log_oldest(item_id)
+ if item not in self.item_cache:
+ self.item_cache[item] = {}
+ self.item_cache[item]['oldest_log'] = _oldest_log
+
+ if self.prepare_debug:
+ self.logger.debug(f"_get_oldest_log for item {item.id()} = {_oldest_log}")
+
+ return _oldest_log
+
+ def _get_oldest_value(self, item: Item) -> Union[int, float, bool]:
+ """
+ Get value of the oldest log of item from cache dict or get value from db and put it to cache dict
+
+ :param item: Item, for which query should be done
+ :return: oldest value
+ """
+
+ _oldest_entry = self.item_cache.get(item, {}).get('_oldest_entry', None)
+
+ if _oldest_entry is not None:
+ _oldest_value = _oldest_entry[0][4]
+ else:
+ item_id = self._get_itemid(item)
+ validity = False
+ i = 0
+ _oldest_value = -999999999
+ while validity is False:
+ oldest_entry = self._read_log_timestamp(item_id, self._get_oldest_log(item))
+ i += 1
+ if isinstance(oldest_entry, list) and isinstance(oldest_entry[0], tuple) and len(oldest_entry[0]) >= 4:
+ if item not in self.item_cache:
+ self.item_cache[item] = {}
+ self.item_cache[item]['oldest_entry'] = oldest_entry
+ _oldest_value = oldest_entry[0][4]
+ validity = True
+ elif i == 10:
+ validity = True
+ self.logger.error(f"oldest_value for item {item.id()} could not be read; value is set to -999999999")
+
+ if self.prepare_debug:
+ self.logger.debug(f"_get_oldest_value for item {item.id()} = {_oldest_value}")
+
+ return _oldest_value
+
+ def _get_itemid(self, item: Item) -> int:
+ """
+ Returns the ID of the given item from cache dict or request it from database
+
+ :param item: Item to get the ID for
+ :return: id of the item within the database
+ """
+
+ # self.logger.debug(f"_get_itemid called with item={item.id()}")
+ _item_id = self.item_cache.get(item, {}).get('id', None)
+ if _item_id is None:
+ row = self._read_item_table(item)
+ if row:
+ if len(row) > 0:
+ _item_id = int(row[0])
+ if item not in self.item_cache:
+ self.item_cache[item] = {}
+ self.item_cache[item]['id'] = _item_id
+ return _item_id
+
+ def _get_itemid_for_query(self, item: Item) -> Union[int, None]:
+ """
+ Get DB item id for query
+
+ :param item: item, the query should be done for
+
+ """
+
+ if isinstance(item, Item):
+ item_id = self._get_itemid(item)
+ elif isinstance(item, str) and item.isdigit():
+ item_id = int(item)
+ elif isinstance(item, int):
+ item_id = item
+ else:
+ item_id = None
+ return item_id
+
+ def _handle_query_result(self, query_result: Union[list, None]) -> list:
+ """
+ Handle query result containing list
+
+ :param query_result: list of query result with [[value, value], [value, value] for regular result, [[None, None]] for errors, [[0,0]] for 'no values for requested timeframe'
+
+ """
+
+ # if query delivers None, abort
+ if query_result is None:
+ # if query delivers None, abort
+ self.logger.error(f"Error occurred during _query_item. Aborting...")
+ _result = [[None, None]]
+ elif len(query_result) == 0:
+ _result = [[0, 0]]
+ self.logger.info(f" No values for item in requested timeframe in database found.")
+ else:
+ _result = []
+ for element in query_result:
+ timestamp = element[0]
+ value = element[1]
+ if timestamp and value is not None:
+ _result.append([timestamp, round(value, 1)])
+ if not _result:
+ _result = [[None, None]]
+
+ # if self.prepare_debug:
+ # self.logger.debug(f"_handle_query_result: {_result=}")
+
+ return _result
+
+ def _consumption_calc(self, item, timeframe: str, start: int, end: int) -> Union[float, None]:
+ """
+ Handle query for Verbrauch
+
+ :param item: item, the query should be done for
+ :param timeframe: timeframe as week, month, year
+ :param start: beginning of timeframe
+ :param start: end of timeframe
+
+ """
+
+ if self.prepare_debug:
+ self.logger.debug(f"_consumption_calc called with {item=},{timeframe=},{start=},{end=}")
+
+ _result = None
+
+ # get value for end and check it;
+ value_end = self._query_item(func='max', item=item, timeframe=timeframe, start=end, end=end)[0][1]
+ if self.prepare_debug:
+ self.logger.debug(f"_consumption_calc {value_end=}")
+
+ if value_end is None: # if None (Error) return
+ return
+ elif value_end == 0: # wenn die Query "None" ergab, was wiederum bedeutet, dass zum Abfragezeitpunkt keine Daten vorhanden sind, ist der value hier gleich 0 → damit der Verbrauch für die Abfrage auch Null
+ _result = 0
+ else:
+ # get value for start and check it;
+ # value_start = self._query_item(func='max', item=item, timeframe=timeframe, start=start, end=start)[0][1]
+ value_start = self._query_item(func='min', item=item, timeframe=timeframe, start=end, end=end)[0][1]
+ if self.prepare_debug:
+ self.logger.debug(f"_consumption_calc {value_start=}")
+
+ if value_start is None: # if None (Error) return
+ return
+
+ # ToDo: Prüfen, unter welchen Bedingungen value_start == 0 bzw. wie man den nächsten Eintrag nutzt.
+ if value_start == 0: # wenn der Wert zum Startzeitpunkt 0 ist, gab es dort keinen Eintrag (also keinen Verbrauch), dann frage den nächsten Eintrag in der DB ab.
+ self.logger.info(f"No DB Entry found for requested start date. Looking for next DB entry.")
+ # value_start = self._handle_query_result(self._query_log_next(item=item, timeframe=timeframe, timedelta=start))[0][1]
+ value_start = self._handle_query_result(self._query_item(func='next', item=item, timeframe=timeframe, start=start))[0][1]
+ if self.prepare_debug:
+ self.logger.debug(f"_consumption_calc: next available value is {value_start=}")
+
+ if value_end is not None and value_start is not None:
+ _result = round(value_end - value_start, 1)
+
+ if self.prepare_debug:
+ self.logger.debug(f"_consumption_calc: {_result=} for {item=},{timeframe=},{start=},{end=}")
+
+ return _result
+
+ def _query_item(self, func: str, item, timeframe: str, start: int = None, end: int = 0, group: str = None, group2: str = None, ignore_value=None) -> list:
+ """
+ Do diverse checks of input, and prepare query of log by getting item_id, start / end in timestamp etc.
+
+ :param func: function to be used at query
+ :param item: item object or item_id for which the query should be done
+ :param timeframe: time increment für definition of start, end (day, week, month, year)
+ :param start: start of timeframe (oldest) for query given in x time increments (default = None, meaning complete database)
+ :param end: end of timeframe (newest) for query given in x time increments (default = 0, meaning end of today, end of last week, end of last month, end of last year)
+ :param group: first grouping parameter (default = None, possible values: day, week, month, year)
+ :param group2: second grouping parameter (default = None, possible values: day, week, month, year)
+ :param ignore_value: value of val_num, which will be ignored during query
+
+ :return: query response / list for value pairs [[None, None]] for errors, [[0,0]] for
+ """
+
+ if self.prepare_debug:
+ self.logger.debug(f"_query_item called with {func=}, item={item.id()}, {timeframe=}, {start=}, {end=}, {group=}, {group2=}, {ignore_value=}")
+
+ # SET DEFAULT RESULT
+ result = [[None, None]]
+
+ # CHECK CORRECTNESS OF TIMEFRAME
+ if timeframe not in ["year", "month", "week", "day"]:
+ self.logger.error(f"_query_item: Requested {timeframe=} for item={item.id()} not defined; Need to be year, month, week, day'. Query cancelled.")
+ return result
+
+ # CHECK CORRECTNESS OF START / END
+ if start < end:
+ self.logger.warning(f"_query_item: Requested {start=} for item={item.id()} is not valid since {start=} < {end=}. Query cancelled.")
+ return result
+
+ # DEFINE ITEM_ID
+ item_id = self._get_itemid_for_query(item)
+ if not item_id:
+ self.logger.error(f"_query_item: ItemId for item={item.id()} not found. Query cancelled.")
+ return result
+
+ # DEFINE START AND END OF QUERY AS TIMESTAMP IN MICROSECONDS
+ ts_start, ts_end = get_start_end_as_timestamp(timeframe, start, end)
+ oldest_log = int(self._get_oldest_log(item))
+
+ if start is None:
+ ts_start = oldest_log
+
+ if self.prepare_debug:
+ self.logger.debug(f"_query_item: Requested {timeframe=} with {start=} and {end=} resulted in start being timestamp={ts_start} / {timestamp_to_timestring(ts_start)} and end being timestamp={ts_end} / {timestamp_to_timestring(ts_end)}")
+
+ # CHECK IF VALUES FOR END TIME AND START TIME ARE IN DATABASE
+ if ts_end < oldest_log: # (Abfrage abbrechen, wenn Endzeitpunkt in UNIX-timestamp der Abfrage kleiner (und damit jünger) ist, als der UNIX-timestamp des ältesten Eintrages)
+ self.logger.info(f"_query_item: Requested end time timestamp={ts_end} / {timestamp_to_timestring(ts_end)} of query for Item='{item.id()}' is prior to oldest entry with timestamp={oldest_log} / {timestamp_to_timestring(oldest_log)}. Query cancelled.")
+ return result
+
+ if ts_start < oldest_log:
+ if not self.use_oldest_entry:
+ self.logger.info(f"_query_item: Requested start time timestamp={ts_start} / {timestamp_to_timestring(ts_start)} of query for Item='{item.id()}' is prior to oldest entry with timestamp={oldest_log} / {timestamp_to_timestring(oldest_log)}. Query cancelled.")
+ return result
+ else:
+ self.logger.info(f"_query_item: Requested start time timestamp={ts_start} / {timestamp_to_timestring(ts_start)} of query for Item='{item.id()}' is prior to oldest entry with timestamp={oldest_log} / {timestamp_to_timestring(oldest_log)}. Oldest available entry will be used.")
+ ts_start = oldest_log
+
+ log = self._query_log_timestamp(func=func, item_id=item_id, ts_start=ts_start, ts_end=ts_end, group=group, group2=group2, ignore_value=ignore_value)
+ result = self._handle_query_result(log)
+
+ if self.prepare_debug:
+ self.logger.debug(f"_query_item: value for item={item.id()} with {timeframe=}, {func=}: {result}")
+
+ return result
+
+ def _init_cache_dicts(self) -> None:
+ """
+ init all cache dicts
+ """
+
+ self.logger.info(f"All cache_dicts will be initiated.")
+
+ self.item_cache = {}
+
+ self.current_values = {
+ DAY: {},
+ WEEK: {},
+ MONTH: {},
+ YEAR: {}
+ }
+
+ self.previous_values = {
+ DAY: {},
+ WEEK: {},
+ MONTH: {},
+ YEAR: {}
+ }
+
+ def _clear_queue(self) -> None:
+ """
+ Clear working queue
+ """
+
+ self.logger.info(f"Working queue will be cleared. Calculation run will end.")
+ self.item_queue.queue.clear()
+
+ def _work_item_queue_thread_startup(self):
+ """
+ Start a thread to work item queue
+ """
+
+ try:
+ _name = 'plugins.' + self.get_fullname() + '.work_item_queue'
+ self.work_item_queue_thread = threading.Thread(target=self.work_item_queue, name=_name)
+ self.work_item_queue_thread.daemon = False
+ self.work_item_queue_thread.start()
+ self.logger.debug("Thread for 'work_item_queue_thread' has been started")
+ except threading.ThreadError:
+ self.logger.error("Unable to launch thread for 'work_item_queue_thread'.")
+ self.work_item_queue_thread = None
+
+ def _work_item_queue_thread_shutdown(self):
+ """
+ Shut down the thread to work item queue
+ """
+
+ if self.work_item_queue_thread:
+ self.work_item_queue_thread.join()
+ if self.work_item_queue_thread.is_alive():
+ self.logger.error("Unable to shut down 'work_item_queue_thread' thread")
+ else:
+ self.logger.info("Thread 'work_item_queue_thread' has been terminated.")
+ self.work_item_queue_thread = None
+
+ ##############################
+ # DB Query Preparation
+ ##############################
+
+ def _query_log_timestamp(self, func: str, item_id: int, ts_start: int, ts_end: int, group: str = None, group2: str = None, ignore_value=None) -> Union[list, None]:
+ """
+ Assemble a mysql query str and param dict based on given parameters, get query response and return it
+
+ :param func: function to be used at query
+ :param item_id: database item_id for which the query should be done
+ :param ts_start: start for query given in timestamp in microseconds
+ :param ts_end: end for query given in timestamp in microseconds
+ :param group: first grouping parameter (default = None, possible values: day, week, month, year)
+ :param group2: second grouping parameter (default = None, possible values: day, week, month, year)
+ :param ignore_value: value of val_num, which will be ignored during query
+
+ :return: query response
+
+ """
+
+ # DO DEBUG LOG
+ if self.prepare_debug:
+ self.logger.debug(f"_query_log_timestamp: Called with {func=}, {item_id=}, {ts_start=}, {ts_end=}, {group=}, {group2=}, {ignore_value=}")
+
+ # DEFINE GENERIC QUERY PARTS
+ _select = {
+ 'avg': 'time, ROUND(AVG(val_num * duration) / AVG(duration), 1) as value ',
+ 'avg1': 'time, ROUND(AVG(value), 1) as value FROM (SELECT time, ROUND(AVG(val_num), 1) as value ',
+ 'min': 'time, ROUND(MIN(val_num), 1) as value ',
+ 'max': 'time, ROUND(MAX(val_num), 1) as value ',
+ 'max1': 'time, ROUND(MAX(value), 1) as value FROM (SELECT time, ROUND(MAX(val_num), 1) as value ',
+ 'sum': 'time, ROUND(SUM(val_num), 1) as value ',
+ 'on': 'time, ROUND(SUM(val_bool * duration) / SUM(duration), 1) as value ',
+ 'integrate': 'time, ROUND(SUM(val_num * duration),1) as value ',
+ 'sum_max': 'time, ROUND(SUM(value), 1) as value FROM (SELECT time, ROUND(MAX(val_num), 1) as value ',
+ 'sum_avg': 'time, ROUND(SUM(value), 1) as value FROM (SELECT time, ROUND(AVG(val_num * duration) / AVG(duration), 1) as value ',
+ 'sum_min_neg': 'time, ROUND(SUM(value), 1) as value FROM (SELECT time, IF(min(val_num) < 0, ROUND(MIN(val_num), 1), 0) as value ',
+ 'diff_max': 'time, value1 - LAG(value1) OVER (ORDER BY time) AS value FROM (SELECT time, ROUND(MAX(val_num), 1) as value1 ',
+ 'next': 'time, val_num as value '
+ }
+
+ _table_alias = {
+ 'avg': '',
+ 'avg1': ') AS table1 ',
+ 'min': '',
+ 'max': '',
+ 'max1': ') AS table1 ',
+ 'sum': '',
+ 'on': '',
+ 'integrate': '',
+ 'sum_max': ') AS table1 ',
+ 'sum_avg': ') AS table1 ',
+ 'sum_min_neg': ') AS table1 ',
+ 'diff_max': ') AS table1 ',
+ 'next': '',
+ }
+
+ _order = "time DESC LIMIT 1 " if func == "next" else "time ASC "
+
+ _where = "item_id = :item_id AND time < :ts_start" if func == "next" else "item_id = :item_id AND time BETWEEN :ts_start AND :ts_end "
+
+ _db_table = 'log '
+
+ # DEFINE mySQL QUERY PARTS
+ _group_by_sql = {
+ "year": "GROUP BY YEAR(FROM_UNIXTIME(time/1000)) ",
+ "month": "GROUP BY YEAR(FROM_UNIXTIME(time/1000)), MONTH(FROM_UNIXTIME(time/1000)) ",
+ "week": "GROUP BY YEARWEEK(FROM_UNIXTIME(time/1000), 5) ",
+ "day": "GROUP BY DATE(FROM_UNIXTIME(time/1000)) ",
+ "hour": "GROUP BY DATE(FROM_UNIXTIME(time/1000)), HOUR(FROM_UNIXTIME(time/1000)) ",
+ None: ''
+ }
+
+ # DEFINE SQLITE QUERY PARTS
+ _group_by_sqlite = {
+ "year": "GROUP BY strftime('%Y', date((time/1000),'unixepoch')) ",
+ "month": "GROUP BY strftime('%Y%m', date((time/1000),'unixepoch')) ",
+ "week": "GROUP BY strftime('%Y%W', date((time/1000),'unixepoch')) ",
+ "day": "GROUP BY date((time/1000),'unixepoch') ",
+ "hour": "GROUP BY date((time/1000),'unixepoch'), strftime('%H', date((time/1000),'unixepoch')) ",
+ None: ''
+ }
+
+ ######################################
+
+ # SELECT QUERY PARTS DEPENDING IN DB DRIVER
+ if self.db_driver.lower() == 'pymysql':
+ _group_by = _group_by_sql
+ elif self.db_driver.lower() == 'sqlite3':
+ _group_by = _group_by_sqlite
+ else:
+ self.logger.error('DB Driver unknown')
+ return
+
+ # CHECK CORRECTNESS OF FUNC
+ if func not in _select:
+ self.logger.error(f"_query_log_timestamp: Requested {func=} for {item_id=} not defined. Query cancelled.")
+ return
+
+ # CHECK CORRECTNESS OF GROUP AND GROUP2
+ if group not in _group_by:
+ self.logger.error(f"_query_log_timestamp: Requested {group=} for item={item_id=} not defined. Query cancelled.")
+ return
+ if group2 not in _group_by:
+ self.logger.error(f"_query_log_timestamp: Requested {group=} for item={item_id=} not defined. Query cancelled.")
+ return
+
+ # HANDLE IGNORE VALUES
+ if func in ['min', 'max', 'max1', 'sum_max', 'sum_avg', 'sum_min_neg', 'diff_max']: # extend _where statement for excluding boolean values == 0 for defined functions
+ _where = f'{_where}AND val_bool = 1 '
+ if ignore_value: # if value to be ignored are defined, extend _where statement
+ _where = f'{_where}AND val_num != {ignore_value} '
+
+ # SET PARAMS
+ params = {
+ 'item_id': item_id,
+ 'ts_start': ts_start
+ }
+
+ if func != "next":
+ params['ts_end'] = ts_end
+
+ # ASSEMBLE QUERY
+ query = f"SELECT {_select[func]}FROM {_db_table}WHERE {_where}{_group_by[group]}ORDER BY {_order}{_table_alias[func]}{_group_by[group2]}".strip()
+
+ if self.db_driver.lower() == 'sqlite3':
+ query = query.replace('IF', 'IIF')
+
+ # DO DEBUG LOG
+ if self.prepare_debug:
+ self.logger.debug(f"_query_log_timestamp: {query=}, {params=}")
+
+ # REQUEST DATABASE AND RETURN RESULT
+ return self._fetchall(query, params)
+
+ def _read_log_all(self, item):
+ """
+ Read the oldest log record for given item
+
+ :param item: Item to read the record for
+ :type item: item
+
+ :return: Log record for Item
+ """
+
+ if self.prepare_debug:
+ self.logger.debug(f"_read_log_all: Called for item={item}")
+
+ # DEFINE ITEM_ID - create item_id from item or string input of item_id and break, if not given
+ item_id = self._get_itemid_for_query(item)
+ if not item_id:
+ self.logger.error(f"_read_log_all: ItemId for item={item.id()} not found. Query cancelled.")
+ return
+
+ if item_id:
+ query = "SELECT * FROM log WHERE (item_id = :item_id) AND (time = None OR 1 = 1)"
+ params = {'item_id': item_id}
+ result = self._fetchall(query, params)
+ return result
+
+ def _read_log_oldest(self, item_id: int, cur=None) -> int:
+ """
+ Read the oldest log record for given database ID
+
+ :param item_id: Database ID of item to read the record for
+ :type item_id: int
+ :param cur: A database cursor object if available (optional)
+
+ :return: Log record for the database ID
+ """
+
+ params = {'item_id': item_id}
+ query = "SELECT min(time) FROM log WHERE item_id = :item_id;"
+ return self._fetchall(query, params, cur=cur)[0][0]
+
+ def _read_log_timestamp(self, item_id: int, timestamp: int, cur=None) -> Union[list, None]:
+ """
+ Read database log record for given database ID
+
+ :param item_id: Database ID of item to read the record for
+ :type item_id: int
+ :param timestamp: timestamp for the given value
+ :type timestamp: int
+ :param cur: A database cursor object if available (optional)
+
+ :return: Log record for the database ID at given timestamp
+ """
+
+ params = {'item_id': item_id, 'timestamp': timestamp}
+ query = "SELECT * FROM log WHERE item_id = :item_id AND time = :timestamp;"
+ return self._fetchall(query, params, cur=cur)
+
+ def _read_item_table(self, item):
+ """
+ Read item table
+
+ :param item: name or Item_id of the item within the database
+ :type item: item
+
+ :return: Data for the selected item
+ :rtype: tuple
+ """
+
+ columns_entries = ('id', 'name', 'time', 'val_str', 'val_num', 'val_bool', 'changed')
+ columns = ", ".join(columns_entries)
+
+ if isinstance(item, Item):
+ query = f"SELECT {columns} FROM item WHERE name = '{str(item.id())}'"
+ return self._fetchone(query)
+
+ elif isinstance(item, str) and item.isdigit():
+ item = int(item)
+ query = f"SELECT {columns} FROM item WHERE id = {item}"
+ return self._fetchone(query)
+
+ def _get_db_version(self) -> str:
+ """
+ Query the database version and provide result
+ """
+
+ query = 'SELECT sqlite_version()' if self.db_driver.lower() == 'sqlite3' else 'SELECT VERSION()'
+ return self._fetchone(query)[0]
+
+ def _get_db_connect_timeout(self) -> str:
+ """
+ Query database timeout
+ """
+
+ query = "SHOW GLOBAL VARIABLES LIKE 'connect_timeout'"
+ return self._fetchone(query)
+
+ def _get_db_net_read_timeout(self) -> str:
+ """
+ Query database timeout net_read_timeout
+ """
+
+ query = "SHOW GLOBAL VARIABLES LIKE 'net_read_timeout'"
+ return self._fetchone(query)
+
+ ##############################
+ # Database specific stuff
+ ##############################
+
+ def _execute(self, query: str, params: dict = None, cur=None):
+ if params is None:
+ params = {}
+
+ return self._query(self._db.execute, query, params, cur)
+
+ def _fetchone(self, query: str, params: dict = None, cur=None):
+ if params is None:
+ params = {}
+
+ return self._query(self._db.fetchone, query, params, cur)
+
+ def _fetchall(self, query: str, params: dict = None, cur=None):
+ if params is None:
+ params = {}
+
+ tuples = self._query(self._db.fetchall, query, params, cur)
+ return None if tuples is None else list(tuples)
+
+ def _query(self, fetch, query: str, params: dict = None, cur=None):
+ if params is None:
+ params = {}
+
+ if self.sql_debug:
+ self.logger.debug(f"_query: Called with {query=}, {params=}, {cur=}")
+
+ if not self._initialize_db():
+ return None
+
+ if cur is None:
+ if self._db.verify(5) == 0:
+ self.logger.error("_query: Connection to database not recovered.")
+ return None
+ # if not self._db.lock(300):
+ # self.logger.error("_query: Can't query due to fail to acquire lock.")
+ # return None
+
+ query_readable = re.sub(r':([a-z_]+)', r'{\1}', query).format(**params)
+
+ try:
+ tuples = fetch(query, params, cur=cur)
+ except Exception as e:
+ self.logger.error(f"_query: Error for query '{query_readable}': {e}")
+ else:
+ if self.sql_debug:
+ self.logger.debug(f"_query: Result of '{query_readable}': {tuples}")
+ return tuples
+ # finally:
+ # if cur is None:
+ # self._db.release()
+
+
+##############################
+# Helper functions
+##############################
+
+
+def params_to_dict(string: str) -> Union[dict, None]:
+ """ Parse a string with named arguments and comma separation to dict; (e.g. string = 'year=2022, month=12')
+ """
+
+ try:
+ res_dict = dict((a.strip(), b.strip()) for a, b in (element.split('=') for element in string.split(', ')))
+ except Exception:
+ return None
+ else:
+ # convert to int and remove possible double quotes
+ for key in res_dict:
+ if isinstance(res_dict[key], str):
+ res_dict[key] = res_dict[key].replace('"', '')
+ res_dict[key] = res_dict[key].replace("'", "")
+ if res_dict[key].isdigit():
+ res_dict[key] = int(float(res_dict[key]))
+
+ # check correctness if known key values (func=str, item, timeframe=str, start=int, end=int, count=int, group=str, group2=str, year=int, month=int):
+ for key in res_dict:
+ if key in ('func', 'timeframe', 'group', 'group2') and not isinstance(res_dict[key], str):
+ return None
+ elif key in ('start', 'end', 'count') and not isinstance(res_dict[key], int):
+ return None
+ elif key in 'year':
+ if not valid_year(res_dict[key]):
+ return None
+ elif key in 'month':
+ if not valid_month(res_dict[key]):
+ return None
+ return res_dict
+
+
+def valid_year(year: Union[int, str]) -> bool:
+ """
+ Check if given year is digit and within allowed range
+ """
+
+ if ((isinstance(year, int) or (isinstance(year, str) and year.isdigit())) and (
+ 1980 <= int(year) <= datetime.date.today().year)) or (isinstance(year, str) and year == 'current'):
+ return True
+ else:
+ return False
+
+
+def valid_month(month: Union[int, str]) -> bool:
+ """
+ Check if given month is digit and within allowed range
+ """
+
+ if (isinstance(month, int) or (isinstance(month, str) and month.isdigit())) and (1 <= int(month) <= 12):
+ return True
+ else:
+ return False
+
+
+def timestamp_to_timestring(timestamp: int) -> str:
+ """
+ Parse timestamp from db query to string representing date and time
+ """
+
+ return datetime.datetime.utcfromtimestamp(timestamp / 1000).strftime('%Y-%m-%d %H:%M:%S')
+
+
+def convert_timeframe(timeframe: str) -> str:
+ """
+ Convert timeframe
+
+ """
+
+ convertion = {
+ 'tag': 'day',
+ 'heute': 'day',
+ 'woche': 'week',
+ 'monat': 'month',
+ 'jahr': 'year',
+ 'vorjahreszeitraum': 'day',
+ 'jahreszeitraum': 'day',
+ 'd': 'day',
+ 'w': 'week',
+ 'm': 'month',
+ 'y': 'year'
+ }
+
+ return convertion.get(timeframe, None)
+
+
+def convert_duration(timeframe: str, window_dur: str) -> int:
+ """
+ Convert duration
+
+ """
+
+ _d_in_y = 365
+ _d_in_w = 7
+ _m_in_y = 12
+ _w_in_y = _d_in_y / _d_in_w
+ _w_in_m = _w_in_y / _m_in_y
+ _d_in_m = _d_in_y / _m_in_y
+
+ conversion = {
+ 'day': {'day': 1,
+ 'week': _d_in_w,
+ 'month': _d_in_m,
+ 'year': _d_in_y,
+ },
+ 'week': {'day': 1 / _d_in_w,
+ 'week': 1,
+ 'month': _w_in_m,
+ 'year': _w_in_y
+ },
+ 'month': {'day': 1 / _d_in_m,
+ 'week': 1 / _w_in_m,
+ 'month': 1,
+ 'year': _m_in_y
+ },
+ 'year': {'day': 1 / _d_in_y,
+ 'week': 1 / _w_in_y,
+ 'month': 1 / _m_in_y,
+ 'year': 1
+ }
+ }
+
+ return round(int(conversion[timeframe][window_dur]), 0)
+
+
+def count_to_start(count: int = 0, end: int = 0):
+ """
+ Converts given count and end ot start and end
+ """
+
+ return end + count, end
+
+
+def get_start_end_as_timestamp(timeframe: str, start: int, end: int) -> tuple:
+ """
+ Provides start and end as timestamp in microseconds from timeframe with start and end
+
+ :param timeframe: timeframe as week, month, year
+ :param start: beginning timeframe in x timeframes from now
+ :param end: end of timeframe in x timeframes from now
+
+ :return: start time in timestamp in microseconds, end time in timestamp in microseconds
+
+ """
+
+ return datetime_to_timestamp(get_start(timeframe, start)) * 1000, datetime_to_timestamp(get_end(timeframe, end)) * 1000
+
+
+def get_start(timeframe: str, start: int) -> datetime:
+ """
+ Provides start as datetime
+
+ :param timeframe: timeframe as week, month, year
+ :param start: beginning timeframe in x timeframes from now
+
+ """
+
+ if start is None:
+ start = 0
+
+ if timeframe == 'week':
+ _dt_start = week_beginning(start)
+ elif timeframe == 'month':
+ _dt_start = month_beginning(start)
+ elif timeframe == 'year':
+ _dt_start = year_beginning(start)
+ else:
+ _dt_start = day_beginning(start)
+
+ return _dt_start
+
+
+def get_end(timeframe: str, end: int) -> datetime:
+ """
+ Provides end as datetime
+
+ :param timeframe: timeframe as week, month, year
+ :param end: end of timeframe in x timeframes from now
+
+ """
+
+ if timeframe == 'week':
+ _dt_end = week_end(end)
+ elif timeframe == 'month':
+ _dt_end = month_end(end)
+ elif timeframe == 'year':
+ _dt_end = year_end(end)
+ else:
+ _dt_end = day_end(end)
+
+ return _dt_end
+
+
+def year_beginning(delta: int = 0) -> datetime:
+ """
+ provides datetime of beginning of year of today minus x years
+ """
+
+ _dt = datetime.datetime.combine(datetime.date.today(), datetime.datetime.min.time())
+ return _dt.replace(month=1, day=1) - relativedelta(years=delta)
+
+
+def year_end(delta: int = 0) -> datetime:
+ """
+ provides datetime of end of year of today minus x years
+ """
+
+ return year_beginning(delta) + relativedelta(years=1)
+
+
+def month_beginning(delta: int = 0) -> datetime:
+ """
+ provides datetime of beginning of month minus x month
+ """
+
+ _dt = datetime.datetime.combine(datetime.date.today(), datetime.datetime.min.time())
+ return _dt.replace(day=1) - relativedelta(months=delta)
+
+
+def month_end(delta: int = 0) -> datetime:
+ """
+ provides datetime of end of month minus x month
+ """
+
+ return month_beginning(delta) + relativedelta(months=1)
+
+
+def week_beginning(delta: int = 0) -> datetime:
+ """
+ provides datetime of beginning of week minus x weeks
+ """
+
+ _dt = datetime.datetime.combine(datetime.date.today(), datetime.datetime.min.time())
+ return _dt - relativedelta(days=(datetime.date.today().weekday() + (delta * 7)))
+
+
+def week_end(delta: int = 0) -> datetime:
+ """
+ provides datetime of end of week minus x weeks
+ """
+
+ return week_beginning(delta) + relativedelta(days=6)
+
+
+def day_beginning(delta: int = 0) -> datetime:
+ """
+ provides datetime of beginning of today minus x days
+ """
+
+ return datetime.datetime.combine(datetime.date.today(), datetime.datetime.min.time()) - relativedelta(days=delta)
+
+
+def day_end(delta: int = 0) -> datetime:
+ """
+ provides datetime of end of today minus x days
+ """
+
+ return day_beginning(delta) + relativedelta(days=1)
+
+
+def datetime_to_timestamp(dt: datetime) -> int:
+ """
+ Provides timestamp from given datetime
+ """
+
+ return int(dt.replace(tzinfo=datetime.timezone.utc).timestamp())
+
+
+def check_substring_in_str(lookfor: Union[str, list], target: str) -> bool:
+ for entry in lookfor:
+ if isinstance(entry, str):
+ if entry in target:
+ return True
+ elif isinstance(entry, list):
+ result = True
+ for element in entry:
+ result = result and element in target # einmal False setzt alles auf False
+ if result:
+ return True
+ return False
+
+
+def onchange_attribute(db_addon_fct) -> bool:
+ """
+ Return True if attribute indicates Item to be calculated on-change
+
+ ONCHANGE_ATTRIBUTES = ['verbrauch_heute', 'verbrauch_woche', 'verbrauch_monat', 'verbrauch_jahr',
+ 'minmax_heute_min', 'minmax_heute_max',
+ 'minmax_woche_min', 'minmax_woche_max',
+ 'minmax_monat_min', 'minmax_monat_max',
+ 'minmax_jahr_min', 'minmax_jahr_max']
+
+ """
+ return True if not any(substring in db_addon_fct for substring in ['minus', 'serie', 'last']) else False
+
+
+def daily_attribute(db_addon_fct) -> bool:
+ """
+ Return True if attribute indicates Item to be calculated daily"
+ """
+ return True if check_substring_in_str(['heute_minus', 'last_', 'jahreszeitraum', ['serie', 'tag'], ['serie', 'stunde']], db_addon_fct) else False
+
+
+def weekly_attribute(db_addon_fct) -> bool:
+ """
+ Return True if attribute indicates Item to be calculated weekly"
+ """
+ return True if check_substring_in_str(['woche_minus', ['serie', 'woche']], db_addon_fct) else False
+
+
+def monthly_attribute(db_addon_fct) -> bool:
+ """
+ Return True if attribute indicates Item to be calculated daily"
+ """
+ return True if check_substring_in_str(['monat_minus', ['serie', 'monat']], db_addon_fct) else False
+
+
+def yearly_attribute(db_addon_fct) -> bool:
+ """
+ Return True if attribute indicates Item to be calculated yearly"
+ """
+ return True if check_substring_in_str(['jahr_minus', ['serie', 'jahr']], db_addon_fct) else False
+
+
+STD_REQUEST_DICT = {
+ 'serie_minmax_monat_min_15m': {'func': 'min', 'timeframe': 'month', 'start': 15, 'end': 0, 'group': 'month'},
+ 'serie_minmax_monat_max_15m': {'func': 'max', 'timeframe': 'month', 'start': 15, 'end': 0, 'group': 'month'},
+ 'serie_minmax_monat_avg_15m': {'func': 'avg', 'timeframe': 'month', 'start': 15, 'end': 0, 'group': 'month'},
+ 'serie_minmax_woche_min_30w': {'func': 'min', 'timeframe': 'week', 'start': 30, 'end': 0, 'group': 'week'},
+ 'serie_minmax_woche_max_30w': {'func': 'max', 'timeframe': 'week', 'start': 30, 'end': 0, 'group': 'week'},
+ 'serie_minmax_woche_avg_30w': {'func': 'avg', 'timeframe': 'week', 'start': 30, 'end': 0, 'group': 'week'},
+ 'serie_minmax_tag_min_30d': {'func': 'min', 'timeframe': 'day', 'start': 30, 'end': 0, 'group': 'day'},
+ 'serie_minmax_tag_max_30d': {'func': 'max', 'timeframe': 'day', 'start': 30, 'end': 0, 'group': 'day'},
+ 'serie_minmax_tag_avg_30d': {'func': 'avg', 'timeframe': 'day', 'start': 30, 'end': 0, 'group': 'day'},
+ 'serie_verbrauch_tag_30d': {'func': 'diff_max', 'timeframe': 'day', 'start': 30, 'end': 0, 'group': 'day'},
+ 'serie_verbrauch_woche_30w': {'func': 'diff_max', 'timeframe': 'week', 'start': 30, 'end': 0, 'group': 'week'},
+ 'serie_verbrauch_monat_18m': {'func': 'diff_max', 'timeframe': 'month', 'start': 18, 'end': 0, 'group': 'month'},
+ 'serie_zaehlerstand_tag_30d': {'func': 'max', 'timeframe': 'day', 'start': 30, 'end': 0, 'group': 'day'},
+ 'serie_zaehlerstand_woche_30w': {'func': 'max', 'timeframe': 'week', 'start': 30, 'end': 0, 'group': 'week'},
+ 'serie_zaehlerstand_monat_18m': {'func': 'max', 'timeframe': 'month', 'start': 18, 'end': 0, 'group': 'month'},
+ 'serie_waermesumme_monat_24m': {'func': 'sum_max', 'timeframe': 'month', 'start': 24, 'end': 0, 'group': 'day', 'group2': 'month'},
+ 'serie_kaeltesumme_monat_24m': {'func': 'sum_max', 'timeframe': 'month', 'start': 24, 'end': 0, 'group': 'day', 'group2': 'month'},
+ 'serie_tagesmittelwert': {'func': 'max', 'timeframe': 'year', 'start': 0, 'end': 0, 'group': 'day'},
+ 'serie_tagesmittelwert_stunde_0d': {'func': 'avg1', 'timeframe': 'day', 'start': 0, 'end': 0, 'group': 'hour', 'group2': 'day'},
+ 'serie_tagesmittelwert_tag_stunde_30d': {'func': 'avg1', 'timeframe': 'day', 'start': 30, 'end': 0, 'group': 'hour', 'group2': 'day'},
+ 'waermesumme_year_month': {'func': 'sum_max', 'timeframe': 'day', 'start': None, 'end': None, 'group': 'day', 'group2': None},
+ 'kaltesumme_year_month': {'func': 'sum_min_neg', 'timeframe': 'day', 'start': None, 'end': None, 'group': 'day', 'group2': None},
+ 'gts': {'func': 'max', 'timeframe': 'year', 'start': None, 'end': None, 'group': 'day'},
+ }
+
+##############################
+# Backup
+##############################
+#
+# def _delta_value(self, item, time_str_1, time_str_2):
+# """ Computes a difference of values on 2 points in time for an item
+#
+# :param item: Item, for which query should be done
+# :param time_str_1: time sting as per database-Plugin for newer point in time (e.g.: 200i)
+# :param time_str_2: Zeitstring gemäß database-Plugin for older point in time(e.g.: 400i)
+# """
+#
+# time_since_oldest_log = self._time_since_oldest_log(item)
+# end = int(time_str_1[0:len(time_str_1) - 1])
+#
+# if time_since_oldest_log > end:
+# # self.logger.debug(f'_delta_value: fetch DB with {item.id()}.db(max, {time_str_1}, {time_str_1})')
+# value_1 = self._db_plugin._single('max', time_str_1, time_str_1, item.id())
+#
+# # self.logger.debug(f'_delta_value: fetch DB with {item.id()}.db(max, {time_str_2}, {time_str_2})')
+# value_2 = self._db_plugin._single('max', time_str_2, time_str_2, item.id())
+#
+# if value_1 is not None:
+# if value_2 is None:
+# self.logger.info(f'No entries for Item {item.id()} in DB found for requested enddate {time_str_1}; try to use oldest entry instead')
+# value_2 = self._get_oldest_value(item)
+# if value_2 is not None:
+# value = round(value_1 - value_2, 2)
+# # self.logger.debug(f'_delta_value for item={item.id()} with time_str_1={time_str_1} and time_str_2={time_str_2} is {value}')
+# return value
+# else:
+# self.logger.info(f'_delta_value for item={item.id()} using time_str_1={time_str_1} is older as oldest_entry. Therefore no DB request initiated.')
+#
+# def _single_value(self, item, time_str_1, func='max'):
+# """ Gets value at given point im time from database
+#
+# :param item: item, for which query should be done
+# :param time_str_1: time sting as per database-Plugin for point in time (e.g.: 200i)
+# :param func: function of database plugin
+# """
+#
+# # value = None
+# # value = item.db(func, time_str_1, time_str_1)
+# value = self._db_plugin._single(func, time_str_1, time_str_1, item.id())
+# if value is None:
+# self.logger.info(f'No entries for Item {item.id()} in DB found for requested end {time_str_1}; try to use oldest entry instead')
+# value = int(self._get_oldest_value(item))
+# # self.logger.debug(f'_single_value for item={item.id()} with time_str_1={time_str_1} is {value}')
+# return value
+#
+# def _connect_to_db(self, host=None, user=None, password=None, db=None):
+# """ Connect to DB via pymysql
+# """
+#
+# if not host:
+# host = self.connection_data[0].split(':', 1)[1]
+# if not user:
+# user = self.connection_data[1].split(':', 1)[1]
+# if not password:
+# password = self.connection_data[2].split(':', 1)[1]
+# if not db:
+# db = self.connection_data[3].split(':', 1)[1]
+# port = self.connection_data[4].split(':', 1)[1]
+#
+# try:
+# connection = pymysql.connect(host=host, user=user, password=password, db=db, charset='utf8mb4', cursorclass=pymysql.cursors.DictCursor)
+# except Exception as e:
+# self.logger.error(f"Connection to Database failed with error {e}!.")
+# return
+# else:
+# return connection
+#
+#
+# def _get_itemid_via_db_plugin(self, item):
+# """ Get item_id of item out of dict or request it from db via database plugin and put it into dict
+# """
+#
+# # self.logger.debug(f"_get_itemid called for item={item}")
+#
+# _item_id = self.itemid_dict.get(item, None)
+# if _item_id is None:
+# _item_id = self._db_plugin.id(item)
+# self.itemid_dict[item] = _item_id
+#
+# return _item_id
+#
+# def _get_time_strs(self, key, x):
+# """ Create timestrings for database query depending in key with
+#
+# :param key: key for getting the time strings
+# :param x: time difference as increment
+# :return: tuple of timestrings (timestr closer to now, timestr more in the past)
+#
+# """
+#
+# self.logger.debug(f"_get_time_strs called with key={key}, x={x}")
+#
+# if key == 'heute':
+# _time_str_1 = self._time_str_heute_minus_x(x - 1)
+# _time_str_2 = self._time_str_heute_minus_x(x)
+# elif key == 'woche':
+# _time_str_1 = self._time_str_woche_minus_x(x - 1)
+# _time_str_2 = self._time_str_woche_minus_x(x)
+# elif key == 'monat':
+# _time_str_1 = self._time_str_monat_minus_x(x - 1)
+# _time_str_2 = self._time_str_monat_minus_x(x)
+# elif key == 'jahr':
+# _time_str_1 = self._time_str_jahr_minus_x(x - 1)
+# _time_str_2 = self._time_str_jahr_minus_x(x)
+# elif key == 'vorjahreszeitraum':
+# _time_str_1 = self._time_str_heute_minus_jahre_x(x + 1)
+# _time_str_2 = self._time_str_jahr_minus_x(x+1)
+# else:
+# _time_str_1 = None
+# _time_str_2 = None
+#
+# # self.logger.debug(f"_time_str_1={_time_str_1}, _time_str_2={_time_str_2}")
+# return _time_str_1, _time_str_2
+#
+# def _time_str_heute_minus_x(self, x=0):
+# """ Creates an str for db request in min from time since beginning of today"""
+# return f"{self.shtime.time_since(self.shtime.today(-x), 'im')}i"
+#
+# def _time_str_woche_minus_x(self, x=0):
+# """ Creates an str for db request in min from time since beginning of week"""
+# return f"{self.shtime.time_since(self.shtime.beginning_of_week(self.shtime.calendar_week(), None, -x), 'im')}i"
+#
+# def _time_str_monat_minus_x(self, x=0):
+# """ Creates an str for db request in min for time since beginning of month"""
+# return f"{self.shtime.time_since(self.shtime.beginning_of_month(None, None, -x), 'im')}i"
+#
+# def _time_str_jahr_minus_x(self, x=0):
+# """ Creates an str for db request in min for time since beginning of year"""
+# return f"{self.shtime.time_since(self.shtime.beginning_of_year(None, -x), 'im')}i"
+#
+# def _time_str_heute_minus_jahre_x(self, x=0):
+# """ Creates an str for db request in min for time since now x years ago"""
+# return f"{self.shtime.time_since(self.shtime.now() + relativedelta(years=-x), 'im')}i"
+#
+# def _time_since_oldest_log(self, item):
+# """ Ermittlung der Zeit in ganzen Minuten zwischen "now" und dem ältesten Eintrag eines Items in der DB
+#
+# :param item: Item, for which query should be done
+# :return: time in minutes from oldest entry to now
+# """
+#
+# _timestamp = self._get_oldest_log(item)
+# _oldest_log_dt = datetime.datetime.fromtimestamp(int(_timestamp) / 1000,
+# datetime.timezone.utc).astimezone().strftime(
+# '%Y-%m-%d %H:%M:%S %Z%z')
+# return self.shtime.time_since(_oldest_log_dt, resulttype='im')
+#
+# @staticmethod
+# def _get_dbtimestamp_from_date(date):
+# """ Compute a timestamp for database entry from given date
+#
+# :param date: datetime object / string of format 'yyyy-mm'
+# """
+#
+# d = None
+# if isinstance(date, datetime.date):
+# d = date
+# elif isinstance(date, str):
+# date = date.split('-')
+# if len(date) == 2:
+# year = int(date[0])
+# month = int(date[1])
+# if (1980 <= year <= datetime.date.today().year) and (1 <= month <= 12):
+# d = datetime.date(year, month, 1)
+#
+# if d:
+# return int(time.mktime(d.timetuple()) * 1000)
+#
+# def fetch_min_monthly_count(sh, item, count=None):
+# _logger.warning(f"Die Userfunction 'fetch_min_monthly_count' wurde aufgerufen mit item {item} and count {count}")
+#
+# if type(item) is str:
+# item = get_item_id(item)
+# if count is None:
+# # query = f"SELECT CONCAT(YEAR(FROM_UNIXTIME(time/1000)), '-', LPAD(MONTH(FROM_UNIXTIME(time/1000)), 2, '0')) AS Date, MIN(val_num) FROM log WHERE item_id = {item} GROUP BY Date ORDER BY Date ASC"
+# query = f"SELECT time, MIN(val_num) FROM log WHERE item_id = {item} GROUP BY YEAR(FROM_UNIXTIME(time/1000)), MONTH(FROM_UNIXTIME(time/1000)) ORDER BY time ASC"
+# else:
+# # query = f"SELECT CONCAT(YEAR(FROM_UNIXTIME(time/1000)), '-', LPAD(MONTH(FROM_UNIXTIME(time/1000)), 2, '0')) AS Date, MIN(val_num) FROM log WHERE item_id = {item} AND DATE(FROM_UNIXTIME(time/1000)) > DATE_SUB(now(), INTERVAL {count} MONTH) GROUP BY Date ORDER BY Date ASC"
+# query = f"SELECT time, MIN(val_num) FROM log WHERE item_id = {item} AND DATE(FROM_UNIXTIME(time/1000)) > DATE_SUB(DATE_FORMAT(NOW() ,'%Y-%m-01'), INTERVAL {count} MONTH) GROUP BY YEAR(FROM_UNIXTIME(time/1000)), MONTH(FROM_UNIXTIME(time/1000)) ORDER BY time ASC"
+#
+# result = []
+# try:
+# connection = connect_db(sh)
+# with connection.cursor() as cursor:
+# cursor.execute(query)
+# result = cursor.fetchall()
+# finally:
+# connection.close()
+#
+# value_list = []
+# for element in result:
+# value_list.append([element['time'], element['MIN(val_num)']])
+#
+# _logger.warning(f'mysql.fetch_min_monthly_count value_list: {value_list}')
+# return value_list
+#
+# def fetch_max_monthly_count(sh, item, count=None):
+# _logger.warning(f"Die Userfunction 'fetch_max_monthly_count' wurde aufgerufen mit item {item} and count {count}")
+#
+# if type(item) is str:
+# item = get_item_id(item)
+# if count is None:
+# # query = f"SELECT CONCAT(YEAR(FROM_UNIXTIME(time/1000)), '-', LPAD(MONTH(FROM_UNIXTIME(time/1000)), 2, '0')) AS Date, MAX(val_num) FROM log WHERE item_id = {item} GROUP BY Date ORDER BY Date ASC"
+# query = f"SELECT time, MAX(val_num) FROM log WHERE item_id = {item} GROUP BY YEAR(FROM_UNIXTIME(time/1000)), MONTH(FROM_UNIXTIME(time/1000)) ORDER BY time ASC"
+# else:
+# # query = f"SELECT CONCAT(YEAR(FROM_UNIXTIME(time/1000)), '-', LPAD(MONTH(FROM_UNIXTIME(time/1000)), 2, '0')) AS Date, MAX(val_num) FROM log WHERE item_id = {item} AND DATE(FROM_UNIXTIME(time/1000)) > DATE_SUB(now(), INTERVAL {count} MONTH) GROUP BY Date ORDER BY Date ASC"
+# query = f"SELECT time, MAX(val_num), DATE(FROM_UNIXTIME(time/1000)) as DATE FROM log WHERE item_id = {item} AND DATE(FROM_UNIXTIME(time/1000)) > DATE_SUB(DATE_FORMAT(NOW() ,'%Y-%m-01'), INTERVAL {count} MONTH) GROUP BY YEAR(FROM_UNIXTIME(time/1000)), MONTH(FROM_UNIXTIME(time/1000)) ORDER BY time ASC"
+#
+# result = []
+# try:
+# connection = connect_db(sh)
+# with connection.cursor() as cursor:
+# cursor.execute(query)
+# result = cursor.fetchall()
+# finally:
+# connection.close()
+#
+# _logger.warning(f'mysql.fetch_max_monthly_count result: {result}')
+#
+# value_list = []
+# for element in result:
+# value_list.append([element['time'], element['MAX(val_num)']])
+#
+# _logger.warning(f'mysql.fetch_max_monthly_count value_list: {value_list}')
+# return value_list
+#
+# def fetch_avg_monthly_count(sh, item, count=None):
+# _logger.warning(f"Die Userfunction 'fetch_avg_monthly_count' wurde aufgerufen mit item {item} and count {count}")
+#
+# if type(item) is str:
+# item = get_item_id(item)
+# if count is None:
+# query = f"SELECT time, ROUND(AVG(val_num * duration) / AVG(duration),2) as AVG FROM log WHERE item_id = {item} GROUP BY YEAR(FROM_UNIXTIME(time/1000)), MONTH(FROM_UNIXTIME(time/1000)) ORDER BY time ASC"
+# else:
+# query = f"SELECT time, ROUND(AVG(val_num * duration) / AVG(duration),2) as AVG FROM log WHERE item_id = {item} AND DATE(FROM_UNIXTIME(time/1000)) > DATE_SUB(DATE_FORMAT(NOW() ,'%Y-%m-01'), INTERVAL {count} MONTH) GROUP BY YEAR(FROM_UNIXTIME(time/1000)), MONTH(FROM_UNIXTIME(time/1000)) ORDER BY time ASC"
+#
+# result = []
+# try:
+# connection = connect_db(sh)
+# with connection.cursor() as cursor:
+# cursor.execute(query)
+# result = cursor.fetchall()
+# finally:
+# connection.close()
+#
+# value_list = []
+# for element in result:
+# value_list.append([element['time'], element['AVG']])
+#
+# _logger.warning(f'mysql.fetch_avg_monthly_count value_list: {value_list}')
+# return value_list
+#
+# def fetch_min_max_monthly_count(sh, item, count=None):
+# _logger.warning(f"Die Userfunction 'fetch_min_max_monthly_count' wurde aufgerufen mit item {item} and count {count}")
+#
+# if type(item) is str:
+# item = get_item_id(item)
+# if count is None:
+# query = f"SELECT CONCAT(YEAR(FROM_UNIXTIME(time/1000)), '-', LPAD(MONTH(FROM_UNIXTIME(time/1000)), 2, '0')) AS Date, MAX(val_num), MIN(val_num) FROM log WHERE item_id = {item} GROUP BY Date ORDER BY Date DESC"
+# else:
+# query = f"SELECT CONCAT(YEAR(FROM_UNIXTIME(time/1000)), '-', LPAD(MONTH(FROM_UNIXTIME(time/1000)), 2, '0')) AS Date, MAX(val_num), MIN(val_num) FROM log WHERE item_id = {item} AND DATE(FROM_UNIXTIME(time/1000)) > DATE_SUB(now(), INTERVAL {count} MONTH) GROUP BY Date ORDER BY Date DESC"
+#
+# result = []
+# try:
+# connection = connect_db(sh)
+# with connection.cursor() as cursor:
+# cursor.execute(query)
+# result = cursor.fetchall()
+# finally:
+# connection.close()
+# _logger.warning(f'mysql result: {result}')
+# return result
+#
+# def fetch_min_max_monthly_year(sh, item, year=None):
+# _logger.warning(f"Die Userfunction 'fetch_min_max_monthly_year' wurde aufgerufen mit item {item} and year {year}")
+#
+# if type(item) is str:
+# item = get_item_id(item)
+# if year is None:
+# year = datetime.now().year
+#
+# query = f"SELECT CONCAT(YEAR(FROM_UNIXTIME(time/1000)), '-', LPAD(MONTH(FROM_UNIXTIME(time/1000)), 2, '0')) AS Date, MAX(val_num), MIN(val_num) FROM log WHERE item_id = {item} AND YEAR(FROM_UNIXTIME(time/1000)) = {year} GROUP BY Date ORDER BY Date DESC"
+# result = []
+# try:
+# connection = connect_db(sh)
+# with connection.cursor() as cursor:
+# cursor.execute(query)
+# result = cursor.fetchall()
+# finally:
+# connection.close()
+# _logger.warning(f'mysql result: {result}')
+# return result
+#
+# def fetch_min_weekly_count(sh, item, count=None):
+# _logger.warning(f"Die Userfunction 'fetch_min_weekly_count' wurde aufgerufen mit item {item} and count {count}")
+#
+# if type(item) is str:
+# item = get_item_id(item)
+# if count is None:
+# count = 51
+# query = f"SELECT time, MIN(val_num), DATE(FROM_UNIXTIME(time/1000)) as DATE FROM log WHERE item_id = {item} AND DATE(FROM_UNIXTIME(time/1000)) > DATE_SUB(DATE_ADD(CURDATE(), INTERVAL - WEEKDAY(CURDATE()) DAY), INTERVAL {count} WEEK) GROUP BY YEAR(FROM_UNIXTIME(time/1000)), WEEK(FROM_UNIXTIME(time/1000)) ORDER BY time ASC"
+# result = []
+# try:
+# connection = connect_db(sh)
+# with connection.cursor() as cursor:
+# cursor.execute(query)
+# result = cursor.fetchall()
+# finally:
+# connection.close()
+#
+# value_list = []
+# for element in result:
+# value_list.append([element['time'], element['MIN(val_num)']])
+#
+# _logger.warning(f'mysql.fetch_min_weekly_count value_list: {value_list}')
+# return value_list
+#
+# def fetch_max_weekly_count(sh, item, count=None):
+# _logger.warning(f"Die Userfunction 'fetch_max_weekly_count' wurde aufgerufen mit item {item} and count {count}")
+#
+# if type(item) is str:
+# item = get_item_id(item)
+# if count is None:
+# count = 51
+# query = f"SELECT time, MAX(val_num) FROM log WHERE item_id = {item} AND DATE(FROM_UNIXTIME(time/1000)) > DATE_SUB(DATE_ADD(CURDATE(), INTERVAL - WEEKDAY(CURDATE()) DAY), INTERVAL {count} WEEK) GROUP BY YEAR(FROM_UNIXTIME(time/1000)), WEEK(FROM_UNIXTIME(time/1000)) ORDER BY time ASC"
+# result = []
+# try:
+# connection = connect_db(sh)
+# with connection.cursor() as cursor:
+# cursor.execute(query)
+# result = cursor.fetchall()
+# finally:
+# connection.close()
+#
+# value_list = []
+# for element in result:
+# value_list.append([element['time'], element['MAX(val_num)']])
+#
+# _logger.warning(f'mysql.fetch_max_weekly_count value_list: {value_list}')
+# return value_list
+#
+# def fetch_avg_weekly_count(sh, item, count=None):
+# _logger.warning(f"Die Userfunction 'fetch_avg_weekly_count' wurde aufgerufen mit item {item} and count {count}")
+#
+# if type(item) is str:
+# item = get_item_id(item)
+# if count is None:
+# count = 51
+# query = f"SELECT time, ROUND(AVG(val_num * duration) / AVG(duration),2) as AVG FROM log WHERE item_id = {item} AND DATE(FROM_UNIXTIME(time/1000)) > DATE_SUB(DATE_ADD(CURDATE(), INTERVAL - WEEKDAY(CURDATE()) DAY), INTERVAL {count} WEEK) GROUP BY YEAR(FROM_UNIXTIME(time/1000)), WEEK(FROM_UNIXTIME(time/1000)) ORDER BY time ASC"
+# result = []
+# try:
+# connection = connect_db(sh)
+# with connection.cursor() as cursor:
+# cursor.execute(query)
+# result = cursor.fetchall()
+# finally:
+# connection.close()
+#
+# value_list = []
+# for element in result:
+# value_list.append([element['time'], element['AVG']])
+#
+# _logger.warning(f'mysql.fetch_avg_weekly_count value_list: {value_list}')
+# return value_list
+#
+# def fetch_min_max_weekly_count(sh, item, count=None):
+# _logger.warning(f"Die Userfunction 'fetch_min_max_weekly_count' wurde aufgerufen mit item {item} and count {count}")
+#
+# if type(item) is str:
+# item = get_item_id(item)
+# if count is None:
+# count = 51
+# query = f"SELECT time, MAX(val_num), MIN(val_num), DATE(FROM_UNIXTIME(time/1000)) as DATE FROM log WHERE item_id = {item} AND DATE(FROM_UNIXTIME(time/1000)) > DATE_SUB(DATE_ADD(CURDATE(), INTERVAL - WEEKDAY(CURDATE()) DAY), INTERVAL {count} WEEK) GROUP BY YEAR(FROM_UNIXTIME(time/1000)), WEEK(FROM_UNIXTIME(time/1000)) ORDER BY time ASC"
+# result = []
+# try:
+# connection = connect_db(sh)
+# with connection.cursor() as cursor:
+# cursor.execute(query)
+# result = cursor.fetchall()
+# finally:
+# connection.close()
+# _logger.warning(f'mysql result: {result}')
+# return result
+#
+# def fetch_min_max_weekly_year(sh, item, year=None):
+# _logger.warning(f"Die Userfunction 'fetch_min_max_weekly_year' wurde aufgerufen mit item {item} and year {year}")
+#
+# if type(item) is str:
+# item = get_item_id(item)
+# if year is None:
+# year = datetime.now().year
+#
+# query = f"SELECT CONCAT(YEAR(FROM_UNIXTIME(time/1000)), '/', LPAD(WEEK(FROM_UNIXTIME(time/1000)), 2, '0')) AS Date, MAX(val_num), MIN(val_num) FROM log WHERE item_id = {item} AND YEAR(FROM_UNIXTIME(time/1000)) = {year} GROUP BY Date ORDER BY Date DESC"
+# result = []
+# try:
+# connection = connect_db(sh)
+# with connection.cursor() as cursor:
+# cursor.execute(query)
+# result = cursor.fetchall()
+# finally:
+# connection.close()
+# _logger.warning(f'mysql result: {result}')
+# return result
+#
+# def fetch_min_daily_count(sh, item, count=None):
+# _logger.warning(f"Die Userfunction 'fetch_min_daily_count' wurde aufgerufen mit item {item} as type {type(item)} and count {count}")
+#
+# if type(item) is str:
+# item = get_item_id(item)
+# if count is None:
+# count = 30
+#
+# query = f"SELECT time, MIN(val_num) FROM log WHERE item_id = {item} AND DATE(FROM_UNIXTIME(time/1000)) > DATE_SUB(now(), INTERVAL {count} DAY) GROUP BY DATE(FROM_UNIXTIME(time/1000)) ORDER BY time ASC"
+# result = []
+# try:
+# connection = connect_db(sh)
+# with connection.cursor() as cursor:
+# cursor.execute(query)
+# result = cursor.fetchall()
+# finally:
+# connection.close()
+#
+# value_list = []
+# for element in result:
+# value_list.append([element['time'], element['MIN(val_num)']])
+#
+# _logger.warning(f'mysql.fetch_min_daily_count value_list: {value_list}')
+# return value_list
+#
+# def fetch_max_daily_count(sh, item, count=None):
+# _logger.warning(f"Die Userfunction 'fetch_max_daily_count' wurde aufgerufen mit item {item} as type {type(item)} and count {count}")
+#
+# if type(item) is str:
+# item = get_item_id(item)
+# if count is None:
+# count = 30
+#
+# query = f"SELECT time, MAX(val_num) FROM log WHERE item_id = {item} AND DATE(FROM_UNIXTIME(time/1000)) > DATE_SUB(now(), INTERVAL {count} DAY) GROUP BY DATE(FROM_UNIXTIME(time/1000)) ORDER BY time ASC"
+# result = []
+# try:
+# connection = connect_db(sh)
+# with connection.cursor() as cursor:
+# cursor.execute(query)
+# result = cursor.fetchall()
+# finally:
+# connection.close()
+#
+#
+# value_list = []
+# for element in result:
+# value_list.append([element['time'], element['MAX(val_num)']])
+#
+# _logger.warning(f'mysql.fetch_max_daily_count value_list: {value_list}')
+# return value_list
+#
+# def fetch_min_max_daily_count(sh, item, count=None):
+# _logger.warning(f"Die Userfunction 'fetch_min_max_daily_count' wurde aufgerufen mit item {item} as type {type(item)} and count {count}")
+#
+# if type(item) is str:
+# item = get_item_id(item)
+# if count is None:
+# count = 30
+#
+# query = f"SELECT DATE(FROM_UNIXTIME(time/1000)) AS Date, MAX(val_num), MIN(val_num) FROM log WHERE item_id = {item} AND DATE(FROM_UNIXTIME(time/1000)) > DATE_SUB(now(), INTERVAL {count} DAY) GROUP BY Date ORDER BY Date DESC"
+# result = []
+# try:
+# connection = connect_db(sh)
+# with connection.cursor() as cursor:
+# cursor.execute(query)
+# result = cursor.fetchall()
+# finally:
+# connection.close()
+# _logger.warning(f'mysql result: {result}')
+# return result
+#
+# def fetch_min_max_daily_year(sh, item, year=None):
+# _logger.warning(f"Die Userfunction 'fetch_min_max_daily_year' wurde aufgerufen mit item {item} and year {year}")
+#
+# if type(item) is str:
+# item = get_item_id(item)
+# if year is None:
+# year = datetime.now().year
+#
+# query = f"SELECT DATE(FROM_UNIXTIME(time/1000)) AS Date, MAX(val_num), MIN(val_num) FROM log WHERE item_id = {item} AND YEAR(FROM_UNIXTIME(time/1000)) = {year} GROUP BY Date ORDER BY Date DESC"
+# result = []
+# try:
+# connection = connect_db(sh)
+# with connection.cursor() as cursor:
+# cursor.execute(query)
+# result = cursor.fetchall()
+# finally:
+# connection.close()
+# _logger.warning(f'mysql result: {result}')
+# return result
+#
+# def _fetch_query(self, query):
+#
+# self.logger.debug(f"'_fetch_query' has been called with query={query}")
+# connection = self._connect_to_db()
+# if connection:
+# try:
+# connection = connect_db(sh)
+# with connection.cursor() as cursor:
+# cursor.execute(query)
+# result = cursor.fetchall()
+# except Exception as e:
+# self.logger.error(f"_fetch_query failed with error={e}")
+# else:
+# self.logger.debug(f'_fetch_query result={result}')
+# return result
+# finally:
+# connection.close()
diff --git a/db_addon/locale.yaml b/db_addon/locale.yaml
new file mode 100644
index 000000000..2c14a15da
--- /dev/null
+++ b/db_addon/locale.yaml
@@ -0,0 +1,12 @@
+# translations for the web interface
+plugin_translations:
+ # Translations for the plugin specially for the web interface
+ 'daily': {'de': 'täglich', 'en': 'daily'}
+ 'weekly': {'de': 'wöchentlich', 'en': '='}
+ 'monthly': {'de': 'monatlich', 'en': '='}
+ 'yearly': {'de': 'jährlich', 'en': '='}
+
+ # Alternative format for translations of longer texts:
+ 'Hier kommt der Inhalt des Webinterfaces hin.':
+ de: '='
+ en: 'Here goes the content of the web interface.'
diff --git a/db_addon/plugin.yaml b/db_addon/plugin.yaml
new file mode 100644
index 000000000..7aeb65439
--- /dev/null
+++ b/db_addon/plugin.yaml
@@ -0,0 +1,1073 @@
+# Metadata for the plugin
+plugin:
+ # Global plugin attributes
+ type: system # plugin type (gateway, interface, protocol, system, web)
+ description:
+ de: 'Add-On für das database Plugin zur Datenauswertung'
+ en: 'Add-On for the database plugin for data evaluation'
+ maintainer: sisamiwe
+ tester: bmx, onkelandy # Who tests this plugin?
+ state: ready # change to ready when done with development
+# keywords: iot xyz
+# documentation: https://github.com/smarthomeNG/smarthome/wiki/CLI-Plugin # url of documentation (wiki) page
+ support: https://knx-user-forum.de/forum/supportforen/smarthome-py/1848494-support-thread-databaseaddon-plugin
+ version: 1.0.0 # Plugin version (must match the version specified in __init__.py)
+ sh_minversion: 1.9.3.5 # minimum shNG version to use this plugin
+# sh_maxversion: # maximum shNG version to use this plugin (leave empty if latest)
+ py_minversion: 3.8 # minimum Python version to use for this plugin
+# py_maxversion: # maximum Python version to use for this plugin (leave empty if latest)
+ multi_instance: false # plugin supports multi instance
+ restartable: unknown
+ classname: DatabaseAddOn # class containing the plugin
+
+parameters:
+ database_plugin_config:
+ type: str
+ default: 'database'
+ description:
+ de: "Konfiguration des Plugin 'Database', für die das Plugin 'DatabaseAddOn' verwendet wird"
+ en: "Config of Plugin 'Database, for which the Plugin 'DatabaseAddOn' should be active"
+
+ startup_run_delay:
+ type: int
+ default: 60
+ description:
+ de: 'Zeitlicher Abstand in Sekunden, mit der die Berechnungen bei Startup ausgeführt werden sollen'
+ en: 'Delay in seconds, after which the startup calculations will be run'
+
+ ignore_0:
+ type: list
+ default: []
+ description:
+ de: "Bei Items, bei denen ein String aus der Liste im Pfadnamen vorkommt, werden 0-Werte (val_num = 0) bei Datenbankauswertungen ignoriert.
+ Beispieleintrag: temp | hum"
+ en: "At items having a entry of that list in path, val_num=0 will be ignored for database queries.
+ Example: temp | hum"
+
+ use_oldest_entry:
+ type: bool
+ default: False
+ description:
+ de: "True: Verwendung des ältesten Eintrags des Items in der Datenbank, falls der Start des Abfragezeitraums zeitlich vor diesem Eintrag liegt
+ False: Abbruch der Datenbankabfrage"
+ en: "True: Use of oldest entry of item in database, if start of query is prior to oldest entry
+ False: Cancel query"
+
+item_attributes:
+ db_addon_fct:
+ type: str
+ description:
+ de: 'Auswertefunktion des DB-Addon Plugins'
+ en: 'Evaluation Function of DB-Addon Plugins'
+ valid_list:
+ # Verbrauch
+ - 'verbrauch_heute' #num onchange Verbrauch am heutigen Tag (Differenz zwischen aktuellem Wert und den Wert am Ende des vorherigen Tages)
+ - 'verbrauch_woche' #num onchange Verbrauch in der aktuellen Woche
+ - 'verbrauch_monat' #num onchange Verbrauch im aktuellen Monat
+ - 'verbrauch_jahr' #num onchange Verbrauch im aktuellen Jahr
+ - 'verbrauch_heute_minus1' #num daily Verbrauch gestern (heute -1 Tag) (Differenz zwischen Wert am Ende des gestrigen Tages und dem Wert am Ende des Tages danach)
+ - 'verbrauch_heute_minus2' #num daily Verbrauch vorgestern (heute -2 Tage)
+ - 'verbrauch_heute_minus3' #num daily Verbrauch heute -3 Tage
+ - 'verbrauch_heute_minus4' #num daily Verbrauch heute -4 Tage
+ - 'verbrauch_heute_minus5' #num daily Verbrauch heute -5 Tage
+ - 'verbrauch_heute_minus6' #num daily Verbrauch heute -6 Tage
+ - 'verbrauch_heute_minus7' #num daily Verbrauch heute -7 Tage
+ - 'verbrauch_woche_minus1' #num weekly Verbrauch Vorwoche (aktuelle Woche -1)
+ - 'verbrauch_woche_minus2' #num weekly Verbrauch aktuelle Woche -2 Wochen
+ - 'verbrauch_woche_minus3' #num weekly Verbrauch aktuelle Woche -3 Wochen
+ - 'verbrauch_woche_minus4' #num weekly Verbrauch aktuelle Woche -4 Wochen
+ - 'verbrauch_monat_minus1' #num monthly Verbrauch Vormonat (aktueller Monat -1)
+ - 'verbrauch_monat_minus2' #num monthly Verbrauch aktueller Monat -2 Monate
+ - 'verbrauch_monat_minus3' #num monthly Verbrauch aktueller Monat -3 Monate
+ - 'verbrauch_monat_minus4' #num monthly Verbrauch aktueller Monat -4 Monate
+ - 'verbrauch_monat_minus12' #num monthly Verbrauch aktueller Monat -12 Monate
+ - 'verbrauch_jahr_minus1' #num yearly Verbrauch Vorjahr (aktuelles Jahr -1 Jahr)
+ - 'verbrauch_jahr_minus2' #num yearly Verbrauch aktuelles Jahr -2 Jahre
+ - 'verbrauch_rolling_12m_heute_minus1' #num daily Verbrauch der letzten 12 Monate ausgehend im Ende des letzten Tages
+ - 'verbrauch_rolling_12m_woche_minus1' #num weekly Verbrauch der letzten 12 Monate ausgehend im Ende der letzten Woche
+ - 'verbrauch_rolling_12m_monat_minus1' #num monthly Verbrauch der letzten 12 Monate ausgehend im Ende des letzten Monats
+ - 'verbrauch_rolling_12m_jahr_minus1' #num yearly Verbrauch der letzten 12 Monate ausgehend im Ende des letzten Jahres
+ - 'verbrauch_jahreszeitraum_minus1' #num daily Verbrauch seit dem 1.1. bis zum heutigen Tag des Vorjahres
+ - 'verbrauch_jahreszeitraum_minus2' #num daily Verbrauch seit dem 1.1. bis zum heutigen Tag vor 2 Jahren
+ - 'verbrauch_jahreszeitraum_minus3' #num daily Verbrauch seit dem 1.1. bis zum heutigen Tag vor 3 Jahren
+ # Zaehlerstand
+ - 'zaehlerstand_heute_minus1' #num daily Zählerstand / Wert am Ende des letzten Tages (heute -1 Tag)
+ - 'zaehlerstand_woche_minus1' #num weekly Zählerstand / Wert am Ende der letzten Woche (aktuelle Woche -1 Woche)
+ - 'zaehlerstand_woche_minus2' #num weekly Zählerstand / Wert am Ende der vorletzten Woche (aktuelle Woche -2 Woche)
+ - 'zaehlerstand_woche_minus3' #num weekly Zählerstand / Wert am Ende der aktuellen Woche -3 Woche
+ - 'zaehlerstand_monat_minus1' #num monthly Zählerstand / Wert am Ende des letzten Monates (aktueller Monat -1 Monat)
+ - 'zaehlerstand_monat_minus2' #num monthly Zählerstand / Wert am Ende des vorletzten Monates (aktueller Monat -2 Monate)
+ - 'zaehlerstand_monat_minus3' #num monthly Zählerstand / Wert am Ende des aktuellen Monats -3 Monate
+ - 'zaehlerstand_jahr_minus1' #num yearly Zählerstand / Wert am Ende des letzten Jahres (aktuelles Jahr -1 Jahr)
+ - 'zaehlerstand_jahr_minus2' #num yearly Zählerstand / Wert am Ende des vorletzten Jahres (aktuelles Jahr -2 Jahre)
+ - 'zaehlerstand_jahr_minus3' #num yearly Zählerstand / Wert am Ende des aktuellen Jahres -3 Jahre
+ # Wertehistorie min/max
+ - 'minmax_last_24h_min' #num daily minimaler Wert der letzten 24h
+ - 'minmax_last_24h_max' #num daily maximaler Wert der letzten 24h
+ - 'minmax_last_24h_avg' #num daily durchschnittlicher Wert der letzten 24h
+ - 'minmax_last_7d_min' #num daily minimaler Wert der letzten 7 Tage
+ - 'minmax_last_7d_max' #num daily maximaler Wert der letzten 7 Tage
+ - 'minmax_last_7d_avg' #num daily durchschnittlicher Wert der letzten 7 Tage
+ - 'minmax_heute_min' #num onchange Minimalwert seit Tagesbeginn
+ - 'minmax_heute_max' #num onchange Maximalwert seit Tagesbeginn
+ - 'minmax_heute_minus1_min' #num daily Minimalwert gestern (heute -1 Tag)
+ - 'minmax_heute_minus1_max' #num daily Maximalwert gestern (heute -1 Tag)
+ - 'minmax_heute_minus1_avg' #num daily Durchschnittswert gestern (heute -1 Tag)
+ - 'minmax_heute_minus2_min' #num daily Minimalwert vorgestern (heute -2 Tage)
+ - 'minmax_heute_minus2_max' #num daily Maximalwert vorgestern (heute -2 Tage)
+ - 'minmax_heute_minus2_avg' #num daily Durchschnittswert vorgestern (heute -2 Tage)
+ - 'minmax_heute_minus3_min' #num daily Minimalwert heute vor 3 Tagen
+ - 'minmax_heute_minus3_max' #num daily Maximalwert heute vor 3 Tagen
+ - 'minmax_heute_minus3_avg' #num daily Durchschnittswert heute vor 3 Tagen
+ - 'minmax_woche_min' #num onchange Minimalwert seit Wochenbeginn
+ - 'minmax_woche_max' #num onchange Maximalwert seit Wochenbeginn
+ - 'minmax_woche_minus1_min' #num weekly Minimalwert Vorwoche (aktuelle Woche -1)
+ - 'minmax_woche_minus1_max' #num weekly Maximalwert Vorwoche (aktuelle Woche -1)
+ - 'minmax_woche_minus1_avg' #num weekly Durchschnittswert Vorwoche (aktuelle Woche -1)
+ - 'minmax_woche_minus2_min' #num weekly Minimalwert aktuelle Woche -2 Wochen
+ - 'minmax_woche_minus2_max' #num weekly Maximalwert aktuelle Woche -2 Wochen
+ - 'minmax_woche_minus2_avg' #num weekly Durchschnittswert aktuelle Woche -2 Wochen
+ - 'minmax_monat_min' #num onchange Minimalwert seit Monatsbeginn
+ - 'minmax_monat_max' #num onchange Maximalwert seit Monatsbeginn
+ - 'minmax_monat_minus1_min' #num monthly Minimalwert Vormonat (aktueller Monat -1)
+ - 'minmax_monat_minus1_max' #num monthly Maximalwert Vormonat (aktueller Monat -1)
+ - 'minmax_monat_minus1_avg' #num monthly Durchschnittswert Vormonat (aktueller Monat -1)
+ - 'minmax_monat_minus2_min' #num monthly Minimalwert aktueller Monat -2 Monate
+ - 'minmax_monat_minus2_max' #num monthly Maximalwert aktueller Monat -2 Monate
+ - 'minmax_monat_minus2_avg' #num monthly Durchschnittswert aktueller Monat -2 Monate
+ - 'minmax_jahr_min' #num onchange Minimalwert seit Jahresbeginn
+ - 'minmax_jahr_max' #num onchange Maximalwert seit Jahresbeginn
+ - 'minmax_jahr_minus1_min' #num yearly Minimalwert Vorjahr (aktuelles Jahr -1 Jahr)
+ - 'minmax_jahr_minus1_max' #num yearly Maximalwert Vorjahr (aktuelles Jahr -1 Jahr)
+ - 'minmax_jahr_minus1_avg' #num yearly Durchschnittswert Vorjahr (aktuelles Jahr -1 Jahr)
+ # Serie
+ - 'serie_minmax_monat_min_15m' #list monthly monatlicher Minimalwert der letzten 15 Monate (gleitend)
+ - 'serie_minmax_monat_max_15m' #list monthly monatlicher Maximalwert der letzten 15 Monate (gleitend)
+ - 'serie_minmax_monat_avg_15m' #list monthly monatlicher Mittelwert der letzten 15 Monate (gleitend)
+ - 'serie_minmax_woche_min_30w' #list weekly wöchentlicher Minimalwert der letzten 30 Wochen (gleitend)
+ - 'serie_minmax_woche_max_30w' #list weekly wöchentlicher Maximalwert der letzten 30 Wochen (gleitend)
+ - 'serie_minmax_woche_avg_30w' #list weekly wöchentlicher Mittelwert der letzten 30 Wochen (gleitend)
+ - 'serie_minmax_tag_min_30d' #list daily täglicher Minimalwert der letzten 30 Tage (gleitend)
+ - 'serie_minmax_tag_max_30d' #list daily täglicher Maximalwert der letzten 30 Tage (gleitend)
+ - 'serie_minmax_tag_avg_30d' #list daily täglicher Mittelwert der letzten 30 Tage (gleitend)
+ - 'serie_verbrauch_tag_30d' #list daily Verbrauch pro Tag der letzten 30 Tage
+ - 'serie_verbrauch_woche_30w' #list weekly Verbrauch pro Woche der letzten 30 Wochen
+ - 'serie_verbrauch_monat_18m' #list monthly Verbrauch pro Monat der letzten 18 Monate
+ - 'serie_zaehlerstand_tag_30d' #list daily Zählerstand am Tagesende der letzten 30 Tage
+ - 'serie_zaehlerstand_woche_30w' #list weekly Zählerstand am Wochenende der letzten 30 Wochen
+ - 'serie_zaehlerstand_monat_18m' #list monthly Zählerstand am Monatsende der letzten 18 Monate
+ - 'serie_waermesumme_monat_24m' #list monthly monatliche Wärmesumme der letzten 24 Monate
+ - 'serie_kaeltesumme_monat_24m' #list monthly monatliche Kältesumme der letzten 24 Monate
+ - 'serie_tagesmittelwert_stunde_0d' #list daily Stundenmittelwert für den aktuellen Tag
+ - 'serie_tagesmittelwert_tag_stunde_30d' #list daily Stundenmittelwert pro Tag der letzten 30 Tage (bspw. zur Berechnung der Tagesmitteltemperatur basierend auf den Mittelwert der Temperatur pro Stunde
+ # Allgemein
+ - 'general_oldest_value' #num ------ Ausgabe des ältesten Wertes des entsprechenden "Parent-Items" mit database Attribut
+ - 'general_oldest_log' #list ------ Ausgabe des Timestamp des ältesten Eintrages des entsprechenden "Parent-Items" mit database Attribut
+ # Komplex Hinweis: db_addon_params needed
+ - 'kaeltesumme' #num daily Berechnet die Kältesumme für einen Zeitraum, db_addon_params: (year=mandatory, month=optional)
+ - 'waermesumme' #num daily Berechnet die Wärmesumme für einen Zeitraum, db_addon_params: (year=mandatory, month=optional)
+ - 'gruenlandtempsumme' #num daily Berechnet die Grünlandtemperatursumme für einen Zeitraum, db_addon_params: (year=mandatory)
+ - 'tagesmitteltemperatur' #list daily Berechnet die Tagesmitteltemperatur auf basis der stündlichen Durchschnittswerte eines Tages für die angegebene Anzahl von Tagen (days=optional)
+ - 'db_request' #list 'group' Abfrage der DB: db_addon_params: (func=mandatory, item=mandatory, timespan=mandatory, start=optional, end=optional, count=optional, group=optional, group2=optional):
+ valid_list_description: # Beschreibung -> notwendiger Item-Type
+ # Verbrauch
+ - 'Verbrauch am heutigen Tag (Differenz zwischen aktuellem Wert und den Wert am Ende des vorherigen Tages) -> num \n
+ Berechnungszyklus = onchange'
+ - 'Verbrauch in der aktuellen Woche -> num \n
+ Berechnungszyklus = onchange'
+ - 'Verbrauch im aktuellen Monat -> num \n
+ Berechnungszyklus = onchange'
+ - 'Verbrauch im aktuellen Jahr -> num \n
+ Berechnungszyklus = onchange'
+ - 'Verbrauch gestern (heute -1 Tag) (Differenz zwischen Wert am Ende des gestrigen Tages und dem Wert am Ende des Tages danach) -> num \n
+ Berechnungszyklus = täglich'
+ - 'Verbrauch vorgestern (heute -2 Tage) -> num \n
+ Berechnungszyklus = täglich'
+ - 'Verbrauch heute -3 Tage -> num \n
+ Berechnungszyklus = täglich'
+ - 'Verbrauch heute -4 Tage -> num \n
+ Berechnungszyklus = täglich'
+ - 'Verbrauch heute -5 Tage -> num \n
+ Berechnungszyklus = täglich'
+ - 'Verbrauch heute -6 Tage -> num \n
+ Berechnungszyklus = täglich'
+ - 'Verbrauch heute -7 Tage -> num \n
+ Berechnungszyklus = täglich'
+ - 'Verbrauch Vorwoche (aktuelle Woche -1) -> num \n
+ Berechnungszyklus = wöchentlich'
+ - 'Verbrauch aktuelle Woche -2 Wochen) -> num \n
+ Berechnungszyklus = wöchentlich'
+ - 'Verbrauch aktuelle Woche -3 Wochen) -> num \n
+ Berechnungszyklus = wöchentlich'
+ - 'Verbrauch aktuelle Woche -4 Wochen) -> num \n
+ Berechnungszyklus = wöchentlich'
+ - 'Verbrauch Vormonat (aktueller Monat -1) -> num \n
+ Berechnungszyklus = monatlich'
+ - 'Verbrauch aktueller Monat -2 Monate -> num \n
+ Berechnungszyklus = monatlich'
+ - 'Verbrauch aktueller Monat -3 Monate -> num \n
+ Berechnungszyklus = monatlich'
+ - 'Verbrauch aktueller Monat -4 Monate -> num \n
+ Berechnungszyklus = monatlich'
+ - 'Verbrauch aktueller Monat -12 Monate -> num \n
+ Berechnungszyklus = monatlich'
+ - 'Verbrauch Vorjahr (aktuelles Jahr -1 Jahr) -> num \n
+ Berechnungszyklus = jährlich'
+ - 'Verbrauch aktuelles Jahr -2 Jahre) -> num \n
+ Berechnungszyklus = jährlich'
+ - 'Verbrauch der letzten 12 Monate ausgehend im Ende des letzten Tages -> num \n
+ Berechnungszyklus = täglich'
+ - 'Verbrauch der letzten 12 Monate ausgehend im Ende der letzten Woche -> num \n
+ Berechnungszyklus = wöchentlich'
+ - 'Verbrauch der letzten 12 Monate ausgehend im Ende des letzten Monats -> num \n
+ Berechnungszyklus = monatlich'
+ - 'Verbrauch der letzten 12 Monate ausgehend im Ende des letzten Jahres -> num \n
+ Berechnungszyklus = jährlich'
+ - 'Verbrauch seit dem 1.1. bis zum heutigen Tag des Vorjahres -> num \n
+ Berechnungszyklus = täglich'
+ - 'Verbrauch seit dem 1.1. bis zum heutigen Tag vor 2 Jahren -> num \n
+ Berechnungszyklus = täglich'
+ - 'Verbrauch seit dem 1.1. bis zum heutigen Tag vor 3 Jahren -> num \n
+ Berechnungszyklus = täglich'
+ # Zaehlerstand
+ - 'Zählerstand / Wert am Ende des letzten Tages (heute -1 Tag) -> num \n
+ Berechnungszyklus = täglich'
+ - 'Zählerstand / Wert am Ende der letzten Woche (aktuelle Woche -1 Woche) -> num \n
+ Berechnungszyklus = wöchentlich'
+ - 'Zählerstand / Wert am Ende der vorletzten Woche (aktuelle Woche -2 Woche) -> num \n
+ Berechnungszyklus = wöchentlich'
+ - 'Zählerstand / Wert am Ende der aktuellen Woche -3 Woche -> num \n
+ Berechnungszyklus = wöchentlich'
+ - 'Zählerstand / Wert am Ende des letzten Monates (aktueller Monat -1 Monat)) -> num \n
+ Berechnungszyklus = monatlich'
+ - 'Zählerstand / Wert am Ende des vorletzten Monates (aktueller Monat -2 Monate)) -> num \n
+ Berechnungszyklus = monatlich'
+ - 'Zählerstand / Wert am Ende des aktuellen Monats -3 Monate) -> num \n
+ Berechnungszyklus = monatlich'
+ - 'Zählerstand / Wert am Ende des letzten Jahres (aktuelles Jahr -1 Jahr) -> num \n
+ Berechnungszyklus = jährlich'
+ - 'Zählerstand / Wert am Ende des vorletzten Jahres (aktuelles Jahr -2 Jahre) -> num \n
+ Berechnungszyklus = jährlich'
+ - 'Zählerstand / Wert am Ende des aktuellen Jahres -3 Jahre -> num \n
+ Berechnungszyklus = jährlich'
+ # Wertehistorie min/max
+ - 'minimaler Wert der letzten 24h -> num \n
+ Berechnungszyklus = täglich'
+ - 'maximaler Wert der letzten 24h -> num \n
+ Berechnungszyklus = täglich'
+ - 'durchschnittlicher Wert der letzten 24h -> num \n
+ Berechnungszyklus = täglich'
+ - 'minimaler Wert der letzten 7 Tage -> num \n
+ Berechnungszyklus = täglich'
+ - 'maximaler Wert der letzten 7 Tage -> num \n
+ Berechnungszyklus = täglich'
+ - 'durchschnittlicher Wert der letzten 7 Tage -> num \n
+ Berechnungszyklus = täglich'
+ - 'Minimalwert seit Tagesbeginn'
+ - 'Maximalwert seit Tagesbeginn'
+ - 'Minimalwert gestern (heute -1 Tag) -> num \n
+ Berechnungszyklus = täglich'
+ - 'Maximalwert gestern (heute -1 Tag) -> num \n
+ Berechnungszyklus = täglich'
+ - 'Durchschnittswert gestern (heute -1 Tag) -> num \n
+ Berechnungszyklus = täglich'
+ - 'Minimalwert vorgestern (heute -2 Tage) -> num \n
+ Berechnungszyklus = täglich'
+ - 'Maximalwert vorgestern (heute -2 Tage) -> num \n
+ Berechnungszyklus = täglich'
+ - 'Durchschnittswert vorgestern (heute -2 Tage) -> num \n
+ Berechnungszyklus = täglich'
+ - 'Minimalwert heute vor 3 Tagen -> num \n
+ Berechnungszyklus = täglich'
+ - 'Maximalwert heute vor 3 Tagen -> num \n
+ Berechnungszyklus = täglich'
+ - 'Durchschnittswert heute vor 3 Tagen -> num \n
+ Berechnungszyklus = täglich'
+ - 'Minimalwert seit Wochenbeginn -> num \n
+ Berechnungszyklus = onchange'
+ - 'Maximalwert seit Wochenbeginn -> num \n
+ Berechnungszyklus = onchange'
+ - 'Minimalwert Vorwoche (aktuelle Woche -1) -> num \n
+ Berechnungszyklus = wöchentlich'
+ - 'Maximalwert Vorwoche (aktuelle Woche -1) -> num \n
+ Berechnungszyklus = wöchentlich'
+ - 'Durchschnittswert Vorwoche (aktuelle Woche -1) -> num \n
+ Berechnungszyklus = wöchentlich'
+ - 'Minimalwert aktuelle Woche -2 Wochen -> num \n
+ Berechnungszyklus = wöchentlich'
+ - 'Maximalwert aktuelle Woche -2 Wochen -> num \n
+ Berechnungszyklus = wöchentlich'
+ - 'Durchschnittswert aktuelle Woche -2 Wochen -> num \n
+ Berechnungszyklus = wöchentlich'
+ - 'Minimalwert seit Monatsbeginn -> num \n
+ Berechnungszyklus = onchange'
+ - 'Maximalwert seit Monatsbeginn -> num \n
+ Berechnungszyklus = onchange'
+ - 'Minimalwert Vormonat (aktueller Monat -1) -> num \n
+ Berechnungszyklus = monatlich'
+ - 'Maximalwert Vormonat (aktueller Monat -1) -> num \n
+ Berechnungszyklus = monatlich'
+ - 'Durchschnittswert Vormonat (aktueller Monat -1) -> num \n
+ Berechnungszyklus = monatlich'
+ - 'Minimalwert aktueller Monat -2 Monate -> num \n
+ Berechnungszyklus = monatlich'
+ - 'Maximalwert aktueller Monat -2 Monate -> num \n
+ Berechnungszyklus = monatlich'
+ - 'Durchschnittswert aktueller Monat -2 Monate -> num \n
+ Berechnungszyklus = monatlich'
+ - 'Minimalwert seit Jahresbeginn -> num \n
+ Berechnungszyklus = onchange'
+ - 'Maximalwert seit Jahresbeginn -> num \n
+ Berechnungszyklus = onchange'
+ - 'Minimalwert Vorjahr (aktuelles Jahr -1 Jahr) -> num \n
+ Berechnungszyklus = jährlich'
+ - 'Maximalwert Vorjahr (aktuelles Jahr -1 Jahr) -> num \n
+ Berechnungszyklus = jährlich'
+ - 'Durchschnittswert Vorjahr (aktuelles Jahr -1 Jahr) -> num \n
+ Berechnungszyklus = jährlich'
+ # Serie
+ - 'monatlicher Minimalwert der letzten 15 Monate (gleitend) -> list \n
+ Berechnungszyklus = monatlich'
+ - 'monatlicher Maximalwert der letzten 15 Monate (gleitend) -> list \n
+ Berechnungszyklus = monatlich'
+ - 'monatlicher Mittelwert der letzten 15 Monate (gleitend) -> list \n
+ Berechnungszyklus = monatlich'
+ - 'wöchentlicher Minimalwert der letzten 30 Wochen (gleitend) -> list \n
+ Berechnungszyklus = wöchentlich'
+ - 'wöchentlicher Maximalwert der letzten 30 Wochen (gleitend) -> list \n
+ Berechnungszyklus = wöchentlich'
+ - 'wöchentlicher Mittelwert der letzten 30 Wochen (gleitend) -> list \n
+ Berechnungszyklus = wöchentlich'
+ - 'täglicher Minimalwert der letzten 30 Tage (gleitend) -> list \n
+ Berechnungszyklus = täglich'
+ - 'täglicher Maximalwert der letzten 30 Tage (gleitend)) -> list \n
+ Berechnungszyklus = täglich'
+ - 'täglicher Mittelwert der letzten 30 Tage (gleitend)) -> list \n
+ Berechnungszyklus = täglich'
+ - 'Verbrauch pro Tag der letzten 30 Tage) -> list \n
+ Berechnungszyklus = täglich'
+ - 'Verbrauch pro Woche der letzten 30 Wochen) -> list \n
+ Berechnungszyklus = wöchentlich'
+ - 'Verbrauch pro Monat der letzten 18 Monate) -> list \n
+ Berechnungszyklus = monatlich'
+ - 'Zählerstand am Tagesende der letzten 30 Tage) -> list \n
+ Berechnungszyklus = täglich'
+ - 'Zählerstand am Wochenende der letzten 30 Wochen) -> list \n
+ Berechnungszyklus = wöchentlich'
+ - 'Zählerstand am Monatsende der letzten 18 Monate) -> list \n
+ Berechnungszyklus = monatlich'
+ - 'monatliche Wärmesumme der letzten 24 Monate) -> list \n
+ Berechnungszyklus = monatlich'
+ - 'monatliche Kältesumme der letzten 24 Monate) -> list \n
+ Berechnungszyklus = monatlich'
+ - 'Stundenmittelwert für den aktuellen Tag) -> list \n
+ Berechnungszyklus = täglich'
+ - 'Stundenmittelwert pro Tag der letzten 30 Tage (bspw. zur Berechnung der Tagesmitteltemperatur basierend auf den Mittelwert der Temperatur pro Stunde) -> list \n
+ Berechnungszyklus = täglich'
+ # Allgemein
+ - 'Ausgabe des ältesten Wertes des entsprechenden "Parent-Items" mit database Attribut -> num'
+ - 'Ausgabe des Timestamp des ältesten Eintrages des entsprechenden "Parent-Items" mit database Attribut -> list'
+ # Komplex
+ - 'Berechnet die Kältesumme für einen Zeitraum, db_addon_params sind für die Definition des Zeitraums notwendig (year=optional, month=optional) -> num \n
+ Berechnungszyklus = täglich'
+ - 'Berechnet die Wärmesumme für einen Zeitraum, db_addon_params sind für die Definition des Zeitraums notwendig (year=optional, month=optional) -> num \n
+ Berechnungszyklus = täglich'
+ - 'Berechnet die Grünlandtemperatursumme für einen Zeitraum, db_addon_params sind für die Definition des Zeitraums notwendig (year=optional) siehe https://de.wikipedia.org/wiki/Gr%C3%BCnlandtemperatursumme -> num \n
+ Berechnungszyklus = täglich'
+ - 'Berechnet die Tagesmitteltemperatur auf basis der stündlichen Durchschnittswerte eines Tages für die angegebene Anzahl von Tagen (days=optional) -> num \n
+ Berechnungszyklus = täglich'
+ - 'Abfrage der DB mit db_addon_params (func=mandatory, item=mandatory, timespan=mandatory, start=optional, end=optional, count=optional, group=optional, group2=optional) -> foo \n
+ Berechnungszyklus = group'
+
+ valid_list_item_type:
+ # Verbrauch
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ # Zaehlerstand
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ # Wertehistorie min/max
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ - num
+ # Serie
+ - list
+ - list
+ - list
+ - list
+ - list
+ - list
+ - list
+ - list
+ - list
+ - list
+ - list
+ - list
+ - list
+ - list
+ - list
+ - list
+ - list
+ - list
+ - list
+ # Allgemein
+ - num
+ - list
+ # Komplex
+ - num
+ - num
+ - num
+ - list
+ - list
+
+ db_addon_info:
+ type: str
+ description:
+ de: 'Info-Funktion des DB-Addon Plugins'
+ en: 'Info-Function of DB-Addon Plugins'
+ valid_list:
+ - 'db_version' #str ------ Version der verbundenen Datenbank
+ valid_list_description:
+ - 'Version der verbundenen Datenbank -> str'
+ valid_list_item_type:
+ - str
+
+ db_addon_admin:
+ type: str
+ description:
+ de: 'Admin-Funktion des DB-Addon Plugins'
+ en: 'Admin-Function of DB-Addon Plugins'
+ valid_list:
+ - 'suspend' #bool ------ unterbricht die Aktivitäten des Plugin
+ - 'recalc_all' #bool ------ Startet einen Neuberechnungslauf aller on-demand items
+ - 'clean_cache_values' #bool ------ Löscht Plugin-Cache und damit alle im Plugin zwischengespeicherten Werte
+ valid_list_description:
+ - 'unterbricht die Aktivitäten des Plugin -> bool'
+ - 'Startet einen Neuberechnungslauf aller on-demand items -> bool'
+ - 'Löscht Plugin-Cache und damit alle im Plugin zwischengespeicherten Werte -> bool'
+ valid_list_item_type:
+ - bool
+ - bool
+ - bool
+
+ db_addon_params:
+ type: str
+ description:
+ de: "Parameter für eine Auswertefunktion des DB-Addon Plugins im Format 'kwargs' enclosed in quotes like 'keyword=argument, keyword=argument'"
+ en: "Parameters of a DB-Addon Plugin evaluation function. Need to have format of 'kwargs' enclosed in quotes like 'keyword=argument, keyword=argument'"
+
+ db_addon_startup:
+ type: bool
+ description:
+ de: 'Ausführen der Berechnung bei Plugin Start (mit zeitlichem Abstand, wie in den Plugin Parametern definiert)'
+ en: 'Run function in startup of plugin (with delay, set in plugin parameters)'
+
+ db_addon_ignore_value:
+ type: num
+ description:
+ de: 'Wert der bei Abfrage bzw. Auswertung der Datenbank für diese Item ignoriert werden soll'
+ en: 'Value which will be ignored at database query'
+
+item_structs:
+ verbrauch_1:
+ name: Struct für Verbrauchsauswertung bei Zählern mit stetig ansteigendem Zählerstand (Teil 1)
+ verbrauch_heute:
+ name: Verbrauch heute
+ db_addon_fct: verbrauch_heute
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ verbrauch_woche:
+ name: Verbrauch seit Wochenbeginn
+ db_addon_fct: verbrauch_woche
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ verbrauch_monat:
+ name: Verbrauch seit Monatsbeginn
+ db_addon_fct: verbrauch_monat
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ verbrauch_jahr:
+ name: Verbrauch seit Jahresbeginn
+ db_addon_fct: verbrauch_jahr
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ verbrauch_rolling_12m:
+ name: Verbrauch innerhalb der letzten 12 Monate ausgehend von gestern
+ db_addon_fct: verbrauch_rolling_12m_heute_minus1
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ verbrauch_gestern:
+ name: Verbrauch gestern
+ db_addon_fct: verbrauch_heute_minus1
+ db_addon_startup: yes
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ verbrauch_gestern_minus1:
+ name: Verbrauch vorgestern
+ db_addon_fct: verbrauch_heute_minus2
+ db_addon_startup: yes
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ verbrauch_gestern_minus2:
+ name: Verbrauch vor 3 Tagen
+ db_addon_fct: verbrauch_heute_minus3
+ db_addon_startup: yes
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ verbrauch_vorwoche:
+ name: Verbrauch in der Vorwoche
+ db_addon_fct: verbrauch_woche_minus1
+ db_addon_startup: yes
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ verbrauch_vorwoche_minus1:
+ name: Verbrauch vor 2 Wochen
+ db_addon_fct: verbrauch_woche_minus2
+ db_addon_startup: yes
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ verbrauch_vormonat:
+ name: Verbrauch im Vormonat
+ db_addon_fct: verbrauch_monat_minus1
+ db_addon_startup: yes
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ verbrauch_vormonat_minus12:
+ name: Verbrauch vor 12 Monaten
+ db_addon_fct: verbrauch_monat_minus12
+ db_addon_startup: yes
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ verbrauch_vorjahreszeitraum:
+ name: Verbrauch im Jahreszeitraum 1.1. bis jetzt vor einem Jahr
+ db_addon_fct: verbrauch_jahreszeitraum_minus1
+ db_addon_startup: yes
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ verbrauch_2:
+ name: Struct für Verbrauchsauswertung bei Zählern mit stetig ansteigendem Zählerstand (Teil 2)
+ verbrauch_gestern_minus3:
+ name: Verbrauch vor 3 Tagen
+ db_addon_fct: verbrauch_heute_minus3
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ verbrauch_gestern_minus4:
+ name: Verbrauch vor 4 Tagen
+ db_addon_fct: verbrauch_heute_minus4
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ verbrauch_gestern_minus5:
+ name: Verbrauch vor 5 Tagen
+ db_addon_fct: verbrauch_heute_minus5
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ verbrauch_gestern_minus6:
+ name: Verbrauch vor 6 Tagen
+ db_addon_fct: verbrauch_heute_minus6
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ verbrauch_gestern_minus7:
+ name: Verbrauch vor 7 Tagen
+ db_addon_fct: verbrauch_heute_minus7
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ verbrauch_vorwoche_minus2:
+ name: Verbrauch vor 3 Wochen
+ db_addon_fct: verbrauch_woche_minus3
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ verbrauch_vorwoche_minus3:
+ name: Verbrauch vor 4 Wochen
+ db_addon_fct: verbrauch_woche_minus4
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ verbrauch_vormonat_minus1:
+ name: Verbrauch vor 2 Monaten
+ db_addon_fct: verbrauch_monat_minus2
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ verbrauch_vormonat_minus2:
+ name: Verbrauch vor 3 Monaten
+ db_addon_fct: verbrauch_monat_minus3
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ verbrauch_vormonat_minus3:
+ name: Verbrauch vor 4 Monaten
+ db_addon_fct: verbrauch_monat_minus4
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ zaehlerstand_1:
+ name: Struct für die Erfassung von Zählerständen zu bestimmten Zeitpunkten bei Zählern mit stetig ansteigendem Zählerstand
+ zaehlerstand_gestern:
+ name: Zählerstand zum Ende des gestrigen Tages
+ db_addon_fct: zaehlerstand_heute_minus1
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ zaehlerstand_vorwoche:
+ name: Zählerstand zum Ende der vorigen Woche
+ db_addon_fct: zaehlerstand_woche_minus1
+ db_addon_startup: yes
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ zaehlerstand_vormonat:
+ name: Zählerstand zum Ende des Vormonates
+ db_addon_fct: zaehlerstand_monat_minus1
+ db_addon_startup: yes
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ zaehlerstand_vormonat_minus1:
+ name: Zählerstand zum Monatsende vor 2 Monaten
+ db_addon_fct: zaehlerstand_monat_minus2
+ db_addon_startup: yes
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ zaehlerstand_vormonat_minus2:
+ name: Zählerstand zum Monatsende vor 3 Monaten
+ db_addon_fct: zaehlerstand_monat_minus3
+ db_addon_startup: yes
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ zaehlerstand_vorjahr:
+ name: Zählerstand am Ende des vorigen Jahres
+ db_addon_fct: zaehlerstand_jahr_minus1
+ db_addon_startup: yes
+ type: num
+ visu_acl: ro
+ # cache: yes
+
+ minmax_1:
+ name: Struct für Auswertung der Wertehistorie bei schwankenden Werten wie bspw. Temperatur oder Leistung (Teil 1)
+
+ heute_min:
+ name: Minimaler Wert seit Tagesbeginn
+ db_addon_fct: minmax_heute_min
+ db_addon_ignore_value: 0
+ type: num
+ # cache: yes
+
+ heute_max:
+ name: Maximaler Wert seit Tagesbeginn
+ db_addon_fct: minmax_heute_max
+ type: num
+ # cache: yes
+
+ last24h_min:
+ name: Minimaler Wert in den letzten 24h (gleitend)
+ db_addon_fct: minmax_last_24h_min
+ type: num
+ # cache: yes
+
+ last24h_max:
+ name: Maximaler Wert in den letzten 24h (gleitend)
+ db_addon_fct: minmax_last_24h_max
+ type: num
+ # cache: yes
+
+ woche_min:
+ name: Minimaler Wert seit Wochenbeginn
+ db_addon_fct: minmax_woche_min
+ type: num
+ # cache: yes
+
+ woche_max:
+ name: Maximaler Wert seit Wochenbeginn
+ db_addon_fct: minmax_woche_max
+ type: num
+ # cache: yes
+
+ monat_min:
+ name: Minimaler Wert seit Monatsbeginn
+ db_addon_fct: minmax_monat_min
+ type: num
+ # cache: yes
+
+ monat_max:
+ name: Maximaler Wert seit Monatsbeginn
+ db_addon_fct: minmax_monat_max
+ type: num
+ # cache: yes
+
+ jahr_min:
+ name: Minimaler Wert seit Jahresbeginn
+ db_addon_fct: minmax_jahr_min
+ type: num
+ # cache: yes
+
+ jahr_max:
+ name: Maximaler Wert seit Jahresbeginn
+ db_addon_fct: minmax_jahr_max
+ type: num
+ # cache: yes
+
+ gestern_min:
+ name: Minimaler Wert gestern
+ db_addon_fct: minmax_heute_minus1_min
+ db_addon_startup: yes
+ type: num
+ # cache: yes
+
+ gestern_max:
+ name: Maximaler Wert gestern
+ db_addon_fct: minmax_heute_minus1_max
+ db_addon_startup: yes
+ type: num
+ # cache: yes
+
+ gestern_avg:
+ name: Durchschnittlicher Wert gestern
+ db_addon_fct: minmax_heute_minus1_avg
+ db_addon_startup: yes
+ type: num
+ # cache: yes
+
+ vorwoche_min:
+ name: Minimaler Wert in der Vorwoche
+ db_addon_fct: minmax_woche_minus1_min
+ db_addon_startup: yes
+ type: num
+ # cache: yes
+
+ vorwoche_max:
+ name: Maximaler Wert in der Vorwoche
+ db_addon_fct: minmax_woche_minus1_max
+ db_addon_startup: yes
+ type: num
+ # cache: yes
+
+ vorwoche_avg:
+ name: Durchschnittlicher Wert in der Vorwoche
+ db_addon_fct: minmax_woche_minus1_avg
+ db_addon_startup: yes
+ type: num
+ # cache: yes
+
+ vormonat_min:
+ name: Minimaler Wert im Vormonat
+ db_addon_fct: minmax_monat_minus1_min
+ db_addon_startup: yes
+ type: num
+ # cache: yes
+
+ vormonat_max:
+ name: Maximaler Wert im Vormonat
+ db_addon_fct: minmax_monat_minus1_max
+ db_addon_startup: yes
+ type: num
+ # cache: yes
+
+ vormonat_avg:
+ name: Durchschnittlicher Wert im Vormonat
+ db_addon_fct: minmax_monat_minus1_avg
+ db_addon_startup: yes
+ type: num
+ # cache: yes
+
+ vorjahr_min:
+ name: Minimaler Wert im Vorjahr
+ db_addon_fct: minmax_jahr_minus1_min
+ db_addon_startup: yes
+ type: num
+ # cache: yes
+
+ vorjahr_max:
+ name: Maximaler Wert im Vorjahr
+ db_addon_fct: minmax_jahr_minus1_max
+ db_addon_startup: yes
+ type: num
+ # cache: yes
+
+ minmax_2:
+ name: Struct für Auswertung der Wertehistorie bei schwankenden Werten wie bspw. Temperatur oder Leistung (Teil 2)
+
+ gestern_minus1_min:
+ name: Minimaler Wert vorgestern
+ db_addon_fct: minmax_heute_minus2_min
+ type: num
+ # cache: yes
+
+ gestern_minus1_max:
+ name: Maximaler Wert vorgestern
+ db_addon_fct: minmax_heute_minus2_max
+ type: num
+ # cache: yes
+
+ gestern_minus1_avg:
+ name: Durchschnittlicher Wert vorgestern
+ db_addon_fct: minmax_heute_minus2_avg
+ type: num
+ # cache: yes
+
+ gestern_minus2_min:
+ name: Minimaler Wert vor 3 Tagen
+ db_addon_fct: minmax_heute_minus3_min
+ type: num
+ # cache: yes
+
+ gestern_minus2_max:
+ name: Maximaler Wert vor 3 Tagen
+ db_addon_fct: minmax_heute_minus3_max
+ type: num
+ # cache: yes
+
+ gestern_minus2_avg:
+ name: Durchschnittlicher Wert vor 3 Tagen
+ db_addon_fct: minmax_heute_minus3_avg
+ type: num
+ # cache: yes
+
+ vorwoche_minus1_min:
+ name: Minimaler Wert in der Woche vor 2 Wochen
+ db_addon_fct: minmax_woche_minus2_min
+ type: num
+ # cache: yes
+
+ vorwoche_minus1_max:
+ name: Maximaler Wert in der Woche vor 2 Wochen
+ db_addon_fct: minmax_woche_minus2_max
+ type: num
+ # cache: yes
+
+ vorwoche_minus1_avg:
+ name: Durchschnittlicher Wert in der Woche vor 2 Wochen
+ db_addon_fct: minmax_woche_minus2_avg
+ type: num
+ # cache: yes
+
+ vormonat_minus1_min:
+ name: Minimaler Wert im Monat vor 2 Monaten
+ db_addon_fct: minmax_monat_minus2_min
+ type: num
+ # cache: yes
+
+ vormonat_minus1_max:
+ name: Maximaler Wert im Monat vor 2 Monaten
+ db_addon_fct: minmax_monat_minus2_max
+ type: num
+ # cache: yes
+
+ vormonat_minus1_avg:
+ name: Durchschnittlicher Wert im Monat vor 2 Monaten
+ db_addon_fct: minmax_monat_minus2_avg
+ type: num
+ # cache: yes
+
+item_attribute_prefixes: NONE
+
+plugin_functions:
+ fetch_log:
+ type: list
+ description:
+ de: 'Liefert für das angegebene Item und die Parameter das Abfrageergebnis zurück'
+ en: 'Return the database request result for the given item and parameters'
+ # mit dieser Funktion ist es möglich, eine Liste der "func" Werte pro "group" / "group2" eines "item" von "start""timespan" bis "end""timespan" oder von "start""timespan" bis "count" ausgegeben zu lassen
+ # bspw. minimale Tagestemperatur vom Item "outdoor.temp" der letzten 10 Tage startend von gestern davor --> func=min, item=outdoor.temp, timespan=day, start=1, count=10, group=day
+ # bspw. maximal Tagestemperatur vom Item "outdoor.temp" von jetzt bis 2 Monate davor --> func=max, item=outdoor.temp, timeframe=month, start=0, end=2, group=day
+ parameters:
+ func:
+ type: str
+ description:
+ de: "zu verwendende Abfragefunktion"
+ en: "database function to be used"
+ mandatory: True
+ valid_list:
+ - min # Minimalwerte
+ - max # Maximalwerte
+ - sum # Summe
+ - on
+ - integrate
+ - sum_max
+ - sum_avg
+ - sum_min_neg
+ - diff_max
+ item:
+ type: foo
+ description:
+ de: "Das Item-Objekt oder die Item_ID der DB"
+ en: "An item object"
+ mandatory: True
+ timeframe:
+ type: str
+ description:
+ de: "Zeitinkrement für die DB-Abfrage"
+ en: "time increment for db-request"
+ mandatory: True
+ valid_list:
+ - day
+ - week
+ - month
+ - year
+ start:
+ type: int
+ description:
+ de: "Zeitlicher Beginn der DB-Abfrage: x Zeitinkrementen von jetzt in die Vergangenheit"
+ en: "start point in time for db-request; x time increments from now into the past"
+ end:
+ type: int
+ description:
+ de: "Zeitliches Ende der DB-Abfrage: x Zeitinkrementen von jetzt in die Vergangenheit"
+ en: "end point in time for db-request; x time increments from now into the past"
+ count:
+ type: int
+ description:
+ de: "Anzahl der Zeitinkremente, vom Start in die Vergangenheit abzufragen sind. Alternative zu 'end'"
+ en: "number of time increments from start point in time into the past. can be used alternativly to 'end'"
+ group:
+ type: str
+ description:
+ de: "erste Gruppierung der DB-Abfrage"
+ en: "first grouping for the db-request"
+ valid_list:
+ - day
+ - week
+ - month
+ - year
+ group2:
+ type: str
+ description:
+ de: "zweite Gruppierung der DB-Abfrage"
+ en: "second grouping for the db-request"
+ valid_list:
+ - day
+ - week
+ - month
+ - year
+
+ db_version:
+ type: str
+ description:
+ de: 'Liefer die verwendete Version der Datenbank'
+ en: 'Return the database version'
+
+ suspend:
+ type: bool
+ description:
+ de: 'Pausiert die Berechnungen des Plugins'
+ en: 'Suspends value evaluation of plugin'
+
+logic_parameters: NONE
diff --git a/db_addon/requirements.txt b/db_addon/requirements.txt
new file mode 100644
index 000000000..15d323b8c
--- /dev/null
+++ b/db_addon/requirements.txt
@@ -0,0 +1,3 @@
+python-dateutil
+sqlvalidator
+pymysql
\ No newline at end of file
diff --git a/db_addon/user_doc.rst b/db_addon/user_doc.rst
new file mode 100644
index 000000000..65ec9bfc4
--- /dev/null
+++ b/db_addon/user_doc.rst
@@ -0,0 +1,184 @@
+
+.. index:: Plugins; db_addon (Datenbank Unterstützung)
+.. index:: db_addon
+
+========
+db_addon
+========
+
+.. image:: webif/static/img/plugin_logo.png
+ :alt: plugin logo
+ :width: 300px
+ :height: 300px
+ :scale: 50 %
+ :align: left
+
+
+Das Plugin bietet eine Funktionserweiterung zum Database Plugin und ermöglicht die einfache Auswertung von Messdaten.
+Basierend auf den Daten in der Datenbank können bspw. Auswertungen zu Verbrauch (heute, gestern, ...) oder zu Minimal-
+und Maximalwerten gefahren werden.
+Diese Auswertungen werden zyklisch zum Tageswechsel, Wochenwechsel, Monatswechsel oder Jahreswechsel, in Abhängigkeit
+der Funktion erzeugt.
+Um die Zugriffe auf die Datenbank zu minimieren, werden diverse Daten zwischengespeichert.
+
+Die Items mit einem DatabaseAddon-Attribut müssen im gleichen Pfad sein, wie das Item, für das das Database Attribut
+konfiguriert ist.
+Bedeutet: Die Items mit dem DatabaseAddon-Attribute müssen Kinder oder Kindeskinder oder Kindeskinderkinder des Items
+sein, für das das Database Attribut konfiguriert ist
+
+Bsp:
+
+
+.. code-block:: yaml
+
+ temperatur:
+ type: bool
+ database: yes
+
+ auswertung:
+ type: foo
+
+ heute_min:
+ type: num
+ db_addon_fct: heute_min
+
+ gestern_max:
+ type: num
+ db_addon_fct: heute_minus1_max
+
+|
+
+Anforderungen
+=============
+
+Es muss das Database Plugin konfiguriert und aktiv sein. In den Plugin Parametern ist der Name der Konfiguration des
+Database-Plugins anzugeben. Damit ist auch eine etwaig definierte Instanz des Database-Plugins definiert.
+Die Konfiguration des DatabaseAddon-Plugin erfolgt automatisch bei Start.
+
+
+Hinweis: Das Plugin selbst ist aktuell nicht multi-instance fähig. Das bedeutet, dass das Plugin aktuell nur eine Instanz
+des Database-Plugin abgebunden werden kann.
+
+|
+
+Konfiguration
+=============
+
+Diese Plugin Parameter und die Informationen zur Item-spezifischen Konfiguration des Plugins sind
+unter :doc:`/plugins_doc/config/db_addon` beschrieben.
+
+mysql Datenbank
+---------------
+
+Bei Verwendung von mysql sollten einige Variablen der Datenbank angepasst werden, so dass die komplexeren Anfragen
+ohne Fehler bearbeitet werden.
+
+Dazu folgenden Block am Ende der Datei */etc/mysql/my.cnf* einfügen bzw den existierenden ergänzen.
+
+
+.. code-block:: bash
+
+ [mysqld]
+ connect_timeout = 60
+ net_read_timeout = 60
+ wait_timeout = 28800
+ interactive_timeout = 28800
+
+|
+
+Hinweise
+========
+
+ - Das Plugin startet die Berechnungen der Werte nach einer gewissen (konfigurierbaren) Zeit (Attribut `startup_run_delay`) nach dem Start von shNG, um den Startvorgang nicht zu beeinflussen.
+ - Bei Start werden automatisch nur die Items berechnet, für das das Attribute `db_addon_startup` gesetzt wurde. Alle anderen Items werden erst zu konfigurierten Zeit berechnet. Über das WebIF kann die Berechnung aller definierten Items ausgelöst werden.
+ - Für sogenannte `on_change` Items, also Items, deren Berechnung bis zum Jetzt (bspw. verbrauch-heute) gehen, wird die Berechnung immer bei eintreffen eines neuen Wertes gestartet. Zu Reduktion der Belastung auf die Datenbank werden die Werte für das Ende der letzten Periode gecached.
+ - Berechnungen werden nur ausgeführt, wenn für den kompletten abgefragten Zeitraum Werte in der Datenbank vorliegen. Wird bspw. der Verbrauch des letzten Monats abgefragt wobei erst Werte ab dem 3. des Monats in der Datenbank sind, wird die Berechnung abgebrochen.
+ Mit dem Attribut `use_oldest_entry` kann dieses Verhalten verändert werden. Ist das Attribut gesetzt, wird, wenn für den Beginn der Abfragezeitraums keinen Werte vorliegen, der älteste Eintrag der Datenbank genutzt.
+ - Für die Auswertung kann es nützlich sein, bestimmte Werte aus der Datenbank bei der Berechnung auszublenden. Hierfür stehen 2 Möglichkeiten zur Verfügung:
+ - Plugin-Attribut `ignore_0`: (list of strings) Bei Items, bei denen ein String aus der Liste im Pfadnamen vorkommt, werden 0-Werte (val_num = 0) bei Datenbankauswertungen ignoriert. Hat also das Attribut den Wert ['temp'] werden bei allen Items mit 'temp' im Pfadnamen die 0-Werte bei der Auswertung ignoriert.
+ - Item-Attribut `db_addon_ignore_value`: (num) Dieser Wert wird bei der Abfrage bzw. Auswertung der Datenbank für diese Item ignoriert.
+ - Das Plugin enthält sehr ausführliche Logginginformation. Bei unerwartetem Verhalten, den LogLevel entsprechend anpassen, um mehr information zu erhalten.
+ - Berechnungen des Plugins können im WebIF unterbrochen werden. Auch das gesamte Plugin kann pausiert werden. Dies kann be starker Systembelastung nützlich sein.
+
+|
+
+Beispiele
+=========
+
+Verbrauch
+---------
+
+Soll bspw. der Verbrauch von Wasser ausgewertet werden, so ist dies wie folgt möglich:
+
+.. code-block:: yaml
+
+ wasserzaehler:
+ zaehlerstand:
+ type: num
+ knx_dpt: 12
+ knx_cache: 5/3/4
+ eval: round(value/1000, 1)
+ database: init
+ struct:
+ - db_addon.verbrauch_1
+ - db_addon.verbrauch_2
+ - db_addon.zaehlerstand_1
+
+Die Werte des Wasserzählerstandes werden in die Datenbank geschrieben und darauf basierend ausgewertet. Die structs
+'db_addon.verbrauch_1' und 'db_addon.verbrauch_2' stellen entsprechende Items für die Verbrauchsauswerten zur Verfügung.
+
+minmax
+------
+
+Soll bspw. die minimalen und maximalen Temperaturen ausgewertet werden, kann dies so umgesetzt werden:
+
+.. code-block:: yaml
+
+ temperature:
+ aussen:
+ nord:
+ name: Außentemp Nordseite
+ type: num
+ visu_acl: ro
+ knx_dpt: 9
+ knx_cache: 6/5/1
+ database: init
+ struct:
+ - db_addon.minmax_1
+ - db_addon.minmax_2
+
+Die Temperaturwerte werden in die Datenbank geschrieben und darauf basierend ausgewertet. Die structs
+'db_addon.minmax_1' und 'db_addon.minmax_2' stellen entsprechende Items für die min/max Auswertung zur Verfügung.
+
+|
+
+Web Interface
+=============
+
+Das WebIF stellt neben der Ansicht verbundener Items und deren Parameter und Werte auch Funktionen für die
+Administration des Plugins bereit.
+
+Es stehen Button für:
+
+- Neuberechnung aller Items
+- Abbruch eines aktiven Berechnungslaufes
+- Pausieren des Plugins
+- Wiederaufnahme des Plugins
+
+bereit.
+
+Achtung: Das Auslösen einer kompletten Neuberechnung aller Items kann zu einer starken Belastung der Datenbank
+aufgrund vieler Leseanfragen führen.
+
+
+db_addon Items
+--------------
+
+Dieser Reiter des Webinterface zeigt die Items an, für die ein DatabaseAddon Attribut konfiguriert ist.
+
+
+db_addon Maintenance
+--------------------
+
+Das Webinterface zeigt detaillierte Informationen über die im Plugin verfügbaren Daten an.
+Dies dient der Maintenance bzw. Fehlersuche. Dieser Tab ist nur bei Log-Level "Debug" verfügbar.
diff --git a/db_addon/webif/__init__.py b/db_addon/webif/__init__.py
new file mode 100644
index 000000000..0397f8ab9
--- /dev/null
+++ b/db_addon/webif/__init__.py
@@ -0,0 +1,138 @@
+#!/usr/bin/env python3
+# vim: set encoding=utf-8 tabstop=4 softtabstop=4 shiftwidth=4 expandtab
+#########################################################################
+# Copyright 2022- Michael Wenzel wenzel_michael@web.de
+#########################################################################
+# This file is part of SmartHomeNG.
+# https://www.smarthomeNG.de
+# https://knx-user-forum.de/forum/supportforen/smarthome-py
+#
+# This plugin provides additional functionality to mysql database
+# connected via database plugin
+#
+# SmartHomeNG is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# SmartHomeNG 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with SmartHomeNG. If not, see .
+#
+#########################################################################
+
+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
+
+
+class WebInterface(SmartPluginWebIf):
+
+ def __init__(self, webif_dir, plugin):
+ """
+ Initialization of instance of class WebInterface
+
+ :param webif_dir: directory where the webinterface of the plugin resides
+ :param plugin: instance of the plugin
+ :type webif_dir: str
+ :type plugin: object
+ """
+ self.logger = plugin.logger
+ self.webif_dir = webif_dir
+ self.plugin = plugin
+ self.items = Items.get_instance()
+
+ self.tplenv = self.init_template_environment()
+
+ @cherrypy.expose
+ def index(self, reload=None):
+ """
+ Build index.html for cherrypy
+
+ Render the template and return the html file to be delivered to the browser
+
+ :return: contents of the template after being rendered
+ """
+
+ tmpl = self.tplenv.get_template('index.html')
+
+ return tmpl.render(p=self.plugin,
+ webif_pagelength=self.plugin.get_parameter_value('webif_pagelength'),
+ suspended='true' if self.plugin.suspended else 'false',
+ items=self.plugin.get_item_list('db_addon', 'function'),
+ item_count=len(self.plugin.get_item_list('db_addon', 'function')),
+ plugin_shortname=self.plugin.get_shortname(),
+ plugin_version=self.plugin.get_version(),
+ plugin_info=self.plugin.get_info(),
+ maintenance=True if self.plugin.log_level == 10 else False,
+ )
+
+ @cherrypy.expose
+ def get_data_html(self, dataSet=None):
+ """
+ Return data to update the webpage
+
+ For the standard update mechanism of the web interface, the dataSet to return the data for is None
+
+ :param dataSet: Dataset for which the data should be returned (standard: None)
+ :return: dict with the data needed to update the web page.
+ """
+ if dataSet is None:
+ # get the new data
+ data = dict()
+ data['items'] = {}
+
+ for item in self.plugin.get_item_list('db_addon', 'function'):
+ data['items'][item.id()] = {}
+ data['items'][item.id()]['value'] = item.property.value
+ data['items'][item.id()]['last_update'] = item.property.last_update.strftime('%d.%m.%Y %H:%M:%S')
+ data['items'][item.id()]['last_change'] = item.property.last_change.strftime('%d.%m.%Y %H:%M:%S')
+
+ data['plugin_suspended'] = self.plugin.suspended
+ data['maintenance'] = True if self.plugin.log_level == 10 else False
+ data['queue_length'] = self.plugin.queue_backlog
+ data['active_queue_item'] = self.plugin.active_queue_item
+
+ try:
+ return json.dumps(data, default=str)
+ except Exception as e:
+ self.logger.error(f"get_data_html exception: {e}")
+
+ @cherrypy.expose
+ def recalc_all(self):
+ self.logger.debug(f"recalc_all called")
+ self.plugin.execute_all_items()
+
+ @cherrypy.expose
+ def clean_cache_dicts(self):
+ self.logger.debug(f"_clean_cache_dicts called")
+ self.plugin._clean_cache_dicts()
+
+ @cherrypy.expose
+ def clear_queue(self):
+ self.logger.debug(f"_clear_queue called")
+ self.plugin._clear_queue()
+
+ @cherrypy.expose
+ def activate(self):
+ self.logger.debug(f"active called")
+ self.plugin.suspend(False)
+
+ @cherrypy.expose
+ def suspend(self):
+ self.logger.debug(f"suspend called")
+ self.plugin.suspend(True)
diff --git a/db_addon/webif/static/img/plugin_logo.png b/db_addon/webif/static/img/plugin_logo.png
new file mode 100644
index 000000000..8498f745e
Binary files /dev/null and b/db_addon/webif/static/img/plugin_logo.png differ
diff --git a/db_addon/webif/templates/index.html b/db_addon/webif/templates/index.html
new file mode 100644
index 000000000..37688339b
--- /dev/null
+++ b/db_addon/webif/templates/index.html
@@ -0,0 +1,495 @@
+{% extends "base_plugin.html" %}
+
+{% set logo_frame = false %}
+{% set row_count = true %}
+{% set initial_update = true %}
+
+{% set update_interval = [(((10 * item_count) / 1000) | round | int) * 1000, 5000]|max %}
+
+
+{% set language = p.get_sh().get_defaultlanguage() %}
+{% if language not in ['en','de'] %}
+ {% set language = 'de' %}
+{% endif %}
+
+
+{% block pluginstyles %}
+
+{% endblock pluginstyles %}
+
+
+{% block pluginscripts %}
+
+
+
+
+
+{% endblock pluginscripts %}
+
+
+{% block headtable %}
+
+
+{% endblock bodytab2 %}
diff --git a/executor/plugin.yaml b/executor/plugin.yaml
index 509ecc6a2..3933b87be 100755
--- a/executor/plugin.yaml
+++ b/executor/plugin.yaml
@@ -12,15 +12,30 @@ plugin:
documentation: https://www.smarthomeng.de/user/plugins/executor/user_doc.html
support: https://knx-user-forum.de/forum/supportforen/smarthome-py/1425152-support-thread-plugin-executor
- version: 1.0.4 # 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)
+ version: 1.1.1 # Plugin version
+ sh_minversion: 1.9 # minimum shNG version to use this plugin
+ #sh_maxversion: # maximum shNG version to use this plugin (leave empty if latest)
+ py_minversion: 3.8 # minimum Python version to use for this plugin, use f-strings for debug
+ #py_maxversion: # maximum Python version to use for this plugin (leave empty if latest)
multi_instance: False # plugin supports multi instance
restartable: True
classname: Executor # class containing the plugin
-parameters: NONE
- # Definition of parameters to be configured in etc/plugin.yaml (enter 'parameters: NONE', if section should be empty)
+parameters:
+ scripts:
+ type: str
+ default: executor_scripts
+ description:
+ de: 'relative Pfadangabe unterhalb *var* wo im Bedarfsfall die Skripte für das Executor Plugin abgelegt werden'
+ en: 'relative path below *var* to script files for executor plugin if needed'
+ script_entries:
+ type: int
+ default: 6
+ valid_min: 0
+ valid_max: 50
+ description:
+ de: 'Maximale Anzahl der Zeilen in der Listbox für Skripte. Bei Angabe von 0 wird die Listbox zur Dropdown Liste.'
+ en: 'Maximum number of lines in listbox für scripts. If 0 is given the listbox will turn into a dropdown list.'
item_attributes: NONE
# Definition of item attributes defined by this plugin (enter 'item_attributes: NONE', if section should be empty)
diff --git a/executor/user_doc.rst b/executor/user_doc.rst
index b70aa29e2..7c749a259 100755
--- a/executor/user_doc.rst
+++ b/executor/user_doc.rst
@@ -1,44 +1,59 @@
.. index:: Plugins; executor
.. index:: executor
+========
executor
-########
+========
+
+
+.. image:: webif/static/img/plugin_logo.svg
+ :alt: plugin logo
+ :width: 300px
+ :height: 300px
+ :scale: 50 %
+ :align: left
Einführung
-==========
+~~~~~~~~~~
-Das executor plugin kann genutzt werden, um **eval Ausdrücke** und **Python Code** (z.B. für **Logiken**) zu testen.
+Das executor plugin kann genutzt werden, um **Python Code** (z.B. für **Logiken**) und **eval Ausdrücke** zu testen.
.. important::
- Seien Sie sich bewusst, dass die Aktivierung dieses Plugins ein Sicherheitsrisiko darstellen könnte. Wenn andere Personen Zugriff auf die Web-Schnittstelle erhalten,
+ Seien Sie sich bewusst, dass die Aktivierung dieses Plugins ein Sicherheitsrisiko darstellen könnte.
+ Wenn andere Personen Zugriff auf die Web-Schnittstelle erhalten,
kann man das ganze SmartHomeNG-Biest kontrollieren. Seien Sie also vorsichtig!!!
Konfiguration
=============
-Das Aktivieren des Plugins ist ausreichend.
+Das Aktivieren des Plugins ist ausreichend. Optional kann noch ein Verzeichnis für Skripte konfiguriert werden
+über das Attribut ``executor_scripts`` in der ``plugin.yaml``.
+Damit wird dem Plugin eine relative Pfadangabe unterhalb *var* angegeben wo Skripte für das Executor Plugin abgelegt werden.
-Beispiele für Eval
-==================
+Webinterface
+============
-.. code-block:: python
+Im Webinterface findet sich eine Listbox mit den auf dem Rechner gespeicherten Skripten.
+Um das Skript in den Editor zu laden entweder ein Skript in der Liste einfach anklicken und auf *aus Datei laden* klicken oder
+direkt in der Liste einen Doppelklick auf die gewünschte Datei ausführen.
- 12 if 23 % 3 == 5 else None
+Der Dateiname wird entsprechend der gewählten Datei gesetzt. Mit Klick auf *aktuellen Code speichern* wird der Code im konfigurierten
+Skript Verzeichnis unter dem aktuell in der Eingabebox vorgegebenem Dateinamen abgespeichert.
-Würde im Ergebnis **None** resultieren.
+Mit einem Klick auf *Code ausführen!* oder der Kombination Ctrl+Return wird der Code an SmartHomeNG gesendet und ausgeführt.
+Das kann gerade bei Datenbank Abfragen recht lange dauern. Es kann keine Rückmeldung von SmartHomeNG abgefragt werden wie weit der Code derzeit ist.
+Das Ergebnis wird unten angezeigt. Solange kein Ergebnis vorliegt, steht im Ergebniskasten **... processing ...**
-.. code-block:: python
-
- sh..child() + 4
-
-Da sich im Evalausdruck ein relatives Item befindet, ist es notwendig im Feld "Itempfad" das Item anzugeben, dem das im Code angegebene Unteritem zugewiesen ist.
+Mit einem Klick auf Datei löschen wird versucht die unter Dateiname angezeigte Datei ohne Rückfrage zu löschen.
+Anschliessend wird die Liste der Skripte aktualisiert.
Beispiel Python Code
====================
-Sowohl``logger`` als auch ``print`` funktionieren für die Ausgabe von Ergebnissen. Die Idee ist, dass Logiken mehr oder weniger 1:1 kopiert und getestet werden können.
+Sowohl ``logger`` als auch ``print`` funktionieren für die Ausgabe von Ergebnissen.
+Die Idee ist, dass Logiken mehr oder weniger 1:1 kopiert und getestet werden können.
Loggertest
@@ -67,7 +82,7 @@ Abfragen von Daten aus dem database plugin für ein spezifisches Item:
print(pretty)
-würde in folgendem Ergebnis münden.
+würde in folgendem Ergebnis münden:
.. code-block:: json
@@ -95,3 +110,5 @@ würde in folgendem Ergebnis münden.
]
]
}
+
+Damit die Nutzung
diff --git a/executor/webif/__init__.py b/executor/webif/__init__.py
new file mode 100755
index 000000000..a74caa780
--- /dev/null
+++ b/executor/webif/__init__.py
@@ -0,0 +1,320 @@
+#!/usr/bin/env python3
+# vim: set encoding=utf-8 tabstop=4 softtabstop=4 shiftwidth=4 expandtab
+#########################################################################
+# Copyright 2019-2022 Bernd Meiners Bernd.Meiners@mail.de
+#########################################################################
+# This file is part of SmartHomeNG.
+# https://www.smarthomeNG.de
+# https://knx-user-forum.de/forum/supportforen/smarthome-py
+#
+# This is the executor plugin to run with SmartHomeNG version 1.9 and
+# upwards.
+#
+# SmartHomeNG is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# SmartHomeNG 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with SmartHomeNG. If not, see .
+#
+#########################################################################
+
+
+import urllib
+import time
+import datetime
+import random
+import pprint
+import json
+import logging
+import os
+
+from lib.item import Items
+from lib.model.smartplugin import SmartPluginWebIf
+from lib.model.smartplugin import SmartPlugin
+
+
+# ------------------------------------------
+# Webinterface of the plugin
+# ------------------------------------------
+
+import cherrypy
+import csv
+from jinja2 import Environment, FileSystemLoader
+
+import sys
+
+class PrintCapture:
+ """this class overwrites stdout and stderr temporarily to capture output"""
+ def __init__(self):
+ self.data = []
+ def write(self, s):
+ self.data.append(s)
+ def __enter__(self):
+ sys.stdout = self
+ sys.stderr = self
+ return self
+ def __exit__(self, ext_type, exc_value, traceback):
+ sys.stdout = sys.__stdout__
+ sys.stderr = sys.__stderr__
+
+class Stub():
+ def __init__(self, *args, **kwargs):
+ print(args)
+ print(kwargs)
+ for k,v in kwargs.items():
+ setattr(self, k, v)
+
+# e.g. logger = Stub(warning=print, info=print, debug=print)
+
+
+class WebInterface(SmartPluginWebIf):
+
+ def __init__(self, webif_dir, plugin):
+ """
+ Initialization of instance of class WebInterface
+
+ :param webif_dir: directory where the webinterface of the plugin resides
+ :param plugin: instance of the plugin
+ :type webif_dir: str
+ :type plugin: object
+ """
+ self.logger = plugin.logger
+ self.webif_dir = webif_dir
+ self.plugin = plugin
+ self.items = Items.get_instance()
+
+ self.tplenv = self.init_template_environment()
+
+
+ @cherrypy.expose
+ def index(self, reload=None):
+ """
+ Build index.html for cherrypy
+
+ Render the template and return the html file to be delivered to the browser
+
+ :return: contents of the template after beeing rendered
+ """
+ tmpl = self.tplenv.get_template('index.html')
+ # Setting pagelength (max. number of table entries per page) for web interface
+ try:
+ pagelength = self.plugin.webif_pagelength
+ except Exception:
+ pagelength = 100
+ # 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=sorted(self.items.return_items(), key=lambda k: str.lower(k['_path'])),
+ item_count=0)
+
+
+ @cherrypy.expose
+ def get_data_html(self, dataSet=None):
+ """
+ Return data to update the webpage
+
+ For the standard update mechanism of the web interface, the dataSet to return the data for is None
+
+ :param dataSet: Dataset for which the data should be returned (standard: None)
+ :return: dict with the data needed to update the web page.
+ """
+ if dataSet is 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))
+ return {}
+
+
+ """
+ According to SmartHomeNG documentation the following modules are loaded for the
+ logic environment:
+ - sys
+ - os
+ - time
+ - datetime
+ - random
+ - ephem
+ - Queue
+ - subprocess
+
+ The usage of sys and os is a potential risk for eval and exec as they can remove files in reach of SmartHomeNG user.
+ There should be however no need for ephem, Queue or subprocess
+ """
+
+ @cherrypy.expose
+ def eval_statement(self, eline, path, reload=None):
+ """
+ evaluate expression in eline and return the result
+
+ :return: result of the evaluation
+ """
+ result = ""
+
+ g = {}
+ l = { 'sh': self.plugin.get_sh() }
+ self.logger.debug(f"eval {eline} (raw) for item path {path}")
+ eline = urllib.parse.unquote(eline)
+ if path != '':
+ try:
+ path = self.items.return_item(path)
+ eline = path.get_stringwithabsolutepathes(eline, 'sh.', '(')
+ eline = path.get_stringwithabsolutepathes(eline, 'sh.', '.property')
+ self.logger.debug(f"eval {eline} (unquoted) for item path {path}")
+ except Exception as e:
+ res = f"Error '{e}' while evaluating"
+ result = f"{res}"
+ return result
+
+ try:
+ if eline:
+ res = eval(eline,g,l)
+ else:
+ res = "Nothing to do"
+ except Exception as e:
+ res = f"Error '{e}' while evaluating"
+
+ result = f"{res}"
+ self.logger.debug(f"{result=}")
+ return result
+
+ @cherrypy.expose
+ def exec_code(self, eline, reload=None):
+ """
+ evaluate a whole python block in eline
+
+ :return: result of the evaluation
+ """
+ result = ""
+ stub_logger = Stub(warning=print, info=print, debug=print, error=print)
+
+ g = {}
+ l = { 'sh': self.plugin.get_sh(),
+ 'time': time,
+ 'datetime': datetime,
+ 'random': random,
+ 'json': json,
+ 'pprint': pprint,
+ 'logger': stub_logger,
+ 'logging': logging
+ }
+ self.logger.debug(f"Got request to evaluate {eline} (raw)")
+ eline = urllib.parse.unquote(eline)
+ self.logger.debug(f"Got request to evaluate {eline} (unquoted)")
+ with PrintCapture() as p:
+ try:
+ if eline:
+ exec(eline,g,l)
+ res = ""
+ except Exception as e:
+ res = f"Error '{e}' while evaluating"
+
+ result = ''.join(p.data) + res
+ self.logger.debug(f"{result=}")
+ return result
+
+ @cherrypy.expose
+ def get_code(self, filename=''):
+ """loads and returns the given filename from the defined script path"""
+ self.logger.debug(f"get_code called with {filename=}")
+ try:
+ if self.plugin.executor_scripts is not None and filename != '':
+ filepath = os.path.join(self.plugin.executor_scripts,filename)
+ self.logger.debug(f"{filepath=}")
+ code_file = open(filepath)
+ data = code_file.read()
+ code_file.close()
+ return data
+ except:
+ self.logger.error(f"{filepath} could not be read")
+ return f"### {filename} could not be read ###"
+
+ @cherrypy.expose
+ def save_code(self, filename='', code=''):
+ """save the given code at filename from the defined script path"""
+ self.logger.debug(f"save_code called with {filename=}")
+ try:
+ if self.plugin.executor_scripts is not None and filename != '' and code != '':
+ if '/' in filename or '\\' in filename or '..' in filename:
+ raise ValueError("Special Characters not allowed in filename")
+ if (filename[-3:] != '.py'):
+ filename += '.py'
+ filepath = os.path.join(self.plugin.executor_scripts,filename)
+ self.logger.debug(f"{filepath=}")
+ with open(filepath, "w") as code_file:
+ code_file.write(code)
+ return f"{filename} was saved"
+ except Exception as e:
+ self.logger.error(f"{filepath} could not be saved, {e}")
+ return f"{filename} could not be saved"
+
+ @cherrypy.expose
+ def delete_file(self, filename=''):
+ """deletes the file with given filename from the defined script path"""
+ self.logger.debug(f"delete_file called with {filename=}")
+ try:
+ if self.plugin.executor_scripts is not None and filename != '':
+ filepath = os.path.join(self.plugin.executor_scripts,filename)
+ if os.path.exists(filepath) and os.path.isfile(filepath):
+ os.remove(filepath)
+ self.logger.debug(f"{filepath} successfully deleted")
+ return f"{filepath} successfully deleted"
+ else:
+ self.logger.debug(f"{filepath} was not deleted")
+ except Exception as e:
+ self.logger.error(f"{e}: {filepath} could not be deleted")
+ return f"### {filename} could not be deleted ###"
+
+
+ @cherrypy.expose
+ def get_filelist(self):
+ """returns all filenames from the defined script path with suffix ``.py``"""
+
+ if self.plugin.executor_scripts is not None:
+ subdir = self.plugin.executor_scripts
+ self.logger.debug(f"list files in {subdir}")
+ files = os.listdir(subdir)
+ files = [f for f in files if os.path.isfile(os.path.join(subdir,f))]
+ files = [f for f in files if f.endswith(".py")]
+ files = '\n'.join(f for f in files)
+ self.logger.debug(f"{files=}\n\n")
+ return files
+
+ return ''
+
+ @cherrypy.expose
+ def get_autocomplete(self):
+ _sh = self.plugin.get_sh()
+ plugins = _sh.plugins.get_instance()
+ plugin_list = []
+ for x in plugins.return_plugins():
+ if isinstance(x, SmartPlugin):
+ plugin_config_name = x.get_configname()
+ if x.metadata is not None:
+ api = x.metadata.get_plugin_function_defstrings(with_type=True, with_default=True)
+ if api is not None:
+ for function in api:
+ plugin_list.append("sh."+plugin_config_name + "." + function)
+
+
+ myItems = _sh.return_items()
+ itemList = []
+ for item in myItems:
+ itemList.append("sh."+str(item)+"()")
+ retValue = {'items':itemList,'plugins':plugin_list}
+ return (json.dumps(retValue))
\ No newline at end of file
diff --git a/executor/webif/static/img/plugin_logo.svg b/executor/webif/static/img/plugin_logo.svg
new file mode 100755
index 000000000..467b07b26
--- /dev/null
+++ b/executor/webif/static/img/plugin_logo.svg
@@ -0,0 +1,265 @@
+
+
+
+
diff --git a/executor/webif/templates/index.html b/executor/webif/templates/index.html
index bd32e36be..20bc2ca95 100755
--- a/executor/webif/templates/index.html
+++ b/executor/webif/templates/index.html
@@ -1,130 +1,206 @@
-{% extends "base_plugin.html" %}
+{% extends "base.html" %}
{% set logo_frame = false %}
-{% block headtable %}
-{% endblock headtable %}
+{% block pluginscripts %}
+
+{% endblock pluginscripts %}
-
+
-
+// ************************************************************************
+// registerAutocompleteHelper - seen at Web-Interface of logics from shNG
+// ************************************************************************
+function registerAutocompleteHelper(name, curDict) {
+ CodeMirror.registerHelper('hint', name, function(editor) {
+ cur = editor.getCursor();
+ curLine = editor.getLine(cur.line);
+ var start = cur.ch,
+ end = start;
+ console.log('Autocomplete called - autocompleteHint')
+ var charexp = /[\w\.$]+/;
+ while (end < curLine.length && charexp.test(curLine.charAt(end))) ++end;
+ while (start && charexp.test(curLine.charAt(start - 1))) --start;
+ var curWord = start != end && curLine.slice(start, end);
+ if (curWord.length > 1) {
+ curWord = curWord.trim();
+ }
-
+{%- endblock content %}
diff --git a/gpio/README.md b/gpio/README.md
deleted file mode 100755
index 0491dfc62..000000000
--- a/gpio/README.md
+++ /dev/null
@@ -1,19 +0,0 @@
-# GPIO
-
-## Configuration
-
-Information can be found at the [Configuration Documentation](https://www.smarthomeng.de/user/plugins_doc/config/gpio.html)
-
-## Changelog
-1.0
-- initial release
-
-1.0.1
-- Changed event detection from constant polling to GPIO.add_event_detect
-
-1.4.2
-- added parameter support for GPIO pull-up/pull-down configuration (global / per
- item)
-- changed startup code to prevent unwanted output changes
-- cleaned up code, removed unnecessary parts
-
diff --git a/gpio/__init__.py b/gpio/__init__.py
index 635fe53dc..2444343ef 100755
--- a/gpio/__init__.py
+++ b/gpio/__init__.py
@@ -35,7 +35,7 @@ class GPIO(SmartPlugin, Utils):
Main class of the plugin.
'''
- PLUGIN_VERSION = '1.5.2'
+ PLUGIN_VERSION = '1.5.4'
ALLOW_MULTIINSTANCE = False
def __init__(self, sh):
diff --git a/gpio/assets/webif-gpio.png b/gpio/assets/webif-gpio.png
new file mode 100755
index 000000000..5ae4060dc
Binary files /dev/null and b/gpio/assets/webif-gpio.png differ
diff --git a/gpio/plugin.yaml b/gpio/plugin.yaml
index b99b2572e..a222fe667 100755
--- a/gpio/plugin.yaml
+++ b/gpio/plugin.yaml
@@ -6,7 +6,7 @@ plugin:
de: 'GPIO-Unterstützung für Rasberry Pi, **seit SmartHomeNG v1.3**'
en: 'GPIO support for Raspberry Pi, **since SmarthomeNG v1.3**'
description_long:
- de: 'GPIO-Unterstützung für den Rasberry Pi.\n
+ de: 'GPIO-Unterstützung für den Raspberry Pi.\n
Dieses Plugin unterstützt über das RPi.GPIO-Modul das Einbinden von externen Sensoren und Aktoren,
die direkt am Raspberry Pi angeschlossen werden. Damit ist es beispielsweise möglich,
den Zustand von Reedkontakten einzulesen oder LEDs zu aktivieren und beispielsweise eine
@@ -24,12 +24,13 @@ plugin:
maintainer: onkelandy
tester: cmalo, ohinckel, morg
state: ready
+ support: https://knx-user-forum.de/forum/supportforen/smarthome-py/1842450-support-thread-f%C3%BCr-das-gpio-plugin
requirements:
de: 'RPi.GPIO Python Modul'
en: 'RPi.GPIO python module'
keywords: iot gpio raspberrypi
- version: 1.5.2 # Plugin version
+ version: 1.5.4 # Plugin version
sh_minversion: 1.4 # minimum shNG version to use this plugin
multi_instance: false # plugin supports multi instance
restartable: unknown
@@ -93,6 +94,7 @@ parameters:
Define the global preset for pullup/pulldown settings. This can be overridden
individually by the corresponding item option.
'
+
item_attributes:
# Definition of item attributes defined by this plugin
gpio_in:
diff --git a/gpio/user_doc.rst b/gpio/user_doc.rst
new file mode 100755
index 000000000..b04e129fc
--- /dev/null
+++ b/gpio/user_doc.rst
@@ -0,0 +1,40 @@
+.. index:: Plugins; gpio
+.. index:: gpio
+
+====
+gpio
+====
+
+.. image:: webif/static/img/plugin_logo.png
+ :alt: plugin logo
+ :width: 1000px
+ :height: 472px
+ :scale: 30 %
+ :align: left
+
+Konfiguration
+=============
+
+Die Informationen zur Konfiguration des Plugins sind unter :doc:`/user/plugins_doc/config/gpio` beschrieben.
+
+Beschreibung
+============
+
+GPIO-Unterstützung für den Raspberry Pi. Dieses Plugin unterstützt über das RPi.GPIO-Modul das Einbinden von externen Sensoren und Aktoren, die direkt am Raspberry Pi angeschlossen werden. Damit ist es beispielsweise möglich, den Zustand von Reedkontakten einzulesen oder LEDs zu aktivieren.
+
+
+Web Interface
+=============
+
+Das Plugin Webinterface kann aus dem Admin Interface aufgerufen werden. Dazu auf der Seite Plugins in der entsprechenden
+Zeile das Icon in der Spalte **Web Interface** anklicken.
+
+Darunter gibt es für Ein- und Ausgänge je einen Tab mit Informationen zu den Items, die das GPIO Plugin
+implementiert haben, den Pin, Wert und die Initialisierungszeit (nur bei IN Pins).
+
+.. image:: assets/webif-gpio.png
+ :class: screenshot
+ :width: 2022px
+ :height: 984px
+ :scale: 40 %
+ :align: center
diff --git a/gpio/webif/__init__.py b/gpio/webif/__init__.py
index 93feaad06..356e02a23 100755
--- a/gpio/webif/__init__.py
+++ b/gpio/webif/__init__.py
@@ -70,11 +70,12 @@ def index(self, action=None, item_id=None, item_path=None, reload=None):
:return: contents of the template after beeing rendered
'''
- # item = self.plugin.get_sh().return_item(item_path)
+ pagelength = self.plugin.get_parameter_value('webif_pagelength')
tmpl = self.tplenv.get_template('index.html')
# 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,
language=self.plugin._sh.get_defaultlanguage(), now=self.plugin.shtime.now())
@cherrypy.expose
diff --git a/gpio/webif/templates/index.html b/gpio/webif/templates/index.html
index e320daf81..ecf7ac3d6 100755
--- a/gpio/webif/templates/index.html
+++ b/gpio/webif/templates/index.html
@@ -15,10 +15,27 @@
+
{% else %}
@@ -150,8 +199,8 @@
{{ _('Verbunden') }}
- 
+ {% elif isfile("static/img/plugin_logo.jpg") %}
+ 
+ {% elif isfile("static/img/plugin_logo.svg") %}
+ 
+ {% else %}
+ {% set plgtype_logo = "/gstatic/img/plugin_"+p._plgtype+".svg" %}
+ {% if isfile(plgtype_logo) %}
+ 
+ {% endif %}
+ {% endif %}
+ 