pymscada 0.1.7__tar.gz → 0.1.9__tar.gz

{pymscada-0.1.7 → pymscada-0.1.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pymscada
-Version: 0.1.7
+Version: 0.1.9
 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.1.7 → pymscada-0.1.9}/pyproject.toml

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

{pymscada-0.1.7 → pymscada-0.1.9}/src/pymscada/__init__.py

@@ -2,6 +2,7 @@
 from pymscada.bus_client import BusClient
 from pymscada.bus_server import BusServer
 from pymscada.config import Config
+from pymscada.iodrivers.accuweather import AccuWeatherClient
 from pymscada.iodrivers.logix_client import LogixClient
 from pymscada.iodrivers.modbus_client import ModbusClient
 from pymscada.iodrivers.modbus_server import ModbusServer
@@ -14,6 +15,7 @@ __all__ = [
     'BusClient',
     'BusServer',
     'Config',
+    'AccuWeatherClient',
     'LogixClient',
     'ModbusClient',
     'ModbusServer',

{pymscada-0.1.7 → pymscada-0.1.9}/src/pymscada/bus_client.py

@@ -109,7 +109,7 @@ class BusClient:
             self.ip, self.port)
         self.addr = self.writer.get_extra_info('sockname')
         self.write(pc.CMD_LOG, 0, 0, f'{self.module} connected'.encode())
-        logging.info(f'connected {self.addr}')
+        logging.warning(f'connected {self.addr} {self.port}')
         for tag in Tag.get_all_tags().values():
             self.add_tag(tag)
         Tag.set_notify(self.add_tag)

pymscada-0.1.9/src/pymscada/demo/accuweather.yaml

@@ -0,0 +1,16 @@
+bus_ip: 127.0.0.1
+bus_port: 1325
+proxy: 'http://127.0.0.1:3128'
+api:
+  url: http://dataservice.accuweather.com/forecasts/v1/hourly/12hour/
+  query:
+    apikey: <your key>
+    details: 'true'
+    metric: 'true'
+  locations:
+    Murupara: 246970
+  times: [1, 3, 12]
+tags:
+- MuruparaTemp_1
+- MuruparaTemp_3
+- MuruparaTemp_12

pymscada-0.1.9/src/pymscada/demo/pymscada-io-accuweather.service

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

pymscada-0.1.9/src/pymscada/iodrivers/accuweather.py

@@ -0,0 +1,96 @@
+"""Poll SNMP OIDs from devices."""
+import asyncio
+import aiohttp
+import logging
+from time import time
+from pymscada.bus_client import BusClient
+from pymscada.periodic import Periodic
+from pymscada.tag import Tag
+
+
+class AccuWeatherClient:
+    """Get forecast information from AccuWeather."""
+
+    def __init__(self, bus_ip: str = '127.0.0.1', bus_port: int = 1324,
+                 proxy: str = None, api: dict = {}, tags: dict = {}) -> None:
+        """
+        Connect to bus on bus_ip:bus_port.
+
+        Event loop must be running.
+        """
+        self.busclient = None
+        if bus_ip is not None:
+            self.busclient = BusClient(bus_ip, bus_port, module='AccuWeather')
+        self.proxy = proxy
+        self.map_bus = id(self)
+        self.tags = {tagname: Tag(tagname, float) for tagname in tags}
+        self.api = api
+        self.urls = [[f'{api["url"]}{x}?', api['query']]
+                     for x in api['locations'].values()]
+        self.session = aiohttp.ClientSession()
+        self.queue = asyncio.Queue()
+        self.init_run = True
+
+    async def handle_response(self):
+        """Unpack the weather values from the json response."""
+        while True:
+            resp = await self.queue.get()
+            site = resp[0]
+            json = resp[1]
+            time_s = int(time())
+            time_mod = time_s - time_s % 3600
+            for record in json:
+                epoch = record['EpochDateTime']
+                hour = int((epoch - time_mod) / 3600)
+                logging.warning(f'epoch {epoch} time_s {time_s} hour {hour}')
+                if hour not in self.api['times']:
+                    continue
+                suffix = ''
+                if hour > 0:
+                    suffix = f'_{int(hour)}'
+                for parm, key1, key2, key in [
+                    ['Temp', 'Temperature', None, 'Value'],
+                    ['WindDir', 'Wind', 'Direction', 'Degrees'],
+                    ['WindSpeed', 'Wind', 'Speed', 'Value'],
+                    ['Rain', 'Rain', None, 'Value'],
+                    ['Snow', 'Snow', None, 'Value']
+                ]:
+                    tag = self.tags[f'{site}{parm}{suffix}']
+                    if key2 is None:
+                        value = record[key1][key]
+                    else:
+                        value = record[key1][key2][key]
+                    if tag.value != value:
+                        tag.value = value, int(epoch * 1e6), self.map_bus
+
+    async def fetch_data(self, location, url, query):
+        """HTTP get."""
+        logging.warning(f'poll {location} {url}')
+        try:
+            async with self.session.get(url, params=query,
+                                        proxy=self.proxy) as resp:
+                self.queue.put_nowait([location, await resp.json()])
+        except asyncio.TimeoutError as e:
+            logging.warning('AccuWeather {e}')
+
+    async def poll(self):
+        """Poll the weather site near the start of each hour."""
+        now = int(time())
+        if now % 3600 != 120 and not self.init_run:
+            return
+        self.init_run = False
+        if not self.queue.empty():
+            return
+        # Get the weather forecasts
+        query = self.api['query']
+        for location, location_id in self.api['locations'].items():
+            url = f'{self.api["url"]}{location_id}'
+            asyncio.create_task(self.fetch_data(location, url, query))
+
+    async def start(self):
+        """Start bus connection and PLC polling."""
+        if self.busclient is not None:
+            await self.busclient.start()
+        self.handle = asyncio.create_task(self.handle_response())
+        self.periodic = Periodic(self.poll, 1.0)
+        await self.periodic.start()

