Skip to content

Commit

Permalink
Documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
msinn committed May 22, 2024
1 parent a5c5f9a commit 7afce66
Show file tree
Hide file tree
Showing 3 changed files with 130 additions and 132 deletions.
1 change: 1 addition & 0 deletions doc/user/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ oder im `Chat auf gitter.im <https://gitter.im/smarthomeNG/smarthome>`_ .

einleitung.md
was_ist_neu.rst
was_war_neu.rst
installation/installation.rst
konfiguration/konfiguration.rst
plugins_all.rst
Expand Down
134 changes: 2 additions & 132 deletions doc/user/source/was_ist_neu.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
:tocdepth: 2

===========================
Neuerungen im Release v1.11
===========================

Expand All @@ -18,16 +17,13 @@ diesem und den vorangegangenen Releases ist den :doc:`Release Notes </release/re

|
Neuerungen im Release v1.11.1
=============================

*Hier kommen die Neuerungen des Releases v1.11.1 hin.*

.. comment
Neuerungen im Release v1.11.x
-----------------------------
*Hier kommen die Neuerungen des Releases v1.11.1 hin.*
...
Ab dem Release v1.9.4 misst SmartHomeNG beim ersten Start die Geschwindigkeit der CPU, um je nach Geschwindigkeit
Expand All @@ -54,129 +50,3 @@ Neuerungen im Release v1.11.1
`--config_etc` aktiviert. Dies muss bei jedem Start angegeben werden.
===============================
Neuerungen der letzten Releases
===============================

Hier sind die wichtigsten Neuerungen in den Letzten Releases:

Neuerungen im Release v1.10
===========================

Hier ist eine Kurzübersicht über größere Neuerungen im aktuellen Release. Eine vollständige Übersicht der Änderungen in
diesem und den vorangegangenen Releases ist den :doc:`Release Notes </release/release>` zu finden.

- **Python Environment**: SmartHomeNG sollte/muss in einem virtuellen Python Environment laufen.

- **postinstall Skript**: Ab Debian 12/Python 3.11 können in die systemseitige Installation nicht mehr beliebig
Python Packages installiert werden. Es gibt jetzt ein neues Skript ``tools/postinstall`` welches ein Standard
Environment anlegt, in dem SmartHomeNG später läuft/laufen soll.
(Siehe auch :doc:`Komplettanleitung </installation/komplettanleitung/02_smarthomeng>`)

- **virtuelle Environments**: Skripte zum Anlegen und Aktivieren von virtuellen Python Environments
- **Items**:

- **Hysterese**: Es gibt neue Attribute, die es ermöglichen ein Item als Hysterese-Glied mit optionalem Zeitlied
zu konfigurieren.
- **Attribute**: In den Attributen **autotimer** und **cycle** können nun eval Ausdrücke
in der Konfiguration genutzt werden. Bisher waren nur konstante Werte und alternativ Item Referenzen
möglich
- **Platzhalter in Attributen**: Es ist jetzt möglich innerhalb von Attributwerten über Platzhalter die
Inhalte anderer Attribute zu verwenden.
Details sind in der :ref:`Dokumentation <Platzhalter_in_Attributwerten>` 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 <Zugriff_auf_Attributwerte>` zu finden.
- **Structs**:

- **Verschachtelung**: Es ist jetzt eine beliebige Verschachtelung von structs möglich. stucts können auch
auf Unterebenen einer stuct eingebunden werden.
- **relative Referenzen**: Bei der Einbindung von Sub-Structs aus der selben Datei können jetzt relative
Angaben gemacht werden.
- **structs Verzeichnis**: Dateien mit struct Definitionen werden jetzt im Verzeichnis ``../structs`` abgelegt.
Bestehende Definitionsdateien werden automatisch aus dem ``../etc`` Verzeichnis in das ``../structs`` Verzeichnis
migriert.
- **Plugins**:

- **Installation**: Falls eine neuere Version eines Plugins aus dem develop Branch auf GitHub installiert werden
soll, ohne deshalb die eigene Installation vollständig auf die (nicht notwendigerweise stabile) develop Version
von SmartHomeNG umzustellen, wurde ein Skript erstellt. Dieses Skript installiert ein gewähltes Plugin aus dem
develop branch zusätzlich in die aktuelle Installation von SmartHomeNG.
Details sind in der Dokumentation unter :ref:`Tipps & Tricks <Plugin_aus_develop>` zu finden.

- **Neue Bibliothek lib.env**:

