From 9bb301ef01009d93ddc3f027a7ef830deb59f34a Mon Sep 17 00:00:00 2001 From: msinn Date: Mon, 28 Aug 2023 20:07:26 +0200 Subject: [PATCH] Updated release notes --- .../source/referenz/items/item_zugriff.rst | 30 ++-- doc/user/source/release/1_10.rst | 139 +++++++++++++++++- doc/user/source/was_ist_neu.rst | 3 + 3 files changed, 151 insertions(+), 21 deletions(-) diff --git a/doc/user/source/referenz/items/item_zugriff.rst b/doc/user/source/referenz/items/item_zugriff.rst index d52b0614a..8a70461f1 100644 --- a/doc/user/source/referenz/items/item_zugriff.rst +++ b/doc/user/source/referenz/items/item_zugriff.rst @@ -4,6 +4,7 @@ .. role:: greensup .. role:: blacksup +.. _Zugriff_auf_Attributwerte: Zugriff auf die Werte von Items =============================== @@ -36,16 +37,14 @@ konfiguriert ist: ist für das Item ``Kind`` der Pfad ``Oma.Papa.Kind``. Auf den Wert kann folglich über ``sh.Oma.Papa.Kind()`` zugegriffen werden. -| - Wenn ein Item einen komplexen Datentyp (``type: list`` oder ``type: dict``) hat, ist außer dem Zugriff auf den gesamten Item Wert (also die komplette Liste oder das komplette dict) auch der Zugriff auf einzelne Elemente dieser Item Werte möglich. | -Zugriff auf ein Listen-Element -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Zugriff auf ein Listen-Element :redsup:`neu` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Wenn ein Item als Liste konfiguriert ist, kann auf die einzelnen Elemente der Liste über ihre Position zugegriffen werden, wobei 0 die erste Position kennzeichnet. Um z.B. auf das dritte Element einer Liste zuzugreifen, ist der @@ -60,15 +59,15 @@ das vorletzte Element usw. | -Zugriff auf ein Dict-Element -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Zugriff auf ein Dict-Element :redsup:`neu` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Wenn ein Item als Dict konfiguriert ist, kann auf die einzelnen Elemente des Dicts über ihren Key zugegriffen werden. Um z.B. auf das Element mit dem Key **meinWert** eines Dicts zuzugreifen, ist der Syntax folgender: .. code-block:: python - myvar = sh.Oma.Papa.Kind(key='meinWert') + myvar = sh.Oma.Papa.Kind(key='myKey') | @@ -107,8 +106,8 @@ Alle weiteren (namentlich benannten) Parameter dürfen erst danach folgen. | -Schreiben eines Listen-Elements -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Schreiben eines Listen-Elements :redsup:`neu` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Wenn ein Item als Liste konfiguriert ist, kann auf die einzelnen Elemente der Liste über ihre Position zugegriffen werden, wobei 0 die erste Position kennzeichnet. Um z.B. das dritte Element einer Liste zu setzen, ist @@ -125,6 +124,7 @@ Wenn eine Liste vergrößert werden soll, so gibt es die Möglichkeit das neue I anzufügen. Um einen Wert am Ende der Liste anzufügen, ist als **index** der String 'append' anzugeben. + .. code-block:: python sh.Oma.Papa.Kind(, index='append') @@ -134,21 +134,23 @@ Um einen Wert am Anfang der Liste einzufügen, ist als **index** der String 'pre .. code-block:: python - sh.Oma.Papa.Kind(, index='prepent') + sh.Oma.Papa.Kind(, index='prepend') | -Schreiben eines Dict-Elements -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Schreiben eines Dict-Elements :redsup:`neu` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Wenn ein Item als Dict konfiguriert ist, kann auf die einzelnen Elemente des Dicts über ihren Key zugegriffen -werden. Um z.B. auf das Element mit dem Key **meinWert** eines Dicts zu setzen, ist der Syntax folgender: +werden. Um z.B. auf das Element mit dem Key **myKey** eines Dicts zu setzen, ist der Syntax folgender: .. code-block:: python - sh.Oma.Papa.Kind(, key='meinWert') + sh.Oma.Papa.Kind(, key='myKey') + +Falls der Key im dict noch nicht existiert, wird ein neuer Eintrag hinzugefügt. | diff --git a/doc/user/source/release/1_10.rst b/doc/user/source/release/1_10.rst index f421b32bf..a05eaa2b0 100644 --- a/doc/user/source/release/1_10.rst +++ b/doc/user/source/release/1_10.rst @@ -17,9 +17,9 @@ sowie einige neue Plugins. Diese Release Notes sind ein Arbeitsstand. - - Berücksichtigt sind Commits im smarthome Repository bis incl. 31. Juli 2023 - (modules.admin: Bugfix in api_logics) - - Berücksichtigt sind Commits im plugins Repository bis incl. 28. Juli 2023 + - Berücksichtigt sind Commits im smarthome Repository bis incl. 26. August 2023 + (...) + - Berücksichtigt sind Commits im plugins Repository bis incl. 21. August 2023 (...) @@ -79,13 +79,19 @@ Updates im CORE * Libs: + * lib.backup: + + * Added structs directory to configuration backup and restore + * lib.db: * Suppress an error log message, if database is new and empty * lib.env: + * New lib with support functions for environmental calculations * Added descriptions for system logics + * Integration in eval-statements and logics * lib.item: @@ -101,15 +107,29 @@ Updates im CORE * Corrected Call order of __run_attribute_eval() and _cast_duration() for autotimer * Extended configuration options for autotimer (duration) * Corrected Call to __run_attribute_eval() and _cast_duration() for autotimer + * structs: Added relative reference to sub-struct from same file (struct name starts with a period) + * Implemented attributes with variables (attribut reference) in attribute value; attribute references now + include attributes from current item to great-grandparent item + * Allow attribute-vars in name attribute + * Implemented loading structs from ../structs directory + * structs: Implemented automatic migration from /etc to /structs + * eval on trigger only implemented + * Initial support for access to elements of list and dict items * lib.log: * Improvements to logging configuration + * Added import logging.config (to keep mockup core from failing) * lib.logic: * Logic list can now be grouped. Logics can be assigned to one or more groups + * lib.metadata: + + * Changed one loglevel from warning to notice (to test mockup core) + * Added prefix '_' for "internal" attributes to allow using these attributes without warnings + * lib.model: * Added SmartDevicePlugin (sdp) and documentation @@ -118,11 +138,16 @@ Updates im CORE * Added do_before_send method * Update sdp connections for standby * Update standby mode on failed connect and reconnect + * move suspend/resume function to smartplugin + * Suspend/resume API für SmartPlugin + * sdp: Update sdp serial connections + * smartplugin: New parameter 'mode' for get_item_list() * lib.network: * Fix name reference * Small fixes + * Add open method * lib.plugin: @@ -136,11 +161,22 @@ Updates im CORE * Added some error handling * Bugfix for giving parameters to a task via scheduler.add() - * lib.shpypi: Small updates for changed messages of pip commend + * lib.shpypi: + + * Small updates for changed messages of pip commend + * lib.shtime: * Added function to_seconds() which converts a string (e.g. '2h5m25s') to seconds (integer) + * lib.systeminfo: + + * Fix issues with some Mac OS X versions on startup + + * lib.translate: + + * Enhanced translation capabilities + * Modules: * admin: @@ -175,6 +211,10 @@ Updates im CORE * In Logger configuration sub-loggers of a plugin are en-/disabled with the plugin logger * v0.8.17 Implemented load logics from editor page after it has been unloaded due to error * v0.9.1: Adding, changing and deleting of logic-groups implemented + * v0.9.2: In item-details show logic-description for connected logics + * v0.9.3: Fix for display of items/struct templates + + * Caught an error in eval syntax checker, if result could not be converted to json * http: @@ -196,6 +236,11 @@ Updates im CORE * Update documentation.. add info on tooltips, datepicker, cookies, icons * Update sample plugin to include cookies and tooltips * Updates to datatables and pageresize + * Update to base_plugin.html to support bordered tab data + + * mqtt: + + * Added datatype 'dict/str' for subscribing to messages containing a payload with uncertain data type * websocket: @@ -208,7 +253,8 @@ Updates im CORE * tests: - * ... + * Added extended loglevels to mock/core + * Extended mockup core | @@ -235,6 +281,7 @@ http://www.smarthomeng.de/user/plugins_all.html konsultieren. * lms: Logitech Mediaserver / Squeezebox, based on SmartDevicePlugin * pioneer: for Pioneer AV Receivers, based on SmartDevicePlugin * oppo: First version of SmartDevicePlugin based plugin for Oppo UHD players +* byd_bat: Plugin to display data from BYD batteries .. _releasenotes_1_10_updates_plugins: @@ -248,6 +295,7 @@ http://www.smarthomeng.de/user/plugins_all.html konsultieren. * alexarc4shng: * Small bug-fix in Web-IF + * Fixed issues with urlencode * appletv: @@ -263,6 +311,10 @@ http://www.smarthomeng.de/user/plugins_all.html konsultieren. * Clean up user_doc * Improve error handling and logging +* avdevice: + + * Fix dependency function for int/float values + * avm: * raise exception if no connection to fritzdevice, fritzhome or callmonitor is possible @@ -286,10 +338,23 @@ http://www.smarthomeng.de/user/plugins_all.html konsultieren. * Bugfix and Extension of get_hosts * Make use of standard methods of class SmartPlugin for item handling/storage * Improve Fritz_Home + * Exception Classes & Minor Fixes + * FritzHome: Bugfix renewing SID in case SID has expired + * CallMonitor: bugfix join listing thread + * CallMonitor: reconnect if connection is lost + * Bump to 2.0.9 + * CallMonitor: bugfix join counter threads + * FritzHome: Add support for device statistics + * bump to 2.1.0 + +* beolink: + + * Changes to translations * database: * Changed log message, if no cache value was found + * Added option 'no' to valid list of database attribute * db_addon: @@ -325,6 +390,9 @@ http://www.smarthomeng.de/user/plugins_all.html konsultieren. * enocean: * Robustify plugin reaction to loss of Enocean serial device + * Support RFC2217 connections + * Expanded user documentation + * Added serial/ethernet connection status to webinterface * executor: @@ -346,9 +414,26 @@ http://www.smarthomeng.de/user/plugins_all.html konsultieren. * Fix user_doc reference to configuration +* homeconnect: + + * Added requests-oauthlib to requirements + * hue2: * Adjusted requirements for zeroconf package + * Changed requirements for zeroconf + +* husky2: + + * Minor updates + +* ical: + + * Reduced warning log indicating event with no summary entry to info level + +* indego4shng: + + * Update to 4.0.1 including single-key-id login * knx: @@ -359,6 +444,14 @@ http://www.smarthomeng.de/user/plugins_all.html konsultieren. * Fixed bug +* philips_tv: + + * Added support for ambilight control + +* pioneer: + + * Update plugin.yaml to make suspend_item and retry_suspend available. + * piratewthr: * Adjusted log mesages @@ -369,20 +462,42 @@ http://www.smarthomeng.de/user/plugins_all.html konsultieren. * Removed 'database_maxage: 731' from struct items to use default of database plugin * Bumped version to 1.2.0 * Added locals.location to struct + * Reworked structs to use new features + * Modified to use lib.env + +* rcs1000n: + + *Restructure send method and improve try/except clause + +* resol: + + * Improved user_doc * rpi_info: * Update and fix web interface +* shelly: + + * Initial version of plugin with Gen2 api support + * smartvisu: * Changed default value for generate_pages to False * Corrected log message - * only check dir if handling option is set + * Only check dir if handling option is set + * Adjust empty dir handling * solarforecast: * Fallback to smarthomeNG lat/long default values if no plugin specific latitude and longitude values are specified + * Fix for plugin.yaml, lat, lon are now interpreted as strings not numbers (backward compatible) + * Fix for fallback to system location as a plugin default value + * Replaced deprecated sh.now() with method of lib shtime + +* sonos: + + * Improved thread termination; reintroduced old legacy method play_radio * stateengine: @@ -398,6 +513,7 @@ http://www.smarthomeng.de/user/plugins_all.html konsultieren. * Fix for get_petrol_stations(), if tankerkoenig.de did not return any information * Added check for Nonetype results + * Extend error message to show raw response * tasmota: @@ -412,6 +528,9 @@ http://www.smarthomeng.de/user/plugins_all.html konsultieren. * Improve exception handling * Improve clearing retained messages * Revert direct use of _plg_item_dict in WebIF + * Allow unknown tasmota-attrs, move tasmota-attr doc to user_doc.rst + * Improve Exception handling and handling of power messages + * Bump version to 1.5.2 * telegram: @@ -423,6 +542,12 @@ http://www.smarthomeng.de/user/plugins_all.html konsultieren. * Retry sending in case of error (with parameters) * Attempt to catch the exception in the updater +* vacations: + + * Update after start + * Update cycle configurable + * Accept country "Germany" + * Webservices: * Fix for splitting up of autotimer attribute into _value and _time @@ -496,6 +621,6 @@ Dokumentation ------------- * Increase version required for sphinx tabs -* ... +* Updates to example plugin files diff --git a/doc/user/source/was_ist_neu.rst b/doc/user/source/was_ist_neu.rst index a756faea5..bbd4777da 100644 --- a/doc/user/source/was_ist_neu.rst +++ b/doc/user/source/was_ist_neu.rst @@ -33,6 +33,9 @@ diesem und den vorangegangenen Releases ist den :doc:`Release Notes ` zu finden. + - **Zugriff auf Elemente komplexer Items**: Bei Items vom Typ **list** oder **dict** ist es möglich auf einzelne + Elemente zuzugreifen. + Details sind in der :ref:`Dokumentation ` zu finden. - **Neue Bibliothek lib.env**: - lib.env enthält eine Reihe von Funktionen zur Maßeinheitenumrechnung für Environment Daten, sowie weitere