{pymscada-0.1.7 → pymscada-0.1.9}/src/pymscada/main.py

@@ -12,6 +12,7 @@ from pymscada.files import Files
 from pymscada.history import History
 from pymscada.opnotes import OpNotes
 from pymscada.www_server import WwwServer
+from pymscada.iodrivers.accuweather import AccuWeatherClient
 from pymscada.iodrivers.logix_client import LogixClient
 from pymscada.iodrivers.modbus_client import ModbusClient
 from pymscada.iodrivers.modbus_server import ModbusServer
@@ -186,6 +187,18 @@ class _validate(Module):
             print(e)
 
 
+class _AccuWeatherClient(Module):
+    """Bus Module."""
+
+    name = 'accuweatherclient'
+    help = 'poll weather information'
+
+    def run_once(self, options):
+        """Create the module."""
+        config = Config(options.config)
+        self.module = AccuWeatherClient(**config)
+
+
 class _LogixClient(Module):
     """Bus Module."""
 
@@ -275,6 +288,7 @@ def args(_version: str):
     _Console(s)
     _checkout(s)
     _validate(s)
+    _AccuWeatherClient(s)
     _LogixClient(s)
     _ModbusServer(s)
     _ModbusClient(s)

{pymscada-0.1.7 → pymscada-0.1.9}/src/pymscada/tag.py

@@ -240,7 +240,7 @@ class Tag(metaclass=UniqueTag):
     def time_us(self, time_us: int):
         """Make sure this is int, should _always_ be. TODO remove."""
         if type(time_us) is not int:
-            logging.warning(f"{self.name} was not an int, FIX.")
+            logging.warning(f"{self.name} time_us was not an int, FIX.")
             self.__time_us = int(time_us)
         else:
             self.__time_us = time_us

{pymscada-0.1.7 → pymscada-0.1.9}/src/pymscada/demo/wwwserver.yaml

@@ -5,6 +5,12 @@ port: 8324
 get_path: __HOME__/angmscada/dist/angmscada
 serve_path: __HOME__/pymscada
 pages:
+- name: Notes
+  parent:
+  items:
+  - type: opnote
+    site: [Site 1, Site 2]
+    by: [B1, B2]
 - name: Default Main
   parent:
   items:
@@ -35,12 +41,6 @@ pages:
       - Four
       - Five
   - {tagname: FloatSelect, type: selectdict, opts: {type: float, dp: 2}}
-- name: Notes
-  parent:
-  items:
-  - type: opnote
-    site: [Site 1, Site 2]
-    by: [B1, B2]
 - name: Trends
   parent: Dropdown
   items: