pymscada 0.0.13__tar.gz → 0.0.15__tar.gz

{pymscada-0.0.13 → pymscada-0.0.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pymscada
-Version: 0.0.13
+Version: 0.0.15
 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
@@ -16,6 +16,7 @@ Requires-Dist: aiohttp>=3.8.5
 Requires-Dist: pymscada-html<=0.1.0
 Requires-Dist: cerberus>=1.3.5
 Requires-Dist: pycomm3>=1.2.14
+Requires-Dist: pysnmplib>=5.0.24
 Description-Content-Type: text/markdown
 
 # pymscada
@@ -25,20 +26,39 @@ Description-Content-Type: text/markdown
 
 ## Python Mobile SCADA
 
+This is an open source Python SCADA package intended for use over your
+mobile phone. It has been developed to connect custom python scripts to
+Modicon and Rockwell PLCs, and present a web based user interface, with
+minimal coding. ```pymscada``` does expect you to be able to use python.
+
+```pymscada``` shares values through a ```Tag``` for all data. Tag values
+are updated by exception through a message bus. Changes are in any
+direction with simple loops stopped with a simplistic _don't send updates
+back to where they came from_ check. It's too simple to stop you defeating
+it (but there are easier ways to break the code).
+
+There are primary owner Tag's. A _request to set_ command is passed to the
+author of the Tag, where it is updated. This allows database information
+to pass through the Tag values as well. Tag values are typically float or
+int however they may also be megabyte sized binary or dictionary values.
+
+Example ```systemd``` service files, pymscada module config files and
+custom script examples are included. The example scripts include polling
+weather from tommorrow.io and a python script based Modbus TCP PLC.
+
+## Introduction
+
 This is a small SCADA package that will run on Linux (preferably) or
 Windows. The server runs as several modules on the host, sharing
 information through a message bus. A __subset__ of modules is:
 
 - Bus server - shares tag values with by exception updates
 - Modbus client - reads and writes to a PLC using Modbus/TCP
+- Logix client - uses ```pycomm3``` to read / write to Rockwell PLCs
+- SNMP client - polls SNMP OID values
 - History - saves data changes, serves history to web pages
 - Web server - serves web pages which connect with a web socket
-- Web pages - an Angular single page web application
-
-Web pages are responsive and defined procedurally from the
-```wwwserver.yaml``` config file.
-
-Trends use [uPlot](https://github.com/leeoniya/uPlot).
+- Web pages - procedurally generated setpoint, indication and trends
 
 ## Objectives
 

{pymscada-0.0.13 → pymscada-0.0.15}/README.md

@@ -5,20 +5,39 @@
 
 ## Python Mobile SCADA
 
+This is an open source Python SCADA package intended for use over your
+mobile phone. It has been developed to connect custom python scripts to
+Modicon and Rockwell PLCs, and present a web based user interface, with
+minimal coding. ```pymscada``` does expect you to be able to use python.
+
+```pymscada``` shares values through a ```Tag``` for all data. Tag values
+are updated by exception through a message bus. Changes are in any
+direction with simple loops stopped with a simplistic _don't send updates
+back to where they came from_ check. It's too simple to stop you defeating
+it (but there are easier ways to break the code).
+
+There are primary owner Tag's. A _request to set_ command is passed to the
+author of the Tag, where it is updated. This allows database information
+to pass through the Tag values as well. Tag values are typically float or
+int however they may also be megabyte sized binary or dictionary values.
+
+Example ```systemd``` service files, pymscada module config files and
+custom script examples are included. The example scripts include polling
+weather from tommorrow.io and a python script based Modbus TCP PLC.
+
+## Introduction
+
 This is a small SCADA package that will run on Linux (preferably) or
 Windows. The server runs as several modules on the host, sharing
 information through a message bus. A __subset__ of modules is:
 
 - Bus server - shares tag values with by exception updates
 - Modbus client - reads and writes to a PLC using Modbus/TCP
+- Logix client - uses ```pycomm3``` to read / write to Rockwell PLCs
+- SNMP client - polls SNMP OID values
 - History - saves data changes, serves history to web pages
 - Web server - serves web pages which connect with a web socket
-- Web pages - an Angular single page web application
-
-Web pages are responsive and defined procedurally from the
-```wwwserver.yaml``` config file.
-
-Trends use [uPlot](https://github.com/leeoniya/uPlot).
+- Web pages - procedurally generated setpoint, indication and trends
 
 ## Objectives
 

{pymscada-0.0.13 → pymscada-0.0.15}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pymscada"
-version = "0.0.13"
+version = "0.0.15"
 description = "Shared tag value SCADA with python backup and Angular UI"
 authors = [
     { name = "Jamie Walton", email = "jamie@walton.net.nz" },
@@ -11,6 +11,7 @@ dependencies = [
     "pymscada-html<=0.1.0",
     "cerberus>=1.3.5",
     "pycomm3>=1.2.14",
+    "pysnmplib>=5.0.24",
 ]
 requires-python = ">=3.9"
 readme = "README.md"

{pymscada-0.0.13 → pymscada-0.0.15}/src/pymscada/demo/logixclient.yaml

@@ -9,37 +9,42 @@ rtus:
   - {addr: Iout, type: 'DINT[]', start: 0, end: 99}
   - {addr: OutVar, type: REAL}
   writeok:
-  - {addr: Fin, start: 0, end: 99}
-  - {addr: Iin, start: 0, end: 99}
+  - {addr: Fin, type: 'REAL[]', start: 0, end: 99}
+  - {addr: Iin, type: 'REAL[]', start: 0, end: 99}
   - {addr: InVar, type: REAL}
 tags:
+  Ani_Fin_20:
+    type: float32
+    read: 'Ani:Fout[20]'
+    write: 'Ani:Fin[20]'
   Ani_Fout_20:
     type: float32
     addr: 'Ani:Fout[20]'
+  Ani_Iin_20:
+    type: int32
+    read: 'Ani:Iout[20]'
+    write: 'Ani:Iin[20]'
   Ani_Iout_20:
     type: int32
     addr: 'Ani:Iout[20]'
+  Ani_Iin_21_0:
+    type: bool
+    read: 'Ani:Iout[21].0'
+    write: 'Ani:Iin[21].0'
   Ani_Iout_21_0:
     type: bool
     addr: 'Ani:Iout[21].0'
+  Ani_Iin_21_1:
+    type: bool
+    read: 'Ani:Iout[21].1'
+    write: 'Ani:Iin[21].1'
   Ani_Iout_21_1:
     type: bool
     addr: 'Ani:Iout[21].1'
-  Ani_Fin_20:
-    type: float32
-    addr: 'Ani:Fin[20]'
-  Ani_Iin_20:
-    type: int32
-    addr: 'Ani:Iin[20]'
   InVar:
     type: float32
-    addr: Ani:InVar
+    read: Ani:OutVar
+    write: Ani:InVar
   OutVar:
     type: float32
-    addr: Ani:OutVar
-  Ani_Iin_21_0:
-    type: bool
-    addr: 'Ani:Iin[21].0'
-  Ani_Iin_21_1:
-    type: bool
-    addr: 'Ani:Iin[21].1'
+    addr: Ani:OutVar

{pymscada-0.0.13 → pymscada-0.0.15}/src/pymscada/demo/pymscada-io-logixclient.service

@@ -4,8 +4,8 @@
     After=pymscada-bus.service
 
 [Service]
-    WorkingDirectory=/home/mscada
-    ExecStart=/usr/bin/python -m pymscada_pycomm3
+    WorkingDirectory=__DIR__
+    ExecStart=__PYMSCADA__ logixclient --config __DIR__/config/logixclient.yaml
     Restart=always
     RestartSec=5
     User=mscada

pymscada-0.0.15/src/pymscada/demo/pymscada-io-snmpclient.service

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

pymscada-0.0.15/src/pymscada/demo/snmpclient.yaml

@@ -0,0 +1,73 @@
+bus_ip: 127.0.0.1
+bus_port: 1324
+rtus:
+- name: router
+  ip: 172.26.3.254
+  community: public
+  rate: 10
+  read:
+  - '1.3.6.1.2.1.31.1.1.1.6.1'
+  - '1.3.6.1.2.1.31.1.1.1.6.2'
+  - '1.3.6.1.2.1.31.1.1.1.6.3'
+  - '1.3.6.1.2.1.31.1.1.1.6.4'
+  - '1.3.6.1.2.1.31.1.1.1.6.5'
+  - '1.3.6.1.2.1.31.1.1.1.6.6'
+  - '1.3.6.1.2.1.31.1.1.1.6.7'
+  - '1.3.6.1.2.1.31.1.1.1.6.8'
+  - '1.3.6.1.2.1.31.1.1.1.10.1'
+  - '1.3.6.1.2.1.31.1.1.1.10.2'
+  - '1.3.6.1.2.1.31.1.1.1.10.3'
+  - '1.3.6.1.2.1.31.1.1.1.10.4'
+  - '1.3.6.1.2.1.31.1.1.1.10.5'
+  - '1.3.6.1.2.1.31.1.1.1.10.6'
+  - '1.3.6.1.2.1.31.1.1.1.10.7'
+  - '1.3.6.1.2.1.31.1.1.1.10.8'
+tags:
+  Router_eth1_bytes_in:
+    type: int_roc
+    addr: 'router:1.3.6.1.2.1.31.1.1.1.6.1'
+  Router_eth1_bytes_out:
+    type: int_roc
+    addr: 'router:1.3.6.1.2.1.31.1.1.1.10.1'
+  Router_eth2_bytes_in:
+    type: int_roc
+    addr: 'router:1.3.6.1.2.1.31.1.1.1.6.2'
+  Router_eth2_bytes_out:
+    type: int_roc
+    addr: 'router:1.3.6.1.2.1.31.1.1.1.10.2'
+  Router_eth3_bytes_in:
+    type: int_roc
+    addr: 'router:1.3.6.1.2.1.31.1.1.1.6.3'
+  Router_eth3_bytes_out:
+    type: int_roc
+    addr: 'router:1.3.6.1.2.1.31.1.1.1.10.3'
+  Router_eth4_bytes_in:
+    type: int_roc
+    addr: 'router:1.3.6.1.2.1.31.1.1.1.6.4'
+  Router_eth4_bytes_out:
+    type: int_roc
+    addr: 'router:1.3.6.1.2.1.31.1.1.1.10.4'
+  Router_eth5_bytes_in:
+    type: int_roc
+    addr: 'router:1.3.6.1.2.1.31.1.1.1.6.5'
+  Router_eth5_bytes_out:
+    type: int_roc
+    addr: 'router:1.3.6.1.2.1.31.1.1.1.10.5'
+  Router_eth6_bytes_in:
+    type: int_roc
+    addr: 'router:1.3.6.1.2.1.31.1.1.1.6.6'
+  Router_eth6_bytes_out:
+    type: int_roc
+    addr: 'router:1.3.6.1.2.1.31.1.1.1.10.6'
+  Router_eth7_bytes_in:
+    type: int_roc
+    addr: 'router:1.3.6.1.2.1.31.1.1.1.6.7'
+  Router_eth7_bytes_out:
+    type: int_roc
+    addr: 'router:1.3.6.1.2.1.31.1.1.1.10.7'
+  Router_eth8_bytes_in:
+    type: int_roc
+    addr: 'router:1.3.6.1.2.1.31.1.1.1.6.8'
+  Router_eth8_bytes_out:
+    type: int_roc
+    addr: 'router:1.3.6.1.2.1.31.1.1.1.10.8'

{pymscada-0.0.13 → pymscada-0.0.15}/src/pymscada/demo/tags.yaml

@@ -165,4 +165,52 @@ sim_DateTimeSet:
   type: int
 sim_DateTimeVal:
   desc: Simulation tag
+  type: int
+Router_eth1_bytes_in:
+  desc: eth1 bytes in
+  type: int
+Router_eth1_bytes_out:
+  desc: eth1 bytes out
+  type: int
+Router_eth2_bytes_in:
+  desc: eth2 bytes in
+  type: int
+Router_eth2_bytes_out:
+  desc: eth2 bytes out
+  type: int
+Router_eth3_bytes_in:
+  desc: eth3 bytes in
+  type: int
+Router_eth3_bytes_out:
+  desc: eth3 bytes out
+  type: int
+Router_eth4_bytes_in:
+  desc: eth4 bytes in
+  type: int
+Router_eth4_bytes_out:
+  desc: eth4 bytes out
+  type: int
+Router_eth5_bytes_in:
+  desc: eth5 bytes in
+  type: int
+Router_eth5_bytes_out:
+  desc: eth5 bytes out
+  type: int
+Router_eth6_bytes_in:
+  desc: eth6 bytes in
+  type: int
+Router_eth6_bytes_out:
+  desc: eth6 bytes out
+  type: int
+Router_eth7_bytes_in:
+  desc: eth7 bytes in
+  type: int
+Router_eth7_bytes_out:
+  desc: eth7 bytes out
+  type: int
+Router_eth8_bytes_in:
+  desc: eth8 bytes in
+  type: int
+Router_eth8_bytes_out:
+  desc: eth8 bytes out
   type: int

{pymscada-0.0.13 → pymscada-0.0.15}/src/pymscada/iodrivers/logix_map.py

@@ -12,42 +12,51 @@ DTYPES = {
 }
 
 
+def tag_split(plc_tag: str):
+    separator = plc_tag.find(':')
+    arr_start_loc = plc_tag.find('[')
+    arr_end_loc = plc_tag.find(']')
+    bit_loc = plc_tag.find('.')
+    plc = plc_tag[:separator]
+    if arr_start_loc == -1 and bit_loc == -1:
+        var = plc_tag[separator + 1:]
+        elm = None
+        bit = None
+    elif arr_start_loc == -1:
+        var = plc_tag[separator + 1:bit_loc]
+        elm = None
+        bit = int(plc_tag[bit_loc + 1:])
+    elif bit_loc == -1:
+        var = plc_tag[separator + 1:arr_start_loc]
+        elm = int(plc_tag[arr_start_loc + 1:arr_end_loc])
+        bit = None
+    else:
+        var = plc_tag[separator + 1:arr_start_loc]
+        elm = int(plc_tag[arr_start_loc + 1:arr_end_loc])
+        bit = int(plc_tag[bit_loc + 1:])
+    return plc, var, elm, bit
+
+
 class LogixMap:
     """Do value updates for each tag."""
 
-    def __init__(self, tagname: str, src_type: str, plc_tag: str):
+    def __init__(self, tagname: str, src_type: str, read_tag: str,
+                 write_tag: str):
         """Initialise modbus map and Tag."""
         dtype, dmin, dmax = DTYPES[src_type][0:3]
         self.tag = Tag(tagname, dtype)
         self.map_bus = id(self)
-        plc_loc = plc_tag.find(':')
-        arr_start_loc = plc_tag.find('[')
-        arr_end_loc = plc_tag.find(']')
-        bit_loc = plc_tag.find('.')
-        self.plc = plc_tag[:plc_loc]
-        if arr_start_loc == -1 and bit_loc == -1:
-            self.var = plc_tag[plc_loc + 1:]
-            self.elm = None
-            self.bit = None
-        elif arr_start_loc == -1:
-            self.var = plc_tag[plc_loc + 1:bit_loc]
-            self.elm = None
-            self.bit = int(plc_tag[bit_loc + 1:])
-        elif bit_loc == -1:
-            self.var = plc_tag[plc_loc + 1:arr_start_loc]
-            self.elm = int(plc_tag[arr_start_loc + 1:arr_end_loc])
-            self.bit = None
-        else:
-            self.var = plc_tag[plc_loc + 1:arr_start_loc]
-            self.elm = int(plc_tag[arr_start_loc + 1:arr_end_loc])
-            self.bit = int(plc_tag[bit_loc + 1:])
-        self.plc_tag = plc_tag
+        self.read_plc, self.read_var, self.read_elm, self.read_bit = \
+            tag_split(read_tag)
+        self.plc_read_tag = read_tag
+        self.write_plc, self.write_var, self.write_elm, self.write_bit = \
+            tag_split(write_tag)
+        self.plc_write_tag = write_tag
         self.callback = None
         if dmin is not None:
             self.tag.value_min = dmin
         if dmax is not None:
             self.tag.value_max = dmax
-        self.write_cb = None  # used?
 
     def set_callback(self, callback):
         """Add tag callback interface."""
@@ -56,8 +65,8 @@ class LogixMap:
 
     def set_tag_value(self, value, time_us):
         """Pass update from IO driver to tag value."""
-        if self.bit is not None:
-            if value & 1 << self.bit:
+        if self.read_bit is not None:
+            if value & 1 << self.read_bit:
                 value = 1
             else:
                 value = 0
@@ -66,18 +75,18 @@ class LogixMap:
 
     def tag_value_changed(self, tag: Tag):
         """Pass update from tag value to IO driver."""
-        if self.elm is None and self.bit is None:
-            addr = self.var
-        elif self.elm is None:
-            addr = f'{self.var}.{self.bit}'
-        elif self.bit is None:
-            addr = f'{self.var}[{self.elm}]'
+        if self.write_elm is None and self.write_bit is None:
+            addr = self.write_var
+        elif self.write_elm is None:
+            addr = f'{self.write_var}.{self.write_bit}'
+        elif self.write_bit is None:
+            addr = f'{self.write_var}[{self.write_elm}]'
         else:
-            addr = f'{self.var}[{self.elm}].{self.bit}'
+            addr = f'{self.write_var}[{self.write_elm}].{self.write_bit}'
         self.callback(addr, tag.value)
 
 
-class LogixMaps():
+class LogixMaps:
     """Link tags with protocol connector."""
 
     def __init__(self, tags: dict):
@@ -85,16 +94,21 @@ class LogixMaps():
         # use the tagname to access the map.
         self.tag_map: dict[str, LogixMap] = {}
         # use the plc_name then variable name to access a list of maps.
-        self.var_map: dict[str, dict[str, list[LogixMap]]] = {}
+        self.read_var_map: dict[str, dict[str, list[LogixMap]]] = {}
         for tagname, v in tags.items():
-            addr = v['addr']
-            map = LogixMap(tagname, v['type'], addr)
-            if map.plc not in self.var_map:
-                self.var_map[map.plc] = {}
-            if map.var not in self.var_map[map.plc]:
+            if 'addr' in v:
+                read_addr = v['addr']
+                write_addr = v['addr']
+            else:
+                read_addr = v['read']
+                write_addr = v['write']
+            map = LogixMap(tagname, v['type'], read_addr, write_addr)
+            if map.read_plc not in self.read_var_map:
+                self.read_var_map[map.read_plc] = {}
+            if map.read_var not in self.read_var_map[map.read_plc]:
                 # make a list so multiple bits can map to a word
-                self.var_map[map.plc][map.var] = []
-            self.var_map[map.plc][map.var].append(map)
+                self.read_var_map[map.read_plc][map.read_var] = []
+            self.read_var_map[map.read_plc][map.read_var].append(map)
             self.tag_map[map.tag.name] = map
 
     def add_write_callback(self, plcname, writeok, callback):
@@ -110,7 +124,8 @@ class LogixMaps():
         # where the mapped tag uses a valid address, add callback to
         # the connection writer
         for map in self.tag_map.values():
-            if map.plc == plcname and (map.var, map.elm) in write_set:
+            if map.write_plc == plcname and \
+                    (map.write_var, map.write_elm) in write_set:
                 map.set_callback(callback)
 
     def polled_data(self, plcname, polls):
@@ -121,12 +136,12 @@ class LogixMaps():
                 logging.error(poll.error)
             arr_start_loc = poll.tag.find('[')
             if arr_start_loc == -1:
-                for map in self.var_map[plcname][poll.tag]:
+                for map in self.read_var_map[plcname][poll.tag]:
                     map.set_tag_value(poll.value, time_us)
             else:
                 var = poll.tag[:arr_start_loc]
                 elm = int(poll.tag[arr_start_loc + 1: -1])
-                for map in self.var_map[plcname][var]:
-                    elm_offset = map.elm - elm
+                for map in self.read_var_map[plcname][var]:
+                    elm_offset = map.read_elm - elm
                     if elm_offset > 0 and elm_offset < len(poll.value):
                         map.set_tag_value(poll.value[elm_offset], time_us)

pymscada-0.0.15/src/pymscada/iodrivers/snmp_client.py

@@ -0,0 +1,75 @@
+import logging
+import pysnmp.hlapi.asyncio as snmp
+from pymscada.bus_client import BusClient
+from pymscada.periodic import Periodic
+from pymscada.iodrivers.snmp_map import SnmpMaps
+
+
+class SnmpClientConnector:
+    """Poll snmp devices, write and traps are not implemented."""
+
+    def __init__(self, name: str, ip:str, rate: float, read: list,
+                 community: str, mapping: SnmpMaps):
+        """Set up polling client."""
+        self.snmp_name = name
+        self.ip = ip
+        self.community = community
+        self.read_oids = [snmp.ObjectType(snmp.ObjectIdentity(x))
+                          for x in read]
+        self.mapping = mapping
+        self.periodic = Periodic(self.poll, rate)
+        self.snmp_engine = snmp.SnmpEngine()
+
+    async def poll(self):
+        """Poll data."""
+        r = await snmp.getCmd(
+            self.snmp_engine,
+            snmp.CommunityData(self.community),
+            snmp.UdpTransportTarget((self.ip, 161)),
+            snmp.ContextData(),
+            *self.read_oids
+        )
+        errorIndication, errorStatus, errorIndex, varBinds = r
+        if errorIndication:
+            logging.error(errorIndication)
+        elif errorStatus:
+            logging.error('%s at %s' % (
+                errorStatus.prettyPrint(),
+                errorIndex and varBinds[int(errorIndex) - 1][0] or '?'))
+        else:
+            self.mapping.polled_data(self.snmp_name, varBinds)
+
+    async def start(self):
+        """Start polling."""
+        await self.periodic.start()
+
+
+class SnmpClient:
+
+    def __init__(self, bus_ip: str = '127.0.0.1', bus_port: int = 1324,
+                 rtus: dict = {}, tags: dict = {}) -> None:
+        """
+        Connect to bus on bus_ip:bus_port, connect to snmp devices.
+
+        Event loop must be running.
+        """
+        self.busclient = None
+        if bus_ip is not None:
+            self.busclient = BusClient(bus_ip, bus_port)
+        self.mapping = SnmpMaps(tags)
+        self.connections: list[SnmpClientConnector] = []
+        for rtu in rtus:
+            connection = SnmpClientConnector(**rtu, mapping=self.mapping)
+            self.connections.append(connection)
+
+    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()
+        for connection in self.connections:
+            await connection.start()

pymscada-0.0.15/src/pymscada/iodrivers/snmp_client2.py

@@ -0,0 +1,53 @@
+import asyncio
+from pysnmp.hlapi.asyncio import *
+
+
+async def run():
+    base = [
+        '1.3.6.1.2.1.2.2.1.2.',  # name
+        # '.1.3.6.1.2.1.2.2.1.4.',  # mtu
+        # '.1.3.6.1.2.1.2.2.1.6.',  # mac address
+        # '.1.3.6.1.2.1.2.2.1.7.',  # admin status
+        # '.1.3.6.1.2.1.2.2.1.8.',  # oper status
+        '1.3.6.1.2.1.31.1.1.1.6.',  # bytes in
+        # '.1.3.6.1.2.1.31.1.1.1.7.',  # packets in
+        # '.1.3.6.1.2.1.2.2.1.13.',  # discards in
+        # '.1.3.6.1.2.1.2.2.1.14.',  # errors in
+        '1.3.6.1.2.1.31.1.1.1.10.',  # bytes out
+        # '.1.3.6.1.2.1.31.1.1.1.11.',  # packets out
+        # '.1.3.6.1.2.1.2.2.1.19.',  # discards out
+        # '.1.3.6.1.2.1.2.2.1.20.',  # errors out
+    ]
+    oids = []
+    for i in range(1, 9):
+        for b in base:
+            oids.append(ObjectType(ObjectIdentity(f'{b}{i}')))
+    ip_address = '172.26.3.254'
+    community = 'public'
+
+    snmp_engine = SnmpEngine()
+
+    r = await getCmd(
+        snmp_engine,
+        CommunityData(community),
+        UdpTransportTarget((ip_address, 161)),
+        ContextData(),
+        *oids
+    )
+    errorIndication, errorStatus, errorIndex, varBinds = r
+    if errorIndication:
+        print(errorIndication)
+    elif errorStatus:
+        print('%s at %s' % (
+            errorStatus.prettyPrint(),
+            errorIndex and varBinds[int(errorIndex) - 1][0] or '?'))
+    else:
+        for varBind in varBinds:
+            oid, value = varBind
+            print(str(oid), type(oid), str(value), type(value))
+    # snmp_engine.transportDispatcher.closeDispatcher()
+
+
+if __name__ == '__main__':
+    """Starts with creating an event loop."""
+    asyncio.run(run())

pymscada-0.0.15/src/pymscada/iodrivers/snmp_map.py

@@ -0,0 +1,71 @@
+"""Map between snmp MIB and Tag."""
+import logging
+from time import time
+from pymscada.tag import Tag
+
+
+# data types for MIBs
+DTYPES = {
+    'int_roc': [int]
+}
+
+
+class SnmpMap:
+    """Do value updates for each tag."""
+
+    def __init__(self, tagname: str, src_type: str, plc_tag: str):
+        """initialise MIB map and Tag."""
+        dtype = DTYPES[src_type][0]
+        self.last_value = None
+        self.tag = Tag(tagname, dtype)
+        self.map_bus = id(self)
+        separator = plc_tag.find(':')
+        self.plc = plc_tag[:separator]
+        self.var = plc_tag[separator + 1:]
+
+    def set_tag_value(self, value, time_us):
+        """Pass update from IO driver to tag value."""
+        vtype = type(value).__name__
+        if vtype == 'Counter64':
+            v = int(value)
+            if self.last_value is None:
+                self.last_value = v
+                return
+            d = v - self.last_value
+            self.last_value = v
+            if d < 0:
+                d += 2**64
+            if self.tag.value != d:
+                self.tag.value = d, time_us, self.map_bus    
+        else:
+            logging.warning(
+                f'SnmpMap: {self.tag.name} {vtype} not implemented')
+
+
+class SnmpMaps:
+    """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, SnmpMap] = {}
+        # use the plc_name then variable name to access a list of maps.
+        self.var_map: dict[str, dict[str, list[SnmpMap]]] = {}
+        for tagname, v in tags.items():
+            addr = v['addr']
+            map = SnmpMap(tagname, v['type'], addr)
+            if map.plc not in self.var_map:
+                self.var_map[map.plc] = {}
+            if map.var not in self.var_map[map.plc]:
+                # make a list so multiple bits can map to a word
+                self.var_map[map.plc][map.var] = []
+            self.var_map[map.plc][map.var].append(map)
+            self.tag_map[map.tag.name] = map
+
+    def polled_data(self, plcname, polls):
+        """Pass updates read from the PLC to the tags."""
+        time_us = int(time() * 1e6)
+        for poll in polls:
+            oid, value = poll
+            for map in self.var_map[plcname][str(oid)]:
+                map.set_tag_value(value, time_us)

{pymscada-0.0.13 → pymscada-0.0.15}/src/pymscada/main.py

@@ -11,6 +11,7 @@ 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.snmp_client import SnmpClient
 from pymscada.simulate import Simulate
 from pymscada.www_server import WwwServer
 from pymscada.validate import validate
@@ -26,6 +27,7 @@ def args():
     commands = ['bus', 'console', 'wwwserver', 'history', 'files',
                 'logixclient',
                 'modbusserver', 'modbusclient',
+                'snmpclient',
                 'simulate', 'checkout',
                 'validate']
     parser.add_argument('module', type=str, choices=commands, metavar='action',
@@ -77,6 +79,9 @@ async def run():
     elif options.module == 'modbusserver':
         config = Config(options.config)
         module = ModbusServer(**config)
+    elif options.module == 'snmpclient':
+        config = Config(options.config)
+        module = SnmpClient(**config)
     elif options.module == 'simulate':
         config = Config(options.config)
         tag_info = dict(Config(options.tags))

pymscada-0.0.15/src/pymscada/tools/walk.py

@@ -0,0 +1,55 @@
+"""
+Walk whole MIB
+++++++++++++++
+
+Send a series of SNMP GETNEXT requests using the following options:
+
+* with SNMPv3, user 'usr-md5-none', MD5 authentication, no privacy
+* over IPv4/UDP
+* to an Agent at demo.snmplabs.com:161
+* for all OIDs in IF-MIB
+
+Functionally similar to:
+
+| $ snmpwalk -v3 -lauthPriv -u usr-md5-none -A authkey1 -X privkey1 demo.snmplabs.com  IF-MIB::
+
+"""#
+from pysnmp.hlapi import *
+
+mibs = {
+    'MIKROTIK-MIB': '1.3.6.1.4.1.14988',
+    'MIB-2': '1.3.6.1.2.1',
+    'HOST-RESOURCES-MIB': '1.3.6.1.2.1.25',
+    'IF-MIB': '1.3.6.1.2.1.2',
+    'IP-MIB': '1.3.6.1.2.1.4',
+    'IP-FORWARD-MIB': '1.3.6.1.2.1.4.21',
+    'IPV6-MIB': '1.3.6.1.2.1.55',
+    'BRIDGE-MIB': '1.3.6.1.2.1.17',
+    'DHCP-SERVER-MIB': '1.3.6.1.4.1.14988.1.1.8',
+    'CISCO-AAA-SESSION-MIB': '1.3.6.1.4.1.9.9.39',
+    'ENTITY-MIB': '1.3.6.1.2.1.47',
+    'UPS-MIB': '1.3.6.1.2.1.33',
+    'SQUID-MIB': '1.3.6.1.4.1.3495',
+}
+
+iterator = nextCmd(
+    SnmpEngine(),
+    UsmUserData('public'),
+    UdpTransportTarget(('172.26.3.254', 161)),
+    ContextData(),
+    # ObjectType(ObjectIdentity('1.3.6.1.2.1.1.1.0')),
+    # ObjectType(ObjectIdentity('1.3.6.1.2.1.1.6.0'))
+    ObjectType(ObjectIdentity(mibs['MIB-2']))
+)
+
+for errorIndication, errorStatus, errorIndex, varBinds in iterator:
+    if errorIndication:
+        print(errorIndication)
+        break
+    elif errorStatus:
+        print('%s at %s' % (errorStatus.prettyPrint(),
+                            errorIndex and varBinds[int(errorIndex) - 1][0] or '?'))
+        break
+    else:
+        for varBind in varBinds:
+            print(' = '.join([x.prettyPrint() for x in varBind]))