pymscada 0.2.0rc1__tar.gz → 0.2.0rc2__tar.gz

{pymscada-0.2.0rc1/src/pymscada.egg-info → pymscada-0.2.0rc2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pymscada
-Version: 0.2.0rc1
+Version: 0.2.0rc2
 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
@@ -17,7 +17,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML>=6.0.1
 Requires-Dist: aiohttp>=3.8.5
-Requires-Dist: pymscada-html==0.2.0rc1
+Requires-Dist: pymscada-html==0.2.0rc2
 Requires-Dist: cerberus>=1.3.5
 Requires-Dist: pycomm3>=1.2.14
 Requires-Dist: pysnmplib>=5.0.24

{pymscada-0.2.0rc1 → pymscada-0.2.0rc2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pymscada"
-version = "0.2.0rc1"
+version = "0.2.0rc2"
 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",          # all
     "aiohttp>=3.8.5",         # www_server
-    "pymscada-html==0.2.0rc1",   # www_server
+    "pymscada-html==0.2.0rc2",   # www_server
     "cerberus>=1.3.5",        # validate
     "pycomm3>=1.2.14",        # logix_client
     "pysnmplib>=5.0.24",      # DON'T use pysnmp, dead

{pymscada-0.2.0rc1 → pymscada-0.2.0rc2}/src/pymscada/bus_client.py

@@ -12,8 +12,9 @@ class BusClient:
     """
     Connects to a Bus Server.
 
-    await client.connect() to make the connection. If bus server connection
-    fails, die.
+    The client is created without a connection. client.start() creates the
+    connection and checks the tags at that time. When the connection fails
+    the client dies. A connection is mandatory for the client to run.
     """
 
     def __init__(self, ip: str = '127.0.0.1', port: int = 1324, tag_info=None,
@@ -125,7 +126,6 @@ class BusClient:
 
     async def read(self):
         """Read forever."""
-        await self.open_connection()
         while True:
             try:
                 head = await self.reader.readexactly(14)
@@ -223,4 +223,5 @@ class BusClient:
 
     async def start(self):
         """Start async."""
+        await self.open_connection()
         self.read_task = asyncio.create_task(self.read())

{pymscada-0.2.0rc1 → pymscada-0.2.0rc2}/src/pymscada/bus_server.py

@@ -3,6 +3,7 @@ import asyncio
 from struct import pack, unpack
 import time
 import logging
+import socket
 import pymscada.protocol_constants as pc
 
 
@@ -143,8 +144,12 @@ class BusServer:
 
     __slots__ = ('ip', 'port', 'server', 'connections', 'bus_tag')
 
-    def __init__(self, ip: str = '127.0.0.1', port: int = 1324,
-                 bus_tag: str = '__bus__'):
+    def __init__(
+        self,
+        ip: str = '127.0.0.1',
+        port: int = 1324,
+        bus_tag: str = '__bus__'
+    ) -> None:
         """
         Serve Tags on ip:port, echoing changes to any subscribers.
 
@@ -154,6 +159,13 @@ class BusServer:
 
         Event loop must be running.
         """
+        try:
+            socket.gethostbyname(ip)
+        except socket.gaierror as e:
+            raise ValueError(f'Cannot resolve IP/hostname: {e}')
+        if not isinstance(bus_tag, str):
+            raise ValueError('bus_tag must be a string')
+
         self.ip = ip
         self.port = port
         self.server = None

{pymscada-0.2.0rc1 → pymscada-0.2.0rc2}/src/pymscada/console.py

@@ -3,7 +3,7 @@ import asyncio
 import logging
 import sys
 from pymscada.bus_client import BusClient
-from pymscada.tag import Tag, tag_for_web
+from pymscada.tag import Tag, tag_for_web, TagInfo
 try:
     import termios
     import tty
@@ -153,7 +153,7 @@ class Console:
     """Provide a text console to interact with a Bus."""
 
     def __init__(self, bus_ip: str = '127.0.0.1', bus_port: int = 1324,
-                 tag_info: dict = {}):
+                 tag_info: dict[str, TagInfo] = {}) -> None:
         """
         Connect to bus_ip:bus_port and provide console interaction with a Bus.
 

{pymscada-0.2.0rc1 → pymscada-0.2.0rc2}/src/pymscada/files.py

@@ -10,13 +10,13 @@ class Files():
     """Connect to bus_ip:bus_port, store and provide a value history."""
 
     def __init__(self, bus_ip: str = '127.0.0.1', bus_port: int = 1324,
-                 path: str = '', files: list = None,
+                 path: str = '', files: list[dict] = [],
                  rta_tag: str = '__files__') -> None:
         """
         Connect to bus_ip:bus_port, serve and update files.
 
-        TODO
-        Write something.
+        Scans paths in files at the root defined by path. These should
+        be readable by wwwserver so that download links work.
 
         Event loop must be running.
         """

{pymscada-0.2.0rc1 → pymscada-0.2.0rc2}/src/pymscada/history.py

@@ -25,6 +25,7 @@ import logging
 from pathlib import Path
 from struct import pack, pack_into, unpack_from, error
 import time
+import socket
 from typing import TypedDict, Optional
 from pymscada.bus_client import BusClient
 from pymscada.tag import Tag, TagInfo, TYPES
@@ -220,9 +221,14 @@ class TagHistory():
 class History():
     """Connect to bus_ip:bus_port, store and provide a value history."""
 
-    def __init__(self, bus_ip: str = '127.0.0.1', bus_port: int = 1324,
-                 path: str = 'history', tag_info: TagInfo = {},
-                 rta_tag: str = '__history__') -> None:
+    def __init__(
+        self,
+        bus_ip: str = '127.0.0.1',
+        bus_port: int = 1324,
+        path: str = 'history',
+        tag_info: TagInfo = {},
+        rta_tag: str | None = '__history__'
+    ) -> None:
         """
         Connect to bus_ip:bus_port, store and provide a value history.
 
@@ -232,6 +238,23 @@ class History():
 
         Event loop must be running.
         """
+        if not isinstance(bus_ip, str):
+            raise ValueError("bus_ip must be a string")
+        try:
+            socket.gethostbyname(bus_ip)
+        except socket.gaierror:
+            raise ValueError(f"Invalid bus_ip: {bus_ip}")
+        if not isinstance(bus_port, int):
+            raise ValueError("bus_port must be an integer")
+        if not 1024 <= bus_port <= 65535:
+            raise ValueError(f"bus_port must be between 1024 and 65535")
+        if not isinstance(path, str):
+            raise ValueError("path must be a string")
+        if not isinstance(tag_info, dict):
+            raise ValueError("tag_info must be a dictionary")
+        if not isinstance(rta_tag, (str, type(None))):
+            raise ValueError("rta_tag must be a string or None")
+
         self.busclient = BusClient(bus_ip, bus_port, module='History')
         self.path = path
         self.tags: dict[str, Tag] = {}

{pymscada-0.2.0rc1 → pymscada-0.2.0rc2}/src/pymscada/iodrivers/openweather.py

@@ -2,6 +2,7 @@
 import asyncio
 import aiohttp
 import logging
+import socket
 from time import time
 from pymscada.bus_client import BusClient
 from pymscada.periodic import Periodic
@@ -10,8 +11,14 @@ from pymscada.tag import Tag
 class OpenWeatherClient:
     """Get weather data from OpenWeather Current and Forecast APIs."""
 
-    def __init__(self, bus_ip: str = '127.0.0.1', bus_port: int = 1324,
-                 proxy: str = None, api: dict = {}, tags: dict = {}) -> None:
+    def __init__(
+        self,
+        bus_ip: str | None = '127.0.0.1',
+        bus_port: int = 1324,
+        proxy: str | None = None,
+        api: dict = {},
+        tags: list = []
+    ) -> None:
         """
         Connect to bus on bus_ip:bus_port.
 
@@ -21,6 +28,18 @@ class OpenWeatherClient:
         - times: list of hours ahead to fetch forecast data for
         - units: optional units (standard, metric, imperial)
         """
+        if bus_ip is not None:
+            try:
+                socket.gethostbyname(bus_ip)
+            except socket.gaierror:
+                raise ValueError(f"Invalid bus_ip: {bus_ip}")
+        if not isinstance(proxy, str) and proxy is not None:
+            raise ValueError("proxy must be a string or None")
+        if not isinstance(api, dict):
+            raise ValueError("api must be a dictionary")
+        if not isinstance(tags, list):
+            raise ValueError("tags must be a list")
+
         self.busclient = None
         if bus_ip is not None:
             self.busclient = BusClient(bus_ip, bus_port, module='OpenWeather')

{pymscada-0.2.0rc1 → pymscada-0.2.0rc2}/src/pymscada/opnotes.py

@@ -1,6 +1,7 @@
 """Operator Notes."""
 import logging
 import sqlite3  # note that sqlite3 has blocking calls
+import socket
 from pymscada.bus_client import BusClient
 from pymscada.tag import Tag
 
@@ -8,9 +9,14 @@ from pymscada.tag import Tag
 class OpNotes:
     """Connect to bus_ip:bus_port, store and provide Operator Notes."""
 
-    def __init__(self, bus_ip: str = '127.0.0.1', bus_port: int = 1324,
-                 db: str = None, rta_tag: str = '__opnotes__',
-                 table: str = 'opnotes') -> None:
+    def __init__(
+        self,
+        bus_ip: str = '127.0.0.1',
+        bus_port: int = 1324,
+        db: str | None = None,
+        table: str = 'opnotes',
+        rta_tag: str = '__opnotes__'
+    ) -> None:
         """
         Connect to bus_ip:bus_port, serve and update operator notes database.
 
@@ -21,6 +27,19 @@ class OpNotes:
         """
         if db is None:
             raise SystemExit('OpNotes db must be defined')
+        try:
+            socket.gethostbyname(bus_ip)
+        except socket.gaierror as e:
+            raise ValueError(f'Cannot resolve IP/hostname: {e}')
+        if not isinstance(bus_port, int):
+            raise TypeError('bus_port must be an integer')
+        if not 1024 <= bus_port <= 65535:
+            raise ValueError('bus_port must be between 1024 and 65535')
+        if not isinstance(rta_tag, str) or not rta_tag:
+            raise ValueError('rta_tag must be a non-empty string')
+        if not isinstance(table, str) or not table:
+            raise ValueError('table must be a non-empty string')
+
         logging.warning(f'OpNotes {bus_ip} {bus_port} {db} {rta_tag}')
         self.connection = sqlite3.connect(db)
         self.table = table

{pymscada-0.2.0rc1 → pymscada-0.2.0rc2}/src/pymscada/www_server.py

@@ -4,6 +4,7 @@ from aiohttp import web, WSMsgType
 import logging
 from pathlib import Path
 from struct import pack, unpack_from
+import socket
 import time
 from pymscada.bus_client import BusClient
 import pymscada.protocol_constants as pc
@@ -34,11 +35,13 @@ class WSHandler():
     ids = set(range(1, 1000))
 
     def __init__(self, ws: web.WebSocketResponse, pages: dict,
-                 tag_info: dict[str, Tag], do_rta, interface: Interface):
+                 tag_info: dict[str, Tag], do_rta, interface: Interface,
+                 webclient: dict):
         """Create callbacks to monitor tag values."""
         self.ws = ws
         self.pages = pages
         self.tag_info = tag_info
+        self.webclient = webclient
         self.tag_by_id: dict[int, Tag] = {}
         self.tag_by_name: dict[str, Tag] = {}
         self.queue = asyncio.Queue()
@@ -168,6 +171,8 @@ class WSHandler():
     async def connection_active(self):
         """Run while the connection is active and don't return."""
         send_queue = asyncio.create_task(self.send_queue())
+        self.queue.put_nowait(
+            (False, {'type': 'webclient', 'payload': self.webclient}))
         self.queue.put_nowait(
             (False, {'type': 'pages', 'payload': self.pages}))
         async for msg in self.ws:
@@ -210,11 +215,19 @@ class WSHandler():
 class WwwServer:
     """Connect to bus on bus_ip:bus_port, serve on ip:port for webclient."""
 
-    def __init__(self, bus_ip: str = '127.0.0.1', bus_port: int = 1324,
-                 ip: str = '127.0.0.1', port: int = 8324, get_path: str = None,
-                 tag_info: dict = {}, pages: dict = {}, serve_path: str = None,
-                 www_tag: str = '__wwwserver__'
-                 ) -> None:
+    def __init__(
+        self,
+        bus_ip: str = '127.0.0.1',
+        bus_port: int = 1324,
+        ip: str = '127.0.0.1',
+        port: int = 8324,
+        get_path: str | None = None,
+        tag_info: dict = {},
+        pages: dict = {},
+        webclient: dict = {},
+        serve_path: str | None = None,
+        www_tag: str = '__wwwserver__'
+    ) -> None:
         """
         Connect to bus on bus_ip:bus_port, serve on ip:port for webclient.
 
@@ -224,16 +237,36 @@ class WwwServer:
 
         Event loop must be running.
         """
+        try:
+            socket.gethostbyname(bus_ip)
+        except socket.gaierror as e:
+            raise ValueError(f'Cannot resolve bus IP/hostname: {e}')
+        if not isinstance(bus_port, int):
+            raise TypeError('bus_port must be an integer')
+        if not 1024 <= bus_port <= 65535:
+            raise ValueError('bus_port must be between 1024 and 65535')
+        try:
+            socket.gethostbyname(ip)
+        except socket.gaierror as e:
+            raise ValueError(f'Cannot resolve IP/hostname: {e}')
+        if not isinstance(port, int):
+            raise TypeError('port must be an integer')
+        if not 1024 <= port <= 65535:
+            raise ValueError('port must be between 1024 and 65535')
+        if not isinstance(www_tag, str) or not www_tag:
+            raise ValueError('www_tag must be a non-empty string')
+
         self.busclient = BusClient(bus_ip, bus_port, tag_info,
                                    module='WWW Server')
         self.ip = ip
         self.port = port
         self.get_path = get_path
-        self.serve_path = Path(serve_path)
+        self.serve_path = Path(serve_path) if serve_path else None
         for tagname, tag in tag_info.items():
             tag_for_web(tagname, tag)
         self.tag_info = tag_info
         self.pages = pages
+        self.webclient = webclient
         self.interface = Interface(www_tag)
 
     async def redirect_handler(self, _request: web.Request):
@@ -256,14 +289,14 @@ class WwwServer:
     async def path_handler(self, request: web.Request):
         """Plain files."""
         logging.info(f"path {request.match_info['path']}")
+        if self.serve_path is None:
+            return web.HTTPForbidden(reason='path not configured')
         path = self.serve_path.joinpath(request.match_info['path'])
         if path.is_dir():
             return web.HTTPForbidden(reason='folder not permitted')
         if not path.exists():
             return web.HTTPNotFound(reason='no such file in path')
         return web.FileResponse(path)
-        # logging.warning(f"path not configured {request.match_info['path']}")
-        # return web.HTTPForbidden(reason='path not permitted')
 
     async def websocket_handler(self, request: web.Request):
         """Wait for connections. Create a new one each time."""
@@ -272,7 +305,7 @@ class WwwServer:
         ws = web.WebSocketResponse(max_msg_size=0)  # disables max message size
         await ws.prepare(request)
         await WSHandler(ws, self.pages, self.tag_info, self.busclient.rta,
-                        self.interface).connection_active()
+                        self.interface, self.webclient).connection_active()
         await ws.close()
         logging.info(f"WS closed {peer}")
         return ws

{pymscada-0.2.0rc1 → pymscada-0.2.0rc2/src/pymscada.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pymscada
-Version: 0.2.0rc1
+Version: 0.2.0rc2
 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
@@ -17,7 +17,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML>=6.0.1
 Requires-Dist: aiohttp>=3.8.5
-Requires-Dist: pymscada-html==0.2.0rc1
+Requires-Dist: pymscada-html==0.2.0rc2
 Requires-Dist: cerberus>=1.3.5
 Requires-Dist: pycomm3>=1.2.14
 Requires-Dist: pysnmplib>=5.0.24

{pymscada-0.2.0rc1 → pymscada-0.2.0rc2}/src/pymscada.egg-info/requires.txt

@@ -1,6 +1,6 @@
 PyYAML>=6.0.1
 aiohttp>=3.8.5
-pymscada-html==0.2.0rc1
+pymscada-html==0.2.0rc2
 cerberus>=1.3.5
 pycomm3>=1.2.14
 pysnmplib>=5.0.24

{pymscada-0.2.0rc1 → pymscada-0.2.0rc2}/tests/test_openweather.py

@@ -19,8 +19,7 @@ async def test_openweather_temperature():
     }
     tags = ['London_Temp', 'London_Temp_01', 'London_Temp_02',
             'London_Temp_03']
-    client = OpenWeatherClient(bus_ip=None, bus_port=None, api=api_config,
-                               tags=tags)
+    client = OpenWeatherClient(bus_ip=None, api=api_config, tags=tags)
     try:
         handle_task = asyncio.create_task(client.handle_response())
         await client.fetch_current_data()