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

pymscada/protocol_constants.py

@@ -16,17 +16,17 @@ rarely.
 - data size of 8-bit char
 
 command
-- CMD_ID data is tagname
+- CMD.ID data is tagname
   - reply: CMD_ID with tag_id and data as tagname
-- CMD_SET id, data is typed or json packed
+- CMD.SET id, data is typed or json packed
   - no reply
-- CMD_UNSUB id
+- CMD.UNSUB id
   - no reply
-- CMD_GET id
-- CMD_RTA id, data is request to author
-- CMD_SUB id
+- CMD.GET id
+- CMD.RTA id, data is request to author
+- CMD.SUB id
   - reply: SET id and value, value may be None
-- CMD_LIST
+- CMD.LIST
   - size == 0x00
     - tags with values newer than time_us
   - size > 0x00
@@ -34,43 +34,33 @@ command
     - text$ matches start of tagname
     - text matches anywhere in tagname
   - reply: LIST data as space separated tagnames
-- CMD_LOG data to logging.warning
+- CMD.LOG data to logging.warning
 """
 
 # Tuning constants
 MAX_LEN = 65535 - 14  # TODO fix server(?) when 3
 
-# Network protocol commands
-CMD_ID = 1  # query / inform tag ID - data is tagname bytes string
-CMD_SET = 2  # set a tag
-CMD_GET = 3  # get a tag
-CMD_RTA = 4  # request to author
-CMD_SUB = 5  # subscribe to a tag
-CMD_UNSUB = 6  # unsubscribe from a tag
-CMD_LIST = 7  # bus list tags
-CMD_ERR = 8  # action failed
-CMD_LOG = 9  # bus print a logging message
+from enum import IntEnum
 
-CMD_TEXT = {
-    1: 'CMD_ID',
-    2: 'CMD_SET',
-    3: 'CMD_GET',
-    4: 'CMD_RTA',
-    5: 'CMD_SUB',
-    6: 'CMD_UNSUB',
-    7: 'CMD_LIST',
-    8: 'CMD_ERR',
-    9: 'CMD_LOG'
-}
+class COMMAND(IntEnum):
+    ID = 1     # query / inform tag ID - data is tagname bytes string
+    SET = 2    # set a tag
+    GET = 3    # get a tag
+    RTA = 4    # request to author
+    SUB = 5    # subscribe to a tag
+    UNSUB = 6  # unsubscribe from a tag
+    LIST = 7   # bus list tags
+    ERR = 8    # action failed
+    LOG = 9    # bus print a logging message
 
-COMMANDS = [CMD_ID, CMD_SET, CMD_GET, CMD_RTA, CMD_SUB, CMD_UNSUB, CMD_LIST,
-            CMD_ERR, CMD_LOG]
+    @staticmethod
+    def text(cmd) -> str:
+        """Return command text description for enum or int."""
+        return COMMAND(cmd).name
 
-# data types
-TYPE_INT = 1  # 64 bit signed integer
-TYPE_FLOAT = 2  # 64 bit IEEE float
-TYPE_STR = 3  # string
-TYPE_BYTES = 4
-TYPE_JSON = 5
-
-TYPES = [TYPE_INT, TYPE_FLOAT, TYPE_STR, TYPE_BYTES, TYPE_JSON]
+class TYPE(IntEnum):
+    INT = 1    # 64 bit signed integer
+    FLOAT = 2  # 64 bit IEEE float
+    STR = 3    # string
+    BYTES = 4  # raw bytes
+    JSON = 5   # JSON encoded data

pymscada/validate.py

@@ -1,5 +1,6 @@
 """Config file validation."""
 from cerberus import Validator
+import logging
 from yaml import dump
 from pymscada import Config
 from socket import inet_aton
@@ -106,17 +107,15 @@ SELECTDICT_LIST = {
         'required': False
     }
 }
+OPNOTE_LIST = {
+    'type': {'type': 'string', 'allowed': ['opnote']},
+    'site': {'type': 'list'},
+    'by': {'type': 'list'}
+}
 UPLOT_LIST = {
     'type': {'type': 'string', 'allowed': ['uplot']},
     'ms': {
         'type': 'dict',
-        # 'schema': {
-        #     'type': 'dict',
-        #     # 'schema': {
-        #     #     'type': {'type': 'string', 'required': False},
-        #     #     'multi': {'type': 'list', 'required': False},
-        #     # }
-        # },
         'required': False
     },
     'axes': {
@@ -160,7 +159,7 @@ LIST_WWWSERVER = {
                 'type': 'dict',
                 'oneof_schema': [
                     BRHR_LIST, H123P_LIST, VALUESETFILES_LIST,
-                    SELECTDICT_LIST, UPLOT_LIST
+                    SELECTDICT_LIST, OPNOTE_LIST, UPLOT_LIST
                 ]
             }
         },
@@ -175,6 +174,7 @@ WWWSERVER_SCHEMA = {
         'ip': {'type': 'string', 'ms_ip': 'none ipv4'},
         'port': {'type': 'integer', 'min': 1024, 'max': 65536},
         'get_path': {'nullable': True},
+        'serve_path': {'nullable': True},
         'paths': {'type': 'list', 'allowed': ['history', 'config', 'pdf']},
         'pages': {
             'type': 'list',
@@ -361,6 +361,13 @@ class MsValidator(Validator):
     ms_tagnames = {}
     ms_notagcheck = {}
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.context = {
+            'current_file': None,
+            'current_section': None
+        }
+
     def _validate_ms_tagname(self, constraint, field, value):
         """
         Test tagname exists, capture when true.
@@ -369,15 +376,15 @@ class MsValidator(Validator):
         {'type': 'string'}
         """
         if '.' in field:
-            self._error(field, "'.' invalid in tag definition.")
+            self._error(field, f"'.' invalid in tag definition in {self.context['current_file']}")
         if constraint == 'save':
             if field in self.ms_tagnames:
-                self._error(field, 'attempt to redefine')
+                self._error(field, f"attempt to redefine in {self.context['current_file']}")
             else:
                 self.ms_tagnames[field] = {'type': None}
         elif constraint == 'exists':
             if value not in self.ms_tagnames:
-                self._error(field, 'tag was not defined in tags.yaml')
+                self._error(field, f"tag '{value}' was not defined in tags.yaml")
         elif constraint == 'none':
             pass
         else:
@@ -429,20 +436,16 @@ def validate(path: str = None):
         'snmpclient': SNMPCLIENT_SCHEMA,
         'logixclient': LOGIXCLIENT_SCHEMA,
     }
-    prefix = './'
-    if path is not None:
-        prefix = path + '/'
-    c = {
-        'tags': dict(Config(f'{prefix}tags.yaml')),
-        'bus': dict(Config(f'{prefix}bus.yaml')),
-        'wwwserver': dict(Config(f'{prefix}wwwserver.yaml')),
-        'history': dict(Config(f'{prefix}history.yaml')),
-        'modbusserver': dict(Config(f'{prefix}modbusserver.yaml')),
-        'modbusclient': dict(Config(f'{prefix}modbusclient.yaml')),
-        'snmpclient': dict(Config(f'{prefix}snmpclient.yaml')),
-        'logixclient': dict(Config(f'{prefix}logixclient.yaml')),
-    }
     v = MsValidator(s)
+    c = {}
+    prefix = './' if path is None else f"{path}/"
+    for name in s.keys():
+        try:
+            v.context['current_file'] = f'{name}.yaml'
+            v.context['current_section'] = name
+            c[name] = dict(Config(f'{prefix}{name}.yaml'))
+        except Exception as e:
+            v._error(name, f'Failed to load {name}.yaml: {str(e)}')
+            return False, dump(v.errors), prefix
     res = v.validate(c)
-    wdy = dump(v.errors)  # , default_flow_style=False)
-    return res, wdy, prefix
+    return res, dump(v.errors), prefix

pymscada/www_server.py

@@ -83,7 +83,7 @@ class WSHandler():
             self.queue.put_nowait((True, pack(
                 '!HHQq',            # Network big-endian
                 tag.id,             # Uint16
-                pc.TYPE_INT,        # Uint16
+                pc.TYPE.INT,        # Uint16
                 tag.time_us,        # Uint64
                 tag.value           # Int64
             )))
@@ -91,7 +91,7 @@ class WSHandler():
             self.queue.put_nowait((True, pack(
                 '!HHQd',            # Network big-endian
                 tag.id,             # Uint16
-                pc.TYPE_FLOAT,      # Uint16
+                pc.TYPE.FLOAT,      # Uint16
                 tag.time_us,        # Uint64
                 tag.value           # Float64
             )))
@@ -100,7 +100,7 @@ class WSHandler():
             self.queue.put_nowait((True, pack(
                 f'!HHQ{len(asbytes)}s',  # Network big-endian
                 tag.id,             # Uint16
-                pc.TYPE_STR,        # Uint16
+                pc.TYPE.STR,        # Uint16
                 tag.time_us,        # Uint64
                 asbytes             # Char as needed
             )))
@@ -110,7 +110,7 @@ class WSHandler():
                 self.queue.put_nowait((True, pack(
                     f'!HHQ{len(tag.value)}s',  # Network big-endian
                     tag.id,             # Uint16
-                    pc.TYPE_BYTES,      # Uint16
+                    pc.TYPE.BYTES,      # Uint16
                     tag.time_us,        # Uint64
                     tag.value           # Char as needed
                 )))

{pymscada-0.1.11.dist-info → pymscada-0.1.11b2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pymscada
-Version: 0.1.11
+Version: 0.1.11b2
 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
@@ -11,11 +11,11 @@ Classifier: Operating System :: OS Independent
 Classifier: Environment :: Console
 Classifier: Development Status :: 1 - Planning
 Project-URL: Homepage, https://github.com/jamie0walton/pymscada
-Project-URL: Bug tracker, https://github.com/jamie0walton/pymscada/issues
+Project-URL: Bug Tracker, https://github.com/jamie0walton/pymscada/issues
 Requires-Python: >=3.9
 Requires-Dist: PyYAML>=6.0.1
 Requires-Dist: aiohttp>=3.8.5
-Requires-Dist: pymscada-html>=0.1.2
+Requires-Dist: pymscada-html>=0.1.10b2
 Requires-Dist: cerberus>=1.3.5
 Requires-Dist: pycomm3>=1.2.14
 Requires-Dist: pysnmplib>=5.0.24

{pymscada-0.1.11.dist-info → pymscada-0.1.11b2.dist-info}/RECORD

@@ -1,14 +1,14 @@
-pymscada-0.1.11.dist-info/METADATA,sha256=itDYWXs3JwiNNw8EJCAtxZ6tjVmQyrnO4ufYA-xgFLw,2344
-pymscada-0.1.11.dist-info/WHEEL,sha256=pM0IBB6ZwH3nkEPhtcp50KvKNX-07jYtnb1g1m6Z4Co,90
-pymscada-0.1.11.dist-info/entry_points.txt,sha256=j_UgZmqFhNquuFC2M8g5-8X9FCpp2RaDb7NrExzkj1c,72
-pymscada-0.1.11.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+pymscada-0.1.11b2.dist-info/METADATA,sha256=ha12v3EbpjwJ8bTiLYLCGsVFVGny1Yz0LQzDWlOiGks,2349
+pymscada-0.1.11b2.dist-info/WHEEL,sha256=thaaA2w1JzcGC48WYufAs8nrYZjJm8LqNfnXFOFyCC4,90
+pymscada-0.1.11b2.dist-info/entry_points.txt,sha256=j_UgZmqFhNquuFC2M8g5-8X9FCpp2RaDb7NrExzkj1c,72
+pymscada-0.1.11b2.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
 pymscada/__init__.py,sha256=NV_cIIwe66Ugp8ns426rtfJIIyskWbqwImD9p_5p0bQ,739
 pymscada/__main__.py,sha256=WcyVlrYOoDdktJhOoyubTOycMwpayksFdxwelRU5xpQ,272
-pymscada/bus_client.py,sha256=NWumdtLNy4-_LdTumHy687q0ebQX7fdynSp13dZgpYo,8899
-pymscada/bus_server.py,sha256=3ZLT2QFfKMndrTVd1TRWk15rYtaXnW1Ls2dlZe5nsyM,11544
+pymscada/bus_client.py,sha256=ZUCynJtEvmHruzLS6ZAzp-_0dv1A1u_POgemb38kHuc,8989
+pymscada/bus_server.py,sha256=8F1beP4NRCBpGJQ0u9NZI1mP6P29HSl6mm9GoGMTCJA,11795
 pymscada/checkout.py,sha256=N8ZIxtNaP87w2cVRBGA2ib1cijdFfF4xWWZFFVLJa9g,3494
 pymscada/config.py,sha256=vwGxieaJBYXiHNQEOYVDFaPuGmnUlCnbNm_W9bugKlc,1851
-pymscada/console.py,sha256=ujHhOTPYLRQa96wGIEsjdq6r1cOFcEu-Mnl7wqk8mTg,8756
+pymscada/console.py,sha256=b4gm7cuhYKGFNtHoxygWkrqiN42mU8DM4KUi-Q74M4U,8793
 pymscada/demo/README.md,sha256=iNcVbCTkq-d4agLV-979lNRaqf_hbJCn3OFzY-6qfU8,880
 pymscada/demo/__init__.py,sha256=WsDDgkWnZBJbt2-cJCdc2NvRAv_T4a7WOC1Q0k_l0gI,29
 pymscada/demo/accuweather.yaml,sha256=rJIiBTUHfaxuYqLLuyKtAe5dqXVdQyEeHJgIy7z-qXo,322
@@ -19,6 +19,7 @@ pymscada/demo/logixclient.yaml,sha256=G_NlJhBYwT1a9ceHDgO6fCNKFmBM2pVO_t9Xa1NqlR
 pymscada/demo/modbus_plc.py,sha256=3zZHHbyrdxyryEHBeNIw-fpcDGcS1MaJiqEwQDr6zWI,2397
 pymscada/demo/modbusclient.yaml,sha256=geeCsUJZkkEj7jjXR_Yk6R5zA5Ta9IczrHsARz7ZgXY,1099
 pymscada/demo/modbusserver.yaml,sha256=67_mED6jXgtnzlDIky9Cg4j-nXur06iz9ve3JUwSyG8,1133
+pymscada/demo/openweather.yaml,sha256=NQ2HL_RlTQ8amYuNQhk09bC7w_rTmIeQ1RsxX1LLtKU,430
 pymscada/demo/opnotes.yaml,sha256=9z8dO_S6JErMuGQHivR584UPln-5jW8Qzq7gdhTNcxM,107
 pymscada/demo/ping.yaml,sha256=r_VBGTLU5r4cZi9bIGL3M4eNw70KnoBptOUoNrSbnFY,210
 pymscada/demo/pymscada-bus.service,sha256=F3ViriRXyMKdCY3tHa3wXAnv2Fo2_16-EScTLsYnSOA,261
@@ -34,8 +35,8 @@ pymscada/demo/pymscada-io-snmpclient.service,sha256=Rsm8uiwnoGx-1MkXqYgtj4UP9-r7
 pymscada/demo/pymscada-opnotes.service,sha256=TlrTRgP3rzrlXT8isAGT_Wy38ScDjT1VvnlgW84XiS8,354
 pymscada/demo/pymscada-wwwserver.service,sha256=7Qy2wsMmFEsQn-b5mgAcsrAQZgXynkv8SpHD6hLvRGc,370
 pymscada/demo/snmpclient.yaml,sha256=z8iACrFvMftYUtqGrRjPZYZTpn7aOXI-Kp675NAM8cU,2013
-pymscada/demo/tags.yaml,sha256=GH90X3QRBANUhvd2E9OuyIoiZD25OBihHHlDBw1uzlw,4231
-pymscada/demo/wwwserver.yaml,sha256=MhZbvnxAfkc3OutXyZVaVKif4ZD9VSch5NfBbO0T_-E,12597
+pymscada/demo/tags.yaml,sha256=E8pMcLvwwyPBeSIXnu56IoTKfOJ3tnrgR4lpzHyMk4c,4267
+pymscada/demo/wwwserver.yaml,sha256=95TM8V4KMwlPAM1uY50GDGScfZ1xVJrpeoN9m6uluIs,6488
 pymscada/files.py,sha256=MisnKoWvkffPMSj6sGVmm-4fh866x4UX3t9LJg4oCfk,2400
 pymscada/history.py,sha256=G079gHfzasmGtI5ANS8MdETD4bdZg5vHE_yTKk7atHw,9504
 pymscada/iodrivers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -45,22 +46,24 @@ pymscada/iodrivers/logix_map.py,sha256=ljjBAMJcw199v1V5u0Yfl38U6zbZzba5mdY4I3Zvd
 pymscada/iodrivers/modbus_client.py,sha256=DIGrEPz_Bwwj9CEeog5fQqiAu1UMV7xVL6KxlKgXNPs,9592
 pymscada/iodrivers/modbus_map.py,sha256=af2J3CGSeYQ4mSy8rNsERp9z7fRgRUYk3it5Mrc_IQA,7255
 pymscada/iodrivers/modbus_server.py,sha256=VqvjOJ4-LOVaD1jOK22raXhrCshJEaWlMxLvn5xMnFc,6570
+pymscada/iodrivers/openweather.py,sha256=ftFLXp5qAQ1G3dx8zKH1ZrhoW6E2kQTqBOnT7XE0wcQ,5467
 pymscada/iodrivers/ping_client.py,sha256=UOQgUfoIcYqy5VvKyJ8XGHHjeSRTfjmrhyWEojhIZQk,4188
 pymscada/iodrivers/ping_map.py,sha256=EbOteqfEYKIOMqPymROJ4now2If-ekEj6jnM5hthoSA,1403
 pymscada/iodrivers/snmp_client.py,sha256=66-IDzddeKcSnqOzNXIZ8wuuAqhIxZjyLNrDwDvHCvw,2708
 pymscada/iodrivers/snmp_map.py,sha256=sDdIR5ZPAETpozDfBt_XQiZ-f4t99UCPlzj7BxFxQyM,2369
-pymscada/main.py,sha256=6F8a8y_rHYUZnc5JBWPJhT-z4M7d134tA_l3QNfbm3A,8469
+pymscada/main.py,sha256=XtASmPZoQMuzDCHlH3P9XwgYskeLtNdl-hc1tDI7ljc,1875
 pymscada/misc.py,sha256=0Cj6OFhQonyhyk9x0BG5MiS-6EPk_w6zvavt8o_Hlf0,622
+pymscada/module_config.py,sha256=aGa6MArf-81vaB9r83MfCfW7ERYC9Ftj0AglsRm7_08,7620
 pymscada/opnotes.py,sha256=pxjFgy4uMnAmJcfrk8BX4Gl5j0z4fFb5waXcqI6UJ_M,5133
 pymscada/pdf/__init__.py,sha256=WsDDgkWnZBJbt2-cJCdc2NvRAv_T4a7WOC1Q0k_l0gI,29
 pymscada/pdf/one.pdf,sha256=eoJ45DrAjVZrwmwdA_EAz1fwmT44eRnt_tkc2pmMrKY,1488
 pymscada/pdf/two.pdf,sha256=TAuW5yLU1_wfmTH_I5ezHwY0pxhCVuZh3ixu0kwmJwE,1516
 pymscada/periodic.py,sha256=MLlL93VLvFqBBgjO1Us1t0aLHTZ5BFdW0B__G02T1nQ,1235
-pymscada/protocol_constants.py,sha256=scqu_vecB4U8WxbFbn3mdIhKuZWgNO7fyd-RMP5O_14,2094
+pymscada/protocol_constants.py,sha256=ooGmBM7WGWWdN10FObdjzcYieK8WN7Zy6qVxtD93LMk,1963
 pymscada/samplers.py,sha256=t0IscgsCm5YByioOZ6aOKMO_guDFS_wxnJSiOGKI4Nw,2583
 pymscada/tag.py,sha256=Oxh70q2MrPAEI94v4QsWt4gD8QP6BlfzNv9xXeeUFys,10103
 pymscada/tools/snmp_client2.py,sha256=pdn5dYyEv4q-ubA0zQ8X-3tQDYxGC7f7Xexa7QPaL40,1675
 pymscada/tools/walk.py,sha256=OgpprUbKLhEWMvJGfU1ckUt_PFEpwZVOD8HucCgzmOc,1625
-pymscada/validate.py,sha256=VPpAVEwfgori5OREEwWlbPoPxz5Tfqr6dw-O5pINHyI,13125
-pymscada/www_server.py,sha256=bDa3Mh1Dcjk67yk3nPd6HadWF8GjoDYY1t_1g8mfmdk,12021
-pymscada-0.1.11.dist-info/RECORD,,
+pymscada/validate.py,sha256=fPMlP6RscYuTIgdEJjJ0ZZI0OyVSat1lpqg254wqpdE,13140
+pymscada/www_server.py,sha256=rV1Vsk3J1wBhFMBCnK33SziNuTGgVwNc5zLjQQFxJ-s,12021
+pymscada-0.1.11b2.dist-info/RECORD,,

{pymscada-0.1.11.dist-info → pymscada-0.1.11b2.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: pdm-backend (2.4.2)
+Generator: pdm-backend (2.4.3)
 Root-Is-Purelib: true
 Tag: py3-none-any