Add support for Sungrow SH5k-20

README.md

@@ -9,7 +9,7 @@ Currently supported inverters include:
 * Sungrow SG5KTL (TCP and RS485)
 * Fronius (WiFi)
 * SolaX X1-5.0-T (WiFi)
-* TODO: Sungrow SH5K
+* Sungrow SH5K-20
 * TODO: SMA Sunny Boy
 
 Currently supported reporting methods include:

pvstats/pvinverter/factory.py

@@ -26,6 +26,7 @@
 from pvstats.pvinverter.fronius import PVInverter_Fronius
 from pvstats.pvinverter.solax import PVInverter_Solax
 from pvstats.pvinverter.sungrow_sg5ktl import PVInverter_SunGrow, PVInverter_SunGrowRTU
+from pvstats.pvinverter.sungrow_sh5k_20 import PVInverter_SunGrow_sh5k_20, PVInverter_SunGrow_sh5k_20RTU
 from pvstats.pvinverter.base import BasePVInverter
 
 from random import randint
@@ -52,6 +53,9 @@ def PVInverterFactory(model, cfg):
   elif (model == "sungrow-sg5ktl"):
     # Assume TCP
     return PVInverter_SunGrow(cfg)
+  elif (model == "sungrow-sh5k-20"):
+    # Assume TCP
+    return PVInverter_SunGrow_sh5k_20(cfg)
   elif (model == "fronius"):
     # Assume TCP
     return PVInverter_Fronius(cfg)

pvstats/pvinverter/sungrow_sh5k_20.py

