Revert "Delete sungather.py"

This reverts commit 32a2792371.
This commit is contained in:
bohdan-s
2022-07-07 14:09:02 +10:00
parent 32a2792371
commit cd53342ca8
+571
View File
@@ -0,0 +1,571 @@
#!/usr/bin/python3
from SungrowModbusTcpClient import SungrowModbusTcpClient
from SungrowModbusWebClient import SungrowModbusWebClient
from pymodbus.client.sync import ModbusTcpClient
from version import __version__
from datetime import datetime
import importlib
import logging
import logging.handlers
import sys
import getopt
import yaml
import time
import os
class SungrowInverter():
def __init__(self, config_inverter):
self.client_config = {
"host": config_inverter.get('host'),
"port": config_inverter.get('port'),
"timeout": config_inverter.get('timeout'),
"retries": config_inverter.get('retries'),
"RetryOnEmpty": False,
}
self.inverter_config = {
"slave": config_inverter.get('slave'),
"model": config_inverter.get('model'),
"level": config_inverter.get('level'),
"use_local_time": config_inverter.get('use_local_time'),
"smart_meter": config_inverter.get('smart_meter'),
"connection": config_inverter.get('connection')
}
self.client = None
self.registers = [[]]
self.registers.pop() # Remove null value from list
self.registers_custom = [{'name': 'export_to_grid', 'unit': 'W', 'address': 'vr001'}, {'name': 'import_from_grid', 'unit': 'W', 'address': 'vr002'}, {'name': 'run_state', 'address': 'vr003'}, {'name': 'timestamp', 'address': 'vr004'}]
self.register_ranges = [[]]
self.register_ranges.pop() # Remove null value from list
self.latest_scrape = {}
def connect(self):
if self.client:
try: self.client.connect()
except: return False
return True
if self.inverter_config['connection'] == "http":
self.client_config['port'] = '8082'
self.client = SungrowModbusWebClient.SungrowModbusWebClient(**self.client_config)
elif self.inverter_config['connection'] == "sungrow":
self.client = SungrowModbusTcpClient.SungrowModbusTcpClient(**self.client_config)
elif self.inverter_config['connection'] == "modbus":
self.client = ModbusTcpClient(**self.client_config)
else:
logging.warning(f"Inverter: Unknown connection type {self.inverter_config['connection']}, Valid options are http, sungrow or modbus")
return False
logging.info("Connection: " + str(self.client))
try: self.client.connect()
except: return False
time.sleep(3) # Wait 3 seconds, fixes timing issues
return True
def checkConnection(self):
logging.debug("Checking Modbus Connection")
if self.client:
if self.client.is_socket_open():
logging.debug("Modbus, Session is still connected")
return True
else:
logging.info(f'Modbus, Connecting new session')
return self.connect()
else:
logging.info(f'Modbus client is not connected, attempting to reconnect')
return self.connect()
def close(self):
logging.info("Closing Session: " + str(self.client))
try: self.client.close()
except: pass
def disconnect(self):
logging.info("Disconnecting: " + str(self.client))
try: self.client.close()
except: pass
self.client = None
def configure_registers(self,registersfile):
# Check model so we can load only valid registers
if self.inverter_config.get('model'):
logging.info(f"Bypassing Model Detection, Using config: {self.inverter_config.get('model')}")
else:
# Load just the register to detect model, then we can load the rest of registers based on returned model
for register in registersfile['registers'][0]['read']:
if register.get('name') == "device_type_code":
register['type'] = "read"
self.registers.append(register)
if self.load_registers(register['type'], register['address'] -1, 1): # Needs to be address -1
if isinstance(self.latest_scrape.get('device_type_code'),int):
logging.warning(f"Unknown Type Code Detected: {self.latest_scrape.get('device_type_code')}")
else:
self.inverter_config['model'] = self.latest_scrape.get('device_type_code')
logging.info(f"Detected Model: {self.inverter_config.get('model')}")
else:
logging.info(f'Model detection failed, please set model in config.py')
self.registers.pop()
break
# Load register list based on name and value after checking model
for register in registersfile['registers'][0]['read']:
if register.get('level',3) <= self.inverter_config.get('level') or self.inverter_config.get('level') == 3:
register['type'] = "read"
register.pop('level')
if register.get('smart_meter') and self.inverter_config.get('smart_meter'):
register.pop('models')
self.registers.append(register)
elif register.get('models') and not self.inverter_config.get('level') == 3:
for supported_model in register.get('models'):
if supported_model == self.inverter_config.get('model'):
register.pop('models')
self.registers.append(register)
else:
self.registers.append(register)
for register in registersfile['registers'][1]['hold']:
if register.get('level',3) <= self.inverter_config.get('level') or self.inverter_config.get('level') == 3:
register['type'] = "hold"
register.pop('level')
if register.get('smart_meter') and self.inverter_config.get('smart_meter'):
register.pop('models')
self.registers.append(register)
elif register.get('models') and not self.inverter_config.get('level',1) == 3:
for supported_model in register.get('models'):
if supported_model == self.inverter_config.get('model'):
register.pop('models')
self.registers.append(register)
else:
self.registers.append(register)
# Load register list based om name and value after checking model
for register_range in registersfile['scan'][0]['read']:
register_range_used = False
register_range['type'] = "read"
for register in self.registers:
if register.get("type") == register_range.get("type"):
if register.get('address') >= register_range.get("start") and register.get('address') <= (register_range.get("start") + register_range.get("range")):
register_range_used = True
continue
if register_range_used:
self.register_ranges.append(register_range)
for register_range in registersfile['scan'][1]['hold']:
register_range_used = False
register_range['type'] = "hold"
for register in self.registers:
if register.get("type") == register_range.get("type"):
if register.get('address') >= register_range.get("start") and register.get('address') <= (register_range.get("start") + register_range.get("range")):
register_range_used = True
continue
if register_range_used:
self.register_ranges.append(register_range)
return True
def load_registers(self, register_type, start, count=100):
try:
logging.debug(f'load_registers: {register_type}, {start}:{count}')
if register_type == "read":
rr = self.client.read_input_registers(start,count=count, unit=self.inverter_config['slave'])
elif register_type == "hold":
rr = self.client.read_holding_registers(start,count=count, unit=self.inverter_config['slave'])
else:
raise RuntimeError(f"Unsupported register type: {type}")
except Exception as err:
logging.warning(f"No data returned for {register_type}, {start}:{count}")
logging.debug(f"{str(err)}')")
return False
if rr.isError():
logging.warning(f"Modbus connection failed")
logging.debug(f"{rr}")
return False
if not hasattr(rr, 'registers'):
logging.warning("No registers returned")
return False
if len(rr.registers) != count:
logging.warning(f"Mismatched number of registers read {len(rr.registers)} != {count}")
return False
for num in range(0, count):
run = int(start) + num + 1
for register in self.registers:
if register_type == register['type'] and register['address'] == run:
register_name = register['name']
register_value = rr.registers[num]
# Convert unsigned to signed
if register.get('datatype') == "S32":
u32_value = rr.registers[num+1]
if u32_value == 65535: # Flag to say value is negative for 32bit
register_value = (register_value - 65535)
elif register.get('datatype') == "S16":
if register_value >= 32767: # Anything greater than 32767 is a negative for 16bit
register_value = (register_value - 65535)
# We convert a system response to a human value
if register.get('datarange'):
for value in register.get('datarange'):
if value['response'] == rr.registers[num]:
register_value = value['value']
if not register_value:
register_value = rr.registers[num]
# If xFF / xFFFF then change to 0, looks better when logging / graphing
if register_value == 65535:
register_value = 0
if register.get('accuracy'):
register_value = round(register_value * register.get('accuracy'),2)
# Set the final register value with adjustments above included
self.latest_scrape[register_name] = register_value
break
return True
def validateRegister(self, check_register):
for register in self.registers:
if check_register == register['name']:
return True
for register in self.registers_custom:
if check_register == register['name']:
return True
return False
def getRegisterAddress(self, check_register):
for register in self.registers:
if check_register == register['name']:
return register['address']
for register in self.registers_custom:
if check_register == register['name']:
return register['address']
return '----'
def getRegisterUnit(self, check_register):
for register in self.registers:
if check_register == register['name']:
return register.get('unit','')
for register in self.registers_custom:
if check_register == register['name']:
return register.get('unit','')
return ''
def validateLatestScrape(self, check_register):
for register, value in self.latest_scrape.items():
if check_register == register:
return True
return False
def getRegisterValue(self, check_register):
for register, value in self.latest_scrape.items():
if check_register == register:
return value
return False
def getHost(self):
return self.client_config['host']
def getInverterModel(self, clean=False):
if clean:
return self.inverter_config['model'].replace('.','').replace('-','')
else:
return self.inverter_config['model']
def scrape(self):
scrape_start = datetime.now()
# Clear previous inverter values, keep the model and run state
if self.latest_scrape.get("run_state"): run_state = self.latest_scrape.get("run_state")
else: run_state = "ON"
self.latest_scrape = {}
self.latest_scrape['device_type_code'] = self.inverter_config['model']
self.latest_scrape["run_state"] = run_state
load_registers_count = 0
load_registers_failed = 0
for range in self.register_ranges:
load_registers_count +=1
logging.debug(f'Scraping: {range.get("type")}, {range.get("start")}:{range.get("range")}')
if not self.load_registers(range.get('type'), int(range.get('start')), int(range.get('range'))):
load_registers_failed +=1
if load_registers_failed == load_registers_count:
# If every scrape fails, disconnect the client
logging.warning
self.disconnect()
return False
if load_registers_failed > 0:
logging.info(f'Scraping: {load_registers_failed}/{load_registers_count} registers failed to scrape')
# Leave connection open, see if helps resolve the connection issues
#self.close()
# Create a registers for Power imported and exported to/from Grid
if self.inverter_config['level'] >= 1:
try:
self.latest_scrape["export_to_grid"] = 0
self.latest_scrape["import_from_grid"] = 0
power = self.latest_scrape.get('meter_power', self.latest_scrape.get('export_power', 0))
if power < 0:
self.latest_scrape["export_to_grid"] = abs(power)
elif power >= 0:
self.latest_scrape["import_from_grid"] = power
except Exception:
pass
try: # If inverter is returning no data for load_power, we can calculate it manually
if not self.latest_scrape["load_power"]:
self.latest_scrape["load_power"] = int(self.latest_scrape.get('total_active_power')) + int(self.latest_scrape.get('meter_power'))
except Exception:
pass
# See if the inverter is running, This is added to inverters so can be read via MQTT etc...
# It is also used below, as some registers hold the last value on 'stop' so we need to set to 0
# to help with graphing.
try:
if self.latest_scrape.get('start_stop'):
if self.latest_scrape.get('start_stop', False) == 'Start' and self.latest_scrape.get('work_state_1', False).contains('Run'):
self.latest_scrape["run_state"] = "ON"
else:
self.latest_scrape["run_state"] = "OFF"
else:
self.latest_scrape["run_state"] = "OFF"
except Exception:
pass
if self.inverter_config.get('use_local_time',False):
self.latest_scrape["timestamp"] = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
logging.debug(f'Using Local Computer Time: {self.latest_scrape.get("timestamp")}')
del self.latest_scrape["year"]
del self.latest_scrape["month"]
del self.latest_scrape["day"]
del self.latest_scrape["hour"]
del self.latest_scrape["minute"]
del self.latest_scrape["second"]
else:
try:
self.latest_scrape["timestamp"] = "%s-%s-%s %s:%02d:%02d" % (
self.latest_scrape["year"],
self.latest_scrape["month"],
self.latest_scrape["day"],
self.latest_scrape["hour"],
self.latest_scrape["minute"],
self.latest_scrape["second"],
)
logging.debug(f'Using Inverter Time: {self.latest_scrape.get("timestamp")}')
del self.latest_scrape["year"]
del self.latest_scrape["month"]
del self.latest_scrape["day"]
del self.latest_scrape["hour"]
del self.latest_scrape["minute"]
del self.latest_scrape["second"]
except Exception:
pass
# If alarm state exists then convert to timestamp, otherwise remove it
try:
if self.latest_scrape["pid_alarm_code"]:
self.latest_scrape["alarm_timestamp"] = "%s-%s-%s %s:%02d:%02d" % (
self.latest_scrape["alarm_time_year"],
self.latest_scrape["alarm_time_month"],
self.latest_scrape["alarm_time_day"],
self.latest_scrape["alarm_time_hour"],
self.latest_scrape["alarm_time_minute"],
self.latest_scrape["alarm_time_second"],
)
del self.latest_scrape["alarm_time_year"]
del self.latest_scrape["alarm_time_month"]
del self.latest_scrape["alarm_time_day"]
del self.latest_scrape["alarm_time_hour"]
del self.latest_scrape["alarm_time_minute"]
del self.latest_scrape["alarm_time_second"]
except Exception:
pass
scrape_end = datetime.now()
logging.info(f'Inverter: Successfully scraped in {(scrape_end - scrape_start).seconds}.{(scrape_end - scrape_start).microseconds} secs')
return True
def main():
configfilename = 'config.yaml'
logfolder = ''
try:
opts, args = getopt.getopt(sys.argv[1:],"hc:l:v:", "runonce")
except getopt.GetoptError:
logging.debug(f'No options passed via command line')
for opt, arg in opts:
if opt == '-h':
print(f'\nSunGather {__version__}')
print(f'\nhttps://sungather.app')
print(f'usage: python3 sungather.py [options]')
print(f'\nCommandling arguments override any config file settings')
print(f'Options and arguments:')
print(f'-c config.yaml : Specify config file.')
print(f'-l /logs/ : Specify folder to store logs.')
print(f'-v 30 : Logging Level, 10 = Debug, 20 = Info, 30 = Warning (default), 40 = Error')
print(f'--runonce : Run once then exit')
print(f'-h : print this help message and exit (also --help)')
print(f'\nExample:')
print(f'python3 sungather.py -c /full/path/config.yaml\n')
sys.exit()
elif opt == '-c':
configfilename = arg
elif opt == '-l':
logfolder = arg
elif opt == '-v':
if arg.isnumeric():
if int(arg) >= 0 and int(arg) <= 50:
loglevel = int(arg)
else:
logging.error(f"Valid verbose options: 10 = Debug, 20 = Info, 30 = Warning (default), 40 = Error")
sys.exit(2)
else:
logging.error(f"Valid verbose options: 10 = Debug, 20 = Info, 30 = Warning (default), 40 = Error")
sys.exit(2)
elif opt == '--runonce':
runonce = True
logging.info(f'Starting SunGather {__version__}')
try:
configfile = yaml.safe_load(open(configfilename))
logging.info(f"Loaded config: {configfilename}")
except Exception as err:
logging.error(f"Failed: Loading config: {configfilename} \n\t\t\t {err}")
sys.exit(1)
if not configfile.get('inverter'):
logging.error(f"Failed Loading config, missing Inverter settings")
sys.exit(f"Failed Loading config, missing Inverter settings")
try:
registersfile = yaml.safe_load(open('registers.yaml'))
logging.info(f"Loaded registers: {os.getcwd()}/registers.yaml")
logging.info(f"Registers file version: {registersfile.get('version','UNKNOWN')}")
except Exception as err:
logging.error(f"Failed: Loading registers: {os.getcwd()}/registers.yaml {err}")
sys.exit(f"Failed: Loading registers: {os.getcwd()}/registers.yaml {err}")
config_inverter = {
"host": configfile['inverter'].get('host',None),
"port": configfile['inverter'].get('port',502),
"timeout": configfile['inverter'].get('timeout',10),
"retries": configfile['inverter'].get('retries',3),
"slave": configfile['inverter'].get('slave',0x01),
"scan_interval": configfile['inverter'].get('scan_interval',30),
"connection": configfile['inverter'].get('connection',"modbus"),
"model": configfile['inverter'].get('model',None),
"smart_meter": configfile['inverter'].get('smart_meter',False),
"use_local_time": configfile['inverter'].get('use_local_time',False),
"log_console": configfile['inverter'].get('log_console','WARNING'),
"log_file": configfile['inverter'].get('log_file','OFF'),
"level": configfile['inverter'].get('level',1)
}
if 'loglevel' in locals():
logger.handlers[0].setLevel(loglevel)
else:
logger.handlers[0].setLevel(config_inverter['log_console'])
if not config_inverter['log_file'] == "OFF":
if config_inverter['log_file'] == "DEBUG" or config_inverter['log_file'] == "INFO" or config_inverter['log_file'] == "WARNING" or config_inverter['log_file'] == "ERROR":
logfile = logfolder + "SunGather.log"
fh = logging.handlers.RotatingFileHandler(logfile, mode='w', encoding='utf-8', maxBytes=10485760, backupCount=10) # Log 10mb files, 10 x files = 100mb
fh.formatter = logger.handlers[0].formatter
fh.setLevel(config_inverter['log_file'])
logger.addHandler(fh)
else:
logging.warning(f"log_file: Valid options are: DEBUG, INFO, WARNING, ERROR and OFF")
logging.info(f"Logging to console set to: {logging.getLevelName(logger.handlers[0].level)}")
if logger.handlers.__len__() == 3:
logging.info(f"Logging to file set to: {logging.getLevelName(logger.handlers[2].level)}")
logging.debug(f'Inverter Config Loaded: {config_inverter}')
if config_inverter.get('host'):
inverter = SungrowInverter(config_inverter)
else:
logging.error(f"Error: host option in config is required")
sys.exit("Error: host option in config is required")
if not inverter.checkConnection():
logging.error(f"Error: Connection to inverter failed: {config_inverter.get('host')}:{config_inverter.get('port')}")
sys.exit(f"Error: Connection to inverter failed: {config_inverter.get('host')}:{config_inverter.get('port')}")
inverter.configure_registers(registersfile)
if not inverter.inverter_config['connection'] == "http": inverter.close()
# Now we know the inverter is working, lets load the exports
exports = []
if configfile.get('exports'):
for export in configfile.get('exports'):
try:
if export.get('enabled', False):
export_load = importlib.import_module("exports." + export.get('name'))
logging.info(f"Loading Export: exports\{export.get('name')}")
exports.append(getattr(export_load, "export_" + export.get('name'))())
retval = exports[-1].configure(export, inverter)
except Exception as err:
logging.error(f"Failed loading export: {err}" +
f"\n\t\t\t Please make sure {export.get('name')}.py exists in the exports folder")
scan_interval = config_inverter.get('scan_interval')
# Core polling loop
while True:
loop_start = datetime.now()
inverter.checkConnection()
# Scrape the inverter
success = inverter.scrape()
if(success):
for export in exports:
export.publish(inverter)
if not inverter.inverter_config['connection'] == "http": inverter.close()
else:
inverter.disconnect()
logging.warning(f"Data collection failed, skipped exporting data. Retying in {scan_interval} secs")
loop_end = datetime.now()
process_time = round(float(((loop_end - loop_start).seconds) + ((loop_end - loop_start).microseconds / 1000000)),2)
logging.debug(f'Processing Time: {process_time} secs')
if 'runonce' in locals():
sys.exit(0)
# Sleep until the next scan
if scan_interval - process_time <= 1:
logging.warning(f"SunGather is taking {process_time} to process, which is longer than interval {scan_interval}, Please increase scan interval")
time.sleep(process_time)
else:
logging.info(f'Next scrape in {int(scan_interval - process_time)} secs')
time.sleep(scan_interval - process_time)
logging.basicConfig(
format='%(asctime)s %(levelname)-8s %(message)s',
level=logging.DEBUG,
datefmt='%Y-%m-%d %H:%M:%S')
logger = logging.getLogger('')
ch = logging.StreamHandler()
ch.setLevel(logging.WARNING)
logger.addHandler(ch)
if __name__== "__main__":
main()
sys.exit()