pymscada 0.1.0a6__py3-none-any.whl → 0.1.1a2__py3-none-any.whl

pymscada/www_server.py

@@ -7,30 +7,20 @@ from struct import pack, unpack_from
 import time
 from pymscada.bus_client import BusClient
 import pymscada.protocol_constants as pc
-from pymscada.tag import Tag, TYPES
+from pymscada.tag import Tag, tag_for_web, TYPES
 from pymscada_html import get_html_file
 
 
-def tag_for_web(tagname: str, tag: dict):
-    """Correct tag dictionary in place to be suitable for web client."""
-    tag['name'] = tagname
-    tag['id'] = None
-    if 'desc' not in tag:
-        tag['desc'] = tag.name
-    if 'multi' in tag:
-        tag['type'] = 'int'
-    else:
-        if 'type' not in tag:
-            tag['type'] = 'float'
-        else:
-            if tag['type'] not in TYPES:
-                tag['type'] = 'str'
-    if tag['type'] == 'int':
-        tag['dp'] = 0
-    elif tag['type'] == 'float' and 'dp' not in tag:
-        tag['dp'] = 2
-    elif tag['type'] == 'str' and 'dp' in tag:
-        del tag['dp']
+class Interface():
+    """Provide an interface between web client rta and the action."""
+
+    def __init__(self, tagname: str) -> None:
+        """Return path tagname for rta requests."""
+        self.tag = Tag(tagname, dict)
+
+    def ask(self, message):
+        """Process the message."""
+        logging.warning(message)
 
 
 class WSHandler():
@@ -44,7 +34,7 @@ class WSHandler():
     ids = set(range(1, 100))
 
     def __init__(self, ws: web.WebSocketResponse, pages: dict,
-                 tag_info: dict[str, Tag], do_rqs):
+                 tag_info: dict[str, Tag], do_rta, interface: Interface):
         """Create callbacks to monitor tag values."""
         self.ws = ws
         self.pages = pages
@@ -52,13 +42,14 @@ class WSHandler():
         self.tag_by_id: dict[int, Tag] = {}
         self.tag_by_name: dict[str, Tag] = {}
         self.queue = asyncio.Queue()
-        self.do_rqs = do_rqs
-        self.rqs_id = self.ids.pop()
-        logging.info(f'weksocket id {self.rqs_id}')
+        self.do_rta = do_rta
+        self.rta_id = self.ids.pop()
+        logging.info(f'websocket id {self.rta_id}')
+        self.interface = interface
 
     def __del__(self):
         """Depends on garbage collector. Is OK."""
-        self.ids.add(self.rqs_id)
+        self.ids.add(self.rta_id)
 
     async def send_queue(self):
         """Run forever, write from queue."""
@@ -70,7 +61,7 @@ class WSHandler():
                 else:
                     await self.ws.send_json(message)
         except asyncio.CancelledError:
-            logging.warn(f'{self.rqs_id}: send queue error, close '
+            logging.warn(f'{self.rta_id}: send queue error, close '
                          f'{self.ws.exception()}')
             return
 
@@ -91,7 +82,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
             )))
@@ -99,7 +90,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
             )))
@@ -113,17 +104,17 @@ class WSHandler():
                 asbytes             # Char as needed
             )))
         elif tag.type == bytes:
-            rqs_id = unpack_from('>H', tag.value)[0]
-            if rqs_id in [0, self.rqs_id]:
+            rta_id = unpack_from('>H', tag.value)[0]
+            if rta_id in [0, self.rta_id]:
                 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
                 )))
             else:
