pymscada 0.1.11__py3-none-any.whl → 0.1.11b3__py3-none-any.whl

pymscada/demo/wwwserver.yaml

@@ -2,13 +2,13 @@ bus_ip: 127.0.0.1
 bus_port: 1324
 ip: 0.0.0.0
 port: 8324
-get_path: __HOME__/angmscada/dist/angmscada
-serve_path: __HOME__/pymscada
+get_path:
+serve_path: __HOME__
 pages:
 - name: Notes
   parent:
   items:
-  - type: opnote
+  - type: opnotes
     site: [Site 1, Site 2]
     by: [B1, B2]
 - name: Default Main
@@ -41,469 +41,19 @@ pages:
       - Four
       - Five
   - {tagname: FloatSelect, type: selectdict, opts: {type: float, dp: 2}}
-- name: Trends
-  parent: Dropdown
-  items:
-  - type: uplot  # Do all times in seconds, which uplot uses.
-    ms:
-      desc: Sample Trend
-      age: 172800
-      legend_pos: left
-      time_pos: left
-      time_res: m
-    axes:
-    - scale: x
-      range: [-86400, 0]  # 86400 172800 1209600
-    - scale: '°C'
-      range: [0.0, 100.0]
-      dp: 1
-    - scale: '%'
-      range: [0.0, 100.0]
-      dp: 1
-      # side: 1
-    # bands:  # TODO
-    # - series: [I_Transpower_Limit_Hi, I_Transpower_Limit_Lo]
-    #   fill: [red, 0.2]
-    #   dir: -1
-    series:
-    - tagname: cpu_load
-      label: CPU Load
-      scale: '%'
-      color: black
-      width: 1.5
-      dp: 1
-    - tagname: disk_use
-      label: Disk Use
-      scale: '%'
-      color: blue
-      width: 1
-      dp: 1
-    - tagname: cpu_temp
-      label: CPU Temp
-      scale: '°C'
-      color: red
-      width: 1
-      dp: 1
 - name: Files
-  parent: Dropdown
+  parent:
   items:
   - type: files
