pymscada 0.0.14__py3-none-any.whl → 0.1.0__py3-none-any.whl

pymscada-0.1.0.dist-info/METADATA

@@ -0,0 +1,88 @@
+Metadata-Version: 2.1
+Name: pymscada
+Version: 0.1.0
+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
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: JavaScript
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: OS Independent
+Classifier: Environment :: Console
+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.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
+#### [Docs](https://github.com/jamie0walton/pymscada/blob/main/docs/README.md)
+
+#### [@Github](https://github.com/jamie0walton/pymscada/blob/main/README.md)
+
+## Python Mobile SCADA
+
+```pymscada``` read / write to Modbus and Logix PLCs. Read SNMP OIDs.
+Collect history values and provide the ability to set values and trends
+and issue commands.
+
+User interface is via a web client embedded in this package. Examples included
+for securing with Apache as a proxy.
+
+Configuration with text yaml files, including the web page which are
+procedurally built.
+
+# See also
+
+- The angular project [angmscada](https://github.com/jamie0walton/angmscada)
+- Python container for the compiled angular pages [pymscada-html](https://github.com/jamie0walton/pymscada-html)
+
+# Licence
+
+```pymscada``` is distributed under the GPLv3 [license](./LICENSE).
+
+# Use
+Checkout the example files.
+```bash
+mscada@raspberrypi:~/test $ pymscada checkout
+making 'history' folder
+making pdf dir
+making config dir
+Creating  /home/mscada/test/config/modbusclient.yaml
+Creating  /home/mscada/test/config/pymscada-history.service
+Creating  /home/mscada/test/config/wwwserver.yaml
+Creating  /home/mscada/test/config/pymscada-demo-modbus_plc.service
+Creating  /home/mscada/test/config/files.yaml
+Creating  /home/mscada/test/config/pymscada-modbusserver.service
+Creating  /home/mscada/test/config/pymscada-wwwserver.service
+Creating  /home/mscada/test/config/simulate.yaml
+Creating  /home/mscada/test/config/tags.yaml
+Creating  /home/mscada/test/config/history.yaml
+Creating  /home/mscada/test/config/pymscada-files.service
+Creating  /home/mscada/test/config/bus.yaml
+Creating  /home/mscada/test/config/modbusserver.yaml
+Creating  /home/mscada/test/config/modbus_plc.py
+Creating  /home/mscada/test/config/pymscada-modbusclient.service
+Creating  /home/mscada/test/config/pymscada-bus.service
+Creating  /home/mscada/test/config/README.md
+mscada@raspberrypi:~/test $ pymscada validate
+WARNING:root:pymscada 0.1.0 starting
+Config files in ./ valid.
+``` 
+
+Runs on a Raspberry Pi and includes preconfigured systemd files to
+automate running the services. Mostly works on Windows, works better
+on linux.
+
+Modules can be run from the command line, although you need
+a terminal for each running module (better with systemd).
+```bash
+pymscada bus --config bus.yaml
+pymscada wwwserver --config wwwserver.yaml --tags tags.yaml
+pymscada history --config history.yaml --tags tags.yaml
+python weather.py
+```

{pymscada-0.0.14.dist-info → pymscada-0.1.0.dist-info}/RECORD

@@ -1,12 +1,12 @@
-pymscada-0.0.14.dist-info/METADATA,sha256=jJFPngLLwjv1ujm89kVFQwtjIybU5q1ALpFJSmFMFgA,8818
-pymscada-0.0.14.dist-info/WHEEL,sha256=N2J68yzZqJh3mI_Wg92rwhw0rtJDFpZj9bwQIMJgaVg,90
-pymscada-0.0.14.dist-info/entry_points.txt,sha256=AcZZ7HFj8k1ztP6ge-5bdRinYF8glW2s6lFEQG3esN4,57
-pymscada-0.0.14.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+pymscada-0.1.0.dist-info/METADATA,sha256=4k0xZCUfrBdcOG1vnI9reNEvrOg8UKqG6MaN5vp_Oqs,3212
+pymscada-0.1.0.dist-info/WHEEL,sha256=N2J68yzZqJh3mI_Wg92rwhw0rtJDFpZj9bwQIMJgaVg,90
+pymscada-0.1.0.dist-info/entry_points.txt,sha256=AcZZ7HFj8k1ztP6ge-5bdRinYF8glW2s6lFEQG3esN4,57
+pymscada-0.1.0.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/checkout.py,sha256=c8Fy--Oz4GMXaOO48VmySyI31Y2qjxL-_Tuh7V29JeY,2236
+pymscada/checkout.py,sha256=ISXhwRJbZBRu0cMeVHwgHzMgk9YslhnPtjs7-0lgjRo,3351
 pymscada/config.py,sha256=vwGxieaJBYXiHNQEOYVDFaPuGmnUlCnbNm_W9bugKlc,1851
 pymscada/console.py,sha256=sw1k6eXY53S8qMR-kx8pHOyhXHHt88e4RTcXmC7AQlw,946
 pymscada/demo/README.md,sha256=iNcVbCTkq-d4agLV-979lNRaqf_hbJCn3OFzY-6qfU8,880
@@ -14,35 +14,37 @@ 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/history.yaml,sha256=mn_Xf4h_bK6vwZVQ0Iz9BzJpwWok2gEgSKbDgEM8AOQ,46
-pymscada/demo/logixclient.yaml,sha256=0fsi702CozjvshZNy8KirzCaah3asHR_Bjl-76mrNOA,925
+pymscada/demo/logixclient.yaml,sha256=G_NlJhBYwT1a9ceHDgO6fCNKFmBM2pVO_t9Xa1NqlRY,912
 pymscada/demo/modbus_plc.py,sha256=3zZHHbyrdxyryEHBeNIw-fpcDGcS1MaJiqEwQDr6zWI,2397
-pymscada/demo/modbusclient.yaml,sha256=vF96CTA-fsIbTUMnVa1yE4NBnMW5-jeVyEe4HrwfvCY,1020
-pymscada/demo/modbusserver.yaml,sha256=xit3bfQrf_CnJZXXiGnWAOOAfH33KIxJC4jQWqkEJLc,1036
+pymscada/demo/modbusclient.yaml,sha256=geeCsUJZkkEj7jjXR_Yk6R5zA5Ta9IczrHsARz7ZgXY,1099
+pymscada/demo/modbusserver.yaml,sha256=67_mED6jXgtnzlDIky9Cg4j-nXur06iz9ve3JUwSyG8,1133
+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
 pymscada/demo/pymscada-files.service,sha256=yGTxYnmQ_QBjIzItFatw_uIg_cG11vadLDaR0C9pPEk,322
 pymscada/demo/pymscada-history.service,sha256=kEU_RsrRSmEUE-nR23n2q2yZxjALm_nCrJhjxS4pcSQ,382
 pymscada/demo/pymscada-io-logixclient.service,sha256=gvnCJgUeqnIgnuN-Wf1XhB0FJxVYyLksmMO7JC0wT-Y,344
+pymscada/demo/pymscada-io-modbusclient.service,sha256=4tenKcrfRi0iMdv8-k2gtMQA4OPTM59zAyKpovwemxM,344
+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-modbusclient.service,sha256=4tenKcrfRi0iMdv8-k2gtMQA4OPTM59zAyKpovwemxM,344
-pymscada/demo/pymscada-modbusserver.service,sha256=FqCMD3EJKoiq6EbYnoijRLX5UeUWbZrNzDs50eQj7iE,344
 pymscada/demo/pymscada-wwwserver.service,sha256=uDnqzfvAdAnTrqOCqDm1PN7SmeMSuOdmAhorHPJdEVI,366
-pymscada/demo/simulate.yaml,sha256=SprrcLY8sx5c-2RggtZqhZS3SL03QM3Yp-Rh5F0trA8,324
-pymscada/demo/snmpclient.yaml,sha256=SCjAN8kg7cmS3-Hu6gHw2mo7KxQSYtSi5ew-fIxRs6I,2013
-pymscada/demo/tags.yaml,sha256=cLSS6tIQ1XyVf7ldcdW0J2Tv8VsIQwfka4dPuBsY7FI,3494
-pymscada/demo/wwwserver.yaml,sha256=KDbe3mmslcK1L0ZnuvtOhhuJG-Hyw9OztMz813pChYw,1920
+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/iodrivers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pymscada/iodrivers/logix_client.py,sha256=czoMLo6VXaj-JrhOkmvoZlXUTzqF4Ez_I2Fe0oW15p8,2808
-pymscada/iodrivers/logix_map.py,sha256=vPEUmmqwtCAq8Zu86T_cn7EE19XMa5TlihXWI7aiEHQ,5015
-pymscada/iodrivers/modbus_client.py,sha256=aGmy1lAlpmnJxEALZc8VfOXCZpI4Ukgslv14S9EYrpE,10140
-pymscada/iodrivers/modbus_map.py,sha256=oFCCkHeGQudSPKhiUnSK3gg2WL_O25wuRCQXEZfpqcA,7172
-pymscada/iodrivers/modbus_server.py,sha256=e_wCiF044CK_a-WgfHBfHwj4v3Qwybt3yIpBcInoPMk,7087
-pymscada/iodrivers/snmp_client.py,sha256=plKh0gyI_KqD-RLorBJ3OfPrmMG0tuPwOB-SUrC-qFs,2542
-pymscada/iodrivers/snmp_client2.py,sha256=pdn5dYyEv4q-ubA0zQ8X-3tQDYxGC7f7Xexa7QPaL40,1675
-pymscada/iodrivers/snmp_map.py,sha256=rCTniik40Yy6avooIW8PqWanrnUglwBLKReIM7Ab5lA,2369
-pymscada/main.py,sha256=ss_wlV5Pmtp4yKOhk8-KaEloBGGytKLEntdK7WNjcaQ,3975
+pymscada/iodrivers/logix_client.py,sha256=wDhl0pCqs_k7Hd1MtbOuBrEx9emOwDrLJqBNussH1qU,2806
+pymscada/iodrivers/logix_map.py,sha256=ljjBAMJcw199v1V5u0Yfl38U6zbZzba5mdY4I3ZvdIM,5401
+pymscada/iodrivers/modbus_client.py,sha256=mo7VRLWi4W2J5Ft3M6Y5jSbK5vbd6wn4R2dncbiL4nU,9529
+pymscada/iodrivers/modbus_map.py,sha256=af2J3CGSeYQ4mSy8rNsERp9z7fRgRUYk3it5Mrc_IQA,7255
+pymscada/iodrivers/modbus_server.py,sha256=nnUjd6iCny_Abylk06J8dq4slNAyNPQC2Rw2ZWEElKM,6507
+pymscada/iodrivers/ping_client.py,sha256=dIR4SuKeNCu2FyhUNfTbkv-El3qPFMb0zUG1GJSD-80,4166
+pymscada/iodrivers/ping_map.py,sha256=EbOteqfEYKIOMqPymROJ4now2If-ekEj6jnM5hthoSA,1403
+pymscada/iodrivers/snmp_client.py,sha256=e-ea5BQnp-PxTetM9d61Mm-GkQrNZkUUlNp1Km9ZasI,2601
+pymscada/iodrivers/snmp_map.py,sha256=sDdIR5ZPAETpozDfBt_XQiZ-f4t99UCPlzj7BxFxQyM,2369
+pymscada/main.py,sha256=LxFUuijrIuNLOGhNy_5yNIq4pvNz4npsUwHaDtvrdCQ,7191
 pymscada/misc.py,sha256=0Cj6OFhQonyhyk9x0BG5MiS-6EPk_w6zvavt8o_Hlf0,622
 pymscada/pdf/__init__.py,sha256=WsDDgkWnZBJbt2-cJCdc2NvRAv_T4a7WOC1Q0k_l0gI,29
 pymscada/pdf/one.pdf,sha256=eoJ45DrAjVZrwmwdA_EAz1fwmT44eRnt_tkc2pmMrKY,1488
@@ -50,9 +52,9 @@ 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/samplers.py,sha256=t0IscgsCm5YByioOZ6aOKMO_guDFS_wxnJSiOGKI4Nw,2583
-pymscada/simulate.py,sha256=39PfIc_jJC4ekuSEqlVb8SlxvIjwgyTkCL5fSlwmanc,2404
 pymscada/tag.py,sha256=Q2EgacTnsxnGLM_zoHYsVWdwmd1faqfbxw9byI5fCgY,9463
+pymscada/tools/snmp_client2.py,sha256=pdn5dYyEv4q-ubA0zQ8X-3tQDYxGC7f7Xexa7QPaL40,1675
 pymscada/tools/walk.py,sha256=OgpprUbKLhEWMvJGfU1ckUt_PFEpwZVOD8HucCgzmOc,1625
-pymscada/validate.py,sha256=h2VnIT3EV3hLGtaAaBTjeDVMrVl8SpP9nz_fqyRtU4Y,10634
+pymscada/validate.py,sha256=VPpAVEwfgori5OREEwWlbPoPxz5Tfqr6dw-O5pINHyI,13125
 pymscada/www_server.py,sha256=BW6-ctE5BgyFDiyUJsOpe3c06DRp8k83MCGjwPh5fco,11473
-pymscada-0.0.14.dist-info/RECORD,,
+pymscada-0.1.0.dist-info/RECORD,,

pymscada/demo/simulate.yaml

@@ -1,21 +0,0 @@
-bus_ip: 127.0.0.1
-bus_port: 1324
-process:
-  one:
-    type: sine
-    offset: 50
-    amplitude: 40
-    frequency: 0.0005
-    sub:
-      offset: FloatSet
-    pub:
-      result: FloatVal
-  two:
-    type: sawtooth
-    offset: 10
-    amplitude: 80
-    frequency: 0.00005
-    sub:
-      offset: IntSet
-    pub:
-      result: IntVal

pymscada/simulate.py

@@ -1,66 +0,0 @@
-"""Simulate logic."""
-import asyncio
-import logging
-import math
-from pymscada.bus_client import BusClient
-from pymscada.misc import find_nodes
-from pymscada.tag import Tag, TYPES
-from time import monotonic
-
-
-class Simulate():
-    """Modify tag values to simulate a real process."""
-
-    def __init__(self, bus_ip: str = '127.0.0.1', bus_port: int = 1324,
-                 tag_info: dict = {}, process: dict = {}) -> None:
-        """
-        Connect to bus on bus_ip:bus_port, modify tag values per process.
-
-        Event loop must be running.
-        """
-        self.busclient = BusClient(bus_ip, bus_port, tag_info)
-        self.process = process
-        self.tags = {}
-        for x in ['sub', 'pub']:  # resist the temptation to
-            for t in find_nodes(x, self.process):
-                for tagname in t[x].values():
-                    self.tags[tagname] = Tag(
-                        tagname, TYPES[tag_info[tagname]['type']])
-
-    def step(self):
-        """Do simulation step."""
-        for e in self.process.values():
-            time = monotonic()
-            tagname = e['pub']['result']
-            if e['type'] == 'sine':
-                result = e['offset'] + e['amplitude'] * \
-                    math.sin(e['frequency'] * time)
-            elif e['type'] == 'sawtooth':
-                period = 1 / e['frequency']
-                result = int(e['offset'] + e['amplitude'] * (time %
-                             period) / period)
-            else:
-                return
-            if self.tags[tagname].value is None or \
-                    abs(self.tags[tagname].value - result) > 0.01:
-                self.tags[tagname].value = result
-                logging.warning(f'simulate {tagname} {result}')
-
-    async def periodic(self):
-        """Run simulation step every 5 seconds."""
-        while True:
-            self.next_run += 1.0
-            self.step()
-            self.last_ran = monotonic()
-            sleep_time = self.next_run - self.last_ran
-            if sleep_time < 0:
-                self.next_run = self.last_ran
-                logging.warning(f'Health count skipped at {self.last_ran}')
-            else:
-                await asyncio.sleep(sleep_time)
-
-    async def start(self):
-        """Provide the simulation process."""
-        await self.busclient.start()
-        self.next_run = monotonic()
-        await asyncio.create_task(self.periodic())

pymscada-0.0.14.dist-info/METADATA

@@ -1,251 +0,0 @@
-Metadata-Version: 2.1
-Name: pymscada
-Version: 0.0.14
-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
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: JavaScript
-Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
-Classifier: Operating System :: OS Independent
-Classifier: Environment :: Console
-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.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
-#### [Docs](https://github.com/jamie0walton/pymscada/blob/main/docs/README.md)
-
-#### [@Github](https://github.com/jamie0walton/pymscada/blob/main/README.md)
-
-## Python Mobile SCADA
-
-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
-- 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).
-
-## Objectives
-
-Traditional SCADA has a fixed 19:6, 1920x1080 or some equivalent layout.
-It's great on a big screen but not good on a phone. Hence __Mobile__
-SCADA with a responsive layout.
-
-I wrote Mobile SCADA to provide a GUI to the other things I was trying to
-do, I wanted to leverage web browsers and eliminate a dedicated
-_viewer.exe_. Display on the client is fast, trends, as fast as I can
-make them.
-
-Uptimes should be excellent. The best I have on an earlier version is
-over 5 years for about half of the script modules. This version is a
-complete rewrite, however the aim is the same.
-
-All tag value updates are by exception. So an update from you setting a
-value to seeing the feedback should be __FAST__.
-
-# See also
-
-- The angular project [angmscada](https://github.com/jamie0walton/angmscada)
-- Python container for the compiled angular pages [pymscada-html](https://github.com/jamie0walton/pymscada-html)
-- An add-on IO driver for Rockwell using pycomm3 [pymscada-pycomm3](https://github.com/jamie0walton/pymscada-pycomm3)
-
-# Licence
-
-```pymscada``` is distributed under the GPLv3 [license](./LICENSE).
-
-# Example Use
-This was all run on a Raspberry Pi 3B+ with a 16GB SDRAM card.
-
-## First
-Checkout the example files. Start in an empty directory. Plan to keep
-in the directory you check out into as the config file path details
-are auto-generated for the location you check out in to.
-```bash
-mscada@raspberrypi:~/test $ pymscada checkout
-making 'history' folder
-making pdf dir
-making config dir
-Creating  /home/mscada/test/config/modbusclient.yaml
-Creating  /home/mscada/test/config/pymscada-history.service
-Creating  /home/mscada/test/config/wwwserver.yaml
-Creating  /home/mscada/test/config/pymscada-demo-modbus_plc.service
-Creating  /home/mscada/test/config/files.yaml
-Creating  /home/mscada/test/config/pymscada-modbusserver.service
-Creating  /home/mscada/test/config/pymscada-wwwserver.service
-Creating  /home/mscada/test/config/simulate.yaml
-Creating  /home/mscada/test/config/tags.yaml
-Creating  /home/mscada/test/config/history.yaml
-Creating  /home/mscada/test/config/pymscada-files.service
-Creating  /home/mscada/test/config/bus.yaml
-Creating  /home/mscada/test/config/modbusserver.yaml
-Creating  /home/mscada/test/config/modbus_plc.py
-Creating  /home/mscada/test/config/pymscada-modbusclient.service
-Creating  /home/mscada/test/config/pymscada-bus.service
-Creating  /home/mscada/test/config/README.md
-mscada@raspberrypi:~/test $
-``` 
-
-## Objective
-To show a trend of the temperature forecast with a custom pymscada bus
-client program. The end result should look like ...
-
-![Temperature](temperature%20trend.png)
-
-## Configuration
-### Bus
-Defaults in ```bus.yaml``` are fine.
-
-### Tags
-Add some tags in ```tags.yaml```:
-```yaml
-temperature:
-  desc: temperature
-  type: float
-  min: 0
-  max: 35
-  units: C
-  dp: 1
-temperature_01:
-  desc: temperature_01
-  type: float
-  min: 0
-  max: 35
-  units: C
-  dp: 1
-... etc.
-```
-
-### History
-Defaults in ```history.yaml``` are fine.
-
-### Web Server
-You will need to add a trend page to ```wwwserver.yaml``` as:
-```yaml
-- name: Temperature     # Creates a Temperature page in the web client
-  parent: Weather       # Add the Temperature page in a submenu under Weather
-  items:
-  - type: uplot         # Identify the Angular component to use
-    ms:
-      desc: Temperature
-      age: 172800
-      legend_pos: left
-      time_pos: left
-      time_res: m
-    axes:
-    - scale: x
-      range: [-604800, 86400]  # initial time range for the trend
-    - scale: 'C'
-      range: [0.0, 35.0]
-      dp: 1
-    series:
-    - tagname: temperature     # pymscada Tag name
-      label: Current Temperature
-      scale: 'C'
-      color: black             # standard html colour names
-      width: 2
-      dp: 1                    # number of decimal places
-... etc for additional series
-```
-
-### Your custom pymscada Module
-For this example I polled [tomorrow.io](https://www.tomorrow.io/weather-api/)
-
-```weather.py```
-```python
-from datetime import datetime
-import time
-from pymscada import BusClient, Periodic, Tag
-
-URL = 'https://api.tomorrow.io/v4/timelines'
-QUERY = {'location': '-43.527934570040124, 172.6415203551829',
-         'fields': ['temperature'],
-         'units': 'metric',
-         'timesteps': '1h',
-         'startTime': 'now',
-         'endTime': 'nowPlus24h',
-         'apikey': '<your key>'}
-
-class PollWeather():
-    def __init__(self):
-        self.tags = {}
-        for tagname in ['temperature', 'temperature_01', 'temperature_04',
-                        'temperature_12', 'temperature_24']:
-            # Create pymscada tags, tags are singletons by 'tagname'
-            self.tags[tagname] = Tag(tagname, float)
-
-    async def periodic(self):
-        now = int(time.time())
-        if now % 3600 != 120:
-            return
-        # Get the weather forecast from tomorrow.io
-        async with aiohttp.ClientSession() as session:
-            async with session.get(URL, params=QUERY) as resp:
-                response = await resp.json()
-        utc_now = None
-        for row in response['data']['timelines'][0]['intervals']:
-            convert = row['startTime'].replace('Z', '+0000')
-            utc = datetime.strptime(convert, '%Y-%m-%dT%H:%M:%S%z').timestamp()
-            if utc_now is None:
-                utc_now = utc
-                forecast = ''
-            else:
-                forecast = f'_{int((utc - utc_now) / 3600):02d}'
-            if forecast not in ['', '_01', '_04', '_12', '_24']:
-                continue
-            for k, v in row['values'].items():
-                ftag = k + forecast
-                value = float(v)
-                time_us = int(utc * 1000000)
-                if ftag in self.tags:
-                    # Write the tag value. This is one of the following:
-                    # - value                      # time_us, bus_id auto-generated
-                    # - value, time_us             # bus_id auto-generated
-                    # - value, time_us, bus_id     # Don't use this one
-                    self.tags[ftag].value = value, time_us
-
-async def main():
-    # Connect to the bus and poll the weather service.
-    bus = BusClient()
-    await bus.start()
-    weather = PollWeather()                         # demo function
-    periodic = Periodic(weather.periodic, 1.0)      # part of pymscada
-    await periodic.start()
-    await asyncio.get_event_loop().create_future()  # run forever
-
-if __name__ == '__main__':
-    asyncio.run(main())
-```
-
-# Run the modules
-You can run the modules in one of: individual terminals, ```nohup ... &``` or as a
-```systemd``` service. I run as a service, the snips are abbreviated (no path) from
-the exec line in the auto-generated service files.
-
-Run the bus first! This needs to remain running all the time. It does not need to
-know the tagnames in advance so it can run forever for most tests. It will gather
-dead tagnames over time as you are experimenting, however this only requires a
-small amount of memory (unless you are setting tag values in the MB - which does
-work).
-
-```bash
-pymscada bus --config bus.yaml
-pymscada wwwserver --config wwwserver.yaml --tags tags.yaml
-pymscada history --config history.yaml --tags tags.yaml
-python weather.py
-```