pymscada 0.2.0rc6__tar.gz → 0.2.0rc8__tar.gz

{pymscada-0.2.0rc6/src/pymscada.egg-info → pymscada-0.2.0rc8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pymscada
-Version: 0.2.0rc6
+Version: 0.2.0rc8
 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.0rc6 → pymscada-0.2.0rc8}/pyproject.toml

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

{pymscada-0.2.0rc6 → pymscada-0.2.0rc8}/src/pymscada/alarms.py

@@ -11,14 +11,12 @@ ALM = 0
 RTN = 1
 ACT = 2
 INF = 3
-
 KIND = {
     ALM: 'ALM',
     RTN: 'RTN',
     ACT: 'ACT',
     INF: 'INF'
 }
-
 NORMAL = 0
 ALARM = 1
 
@@ -46,8 +44,8 @@ def standardise_tag_info(tagname: str, tag: dict):
     if 'desc' not in tag:
         logging.warning(f"Tag {tagname} has no description, using name")
         tag['desc'] = tag['name']
-    if 'area' not in tag:
-        tag['area'] = ''
+    if 'group' not in tag:
+        tag['group'] = ''
     if 'multi' in tag:
         tag['type'] = int
     else:
@@ -107,7 +105,7 @@ class Alarm():
     Generates the ALM and RTN messages for Alarms to publish via rta_tag.
     """
 
-    def __init__(self, tagname: str, tag: dict, alarm: str, area: str, rta_cb, alarms) -> None:
+    def __init__(self, tagname: str, tag: dict, alarm: str, group: str, rta_cb, alarms) -> None:
         """Initialize alarm with tag and condition(s)."""
         self.alarm_id = f'{tagname} {alarm}'
         self.tag = Tag(tagname, tag['type'])
@@ -115,7 +113,7 @@ class Alarm():
         self.tag.dp = tag['dp']
         self.tag.units = tag['units']
         self.tag.add_callback(self.callback)
-        self.area = area
+        self.group = group
         self.rta_cb = rta_cb
         self.alarms = alarms
         self.alarm = split_operator(alarm)
@@ -166,7 +164,7 @@ class Alarm():
             'kind': kind,
             'desc': f'{self.tag.desc} {value:.{self.tag.dp}f}'
                     f' {self.tag.units}',
-            'group': self.area
+            'group': self.group
         })
 
     def check_duration(self, current_time_us: int):
@@ -224,9 +222,10 @@ class Alarms:
             standardise_tag_info(tagname, tag)
             if 'alarm' not in tag or tag['type'] not in (int, float):
                 continue
-            area = tag['area']
+            group = tag['group']
             for alarm in tag['alarm']:
-                new_alarm = Alarm(tagname, tag, alarm, area, self.rta_cb, self)
+                new_alarm = Alarm(tagname, tag, alarm, group, self.rta_cb,
+                                  self)
                 self.alarms.append(new_alarm)
         self.busclient = BusClient(bus_ip, bus_port, module='Alarms')
         self.rta = Tag(rta_tag, dict)

{pymscada-0.2.0rc6 → pymscada-0.2.0rc8}/src/pymscada/bus_client.py

@@ -17,8 +17,8 @@ class BusClient:
     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,
-                 module: str = '_unset_'):
+    def __init__(self, ip: str | None = '127.0.0.1', port: int | None = 1324,
+                 tag_info=None, module: str = '_unset_'):
         """Create bus server."""
         self.ip = ip
         self.port = port

pymscada-0.2.0rc8/src/pymscada/callout.py

@@ -0,0 +1,203 @@
+"""Callout handling."""
+import logging
+import socket
+import time
+from pymscada.bus_client import BusClient
+from pymscada.periodic import Periodic
+from pymscada.tag import Tag
+
+
+"""
+Callout monitors alarms and sends SMS notifications to configured callees.
+
+Configuration:
+- callees: list of recipients with SMS numbers, delays, and group filters
+- alarms_tag: RTA tag receiving alarms from alarms.py
+- ack_tag: tag for receiving acknowledgments
+- rta_tag: tag for configuration updates and SMS requests
+
+Operation:
+1. Collect alarms from alarms_tag (kind=ALM)
+2. For each callee, check if alarms match their group filter and delay
+3. Send SMS via rta_tag when conditions are met
+4. Track sent notifications in alarm['sent'] hash
+5. Remove alarms when callee acknowledges (matches their group)
+"""
+
+ALM = 0
+IDLE = 0
+NEW_ALM = 1
+CALLOUT = 2
+
+
+def normalise_callees(callees: list | None):
+    """Normalise callees to include delay_ms and remove delay."""
+    if callees is None:
+        return []
+    for callee in callees:
+        if 'sms' not in callee:
+            raise ValueError(f'Callee {callee["name"]} has no sms number')
+        if 'delay' in callee:
+            callee['delay_ms'] = callee['delay'] * 1000
+            del callee['delay']
+        else:
+            callee['delay_ms'] = 0
+        if 'group' not in callee:
+            callee['group'] = []
+    callees.sort(key=lambda x: x['delay_ms'])
+    return callees
+
+
+def alarm_in_callee_group(alarm_group: list, callee_group: list):
+    """Check if alarm_group is in callee_group."""
+    if not callee_group:
+        if not alarm_group:
+            return ''
+        return alarm_group[0]
+    if not alarm_group:
+        return None
+    for group in alarm_group:
+        if group in callee_group:
+            return group
+    return None
+
+
+class Callout:
+    """Connect to bus_ip:bus_port, monitor alarms and manage callouts."""
+
+    def __init__(
+        self,
+        bus_ip: str | None = '127.0.0.1',
+        bus_port: int | None = 1324,
+        rta_tag: str = '__callout__',
+        alarms_tag: str | None = None,
+        ack_tag: str | None = None,
+        status_tag: str | None = None,
+        callees: list | None = None,
+        groups: list | None = None
+    ) -> None:
+        """
+        Connect to bus_ip:bus_port, monitor alarms and manage callouts.
+
+        Monitor alarms via alarms_tag and manage callout messages to callees
+        based on configured delays and area filters.
+
+        Event loop must be running.
+
+        For testing only: bus_ip can be None to skip connection.
+        """
+        if bus_ip is None:
+            logging.warning('Callout 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')
+
+        logging.warning(f'Callout {bus_ip} {bus_port} {rta_tag}')
+        self.alarms = []
+        self.callees = normalise_callees(callees)
+        self.groups = []
+        if groups is not None:
+            self.groups = groups
+        self.status = None
+        if status_tag is not None:
+            self.status = Tag(status_tag, int)
+            self.status.value = IDLE
+        self.busclient = BusClient(bus_ip, bus_port, module='Callout')
+        self.busclient.add_callback_rta(alarms_tag, self.alarms_cb)
+        self.busclient.add_callback_rta(ack_tag, self.ack_cb)
+        self.rta = Tag(rta_tag, dict)
+        self.rta.value = {}
+        self.busclient.add_callback_rta(rta_tag, self.rta_cb)
+        self.periodic = Periodic(self.periodic_cb, 1.0)
+
+    def alarms_cb(self, request):
+        """Handle alarm messages from alarms.py."""
+        if request['kind'] != ALM:
+            return
+        alarm = {
+            'date_ms': request['date_ms'],
+            'alarm_string': request['alarm_string'],
+            'desc': request['desc'],
+            'group': request['group'],
+            'sent': {}
+        }
+        self.alarms.append(alarm)
+        logging.info(f'Added alarm to list: {alarm}')
+
+    def ack_cb(self, ack: str):
+        """Handle ACK requests for alarm acknowledgment."""
+        if ack == '__all':
+            self.alarms = []
+            return
+        callee = None
+        for c in self.callees:
+            if ack == c['sms']:
+                callee = c
+                break
+            if ack == c['name']:
+                callee = c
+                break
+        if callee is None:
+            logging.warning(f'ACK rejected: {ack}')
+            return
+        logging.info(f'ACK accepted: {ack}')
+        group = callee['group']
+        remaining_alarms = []
+        for alarm in self.alarms:
+            alarm_group = alarm_in_callee_group(alarm['group'], group)
+            if alarm_group is None:
+                remaining_alarms.append(alarm)
+        self.alarms = remaining_alarms
+
+    def rta_cb(self, request):
+        """Handle RTA requests for callout configuration."""
+        if 'action' not in request:
+            logging.warning(f'rta_cb malformed {request}')
+        elif request['action'] == 'MODIFY':
+            for callee in self.callees:
+                if callee['name'] == request['name']:
+                    if 'delay' in request:
+                        callee['delay_ms'] = request['delay'] * 1000
+                    if 'group' in request:
+                        callee['group'] = request['group']
+                    logging.info(f'Modified callee with {request}')
+
+    def check_callouts(self):
+        """Check alarms and send callouts. Can be called independently for testing."""
+        time_ms = int(time.time() * 1000)
+        for callee in self.callees:
+            message = ''
+            count = 0
+            group = callee['group']
+            notify_ms = time_ms - callee['delay_ms']
+            for alarm in self.alarms:
+                if alarm['date_ms'] < notify_ms:
+                    alarm_group = alarm_in_callee_group(alarm['group'], group)
+                    if alarm_group is not None and callee['name'] not in alarm['sent']:
+                        count += 1
+                        message += f"{alarm['alarm_string']}\n"
+                        alarm['sent'][callee['name']] = time_ms
+            if count > 0:
+                send_message = f"{alarm_group} {count} unack alarms\n{message}"
+                logging.warning(f'Callout to {callee["name"]}: {send_message}')
+                self.rta.value = {'action': 'SMS', 'sms': callee['sms'],
+                                  'message': send_message}
+                if self.status is not None:
+                    self.status.value = CALLOUT
+
+    async def periodic_cb(self):
+        """Periodic callback to check alarms and send callouts."""
+        self.check_callouts()
+
+    async def start(self):
+        """Async startup."""
+        await self.busclient.start()
+        await self.periodic.start()

pymscada-0.2.0rc8/src/pymscada/demo/callout.yaml

@@ -0,0 +1,16 @@
+bus_ip: 127.0.0.1
+bus_port: 1324
+rta_tag: __callout__
+alarms: __alarms__
+ack: SI_Alarm_Ack
+status: SO_Alarm_Status
+callees:
+- name: A name
+  sms: A number
+- name: B name
+  sms: B number
+groups:
+- name: Aniwhenua Station
+  group:
+- name: Aniwhenua System
+  group: System

pymscada-0.2.0rc8/src/pymscada/demo/pymscada-io-witsapi.service

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

{pymscada-0.2.0rc6 → pymscada-0.2.0rc8}/src/pymscada/demo/tags.yaml

@@ -113,10 +113,14 @@ localhost_ping:
   desc: Ping time to localhost
   type: float
   units: ms
+  alarm: '> 500 for 300'
+  group: System
 google_ping:
   desc: Ping time to google
   type: float
   units: ms
+  alarm: '> 100 for 30'
+  group: System
 Murupara_Temp:
   desc: Murupara Temperature
   type: float

{pymscada-0.2.0rc6 → pymscada-0.2.0rc8}/src/pymscada/module_config.py

@@ -9,14 +9,14 @@ from pymscada.config import Config
 class ModuleArgument:
     def __init__(self, args: tuple[str, ...], kwargs: dict[str, Any]):
         self.args = args
-        self.kwargs = kwargs
+        self.kwargs = kwargs 
 
 class ModuleDefinition:
     """Defines a module's configuration and behavior."""
-    def __init__(self, name: str, help: str, module_class: Type[Any], *,
+    def __init__(self, name: str, help: str, module_class: Any, *,
                  config: bool = True, tags: bool = True,
                  epilog: Optional[str] = None,
-                 extra_args: list[ModuleArgument] = None,
+                 extra_args: Optional[list[ModuleArgument]] = None,
                  await_future: bool = True):
         self.name = name
         self.help = help
@@ -63,6 +63,12 @@ def create_module_registry():
             help='alarms',
             module_class='pymscada.alarms:Alarms'
         ),
+        ModuleDefinition(
+            name='callout',
+            help='alarm callout notifications',
+            module_class='pymscada.callout:Callout',
+            tags=False
+        ),
         ModuleDefinition(
             name='validate',
             help='validate config files',

{pymscada-0.2.0rc6 → pymscada-0.2.0rc8/src/pymscada.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pymscada
-Version: 0.2.0rc6
+Version: 0.2.0rc8
 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.0rc6 → pymscada-0.2.0rc8}/src/pymscada.egg-info/SOURCES.txt

@@ -7,6 +7,7 @@ src/pymscada/__main__.py
 src/pymscada/alarms.py
 src/pymscada/bus_client.py
 src/pymscada/bus_server.py
+src/pymscada/callout.py
 src/pymscada/checkout.py
 src/pymscada/config.py
 src/pymscada/console.py
@@ -33,6 +34,7 @@ src/pymscada/demo/__init__.py
 src/pymscada/demo/accuweather.yaml
 src/pymscada/demo/alarms.yaml
 src/pymscada/demo/bus.yaml
+src/pymscada/demo/callout.yaml
 src/pymscada/demo/files.yaml
 src/pymscada/demo/history.yaml
 src/pymscada/demo/logixclient.yaml
@@ -53,11 +55,12 @@ src/pymscada/demo/pymscada-io-modbusserver.service
 src/pymscada/demo/pymscada-io-openweather.service
 src/pymscada/demo/pymscada-io-ping.service
 src/pymscada/demo/pymscada-io-snmpclient.service
+src/pymscada/demo/pymscada-io-witsapi.service
 src/pymscada/demo/pymscada-opnotes.service
 src/pymscada/demo/pymscada-wwwserver.service
 src/pymscada/demo/snmpclient.yaml
 src/pymscada/demo/tags.yaml
-src/pymscada/demo/wits.yaml
+src/pymscada/demo/witsapi.yaml
 src/pymscada/demo/wwwserver.yaml
 src/pymscada/demo/__pycache__/__init__.cpython-311.pyc
 src/pymscada/iodrivers/__init__.py
@@ -82,6 +85,7 @@ src/pymscada/tools/snmp_client2.py
 src/pymscada/tools/walk.py
 tests/test_alarms.py
 tests/test_bus_server.py
+tests/test_callout.py
 tests/test_config.py
 tests/test_history.py
 tests/test_misc.py

pymscada-0.2.0rc8/tests/test_callout.py

@@ -0,0 +1,145 @@
+"""Test Callout."""
+import pytest
+from pymscada.callout import Callout, alarm_in_callee_group, ALM
+
+
+BUS_ID = 123
+CALLEES = [
+    {
+        'name': 'Name Lazy',
+        'sms': 'Lazy number',
+        'delay': 1000,
+        'group': ['NoZone']
+    },
+    {
+        'name': 'Name System',
+        'sms': 'System number',
+        'delay': 1000,
+        'group': ['System']
+    },
+    {
+        'name': 'Name All',
+        'sms': 'All number',
+        'delay': 1000,
+        'group': []
+    }
+]
+GROUPS = [
+    {
+        'name': 'My Group',
+        'group': 'System'
+    }
+]
+
+@pytest.fixture(scope='function')
+def callout():
+    """Create a fixture for Callout."""
+    return Callout(bus_ip=None, callees=CALLEES, groups=GROUPS)
+
+
+def test_alarm_in_callee_group(callout):
+    """Test group in group."""
+    # obvious match
+    assert alarm_in_callee_group(['Test'], ['Test']) == 'Test'
+    # empty callee_group should match all, otherwise match explicit
+    assert alarm_in_callee_group([], []) == ''
+    assert alarm_in_callee_group(['Test'], []) == 'Test'
+    assert alarm_in_callee_group([], ['Test']) == None
+    # return the first matching group from alarms if there is a match
+    assert alarm_in_callee_group(['Test', '2'], ['Test', '2']) == 'Test'
+    # return None is there is no match
+    assert alarm_in_callee_group(['Other'], ['Test']) is None
+
+
+def test_callout(callout):
+    """Basic tests."""
+    co = callout
+    # test callees and groups setup from config variables
+    assert co.callees[0]['name'] == 'Name Lazy'
+    assert co.callees[0]['delay_ms'] == 1000000
+    assert co.callees[0]['group'] == ['NoZone']
+    assert co.groups[0]['name'] == 'My Group'
+    assert co.groups[0]['group'] == 'System'
+    # test update in the callee group
+    callee_update = {
+        'action': 'MODIFY',
+        'name': 'Name Lazy',
+        'group': ['Still No Zone']
+    }
+    co.rta_cb(callee_update)
+    assert co.callees[0]['delay_ms'] == 1000000
+    assert co.callees[0]['group'] == ['Still No Zone']
+
+
+def test_new_alarm(callout):
+    """Test new alarm."""
+    values = []
+
+    def rta_cb(tag):
+        # the SMS modem module should monitor this tag to send SMSs
+        values.append(tag.value)
+
+    co = callout
+    co.rta.add_callback(rta_cb, BUS_ID)
+    # alarm should go to All and System
+    alarm = {
+        'date_ms': 12345,
+        'alarm_string': 'sys alarm',
+        'kind': ALM,
+        'desc': 'System Alarm',
+        'group': ['System']
+    }
+    co.alarms_cb(alarm)
+    co.check_callouts()
+    # doesn't have to be in the order in CALLEES, but it is so ...
+    assert values[0]['action'] == 'SMS'
+    assert values[0]['sms'] == 'System number'
+    assert values[1]['action'] == 'SMS'
+    assert values[1]['sms'] == 'All number'
+    assert 'Name Lazy' not in co.alarms[0]['sent']
+    assert 'Name System' in co.alarms[0]['sent']
+    assert 'Name All' in co.alarms[0]['sent']
+    # Alarm should go to All
+    alarm = {
+        'date_ms': 12345,
+        'alarm_string': 'all alarm',
+        'kind': ALM,
+        'desc': 'Broadcast Alarm',
+        'group': []
+    }
+    co.alarms_cb(alarm)
+    co.check_callouts()
+    assert values[2]['action'] == 'SMS'
+    assert values[2]['sms'] == 'All number'
+    assert 'Name Lazy' not in co.alarms[1]['sent']
+    assert 'Name All' in co.alarms[1]['sent']
+    assert 'Name System' not in co.alarms[1]['sent']
+
+
+def test_ack_functionality(callout):
+    """Test ACK functionality with sent hash."""
+    co = callout
+    alarm = {
+        'date_ms': 12345,
+        'alarm_string': 'sys alarm',
+        'kind': ALM,
+        'desc': 'System Alarm',
+        'group': ['System']
+    }
+    co.alarms_cb(alarm)
+    co.check_callouts()
+    assert 'Name Lazy' not in co.alarms[0]['sent']
+    assert 'Name System' in co.alarms[0]['sent']
+    assert 'Name All' in co.alarms[0]['sent']
+    co.ack_cb('__all')
+    assert len(co.alarms) == 0
+    co.alarms_cb(alarm)
+    co.check_callouts()
+    co.ack_cb('Lazy number')
+    assert len(co.alarms) == 1
+    co.ack_cb('System number')
+    assert len(co.alarms) == 0
+    co.alarms_cb(alarm)
+    co.check_callouts()
+    co.ack_cb('All number')
+    assert len(co.alarms) == 0