pymscada 0.2.0rc2__tar.gz → 0.2.0rc3__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pymscada
-Version: 0.2.0rc2
+Version: 0.2.0rc3
 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

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

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

pymscada-0.2.0rc3/src/pymscada/alarms.py

@@ -0,0 +1,194 @@
+"""Alarms handling."""
+import logging
+import sqlite3  # note that sqlite3 has blocking calls
+import socket
+import time
+import atexit
+from pymscada.bus_client import BusClient
+from pymscada.tag import Tag, TagInfo, TYPES
+
+ALM = 0
+RTN = 1
+ACT = 2
+INF = 3
+
+
+class Alarms:
+    """Connect to bus_ip:bus_port, store and provide Alarms."""
+
+    def __init__(
+        self,
+        bus_ip: str | None = '127.0.0.1',
+        bus_port: int | None = 1324,
+        db: str | None = None,
+        table: str = 'alarms',
+        tag_info: TagInfo = {},
+        rta_tag: str = '__alarms__'
+    ) -> None:
+        """
+        Connect to bus_ip:bus_port, serve and update alarms database.
+
+        Open an Alarms table, creating if necessary. Provide additions
+        and history requests via the rta_tag.
+
+        Event loop must be running.
+
+        For testing only: bus_ip can be None to skip connection.
+        """
+        if db is None:
+            raise SystemExit('Alarms db must be defined')
+        if bus_ip is None:
+            logging.warning('Alarms has bus_ip=None, only use for testing')
+        else:
+            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'Alarms {bus_ip} {bus_port} {db} {rta_tag}')
+        self.connection = sqlite3.connect(db)
+        self.tags: dict[str, Tag] = {}
+        self.alarm_test: dict[str, dict] = {}
+        self.in_alarm: set[str] = set()
+        for tagname, tag in tag_info.items():
+            if 'alarm' not in tag:
+                continue
+            self.tags[tagname] = Tag(tagname, tag['type'])
+            self.tags[tagname].desc = tag['desc']
+            self.tags[tagname].add_callback(self.alarm_cb)
+            operator, value = tag['alarm'].split(' ')
+            self.alarm_test[tagname] = [
+                {
+                    '==': (lambda x, y: x == y),
+                    '<': (lambda x, y: x < y),
+                    '>': (lambda x, y: x > y),
+                    '<=': (lambda x, y: x <= y),
+                    '>=': (lambda x, y: x >= y)
+                }[operator],
+                float(value)
+            ]
+        self.table = table
+        self.cursor = self.connection.cursor()
+        self.busclient = BusClient(bus_ip, bus_port, module='Alarms')
+        self.rta = Tag(rta_tag, dict)
+        self.rta.value = {}
+        self.busclient.add_callback_rta(rta_tag, self.rta_cb)
+        self._init_table()
+        atexit.register(self.close)
+
+    def alarm_cb(self, tag):
+        """Callback for alarm tags."""
+        operator, value = self.alarm_test[tag.name]
+        if operator(tag.value, value) and tag.name not in self.in_alarm:
+            logging.warning(f'Alarm {tag.name} {tag.value}')
+            alarm_record = {
+                'action': 'ADD',
+                'date_ms': int(tag.time_us / 1000),
+                'tagname': tag.name,
+                'transition': ALM,
+                'description': f'{tag.desc} {tag.value}'
+            }
+            self.rta_cb(alarm_record)
+            self.in_alarm.add(tag.name)
+        elif not operator(tag.value, value) and tag.name in self.in_alarm:
+            logging.info(f'No alarm {tag.name} {tag.value}')
+            alarm_record = {
+                'action': 'ADD',
+                'date_ms': int(tag.time_us / 1000),
+                'tagname': tag.name,
+                'transition': RTN,
+                'description': f'{tag.desc} {tag.value}'
+            }
+            self.rta_cb(alarm_record)
+            self.in_alarm.remove(tag.name)
+
+    def _init_table(self):
+        """Initialize the database table schema."""
+        query = (
+            'CREATE TABLE IF NOT EXISTS ' + self.table +
+            '(id INTEGER PRIMARY KEY ASC, '
+            'date_ms INTEGER, '
+            'tagname TEXT, '
+            'transition INTEGER, '
+            'description TEXT)'
+        )
+        self.cursor.execute(query)
+        
+        # Add startup record using existing ADD functionality
+        startup_record = {
+            'action': 'ADD',
+            'date_ms': int(time.time() * 1000),
+            'tagname': self.rta.name,
+            'transition': INF,
+            'description': 'Alarm logging started'
+        }
+        self.rta_cb(startup_record)
+
+    def rta_cb(self, request):
+        """Respond to Request to Author and publish on rta_tag as needed."""
+        if 'action' not in request:
+            logging.warning(f'rta_cb malformed {request}')
+        elif request['action'] == 'ADD':
+            try:
+                logging.info(f'add {request}')
+                with self.connection:
+                    self.cursor.execute(
+                        f'INSERT INTO {self.table} '
+                        '(date_ms, tagname, transition, description) '
+                        'VALUES(:date_ms, :tagname, :transition, :description) '
+                        'RETURNING *;',
+                        request)
+                    res = self.cursor.fetchone()
+                    self.rta.value = {
+                        'id': res[0],
+                        'date_ms': res[1],
+                        'tagname': res[2],
+                        'transition': res[3],
+                        'description': res[4]
+                    }
+            except sqlite3.IntegrityError as error:
+                logging.warning(f'Alarms rta_cb {error}')
+        elif request['action'] == 'HISTORY':
+            try:
+                logging.info(f'history {request}')
+                with self.connection:
+                    self.cursor.execute(
+                        f'SELECT * FROM {self.table} WHERE date_ms > :date_ms '
+                        'ORDER BY (date_ms - :date_ms);', request)
+                    for res in self.cursor.fetchall():
+                        self.rta.value = {
+                            '__rta_id__': request['__rta_id__'],
+                            'id': res[0],
+                            'date_ms': res[1],
+                            'tagname': res[2],
+                            'transition': res[3],
+                            'description': res[4]
+                        }
+            except sqlite3.IntegrityError as error:
+                logging.warning(f'Alarms rta_cb {error}')
+
+    async def start(self):
+        """Async startup."""
+        await self.busclient.start()
+
+    def close(self):
+        """Clean shutdown of alarms logging."""
+        shutdown_record = {
+            'action': 'ADD',
+            'date_ms': int(time.time() * 1000),
+            'tagname': self.rta.name,
+            'transition': INF,
+            'description': 'Alarm logging stopped'
+        }
+        try:
+            self.rta_cb(shutdown_record)
+        except sqlite3.Error as e:
+            logging.error(f'Error during alarm shutdown: {e}')

pymscada-0.2.0rc3/src/pymscada/demo/alarms.yaml

@@ -0,0 +1,5 @@
+bus_ip: 127.0.0.1
+bus_port: 1324
+rta_tag: __alarms__
+db: __HOME__/config/pymscada-alarms.sqlite
+table: alarms

pymscada-0.2.0rc3/src/pymscada/demo/pymscada-alarms.service

@@ -0,0 +1,16 @@
+[Unit]
+    Description=pymscada - alarms
+    BindsTo=pymscada-bus.service
+    After=pymscada-bus.service
+
+[Service]
+    WorkingDirectory=__DIR__
+    ExecStart=__PYMSCADA__ alarms --config __DIR__/config/alarms.yaml --tags __DIR__/config/tags.yaml
+    Restart=always
+    RestartSec=5
+    User=__USER__
+    Group=__USER__
+    KillSignal=SIGINT
+
+[Install]
+    WantedBy=multi-user.target

{pymscada-0.2.0rc2 → pymscada-0.2.0rc3}/src/pymscada/module_config.py

@@ -5,7 +5,6 @@ from textwrap import dedent
 from importlib.metadata import version
 import logging
 from pymscada.config import Config
-from pymscada.console import Console
 
 class ModuleArgument:
     def __init__(self, args: tuple[str, ...], kwargs: dict[str, Any]):
