pymscada 0.1.0a3__tar.gz → 0.1.0a4__tar.gz

{pymscada-0.1.0a3 → pymscada-0.1.0a4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pymscada
-Version: 0.1.0a3
+Version: 0.1.0a4
 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.0a3 → pymscada-0.1.0a4}/pyproject.toml

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

{pymscada-0.1.0a3 → pymscada-0.1.0a4}/src/pymscada/checkout.py

@@ -1,4 +1,5 @@
 """Create base config folder and check out demo files."""
+import difflib
 from pathlib import Path
 import sys
 from pymscada.config import get_demo_files, get_pdf_files
@@ -36,7 +37,7 @@ def make_pdf():
         target.write_bytes(pdf_file.read_bytes())
 
 
-def make_config(overwrite):
+def make_config(overwrite: bool):
     """Make the config folder, if missing, and copy files in."""
     config_dir = PATH['__DIR__'].joinpath('config')
     if not config_dir.exists():
@@ -62,11 +63,43 @@ def make_config(overwrite):
             target.write_bytes(config_file.read_bytes())
 
 
-def checkout(overwrite=False):
+def read_with_subst(file: Path):
+    """Read the file and replace DIR markers."""
+    rd = file.read_bytes().decode()
+    if str(file).endswith('service'):
+        for k, v in PATH.items():
+            rd = rd.replace(k, str(v.absolute()))
+    lines = rd.splitlines()
+    return lines
+
+
+def compare_config():
+    """Compare old and new config."""
+    config_dir = PATH['__DIR__'].joinpath('config')
+    if not config_dir.exists():
+        print('No config dir, are you in the right directory')
+        return
+    for config_file in get_demo_files():
+        target = config_dir.joinpath(config_file.name)
+        if target.exists():
+            new_lines = read_with_subst(config_file)
+            old_lines = read_with_subst(target)
+            diff = list(difflib.unified_diff(old_lines, new_lines,
+                        fromfile=str(target), tofile=str(config_file)))
+            if len(diff):
+                print('\n'.join(diff), '\n')
+        else:
+            print(f'\n--- MISSING FILE\n\n+++ {config_file}')
+
+
+def checkout(overwrite=False, diff=False):
     """Do it."""
     for name in PATH:
         if not PATH[name].exists():
             raise SystemExit(f'{PATH[name]} is missing')
-    make_history()
-    make_pdf()
-    make_config(overwrite)
+    if diff:
+        compare_config()
+    else:
+        make_history()
+        make_pdf(diff)
+        make_config(overwrite, diff)

pymscada-0.1.0a4/src/pymscada/demo/ping.yaml

@@ -0,0 +1,12 @@
+bus_ip: 127.0.0.1
+bus_port: 1324
+tags:
+  localhost_ping:
+    type: ping
+    addr: '127.0.0.1'
+  electronet_ping:
+    type: ping
+    addr: electronet.co.nz
+  google_ping:
+    type: ping
+    addr: www.google.com

pymscada-0.1.0a4/src/pymscada/demo/pymscada-io-ping.service

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

{pymscada-0.1.0a3 → pymscada-0.1.0a4}/src/pymscada/demo/tags.yaml

@@ -253,4 +253,13 @@ Router_eth8_bytes_in:
   type: int
 Router_eth8_bytes_out:
   desc: eth8 bytes out
-  type: int
+  type: int
+localhost_ping:
+  desc: Ping time to localhost
+  units: ms
+google_ping:
+  desc: Ping time to google
+  units: ms
+electronet_ping:
+  desc: Ping time to electronet
+  units: ms

pymscada-0.1.0a4/src/pymscada/demo/wwwserver.yaml

