-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Fixed MQTT incomplete message bug * Fixed MQTT Publishing * Added new Logger with "the loop" * cleaned up formatting * Tidied up publish loop * Fixed tzlocal install bug * Changed timestamp on magtest logfile * Small tweaks * Ready for release
- Loading branch information
1 parent
3752db0
commit 597da34
Showing
15 changed files
with
236 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
| #!/bin/bash | ||
| rm -R -f dist | ||
| rm -R -f pymagnum.egg-info | ||
| python setup.py clean build | ||
| python setup.py sdist --formats=zip | ||
| #!/bin/bash | ||
| # readhow_to_build.md | ||
| # this assumes python 3.7 or higher is installed | ||
| rm -R -f dist | ||
| rm -R -f pymagnum.egg-info | ||
| python setup.py clean build | ||
| python setup.py sdist --formats=zip |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,8 +10,6 @@ | |
| # add these directories to sys.path here. If the directory is relative to the | ||
| # documentation root, use os.path.abspath to make it absolute, like shown here. | ||
| # | ||
| import os | ||
| import sys | ||
| from datetime import date | ||
| # sys.path.insert(0, os.path.abspath('../magnum')) | ||
| # sys.path.insert(0, os.path.abspath('../')) | ||
|
|
@@ -21,21 +19,19 @@ | |
| # -- Project information ----------------------------------------------------- | ||
| # BUILDINFO | ||
| project = 'Magnum Energy' | ||
| year = date.today().year | ||
| copyright = f"2018-{year}, Charles Godwin [email protected]" | ||
| copyright = f"2018-{date.today().year}, Charles Godwin [email protected]" | ||
| author = 'Charles Godwin' | ||
|
|
||
| # The full version, including alpha/beta/rc tags | ||
| release = '2.0' | ||
| version = '2.0.2' | ||
| version = '2.0.3' | ||
|
|
||
| # -- General configuration --------------------------------------------------- | ||
|
|
||
| # Add any Sphinx extension module names here, as strings. They can be | ||
| # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | ||
| # ones. | ||
| extensions = [ | ||
| ] | ||
| extensions = [] | ||
|
|
||
| # Add any paths that contain templates here, relative to this directory. | ||
| templates_path = ['_templates'] | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| # | ||
| # Copyright (c) 2018-2023 Charles Godwin <[email protected]> | ||
| # | ||
| # SPDX-License-Identifier: BSD-3-Clause | ||
| # | ||
| # This code is provided as an example of a JSON logger that writes to MQTT | ||
| # The data is published at every interval seconds | ||
| # If you publish the subtopic 'refresh' (i.e magnum/refresh) this will publish data immediately | ||
| # run the program with --help for details of options. | ||
| # Each device is a separate JSON record new-line delimited | ||
| # The JSON Record is like this: | ||
| # datetime is a timestamp for local time | ||
| # timestamp is the same time but as a Unix Epoch second as UTC time - this is useful for time series software | ||
| # the data object is pertinent to each device | ||
| # The current devices are INVERTER, REMOTE, AGS, BMK, and PT100 | ||
| # topic = magnum/inverter | ||
| # payload | ||
| # { | ||
| # "datetime": "2019-10-08 12:49:14-04:00", | ||
| # "device": "INVERTER", | ||
| # "data": { | ||
| # "revision": "5.1", | ||
| # "mode": 64, | ||
| # "mode_text": "INVERT", | ||
| # "fault": 0, | ||
| # "fault_text": "None", | ||
| # "vdc": 24.6, | ||
| # "adc": 2, | ||
| # "VACout": 119, | ||
| # "VACin": 0, | ||
| # "invled": 1, | ||
| # "invled_text": "On", | ||
| # "chgled": 0, | ||
| # "chgled_text": "Off", | ||
| # "bat": 17, | ||
| # "tfmr": 36, | ||
| # "fet": 30, | ||
| # "model": 107, | ||
| # "model_text": "MS4024PAE", | ||
| # "stackmode": 0, | ||
| # "stackmode_text": "Stand Alone", | ||
| # "AACin": 0, | ||
| # "AACout": 1, | ||
| # "Hz": 60.0 | ||
| # } | ||
| # } | ||
|
|
||
| import json | ||
| import signal | ||
| import sys | ||
| import time | ||
| import uuid | ||
| from collections import OrderedDict | ||
| from datetime import datetime, timezone | ||
|
|
||
| import paho.mqtt.client as mqtt | ||
| from magnum.magnum import Magnum | ||
| from magnum.magparser import MagnumArgumentParser | ||
| # from tzlocal import get_localzone | ||
|
|
||
|
|
||
| def on_connect(client, userdata, flags, rc): | ||
| if rc == 0: | ||
| global args | ||
| client.subscribe(f"{args.topic}refresh") | ||
| if args.trace: | ||
| print("Connected") | ||
| else: | ||
| raise Exception("Connection failed.") | ||
|
|
||
|
|
||
| def on_message(client, userdata, msg): | ||
| global args | ||
| if msg.topic == f"{args.topic}refresh": | ||
| publish_data() | ||
|
|
||
|
|
||
| def on_publish(client, userdata, result): | ||
| print(f"Message {result} published\n") | ||
|
|
||
|
|
||
| def sigint_handler(signal, frame): | ||
| print('Interrupted. Shutting down.') | ||
| global client | ||
| client.disconnect() | ||
| client.loop_stop() | ||
| sys.exit(0) | ||
|
|
||
|
|
||
| def publish_data(): | ||
| global magnumReaders, client, args | ||
| try: | ||
| for comm_device, magnumReader in magnumReaders.items(): | ||
| try: | ||
| devices = magnumReader.getDevices() | ||
| if len(devices) != 0: | ||
| data = OrderedDict() | ||
| now = int(time.time()) | ||
| data["datetime"] = datetime.now(timezone.utc).replace( | ||
| microsecond=0).astimezone().isoformat() | ||
| data['comm_device'] = comm_device | ||
| for device in devices: | ||
| topic = args.topic + device["device"].lower() | ||
| data["device"] = device["device"] | ||
| data["data"] = device["data"] | ||
| payload = json.dumps(data, indent=None, ensure_ascii=True, allow_nan=True, separators=(',', ':')) | ||
| client.publish(topic, payload=payload) | ||
| except Exception as e: | ||
| print(f"{comm_device} {str(e)}") | ||
| except Exception as e: | ||
| print(str(e)) | ||
|
|
||
|
|
||
| signal.signal(signal.SIGINT, sigint_handler) | ||
| parser = MagnumArgumentParser(description="Magnum Data MQTT Publisher", fromfile_prefix_chars='@', | ||
| epilog="Refer to https://github.com/CharlesGodwin/pymagnum for details") | ||
| logger = parser.add_argument_group("MQTT publish") | ||
| reader = parser.add_argument_group("Magnum reader") | ||
| logger.add_argument("-t", "--topic", default='magnum/', | ||
| help="Topic prefix (default: %(default)s)") | ||
| logger.add_argument("-b", "--broker", default='localhost:1883', | ||
| help="MQTT Broker address and (optional port)(default: %(default)s)") | ||
| logger.add_argument("-i", "--interval", default=60, type=int, dest='interval', | ||
| help="Interval, in seconds, between publishing (default: %(default)s)") | ||
| logger.add_argument("--username", default='None', | ||
| help="MQTT User name, if needed (default: %(default)s)") | ||
| logger.add_argument("--password", default='None', | ||
| help="MQTT User password, if needed (default: %(default)s)") | ||
| reader.add_argument("-d", "--device", nargs='*', action='append', default=[], | ||
| help="Serial device name (default: /dev/ttyUSB0). You can specify more than one.") | ||
| reader.add_argument("--packets", default=50, type=int, | ||
| help="Number of packets to generate in reader (default: %(default)s)") | ||
| reader.add_argument("--timeout", default=0.005, type=float, | ||
| help="Timeout for serial read (default: %(default)s)") | ||
| reader.add_argument("--trace", action="store_true", | ||
| help="Add raw packet info to data (default: %(default)s)") | ||
| reader.add_argument("--nocleanup", action="store_true", default=False, dest='cleanpackets', | ||
| help="Suppress clean up of unknown packets (default: False)") | ||
| args = parser.magnum_parse_args() | ||
| if args.interval < 10 or args.interval > (60*60): | ||
| parser.error( | ||
| "argument -i/--interval: must be between 10 seconds and 3600 (1 hour)") | ||
| if args.topic[-1] != "/": | ||
| args.topic += "/" | ||
| print(f"Options:{str(args)[10:-1]}") | ||
| magnumReaders = dict() | ||
| for device in args.device: | ||
| try: | ||
| magnumReader = Magnum(device=device, packets=args.packets, trace=args.trace, | ||
| timeout=args.timeout, cleanpackets=args.cleanpackets) | ||
| magnumReader.getDevices() # test read to see if all's good | ||
| magnumReaders[magnumReader.getComm_Device()] = magnumReader | ||
| except Exception as e: | ||
| print(f"{device} {device}") | ||
| if len(magnumReaders) == 0: | ||
| print("Error: There are no usable devices connected.") | ||
| exit(2) | ||
|
|
||
| print( | ||
| f"Publishing to broker:{args.broker} Every:{args.interval} seconds. Using: {list(magnumReaders.keys())}") | ||
| uuidstr = str(uuid.uuid1()) | ||
| brokerinfo = args.broker.split(':') | ||
| if len(brokerinfo) == 1: | ||
| brokerinfo.append(1883) | ||
| client = mqtt.Client(client_id=uuidstr, clean_session=False) | ||
| if args.username != 'None': | ||
| client.username_pw_set(username=args.username, password=args.password) | ||
| client.on_connect = on_connect | ||
| client.on_message = on_message | ||
| if args.trace: | ||
| client.on_publish = on_publish | ||
| client.connect(brokerinfo[0], port=int(brokerinfo[1])) | ||
| client.loop_start() | ||
| while True: | ||
| start = time.time() | ||
| publish_data() | ||
| sleep = args.interval - (time.time() - start) | ||
| if sleep > 0: | ||
| time.sleep(sleep) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.