-- name: Temperature
-  parent: Weather
-  items:
-  - type: uplot  # Do all times in seconds, which uplot uses.
-    ms:
-      desc: Temperature
-      age: 172800
-      legend_pos: left
-      time_pos: left
-      time_res: m
-    axes:
-    - scale: x
-      range: [-604800, 86400]  # 86400 172800 1209600
-    - scale: 'C'
-      range: [0.0, 35.0]
-      dp: 1
-    series:
-    - tagname: temperature
-      label: Current Temperature
-      scale: 'C'
-      color: black
-      width: 2
-      dp: 1
-    - tagname: temperature_01
-      label: 1h Temperature
-      scale: 'C'
-      color: darkgray
-      width: 1.5
-      dp: 1
-    - tagname: temperature_04
-      label: 4h Temperature
-      scale: 'C'
-      color: green
-      width: 1
-      dp: 1
-    - tagname: temperature_12
-      label: 12h Temperature
-      scale: 'C'
-      color: orange
-      width: 0.75
-      dp: 1
-    - tagname: temperature_24
-      label: 24h Temperature
-      scale: 'C'
-      color: red
-      width: 0.5
-      dp: 1
-- name: Wind Speed
-  parent: Weather
-  items:
-  - type: uplot  # Do all times in seconds, which uplot uses.
-    ms:
-      desc: Wind Speed
-      age: 172800
-      legend_pos: left
-      time_pos: left
-      time_res: m
-    axes:
-    - scale: x
-      range: [-604800, 86400]  # 86400 172800 1209600
-    - scale: 'm/s'
-      range: [0.0, 20.0]
-      dp: 1
-    series:
-    - tagname: windSpeed
-      label: Current Wind Speed
-      scale: 'm/s'
-      color: black
-      width: 2
-      dp: 1
-    - tagname: windSpeed_01
-      label: 1h Wind Speed
-      scale: 'm/s'
-      color: darkgray
-      width: 1.5
-      dp: 1
-    - tagname: windSpeed_04
-      label: 4h Wind Speed
-      scale: 'm/s'
-      color: green
-      width: 1
-      dp: 1
-    - tagname: windSpeed_12
-      label: 12h Wind Speed
-      scale: 'm/s'
-      color: orange
-      width: 0.75
-      dp: 1
-    - tagname: windSpeed_24
-      label: 24h Wind Speed
-      scale: 'm/s'
-      color: red
-      width: 0.5
-      dp: 1
-- name: Wind Direction
-  parent: Weather
-  items:
-  - type: uplot  # Do all times in seconds, which uplot uses.
-    ms:
-      desc: Wind Direction
-      age: 172800
-      legend_pos: left
-      time_pos: left
-      time_res: m
-    axes:
-    - scale: x
-      range: [-604800, 86400]  # 86400 172800 1209600
-    - scale: 'deg'
-      range: [0.0, 360.0]
-      dp: 1
-    series:
-    - tagname: windDirection
-      label: Current Wind Direction
-      scale: 'deg'
-      color: black
-      width: 2
-      dp: 1
-    - tagname: windDirection_01
-      label: 1h Wind Direction
-      scale: 'deg'
-      color: darkgray
-      width: 1.5
-      dp: 1
-    - tagname: windDirection_04
-      label: 4h Wind Direction
-      scale: 'deg'
-      color: green
-      width: 1
-      dp: 1
-    - tagname: windDirection_12
-      label: 12h Wind Direction
-      scale: 'deg'
-      color: orange
-      width: 0.75
-      dp: 1
-    - tagname: windDirection_24
-      label: 24h Wind Direction
-      scale: 'deg'
-      color: red
-      width: 0.5
-      dp: 1
-- name: Rain Accumulation
-  parent: Weather
-  items:
-  - type: uplot  # Do all times in seconds, which uplot uses.
-    ms:
-      desc: Rain Accumulation
-      age: 172800
-      legend_pos: left
-      time_pos: left
-      time_res: m
-    axes:
-    - scale: x
-      range: [-604800, 86400]  # 86400 172800 1209600
-    - scale: 'mm'
-      range: [0.0, 10.0]
-      dp: 1
-    series:
-    - tagname: rainAccumulation
-      label: Current Rain Accumulation
-      scale: 'mm'
-      color: black
-      width: 2
-      dp: 1
-    - tagname: rainAccumulation_01
-      label: 1h Rain Accumulation
-      scale: 'mm'
-      color: darkgray
-      width: 1.5
-      dp: 1
-    - tagname: rainAccumulation_04
-      label: 4h Rain Accumulation
-      scale: 'mm'
-      color: green
-      width: 1
-      dp: 1
-    - tagname: rainAccumulation_12
-      label: 12h Rain Accumulation
-      scale: 'mm'
-      color: orange
-      width: 0.75
-      dp: 1
-    - tagname: rainAccumulation_24
-      label: 24h Rain Accumulation
-      scale: 'mm'
-      color: red
-      width: 0.5
-      dp: 1
-- name: Humidity
-  parent: Weather
-  items:
-  - type: uplot  # Do all times in seconds, which uplot uses.
-    ms:
-      desc: Humidity
-      age: 172800
-      legend_pos: left
-      time_pos: left
-      time_res: m
-    axes:
-    - scale: x
-      range: [-604800, 86400]  # 86400 172800 1209600
-    - scale: '%'
-      range: [0.0, 100.0]
-      dp: 1
-    series:
-    - tagname: humidity
-      label: Current Humidity
-      scale: '%'
-      color: black
-      width: 2
-      dp: 1
-    - tagname: humidity_01
-      label: 1h Humidity
-      scale: '%'
-      color: darkgray
-      width: 1.5
-      dp: 1
-    - tagname: humidity_04
-      label: 4h Humidity
-      scale: '%'
-      color: green
-      width: 1
-      dp: 1
-    - tagname: humidity_12
-      label: 12h Humidity
-      scale: '%'
-      color: orange
-      width: 0.75
-      dp: 1
-    - tagname: humidity_24
-      label: 24h Humidity
-      scale: '%'
-      color: red
-      width: 0.5
-      dp: 1
-- name: Values
-  parent: Weather
-  items:
-  - {tagname: temperature, type: value}
-  - {tagname: temperature_01, type: value}
-  - {tagname: temperature_04, type: value}
-  - {tagname: temperature_12, type: value}
-  - {tagname: temperature_24, type: value}
-  - {tagname: windSpeed, type: value}
-  - {tagname: windSpeed_01, type: value}
-  - {tagname: windSpeed_04, type: value}
-  - {tagname: windSpeed_12, type: value}
-  - {tagname: windSpeed_24, type: value}
-  - {tagname: windDirection, type: value}
-  - {tagname: windDirection_01, type: value}
-  - {tagname: windDirection_04, type: value}
-  - {tagname: windDirection_12, type: value}
-  - {tagname: windDirection_24, type: value}
-  - {tagname: rainAccumulation, type: value}
-  - {tagname: rainAccumulation_01, type: value}
-  - {tagname: rainAccumulation_04, type: value}
-  - {tagname: rainAccumulation_12, type: value}
-  - {tagname: rainAccumulation_24, type: value}
-  - {tagname: humidity, type: value}
-  - {tagname: humidity_01, type: value}
-  - {tagname: humidity_04, type: value}
-  - {tagname: humidity_12, type: value}
-  - {tagname: humidity_24, type: value}
-- name: Logix
-  items:
-  - {tagname: Ani_Fin_20, type: setpoint}
-  - {tagname: Ani_Fout_20, type: value}
-  - {tagname: Ani_Iin_20, type: setpoint}
-  - {tagname: Ani_Iout_20, type: value}
-  - {tagname: InVar, type: setpoint}
-  - {tagname: OutVar, type: value}
-  - {tagname: Ani_Iin_21_0, type: setpoint}
-  - {tagname: Ani_Iout_21_0, type: value}
-  - {tagname: Ani_Iin_21_1, type: setpoint}
-  - {tagname: Ani_Iout_21_1, type: value}
-- name: Values
-  parent: SNMP
-  items:
-  - {tagname: Router_eth1_bytes_in, type: value}
-  - {tagname: Router_eth1_bytes_out, type: value}
-  - {tagname: Router_eth2_bytes_in, type: value}
-  - {tagname: Router_eth2_bytes_out, type: value}
-  - {tagname: Router_eth3_bytes_in, type: value}
-  - {tagname: Router_eth3_bytes_out, type: value}
-  - {tagname: Router_eth4_bytes_in, type: value}
-  - {tagname: Router_eth4_bytes_out, type: value}
-  - {tagname: Router_eth5_bytes_in, type: value}
-  - {tagname: Router_eth5_bytes_out, type: value}
-  - {tagname: Router_eth6_bytes_in, type: value}
-  - {tagname: Router_eth6_bytes_out, type: value}
-  - {tagname: Router_eth7_bytes_in, type: value}
-  - {tagname: Router_eth7_bytes_out, type: value}
-  - {tagname: Router_eth8_bytes_in, type: value}
-  - {tagname: Router_eth8_bytes_out, type: value}
-- name: Trend
-  parent: SNMP
-  items:
-  - type: uplot  # Do all times in seconds, which uplot uses.
-    ms:
-      desc: Bytes
-      age: 172800
-      legend_pos: left
-      time_pos: left
-      time_res: m
-    axes:
-    - scale: x
-      range: [-86400, 0]
-    - scale: 'bytes'
-      range: [0, 100000]
-      dp: 0
-    series:
-    - tagname: Router_eth1_bytes_in
-      label: eth1 in
-      scale: 'bytes'
-      color: violet
-      width: 1
-      dp: 0
-    - tagname: Router_eth1_bytes_out
-      label: eth1 out
-      scale: 'bytes'
-      color: violet
-      width: 0.5
-      dp: 0
-    - tagname: Router_eth2_bytes_in
-      label: eth2 in
-      scale: 'bytes'
-      color: blue
-      width: 1
-      dp: 0
-    - tagname: Router_eth2_bytes_out
-      label: eth2 out
-      scale: 'bytes'
-      color: blue
-      width: 0.5
-      dp: 0
-    - tagname: Router_eth3_bytes_in
-      label: eth3 in
-      scale: 'bytes'
-      color: green
-      width: 1
-      dp: 0
-    - tagname: Router_eth3_bytes_out
-      label: eth3 out
-      scale: 'bytes'
-      color: green
-      width: 0.5
-      dp: 0
-    - tagname: Router_eth4_bytes_in
-      label: eth4 in
-      scale: 'bytes'
-      color: gray
-      width: 1
-      dp: 0
-    - tagname: Router_eth4_bytes_out
-      label: eth4 out
-      scale: 'bytes'
-      color: gray
-      width: 0.5
-      dp: 0
-    - tagname: Router_eth5_bytes_in
-      label: eth5 in
-      scale: 'bytes'
-      color: goldenrod
-      width: 1
-      dp: 0
-    - tagname: Router_eth5_bytes_out
-      label: eth5 out
-      scale: 'bytes'
-      color: goldenrod
-      width: 0.5
-      dp: 0
-    - tagname: Router_eth6_bytes_in
-      label: eth6 in
-      scale: 'bytes'
-      color: brown
-      width: 1
-      dp: 0
-    - tagname: Router_eth6_bytes_out
-      label: eth6 out
-      scale: 'bytes'
-      color: brown
-      width: 0.5
-      dp: 0
-    - tagname: Router_eth7_bytes_in
-      label: eth7 in
-      scale: 'bytes'
-      color: orange
-      width: 1
-      dp: 0
-    - tagname: Router_eth7_bytes_out
-      label: eth7 out
-      scale: 'bytes'
-      color: orange
-      width: 0.5
-      dp: 0
-    - tagname: Router_eth8_bytes_in
-      label: eth8 in
-      scale: 'bytes'
-      color: aqua
-      width: 1
-      dp: 0
-    - tagname: Router_eth8_bytes_out
-      label: eth8 out
-      scale: 'bytes'
-      color: aqua
-      width: 0.5
-      dp: 0
 - name: Ping Values