@@ -0,0 +1,533 @@
+bus_ip: 127.0.0.1
+bus_port: 1324
+ip: 0.0.0.0
+port: 8324
+get_path:
+paths:
+- history
+- config
+- pdf
+pages:
+- name: Default Main
+  parent:
+  items:
+  - {desc: Default tags, type: h1}
+  - {tagname: IntSet, type: setpoint}
+  - {tagname: IntVal, type: value}
+  - {tagname: FloatSet, type: setpoint}
+  - {tagname: FloatVal, type: value}
+  - {tagname: MultiSet, type: setpoint}
+  - {tagname: MultiVal, type: value}
+  - {tagname: StringSet, type: setpoint}
+  - {tagname: StringVal, type: value}
+  - {tagname: TimeSet, type: setpoint}
+  - {tagname: TimeVal, type: value}
+  - {tagname: DateSet, type: setpoint}
+  - {tagname: DateVal, type: value}
+  - {tagname: DateTimeSet, type: setpoint}
+  - {tagname: DateTimeVal, type: value}
+  - type: selectdict
+    tagname: MultiSelect
+    opts:
+      type: multi
+      multi:
+      - Zero
+      - One
+      - Two
+      - Three
+      - 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
+  items:
+  - {tagname: __files__, 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
+  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
+  items:
+  - type: uplot  # Do all times in seconds, which uplot uses.
+    ms:
+      desc: Ping Trend
+      age: 172800
+      legend_pos: left
+      time_pos: left
+      time_res: m
+    axes:
+    - scale: x
+      range: [-86400, 0]  # 86400 172800 1209600
+    - scale: mS
+      range: [0.0, 1.0]
+      dp: 1
+    series:
+    - tagname: localhost_ping
+      label: localhost
+      scale: mS
+      color: black
+      dp: 1
+    - tagname: electronet_ping
+      label: electronet
+      scale: mS
+      color: blue
+      dp: 1
+    - tagname: google_ping
+      label: google
+      scale: mS
+      color: red
+      dp: 1

pymscada-0.1.0a4/src/pymscada/iodrivers/ping_client.py

@@ -0,0 +1,120 @@
+"""Network monitoring / scanning."""
+import asyncio
+import logging
+import socket
+import struct
+import time
+from pymscada.bus_client import BusClient
+from pymscada.periodic import Periodic
+from pymscada.iodrivers.ping_map import PingMaps
+
+
+ICMP_REQUEST = 8
+ICMP_REPLY = 0
+RATE = 60
+
+
+def checksum_chat(data):
+    """Calculate ICMP Checksum."""
+    if len(data) & 1:  # If the packet length is odd
+        data += b'\0'
+    res = 0
+    # Process two bytes at a time
+    for i in range(0, len(data), 2):
+        res += (data[i] << 8) + data[i + 1]
+    res = (res >> 16) + (res & 0xffff)
+    res += res >> 16
+    return (~res) & 0xffff  # Return ones' complement of the result
+
+
+class PingClientConnector:
+    """Ping a list of addresses."""
+
+    def __init__(self, mapping: PingMaps):
+        """Accept list of addresses, ip or name."""
+        self.mapping = mapping
+        self.dns = {}
+        self.addr_info = {}
+        self.socket = None
+        self.ping_id = 0
+        self.ping_dict = {}
+
+    async def poll(self):
+        """Do pings."""
+        self.reply_dict = {}
+        if self.socket is None:
+            self.socket = socket.socket(socket.AF_INET, socket.SOCK_RAW,
+                                        socket.IPPROTO_ICMP)
+            asyncio.get_event_loop().add_reader(self.socket,
+                                                self.read_response)
+        for ping_id, address in list(self.ping_dict.items()):
+            logging.info(f'failed {self.dns[address]} {ping_id}')
+            self.mapping.polled_data(self.dns[address], float('NAN'))
+            del self.ping_dict[ping_id]
+        self.send_ping()
+
+    def send_ping(self):
+        """Build and send ping messages."""
+        for address in self.dns.keys():
+            self.ping_id = (self.ping_id + 1) & 0xffff
+            self.ping_dict[self.ping_id] = address
+            logging.info(f'ping {address} id {self.ping_id}')
+            header = struct.pack("!BbHHh", ICMP_REQUEST, 0, 0, self.ping_id, 1)
+            data = struct.pack("!d", time.perf_counter()) + (60 * b'\0')
+            checksum = checksum_chat(header + data)
+            packet = struct.pack("!BbHHh", ICMP_REQUEST, 0, checksum,
+                                 self.ping_id, 1) + data
+            self.socket.sendto(packet, (address, 0))
+
+    def read_response(self):
+        """Match ping response."""
+        data, address = self.socket.recvfrom(1024)
+        msgtype, _, _, ping_id, _ = struct.unpack('!BBHHH', data[20:28])
+        if msgtype != ICMP_REPLY:
+            return
+        if ping_id in self.ping_dict:
+            latency = 1000 * (time.perf_counter() -
+                              struct.unpack('!d', data[28:36])[0])
+            name = self.dns[address[0]]
+            logging.info(f'success {name} {ping_id} {latency}ms')
+            self.mapping.polled_data(name, latency)
+            del self.ping_dict[ping_id]
+
+    async def start(self):
+        """Start pinging."""
+        loop = asyncio.get_event_loop()
+        for address in self.mapping.var_map.keys():
+            info = await loop.getaddrinfo(address, None, family=socket.AF_INET,
+                                          type=socket.SOCK_STREAM)
+            ip = info[0][4][0]
+            self.dns[ip] = address
+        self.periodic = Periodic(self.poll, RATE)
+        await self.periodic.start()
+
+
+class PingClient:
+    """Ping client."""
+
+    def __init__(self, bus_ip: str = '127.0.0.1', bus_port: int = 1324,
+                 tags: dict = {}) -> None:
+        """
+        Connect to bus on bus_ip:bus_port, ping a list.
+
+        Event loop must be running.
+        """
+        self.busclient = None
+        if bus_ip is not None:
+            self.busclient = BusClient(bus_ip, bus_port)
+        self.mapping = PingMaps(tags)
+        self.pinger = PingClientConnector(mapping=self.mapping)
+
+    async def _poll(self):
+        """For testing."""
+        for connection in self.connections:
+            await connection.poll()
+
+    async def start(self):
+        """Start bus connection and PLC polling."""
+        if self.busclient is not None:
+            await self.busclient.start()
+        await self.pinger.start()

pymscada-0.1.0a4/src/pymscada/iodrivers/ping_map.py

@@ -0,0 +1,43 @@
+"""Map between snmp MIB and Tag."""
+from time import time
+from pymscada.tag import Tag
+
+
+class PingMap:
+    """Do value updates for each tag."""
+
+    def __init__(self, tagname: str, addr: str):
+        """Initialise MIB map and Tag."""
+        self.last_value = None
+        self.tag = Tag(tagname, float)
+        self.addr = addr
+        self.map_bus = id(self)
+
+    def set_tag_value(self, value, time_us):
+        """Pass update from IO driver to tag value."""
+        if self.last_value is None:
+            self.last_value = value
+            return
+        if self.last_value != value:
+            self.tag.value = value, time_us, self.map_bus
+
+
+class PingMaps:
+    """Link tags with protocol connector."""
+
+    def __init__(self, tags: dict):
+        """Collect maps based on a tag dictionary."""
+        # use the tagname to access the map.
+        self.tag_map: dict[str, PingMap] = {}
+        # use the plc_name then variable name to access a list of maps.
+        self.var_map: dict[str, PingMap] = {}
+        for tagname, v in tags.items():
+            addr = v['addr']
+            map = PingMap(tagname, addr)
+            self.var_map[addr] = map
+            self.tag_map[tagname] = map
+
+    def polled_data(self, address, latency):
+        """Pass updates read from the PLC to the tags."""
+        time_us = int(time() * 1e6)
+        self.var_map[address].set_tag_value(latency, time_us)

{pymscada-0.1.0a3 → pymscada-0.1.0a4}/src/pymscada/main.py

@@ -3,6 +3,7 @@ import argparse
 import asyncio
 from importlib.metadata import version
 import logging
+import sys
 from pymscada.bus_server import BusServer
 from pymscada.checkout import checkout
 from pymscada.config import Config
@@ -12,11 +13,15 @@ from pymscada.history import History
 from pymscada.iodrivers.logix_client import LogixClient
 from pymscada.iodrivers.modbus_client import ModbusClient
 from pymscada.iodrivers.modbus_server import ModbusServer
+from pymscada.iodrivers.ping_client import PingClient
 from pymscada.iodrivers.snmp_client import SnmpClient
 from pymscada.www_server import WwwServer
 from pymscada.validate import validate
 
 
+MODULES = {}
+
+
 async def bus(options):
     """Return bus module."""
     config = Config(options.config)
@@ -50,7 +55,7 @@ async def console(_options):
 
 async def _checkout(options):
     """Checkout files in current working directory."""
-    checkout(overwrite=options.overwrite)
+    checkout(overwrite=options.overwrite, diff=options.diff)
     return
 
 
@@ -82,6 +87,14 @@ async def logixclient(options):
     return LogixClient(**config)
 
 
+async def ping(options):
+    """Return logixclient module."""
+    if sys.platform.startswith("win"):
+        asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
+    config = Config(options.config)
+    return PingClient(**config)
+
+
 async def snmpclient(options):
     """Return snmpclient module."""
     config = Config(options.config)
@@ -90,16 +103,16 @@ async def snmpclient(options):
 
 def add_subparser_defaults(
         parser: argparse._SubParsersAction,
-        name: str, call, help: str):
+        name: str, call, help: str, epilog: str):
     """Add arguments common to all subparsers."""
