pymscada 0.0.14__tar.gz → 0.1.0__tar.gz

pymscada-0.1.0/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.1
+Name: pymscada
+Version: 0.1.0
+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.0/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.0.14 → pymscada-0.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pymscada"
-version = "0.0.14"
+version = "0.1.0"
 description = "Shared tag value SCADA with python backup and Angular UI"
 authors = [
     { name = "Jamie Walton", email = "jamie@walton.net.nz" },
@@ -8,7 +8,7 @@ authors = [
 dependencies = [
     "PyYAML>=6.0.1",
     "aiohttp>=3.8.5",
-    "pymscada-html<=0.1.0",
+    "pymscada-html==0.1.0",
     "cerberus>=1.3.5",
     "pycomm3>=1.2.14",
     "pysnmplib>=5.0.24",
@@ -43,7 +43,6 @@ test = [
     "flake8-docstrings>=1.7.0",
     "pytest-asyncio>=0.21.1",
     "pytest-cov>=4.1.0",
-    "pdm>=2.11.1",
 ]
 pdm = []
 

{pymscada-0.0.14 → pymscada-0.1.0}/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()
+        make_config(overwrite)

{pymscada-0.0.14 → pymscada-0.1.0}/src/pymscada/demo/logixclient.yaml

@@ -4,42 +4,43 @@ rtus:
 - name: Ani
   ip: 172.26.7.196
   rate: 0.2
-  read:
+  poll:
   - {addr: Fout, type: 'REAL[]', start: 0, end: 99}
   - {addr: Iout, type: 'DINT[]', start: 0, end: 99}
   - {addr: OutVar, type: REAL}
-  writeok:
-  - {addr: Fin, type: 'REAL[]', start: 0, end: 99}
-  - {addr: Iin, type: 'REAL[]', start: 0, end: 99}
-  - {addr: InVar, type: REAL}
 tags:
+  Ani_Fin_20:
+    type: float32
+    read: 'Ani:Fout[20]'
+    write: 'Ani:Fin[20]'
   Ani_Fout_20:
     type: float32
-    addr: 'Ani:Fout[20]'
+    read: 'Ani:Fout[20]'
+  Ani_Iin_20:
+    type: int32
+    read: 'Ani:Iout[20]'
+    write: 'Ani:Iin[20]'
   Ani_Iout_20:
     type: int32
-    addr: 'Ani:Iout[20]'
+    read: 'Ani:Iout[20]'
+  Ani_Iin_21_0:
+    type: bool
+    read: 'Ani:Iout[21].0'
+    write: 'Ani:Iin[21].0'
   Ani_Iout_21_0:
     type: bool
-    addr: 'Ani:Iout[21].0'
+    read: 'Ani:Iout[21].0'
+  Ani_Iin_21_1:
+    type: bool
+    read: 'Ani:Iout[21].1'
+    write: 'Ani:Iin[21].1'
   Ani_Iout_21_1:
     type: bool
-    addr: 'Ani:Iout[21].1'
-  Ani_Fin_20:
-    type: float32
-    addr: 'Ani:Fin[20]'
-  Ani_Iin_20:
-    type: int32
-    addr: 'Ani:Iin[20]'
+    read: 'Ani:Iout[21].1'
   InVar:
     type: float32
-    addr: Ani:InVar
+    read: Ani:OutVar
+    write: Ani:InVar
   OutVar:
     type: float32
-    addr: Ani:OutVar
-  Ani_Iin_21_0:
-    type: bool
-    addr: 'Ani:Iin[21].0'
-  Ani_Iin_21_1:
-    type: bool
-    addr: 'Ani:Iin[21].1'
+    read: Ani:OutVar

{pymscada-0.0.14 → pymscada-0.1.0}/src/pymscada/demo/modbusclient.yaml

@@ -6,54 +6,58 @@ rtus:
   port: 1502
   tcp_udp: tcp
   rate: 0.2
-  read:
+  poll:
   - {unit: 1, file: 4x, start: 1, end: 50}
   - {unit: 1, file: 4x, start: 51, end: 100}
-  writeok:
-  - {unit: 1, file: 4x, start: 1, end: 100}
 tags:
   IntSet:
     type: int16
-    addr: RTU:1:4x:1
+    read: RTU:1:4x:1
+    write: RTU:1:4x:1
   IntVal:
     type: int16
-    addr: RTU:1:4x:2
+    read: RTU:1:4x:2
   FloatSet:
     type: float32
-    addr: RTU:1:4x:3
+    read: RTU:1:4x:3
+    write: RTU:1:4x:3
   FloatVal:
     type: float32
-    addr: RTU:1:4x:5
+    read: RTU:1:4x:5
   MultiSet:
     type: int16
-    addr: RTU:1:4x:7
+    read: RTU:1:4x:7
+    write: RTU:1:4x:7
   MultiVal:
     type: int16
-    addr: RTU:1:4x:8
+    read: RTU:1:4x:8
   TimeSet:
     type: uint64
-    addr: RTU:1:4x:9
+    read: RTU:1:4x:9
+    write: RTU:1:4x:9
   TimeVal:
     type: uint64
-    addr: RTU:1:4x:13
+    read: RTU:1:4x:13
   DateSet:
     type: uint64
-    addr: RTU:1:4x:17
+    read: RTU:1:4x:17
+    write: RTU:1:4x:17
   DateVal:
     type: uint64
-    addr: RTU:1:4x:21
+    read: RTU:1:4x:21
   DateTimeSet:
     type: uint64
-    addr: RTU:1:4x:25
+    read: RTU:1:4x:25
+    write: RTU:1:4x:25
   DateTimeVal:
     type: uint64
-    addr: RTU:1:4x:29
+    read: RTU:1:4x:29
   cpu_temp:
     type: float32
-    addr: RTU:1:4x:33
+    read: RTU:1:4x:33
   cpu_load:
     type: float32
-    addr: RTU:1:4x:35
+    read: RTU:1:4x:35
   disk_use:
     type: float32
-    addr: RTU:1:4x:37
+    read: RTU:1:4x:37

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

@@ -1,5 +1,5 @@
-bus_ip: 192.168.1.100  # for the demo PLC make empty (None)
-bus_port: 2345  # for the demo PLC make empty (None)
+bus_ip:
+bus_port:
 rtus:
 - name: RTU
   ip: 0.0.0.0
@@ -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.0/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.0/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.0.14 → pymscada-0.1.0}/src/pymscada/demo/snmpclient.yaml

@@ -5,7 +5,7 @@ rtus:
   ip: 172.26.3.254
   community: public
   rate: 10
-  read:
+  poll:
   - '1.3.6.1.2.1.31.1.1.1.6.1'
   - '1.3.6.1.2.1.31.1.1.1.6.2'
   - '1.3.6.1.2.1.31.1.1.1.6.3'
@@ -25,49 +25,49 @@ rtus:
 tags:
   Router_eth1_bytes_in:
     type: int_roc
-    addr: 'router:1.3.6.1.2.1.31.1.1.1.6.1'
+    read: 'router:1.3.6.1.2.1.31.1.1.1.6.1'
   Router_eth1_bytes_out:
     type: int_roc
-    addr: 'router:1.3.6.1.2.1.31.1.1.1.10.1'
+    read: 'router:1.3.6.1.2.1.31.1.1.1.10.1'
   Router_eth2_bytes_in:
     type: int_roc
-    addr: 'router:1.3.6.1.2.1.31.1.1.1.6.2'
+    read: 'router:1.3.6.1.2.1.31.1.1.1.6.2'
   Router_eth2_bytes_out:
     type: int_roc
-    addr: 'router:1.3.6.1.2.1.31.1.1.1.10.2'
+    read: 'router:1.3.6.1.2.1.31.1.1.1.10.2'
   Router_eth3_bytes_in:
     type: int_roc
-    addr: 'router:1.3.6.1.2.1.31.1.1.1.6.3'
+    read: 'router:1.3.6.1.2.1.31.1.1.1.6.3'
   Router_eth3_bytes_out:
     type: int_roc
-    addr: 'router:1.3.6.1.2.1.31.1.1.1.10.3'
+    read: 'router:1.3.6.1.2.1.31.1.1.1.10.3'
   Router_eth4_bytes_in:
     type: int_roc
-    addr: 'router:1.3.6.1.2.1.31.1.1.1.6.4'
+    read: 'router:1.3.6.1.2.1.31.1.1.1.6.4'
   Router_eth4_bytes_out:
     type: int_roc
-    addr: 'router:1.3.6.1.2.1.31.1.1.1.10.4'
+    read: 'router:1.3.6.1.2.1.31.1.1.1.10.4'
   Router_eth5_bytes_in:
     type: int_roc
-    addr: 'router:1.3.6.1.2.1.31.1.1.1.6.5'
+    read: 'router:1.3.6.1.2.1.31.1.1.1.6.5'
   Router_eth5_bytes_out:
     type: int_roc
-    addr: 'router:1.3.6.1.2.1.31.1.1.1.10.5'
+    read: 'router:1.3.6.1.2.1.31.1.1.1.10.5'
   Router_eth6_bytes_in:
     type: int_roc
-    addr: 'router:1.3.6.1.2.1.31.1.1.1.6.6'
+    read: 'router:1.3.6.1.2.1.31.1.1.1.6.6'
   Router_eth6_bytes_out:
     type: int_roc
-    addr: 'router:1.3.6.1.2.1.31.1.1.1.10.6'
+    read: 'router:1.3.6.1.2.1.31.1.1.1.10.6'
   Router_eth7_bytes_in:
     type: int_roc
-    addr: 'router:1.3.6.1.2.1.31.1.1.1.6.7'
+    read: 'router:1.3.6.1.2.1.31.1.1.1.6.7'
   Router_eth7_bytes_out:
     type: int_roc
-    addr: 'router:1.3.6.1.2.1.31.1.1.1.10.7'
+    read: 'router:1.3.6.1.2.1.31.1.1.1.10.7'
   Router_eth8_bytes_in:
     type: int_roc
-    addr: 'router:1.3.6.1.2.1.31.1.1.1.6.8'
+    read: 'router:1.3.6.1.2.1.31.1.1.1.6.8'
   Router_eth8_bytes_out:
     type: int_roc
-    addr: 'router:1.3.6.1.2.1.31.1.1.1.10.8'
+    read: 'router:1.3.6.1.2.1.31.1.1.1.10.8'

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

@@ -166,6 +166,46 @@ sim_DateTimeSet:
 sim_DateTimeVal:
   desc: Simulation tag
   type: int
+Ani_Fin_20:
+  desc: 'Logix Fin[20]'
+  type: float
+  dp: 2
+Ani_Fout_20:
+  desc: 'Logix Fout[20]'
+  type: float
+  dp: 2
+Ani_Iin_20:
+  desc: 'Logix Iin[20]'
+  type: int
+Ani_Iout_20:
+  desc: 'Logix Iout[20]'
+  type: int
+Ani_Iout_21_0:
+  desc: 'Logix Iout[21].0'
+  multi:
+  - 'Off'
+  - 'On'
+Ani_Iout_21_1:
+  desc: 'Logix Iout[21].1'
+  multi:
+  - 'Off'
+  - 'On'
+Ani_Iin_21_0:
+  desc: 'Logix Iin[21].0'
+  multi:
+  - 'Off'
+  - 'On'
+Ani_Iin_21_1:
+  desc: 'Logix Iin[21].1'
+  multi:
+  - 'Off'
+  - 'On'
+InVar:
+  desc: InVar
+  type: float
+OutVar:
+  desc: OutVar
+  type: float
 Router_eth1_bytes_in:
   desc: eth1 bytes in
   type: int
@@ -213,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