pymscada 0.0.6__py3-none-any.whl → 0.0.15__py3-none-any.whl

pymscada/__init__.py

@@ -2,19 +2,23 @@
 from pymscada.bus_client import BusClient
 from pymscada.bus_server import BusServer
 from pymscada.config import Config
+from pymscada.iodrivers.logix_client import LogixClient
+from pymscada.iodrivers.modbus_client import ModbusClient
+from pymscada.iodrivers.modbus_server import ModbusServer
 from pymscada.misc import find_nodes, ramp
-from pymscada.modbus_client import ModbusClient
-from pymscada.modbus_server import ModbusServer
 from pymscada.periodic import Periodic
 from pymscada.tag import Tag
+from pymscada.validate import validate
 
 __all__ = [
     'BusClient',
     'BusServer',
     'Config',
-    'find_nodes', 'ramp',
+    'LogixClient',
     'ModbusClient',
     'ModbusServer',
+    'find_nodes', 'ramp',
     'Periodic',
     'Tag',
+    'validate',
 ]

pymscada/demo/logixclient.yaml

@@ -0,0 +1,50 @@
+bus_ip: 127.0.0.1
+bus_port: 1324
+rtus:
+- name: Ani
+  ip: 172.26.7.196
+  rate: 0.2
+  read:
+  - {addr: Fout, type: 'REAL[]', start: 0, end: 99}
+  - {addr: Iout, type: 'DINT[]', start: 0, end: 99}
+  - {addr: OutVar, type: REAL}
+  writeok:
+  - {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'
+  InVar:
+    type: float32
+    read: Ani:OutVar
+    write: Ani:InVar
+  OutVar:
+    type: float32
+    addr: Ani:OutVar

pymscada/demo/modbus_plc.py

@@ -1,36 +1,52 @@
 """Demo PLC simulation."""
 import asyncio
+import pymscada.samplers as ps
 from pymscada import Config, ramp, ModbusServer, Periodic, Tag
 
 
-sim_IntSet = Tag('sim_IntSet', int)
-sim_IntSet.value = 0
-sim_IntVal = Tag('sim_IntVal', int)
-sim_FloatSet = Tag('sim_FloatSet', float)
-sim_FloatSet.value = 0
-sim_FloatVal = Tag('sim_FloatVal', float)
-sim_MultiSet = Tag('sim_MultiSet', int)
-sim_MultiSet.value = 0
-sim_MultiVal = Tag('sim_MultiVal', int)
-sim_TimeSet = Tag('sim_TimeSet', int)
-sim_TimeSet.value = 0
-sim_TimeVal = Tag('sim_TimeVal', int)
-sim_DateSet = Tag('sim_DateSet', int)
-sim_DateSet.value = 0
-sim_DateVal = Tag('sim_DateVal', int)
-sim_DateTimeSet = Tag('sim_DateTimeSet', int)
-sim_DateTimeSet.value = 0
-sim_DateTimeVal = Tag('sim_DateTimeVal', int)
-
-
-async def main_periodic():
-    """Emulate some PLC logic."""
-    sim_IntVal.value = ramp(sim_IntVal.value, sim_IntSet.value, 1)
-    sim_FloatVal.value = ramp(sim_FloatVal.value, sim_FloatSet.value, 0.5)
-    sim_MultiVal.value = sim_MultiSet.value
-    sim_TimeVal.value = sim_TimeSet.value
-    sim_DateVal.value = sim_DateSet.value
-    sim_DateTimeVal.value = sim_DateTimeSet.value
+class PLC_Logic():
+    """PLC Logic."""
+
+    def __init__(self):
+        """Create tags."""
+        self.i = 0
+        self.sim_IntSet = Tag('sim_IntSet', int)
+        self.sim_IntSet.value = 0
+        self.sim_IntVal = Tag('sim_IntVal', int)
+        self.sim_FloatSet = Tag('sim_FloatSet', float)
+        self.sim_FloatSet.value = 0
+        self.sim_FloatVal = Tag('sim_FloatVal', float)
+        self.sim_MultiSet = Tag('sim_MultiSet', int)
+        self.sim_MultiSet.value = 0
+        self.sim_MultiVal = Tag('sim_MultiVal', int)
+        self.sim_TimeSet = Tag('sim_TimeSet', int)
+        self.sim_TimeSet.value = 0
+        self.sim_TimeVal = Tag('sim_TimeVal', int)
+        self.sim_DateSet = Tag('sim_DateSet', int)
+        self.sim_DateSet.value = 0
+        self.sim_DateVal = Tag('sim_DateVal', int)
+        self.sim_DateTimeSet = Tag('sim_DateTimeSet', int)
+        self.sim_DateTimeSet.value = 0
+        self.sim_DateTimeVal = Tag('sim_DateTimeVal', int)
+        self.avg_temp = ps.Average(Tag('cpu_temp', float))
+        self.cpu_load = Tag('cpu_load', float)
+        self.disk_use = Tag('disk_use', float)
+
+    async def periodic(self):
+        """Emulate some PLC logic."""
+        self.sim_IntVal.value = ramp(self.sim_IntVal.value,
+                                     self.sim_IntSet.value, 1)
+        self.sim_FloatVal.value = ramp(self.sim_FloatVal.value,
+                                       self.sim_FloatSet.value, 0.5)
+        self.sim_MultiVal.value = self.sim_MultiSet.value
+        self.sim_TimeVal.value = self.sim_TimeSet.value
+        self.sim_DateVal.value = self.sim_DateSet.value
+        self.sim_DateTimeVal.value = self.sim_DateTimeSet.value
+        self.avg_temp.step(ps.get_cpu_temp())
+        self.i += 1
+        if self.i % 60 == 0:
+            self.cpu_load.value = ps.get_cpu_load()
+            self.disk_use.value = ps.get_disk_use()
 
 
 async def main():
@@ -38,7 +54,8 @@ async def main():
     config = Config('modbusserver.yaml')
     mbserver = ModbusServer(**config)
     await mbserver.start()
-    periodic = Periodic(main_periodic, 1.0)
+    plc = PLC_Logic()
+    periodic = Periodic(plc.periodic, 1.0)
     await periodic.start()
     await asyncio.get_event_loop().create_future()
 

pymscada/demo/modbusclient.yaml

@@ -47,4 +47,13 @@ tags:
     addr: RTU:1:4x:25
   DateTimeVal:
     type: uint64
-    addr: RTU:1:4x:29
+    addr: RTU:1:4x:29
+  cpu_temp:
+    type: float32
+    addr: RTU:1:4x:33
+  cpu_load:
+    type: float32
+    addr: RTU:1:4x:35
+  disk_use:
+    type: float32
+    addr: RTU:1:4x:37

pymscada/demo/modbusserver.yaml

@@ -1,5 +1,5 @@
-bus_ip:
-bus_port:
+bus_ip: 192.168.1.100  # for the demo PLC make empty (None)
+bus_port: 2345  # for the demo PLC make empty (None)
 rtus:
 - name: RTU
   ip: 0.0.0.0
@@ -43,4 +43,13 @@ tags:
     addr: RTU:1:4x:25
   sim_DateTimeVal:
     type: uint64
-    addr: RTU:1:4x:29
+    addr: RTU:1:4x:29
+  cpu_temp:
+    type: float32
+    addr: RTU:1:4x:33
+  cpu_load:
+    type: float32
+    addr: RTU:1:4x:35
+  disk_use:
+    type: float32
+    addr: RTU:1:4x:37

pymscada/demo/pymscada-bus.service

@@ -3,7 +3,7 @@
 
 [Service]
     WorkingDirectory=__DIR__
-    ExecStart=__PYMSCADA__ bus __DIR__/config/bus.yaml
+    ExecStart=__PYMSCADA__ bus --config __DIR__/config/bus.yaml
     Restart=always
     RestartSec=5
     User=mscada

pymscada/demo/pymscada-files.service

@@ -5,7 +5,7 @@
 
 [Service]
     WorkingDirectory=__DIR__
-    ExecStart=__PYMSCADA__ files __DIR__/config/files.yaml
+    ExecStart=__PYMSCADA__ files --config __DIR__/config/files.yaml
     Restart=always
     RestartSec=5
     User=mscada

pymscada/demo/pymscada-history.service

@@ -5,7 +5,7 @@
 
 [Service]
     WorkingDirectory=__DIR__
-    ExecStart=__PYMSCADA__ history __DIR__/config/bus.yaml
+    ExecStart=__PYMSCADA__ history --config __DIR__/config/history.yaml --tags __DIR__/config/tags.yaml
     Restart=always
     RestartSec=5
     User=mscada

pymscada/demo/pymscada-io-logixclient.service

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

pymscada/demo/{pymscada-modbusclient.service → pymscada-io-modbusclient.service}

@@ -5,7 +5,7 @@
 
 [Service]
     WorkingDirectory=__DIR__
-    ExecStart=__PYMSCADA__ modbusclient __DIR__/config/modbusclient.yaml
+    ExecStart=__PYMSCADA__ modbusclient --config __DIR__/config/modbusclient.yaml
     Restart=always
     RestartSec=5
     User=mscada

pymscada/demo/{pymscada-modbusserver.service → pymscada-io-modbusserver.service}

@@ -5,7 +5,7 @@
 
 [Service]
     WorkingDirectory=__DIR__
-    ExecStart=__PYMSCADA__ modbusserver __DIR__/config/modbusserver.yaml
+    ExecStart=__PYMSCADA__ modbusserver --config __DIR__/config/modbusserver.yaml
     Restart=always
     RestartSec=5
     User=mscada

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/demo/pymscada-wwwserver.service

@@ -5,7 +5,7 @@
 
 [Service]
     WorkingDirectory=__DIR__
-    ExecStart=__PYMSCADA__ wwwserver __DIR__/config/wwwserver.yaml
+    ExecStart=__PYMSCADA__ wwwserver --config __DIR__/config/wwwserver.yaml --tags __DIR__/config/tags.yaml
     Restart=always
     RestartSec=5
     User=mscada

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/demo/tags.yaml

@@ -28,16 +28,16 @@ IntVal:
 FloatSet:
   desc: Float Setpoint
   type: float
-  min: -1e100
-  max: 1e100
+  min: -1.e+100
+  max: 1.e+100
   units: 'm'
   dp: 1
   init: 2
 FloatVal:
   desc: Float Value
   type: float
-  min: -1e100
-  max: 1e100
+  min: -1.e+100
+  max: 1.e+100
   units: 'm'
   dp: 1
   init: 2
@@ -108,4 +108,109 @@ FloatSelect:
   init:
     labels: [Floats, For, This, Tag]
     values: [0.1, 0.1, 0.2, 0.3]
-    locks: [0, 1, 0, 0]
+    locks: [0, 1, 0, 0]
+cpu_temp:
+  desc: CPU Load
+  type: float
+  min: 0
+  max: 100
+  units: '°C'
+  dp: 1
+cpu_load:
+  desc: Float Value
+  type: float
+  min: 0
+  max: 100
+  units: '%'
+  dp: 1
+disk_use:
+  desc: Float Value
+  type: float
+  min: 0
+  max: 100
+  units: '%'
+  dp: 1
+sim_IntSet:  # for the demo PLC sim_ tags not required
+  desc: Simulation tag
+  type: int
+sim_IntVal:
+  desc: Simulation tag
+  type: int
+sim_FloatSet:
+  desc: Simulation tag
+  type: float
+sim_FloatVal:
+  desc: Simulation tag
+  type: float
+sim_MultiSet:
+  desc: Simulation tag
+  type: int
+sim_MultiVal:
+  desc: Simulation tag
+  type: int
+sim_TimeSet:
+  desc: Simulation tag
+  type: int
+sim_TimeVal:
+  desc: Simulation tag
+  type: int
+sim_DateSet:
+  desc: Simulation tag
+  type: int
+sim_DateVal:
+  desc: Simulation tag
+  type: int
+sim_DateTimeSet:
+  desc: Simulation tag
+  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/demo/wwwserver.yaml

@@ -51,30 +51,36 @@ pages:
     axes:
     - scale: x
       range: [-86400, 0]  # 86400 172800 1209600
-    - scale: integers
+    - scale: '°C'
       range: [0.0, 100.0]
       dp: 1
-    - scale: floats
+    - scale: '%'
       range: [0.0, 100.0]
       dp: 1
-      side: 1
+      # side: 1
     # bands:  # TODO
     # - series: [I_Transpower_Limit_Hi, I_Transpower_Limit_Lo]
     #   fill: [red, 0.2]
     #   dir: -1
     series:
-    - tagname: IntVal
-      label: Int
-      scale: integers
-      color: red
+    - tagname: cpu_load
+      label: CPU Load
+      scale: '%'
+      color: black
       width: 1.5
       dp: 1
-    - tagname: FloatVal
-      label: Float
-      scale: floats
+    - 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: