pymscada 0.2.0rc2__py3-none-any.whl → 0.2.0rc3__py3-none-any.whl

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/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/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/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/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/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.dist-info → pymscada-0.2.0rc3.dist-info}/METADATA

@@ -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.dist-info → pymscada-0.2.0rc3.dist-info}/RECORD

@@ -1,5 +1,6 @@
 pymscada/__init__.py,sha256=NV_cIIwe66Ugp8ns426rtfJIIyskWbqwImD9p_5p0bQ,739
 pymscada/__main__.py,sha256=WcyVlrYOoDdktJhOoyubTOycMwpayksFdxwelRU5xpQ,272
+pymscada/alarms.py,sha256=BM6R-PFf7EazhGdGHJ1XeAcCoi83Ro9XvEl_9cp-iCI,7326
 pymscada/bus_client.py,sha256=ROShMcR2-y_i5CIvPxRdCRr-NpnMANjKFdLjKjMTRwo,9117
 pymscada/bus_server.py,sha256=k7ht2SAr24Oab0hBOPeW4NRDF_RK-F46iE0cMzh7K4w,12323
 pymscada/checkout.py,sha256=RLuCMTEuUI7pp1hIRAUPbo8xYFta8TjArelx0SD4gOY,3897
@@ -9,17 +10,18 @@ pymscada/files.py,sha256=iouEOPfEkVI0Qbbf1p-L324Y04zSrynVypLW0-1MThA,2499
 pymscada/history.py,sha256=qXbCkHQC_j7HF9b1PvnF93d4HvW9ODJeSc9tvy63o10,11513
 pymscada/main.py,sha256=d6EnK4-tEcvM5AqMHYhvqlnSh-E_wd0Tuxk-kXYSiDw,1854
 pymscada/misc.py,sha256=0Cj6OFhQonyhyk9x0BG5MiS-6EPk_w6zvavt8o_Hlf0,622
-pymscada/module_config.py,sha256=3-15qhCLsi_xR4i0cy2XZ74w5n0ZcqW2nPcX_Qtc6fU,8720
-pymscada/opnotes.py,sha256=vHJYPlPJLLsUHPbh4eBOUUnEnj9oXrrStb9Jzz-m524,7736
+pymscada/module_config.py,sha256=r1JBjOXtMk7n09kvlvnmA3d_BySEmJpdefFhRNKPdAY,8824
+pymscada/opnotes.py,sha256=MKM51IrB93B2-kgoTzlpOLpaMYs-7rPQHWmRLME-hQQ,7952
 pymscada/periodic.py,sha256=MLlL93VLvFqBBgjO1Us1t0aLHTZ5BFdW0B__G02T1nQ,1235
 pymscada/protocol_constants.py,sha256=lPJ4JEgFJ_puJjTym83EJIOw3UTUFbuFMwg3ohyUAGY,2414
 pymscada/samplers.py,sha256=t0IscgsCm5YByioOZ6aOKMO_guDFS_wxnJSiOGKI4Nw,2583
-pymscada/tag.py,sha256=GINy8gE1TPLFnuJLVVSui4Ke3IQlOGRy6_ePAlGlvj4,10683
+pymscada/tag.py,sha256=G0P9t3G6heQ1kBWPnc0u8qN6UvjG4xtyI9w_KqGr4Q0,10682
 pymscada/validate.py,sha256=fPMlP6RscYuTIgdEJjJ0ZZI0OyVSat1lpqg254wqpdE,13140
 pymscada/www_server.py,sha256=rz6Yictg_Ony8zW76An5bv_cZN5aLi-QW3B85uWMgXQ,13152
 pymscada/demo/README.md,sha256=iNcVbCTkq-d4agLV-979lNRaqf_hbJCn3OFzY-6qfU8,880
 pymscada/demo/__init__.py,sha256=WsDDgkWnZBJbt2-cJCdc2NvRAv_T4a7WOC1Q0k_l0gI,29
 pymscada/demo/accuweather.yaml,sha256=Fk4rV0S8jCau0173QCzKW8TdUbc4crYVi0aD8fPLNgU,322