-    s = parser.add_parser(name, help=help)
+    s = parser.add_parser(name, help=help, epilog=epilog)
     s.set_defaults(get_module=call, module=name)
     s.add_argument('--config', metavar='file', default=None,
-                   help=f'Config file, default is "{name}.yaml".')
+                   help=f"Config file, default is '{name}.yaml'")
     s.add_argument('--tags', metavar='file', default=None,
-                   help='Tags file, default is "tags.yaml".')
+                   help="Tags file, default is 'tags.yaml'")
     s.add_argument('--verbose', action='store_true',
-                   help="Set level to logging.INFO.")
+                   help="Set level to logging.INFO")
     return s
 
 
@@ -111,24 +124,36 @@ def args(_version: str):
         epilog=f'Python Mobile SCADA {_version}'
     )
     subparsers = parser.add_subparsers(title='module')
-    for module, func, help in [
-        ['bus', bus, 'run the message bus'],
-        ['wwwserver', wwwserver, 'serve web pages'],
-        ['history', history, 'collect and serve history'],
-        ['files', files, 'receive and send files'],
-        ['console', console, 'interactive bus console'],
-        ['checkout', _checkout, 'create example config files'],
-        ['validate', _validate, 'validate config files'],
-        ['modbusserver', modbusserver, 'receive modbus messages'],
-        ['modbusclient', modbusclient, 'poll/write to modbus devices'],
-        ['logixclient', logixclient, 'poll/write to logix devices'],
-        ['snmpclient', snmpclient, 'poll snmp oids'],
+    for module, func, help, epilog in [
+        ['bus', bus, 'run the message bus', None],
+        ['wwwserver', wwwserver, 'serve web pages', None],
+        ['history', history, 'collect and serve history', None],
+        ['files', files, 'receive and send files', None],
+        ['console', console, 'interactive bus console', None],
+        ['checkout', _checkout, 'create example config files', """
+            To add to systemd `f="pymscada-bus" && cp config/$f.service
+            /lib/systemd/system && systemctl enable $f && systemctl start
+            $f`"""],
+        ['validate', _validate, 'validate config files', None],
+        ['modbusserver', modbusserver, 'receive modbus messages', """
+            Needs `setcap CAP_NET_BIND_SERVICE=+eip /usr/bin/python3.nn` to
+            bind to port 502"""],
+        ['modbusclient', modbusclient, 'poll/write to modbus devices', None],
+        ['ping', ping, 'ping a list of addresses, return time', """
+            Needs `setcap CAP_NET_RAW+ep /usr/bin/python3.nn` to open SOCK_RAW
+            """],
+        ['logixclient', logixclient, 'poll/write to logix devices', None],
+        ['snmpclient', snmpclient, 'poll snmp oids', None],
     ]:
-        modparser = add_subparser_defaults(subparsers, module, func, help)
+        modparser = add_subparser_defaults(subparsers, module, func, help,
+                                           epilog)
         if module == 'checkout':
             modparser.add_argument(
                 '--overwrite', action='store_true', default=False,
                 help='checkout may overwrite files, CARE!')
+            modparser.add_argument(
+                '--diff', action='store_true', default=False,
+                help='compare default with existing')
         elif module == 'validate':
             modparser.add_argument(
                 '--path', metavar='file',

pymscada-0.1.0a3/src/pymscada/demo/wwwserver.yaml

@@ -1,87 +0,0 @@
-bus_ip: 127.0.0.1
-bus_port: 1324
-ip: 0.0.0.0
-port: 8324
-get_path:
-paths:
-- history
-- config
-- pdf
-pages:
-- name: Default Main
-  parent:
-  items:
-  - {desc: Default tags, type: h1}
-  - {tagname: IntSet, type: setpoint}
-  - {tagname: IntVal, type: value}
-  - {tagname: FloatSet, type: setpoint}
-  - {tagname: FloatVal, type: value}
-  - {tagname: MultiSet, type: setpoint}
-  - {tagname: MultiVal, type: value}
-  - {tagname: StringSet, type: setpoint}
-  - {tagname: StringVal, type: value}
-  - {tagname: TimeSet, type: setpoint}
-  - {tagname: TimeVal, type: value}
-  - {tagname: DateSet, type: setpoint}
-  - {tagname: DateVal, type: value}
-  - {tagname: DateTimeSet, type: setpoint}
-  - {tagname: DateTimeVal, type: value}
-  - type: selectdict
-    tagname: MultiSelect
-    opts:
-      type: multi
-      multi:
-      - Zero
-      - One
-      - Two
-      - Three
-      - 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
-  items:
-  - {tagname: __files__, type: files}