@@ -0,0 +1,246 @@
+#!/usr/bin/env python
+
+# Copyright 2018 Paul Archer
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from pvstats.pvinverter.base import BasePVInverter
+
+from pymodbus.constants import Defaults
+from pymodbus.client.sync import ModbusTcpClient
+from pymodbus.client.sync import ModbusSerialClient
+from pymodbus.transaction import ModbusSocketFramer
+from pymodbus.exceptions import ModbusIOException
+from pymodbus.payload import BinaryPayloadDecoder
+from datetime import datetime
+from time import sleep
+
+import serial.rs485
+
+from decimal import *
+getcontext().prec = 9
+
+import logging
+_logger = logging.getLogger(__name__)
+
+_register_map = {
+  'input': {
+    5003:  {'name': 'daily_pv_power', 'scale': Decimal(100), 'units': 'W', 'type': 'uint16'},
+    5004:  {'name': 'lifetime_pv_power', 'scale': Decimal(1), 'units': 'kW', 'type': 'uint16'},
+    5006:  {'name': 'total_run_time', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    5008:  {'name': 'internal_temp', 'scale': Decimal('0.1'), 'units': 'C', 'type': 'uint16'},
+    5011:  {'name': 'pv1_voltage', 'scale': Decimal('0.1'), 'units': 'V', 'type': 'uint16'},
+    5012:  {'name': 'pv1_current', 'scale': Decimal('0.1'), 'units': 'A', 'type': 'uint16'},
+    5013:  {'name': 'pv2_voltage', 'scale': Decimal('0.1'), 'units': 'V', 'type': 'uint16'},
+    5014:  {'name': 'pv2_current', 'scale': Decimal('0.1'), 'units': 'A', 'type': 'uint16'},
+    5017:  {'name': 'total_pv_power', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    5019:  {'name': 'grid_voltage', 'scale': Decimal('0.1'), 'units': 'V', 'type': 'uint16'},
+    5022:  {'name': 'inverter_current', 'scale': Decimal('0.1'), 'units': 'A', 'type': 'uint16'},
+    5031:  {'name': 'inverter_ac_output', 'scale': Decimal(1), 'units': 'W', 'type': 'int16'}, # AKA "Active Power"?
+    5036:  {'name': 'grid_frequency', 'scale': Decimal('0.1'), 'units': 'Hz', 'type': 'uint16'},
+    13001: {'name': 'running_state', 'scale': Decimal('1'), 'units': '?', 'type': 'uint16'},
+    13002: {'name': 'daily_pv_energy_10', 'scale': Decimal('0.1'), 'units': 'Wh', 'type': 'uint16'},
+    13003: {'name': 'total_pv_energy_10', 'scale': Decimal('0.1'), 'units': 'Wh', 'type': 'uint16'},
+    13005: {'name': 'daily_export_energy_10', 'scale': Decimal('0.1'), 'units': 'Wh', 'type': 'uint16'},
+    13006: {'name': 'total_export_energy_10', 'scale': Decimal('0.1'), 'units': 'Wh', 'type': 'uint16'},
+    13008: {'name': 'load_power', 'scale': Decimal('1'), 'units': 'W', 'type': 'uint16'},
+    13010: {'name': 'export_power', 'scale': Decimal('1'), 'units': 'W', 'type': 'int16'},
+    13011: {'name': 'grid_import_or_export', 'scale': Decimal('1'), 'units': '?', 'type': 'int16'},
+    13012: {'name': 'daily_charge_energy_10', 'scale': Decimal('0.1'), 'units': 'Wh', 'type': 'uint16'},
+    13013: {'name': 'total_charge_energy_10', 'scale': Decimal('0.1'), 'units': 'Wh', 'type': 'uint16'},
+    13015: {'name': 'co2_emission_reduction', 'scale': Decimal('0.1'), 'units': 'Kg CO2', 'type': 'uint16'},
+    13017: {'name': 'daily_use_energy_10', 'scale': Decimal('0.1'), 'units': 'Wh', 'type': 'uint16'},
+    13018: {'name': 'total_use_energy_10', 'scale': Decimal('0.1'), 'units': 'Wh', 'type': 'uint16'},
+    13020: {'name': 'battery_voltage_10', 'scale': Decimal('0.1'), 'units': 'V', 'type': 'uint16'},
+    13021: {'name': 'battery_current_10', 'scale': Decimal('0.1'), 'units': 'A', 'type': 'uint16'},
+    13022: {'name': 'battery_power', 'scale': Decimal('1'), 'units': 'W', 'type': 'uint16'},
+    13023: {'name': 'battery_level_10', 'scale': Decimal('0.1'), 'units': '%', 'type': 'uint16'},
+    13024: {'name': 'battery_health_10', 'scale': Decimal('0.1'), 'units': '%', 'type': 'uint16'},
+    13025: {'name': 'battery_temp_10', 'scale': Decimal('0.1'), 'units': '°C', 'type': 'uint16'},
+    13026: {'name': 'daily_discharge_energy_10', 'scale': Decimal('0.1'), 'units': 'Wh', 'type': 'uint16'},
+    13027: {'name': 'total_discharge_energy_10', 'scale': Decimal('0.1'), 'units': 'Wh', 'type': 'uint16'},
+    13029: {'name': 'use_power', 'scale': Decimal('0.1'), 'units': 'W', 'type': 'uint16'},
+    13031: {'name': 'inverter_current_10', 'scale': Decimal('0.1'), 'units': 'A', 'type': 'uint16'},
+    13034: {'name': 'pv_power', 'scale': Decimal('0.1'), 'units': 'W', 'type': 'uint16'},
+    # TODO Work out what these mystery numbers are
+    5001:  {'name': 'mystery_5001', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    5033:  {'name': 'mystery_5033', 'scale': Decimal(1), 'units': 'W', 'type': 'int16'}, # Possibly -100% to 100% ?
+    5034:  {'name': 'mystery_5034', 'scale': Decimal(1), 'units': 'W', 'type': 'int16'}, # -1 to 0.
+    5035:  {'name': 'mystery_5035', 'scale': Decimal(1), 'units': 'W', 'type': 'int16'}, # -1000 to 1000. Possibly needs a 0.1 scale?
+    13030: {'name': 'mystery_13030', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'}, # Constant 85
+    13036: {'name': 'mystery_13036', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'}, # 0-15. Four-bit state? Possibly?
+    13037: {'name': 'mystery_13037', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'}, # Accumulates. Possibly total kWh consumed?
+    # These are always zero as far as I've seen
+    # 5000:  {'name': '5000', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5002:  {'name': '5002', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5005:  {'name': '5005', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5007:  {'name': '5007', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5009:  {'name': '5009', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5010:  {'name': '5010', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5015:  {'name': '5015', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5016:  {'name': '5016', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5018:  {'name': '5018', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5020:  {'name': '5020', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5021:  {'name': '5021', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5023:  {'name': '5023', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5024:  {'name': '5024', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5025:  {'name': '5025', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5026:  {'name': '5026', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5027:  {'name': '5027', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5028:  {'name': '5028', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5029:  {'name': '5029', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5030:  {'name': '5030', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5032:  {'name': '5032', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5037:  {'name': '5037', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5038:  {'name': '5038', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5039:  {'name': '5039', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5040:  {'name': '5040', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5041:  {'name': '5041', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5042:  {'name': '5042', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5043:  {'name': '5043', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5044:  {'name': '5044', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5045:  {'name': '5045', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5046:  {'name': '5046', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 5047:  {'name': '5047', 'scale': Decimal(1), 'units': 'W', 'type': 'uint16'},
+    # 13004: {'name': '13004', 'scale': Decimal('0.1'), 'units': 'Wh', 'type': 'uint16'},
+    # 13007: {'name': '13007', 'scale': Decimal('0.1'), 'units': 'Wh', 'type': 'uint16'},
+    # 13009: {'name': '13009', 'scale': Decimal('1'), 'units': 'W', 'type': 'uint16'},
+    # 13014: {'name': '13014', 'scale': Decimal('0.1'), 'units': 'Wh', 'type': 'uint16'},
+    # 13016: {'name': '13016', 'scale': Decimal('0.1'), 'units': 'Kg CO2', 'type': 'uint16'},
+    # 13019: {'name': '13019', 'scale': Decimal('0.1'), 'units': 'Wh', 'type': 'uint16'},
+    # 13028: {'name': '13028', 'scale': Decimal('0.1'), 'units': 'Wh', 'type': 'uint16'},
+    # 13032: {'name': '13032', 'scale': Decimal('0.1'), 'units': 'A', 'type': 'uint16'},
+    # 13033: {'name': '13033', 'scale': Decimal('0.1'), 'units': 'A', 'type': 'uint16'},
+    # 13035: {'name': '13035', 'scale': Decimal('0.1'), 'units': 'W', 'type': 'uint16'},
+    # 13038: {'name': '13038', 'scale': Decimal('0.1'), 'units': 'W', 'type': 'uint16'},
+  },
+
+  'holding': {
+    5000:  {'name': 'date_year', 'scale': 1, 'units': 'year', 'type': 'uint16'},
+    5001:  {'name': 'date_month', 'scale': 1, 'units': 'month', 'type': 'uint16'},
+    5002:  {'name': 'date_day', 'scale': 1, 'units': 'day', 'type': 'uint16'},
+    5003:  {'name': 'date_hour', 'scale': 1, 'units': 'hour', 'type': 'uint16'},
+    5004:  {'name': 'date_minute', 'scale': 1, 'units': 'minute', 'type': 'uint16'},
+    5005:  {'name': 'date_second', 'scale': 1, 'units': 'second', 'type': 'uint16'},
+  }
+}
+
+class PVInverter_SunGrow_sh5k_20(BasePVInverter):
+  def __init__(self, cfg, **kwargs):
+    super(PVInverter_SunGrow_sh5k_20, self).__init__()
+    self.cfg = cfg
+    self.init_modbus_client()
+
+  def init_modbus_client(self):
+    self.client = ModbusTcpClient(self.cfg['host'],          port=self.cfg['port'],
+                                  framer=ModbusSocketFramer, timeout=5,
+                                  RetryOnEmpty=True,         retries=5)
+
+  def connect(self):
+    self.client.connect()
+
+  def close(self):
+    self.client.close()
+
+  def read(self):
+    """Reads the PV inverters status"""
+
+    # Read holding and input registers in groups aligned on the 100
+    for func in _register_map:
+      start = -1
+      for k in sorted(_register_map[func].keys()):
+        group  = int(k) - int(k) % 100
+        if (start < group):
+          # Wait 500ms between modbus reads as per https://c.tjhowse.com/misc/SolarInfo%20Logger%20User%20Manual.pdf page 89
+          # This isn't enough though. Sometimes the modbus minion doesn't respond inside the (current) five second timeout.
+          sleep(0.5)
+          self._load_registers(func, group, 100)
+          start = group + 100
+
+    # Manually calculate the power and the timestamps
+    self.registers['pv1_power'] = round(self.registers['pv1_current'] * self.registers['pv1_voltage'])
+    self.registers['pv2_power'] = round(self.registers['pv2_current'] * self.registers['pv2_voltage'])
+    self.registers['timestamp'] = datetime(self.registers['date_year'],   self.registers['date_month'],
+                                           self.registers['date_day'],    self.registers['date_hour'],
+                                           self.registers['date_minute'], self.registers['date_second'])
+
+    floaty = {}
+    for key in self.registers.keys():
+      try:
+        floaty[key] = float(self.registers[key])
+      except:
+        floaty[key] = self.registers[key]
+    self.registers = floaty
+
+
+  def _load_registers(self,func,start,count=100):
+    try:
+      if func == 'input':
+        rq = self.client.read_input_registers(start, count, unit=0x01)
+      elif func == 'holding':
+        # Holding registers need an offset
+        start = start - 1
+        rq = self.client.read_holding_registers(start, count, unit=0x01)
+      else:
+        raise Exception("Unknown register type: {}".format(type))
+
+
+      if isinstance(rq, ModbusIOException):
+        _logger.error("Error: {}".format(rq))
+        self.init_modbus_client()
+        raise Exception("ModbusIOException")
+
+      for x in range(0, count):
+        key  = start + x + 1
+        val  = rq.registers[x]
+
+        if key in _register_map[func]:
+          reg = _register_map[func][key]
+          self.registers[reg['name']] = val * reg['scale']
+          if reg['type'] == 'int16' and self.registers[reg['name']] >= 2**15:
+            self.registers[reg['name']] -= 2**16
+
+
+
+    except Exception as err:
+      _logger.error("Error: %s" % err)
+      _logger.debug("{}, start: {}, count: {}".format(type, start, count))
+      raise
+
+class PVInverter_SunGrow_sh5k_20RTU(PVInverter_SunGrow_sh5k_20):
+  def __init__(self, cfg, **kwargs):
+    super(PVInverter_SunGrow_sh5k_20, self).__init__()
+
+    # Configure the Modbus Remote Terminal Unit settings
+    self.client = ModbusSerialClient(method='rtu', port=cfg['dev'], timeout=0.5,
+                                     stopbits = 1, bytesize =8, parity='N', baudrate=9600)
+
+  def connect(self):
+    # Connect then configure the port
+    self.client.connect()
+
+    # Configure the RS485 port - This seems not needed
+    #rs485_mode = serial.rs485.RS485Settings(delay_before_tx = 0, delay_before_rx = 0,
+    #                                        rts_level_for_tx=True, rts_level_for_rx=False,
+    #                                        loopback=False)
+    #self.client.socket.rs485_mode = rs485_mode
+
+
+#-----------------
+# Exported symbols
+#-----------------
+__all__ = [
+  "PVInverter_SunGrow_sh5k_20", "PVInverter_SunGrow_sh5k_20RTU"
+]
+
+# vim: set expandtab ts=2 sw=2: