[PATCH] 98_PID20: Docu-Update

[yoda_gh]

Hallo!

Mich haben einige Details am PID20 Modul anfänglich ein wenig verwirrt. Anbei ein Vorschlag für ein paar Klarstellungen in der Doku (siehe auch Patch im Anhang):

Code Auswählen Erweitern


--- 98_PID20.pm (Revision 11128)
+++ 98_PID20.pm (Arbeitskopie)
@@ -812,7 +812,7 @@
<br/>
<code>set &lt;name&gt; restart &lt;value&gt;</code>
<br/><br/>
- <ul>Same as start, but uses value as start value for actor</ul>
+ <ul>Same as start, but uses value as start value for actor. You can be reset the I-Portion (p_i) by setting start value to p_p+p_d.</ul>
<br/>

</ul>
@@ -855,11 +855,11 @@
<li><b>pidSensorTimeout</b> - number of seconds to wait before sensor will be recognized n/a; default: 3600</li>
<li><b>pidReverseAction</b> - reverse PID operation mode, possible values: 0,1; default: 0</li>
<li><b>pidUpdateInterval</b> - number of seconds to wait before an update will be forced for plotting; default: 300</li>
- <li><b>pidActorCallBeforeSetting</b> - an optional callback-function,which can manipulate the actorValue; default: not defined
+ <li><b>pidActorCallBeforeSetting</b> - the name(!) of an optional callback-function, which can manipulate the actorValue; default: not defined
         <pre>
-        # Exampe for callback-function
-        # 1. argument = name of PID20
-        # 2. argument = current actor value
+        # Exampe for callback-function: set pidActorCallBeforeSetting to "PIDActorSet" and add this code to your 99_myUtils.pm
+        # 1st argument = name of PID20
+        # 2nd argument = current actor value
           sub PIDActorSet($$)
           {
               my ( $name, $actValue ) = @_;
@@ -870,11 +870,11 @@
               return $actValue;
           }</pre>
  </li>
- <li><b>pidIPortionCallBeforeSetting</b> - an optional callback-function, which can manipulate the value of I-Portion; default: not defined
+ <li><b>pidIPortionCallBeforeSetting</b> - the name(!) of an optional callback-function, which can manipulate the value of I-Portion; default: not defined
         <pre>
-        # Exampe for callback-function
-        # 1. argument = name of PID20
-        # 2. argument = current i-portion value
+        # Exampe for callback-function: set pidIPortionCallBeforeSetting to "PIDIPortionSet" and add this code to your 99_myUtils.pm
+        # 1st argument = name of PID20
+        # 2nd argument = current i-portion value
           sub PIDIPortionSet($$)
           {
               my ( $name, $actValue ) = @_;