@@ -59,6 +58,11 @@ def create_module_registry():
             module_class='pymscada.opnotes:OpNotes',
             tags=False
         ),
+        ModuleDefinition(
+            name='alarms',
+            help='alarms',
+            module_class='pymscada.alarms:Alarms'
+        ),
         ModuleDefinition(
             name='validate',
             help='validate config files',

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

@@ -24,17 +24,22 @@ class OpNotes:
         updates, deletions and history requests via the rta_tag.
 
         Event loop must be running.
+
+        For testing only: bus_ip can be None to skip connection.
         """
         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 bus_ip is None:
+            logging.warning('OpNotes has bus_ip=None, only use for testing')
+        else:
+            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:

{pymscada-0.2.0rc2 → pymscada-0.2.0rc3}/src/pymscada/tag.py

@@ -24,7 +24,7 @@ def tag_for_web(tagname: str, tag: dict):
     tag['name'] = tagname
     tag['id'] = None
     if 'desc' not in tag:
-        tag['desc'] = tag.name
+        tag['desc'] = tagname
     if 'multi' in tag:
         tag['type'] = 'int'
     else:

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pymscada
-Version: 0.2.0rc2
+Version: 0.2.0rc3
 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

{pymscada-0.2.0rc2 → pymscada-0.2.0rc3}/src/pymscada.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ README.md
 pyproject.toml
 src/pymscada/__init__.py
 src/pymscada/__main__.py
+src/pymscada/alarms.py
 src/pymscada/bus_client.py
 src/pymscada/bus_server.py
 src/pymscada/checkout.py
@@ -30,6 +31,7 @@ src/pymscada.egg-info/top_level.txt
 src/pymscada/demo/README.md
 src/pymscada/demo/__init__.py
 src/pymscada/demo/accuweather.yaml
+src/pymscada/demo/alarms.yaml
 src/pymscada/demo/bus.yaml
 src/pymscada/demo/files.yaml
 src/pymscada/demo/history.yaml
@@ -40,6 +42,7 @@ src/pymscada/demo/modbusserver.yaml
 src/pymscada/demo/openweather.yaml
 src/pymscada/demo/opnotes.yaml
 src/pymscada/demo/ping.yaml
+src/pymscada/demo/pymscada-alarms.service
 src/pymscada/demo/pymscada-bus.service
 src/pymscada/demo/pymscada-demo-modbus_plc.service
 src/pymscada/demo/pymscada-files.service
@@ -74,6 +77,7 @@ src/pymscada/pdf/two.pdf
 src/pymscada/pdf/__pycache__/__init__.cpython-311.pyc
 src/pymscada/tools/snmp_client2.py
 src/pymscada/tools/walk.py
+tests/test_alarms.py
 tests/test_bus_server.py
 tests/test_config.py
 tests/test_history.py

pymscada-0.2.0rc3/tests/test_alarms.py

@@ -0,0 +1,125 @@
+"""Test Alarms."""
+from pathlib import Path
+import pytest
+from pymscada.alarms import Alarms, ALM, RTN, ACT, INF
+from pymscada.tag import Tag
+
+
+@pytest.fixture(scope='module')
+def alarms_db():
+    """Create a fixture for DB access."""
+    tag_info = {
+        'localhost_ping': {
+            'desc': 'Ping time to localhost',
+            'units': 'ms',
+            'alarm': '> 2',
+            'type': float
+        }
+    }
+    Path('tests/test_assets/alarms.sqlite').unlink(missing_ok=True)
+    return Alarms(bus_ip=None, bus_port=None,
+                 db='tests/test_assets/alarms.sqlite',
+                 tag_info=tag_info)
+
+
+@pytest.fixture(scope='module')
+def alarms_tag():
+    """Create the RTA tag."""
+    return Tag('__alarms__', dict)
+
+
+@pytest.fixture(scope='module')
+def reply_tag():
+    """Create the reply tag."""
+    return Tag('__wwwserver__', dict)
+
+
+def test_db_and_tag(alarms_db, alarms_tag):
+    """Basic tests."""
+    db = alarms_db
+    tag = alarms_tag  # Alarms sets the tag value for www clients.
+    
+    # Verify startup record was created
+    assert tag.value['transition'] == 3  # INF
+    assert 'Alarm logging started' in tag.value['description']
+    
+    # Test adding an alarm
+    record = {
+        'action': 'ADD',
+        'tagname': 'TEST_TAG',
+        'date_ms': 1234567890123,
+        'transition': ALM,
+        'description': 'Test alarm condition'
+    }
+    db.rta_cb(record)
+    assert tag.value['id'] == 2  # Second record after startup
+    assert tag.value['transition'] == 0
+    assert tag.value['description'] == 'Test alarm condition'
+
+
+def test_history_queries(alarms_db, alarms_tag, reply_tag):
+    """Test history queries."""
+    BUSID = 999
+    db = alarms_db
+    a_tag: Tag = alarms_tag
+    a_values = []
+
+    def a_cb(tag):
+        a_values.append(tag.value)
+
+    a_tag.add_callback(a_cb, BUSID)
+    
+    # Add some test records
+    record = {
+        'action': 'ADD',
+        'tagname': 'TEST_TAG',
+        'date_ms': 12345,
+        'transition': ALM,
+        'description': 'Test alarm'
+    }
+    
+    for i in range(10):
+        record['date_ms'] -= 1
+        record['transition'] = i % 4  # Cycle through transitions
+        db.rta_cb(record)
+    
+    rq = {
+        '__rta_id__': BUSID,
+        'action': 'HISTORY',
+        'date_ms': 12345 - 5.1,
+        'reply_tag': '__wwwserver__'
+    }
+    db.rta_cb(rq)
+    assert a_values[10]['date_ms'] == 12340
+    assert a_values[-1]['description'] == 'Alarm logging started'
+
+    db.close()
+    assert a_values[-1]['transition'] == INF
+    assert a_values[-1]['description'] == 'Alarm logging stopped'
+
+
+def test_alarm_tag(alarms_db, alarms_tag):
+    """Test alarm tag callback."""
+    BUSID = 999
+    db = alarms_db
+    a_tag = alarms_tag
+    a_values = []
+
+    def a_cb(tag):
+        a_values.append(tag.value)
+
+    a_tag.add_callback(a_cb, BUSID)
+
+    ping_tag = db.tags['localhost_ping']
+    ping_tag.value = (3.0, 12345000, BUSID)
+    rq = {
+        '__rta_id__': BUSID,
+        'action': 'HISTORY',
+        'date_ms': 10000,
+        'reply_tag': '__wwwserver__'
+    }
+    db.rta_cb(rq)
+    for record in a_values:
+        if record['tagname'] == 'localhost_ping':
+            assert record['transition'] == ALM
+            assert record['description'] == 'Ping time to localhost 3.0'

{pymscada-0.2.0rc2 → pymscada-0.2.0rc3}/tests/test_opnotes.py

@@ -11,8 +11,7 @@ from pymscada.tag import Tag
 def opnotes_db():
     """Create a fixture for DB access."""
     Path('tests/test_assets/db.sqlite').unlink(missing_ok=True)
-    return OpNotes(bus_ip=None, bus_port=None,
-                   db='tests/test_assets/db.sqlite')
+    return OpNotes(bus_ip=None, db='tests/test_assets/db.sqlite')
 
 
 @pytest.fixture(scope='module')

{pymscada-0.2.0rc2 → pymscada-0.2.0rc3}/tests/test_periodic.py

@@ -34,11 +34,11 @@ async def test_periodic():
 
 @pytest.mark.asyncio()
 async def test_timechange():
-    """Periodic should run four times in 0.41 seconds."""
+    """Periodic should run four times in 0.42 seconds."""
     resetflag()
     periodic = Periodic(do_period, 0.1)
     await periodic.start()
-    await asyncio.sleep(0.21)
+    await asyncio.sleep(0.22)
     periodic.period = 0.3
     await asyncio.sleep(0.2)
     await periodic.stop()