Beispielplugin update
Dieser Abschnitt zeigt ein Beispielplugin. Es kann mit oder ohne Webinterface umgesetzt werden.
Das komplette Plugin mit allen Dateien kann auf github unter https://github.com/smarthomeng/smarthome im /dev-Ordner gefunden werden.
- Note
Diese Dokumentation bezieht sich auf Versionen nach v1.4.2. Sie gilt nicht für Versionen bis inklusive v1.4.2
Auf dieser Seiten finden sich Dateien und Anregungen für neue Plugins. Das Plugin selbst besteht aus einer Datei mit Python-Code (__init__.py), einer Datei mit Metadaten (plugin.yaml) und der Dokumentation (user_doc.rst). Ein Satz Beispieldateien wird weiter unten gezeigt.
Eine formatierte Version der Beispieldokumentation findet sich hier: user_doc.rst
Eine Version im Quelltext als Grundlage für eigene Dokumentationen ist unterhalb der Python-Quellcodes verfügbar.
Die Metadaten-Datei:
plugin.yaml
# Metadata for the plugin
plugin:
# Global plugin attributes
type: unknown # plugin type (gateway, interface, protocol, system, web)
description:
de: 'Beispiel Plugin für SmartHomeNG v1.5 und höher'
en: 'Sample plugin for SmartHomeNG v1.5 and up'
maintainer: <autor>
# tester: # Who tests this plugin?
state: develop # 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
version: 1.0.0 # Plugin version (must match the version specified in __init__.py)
sh_minversion: 1.8 # minimum shNG version to use this plugin
# sh_maxversion: # maximum shNG version to use this plugin (leave empty if latest)
# py_minversion: 3.6 # minimum Python version to use for this plugin
# py_maxversion: # maximum Python version to use for this plugin (leave empty if latest)
multi_instance: false # plugin supports multi instance
restartable: unknown
classname: SamplePlugin # class containing the plugin
parameters:
# Definition of parameters to be configured in etc/plugin.yaml (enter 'parameters: NONE', if section should be empty)
# This parameter should be included if plugin provides a web interface. It lets users configure the standard number of entries per page
webif_pagelength:
type: int
default: 100
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.'
param1:
type: str
description:
de: 'Demo Parameter'
en: 'Parameter for demonstration purposes'
param2:
type: str
default: 'value2'
valid_list:
- 'value1'
- 'value2'
- 'value3'
- 'value4'
- 'value5'
description:
de: 'Demo Parameter mit Gültigkeitsliste und Standardwert'
en: 'Demonstration parameter with valid-list and default value'
param3:
type: str
# If 'mandatory' is specified, a 'default' attribute must not be specified
mandatory: true
description:
de: 'Demo Parameter der angegeben werden muss'
en: 'Demonstration parameter which has to be specified'
item_attributes:
# Definition of item attributes defined by this plugin (enter 'item_attributes: NONE', if section should be empty)
item_structs:
# Definition of item-structure templates for this plugin (enter 'item_structs: NONE', if section should be empty)
#item_attribute_prefixes:
# Definition of item attributes that only have a common prefix (enter 'item_attribute_prefixes: NONE' or ommit this section, if section should be empty)
# NOTE: This section should only be used, if really nessesary (e.g. for the stateengine plugin)
plugin_functions:
# Definition of plugin functions defined by this plugin (enter 'plugin_functions: NONE', if section should be empty)
logic_parameters:
# Definition of logic parameters defined by this plugin (enter 'logic_parameters: NONE', if section should be empty)
Der Quelltext:
__init__.py
#!/usr/bin/env python3
# vim: set encoding=utf-8 tabstop=4 softtabstop=4 shiftwidth=4 expandtab
#########################################################################
# Copyright 2020- <AUTHOR> <EMAIL>
#########################################################################
# 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.8 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 <http://www.gnu.org/licenses/>.
#
#########################################################################
from lib.model.smartplugin import SmartPlugin
from lib.item import Items
from .webif import WebInterface
# If a needed package is imported, which might be not installed in the Python environment,
# add it to a requirements.txt file within the plugin's directory
class SamplePlugin(SmartPlugin):
"""
Main class of the Plugin. Does all plugin specific stuff and provides
the update functions for the items
HINT: Please have a look at the SmartPlugin class to see which
class properties and methods (class variables and class functions)
are already available!
"""
PLUGIN_VERSION = '1.0.0' # (must match the version specified in plugin.yaml), use '1.0.0' for your initial plugin Release
def __init__(self, sh):
"""
Initalizes the plugin.
If you need the sh object at all, use the method self.get_sh() to get it. There should be almost no need for
a reference to the sh object any more.
Plugins have to use the new way of getting parameter values:
use the SmartPlugin method get_parameter_value(parameter_name). Anywhere within the Plugin you can get
the configured (and checked) value for a parameter by calling self.get_parameter_value(parameter_name). It
returns the value in the datatype that is defined in the metadata.
"""
# Call init code of parent class (SmartPlugin)
super().__init__()
# get the parameters for the plugin (as defined in metadata plugin.yaml):
# self.param1 = self.get_parameter_value('param1')
# webif_pagelength should be included in all plugins using a web interface
# It is used to overwrite the default max number of entries per page in the tables
# self.webif_pagelength = self.get_parameter_value('webif_pagelength')
# cycle time in seconds, only needed, if hardware/interface needs to be
# polled for value changes by adding a scheduler entry in the run method of this plugin
# (maybe you want to make it a plugin parameter?)
self._cycle = 60
# Initialization code goes here
# On initialization error use:
# self._init_complete = False
# return
# if plugin should start even without web interface
self.init_webinterface(WebInterface)
# if plugin should not start without web interface
# if not self.init_webinterface():
# self._init_complete = False
return
def run(self):
"""
Run method for the plugin
"""
self.logger.debug("Run method called")
# setup scheduler for device poll loop (disable the following line, if you don't need to poll the device. Rember to comment the self_cycle statement in __init__ as well)
self.scheduler_add('poll_device', self.poll_device, cycle=self._cycle)
self.alive = True
# if you need to create child threads, do not make them daemon = True!
# They will not shutdown properly. (It's a python bug)
def stop(self):
"""
Stop method for the plugin
"""
self.logger.debug("Stop method called")
self.scheduler_remove('poll_device')
self.alive = False
def parse_item(self, 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 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.
"""
if self.has_iattr(item.conf, 'foo_itemtag'):
self.logger.debug(f"parse item: {item}")
# todo
# if interesting item for sending values:
# self._itemlist.append(item)
# return self.update_item
def parse_logic(self, logic):
"""
Default plugin parse_logic method
"""
if 'xxx' in logic.conf:
# self.function(logic['name'])
pass
def update_item(self, item, caller=None, source=None, dest=None):
"""
Item has been updated
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():
# code to execute if the plugin is not stopped
# and only, if the item has not been changed by this this plugin:
self.logger.info(f"Update item: {item.property.path}, item has been changed outside this plugin")
if self.has_iattr(item.conf, 'foo_itemtag'):
self.logger.debug(f"update_item was called with item {item.property.path} from caller {caller}, source {source} and dest {dest}")
pass
def poll_device(self):
"""
Polls for updates of the device
This method is only needed, if the device (hardware/interface) does not propagate
changes on it's own, but has to be polled to get the actual status.
It is called by the scheduler which is set within run() method.
"""
# # get the value from the device
# device_value = ...
#
# # find the item(s) to update:
# for item in self.sh.find_items('...'):
#
# # update the item by calling item(value, caller, source=None, dest=None)
# # - value and caller must be specified, source and dest are optional
# #
# # The simple case:
# item(device_value, self.get_shortname())
# # if the plugin is a gateway plugin which may receive updates from several external sources,
# # the source should be included when updating the the value:
# item(device_value, self.get_shortname(), source=device_source_id)
pass
Das Webinterface (template file):
Das Template hat bis zu fünf Inhaltsblöcke, die mit den Daten des Plugins befüllt werden können:
Kopfdaten auf der rechten Seite
{% block headtable %}Tab 1 der Hauptteils der Seite
{% block bodytab1 %}Tab 2 der Hauptteils der Seite
{% block bodytab2 %}Tab 3 der Hauptteils der Seite
{% block bodytab3 %}Tab 4 der Hauptteils der Seite
{% block bodytab4 %}
Die Anzahl der anzuzeigenden bodytab-Blöcke wird mit der folgenden Anweisung festgelegt:
{% set tabcount = 4 %}
templates/index.html
{% extends "base_plugin.html" %}
{% set logo_frame = false %}
<!-- set update_interval to a value > 0 (in milliseconds) to enable periodic data updates -->
{% set update_interval = 0 %}
<!--
Additional styles go into this block. Examples are for datatables
-->
{% block pluginstyles %}
<style>
table th.value {
width: 100px;
}
These are used for highligt effect in web interface when a value changes. If you don't want to overwrite the
default color, you can remove the entries here as the classes are already defined in smarthomeng.css
*/
.shng_effect_highlight {
background-color: #FFFFE0;
}
.shng_effect_standard {
background-color: none;
}
</style>
{% endblock pluginstyles %}
<!--
Additional script tag for plugin specific javascript code go into this block
-->
{% block pluginscripts %}
<script>
function handleUpdatedData(response, dataSet=null) {
if (dataSet === 'devices_info' || dataSet === null) {
var objResponse = JSON.parse(response);
myProto = document.getElementById(dataSet);
for (item in objResponse) {
/*
Parameters for shngInsertText:
0: mandatory, ID of the HTML element, e.g. the table cell
1: mandatory, Value to be written - taken from the objResponse dict
2: optional, If element of parameter 0 is in a (data)table, the ID of the table has to be put here
3: optional, If you want a visual highlight effect when a value changes, provide the duration in seconds.
shngInsertText (item+'_value', objResponse[item]['value'], 'maintable', 5);
*/
}
}
}
</script>
<!--
This part is used to implement datatable JS for the tables. It allows resorting tables by column, etc.
For each table you have to implement the code part $('#<table_id>').DataTable(..); where the <table_id> matches the id of a table tag
-->
<script>
$(document).ready( function () {
/*
loading defaults from /modules/http/webif/gstatic/datatables/datatables.defaults.js
You can copy that file, put it in your plugin directory, rename the "bind" function and
trigger that function here instead of datatables_defaults if you want to change the behaviour.
Of course you can also overwrite defaults by putting the option declarations in {} below.
*/
$(window).trigger('datatables_defaults');
try {
/* get pagelength from plugin. Also see hidden span element in headtable block! */
webif_pagelength = parseInt(document.getElementById('webif_pagelength').innerHTML);
if (webif_pagelength == 0) {
resize = true;
webif_pagelength = -1;
}
else {
resize = false;
}
}
catch (e) {
webif_pagelength = 100;
resize = false;
console.log("Using default values for page length " + webif_pagelength + ", pageResize: " + resize);
}
try {
/*
Copy this part for every datatable on your page. Adjust options if necessary.
pageLength and pageResize should be included as they are to adjust it based on the plugin settings
*/
table = $('#maintable').DataTable( {
/* If you want to define your own columnDefs options (e.g. for hiding a column by default), use the concat function shown here.
columnDefs: [{ "targets": [8], "className": "none"}].concat($.fn.dataTable.defaults.columnDefs),
*/
pageLength: webif_pagelength,
pageResize: resize});
}
catch (e) {
console.log("Datatable JS not loaded, showing standard table without reorder option " + e);
}
});
</script>
{% endblock pluginscripts %}
{% block headtable %}
<!--
This span needs to be put somewhere on the page to read the table pagelength from the plugin / users' plugin.yaml
-->
<span id='webif_pagelength' style="display:none">{{ webif_pagelength }}</span>
<table class="table table-striped table-hover">
<tbody>
<tr>
<td class="py-1"><strong>Prompt 1</strong></td>
<td class="py-1">{% if 1 == 2 %}{{ _('Ja') }}{% else %}{{ _('Nein') }}{% endif %}</td>
<td class="py-1" width="50px"></td>
<td class="py-1"><strong>Prompt 4</strong></td>
<td class="py-1">{{ _('Wert 4') }}</td>
<td class="py-1" width="50px"></td>
</tr>
<tr>
<td class="py-1"><strong>Prompt 2</strong></td>
<td class="py-1">{{ _('Wert 2') }}</td>
<td></td>
<td class="py-1"><strong>Prompt 5</strong></td>
<td class="py-1">-</td>
<td></td>
</tr>
<tr>
<td class="py-1"><strong>Prompt 3</strong></td>
<td class="py-1">-</td>
<td></td>
<td class="py-1"><strong>Prompt 6</strong></td>
<td class="py-1">-</td>
<td></td>
</tr>
</tbody>
</table>
{% endblock headtable %}
<!--
Additional buttons for the web interface (if any are needed) - displayed below the headtable-section
-->
{% block buttons %}
{% if 1==2 %}
<div>
<button id="btn1" class="btn btn-shng btn-sm" name="scan" onclick="shngPost('', {learn: 'on'})"><i class="fas fa-question"></i> {{ _('nach Devices suchen') }} </button>
</div>
{% endif %}
{% endblock %}
<!--
Define the number of tabs for the body of the web interface (1 - 6)
-->
{% set tabcount = 4 %}
<!--
Set the tab that will be visible on start, if another tab that 1 is wanted (1 - 3)
-->
{% if item_count==0 %}
{% set start_tab = 2 %}
{% endif %}
<!--
Content block for the first tab of the Webinterface
-->
{% set tab1title = "<strong>" ~ p.get_shortname() ~ " Items</strong> (" ~ item_count ~ ")" %}
{% block bodytab1 %}
<div class="container-fluid m-2 table-resize">
{{ _('Hier kommt der Inhalt des Webinterfaces hin.') }}
<!-- set id accordingly -->
<table id="maintable" class="table table-striped table-hover pluginList dataTableAdditional">
<thead>
<tr>
<th>{{ _('Item') }}</th>
<th class="value">{{ _('Wert') }}</th>
</tr>
</thead>
<tbody>
{% for item in items %}
{% if p.has_iattr(item.conf, '<plugin_attribute>') %}
<tr>
<td class="py-1" id="{{ item._path }}">{{ item._path }}</td>
<td class="py-1" id="{{ item._path }}_value">{{ item() }}</td>
</tr>
{% endif %}
{% endfor %}
</tbody>
</table>
</div>
{% endblock bodytab1 %}
<!--
Content block for the second tab of the Webinterface
-->
{% set tab2title = "<strong>" ~ p.get_shortname() ~ " Geräte</strong> (" ~ device_count ~ ")" %}
{% block bodytab2 %}
{% endblock bodytab2 %}
<!--
Content block for the third tab of the Webinterface
If wanted, a title for the tab can be defined as:
{% set tab3title = "<strong>" ~ p.get_shortname() ~ " Geräte</strong>" %}
It has to be defined before (and outside) the block bodytab3
-->
{% block bodytab3 %}
{% endblock bodytab3 %}
<!--
Content block for the fourth tab of the Webinterface
If wanted, a title for the tab can be defined as:
{% set tab4title = "<strong>" ~ p.get_shortname() ~ " Geräte</strong>" %}
It has to be defined before (and outside) the block bodytab4
-->
{% block bodytab4 %}
{% endblock bodytab4 %}
Die Datei für Mehrsprachigkeit:
locale.yaml
# translations for the web interface
plugin_translations:
# Translations for the plugin specially for the web interface
'Wert 2': {'de': '=', 'en': 'Value 2'}
'Wert 4': {'de': '=', 'en': 'Value 4'}
# Alternative format for translations of longer texts:
'Hier kommt der Inhalt des Webinterfaces hin.':
de: '='
en: 'Here goes the content of the web interface.'
Die Dokumentation:
Die folgende Datei skizziert den Mindestumfang für die Plugin-Dokumentation.
user_doc.rst
.. index:: Plugins; sample
.. index:: sample
======
sample
======
.. image:: webif/static/img/plugin_logo.png
:alt: plugin logo
:width: 300px
:height: 300px
:scale: 50 %
:align: left
Anforderungen
-------------
Anforderungen des Plugins auflisten. Werden spezielle Soft- oder Hardwarekomponenten benötigt?
Notwendige Software
~~~~~~~~~~~~~~~~~~~
* die
* benötigte
* Software
* auflisten
Dies beinhaltet Python- und SmartHomeNG-Module
Unterstützte Geräte
~~~~~~~~~~~~~~~~~~~
* die
* unterstütze
* Hardware
* auflisten
Konfiguration
-------------
plugin.yaml
~~~~~~~~~~~
Bitte die Dokumentation lesen, die aus den Metadaten der plugin.yaml erzeugt wurde.
items.yaml
~~~~~~~~~~
Bitte die Dokumentation lesen, die aus den Metadaten der plugin.yaml erzeugt wurde.
logic.yaml
~~~~~~~~~~
Bitte die Dokumentation lesen, die aus den Metadaten der plugin.yaml erzeugt wurde.
Funktionen
~~~~~~~~~~
Bitte die Dokumentation lesen, die aus den Metadaten der plugin.yaml erzeugt wurde.
Beispiele
---------
Hier können ausführlichere Beispiele und Anwendungsfälle beschrieben werden.
Web Interface
-------------
Die Datei ``dev/sample_plugin/webif/templates/index.html`` sollte als Grundlage für Webinterfaces genutzt werden. Um Tabelleninhalte nach Spalten filtern und sortieren zu können, muss der entsprechende Code Block mit Referenz auf die relevante Table ID eingefügt werden (siehe Doku).
SmartHomeNG liefert eine Reihe Komponenten von Drittherstellern mit, die für die Gestaltung des Webinterfaces genutzt werden können. Erweiterungen dieser Komponenten usw. finden sich im Ordner ``/modules/http/webif/gstatic``.
Wenn das Plugin darüber hinaus noch Komponenten benötigt, werden diese im Ordner ``webif/static`` des Plugins abgelegt.
Hinweis
Das in früheren Versionen verwendete README-Format für die Dokumentation von Plugins ist veraltet. Ein Großteil der Dokumentation ist in die Metadaten-Dokumentation in plugin.yaml übergegangen. Die restliche Dokumentation sollte nur noch im user_doc-Format erfolgen.
Soweit möglich, sollten bestehende README im Rahmen von Aktualisierungen in entsprechende user_doc überführt werden.