pymscada 0.1.0a1__tar.gz → 0.1.0a4__tar.gz

pymscada-0.1.0a4/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.1
+Name: pymscada
+Version: 0.1.0a4
+Summary: Shared tag value SCADA with python backup and Angular UI
+Author-Email: Jamie Walton <jamie@walton.net.nz>
+License: GPL-3.0-or-later
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: JavaScript
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: OS Independent
+Classifier: Environment :: Console
+Classifier: Development Status :: 1 - Planning
+Requires-Python: >=3.9
+Requires-Dist: PyYAML>=6.0.1
+Requires-Dist: aiohttp>=3.8.5
+Requires-Dist: pymscada-html<=0.1.0
+Requires-Dist: cerberus>=1.3.5
+Requires-Dist: pycomm3>=1.2.14
+Requires-Dist: pysnmplib>=5.0.24
+Description-Content-Type: text/markdown
+
+# pymscada
+#### [Docs](https://github.com/jamie0walton/pymscada/blob/main/docs/README.md)
+
+#### [@Github](https://github.com/jamie0walton/pymscada/blob/main/README.md)
+
+## Python Mobile SCADA
+
+```pymscada``` read / write to Modbus and Logix PLCs. Read SNMP OIDs.
+Collect history values and provide the ability to set values and trends
+and issue commands.
+
+User interface is via a web client embedded in this package. Examples included
+for securing with Apache as a proxy.
+
+Configuration with text yaml files, including the web page which are
+procedurally built.
+
+# See also
+
+- The angular project [angmscada](https://github.com/jamie0walton/angmscada)
+- Python container for the compiled angular pages [pymscada-html](https://github.com/jamie0walton/pymscada-html)
+
+# Licence
+
+```pymscada``` is distributed under the GPLv3 [license](./LICENSE).
+
+# Use
+Checkout the example files.
+```bash
+mscada@raspberrypi:~/test $ pymscada checkout
+making 'history' folder
+making pdf dir
+making config dir
+Creating  /home/mscada/test/config/modbusclient.yaml
+Creating  /home/mscada/test/config/pymscada-history.service
+Creating  /home/mscada/test/config/wwwserver.yaml
+Creating  /home/mscada/test/config/pymscada-demo-modbus_plc.service
+Creating  /home/mscada/test/config/files.yaml
+Creating  /home/mscada/test/config/pymscada-modbusserver.service
+Creating  /home/mscada/test/config/pymscada-wwwserver.service
+Creating  /home/mscada/test/config/simulate.yaml
+Creating  /home/mscada/test/config/tags.yaml
+Creating  /home/mscada/test/config/history.yaml
+Creating  /home/mscada/test/config/pymscada-files.service
+Creating  /home/mscada/test/config/bus.yaml
+Creating  /home/mscada/test/config/modbusserver.yaml
+Creating  /home/mscada/test/config/modbus_plc.py
+Creating  /home/mscada/test/config/pymscada-modbusclient.service
+Creating  /home/mscada/test/config/pymscada-bus.service
+Creating  /home/mscada/test/config/README.md
+mscada@raspberrypi:~/test $ pymscada validate
+WARNING:root:pymscada 0.1.0 starting
+Config files in ./ valid.
+``` 
+
+Runs on a Raspberry Pi and includes preconfigured systemd files to
+automate running the services. Mostly works on Windows, works better
+on linux.
+
+Modules can be run from the command line, although you need
+a terminal for each running module (better with systemd).
+```bash
+pymscada bus --config bus.yaml
+pymscada wwwserver --config wwwserver.yaml --tags tags.yaml
+pymscada history --config history.yaml --tags tags.yaml
+python weather.py
+```

pymscada-0.1.0a4/README.md

@@ -0,0 +1,67 @@
+# pymscada
+#### [Docs](https://github.com/jamie0walton/pymscada/blob/main/docs/README.md)
+
+#### [@Github](https://github.com/jamie0walton/pymscada/blob/main/README.md)
+
+## Python Mobile SCADA
+
+```pymscada``` read / write to Modbus and Logix PLCs. Read SNMP OIDs.
+Collect history values and provide the ability to set values and trends
+and issue commands.
+
+User interface is via a web client embedded in this package. Examples included
+for securing with Apache as a proxy.
+
+Configuration with text yaml files, including the web page which are
+procedurally built.
+
+# See also
+
+- The angular project [angmscada](https://github.com/jamie0walton/angmscada)
+- Python container for the compiled angular pages [pymscada-html](https://github.com/jamie0walton/pymscada-html)
+
+# Licence
+
+```pymscada``` is distributed under the GPLv3 [license](./LICENSE).
+
+# Use
+Checkout the example files.
+```bash
+mscada@raspberrypi:~/test $ pymscada checkout
+making 'history' folder
+making pdf dir
+making config dir
+Creating  /home/mscada/test/config/modbusclient.yaml
+Creating  /home/mscada/test/config/pymscada-history.service
+Creating  /home/mscada/test/config/wwwserver.yaml
+Creating  /home/mscada/test/config/pymscada-demo-modbus_plc.service
+Creating  /home/mscada/test/config/files.yaml
+Creating  /home/mscada/test/config/pymscada-modbusserver.service
+Creating  /home/mscada/test/config/pymscada-wwwserver.service
+Creating  /home/mscada/test/config/simulate.yaml
+Creating  /home/mscada/test/config/tags.yaml
+Creating  /home/mscada/test/config/history.yaml
+Creating  /home/mscada/test/config/pymscada-files.service
+Creating  /home/mscada/test/config/bus.yaml
+Creating  /home/mscada/test/config/modbusserver.yaml
+Creating  /home/mscada/test/config/modbus_plc.py
+Creating  /home/mscada/test/config/pymscada-modbusclient.service
+Creating  /home/mscada/test/config/pymscada-bus.service
+Creating  /home/mscada/test/config/README.md
+mscada@raspberrypi:~/test $ pymscada validate
+WARNING:root:pymscada 0.1.0 starting
+Config files in ./ valid.
+``` 
+
+Runs on a Raspberry Pi and includes preconfigured systemd files to
+automate running the services. Mostly works on Windows, works better
+on linux.
+
+Modules can be run from the command line, although you need
+a terminal for each running module (better with systemd).
+```bash
+pymscada bus --config bus.yaml
+pymscada wwwserver --config wwwserver.yaml --tags tags.yaml
+pymscada history --config history.yaml --tags tags.yaml
+python weather.py
+```

{pymscada-0.1.0a1 → pymscada-0.1.0a4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pymscada"
-version = "0.1.0a1"
+version = "0.1.0a4"
 description = "Shared tag value SCADA with python backup and Angular UI"
 authors = [
     { name = "Jamie Walton", email = "jamie@walton.net.nz" },

{pymscada-0.1.0a1 → pymscada-0.1.0a4}/src/pymscada/checkout.py

@@ -1,4 +1,5 @@
 """Create base config folder and check out demo files."""
+import difflib
 from pathlib import Path
 import sys
 from pymscada.config import get_demo_files, get_pdf_files
@@ -36,7 +37,7 @@ def make_pdf():
         target.write_bytes(pdf_file.read_bytes())
 
 
-def make_config(overwrite):
+def make_config(overwrite: bool):
     """Make the config folder, if missing, and copy files in."""
     config_dir = PATH['__DIR__'].joinpath('config')
     if not config_dir.exists():
@@ -62,11 +63,43 @@ def make_config(overwrite):
             target.write_bytes(config_file.read_bytes())
 
 
-def checkout(overwrite=False):
+def read_with_subst(file: Path):
+    """Read the file and replace DIR markers."""
+    rd = file.read_bytes().decode()
+    if str(file).endswith('service'):
+        for k, v in PATH.items():
+            rd = rd.replace(k, str(v.absolute()))
+    lines = rd.splitlines()
+    return lines
+
+
+def compare_config():
+    """Compare old and new config."""
+    config_dir = PATH['__DIR__'].joinpath('config')
+    if not config_dir.exists():
+        print('No config dir, are you in the right directory')
+        return
+    for config_file in get_demo_files():
+        target = config_dir.joinpath(config_file.name)
+        if target.exists():
+            new_lines = read_with_subst(config_file)
+            old_lines = read_with_subst(target)
+            diff = list(difflib.unified_diff(old_lines, new_lines,
+                        fromfile=str(target), tofile=str(config_file)))
+            if len(diff):
+                print('\n'.join(diff), '\n')
+        else:
+            print(f'\n--- MISSING FILE\n\n+++ {config_file}')
+
+
+def checkout(overwrite=False, diff=False):
     """Do it."""
     for name in PATH:
         if not PATH[name].exists():
             raise SystemExit(f'{PATH[name]} is missing')
-    make_history()
-    make_pdf()
-    make_config(overwrite)
+    if diff:
+        compare_config()
+    else:
+        make_history()
+        make_pdf(diff)
+        make_config(overwrite, diff)

{pymscada-0.1.0a1 → pymscada-0.1.0a4}/src/pymscada/demo/modbusserver.yaml

@@ -7,10 +7,18 @@ rtus:
   tcp_udp: tcp
   serve:
   - {unit: 1, file: 4x, start: 1, end: 100}
+  - {unit: 2, file: 4x, start: 1, end: 100}
+  - {unit: 3, file: 4x, start: 1, end: 100}
 tags:
   sim_IntSet:
     type: int16
     addr: RTU:1:4x:1
+  sim_IntSet2:
+    type: int16
+    addr: RTU:2:4x:1
+  sim_IntSet3:
+    type: int16
+    addr: RTU:3:4x:1
   sim_IntVal:
     type: int16
     addr: RTU:1:4x:2

pymscada-0.1.0a4/src/pymscada/demo/ping.yaml

@@ -0,0 +1,12 @@
+bus_ip: 127.0.0.1
+bus_port: 1324
+tags:
+  localhost_ping:
+    type: ping
+    addr: '127.0.0.1'
+  electronet_ping:
+    type: ping
+    addr: electronet.co.nz
+  google_ping:
+    type: ping
+    addr: www.google.com

pymscada-0.1.0a4/src/pymscada/demo/pymscada-io-ping.service

@@ -0,0 +1,15 @@
+[Unit]
+    Description=pymscada - Ping client
+    BindsTo=pymscada-bus.service
+    After=pymscada-bus.service
+
+[Service]
+    WorkingDirectory=__DIR__
+    ExecStart=__PYMSCADA__ ping --config __DIR__/config/ping.yaml
+    Restart=always
+    RestartSec=5
+    User=mscada
+    Group=mscada
+
+[Install]
+    WantedBy=multi-user.target

{pymscada-0.1.0a1 → pymscada-0.1.0a4}/src/pymscada/demo/tags.yaml

@@ -253,4 +253,13 @@ Router_eth8_bytes_in:
   type: int
 Router_eth8_bytes_out:
   desc: eth8 bytes out
-  type: int
+  type: int
+localhost_ping:
+  desc: Ping time to localhost
+  units: ms
+google_ping:
+  desc: Ping time to google
+  units: ms
+electronet_ping:
+  desc: Ping time to electronet
+  units: ms