- lib.env enthält eine Reihe von Funktionen zur Maßeinheitenumrechnung für Environment Daten, sowie weitere
Funktionen welche den Umgang mit Environment Informationen unterstützen.
Details sind in der :doc:`Dokumentation </lib/env>` zu finden.
- Die Funktionen können in Logiken und eval Statements in Item Attributen einfach mit ``env.<Funktion>``
aufgerufen werden.
- **Admin GUI**:

- **Logiken**:

- Die Liste der Logiken kann nun gruppiert angezeigt werden. Logiken können einer oder mehreren
Gruppen zugeordnet werden.
- Zu Logiken kann nun eine Beschreibung erfasst werden. Diese wird in der Liste der Logiken, sowie zu den
verbundenen Logiken in den Item-Details angezeigt.
- Zu den Gruppen können eine Titelzeile und eine Beschreibung gepflegt werden.
- **Systemeigenschaften**: Die Resource Graphen der Systemdaten funktionieren jetzt auch, ohne dass das smartvisu
Plugin konfiguriert sein muss.
- **Items**: Es ist jetzt möglich die Veränderung des Werte von mehreren Items in einer Tabelle live zu
überwachen.

Details zu den genannten Punkten sind in den Abschnitten :doc:`Konfiguration </konfiguration/konfiguration>`
bzw. :doc:`Referenz </referenz/referenz>` zu finden.

Die vollständigen Änderungen am Core können in den :ref:`Release Notes v1.10 <Änderungen_am_core>` nachgelesen
werden.

|
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.

Die vollständigen Änderungen bei Plugins können in den Release Notes in den Abschnitten

- :ref:`neue Plugins <releasenotes_1_10_neue_plugins>`
- :ref:`Updates zu bestehenden Plugins <releasenotes_1_10_updates_plugins>`
- :ref:`veraltete/retired Plugins <releasenotes_1_10_retired_plugins>`

nachgelesen werden.

|
Neuerungen für Plugin Entwickler
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Für Entwickler von Plugins gibt es folgende Neuerungen:

- **SmartPlugin**: Die Klasse SmartPlugin ist in der Funktionalität erweitert worden
- **SmartDevicePlugin**: Das SmartDevicePlugin (sdp) ist aus der Notwendigkeit geboren, für jedes neue Plugin und
jedes neue Gerät aufs Neue das ganze Kern-Plugin neu zu erfinden - Item-Handling, Zuordnung von Items zu Befehlen
(commands) und Kommunikation mit Netzwerk- oder seriellen Treibern oder Libraries.
- **lib.env**: Neue Bibliothek zum Umgang mit Environment Daten.
Details sind in der :doc:`Dokumentation </lib/env>` zu finden


Details zu den genannten Punkten sind in den Abschnitten :doc:`Entwicklung </entwicklung/entwicklung>`
bzw. :doc:`Referenz </referenz/referenz>` zu finden.

|
Tipps & Tricks
--------------

Folgende Tipps sind in der Doku hinzugekommen:

- :ref:`Ein Plugin aus develop installieren <Plugin_aus_develop>`
- :ref:`SmartHomeNG umziehen <shng_umziehen>`

|
127 changes: 127 additions & 0 deletions doc/user/source/was_war_neu.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@

===============================
Neuerungen der letzten Releases
===============================

Hier sind die wichtigsten Neuerungen aus den Letzten Releases:

Neuerungen im Release v1.10
===========================

Hier ist eine Kurzübersicht über größere Neuerungen im aktuellen Release. Eine vollständige Übersicht der Änderungen in
diesem und den vorangegangenen Releases ist den :doc:`Release Notes </release/release>` zu finden.

- **Python Environment**: SmartHomeNG sollte/muss in einem virtuellen Python Environment laufen.

- **postinstall Skript**: Ab Debian 12/Python 3.11 können in die systemseitige Installation nicht mehr beliebig
Python Packages installiert werden. Es gibt jetzt ein neues Skript ``tools/postinstall`` welches ein Standard
Environment anlegt, in dem SmartHomeNG später läuft/laufen soll.
(Siehe auch :doc:`Komplettanleitung </installation/komplettanleitung/02_smarthomeng>`)

- **virtuelle Environments**: Skripte zum Anlegen und Aktivieren von virtuellen Python Environments
- **Items**:

- **Hysterese**: Es gibt neue Attribute, die es ermöglichen ein Item als Hysterese-Glied mit optionalem Zeitlied
zu konfigurieren.
- **Attribute**: In den Attributen **autotimer** und **cycle** können nun eval Ausdrücke
in der Konfiguration genutzt werden. Bisher waren nur konstante Werte und alternativ Item Referenzen
möglich
- **Platzhalter in Attributen**: Es ist jetzt möglich innerhalb von Attributwerten über Platzhalter die
Inhalte anderer Attribute zu verwenden.
Details sind in der :ref:`Dokumentation <Platzhalter_in_Attributwerten>` 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 <Zugriff_auf_Attributwerte>` zu finden.
- **Structs**:

- **Verschachtelung**: Es ist jetzt eine beliebige Verschachtelung von structs möglich. stucts können auch
auf Unterebenen einer stuct eingebunden werden.
- **relative Referenzen**: Bei der Einbindung von Sub-Structs aus der selben Datei können jetzt relative
Angaben gemacht werden.
- **structs Verzeichnis**: Dateien mit struct Definitionen werden jetzt im Verzeichnis ``../structs`` abgelegt.
Bestehende Definitionsdateien werden automatisch aus dem ``../etc`` Verzeichnis in das ``../structs`` Verzeichnis
migriert.
- **Plugins**:

- **Installation**: Falls eine neuere Version eines Plugins aus dem develop Branch auf GitHub installiert werden
soll, ohne deshalb die eigene Installation vollständig auf die (nicht notwendigerweise stabile) develop Version
von SmartHomeNG umzustellen, wurde ein Skript erstellt. Dieses Skript installiert ein gewähltes Plugin aus dem
develop branch zusätzlich in die aktuelle Installation von SmartHomeNG.
Details sind in der Dokumentation unter :ref:`Tipps & Tricks <Plugin_aus_develop>` zu finden.

- **Neue Bibliothek lib.env**:

- lib.env enthält eine Reihe von Funktionen zur Maßeinheitenumrechnung für Environment Daten, sowie weitere
Funktionen welche den Umgang mit Environment Informationen unterstützen.
Details sind in der :doc:`Dokumentation </lib/env>` zu finden.
- Die Funktionen können in Logiken und eval Statements in Item Attributen einfach mit ``env.<Funktion>``
aufgerufen werden.
- **Admin GUI**:

- **Logiken**:

- Die Liste der Logiken kann nun gruppiert angezeigt werden. Logiken können einer oder mehreren
Gruppen zugeordnet werden.
- Zu Logiken kann nun eine Beschreibung erfasst werden. Diese wird in der Liste der Logiken, sowie zu den
verbundenen Logiken in den Item-Details angezeigt.
- Zu den Gruppen können eine Titelzeile und eine Beschreibung gepflegt werden.
- **Systemeigenschaften**: Die Resource Graphen der Systemdaten funktionieren jetzt auch, ohne dass das smartvisu
Plugin konfiguriert sein muss.
- **Items**: Es ist jetzt möglich die Veränderung des Werte von mehreren Items in einer Tabelle live zu
überwachen.

Details zu den genannten Punkten sind in den Abschnitten :doc:`Konfiguration </konfiguration/konfiguration>`
bzw. :doc:`Referenz </referenz/referenz>` zu finden.

Die vollständigen Änderungen am Core können in den :ref:`Release Notes v1.10 <Änderungen_am_core>` nachgelesen
werden.

|
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.

Die vollständigen Änderungen bei Plugins können in den Release Notes in den Abschnitten

- :ref:`neue Plugins <releasenotes_1_10_neue_plugins>`
- :ref:`Updates zu bestehenden Plugins <releasenotes_1_10_updates_plugins>`
- :ref:`veraltete/retired Plugins <releasenotes_1_10_retired_plugins>`

nachgelesen werden.

|
Neuerungen für Plugin Entwickler
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Für Entwickler von Plugins gibt es folgende Neuerungen:

- **SmartPlugin**: Die Klasse SmartPlugin ist in der Funktionalität erweitert worden
- **SmartDevicePlugin**: Das SmartDevicePlugin (sdp) ist aus der Notwendigkeit geboren, für jedes neue Plugin und
jedes neue Gerät aufs Neue das ganze Kern-Plugin neu zu erfinden - Item-Handling, Zuordnung von Items zu Befehlen
(commands) und Kommunikation mit Netzwerk- oder seriellen Treibern oder Libraries.
- **lib.env**: Neue Bibliothek zum Umgang mit Environment Daten.
Details sind in der :doc:`Dokumentation </lib/env>` zu finden


Details zu den genannten Punkten sind in den Abschnitten :doc:`Entwicklung </entwicklung/entwicklung>`
bzw. :doc:`Referenz </referenz/referenz>` zu finden.

|
Tipps & Tricks
--------------

Folgende Tipps sind in der Doku hinzugekommen:

- :ref:`Ein Plugin aus develop installieren <Plugin_aus_develop>`
- :ref:`SmartHomeNG umziehen <shng_umziehen>`

|

0 comments on commit 7afce66

Please sign in to comment.