+pymscada/demo/alarms.yaml,sha256=Ea8tLZ0aEiyKM_m5MN1TF6xS-lI5ReXiz2oUPO8GvmQ,110
 pymscada/demo/bus.yaml,sha256=zde5JDo2Yv5s7NvJ569gAEoTDvsvgBwRPxfrYhsxj3w,26
 pymscada/demo/files.yaml,sha256=XWtmGDJxtD4qdl2h7miUfJYkDKsvwNTgQjlGpR6LQNs,163
 pymscada/demo/history.yaml,sha256=c0OuYe8LbTeZqJGU2WKGgTEkOA0IYAjO3e046ddQB8E,55
@@ -30,6 +32,7 @@ pymscada/demo/modbusserver.yaml,sha256=67_mED6jXgtnzlDIky9Cg4j-nXur06iz9ve3JUwSy
 pymscada/demo/openweather.yaml,sha256=n8aPc_Ar6uiM-XbrEbBydABxFYm2uv_49dGo8u7DI8Q,433
 pymscada/demo/opnotes.yaml,sha256=gdT8DKaAV4F6u9trLCPyBgf449wYaP_FF8GCbjXm9-k,105
 pymscada/demo/ping.yaml,sha256=fm3eUdR2BwnPI_lU_V07qgmDxjSoPP6lPazYB6ZgpVg,149
+pymscada/demo/pymscada-alarms.service,sha256=nHjEMsonat-3ny0QJoY6KTZoPIt2HZiarKgW5uasY8k,383
 pymscada/demo/pymscada-bus.service,sha256=F3ViriRXyMKdCY3tHa3wXAnv2Fo2_16-EScTLsYnSOA,261
 pymscada/demo/pymscada-demo-modbus_plc.service,sha256=EtbWDwqAs4nLNLKScUiHcUWU1b6_tRBeAAVGi9q95hY,320
 pymscada/demo/pymscada-files.service,sha256=iLOfbl4SCxAwYHT20XCGHU0BJsUVicNHjHzKS8xIdgA,326
@@ -64,9 +67,9 @@ pymscada/pdf/two.pdf,sha256=TAuW5yLU1_wfmTH_I5ezHwY0pxhCVuZh3ixu0kwmJwE,1516
 pymscada/pdf/__pycache__/__init__.cpython-311.pyc,sha256=4KTfXrV9bGDbTIEv-zgIj_LvzLbVTj77lEC1wzMh9e0,194
 pymscada/tools/snmp_client2.py,sha256=pdn5dYyEv4q-ubA0zQ8X-3tQDYxGC7f7Xexa7QPaL40,1675
 pymscada/tools/walk.py,sha256=OgpprUbKLhEWMvJGfU1ckUt_PFEpwZVOD8HucCgzmOc,1625
-pymscada-0.2.0rc2.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-pymscada-0.2.0rc2.dist-info/METADATA,sha256=LQXKkPOljU9yFJccl7DrUoLjz1MsGWTnirZ-w8Xaj-U,2371
-pymscada-0.2.0rc2.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-pymscada-0.2.0rc2.dist-info/entry_points.txt,sha256=2UJBi8jrqujnerrcXcq4F8GHJYVDt26sacXl94t3sd8,56
-pymscada-0.2.0rc2.dist-info/top_level.txt,sha256=LxIB-zrtgObJg0fgdGZXBkmNKLDYHfaH1Hw2YP2ZMms,9
-pymscada-0.2.0rc2.dist-info/RECORD,,
+pymscada-0.2.0rc3.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+pymscada-0.2.0rc3.dist-info/METADATA,sha256=ezP-4JEdjL8qwHVyi0q9xrpgaft2BJNez1Ai96k1e5k,2371
+pymscada-0.2.0rc3.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+pymscada-0.2.0rc3.dist-info/entry_points.txt,sha256=2UJBi8jrqujnerrcXcq4F8GHJYVDt26sacXl94t3sd8,56
+pymscada-0.2.0rc3.dist-info/top_level.txt,sha256=LxIB-zrtgObJg0fgdGZXBkmNKLDYHfaH1Hw2YP2ZMms,9
+pymscada-0.2.0rc3.dist-info/RECORD,,