├── solis_service
    ├── __init__.py
    ├── persistence
    │   ├── __init__.py
    │   └── influxdb_persistence_client.py
    ├── messaging.py
    └── server.py
├── setup.py
├── requirements.txt
├── data
    ├── 2021-03-12.xlsx
    └── 2021-03-13.xlsx
├── pyproject.toml
├── .gitignore
├── setup.cfg
├── config
    ├── supervisord.conf
    └── solis-service.conf
├── scripts
    ├── intercept.py
    └── find_correlations.py
├── README.md
├── .github
    └── workflows
    │   └── build.yml
├── test
    └── test_messaging.py
└── LICENSE.md


/solis_service/__init__.py:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | import setuptools
2 | setuptools.setup()


--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | influxdb-client[ciso]
2 | numpy
3 | openpyxl
4 | pandas
5 | pint
6 | pytest


--------------------------------------------------------------------------------
/data/2021-03-12.xlsx:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/planetmarshall/solis-service/HEAD/data/2021-03-12.xlsx


--------------------------------------------------------------------------------
/data/2021-03-13.xlsx:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/planetmarshall/solis-service/HEAD/data/2021-03-13.xlsx


--------------------------------------------------------------------------------
/pyproject.toml:
--------------------------------------------------------------------------------
1 | [build-system]
2 | requires = ["setuptools", "wheel"]
3 | build-backend = "setuptools.build_meta"


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # IDE folders
 2 | .idea
 3 | 
 4 | # python folders
 5 | .venv
 6 | *.egg-info
 7 | __pycache__
 8 | 
 9 | # git files
10 | *.orig


--------------------------------------------------------------------------------
/setup.cfg:
--------------------------------------------------------------------------------
 1 | [metadata]
 2 | name = solis-service
 3 | version = 1.2.0
 4 | license = Apache-2.0
 5 | 
 6 | [options]
 7 | packages = find:
 8 | install_requires = pint
 9 |     influxdb-client[ciso]
10 | python_requires = >=3.7
11 | 
12 | [options.entry_points]
13 | console_scripts =
14 |     solis_service = solis_service.server:run
15 | 
16 | 


--------------------------------------------------------------------------------
/solis_service/persistence/__init__.py:
--------------------------------------------------------------------------------
 1 | from contextlib import contextmanager
 2 | 
 3 | from .influxdb_persistence_client import InfluxDbPersistenceClient
 4 | 
 5 | 
 6 | @contextmanager
 7 | def persistence_client(config):
 8 |     client = None
 9 |     try:
10 |         persistence_type = config["service"]["persistence"]
11 |         if persistence_type == "influxdb":
12 |             client = InfluxDbPersistenceClient(**config["influxdb"])
13 |             yield client
14 |         else:
15 |             raise ValueError(f"persistence type: {persistence_type}")
16 |     finally:
17 |         if client is not None:
18 |             client.close()
19 | 


--------------------------------------------------------------------------------
/config/supervisord.conf:
--------------------------------------------------------------------------------
 1 | [unix_http_server]
 2 | file=/tmp/supervisor.sock   ; the path to the socket file
 3 | chmod=0766                  ; needed so non-root users can run supervisorctl
 4 | 
 5 | [supervisord]
 6 | nodaemon=false
 7 | 
 8 | [rpcinterface:supervisor]
 9 | supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
10 | 
11 | [supervisorctl]
12 | serverurl=unix:///tmp/supervisor.sock
13 | 
14 | [program:solis_service]
15 | command=/usr/local/bin/solis_service
16 | user=solis
17 | stdout_logfile=/var/log/solis/solis.log
18 | stderr_logfile=/var/log/solis/solis_error.log
19 | 
20 | [rpcinterface:supervisor]
21 | supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
22 | 
23 | [supervisorctl]
24 | serverurl=unix:///tmp/supervisor.sock
25 | 


--------------------------------------------------------------------------------
/config/solis-service.conf:
--------------------------------------------------------------------------------
 1 | [service]
 2 | hostname = localhost
 3 | port = 19042
 4 | persistence = influxdb
 5 | 
 6 | [influxdb]
 7 | url = localhost
 8 | token = user:password
 9 | bucket = database/autogen
