Merge pull request 'dev' (#146 ) from dev into main

Reviewed-on: #146
Merge pull request 'patch-documentation' (#145 ) from patch-documentation into dev
2025-02-05 07:03:00 +00:00 · 2025-02-05 07:01:36 +00:00 · 2025-02-05 08:00:28 +01:00 · 2025-02-05 07:57:46 +01:00 · 2025-01-25 10:43:41 +00:00 · 2025-01-25 10:43:18 +00:00
3 changed files with 179 additions and 30 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@ -1,4 +1,117 @@
-### fix: remove experimental features change copyright (HEAD -> patch-remove-eperimental)
+### ``` Add important usage information for roller shutter control (HEAD -> patch-documentation)
+>Wed, 5 Feb 2025 07:57:46 +0100
+
+>Author: Marko Oldenburg (fhemdevelopment@cooltux.net)
+
+>Commiter: Marko Oldenburg (fhemdevelopment@cooltux.net)
+
+This update includes new sections in both English and German
+explaining the conditions necessary to prevent delayed operation
+of roller shutters when a window contact is opened. The changes
+clarify that for this functionality to work, the roller shutter
+must be open, the sensor should be set to open, and specific
+attributes (ASC_ShuttersPlace and ASC_Self_Defense_Mode) must
+be appropriately configured.
+
+These additions help users understand proper settings required
+for optimal functionality, improving the overall usability
+and effectiveness of the AutoShuttersControl module. The version
+has been updated to v1.0.1 to reflect these enhancements.
+```
+
+
+
+### docs: changelog
+>Sat, 25 Jan 2025 11:14:17 +0100
+
+>Author: Marko Oldenburg (fhemdevelopment@cooltux.net)
+
+>Commiter: Marko Oldenburg (fhemdevelopment@cooltux.net)
+
+
+
+
+### docs: new version
+>Sat, 25 Jan 2025 11:14:01 +0100
+
+>Author: Marko Oldenburg (fhemdevelopment@cooltux.net)
+
+>Commiter: Marko Oldenburg (fhemdevelopment@cooltux.net)
+
+
+
+
+### docs: Changelog
+>Tue, 21 Jan 2025 18:19:54 +0100
+
+>Author: Marko Oldenburg (fhemdevelopment@cooltux.net)
+
+>Commiter: Marko Oldenburg (fhemdevelopment@cooltux.net)
+
+
+
+
+### fix: commandref
+>Tue, 21 Jan 2025 18:19:42 +0100
+
+>Author: Marko Oldenburg (fhemdevelopment@cooltux.net)
+
+>Commiter: Marko Oldenburg (fhemdevelopment@cooltux.net)
+
+
+
+
+### docs: new changelog
+>Tue, 21 Jan 2025 17:19:04 +0100
+
+>Author: Marko Oldenburg (fhemdevelopment@cooltux.net)
+
+>Commiter: Marko Oldenburg (fhemdevelopment@cooltux.net)
+
+
+
+
+### feat: change version
+>Tue, 21 Jan 2025 17:18:12 +0100
+
+>Author: Marko Oldenburg (fhemdevelopment@cooltux.net)
+
+>Commiter: Marko Oldenburg (fhemdevelopment@cooltux.net)
+
+
+
+
+### feat: https://forum.fhem.de/index.php?topic=136510.0
+>Sun, 12 Jan 2025 12:56:08 +0100
+
+>Author: Marko Oldenburg (oldenburg@b1-systems.de)
+
+>Commiter: Marko Oldenburg (oldenburg@b1-systems.de)
+
+
+
+
+### Corrected some typos and missing spaces
+>Thu, 26 Dec 2024 23:30:36 +0100
+
+>Author: riedel2 (riedel2@yahoo.de)
+
+>Commiter: riedel2 (riedel2@yahoo.de)
+
+
+
+
+### docs: Changelog
+>Sat, 12 Oct 2024 07:40:57 +0200
+
+>Author: Marko Oldenburg (fhemdevelopment@cooltux.net)
+
+>Commiter: Marko Oldenburg (fhemdevelopment@cooltux.net)
+
+
+
+
+### fix: remove experimental features change copyright
 >Sat, 12 Oct 2024 07:40:39 +0200

 >Author: Marko Oldenburg (fhemdevelopment@cooltux.net)
@ -30,6 +143,16 @@ change selfdefense condition in SunRiseShuttersAfterTimerFn



+### Update 73_AutoShuttersControl.pm
+>Wed, 9 Nov 2022 22:39:07 +0100
+
+>Author: riedel2 (56700949+riedel2@users.noreply.github.com)
+
+>Commiter: GitHub (noreply@github.com)
+
+added 'roommate' option at inline help for ASC_Down
+
+
 ### Update 73_AutoShuttersControl.pm
 >Sat, 5 Nov 2022 21:52:39 +0100

--- a/FHEM/73_AutoShuttersControl.pm
+++ b/FHEM/73_AutoShuttersControl.pm
@ -822,7 +822,7 @@ __END__
            <td>Current temperature of a configured temperature device, return -100 is no device configured</td>
        </tr>
    </table>
-    </p>
+    <p></p>
    <u>&Uuml;bersicht f&uuml;r das Rollladen-Device mit Parameter&uuml;bergabe</u>
    <ul>
        <code>{ ascAPIget('Getter','ROLLODEVICENAME',VALUE) }</code><br>
@ -835,7 +835,7 @@ __END__
            <td>QueryShuttersPos</td><td>R&uuml;ckgabewert 1 bedeutet das die aktuelle Position des Rollos unterhalb der Valueposition ist. 0 oder nichts bedeutet oberhalb der Valueposition.</td>
        </tr>
    </table>
-    </p>
+    <p></p>
    <u>Data points of the <abbr>ASC</abbr> device</u>
        <p>
            <code>{ ascAPIget('Getter') }</code><br>
@ -870,6 +870,19 @@ __END__
                <td>Is <abbr>ASC</abbr> globally activated?</td>
            </tr>
        </table>
+        <p></p>
+        <u>Important Information for General Use</u>
+        <p>
+            A possibility has been created to prevent the delayed movement of a roller shutter by opening a window contact.  
+            The handle position is determined before the movement, not before the wait time!  
+            The following settings are required for this function:
+            <ul>
+                <li>the roller shutter must be in the open position</i>
+                <li>the sensor must be set to open</i>
+                <li>the attribute ASC_ShuttersPlace must be set to terrace</i>
+                <li>the attribute ASC_Self_Defense_Mode must be set to off</i>
+            </ul> 
+        </p>
 </ul>

 =end html
@ -1046,7 +1059,7 @@ __END__
            <li><strong>ASC_BrightnessSensor - DEVICE[:READING] WERT-MORGENS:WERT-ABENDS</strong> / 'Sensorname[:brightness [400:800]]' Angaben zum Helligkeitssensor mit (Readingname, optional) f&uuml;r die Beschattung und dem Fahren der Rollladen nach brightness und den optionalen Brightnesswerten f&uuml;r Sonnenauf- und Sonnenuntergang. (default: none)</li>
            <a id="AutoShuttersControl-attr-ASC_Down"></a>
            <li><strong>ASC_Down - astro/time/brightness/roommate</strong> - bei astro wird Sonnenuntergang berechnet, bei time wird der Wert aus ASC_Time_Down_Early als Fahrzeit verwendet und bei brightness muss ASC_Time_Down_Early und ASC_Time_Down_Late korrekt gesetzt werden. Der Timer l&auml;uft dann nach ASC_Time_Down_Late Zeit, es wird aber in der Zeit zwischen ASC_Time_Down_Early und ASC_Time_Down_Late geschaut, ob die als Attribut im Moduldevice hinterlegte ASC_brightnessDriveUpDown der Down Wert erreicht wurde. Wenn ja, wird der Rollladen runter gefahren (default: astro)</li>
-            <ul></p>
+            <ul><p></p>
                <strong><u>Beschreibung der besonderen Positionsattribute</u></strong>
                <a id="AutoShuttersControl-attr-ASC_Closed_Pos"></a>
                <li><strong>ASC_Closed_Pos</strong> - in 10 Schritten von 0 bis 100 (default: ist abh&auml;ngig vom Attribut <em>ASC</em> 0/100)</li>
@ -1060,13 +1073,13 @@ __END__
                <li><strong>ASC_Shading_Pos</strong> - Position des Rollladens f&uuml;r die Beschattung (default: ist abh&auml;ngig vom Attribut <em>ASC</em> 80/20) !!!Verwendung von Perlcode ist m&ouml;glich, dieser muss in {} eingeschlossen sein. R&uuml;ckgabewert muss eine positive Zahl/Dezimalzahl sein!!!</li>
                <a id="AutoShuttersControl-attr-ASC_Ventilate_Pos"></a>
                <li><strong>ASC_Ventilate_Pos</strong> - in 10 Schritten von 0 bis 100 (default: ist abh&auml;ngig vom Attribut <em>ASC</em> 70/30) !!!Verwendung von Perlcode ist m&ouml;glich, dieser muss in {} eingeschlossen sein. R&uuml;ckgabewert muss eine positive Zahl/Dezimalzahl sein!!!</li>
-                </p>
+                <p></p>
                <strong>In Bezug auf die Verwendung mit Lamellen gibt es folgende erg&auml;nzende Parameter</strong>.
                <ul>
                    <li>Wird die gesamte Position inklusive der Lamellen mit Hilfe einer "festen Zurdnung" angefahren, so z.B. <em>set ROLLONAME Beschattung</em> dann wird hinter dem Positionswert mittels : getrennt die "feste Zuordnung" geschrieben. Beispiel: <em>attr ROLLONAME ASC_Shading_Pos 30:Beschattung</em></li>
                    <li>Wird hingegen ein ander Command verwendet z.B. slatPct oder &auml;hnliches dann muss hinter der normalen Positionsangebe noch die Position f&uuml;r die Lamellen mit angegeben werden. Beispiel: <em>attr ROLLONAME ASC_Shading_Pos 30:75</em>. <strong>Bitte beachtet in diesem Zusammenhang auch das Attribut ASC_SlatPosCmd_SlatDevice wo mindestens die Angabe des SlatPosCMD Voraussetzung ist.</strong></li>
                </ul>
-            </p></ul>
+            <p></p></ul>
            <a id="AutoShuttersControl-attr-ASC_Shutter_IdleDetection"></a>
            <li><strong>ASC_Shutter_IdleDetection</strong> - <strong>READING:VALUE</strong> gibt das Reading an welches Auskunft &uuml;ber den Fahrstatus des Rollos gibt, sowie als zweites den Wert im Reading welcher aus sagt das das Rollo <strong>nicht</strong> f&auml;hrt</li>
            <a id="AutoShuttersControl-attr-ASC_DriveUpMaxDuration"></a>
@ -1115,7 +1128,7 @@ __END__
            <a id="AutoShuttersControl-attr-ASC_Self_Defense_AbsentDelay"></a>
            <li><strong>ASC_Self_Defense_AbsentDelay</strong> - um wie viele Sekunden soll das fahren in Selfdefense bei Residents absent verz&ouml;gert werden. (default: 300)</li>
            <a id="AutoShuttersControl-attr-ASC_Self_Defense_Exclude"></a>
-            <li><strong>ASC_Self_Defense_Exclude - on/off</strong> - bei on Wert wird dieser Rollladen bei aktiven Self Defense und offenen Fenster nicht runter gefahren, wenn Residents absent ist. (default: off), off bedeutet das es ausgeschlossen ist vom Self Defense</li></p>
+            <li><strong>ASC_Self_Defense_Exclude - on/off</strong> - bei on Wert wird dieser Rollladen bei aktiven Self Defense und offenen Fenster nicht runter gefahren, wenn Residents absent ist. (default: off), off bedeutet das es ausgeschlossen ist vom Self Defense</li><p></p>
            <ul>
                <strong><u>Beschreibung der Beschattungsfunktion</u></strong>
                </br>Damit die Beschattung Funktion hat, m&uuml;ssen folgende Anforderungen erf&uuml;llt sein.
@ -1138,7 +1151,7 @@ __END__
                <li><strong>ASC_Shading_WaitingPeriod</strong> - wie viele Sekunden soll gewartet werden bevor eine weitere Auswertung der Sensordaten f&uuml;r die Beschattung stattfinden soll (default: 1200)</li>
                <a id="AutoShuttersControl-attr-ASC_Shading_BetweenTheTime"></a>
                <li><strong>ASC_Shading_BetweenTheTime</strong> - das Fahren in die Beschattung erfolgt bei Angabe nur innerhalb des Zeitraumes, Bsp: 09:00-13:00 11:25-15:30</li>
-            </ul></p>
+            </ul><p></p>
            <a id="AutoShuttersControl-attr-ASC_ShuttersPlace"></a>
            <li><strong>ASC_ShuttersPlace - window/terrace/awning</strong> - Wenn dieses Attribut auf terrace gesetzt ist, das Residence Device in den Status "gone" geht und SelfDefense aktiv ist (ohne das das Reading selfDefense gesetzt sein muss), wird das Rollo geschlossen. awning steht f&uuml;r Markise und wirkt sich auf die Beschattungssteuerung aus. (default: window)</li>
            <a id="AutoShuttersControl-attr-ASC_Time_Down_Early"></a>
@ -1185,11 +1198,11 @@ __END__
            </li>
        </ul>
    </ul>
-    </p>
+    <p></p>
    <a id="AutoShuttersControl-API"></a>
    <strong><u>Beschreibung der AutoShuttersControl API</u></strong>
    </br>Mit dem Aufruf der API Funktion und &Uuml;bergabe der entsprechenden Parameter ist es m&ouml;glich auf interne Daten zu zu greifen.
-    </p>
+    <p></p>
    <u>&Uuml;bersicht f&uuml;r das Rollladen-Device Getter</u>
    <ul>
        <code>{ ascAPIget('GETTER','ROLLODEVICENAME') }</code><br>
@ -1334,7 +1347,7 @@ __END__
        <tr><td>OutTemp</td><td>aktuelle Au&szlig;entemperatur sofern ein Sensor definiert ist, wenn nicht kommt -100 als Wert zur&uuml;ck</td></tr>
        <tr><td>ShadingBetweenTheTime</td><td>Konfiguration f&uuml;r die Zeit der Beschattung</td></tr>
    </table>
-    </p>
+    <p></p>
    <u>&Uuml;bersicht f&uuml;r das Rollladen-Device mit Parameter&uuml;bergabe Getter</u>
    <ul>
        <code>{ ascAPIget('GETTER','ROLLODEVICENAME',VALUE) }</code><br>
@ -1343,7 +1356,7 @@ __END__
        <tr><th>Getter</th><th>Erl&auml;uterung</th></tr>
        <tr><td>QueryShuttersPos</td><td>R&uuml;ckgabewert 1 bedeutet das die aktuelle Position des Rollos unterhalb der Valueposition ist. 0 oder nichts bedeutet oberhalb der Valueposition.</td></tr>
    </table>
-    </p>
+    <p></p>
    <u>&Uuml;bersicht f&uuml;r das Rollladen-Device Setter</u>
    <ul>
        <code>{ ascAPIset('SETTER','ROLLODEVICENAME','VALUE') }</code><br>
@ -1404,7 +1417,7 @@ __END__
        <tr><td>WinDev</td><td>   </td></tr>
        <tr><td>ShadingBetweenTheTime</td><td>Konfiguration f&uuml;r die Zeit der Beschattung, Beispiel: 09:00-13:00 WICHTIG!!!! Immer bei einstelligen Stunden die 0 davor setzen</td></tr>
    </table>
-    </p>
+    <p></p>
    <u>&Uuml;bersicht f&uuml;r das ASC Device Getter</u>
    <ul>
        <code>{ ascAPIget('GETTER') }</code><br>
@ -1439,6 +1452,19 @@ __END__
        <tr><td>RainWaitingTime</td><td>   </td></tr>
        <tr><td>BlockAscDrivesAfterManual</td><td>   </td></tr>
    </table>
+    <p></p>
+    <u>Wichtige Informationen zur allgemeinen Verwendung</u>
+    <p>
+        Es wurde eine M&ouml;glichkeit geschaffen um das verz&ouml;gerte fahren eines Rolles durch &ouml;ffnen eines Fensterkontaktes zu unterbinden.
+        Feststellung der Griffstellung vor Fahrt, nicht vor Wartezeit!
+        Voraussetzung f&uuml;r diese Funktion ist folgende Einstellung:
+        <ul>
+            <li>das Rollo muss in der Position Open stehen</i>
+            <li>der Sensor muss auf open stehen / gestellt werden</i>
+            <li>Attribut ASC_ShuttersPlace muss auf terrace gesetzt sein</i>
+            <li>Attribut ASC_Self_Defense_Mode muss auf off gesetzt sein</i>
+        </ul> 
+    </p>
 </ul>

 =end html_DE
@ -1462,7 +1488,7 @@ __END__
  ],
  "release_status": "stable",
  "license": "GPL_2",
-  "version": "v0.99.10",
+  "version": "v1.0.1",
  "author": [
    "Marko Oldenburg <fhemdevelopment@cooltux.net>"
  ],
--- a/controls_AutoShuttersControl.txt
+++ b/controls_AutoShuttersControl.txt
@ -1,16 +1,16 @@
-UPD 2024-10-12_07:38:48 116314 FHEM/73_AutoShuttersControl.pm
-UPD 2024-10-12_07:35:03 76335 lib/FHEM/Automation/ShuttersControl.pm
-UPD 2024-10-12_07:33:39 2691 lib/FHEM/Automation/ShuttersControl/Dev.pm
-UPD 2024-10-12_07:34:12 2675 lib/FHEM/Automation/ShuttersControl/Roommate.pm
-UPD 2024-10-12_07:34:38 31828 lib/FHEM/Automation/ShuttersControl/Shutters.pm
-UPD 2024-10-12_07:34:24 25541 lib/FHEM/Automation/ShuttersControl/Shading.pm
-UPD 2024-10-12_07:33:49 112297 lib/FHEM/Automation/ShuttersControl/EventProcessingFunctions.pm
-UPD 2024-10-12_07:34:00 40681 lib/FHEM/Automation/ShuttersControl/Helper.pm
-UPD 2024-10-12_07:34:46 2209 lib/FHEM/Automation/ShuttersControl/Window.pm
-UPD 2024-10-12_07:38:13 11857 lib/FHEM/Automation/ShuttersControl/Dev/Attr.pm
-UPD 2024-10-12_07:38:06 7265 lib/FHEM/Automation/ShuttersControl/Dev/Readings.pm
-UPD 2024-10-12_07:37:57 52751 lib/FHEM/Automation/ShuttersControl/Shutters/Attr.pm
-UPD 2024-10-12_07:37:49 2799 lib/FHEM/Automation/ShuttersControl/Shutters/Readings.pm
-UPD 2024-10-12_07:37:43 3887 lib/FHEM/Automation/ShuttersControl/Window/Attr.pm
-UPD 2024-10-12_07:33:29 2200 lib/FHEM/Automation/ShuttersControl/Window/Readings.pm
-UPD 2024-10-12_07:34:06 7394 lib/FHEM/Automation/ShuttersControl/Rainprotection.pm
+UPD 2025-02-05_07:57:04 117935 FHEM/73_AutoShuttersControl.pm
+UPD 2025-01-25_11:47:02 76570 lib/FHEM/Automation/ShuttersControl.pm
+UPD 2024-10-12_09:12:30 2691 lib/FHEM/Automation/ShuttersControl/Dev.pm
+UPD 2024-10-12_09:12:30 2675 lib/FHEM/Automation/ShuttersControl/Roommate.pm
+UPD 2024-10-12_09:12:30 31828 lib/FHEM/Automation/ShuttersControl/Shutters.pm
+UPD 2024-10-12_09:12:30 25541 lib/FHEM/Automation/ShuttersControl/Shading.pm
+UPD 2024-10-12_09:12:30 112297 lib/FHEM/Automation/ShuttersControl/EventProcessingFunctions.pm
+UPD 2024-10-12_09:12:30 40681 lib/FHEM/Automation/ShuttersControl/Helper.pm
+UPD 2024-10-12_09:12:30 2209 lib/FHEM/Automation/ShuttersControl/Window.pm
+UPD 2024-10-12_09:12:30 11857 lib/FHEM/Automation/ShuttersControl/Dev/Attr.pm
+UPD 2024-10-12_09:12:30 7265 lib/FHEM/Automation/ShuttersControl/Dev/Readings.pm
+UPD 2024-10-12_09:12:30 52751 lib/FHEM/Automation/ShuttersControl/Shutters/Attr.pm
+UPD 2024-10-12_09:12:30 2799 lib/FHEM/Automation/ShuttersControl/Shutters/Readings.pm
+UPD 2024-10-12_09:12:30 3887 lib/FHEM/Automation/ShuttersControl/Window/Attr.pm
+UPD 2024-10-12_09:12:30 2200 lib/FHEM/Automation/ShuttersControl/Window/Readings.pm
+UPD 2024-10-12_09:12:30 7394 lib/FHEM/Automation/ShuttersControl/Rainprotection.pm
Author	SHA1	Message	Date
Marko Oldenburg	538bd36130	Merge pull request 'dev' (#146 ) from dev into main Reviewed-on: #146	2025-02-05 07:03:00 +00:00
Marko Oldenburg	dd2cb7d2b8	Merge pull request 'patch-documentation' (#145 ) from patch-documentation into dev Reviewed-on: #145	2025-02-05 07:01:36 +00:00
Marko Oldenburg	3c1e539ef8	``` Add usage information for roller shutter control This update enhances the documentation by adding crucial usage information for the roller shutter control module. New sections in both English and German were introduced to explain the necessary conditions for preventing delayed operation when a window contact is opened. It is clarified that for the functionality to operate as intended, the roller shutter must be open, the sensor needs to be set to open, and specific attributes (ASC_ShuttersPlace and ASC_Self_Defense_Mode) must be configured correctly. These additions aim to improve user understanding and usability of the AutoShuttersControl module. The version was updated to v1.0.1 to reflect these enhancements. ```	2025-02-05 08:00:28 +01:00
Marko Oldenburg	e155fbf3ec	``` Add important usage information for roller shutter control This update includes new sections in both English and German explaining the conditions necessary to prevent delayed operation of roller shutters when a window contact is opened. The changes clarify that for this functionality to work, the roller shutter must be open, the sensor should be set to open, and specific attributes (ASC_ShuttersPlace and ASC_Self_Defense_Mode) must be appropriately configured. These additions help users understand proper settings required for optimal functionality, improving the overall usability and effectiveness of the AutoShuttersControl module. The version has been updated to v1.0.1 to reflect these enhancements. ```	2025-02-05 07:57:46 +01:00
Marko Oldenburg	2178943e3a	Merge pull request 'dev' (#144 ) from dev into main Reviewed-on: #144	2025-01-25 10:43:41 +00:00
Marko Oldenburg	ef9349ec90	Merge pull request 'patch-newversion' (#143 ) from patch-newversion into dev Reviewed-on: #143	2025-01-25 10:43:18 +00:00
Marko Oldenburg	640cd620b5	docs: changelog	2025-01-25 11:14:17 +01:00
Marko Oldenburg	9039254ead	docs: new version	2025-01-25 11:14:01 +01:00
Marko Oldenburg	8923b8edbe	Merge pull request 'testing' (#142 ) from testing into main Reviewed-on: #142	2025-01-21 17:21:03 +00:00
Marko Oldenburg	81489d5246	Merge pull request 'dev' (#141 ) from dev into testing Reviewed-on: #141	2025-01-21 17:20:42 +00:00
Marko Oldenburg	833a370347	Merge pull request 'patch-commandref' (#140 ) from patch-commandref into dev Reviewed-on: #140	2025-01-21 17:20:19 +00:00
Marko Oldenburg	fb50355d39	docs: Changelog	2025-01-21 18:19:54 +01:00
Marko Oldenburg	d41615c90f	fix: commandref	2025-01-21 18:19:42 +01:00
Marko Oldenburg	be5e721c43	Merge pull request 'main' (#138 ) from main into dev Reviewed-on: #138	2025-01-21 16:55:10 +00:00
Marko Oldenburg	2351e5b9db	Merge pull request 'testing' (#136 ) from testing into main Reviewed-on: #136	2025-01-21 16:31:26 +00:00
Marko Oldenburg	d4626a068b	Merge pull request 'dev' (#135 ) from dev into testing Reviewed-on: #135	2025-01-21 16:29:35 +00:00
Marko Oldenburg	0571adccc5	Merge pull request 'patch-marvin78' (#134 ) from patch-marvin78 into dev Reviewed-on: #134	2025-01-21 16:20:07 +00:00
Marko Oldenburg	8ec3bcde54	docs: new changelog	2025-01-21 17:19:04 +01:00
Marko Oldenburg	bd97e399bf	feat: change version	2025-01-21 17:18:12 +01:00