-  parent: Ping
+  parent:
   items:
   - {desc: Default tags, type: h1}
   - {tagname: localhost_ping, type: value}
   - {tagname: google_ping, type: value}
   - {tagname: electronet_ping, type: value}
 - name: Ping Trend
-  parent: Ping
+  parent:
   items:
   - type: uplot  # Do all times in seconds, which uplot uses.
     ms:
@@ -524,11 +74,6 @@ pages:
       scale: mS
       color: black
       dp: 1
-    - tagname: electronet_ping
-      label: electronet
-      scale: mS
-      color: blue
-      dp: 1
     - tagname: google_ping
       label: google
       scale: mS

pymscada/iodrivers/openweather.py

@@ -0,0 +1,126 @@
+"""Poll OpenWeather current and forecast APIs."""
+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 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:
+        """
+        Connect to bus on bus_ip:bus_port.
+
+        api dict should contain:
+        - api_key: OpenWeatherMap API key
+        - locations: dict of location names and coordinates
+        - times: list of hours ahead to fetch forecast data for
+        - units: optional units (standard, metric, imperial)
+        """
+        self.busclient = None
+        if bus_ip is not None:
+            self.busclient = BusClient(bus_ip, bus_port, module='OpenWeather')
+        self.proxy = proxy
+        self.map_bus = id(self)
+        self.tags = {tagname: Tag(tagname, float) for tagname in tags}
+        self.api_key = api['api_key']
+        self.units = api.get('units', 'standard')
+        self.locations = api.get('locations', {})
+        self.parameters = api.get('parameters', {})
+        self.times = api.get('times', [3, 6, 12, 24, 48])
+        self.current_url = "https://api.openweathermap.org/data/2.5/weather"
+        self.forecast_url = "https://api.openweathermap.org/data/2.5/forecast"
+        self.queue = asyncio.Queue()
+        self.session = None
+        self.handle = None
+        self.periodic = None
+
+    def update_tags(self, location, data, suffix):
+        """Update tags for forecast weather."""
+        for parameter in self.parameters:
+            tagname = f"{location}_{parameter}{suffix}"
+            if parameter == 'Temp':
+                value = data['main']['temp']
+            elif parameter == 'WindSpeed':
+                value = data['wind']['speed']
+            elif parameter == 'WindDir':
+                value = data['wind'].get('deg', 0)
+            elif parameter == 'Rain':
+                value = data.get('rain', {}).get('1h', 0)
+            try:
+                self.tags[tagname].value = value
+            except KeyError:
+                logging.warning(f'{tagname} not found setting weather value')
+
+    async def handle_response(self):
+        """Handle responses from the API."""
+        while True:
+            location, data = await self.queue.get()
+            now = int(time())
+            if 'dt' in data:
+                self.update_tags(location, data, '')
+            elif 'list' in data:
+                for forecast in data['list']:
+                    hours_ahead = int((forecast['dt'] - now) / 3600)
+                    if hours_ahead not in self.times:
+                        continue
+                    suffix = f'_{hours_ahead:02d}'
+                    self.update_tags(location, forecast, suffix)
+
+    async def fetch_current_data(self):
+        """Fetch current weather data for all locations."""
+        if self.session is None:
+            self.session = aiohttp.ClientSession()
+        for location, coords in self.locations.items():
+            base_params = {'lat': coords['lat'], 'lon': coords['lon'],
+                'appid': self.api_key, 'units': self.units }
+            try:
+                async with self.session.get(self.current_url,
+                        params=base_params, proxy=self.proxy) as resp:
+                    if resp.status == 200:
+                        self.queue.put_nowait((location, await resp.json()))
+                    else:
+                        logging.warning('OpenWeather current API error for '
+                            f'{location}: {resp.status}')
+            except Exception as e:
+                logging.warning('OpenWeather current API error for '
+                    f'{location}: {e}')
+
+    async def fetch_forecast_data(self):
+        """Fetch forecast weather data for all locations."""
+        if self.session is None:
+            self.session = aiohttp.ClientSession()
+        for location, coords in self.locations.items():
+            base_params = {'lat': coords['lat'], 'lon': coords['lon'],
+                'appid': self.api_key, 'units': self.units }
+            try:
+                async with self.session.get(self.forecast_url,
+                        params=base_params, proxy=self.proxy) as resp:
+                    if resp.status == 200:
+                        self.queue.put_nowait((location, await resp.json()))
+                    else:
+                        logging.warning('OpenWeather forecast API error '
+                            f'for {location}: {resp.status}')
+            except Exception as e:
+                logging.warning('OpenWeather forecast API error for '
+                    f'{location}: {e}')
+
+    async def poll(self):
+        """Poll OpenWeather APIs every 10 minutes."""
+        now = int(time())
+        if now % 600 == 0:  # Every 10 minutes
+            await self.fetch_current_data()
+        if now % 10800 == 60:  # Every 3 hours, offset by 1 minute
+            await self.fetch_forecast_data()
+
+    async def start(self):
+        """Start bus connection and API 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()