public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Documentation] Markdown improvements for bindings a to e (#13859)

Browse Source 
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
Jerome Luckenbach
2022-12-07 21:09:32 +01:00
committed by GitHub
parent 72efc1cfed
commit caf71f72e6
86 changed files with 1740 additions and 1822 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
bundles/org.openhab.binding.dwdunwetter/README_de.md
View File

@@ -7,7 +7,6 @@ Binding zur Abfrage von aktuellen Unwetterwarnungen des Deutschen Wetterdienstes
Das Binding unterstützt genau ein Thing - Unwetterwarnungen.
Ein Thing stellt dabei eine oder mehrere Warnungen für eine Gemeinde bereit.
## Thing Konfiguration
| Property | Standard | Erforderlich | Beschreibung |
@@ -32,16 +31,16 @@ Dies ist bei ca. 300+ Warnungen der Fall.
Beispiel:
```
```java
dwdunwetter:dwdwarnings:koeln "Warnungen Köln" [ cellId="805315000", refresh=15, warningCount=1 ]
```
## Channels
Für jede bereitgestellte Warnung werden mehrere Channels bereitgestellt.
Die Channels sind jeweils durchnummeriert, Channels die mit 1 enden sind für die erste Warnung, Channels die mit 2 enden für die zweite Warnung usw.
Die vom DWD gelieferten Warnungen werden dabei nach Severity (Warnstufe) sortiert und innerhalb der Warnstufe nach Beginndatum.
Dadurch ist sichergestellt, dass in den Channels für die erste Warnung (...1) immer die Warnung mit der höchsten Warnstufe steht.
Für jede bereitgestellte Warnung werden mehrere Channels bereitgestellt.
Die Channels sind jeweils durchnummeriert, Channels die mit 1 enden sind für die erste Warnung, Channels die mit 2 enden für die zweite Warnung usw.
Die vom DWD gelieferten Warnungen werden dabei nach Severity (Warnstufe) sortiert und innerhalb der Warnstufe nach Beginndatum.
Dadurch ist sichergestellt, dass in den Channels für die erste Warnung (...1) immer die Warnung mit der höchsten Warnstufe steht.
Werden mehr Warnungen vom DWD geliefert, als an Channels konfiguriert ist, werden dadurch die Warnungen mit der niedrigsten Warnstufe verworfen.
| Channel | Type | Beschreibung |
@@ -62,27 +61,27 @@ Werden mehr Warnungen vom DWD geliefert, als an Channels konfiguriert ist, werde
Sämtliche Channels sind ReadOnly!
Der Channel _warningN_ dient hauptsächlich dazu, um z.B. in Sitemaps dynamisch Warnungen ein- oder auszublenden, bzw. um in Regeln zu prüfen, ob überhaupt eine Warnung vorliegt.
Er ist nicht geeignet um auf das Erscheinen einer Warnung zu prüfen.
Denn wenn eine Warnung durch eine neue Warnung ersetzt wird, bleibt der Zustand ON, es gibt keinen Zustandswechsel.
Um auf das erscheinen einer Warnung zu prüfen, sollte der Trigger-Channel _updatedN_ genutzt werden.
Der feuert immer dann, wenn eine Warnung das erste mal gesendet wird.
Das heißt, der feuert auch dann, wenn eine Warnung durch eine neue Warnung ersetzt wird.
Der Channel _warningN_ dient hauptsächlich dazu, um z.B. in Sitemaps dynamisch Warnungen ein- oder auszublenden, bzw. um in Regeln zu prüfen, ob überhaupt eine Warnung vorliegt.
Er ist nicht geeignet um auf das Erscheinen einer Warnung zu prüfen.
Denn wenn eine Warnung durch eine neue Warnung ersetzt wird, bleibt der Zustand ON, es gibt keinen Zustandswechsel.
Um auf das erscheinen einer Warnung zu prüfen, sollte der Trigger-Channel _updatedN_ genutzt werden.
Der feuert immer dann, wenn eine Warnung das erste mal gesendet wird.
Das heißt, der feuert auch dann, wenn eine Warnung durch eine neue Warnung ersetzt wird.
Weitere Erläuterungen der Bedeutungen finden sich in der Dokumentation des DWDs unter [CAP DWD Profile 1.2](https://www.dwd.de/DE/leistungen/opendata/help/warnungen/cap_dwd_profile_de_pdf.pdf?__blob=publicationFile&v=7).
Bitte bedenke, dass dieses Binding nur *Gemeinden* unterstützt.
Bitte bedenke, dass dieses Binding nur _Gemeinden_ unterstützt.
## Vollständiges Beispiel
demo.things:
```
```java
dwdunwetter:dwdwarnings:koeln "Warnungen Köln" [ cellId="805315000", refresh=15, warningCount=1 ]
```
demo.items:
```
```java
Switch WarnungKoeln "Warnung vorhanden" { channel="dwdunwetter:dwdwarnings:koeln:warning1" }
String WarnungKoelnServerity "Warnstufe [%s]" { channel="dwdunwetter:dwdwarnings:koeln:severity1" }
String WarnungKoelnBeschreibung "[%s]" { channel="dwdunwetter:dwdwarnings:koeln:description1" }
@@ -99,7 +98,7 @@ String WarningCologneInstruction "Zusatzinformationen: [%s]" { channel="dwdunwet
demo.sitemap:
```
```perl
sitemap demo label="Main Menu" {
Frame {
Text item=WarnungKoelnTitel visibility=[WarnungKoeln==ON]
@@ -110,7 +109,7 @@ sitemap demo label="Main Menu" {
demo.rules
```
```java
rule "Neue Warnung"
when
Channel 'dwdunwetter:dwdwarnings:koeln:updated1' triggered NEW
@@ -119,9 +118,10 @@ then
end
```
dwdunwetter_de.map
```
```text
ON=aktiv
OFF=inaktiv
NULL=undefiniert
@@ -130,7 +130,7 @@ UNDEF=undefiniert
dwdunwetter_severity_de.map
```
```text
Minor=Wetterwarnung
Moderate=Markante Wetterwarnung
Severe=Unwetterwarnung
@@ -141,11 +141,11 @@ UNDEF=undefiniert
dwdunwetter_urgency_de.map
```
```text
Immediate=Warnung
Future=Vorabinformation
NULL=undefiniert
UNDEF=undefiniert
```
Wenn du unsicher bist, ob das Binding korrekt funktioniert, kannst du die Wetterdaten direkt mit deinem Browser abrufen, indem du https://maps.dwd.de/geoserver/dwd/ows?service=WFS&version=2.0.0&request=GetFeature&typeName=dwd:Warnungen_Gemeinden&CQL_FILTER=WARNCELLID%20LIKE%20%27CELL_ID%27 (ersetze `CELL_ID` mit deiner Cell ID) besuchst, den Datei Download zulässt und die heruntergeladene `.xml` Datei öffnest.
Wenn du unsicher bist, ob das Binding korrekt funktioniert, kannst du die Wetterdaten direkt mit deinem Browser abrufen, indem du `https://maps.dwd.de/geoserver/dwd/ows?service=WFS&version=2.0.0&request=GetFeature&typeName=dwd:Warnungen_Gemeinden&CQL_FILTER=WARNCELLID%20LIKE%20%27CELL_ID%27` (ersetze `CELL_ID` mit deiner Cell ID) besuchst, den Datei Download zulässt und die heruntergeladene `.xml` Datei öffnest.