-                logging.info(f'{self.rqs_id}: {tag.name} bytes mismatch id')
+                logging.info(f'{self.rta_id}: {tag.name} bytes mismatch id')
         elif tag.type in [dict, list]:
             self.queue.put_nowait((False, {
                 'type': 'tag',
@@ -136,7 +127,7 @@ class WSHandler():
 
     def notify_id(self, tag: Tag):
         """Must be done here."""
-        logging.info(f'{self.rqs_id}: send id to webclient for {tag.name}')
+        logging.info(f'{self.rta_id}: send id to webclient for {tag.name}')
         self.tag_info[tag.name]['id'] = tag.id
         self.tag_by_id[tag.id] = tag
         self.tag_by_name[tag.name] = tag
@@ -151,7 +142,7 @@ class WSHandler():
             tag = self.tag_by_name[tagname]
         except KeyError:
             if tagname not in self.tag_info:
-                logging.warning(f'{self.rqs_id}: no {tagname} in tag_info')
+                logging.warning(f'{self.rta_id}: no {tagname} in tag_info')
                 return
             tag = Tag(tagname, TYPES[self.tag_info[tagname]['type']])
         if tag.id is None:
@@ -168,7 +159,7 @@ class WSHandler():
             (False, {'type': 'pages', 'payload': self.pages}))
         async for msg in self.ws:
             if msg.type == WSMsgType.TEXT:
-                logging.info(f'{self.rqs_id}: websocket recv {msg.json()}')
+                logging.info(f'{self.rta_id}: websocket recv {msg.json()}')
                 command = msg.json()
                 action = command['type']
                 tagname = command['tagname']
@@ -177,23 +168,25 @@ class WSHandler():
                 bus = None
                 if action == 'set':  # pc.CMD_SET
                     self.tag_by_name[tagname].value = value, time_us, bus
-                elif action == 'rqs':  # pc.CMD_RQS
+                elif action == 'rta':  # pc.CMD_RTA
                     if 'File' in value:
                         file = await anext(self.ws)
                         value['_file_data'] = file.data
-                    value['__rqs_id__'] = self.rqs_id
-                    self.do_rqs(tagname, value)
+                    value['__rta_id__'] = self.rta_id
+                    self.do_rta(tagname, value)
+                elif action == 'request_to_author':
+                    self.interface.ask(command)
                 elif action == 'sub':  # pc.CMD_SUB
                     self.do_sub(tagname)
                 elif action == 'get':  # pc.CMD_GET
-                    logging.warning(f'{self.rqs_id}: CMD_GET not implemented.')
+                    logging.warning(f'{self.rta_id}: CMD_GET not implemented.')
                 elif action == 'unsub':  # pc.CMD_UNSUB
-                    logging.warning(f'{self.rqs_id}: CMD_UNSUB not '
+                    logging.warning(f'{self.rta_id}: CMD_UNSUB not '
                                     'implemented.')
             elif msg.type == WSMsgType.BINARY:
                 logging.info(f'{msg.data}')
             elif msg.type == WSMsgType.ERROR:
-                logging.warn(f'{self.rqs_id}: ws closing error '
+                logging.warn(f'{self.rta_id}: ws closing error '
                              f'{self.ws.exception()}')
         send_queue.cancel()
         for tag in self.tag_by_id.values():
@@ -206,7 +199,8 @@ class WwwServer:
 
     def __init__(self, bus_ip: str = '127.0.0.1', bus_port: int = 1324,
                  ip: str = '127.0.0.1', port: int = 8324, get_path: str = None,
-                 tag_info: dict = {}, pages: dict = {}, paths: list[str] = []
+                 tag_info: dict = {}, pages: dict = {}, serve_path: str = None,
+                 www_tag: str = '__wwwserver__'
                  ) -> None:
         """
         Connect to bus on bus_ip:bus_port, serve on ip:port for webclient.
@@ -217,15 +211,17 @@ class WwwServer:
 
         Event loop must be running.
         """
-        self.busclient = BusClient(bus_ip, bus_port, tag_info)
+        self.busclient = BusClient(bus_ip, bus_port, tag_info,
+                                   module='WWW Server')
         self.ip = ip
         self.port = port
         self.get_path = get_path
+        self.serve_path = Path(serve_path)
         for tagname, tag in tag_info.items():
             tag_for_web(tagname, tag)
         self.tag_info = tag_info
         self.pages = pages
-        self.paths = paths
+        self.interface = Interface(www_tag)
 
     async def redirect_handler(self, _request: web.Request):
         """Point an empty request to the index."""
@@ -247,13 +243,12 @@ class WwwServer:
     async def path_handler(self, request: web.Request):
         """Plain files."""
         logging.info(f"path {request.match_info['path']}")
-        path = Path(request.match_info['path'])
+        path = self.serve_path.joinpath(request.match_info['path'])
         if path.is_dir():
             return web.HTTPForbidden(reason='folder not permitted')
-        if '/'.join(path.parts[:-1]) in self.paths:
-            if not path.exists():
-                return web.HTTPNotFound(reason='no such file in path')
-            return web.FileResponse(path)
+        if not path.exists():
+            return web.HTTPNotFound(reason='no such file in path')
+        return web.FileResponse(path)
         logging.warning(f"path not configured {request.match_info['path']}")
         return web.HTTPForbidden(reason='path not permitted')
 
@@ -263,8 +258,8 @@ class WwwServer:
         logging.info(f"WS from {peer}")
         ws = web.WebSocketResponse(max_msg_size=0)  # disables max message size
         await ws.prepare(request)
-        await WSHandler(ws, self.pages, self.tag_info, self.busclient.rqs
-                        ).connection_active()
+        await WSHandler(ws, self.pages, self.tag_info, self.busclient.rta,
+                        self.interface).connection_active()
         await ws.close()
         logging.info(f"WS closed {peer}")
         return ws

{pymscada-0.1.0a6.dist-info → pymscada-0.1.1a2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pymscada
-Version: 0.1.0a6
+Version: 0.1.1a2
 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
@@ -13,7 +13,7 @@ Classifier: Development Status :: 1 - Planning
 Requires-Python: >=3.9
 Requires-Dist: PyYAML>=6.0.1
 Requires-Dist: aiohttp>=3.8.5
-Requires-Dist: pymscada-html==0.1.0a1
+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

{pymscada-0.1.0a6.dist-info → pymscada-0.1.1a2.dist-info}/RECORD

@@ -1,23 +1,24 @@
-pymscada-0.1.0a6.dist-info/METADATA,sha256=sx8uSsELBZGSQfYO2gnHoRln4LYXrEMjrqXoPeCUNao,3216
-pymscada-0.1.0a6.dist-info/WHEEL,sha256=N2J68yzZqJh3mI_Wg92rwhw0rtJDFpZj9bwQIMJgaVg,90
-pymscada-0.1.0a6.dist-info/entry_points.txt,sha256=AcZZ7HFj8k1ztP6ge-5bdRinYF8glW2s6lFEQG3esN4,57
-pymscada-0.1.0a6.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+pymscada-0.1.1a2.dist-info/METADATA,sha256=dOIdGvZZT4QA4yp4O2v9oYVUNmyDSJb9uOkfq3MkSpw,3214
+pymscada-0.1.1a2.dist-info/WHEEL,sha256=vnE8JVcI2Wz7GRKorsPArnBdnW2SWKWGow5gu5tHlRU,90
+pymscada-0.1.1a2.dist-info/entry_points.txt,sha256=AcZZ7HFj8k1ztP6ge-5bdRinYF8glW2s6lFEQG3esN4,57
+pymscada-0.1.1a2.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
 pymscada/__init__.py,sha256=D_4aEDWkW6xMVQane3CbehBKPxT3FCaDY_QpFwglCe8,653
 pymscada/__main__.py,sha256=WcyVlrYOoDdktJhOoyubTOycMwpayksFdxwelRU5xpQ,272
-pymscada/bus_client.py,sha256=A6EI3OafyOBKd8UVFXS4K39SpmwBoFE-kSIwldVeDKE,8695
-pymscada/bus_server.py,sha256=-Bn4rfdE4OWXE0av459sROnCwAqV0VKFWulF0m1abHE,11255
+pymscada/bus_client.py,sha256=PncKysSCWhcpCPTVq9kkfb4NOjds7bZBwH7jaLHX3nI,8884
+pymscada/bus_server.py,sha256=3ZLT2QFfKMndrTVd1TRWk15rYtaXnW1Ls2dlZe5nsyM,11544
 pymscada/checkout.py,sha256=ISXhwRJbZBRu0cMeVHwgHzMgk9YslhnPtjs7-0lgjRo,3351
 pymscada/config.py,sha256=vwGxieaJBYXiHNQEOYVDFaPuGmnUlCnbNm_W9bugKlc,1851
-pymscada/console.py,sha256=sw1k6eXY53S8qMR-kx8pHOyhXHHt88e4RTcXmC7AQlw,946
+pymscada/console.py,sha256=oNsZjGlu16B7_2jCIl8Sw6bVfmJeoDdN-JcmA3LyzUw,8011
 pymscada/demo/README.md,sha256=iNcVbCTkq-d4agLV-979lNRaqf_hbJCn3OFzY-6qfU8,880
 pymscada/demo/__init__.py,sha256=WsDDgkWnZBJbt2-cJCdc2NvRAv_T4a7WOC1Q0k_l0gI,29
 pymscada/demo/bus.yaml,sha256=zde5JDo2Yv5s7NvJ569gAEoTDvsvgBwRPxfrYhsxj3w,26
-pymscada/demo/files.yaml,sha256=Uizvo-LEhHCRePGNLdvl9m_Z40qOlT7aZDLE4zTFSMc,169
+pymscada/demo/files.yaml,sha256=9jhZ7H5dSUz0oKXUiIB9dVYF8J8nwgt4QaFbvhKRPh0,197
 pymscada/demo/history.yaml,sha256=mn_Xf4h_bK6vwZVQ0Iz9BzJpwWok2gEgSKbDgEM8AOQ,46
 pymscada/demo/logixclient.yaml,sha256=G_NlJhBYwT1a9ceHDgO6fCNKFmBM2pVO_t9Xa1NqlRY,912
 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/opnotes.yaml,sha256=1uxAdimPiWlckkRqszh-I3NEi47BNtGraBGLgq8C4L4,111
 pymscada/demo/ping.yaml,sha256=r_VBGTLU5r4cZi9bIGL3M4eNw70KnoBptOUoNrSbnFY,210
 pymscada/demo/pymscada-bus.service,sha256=rRTFwHaS8XWd9YAIB3cET4QvASaIO9emmxFiUAbl14g,257
 pymscada/demo/pymscada-demo-modbus_plc.service,sha256=jmgk_peoxwKVXe-LbyK2VluMS1JMmoTud4JZHi9Tgec,316
@@ -28,33 +29,35 @@ pymscada/demo/pymscada-io-modbusclient.service,sha256=4tenKcrfRi0iMdv8-k2gtMQA4O
 pymscada/demo/pymscada-io-modbusserver.service,sha256=FqCMD3EJKoiq6EbYnoijRLX5UeUWbZrNzDs50eQj7iE,344
 pymscada/demo/pymscada-io-ping.service,sha256=d1n32srVKGd8qo8JWeBYEEznCRZWRWaBQLOYzdqEXWg,327
 pymscada/demo/pymscada-io-snmpclient.service,sha256=wrA2kDR3bgO30lP_lNJrIsVXNQiXmWKnphoqUj3QTRI,339
+pymscada/demo/pymscada-opnotes.service,sha256=5CyKOBlToqyjbyeBE6A68IEov7Y0sPdC_uC1TEJDPRw,350
 pymscada/demo/pymscada-wwwserver.service,sha256=uDnqzfvAdAnTrqOCqDm1PN7SmeMSuOdmAhorHPJdEVI,366
 pymscada/demo/snmpclient.yaml,sha256=z8iACrFvMftYUtqGrRjPZYZTpn7aOXI-Kp675NAM8cU,2013
 pymscada/demo/tags.yaml,sha256=GH90X3QRBANUhvd2E9OuyIoiZD25OBihHHlDBw1uzlw,4231
-pymscada/demo/wwwserver.yaml,sha256=jyboShIbwkwgMAcFLkpn88VMvGfoc7a44jNrI_B6OqY,12493
-pymscada/files.py,sha256=kEkiD7j5k69EK4jfMHEp-lbTnulYyrtUjkQDa5xmGPc,1784
-pymscada/history.py,sha256=yAUfjzo4O3w9-hGEAbtvz9UseMTwRVz7NqS832RtvIs,9455
+pymscada/demo/wwwserver.yaml,sha256=vkRbnZLCf3HXMXmgG_3q0aSShEVzxpGCJLJeWa9REmM,12543
+pymscada/files.py,sha256=FSEvFs6gNgErx_B7mtWkt6EsGNSc-TlxEbDW59NxIZs,2439
+pymscada/history.py,sha256=G079gHfzasmGtI5ANS8MdETD4bdZg5vHE_yTKk7atHw,9504
 pymscada/iodrivers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pymscada/iodrivers/logix_client.py,sha256=wDhl0pCqs_k7Hd1MtbOuBrEx9emOwDrLJqBNussH1qU,2806
+pymscada/iodrivers/logix_client.py,sha256=eqmiYLYUBHbr7wTljomGIZVNvXe-5WleGKfzwcHXO8w,2829
 pymscada/iodrivers/logix_map.py,sha256=ljjBAMJcw199v1V5u0Yfl38U6zbZzba5mdY4I3ZvdIM,5401
-pymscada/iodrivers/modbus_client.py,sha256=mo7VRLWi4W2J5Ft3M6Y5jSbK5vbd6wn4R2dncbiL4nU,9529
-pymscada/iodrivers/modbus_map.py,sha256=ihkb6xEXNQa5JDFklajjq4W8I4UHPsdOGe2MyHHwXYw,7172
-pymscada/iodrivers/modbus_server.py,sha256=nnUjd6iCny_Abylk06J8dq4slNAyNPQC2Rw2ZWEElKM,6507
-pymscada/iodrivers/ping_client.py,sha256=dIR4SuKeNCu2FyhUNfTbkv-El3qPFMb0zUG1GJSD-80,4166
+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/ping_client.py,sha256=UOQgUfoIcYqy5VvKyJ8XGHHjeSRTfjmrhyWEojhIZQk,4188
 pymscada/iodrivers/ping_map.py,sha256=EbOteqfEYKIOMqPymROJ4now2If-ekEj6jnM5hthoSA,1403
-pymscada/iodrivers/snmp_client.py,sha256=fBBE7SJjfcf9Y9zKRqgGMktnk6RoVMVc5Mj05ffk6ds,2601
-pymscada/iodrivers/snmp_map.py,sha256=rCTniik40Yy6avooIW8PqWanrnUglwBLKReIM7Ab5lA,2369
-pymscada/main.py,sha256=KbKX_NzEAX7uwmx9Ms4vbgq4kvg-Aiw5eMjxS8D3A5M,5998
+pymscada/iodrivers/snmp_client.py,sha256=GykrHqKhT-TRIEowLlt90pNQrbm4SXeMBFscflSHtCw,2623
+pymscada/iodrivers/snmp_map.py,sha256=sDdIR5ZPAETpozDfBt_XQiZ-f4t99UCPlzj7BxFxQyM,2369
+pymscada/main.py,sha256=ifu6DuQcI6QpK8w28QAKpbf8gWiaG-zzPoRVorxjFpY,8097
 pymscada/misc.py,sha256=0Cj6OFhQonyhyk9x0BG5MiS-6EPk_w6zvavt8o_Hlf0,622
+pymscada/opnotes.py,sha256=jo9E0if2dcv1ziGjrLqyzaf-eZvBihtLizP9GmWt5ok,4377
 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=ndFeuzhWjKTr_ahvmGJc6Cs5pYkHM8CRgNNDe0Tqecs,1997
+pymscada/protocol_constants.py,sha256=scqu_vecB4U8WxbFbn3mdIhKuZWgNO7fyd-RMP5O_14,2094
 pymscada/samplers.py,sha256=t0IscgsCm5YByioOZ6aOKMO_guDFS_wxnJSiOGKI4Nw,2583
-pymscada/tag.py,sha256=Q2EgacTnsxnGLM_zoHYsVWdwmd1faqfbxw9byI5fCgY,9463
+pymscada/tag.py,sha256=E9xQkf3b0trDRshhsaz_2baa4CAvTCgcZQXqWd3oHEM,10095
 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=BW6-ctE5BgyFDiyUJsOpe3c06DRp8k83MCGjwPh5fco,11473
-pymscada-0.1.0a6.dist-info/RECORD,,
+pymscada/www_server.py,sha256=ToTddnrnmcLdL2JDviBZ1nflw8wi8bBIk8uSxE6jvWk,11465
+pymscada-0.1.1a2.dist-info/RECORD,,

{pymscada-0.1.0a6.dist-info → pymscada-0.1.1a2.dist-info}/WHEEL

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