Skip to content

Commit

Permalink
Update releasenotes and Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
msinn committed Aug 29, 2023
1 parent d8de72b commit a3dd45c
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ Es gibt eine Dokumentations-Datei die für ein Plugin erstellt werden kann (und
restliche Dokumentation sollte nur noch im ``user_doc.rst``-Format erfolgen.

Soweit möglich, sollten bestehende ``README.md`` im Rahmen von Aktualisierungen in entsprechende ``user_doc.rst``
überführt werden.
überführt werden. Wenn alle Informationen, die in der ``README.md`` enthalten waren, entweder in der automatisch
generierten Seite mit Konfigurationsinformationen oder in der ``user_doc.rst`` enhalten sind, ist die Datei
``README.md`` zu löschen.


user_doc.rst
Expand Down
61 changes: 44 additions & 17 deletions doc/user/source/release/1_10.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ sowie einige neue Plugins.

Diese Release Notes sind ein Arbeitsstand.

- Berücksichtigt sind Commits im smarthome Repository bis incl. 26. August 2023
(...)
- Berücksichtigt sind Commits im plugins Repository bis incl. 21. August 2023
- Berücksichtigt sind Commits im smarthome Repository bis incl. 29. August 2023
(Bugfix in dict handling)
- Berücksichtigt sind Commits im plugins Repository bis incl. 28. August 2023
(...)


Expand Down Expand Up @@ -67,21 +67,16 @@ Allgmein
Updates im CORE
---------------

* bin.smarthome: Replaced th deprecated function getdefaultlocale()

* Items:

* ...

* Logics:
* bin.smarthome:

* ...
* Replaced th deprecated function getdefaultlocale()

* Libs:

* lib.backup:

* Added structs directory to configuration backup and restore
* Added structs directory to configuration backup and restore
* Included requirements.txt file for userfunctions and logics

* lib.db:

Expand Down Expand Up @@ -115,6 +110,7 @@ Updates im CORE
* structs: Implemented automatic migration from /etc to /structs
* eval on trigger only implemented
* Initial support for access to elements of list and dict items
* Bugfix in dict handling

* lib.log:

Expand All @@ -134,14 +130,21 @@ Updates im CORE

* Added SmartDevicePlugin (sdp) and documentation
* sdp:

* Add standby mode
* 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()
* Update sdp serial connections
* SmartPlugin:

* move suspend/resume function to smartplugin
* Suspend/resume API für SmartPlugin
* New parameter 'mode' for get_item_list() implemented

* MqttPlugin:

* Fixed implementation of webinterface

* lib.network:

Expand All @@ -164,6 +167,8 @@ Updates im CORE
* lib.shpypi:

* Small updates for changed messages of pip commend
* Included userfunctions and logics. Directories for both can contain a requirements.txt file which is
now loaded and interpreted

* lib.shtime:

Expand Down Expand Up @@ -278,6 +283,7 @@ Für Details zu den neuen Plugins, bitte die Dokumentation des jeweiligen Plugin
http://www.smarthomeng.de/user/plugins_all.html konsultieren.

* denon: For Denon AV Receivers, based on SmartDevicePlugin
* epson: Based on SDP control of Epson projectors are supported (minimal setup for now)
* 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
Expand Down Expand Up @@ -393,6 +399,7 @@ http://www.smarthomeng.de/user/plugins_all.html konsultieren.
* Support RFC2217 connections
* Expanded user documentation
* Added serial/ethernet connection status to webinterface
* Clean-up logging import and unused argument of init function

* executor:

Expand All @@ -409,6 +416,8 @@ http://www.smarthomeng.de/user/plugins_all.html konsultieren.
* Introduce example scripts that can be loaded in the web interface
* Change order of file list
* Improve button enable/disable
* Removed duplicate scroolbars from webinterface
* Bump to v1.2.1

* gpio:

Expand Down Expand Up @@ -438,15 +447,31 @@ http://www.smarthomeng.de/user/plugins_all.html konsultieren.
* knx:

* Prevent send actions to bus while plugin is not running
* Fix issue with polling knx items on startup. All polls are put in a waiting list and polled on run only.
* Fix issue with polling knx items on startup. All polls are put in a waiting list and polled on run only
* Corrected a translation

* modbus_tcp:

* Fixed bug

* neato:

* Clean-up unused argument of init function

* network:

* Remove debug print

* nut:

* Added user_doc, default logo and refined plugin.yaml
* Clean-up unused argument of init function, switched to parameter import via method get_parameter_value()
* Bugfix for exception that can occur during termination of the plugin

* philips_tv:

* Added support for ambilight control
* Clean-up unused argument of init method

* pioneer:

Expand All @@ -472,6 +497,7 @@ http://www.smarthomeng.de/user/plugins_all.html konsultieren.
* resol:

* Improved user_doc
* Clean-up unused argument of init method

* rpi_info:

Expand All @@ -494,6 +520,7 @@ http://www.smarthomeng.de/user/plugins_all.html konsultieren.
* 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
* Clean-up unused argument of init method

* sonos:

Expand Down
1 change: 1 addition & 0 deletions doc/user/source/was_ist_neu.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ Neuerungen bei Plugins

Bei den Plugins sind folgende Änderungen zu beachten:

- **Plugin shelly**: Es werden jetzt Shelly Devices mit dem (neuen) Gen2 API untersützt.
- **Plugin smartvisu**: Der Default Wert des Parameters **generate_pages** wurde auf **False** geändert. Zum
generieren von Seiten muss dieser Parameter nun aktiv konfiguriert werden.
- Es sind auch einige :ref:`neue Plugins <releasenotes_1_10_neue_plugins>` hinzugekommen.
Expand Down

0 comments on commit a3dd45c

Please sign in to comment.