Skip to content

Commit

Permalink
-adds typing to help conversion script
Browse files Browse the repository at this point in the history
-adds a do not edit warning to *.help.py files
-slight changes to eliminate pre-commit edits to *help.py files
roasterdave committed Nov 13, 2024
1 parent b28fc85 commit 6d5e50d
Showing 26 changed files with 5,527 additions and 5,120 deletions.
484 changes: 242 additions & 242 deletions doc/help_dialogs/Output_html/alarms_help.html

Large diffs are not rendered by default.

1,006 changes: 503 additions & 503 deletions doc/help_dialogs/Output_html/autosave_help.html

Large diffs are not rendered by default.

284 changes: 142 additions & 142 deletions doc/help_dialogs/Output_html/energy_help.html

Large diffs are not rendered by default.

408 changes: 204 additions & 204 deletions doc/help_dialogs/Output_html/eventannotations_help.html

Large diffs are not rendered by default.

1,962 changes: 981 additions & 981 deletions doc/help_dialogs/Output_html/eventbuttons_help.html

Large diffs are not rendered by default.

1,392 changes: 696 additions & 696 deletions doc/help_dialogs/Output_html/eventsliders_help.html

Large diffs are not rendered by default.

1,000 changes: 500 additions & 500 deletions doc/help_dialogs/Output_html/keyboardshortcuts_help.html

Large diffs are not rendered by default.