10 | org = -
11 | 
12 | [loggers]
13 | keys=solis_service,root
14 | 
15 | [handlers]
16 | keys=consoleHandler
17 | 
18 | [formatters]
19 | keys=simpleFormatter
20 | 
21 | [logger_root]
22 | level=DEBUG
23 | handlers=consoleHandler
24 | 
25 | [logger_solis_service]
26 | level=DEBUG
27 | handlers=consoleHandler
28 | qualname=solis_service
29 | propagate=0
30 | 
31 | [handler_consoleHandler]
32 | class=StreamHandler
33 | level=DEBUG
34 | formatter=simpleFormatter
35 | args=(sys.stdout,)
36 | 
37 | [formatter_simpleFormatter]
38 | format=%(asctime)s - %(name)s - %(levelname)s - %(message)s
39 | datefmt=


--------------------------------------------------------------------------------
/solis_service/persistence/influxdb_persistence_client.py:
--------------------------------------------------------------------------------
 1 | import asyncio
 2 | from datetime import datetime
 3 | from functools import partial
 4 | 
 5 | 
 6 | from influxdb_client import InfluxDBClient
 7 | from influxdb_client.client.write_api import SYNCHRONOUS
 8 | 
 9 | 
10 | def to_influx_measurement(timestamp, data):
11 |     return {
12 |         "measurement": f"solis_inverter_{data['inverter_serial_number']}",
13 |         "time": timestamp,
14 |         "fields": {key: value.magnitude for key, value in data.items() if key != "inverter_serial_number"}
15 |     }
16 | 
17 | 
18 | class InfluxDbPersistenceClient:
19 |     description = "InfluxDb Persistence Client"
20 | 
21 |     def __init__(self, url, token, org, bucket):
22 |         self.client = InfluxDBClient(url=url, token=token, org=org)
23 |         self.bucket = bucket
24 |         self.writer = self.client.write_api(write_options=SYNCHRONOUS)
25 | 
26 |     async def write_measurement(self, measurement):
27 |         timestamp = datetime.utcnow().isoformat()
28 |         record = to_influx_measurement(timestamp, measurement)
29 |         return asyncio.get_running_loop().run_in_executor(
30 |             None, partial(self.writer.write, self.bucket, record=record))
31 | 
32 |     def close(self):
33 |         self.writer.close()
34 |         self.client.close()
35 | 


--------------------------------------------------------------------------------
/scripts/intercept.py:
--------------------------------------------------------------------------------
 1 | import asyncio
 2 | import json
 3 | from base64 import b64encode
 4 | from datetime import datetime
 5 | 
 6 | 
 7 | async def _read_and_log_response(reader, writer):
 8 |     buffer_size = 1024
 9 |     data = await reader.read(buffer_size)
10 |     print(json.dumps({
11 |         'timestamp': datetime.now().isoformat(),
12 |         'target': writer.transport.get_extra_info("peername"),
13 |         'data': b64encode(data).decode('ascii'),
14 |         'length': len(data)})
15 |     )
16 | 
17 |     return data
18 | 
19 | 
20 | async def log_and_forward_response(reader, writer):
21 |     data = await _read_and_log_response(reader, writer)
22 |     writer.write(data)
23 |     await writer.drain()
24 | 
25 | 
26 | async def handle_inverter_message(inverter_reader, inverter_writer):
27 |     server_reader, server_writer = await asyncio.open_connection('47.88.8.200', 10000)
28 |     await log_and_forward_response(inverter_reader, server_writer)
29 |     await log_and_forward_response(server_reader, inverter_writer)
30 |     server_writer.close()
31 |     inverter_writer.close()
32 | 
33 | 
34 | async def main():
35 |     server = await asyncio.start_server(handle_inverter_message,
36 |             '192.168.10.9', 19042)
37 | 
38 |     print(f"serving on {server.sockets[0].getsockname()}")
39 | 
40 |     async with server:
41 |         await server.serve_forever()
42 | 
43 | 
44 | asyncio.run(main())
45 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Solis / Ginlong Inverter Service
 2 | 
 3 | ![Build and Run](https://github.com/planetmarshall/solis-service/actions/workflows/build.yml/badge.svg)
 4 | 
 5 | This Python package implements a service that interprets messages from a Solis PV Inverter
 6 | monitoring device and can persist them to various destinations
 7 | 
 8 | Here's it being used to display a Grafana dashboard on my Raspberry Pi
 9 | 
10 | ![Grafana Dashboard](https://www.algodynamic.co.uk/images/grafana.png)
11 | 
12 | ## Configuration
13 | 
14 | See the example file in `conf`.
15 | 
16 | ### Persistence Clients
17 | 
18 | Currently [InfluxDb](https://www.influxdata.com/) is supported. Persistence clients are encapsulated such that
19 | adding new ones should be straightforward. See the configuration file for details.
20 | 
21 | ## Installing as a service
22 | 
23 | To install as a service, I use [supervisor](http://supervisord.org/).
24 | 
25 |     sudo pip install . supervisor
26 |     adduser solis
27 |     sudo mkdir -p /var/log/solis
28 |     sudo chown -R solis:solis /var/log/solis
29 | 
30 | Create a `supervisord.conf`, if you have not already done so and edit. See the example in
31 | the `conf` folder.
32 | 
33 | Run supervisor
34 | 
35 |     sudo supervisord -c conf/supervisord.conf
36 |     supervisorctl -c conf/supervisord.conf status
37 |     supervisorctl -c conf/supervisord.conf tail solis_service
38 | 
39 | ## Reverse engineering the data protocol
40 | 
41 | For some details on reverse engineering the protocol, See my 
42 | [blog](https://www.algodynamic.co.uk/reverse-engineering-the-solisginlong-inverter-protocol.html)


--------------------------------------------------------------------------------
/.github/workflows/build.yml:
--------------------------------------------------------------------------------
 1 | name: CI
 2 | 
 3 | on:
 4 |   push:
 5 |     branches:
 6 |       - main
 7 |   pull_request:
 8 |     branches:
 9 |       - main
10 | 
11 |   workflow_dispatch:
12 | 
13 | jobs:
14 |   build:
15 |     name: Build package and test
16 |     runs-on: ubuntu-20.04
17 | 
18 |     steps:
19 |       - name: Checkout repository
20 |         uses: actions/checkout@v2
21 | 
22 |       - name: Set up Python
23 |         uses: actions/setup-python@v2
24 |         with:
25 |           python-version: 3.7
26 | 
27 |       - name: Static Analysis
28 |         run: |
29 |           python -m pip install --upgrade pip
30 |           pip install flake8
31 |           flake8 --count --max-line-length=120 --statistics solis_service
32 | 
33 |       - name: Install Prerequisites
34 |         run: |
35 |           sudo adduser --disabled-password --gecos "" solis
36 |           sudo mkdir -p /var/log/solis
37 |           sudo chown -R solis:solis /var/log/solis
38 |           sudo pip install . pytest supervisor
39 |           sudo cp config/solis-service.conf /etc/solis-service.conf
40 |           sudo chown solis:solis /etc/solis-service.conf
41 |           sudo chmod 600 /etc/solis-service.conf
42 | 
43 |       - name: Run tests
44 |         run: |
45 |           pytest -v test
46 | 
47 |       - name: Configure and run supervisor
48 |         run: |
49 |           CONFIG=config/supervisord.conf
50 |           sudo supervisord -c ${CONFIG}
51 |           sleep 10s
52 |           supervisorctl -c ${CONFIG} status
53 |           supervisorctl -c ${CONFIG} tail solis_service
54 |           sudo pkill supervisord
55 | 
56 |       - name: Show error logs
57 |         run: |
58 |           cat supervisord.log
59 |           cat /var/log/solis/solis.log
60 |           cat /var/log/solis/solis_error.log
61 |         if: always()
62 | 


--------------------------------------------------------------------------------
/solis_service/messaging.py:
--------------------------------------------------------------------------------
 1 | from datetime import datetime
 2 | from io import BytesIO
 3 | from functools import reduce
 4 | from struct import unpack_from, pack
 5 | 
 6 | import pint
 7 | 
 8 | 
 9 | ureg = pint.UnitRegistry()
10 | 
11 | 
12 | def parse_inverter_message(message):
13 |     return {
14 |         "inverter_serial_number":           message[32:48].decode("ascii").rstrip(),
15 |         "inverter_temperature":             0.1 * unpack_from("<H", message, 48)[0] * ureg.centigrade,
16 |         "dc_voltage_pv1":                   0.1 * unpack_from("<H", message, 50)[0] * ureg.volt,  # could also be 52
17 |         "dc_current":                       0.1 * unpack_from("<H", message, 54)[0] * ureg.amperes,
18 |         "ac_current_t_w_c":                 0.1 * unpack_from("<H", message, 62)[0] * ureg.amperes,
19 |         "ac_voltage_t_w_c":                 0.1 * unpack_from("<H", message, 68)[0] * ureg.volt,
20 |         "ac_output_frequency":              0.01 * unpack_from("<H", message, 70)[0] * ureg.hertz,
21 |         "daily_active_generation":          0.01 * unpack_from("<H", message, 76)[0] * ureg.kilowatt_hour,
22 |         "total_dc_input_power":             float(unpack_from("<I", message, 116)[0]) * ureg.watts,
23 |         "total_active_generation":          float(unpack_from("<I", message, 120)[0]) * ureg.kilowatt_hour,  # or 130
24 |         "generation_yesterday":             0.1 * unpack_from("<H", message, 128)[0] * ureg.kilowatt_hour,
25 |         "power_grid_total_apparent_power":  float(unpack_from("<I", message, 142)[0]) * ureg.volt_ampere,
26 |     }
27 | 
28 | 
29 | def checksum_byte(buffer):
30 |     return reduce(lambda lrc, x: (lrc + x) & 255, buffer) & 255
31 | 
32 | 
33 | def mock_server_response(clock, mode, timestamp=None):
34 |     unix_time = int(datetime.utcnow().timestamp() if timestamp is None else timestamp)
35 |     buffer = BytesIO()
36 |     header = b'\xa5\n\x00\x10'
37 |     buffer.write(header)
38 |     buffer.write(mode)
39 |     buffer.write(pack("<B", clock))
40 |     prefix = b'\x01\xc2\xe8\xd7\xf0\x02\x01'
41 |     buffer.write(prefix)
42 |     buffer.write(pack("<I", unix_time))
43 |     suffix = b'\x00\x00\x00\x00'
44 |     buffer.write(suffix)
45 |     checksum_data = buffer.getvalue()
46 |     buffer.write(pack("<B", checksum_byte(checksum_data[1:])))
47 |     buffer.write(b'\x15')
48 | 
49 |     return buffer.getvalue()
50 | 


--------------------------------------------------------------------------------
/test/test_messaging.py:
--------------------------------------------------------------------------------
 1 | from solis_service import messaging
 2 | 
 3 | 
 4 | def test_parse_inverter_message():
 5 |     message = b"\xa5\xe9\x00\x10BO\x02\xc2\xe8\xd7\xf0\x01\x07\x05\xa7r\x01\x00\x12\x00\x00\x00'\x0cJ`\x01" \
 6 |               b"\x00\x9a\x01\x00\x00060E31208070023 p\x01X\x08\x08\x00\x14\x00\x01\x00\x00\x00\x00\x00\x10" \
 7 |               b"\x00\x00\x00\x00\x008\t\x8a\x13r\x01\x00\x00\xbe\x00\x00\x002\x00\x00\x00\x00\x00\x00\x00" \
 8 |               b"\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00\x01\x00\x12\x0e" \
 9 |               b"\x00\x00\xf8*\xe8\x03\xab\x01\x00\x00\x05\x00\x00\x00\x00\x00\x00\x00 \x00\x05\x00\x00\x00" \
10 |               b"\x00\x00\x00\x004\x00\x04\x00r\x01\x00\x00\x15\x00\x03\x00\x0c\x00\x0e\x00.\x00\x1e\x00\xe3" \
11 |               b"\x00*\x00C\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" \
12 |               b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" \
13 |               b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" \
14 |               b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x03\x00\x96\x15"
15 | 
16 |     data = messaging.parse_inverter_message(message)
17 |     expected = {
18 |         "inverter_temperature": 36.8,
19 |         "dc_voltage_pv1": 213.6,
20 |         "dc_current": 2.0,
21 |         "ac_current_t_w_c": 1.6,
22 |         "ac_voltage_t_w_c": 236.0,
23 |         "ac_output_frequency": 50.02,
24 |         "daily_active_generation": 1.9,
25 |         "total_dc_input_power": 427.0,
26 |         "total_active_generation": 5.0,
27 |         "generation_yesterday": 3.2,
28 |         "power_grid_total_apparent_power": 370.0
29 |     }
30 | 
31 |     assert data["inverter_serial_number"] == "060E31208070023"
32 |     for key in expected.keys():
33 |         if key != "inverter_serial_number":
34 |             assert expected[key] - data[key].magnitude < 1.0e-5
35 | 
36 | 
37 | def test_checksum():
38 |     heartbeat = b'\xa5\n\x00\x10\x12\xbc\x04\xc2\xe8\xd7\xf0\x01\x01\x08CS`\x00\x00\x00\x00]\x15'
39 |     lrc = messaging.checksum_byte(heartbeat[1:-2])
40 | 
41 |     assert lrc == 93
42 | 
43 | 
44 | def test_mock_server_response():
45 |     expected = b'\xa5\n\x00\x10\x12\xbc\x01\xc2\xe8\xd7\xf0\x02\x01\x08CS`\x00\x00\x00\x00[\x15'
46 |     response = messaging.mock_server_response(188, b'\x12', 1616069384)
47 |     assert response == expected
48 | 


--------------------------------------------------------------------------------
/scripts/find_correlations.py:
--------------------------------------------------------------------------------
 1 | import json
 2 | from base64 import b64decode
 3 | import struct
 4 | 
 5 | import pandas as pd
 6 | 
 7 | 
 8 | def decode_elements(data, data_format, offset):
 9 |     required_size = struct.calcsize(data_format)
10 |     for i in range(offset, len(data) - required_size + 1):
11 |         yield i, struct.unpack_from(data_format, data, i)[0]
12 | 
13 | 
14 | def decode_candidate(entry, data_format, offset):
15 |     candidate = {"Time": entry["timestamp"]}
16 |     candidate.update(decode_elements(b64decode(entry["data"]), data_format, offset))
17 |     return candidate
18 | 
19 | 
20 | def decode_candidates(file, data_format, length, offset):
21 |     for row in file:
22 |         entry = json.loads(row)
23 |         if entry["length"] == length:
24 |             yield decode_candidate(entry, data_format, offset)
25 | 
26 | 
27 | def load_exported_data(data_file):
28 |     return pd.read_excel(data_file, skiprows=3)
29 | 
30 | 
31 | def load_candidates(log_file, data_format, offset=0):
32 |     with open(log_file) as fp:
33 |         candidates = pd.DataFrame.from_dict(decode_candidates(fp, data_format, 246, offset))
34 |         candidates["Time"] = pd.to_datetime(candidates["Time"])
35 |         return candidates
36 | 
37 | 
38 | def column_correlations(expected, candidates, test_column):
39 |     comparison = pd.merge_asof(expected[["Time", test_column]], candidates, on="Time")
40 |     columns = [i for i in comparison.columns if i not in (test_column, "Time")]
41 |     correlations = [(column, comparison[test_column].corr(comparison[column])) for column in columns]
42 |     return pd.DataFrame(correlations, columns=["index", "correlation"])\
43 |         .set_index("index")\
44 |         .sort_values(by="correlation", ascending=False)
45 | 
46 | 
47 | def best_matches(expected: pd.DataFrame, log, data_format):
48 |     candidates = load_candidates(log, data_format)
49 |     excluded_columns = [
50 |         'Time',
51 |         'InverterSN',
52 |         'Data LoggerSN',
53 |         'Alert Details',
54 |         'Alert Code',
55 |         'Inverter Status',
56 |         'System Time'
57 |     ]
58 |     test_columns = [column for column in expected.columns if column not in excluded_columns]
59 |     for test_column in test_columns:
60 |         comparison = merge_comparison(expected, candidates, test_column)
61 |         correlations = column_correlations(comparison, test_column)
62 |         for correlation in correlations[:5].itertuples():
63 |             yield {
64 |                 "column": test_column,
65 |                 "correlation": correlation.correlation,
66 |                 "field": correlation.Index,
67 |                 "format": data_format
68 |             }
69 | 
70 | 
71 | 


--------------------------------------------------------------------------------
/solis_service/server.py:
--------------------------------------------------------------------------------
  1 | import argparse
  2 | import asyncio
  3 | from configparser import ConfigParser
  4 | import functools
  5 | import logging
  6 | import logging.config
  7 | import os
  8 | 
  9 | from .messaging import (
 10 |     parse_inverter_message,
 11 |     mock_server_response
 12 | )
 13 | from .persistence import persistence_client
 14 | 
 15 | 
 16 | __clock = 0
 17 | logger = logging.getLogger("solis_service")
 18 | 
 19 | 
 20 | def load_config(config_file=None):
 21 |     if config_file is None:
 22 |         config_file_name = "solis-service.conf"
 23 |         candidates = [os.path.realpath(os.path.join(prefix, config_file_name))
 24 |                       for prefix in [".", "/etc", "/usr/local/etc"]]
 25 |         for candidate in candidates:
 26 |             if os.path.exists(candidate):
 27 |                 config_file = candidate
 28 |         if config_file is None:
 29 |             raise ValueError("No config file found")
 30 | 
 31 |     config_file_path = os.path.realpath(config_file)
 32 |     logging.config.fileConfig(config_file)
 33 |     config = ConfigParser()
 34 |     config.read(config_file_path)
 35 |     return config
 36 | 
 37 | 
 38 | def increment_clock():
 39 |     global __clock
 40 |     return ++__clock & 255
 41 | 
 42 | 
 43 | def _heartbeat_response():
 44 |     return mock_server_response(increment_clock(), b'\x11')
 45 | 
 46 | 
 47 | def _data_response():
 48 |     return mock_server_response(increment_clock(), b'\x12')
 49 | 
 50 | 
 51 | def _is_heartbeat(message):
 52 |     return len(message) == 99
 53 | 
 54 | 
 55 | def _is_data_packet(message):
 56 |     return len(message) == 246
 57 | 
 58 | 
 59 | async def handle_inverter_message(persist, reader, writer):
 60 |     buffer_size = 512
 61 |     message = await reader.read(buffer_size)
 62 | 
 63 |     if _is_heartbeat(message):
 64 |         logger.debug(f'Received heartbeat message from {writer.transport.get_extra_info("peername")}')
 65 |         writer.write(_heartbeat_response())
 66 |         writer.close()
 67 | 
 68 |     elif _is_data_packet(message):
 69 |         writer.write(_data_response())
 70 |         writer.close()
 71 |         inverter_data = parse_inverter_message(message)
 72 |         logger.debug(f'Received data message from {writer.transport.get_extra_info("peername")}')
 73 |         logger.debug(f'data message: {inverter_data}')
 74 |         logger.debug(f'persisting data with {persist.description}')
 75 |         result = await persist.write_measurement(inverter_data)
 76 |         logger.debug(f'persistence result: {result}')
 77 | 
 78 | 
 79 | async def main(hostname, port, config):
 80 |     logger.info(f"Starting server on {hostname}:{port}")
 81 |     with persistence_client(config) as client:
 82 |         server = await asyncio.start_server(functools.partial(handle_inverter_message, client), hostname, port)
 83 |         async with server:
 84 |             await server.serve_forever()
 85 | 
 86 | 
 87 | def run():
 88 |     parser = argparse.ArgumentParser(
 89 |         description="Receive messages from a Solis/Ginsong inverter and persist to a database")
 90 |     parser.add_argument("--config", help="load a config file")
 91 |     args = parser.parse_args()
 92 |     config = load_config(args.config)
 93 |     service_config = config["service"]
 94 |     hostname = service_config.get("hostname", "localhost")
 95 |     port = service_config.get("port", "9042")
 96 | 
 97 |     asyncio.run(main(hostname, int(port), config))
 98 | 
 99 | 
100 | if __name__ == "__main__":
101 |     run()
102 | 


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
  1 | 
  2 |                                  Apache License
  3 |                            Version 2.0, January 2004
  4 |                         http://www.apache.org/licenses/
  5 | 
  6 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  7 | 
  8 |    1. Definitions.
  9 | 
 10 |       "License" shall mean the terms and conditions for use, reproduction,
 11 |       and distribution as defined by Sections 1 through 9 of this document.
 12 | 
 13 |       "Licensor" shall mean the copyright owner or entity authorized by
 14 |       the copyright owner that is granting the License.
 15 | 
 16 |       "Legal Entity" shall mean the union of the acting entity and all
 17 |       other entities that control, are controlled by, or are under common
 18 |       control with that entity. For the purposes of this definition,
 19 |       "control" means (i) the power, direct or indirect, to cause the
 20 |       direction or management of such entity, whether by contract or
 21 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 22 |       outstanding shares, or (iii) beneficial ownership of such entity.
 23 | 
 24 |       "You" (or "Your") shall mean an individual or Legal Entity
 25 |       exercising permissions granted by this License.
 26 | 
 27 |       "Source" form shall mean the preferred form for making modifications,
 28 |       including but not limited to software source code, documentation
 29 |       source, and configuration files.
 30 | 
 31 |       "Object" form shall mean any form resulting from mechanical
 32 |       transformation or translation of a Source form, including but
 33 |       not limited to compiled object code, generated documentation,
 34 |       and conversions to other media types.
 35 | 
 36 |       "Work" shall mean the work of authorship, whether in Source or
 37 |       Object form, made available under the License, as indicated by a
 38 |       copyright notice that is included in or attached to the work
 39 |       (an example is provided in the Appendix below).
 40 | 
 41 |       "Derivative Works" shall mean any work, whether in Source or Object
 42 |       form, that is based on (or derived from) the Work and for which the
 43 |       editorial revisions, annotations, elaborations, or other modifications
 44 |       represent, as a whole, an original work of authorship. For the purposes
 45 |       of this License, Derivative Works shall not include works that remain
 46 |       separable from, or merely link (or bind by name) to the interfaces of,
 47 |       the Work and Derivative Works thereof.
 48 | 
 49 |       "Contribution" shall mean any work of authorship, including
 50 |       the original version of the Work and any modifications or additions
 51 |       to that Work or Derivative Works thereof, that is intentionally
 52 |       submitted to Licensor for inclusion in the Work by the copyright owner
 53 |       or by an individual or Legal Entity authorized to submit on behalf of
 54 |       the copyright owner. For the purposes of this definition, "submitted"
 55 |       means any form of electronic, verbal, or written communication sent
 56 |       to the Licensor or its representatives, including but not limited to
 57 |       communication on electronic mailing lists, source code control systems,
 58 |       and issue tracking systems that are managed by, or on behalf of, the
 59 |       Licensor for the purpose of discussing and improving the Work, but
 60 |       excluding communication that is conspicuously marked or otherwise
 61 |       designated in writing by the copyright owner as "Not a Contribution."
 62 | 
 63 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 64 |       on behalf of whom a Contribution has been received by Licensor and
 65 |       subsequently incorporated within the Work.
 66 | 
 67 |    2. Grant of Copyright License. Subject to the terms and conditions of
 68 |       this License, each Contributor hereby grants to You a perpetual,
 69 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 70 |       copyright license to reproduce, prepare Derivative Works of,
 71 |       publicly display, publicly perform, sublicense, and distribute the
 72 |       Work and such Derivative Works in Source or Object form.
 73 | 
 74 |    3. Grant of Patent License. Subject to the terms and conditions of
 75 |       this License, each Contributor hereby grants to You a perpetual,
 76 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 77 |       (except as stated in this section) patent license to make, have made,
 78 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 79 |       where such license applies only to those patent claims licensable
 80 |       by such Contributor that are necessarily infringed by their
 81 |       Contribution(s) alone or by combination of their Contribution(s)
 82 |       with the Work to which such Contribution(s) was submitted. If You
 83 |       institute patent litigation against any entity (including a
 84 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 85 |       or a Contribution incorporated within the Work constitutes direct
 86 |       or contributory patent infringement, then any patent licenses
 87 |       granted to You under this License for that Work shall terminate
 88 |       as of the date such litigation is filed.
 89 | 
 90 |    4. Redistribution. You may reproduce and distribute copies of the
 91 |       Work or Derivative Works thereof in any medium, with or without
 92 |       modifications, and in Source or Object form, provided that You
 93 |       meet the following conditions:
 94 | 
 95 |       (a) You must give any other recipients of the Work or
 96 |           Derivative Works a copy of this License; and
 97 | 
 98 |       (b) You must cause any modified files to carry prominent notices
 99 |           stating that You changed the files; and
100 | 
101 |       (c) You must retain, in the Source form of any Derivative Works
102 |           that You distribute, all copyright, patent, trademark, and
103 |           attribution notices from the Source form of the Work,
104 |           excluding those notices that do not pertain to any part of
105 |           the Derivative Works; and
106 | 
107 |       (d) If the Work includes a "NOTICE" text file as part of its
108 |           distribution, then any Derivative Works that You distribute must
109 |           include a readable copy of the attribution notices contained
110 |           within such NOTICE file, excluding those notices that do not
111 |           pertain to any part of the Derivative Works, in at least one
112 |           of the following places: within a NOTICE text file distributed
113 |           as part of the Derivative Works; within the Source form or
114 |           documentation, if provided along with the Derivative Works; or,
115 |           within a display generated by the Derivative Works, if and
116 |           wherever such third-party notices normally appear. The contents
117 |           of the NOTICE file are for informational purposes only and
118 |           do not modify the License. You may add Your own attribution
119 |           notices within Derivative Works that You distribute, alongside
120 |           or as an addendum to the NOTICE text from the Work, provided
121 |           that such additional attribution notices cannot be construed
122 |           as modifying the License.
123 | 
124 |       You may add Your own copyright statement to Your modifications and
125 |       may provide additional or different license terms and conditions
126 |       for use, reproduction, or distribution of Your modifications, or
127 |       for any such Derivative Works as a whole, provided Your use,
128 |       reproduction, and distribution of the Work otherwise complies with
129 |       the conditions stated in this License.
130 | 
131 |    5. Submission of Contributions. Unless You explicitly state otherwise,
132 |       any Contribution intentionally submitted for inclusion in the Work
133 |       by You to the Licensor shall be under the terms and conditions of
134 |       this License, without any additional terms or conditions.
135 |       Notwithstanding the above, nothing herein shall supersede or modify
136 |       the terms of any separate license agreement you may have executed
137 |       with Licensor regarding such Contributions.
138 | 
139 |    6. Trademarks. This License does not grant permission to use the trade
140 |       names, trademarks, service marks, or product names of the Licensor,
141 |       except as required for reasonable and customary use in describing the
142 |       origin of the Work and reproducing the content of the NOTICE file.
143 | 
144 |    7. Disclaimer of Warranty. Unless required by applicable law or
145 |       agreed to in writing, Licensor provides the Work (and each
146 |       Contributor provides its Contributions) on an "AS IS" BASIS,
147 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 |       implied, including, without limitation, any warranties or conditions
149 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 |       PARTICULAR PURPOSE. You are solely responsible for determining the
151 |       appropriateness of using or redistributing the Work and assume any
152 |       risks associated with Your exercise of permissions under this License.
153 | 
154 |    8. Limitation of Liability. In no event and under no legal theory,
155 |       whether in tort (including negligence), contract, or otherwise,
156 |       unless required by applicable law (such as deliberate and grossly
157 |       negligent acts) or agreed to in writing, shall any Contributor be
158 |       liable to You for damages, including any direct, indirect, special,
159 |       incidental, or consequential damages of any character arising as a
160 |       result of this License or out of the use or inability to use the
161 |       Work (including but not limited to damages for loss of goodwill,
162 |       work stoppage, computer failure or malfunction, or any and all
163 |       other commercial damages or losses), even if such Contributor
164 |       has been advised of the possibility of such damages.
165 | 
166 |    9. Accepting Warranty or Additional Liability. While redistributing
167 |       the Work or Derivative Works thereof, You may choose to offer,
168 |       and charge a fee for, acceptance of support, warranty, indemnity,
169 |       or other liability obligations and/or rights consistent with this
170 |       License. However, in accepting such obligations, You may act only
171 |       on Your own behalf and on Your sole responsibility, not on behalf
172 |       of any other Contributor, and only if You agree to indemnify,
173 |       defend, and hold each Contributor harmless for any liability
174 |       incurred by, or claims asserted against, such Contributor by reason
175 |       of your accepting any such warranty or additional liability.
176 | 
177 |    END OF TERMS AND CONDITIONS
178 | 
179 |    APPENDIX: How to apply the Apache License to your work.
180 | 
181 |       To apply the Apache License to your work, attach the following
182 |       boilerplate notice, with the fields enclosed by brackets "[]"
183 |       replaced with your own identifying information. (Don't include
184 |       the brackets!)  The text should be enclosed in the appropriate
185 |       comment syntax for the file format. We also recommend that a
186 |       file or class name and description of purpose be included on the
187 |       same "printed page" as the copyright notice for easier
188 |       identification within third-party archives.
189 | 
190 |    Copyright [yyyy] [name of copyright owner]
191 | 
192 |    Licensed under the Apache License, Version 2.0 (the "License");
193 |    you may not use this file except in compliance with the License.
194 |    You may obtain a copy of the License at
195 | 
196 |        http://www.apache.org/licenses/LICENSE-2.0
197 | 
198 |    Unless required by applicable law or agreed to in writing, software
199 |    distributed under the License is distributed on an "AS IS" BASIS,
200 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201 |    See the License for the specific language governing permissions and
202 |    limitations under the License.


--------------------------------------------------------------------------------