72 changes: 36 additions & 36 deletions doc/help_dialogs/Output_html/modbus_help.html
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
<head><style> td, th {border: 1px solid #ddd; padding: 6px;} th {padding-top: 6px;padding-bottom: 6px;text-align: left;background-color: #0C6AA6; color: white;} </style></head> <body><b>PORTS CONFIGURATION</b><table width="100%" border="1" padding="1" border-collapse="collapse">
<thead>
<tr>
<th>MODBUS SETTINGS</th>
</tr>
</thead>
<tbody>
<tr>
<td>The MODBUS serial protocols RTU, ASCII, and Binary is using the specified serial port parameters. The MODBUS IP protocol on TCP and UDP is respecting the host IP and port.</td>
</tr>
<tr>
<td>The inputs 1+2 configure the MODBUS device, inputs 3+4 configure the MODBUS_34 device and so on.<br>Inputs with the slave id set to 0 are turned off.</td>
</tr>
<tr>
<td>Function 1 (Read Coils): registers 0 to 65535 corresponding to numbers 000001 to 065536<br>Function 2 (Read Discrete Inputs): registers 0 to 65535 corresponding to numbers 100001 to 165536<br>Function 3 (Read Multiple Holding Registers): registers 0 to 65535 corresponding to numbers 400001 to 465536<br>Function 4 (Read Input Registers): registers 0 to 65535 corresponding to numbers 300001 to 365536</td>
</tr>
<tr>
<td>Dividers 1/10 and 1/100 can be set to recreate decimals of floats transported as integers multiplied by 10 or 100. Eg. a value of 145.2 might be transmitted as 1452, which is turned back into 145.2 by the 1/10 divider.</td>
</tr>
<tr>
<td>Temperature readings are automatically converted based on the specified unit per input channel.</td>
</tr>
<tr>
<td>If a 32bit decoder is set two succeeding 16bit registers are requested and the received 4 bytes are interpreted using the byte and word order as specified by the corresponding flag.</td>
</tr>
<tr>
<td>The PID Control dialog can operate a connected PID slave using the given PID registers to set the p-i-d parameters and the set value (SV). MODBUS commands can be specified to turn the PID slave on and off from that PID Control dialog. See the help page in the Events Dialog for documentation of available MODBUS write commands.</td>
</tr>
<tr>
<td>The Scan button opens a simple MODBUS scanner to search for data holding registers in the connected device.</td>
</tr>
<tr>
<td>Refer to the User Manual of your MODBUS device for information specific to the setup required for your device.</td>
</tr>
</tbody>
</table></body>
<head><style> td, th {border: 1px solid #ddd; padding: 6px;} th {padding-top: 6px;padding-bottom: 6px;text-align: left;background-color: #0C6AA6; color: white;} </style></head> <body><b>PORTS CONFIGURATION</b><table width="100%" border="1" padding="1" border-collapse="collapse">
<thead>
<tr>
<th>MODBUS SETTINGS</th>
</tr>
</thead>
<tbody>
<tr>
<td>The MODBUS serial protocols RTU, ASCII, and Binary is using the specified serial port parameters. The MODBUS IP protocol on TCP and UDP is respecting the host IP and port.</td>
</tr>
<tr>
<td>The inputs 1+2 configure the MODBUS device, inputs 3+4 configure the MODBUS_34 device and so on.<br>Inputs with the slave id set to 0 are turned off.</td>
</tr>
<tr>
<td>Function 1 (Read Coils): registers 0 to 65535 corresponding to numbers 000001 to 065536<br>Function 2 (Read Discrete Inputs): registers 0 to 65535 corresponding to numbers 100001 to 165536<br>Function 3 (Read Multiple Holding Registers): registers 0 to 65535 corresponding to numbers 400001 to 465536<br>Function 4 (Read Input Registers): registers 0 to 65535 corresponding to numbers 300001 to 365536</td>
</tr>
<tr>
<td>Dividers 1/10 and 1/100 can be set to recreate decimals of floats transported as integers multiplied by 10 or 100. Eg. a value of 145.2 might be transmitted as 1452, which is turned back into 145.2 by the 1/10 divider.</td>
</tr>
<tr>
<td>Temperature readings are automatically converted based on the specified unit per input channel.</td>
</tr>
<tr>
<td>If a 32bit decoder is set two succeeding 16bit registers are requested and the received 4 bytes are interpreted using the byte and word order as specified by the corresponding flag.</td>
</tr>
<tr>
<td>The PID Control dialog can operate a connected PID slave using the given PID registers to set the p-i-d parameters and the set value (SV). MODBUS commands can be specified to turn the PID slave on and off from that PID Control dialog. See the help page in the Events Dialog for documentation of available MODBUS write commands.</td>
</tr>
<tr>
<td>The Scan button opens a simple MODBUS scanner to search for data holding registers in the connected device.</td>
</tr>
<tr>
<td>Refer to the User Manual of your MODBUS device for information specific to the setup required for your device.</td>
</tr>
</tbody>
</table></body>
26 changes: 13 additions & 13 deletions doc/help_dialogs/Output_html/programs_help.html
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<head><style> td, th {border: 1px solid #ddd; padding: 6px;} th {padding-top: 6px;padding-bottom: 6px;text-align: left;background-color: #0C6AA6; color: white;} </style></head> <body><b>EXTERNAL PROGRAMS</b><table width="100%" border="1" padding="1" border-collapse="collapse">
<tbody>
<tr>
<td>Link external programs that print temperature when called. This allows to connect meters that use any program language.<br><br>Artisan will start the program each sample period. The program output must be to stdout (like when using print statements). The program must exit and must not be persistent.<br><br>If only one temperature is provided it will be interpreted as BT. If more than one temperature is provided the values are order dependent with ET first and BT second.<br><br>Data may also be provided to the &quot;Program&quot; extra devices. Extra device &quot;Program&quot; are the first two values, typically ET and BT. &quot;Program 34&quot; are the third and fourth values. Up to 10 values may be supplied.<br><br><br>Example of output needed from program for single temperature (BT):<br>&quot;100.4&quot; (note: &quot;&quot; not needed)<br><br>Example of output needed from program for double temperature (ET,BT)<br>&quot;200.4,100.4&quot; (note: temperatures are separated by a comma &quot;ET,BT&quot;)<br><br>Example of output needed from program for double temperature (ET,BT) and extra devices (Program and Program 34)<br>&quot;200.4,100.4,312.4,345.6,299.0,275.5&quot;</td>
</tr>
</tbody>
</table><table width="100%" border="1" padding="1" border-collapse="collapse">
<tbody>
<tr>
<td>Example of a file written in Python called test.py:<br><br>#comment: print a string with two numbers separated by a comma<br>#!/usr/bin/env python<br>print(&quot;237.1,100.4&quot;)<br><br>Note: In many cases the path to the Python or other language executatable should be provided along with the external program path. On Windows it is advised to enclose the paths with quotation marks if there are any spaces, and use forward slashes &#39;/&#39; in the path.<br>&quot;C:/Python38-64/python.exe&quot; &quot;c:/scripts/test.py&quot;<br><br> Under Output a script can be specified which is called per sample interval with 4 arguments, ET, BT, Background ET and Background BT<br> the output script also called if Prog is not selected as input source<br><br> Example of a file written in Python called out.py:<br><br>#comment: adds the script arguments ET, BT, ETB, BTB to &quot;/tmp/out.txt&quot;<br>#!/usr/bin/env python<br><br>import sys<br>ET, BT, ETB, BTB = sys.argv[1:]<br><br>with open(&quot;/tmp/out.txt&quot;, &quot;w+&quot;) as file:<br> file.write(f&#39;ET: {ET}, BT: {ET}, ETB: {ETB}, BTB: {BTB};&#39;)</td>
</tr>
</tbody>
</table></body>
<head><style> td, th {border: 1px solid #ddd; padding: 6px;} th {padding-top: 6px;padding-bottom: 6px;text-align: left;background-color: #0C6AA6; color: white;} </style></head> <body><b>EXTERNAL PROGRAMS</b><table width="100%" border="1" padding="1" border-collapse="collapse">
<tbody>
<tr>
<td>Link external programs that print temperature when called. This allows to connect meters that use any program language.<br><br>Artisan will start the program each sample period. The program output must be to stdout (like when using print statements). The program must exit and must not be persistent.<br><br>If only one temperature is provided it will be interpreted as BT. If more than one temperature is provided the values are order dependent with ET first and BT second.<br><br>Data may also be provided to the &quot;Program&quot; extra devices. Extra device &quot;Program&quot; are the first two values, typically ET and BT. &quot;Program 34&quot; are the third and fourth values. Up to 10 values may be supplied.<br><br><br>Example of output needed from program for single temperature (BT):<br>&quot;100.4&quot; (note: &quot;&quot; not needed)<br><br>Example of output needed from program for double temperature (ET,BT)<br>&quot;200.4,100.4&quot; (note: temperatures are separated by a comma &quot;ET,BT&quot;)<br><br>Example of output needed from program for double temperature (ET,BT) and extra devices (Program and Program 34)<br>&quot;200.4,100.4,312.4,345.6,299.0,275.5&quot;</td>
</tr>
</tbody>
</table><table width="100%" border="1" padding="1" border-collapse="collapse">
<tbody>
<tr>
<td>Example of a file written in Python called test.py:<br><br>#comment: print a string with two numbers separated by a comma<br>#!/usr/bin/env python<br>print(&quot;237.1,100.4&quot;)<br><br>Note: In many cases the path to the Python or other language executatable should be provided along with the external program path. On Windows it is advised to enclose the paths with quotation marks if there are any spaces, and use forward slashes &#39;/&#39; in the path.<br>&quot;C:/Python38-64/python.exe&quot; &quot;c:/scripts/test.py&quot;<br><br> Under Output a script can be specified which is called per sample interval with 4 arguments, ET, BT, Background ET and Background BT<br> the output script also called if Prog is not selected as input source<br><br> Example of a file written in Python called out.py:<br><br>#comment: adds the script arguments ET, BT, ETB, BTB to &quot;/tmp/out.txt&quot;<br>#!/usr/bin/env python<br><br>import sys<br>ET, BT, ETB, BTB = sys.argv[1:]<br><br>with open(&quot;/tmp/out.txt&quot;, &quot;w+&quot;) as file:<br> file.write(f&#39;ET: {ET}, BT: {ET}, ETB: {ETB}, BTB: {BTB};&#39;)</td>
</tr>
</tbody>
</table></body>
66 changes: 33 additions & 33 deletions doc/help_dialogs/Output_html/s7_help.html
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
<head><style> td, th {border: 1px solid #ddd; padding: 6px;} th {padding-top: 6px;padding-bottom: 6px;text-align: left;background-color: #0C6AA6; color: white;} </style></head> <body><b>PORTS CONFIGURATION</b><table width="100%" border="1" padding="1" border-collapse="collapse">
<thead>
<tr>
<th>S7 SETTINGS</th>
</tr>
</thead>
<tbody>
<tr>
<td>The Siemens S7 is respecting the host IP and port.</td>
</tr>
<tr>
<td>The inputs 1+2 configure the S7 device, inputs 3+4 configure the S7_34 device and so on.<br>Inputs with the area set to the empty input are turned off.</td>
</tr>
<tr>
<td>Factors 1/10 and 1/100 can be set as dividers to recreate decimals of floats transported as integers multiplied by 10 or 100. Eg. a value of 145.2 might be transmitted as 1452, which is turned back into 145.2 by the 1/10 divider.</td>
</tr>
<tr>
<td>Temperature readings are automatically converted based on the specified unit per input channel.</td>
</tr>
<tr>
<td>If mode is set to C or F, readings are automatically converted to the temperature unit set for display.</td>
</tr>
<tr>
<td>The PID Control dialog can operate a connected PID slave using the given PID registers to set the p-i-d parameters and the set value (SV). S7 commands can be specified to turn the PID slave on and off from that PID Control dialog. See the help page in the Events Dialog for documentation of available S7 write commands.</td>
</tr>
<tr>
<td>The Scan button opens a simple MODBUS scanner to search for data holding registers in the connected device.</td>
</tr>
<tr>
<td>Refer to the User Manual of your MODBUS device for information specific to the setup required for your device.</td>
</tr>
</tbody>
</table></body>
<head><style> td, th {border: 1px solid #ddd; padding: 6px;} th {padding-top: 6px;padding-bottom: 6px;text-align: left;background-color: #0C6AA6; color: white;} </style></head> <body><b>PORTS CONFIGURATION</b><table width="100%" border="1" padding="1" border-collapse="collapse">
<thead>
<tr>
<th>S7 SETTINGS</th>
</tr>
</thead>
<tbody>
<tr>
<td>The Siemens S7 is respecting the host IP and port.</td>
</tr>
<tr>
<td>The inputs 1+2 configure the S7 device, inputs 3+4 configure the S7_34 device and so on.<br>Inputs with the area set to the empty input are turned off.</td>
</tr>
<tr>
<td>Factors 1/10 and 1/100 can be set as dividers to recreate decimals of floats transported as integers multiplied by 10 or 100. Eg. a value of 145.2 might be transmitted as 1452, which is turned back into 145.2 by the 1/10 divider.</td>
</tr>
<tr>
<td>Temperature readings are automatically converted based on the specified unit per input channel.</td>
</tr>
<tr>
<td>If mode is set to C or F, readings are automatically converted to the temperature unit set for display.</td>
</tr>
<tr>
<td>The PID Control dialog can operate a connected PID slave using the given PID registers to set the p-i-d parameters and the set value (SV). S7 commands can be specified to turn the PID slave on and off from that PID Control dialog. See the help page in the Events Dialog for documentation of available S7 write commands.</td>
</tr>
<tr>
<td>The Scan button opens a simple MODBUS scanner to search for data holding registers in the connected device.</td>
</tr>
<tr>
<td>Refer to the User Manual of your MODBUS device for information specific to the setup required for your device.</td>
</tr>
</tbody>
</table></body>
Loading

0 comments on commit 6d5e50d

Please sign in to comment.