foxesscloud 2.8.1__tar.gz → 2.8.2__tar.gz

{foxesscloud-2.8.1 → foxesscloud-2.8.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxesscloud
-Version: 2.8.1
+Version: 2.8.2
 Summary: library for accessing Fox ESS cloud data using Open API
 Author-email: Tony Matthews <tony@quasair.co.uk>
 Project-URL: Homepage, https://github.com/TonyM1958/FoxESS-Cloud
@@ -620,6 +620,17 @@ Plunge pricing allows for the automatic configuration of charging periods when A
 # PV Output
 These functions produce CSV data for upload to [pvoutput.org](https://pvoutput.org) including PV generation, Export, Load and Grid consumption by day in Wh. The functions use the energy estimates created from the raw power data (see above). The estimates include PV energy generation that are not otherwise available from the Fox Cloud. Typically, the energy results are within 3% of the values reported by the meters built into the inverter.
 
+## Calibration
+PV generation data is created using the Riemann sum of the PV power and CT2 power as the history of the stats provided by the Fox cloud can be unreliable. You can change the calibration factors used:
+
+```
+f.pv_calibration = 0.98
+f.ct2_calibration = 0.92
+```
+* pv_calibration is a DC calibration factor and is multiplied by the Riemann sum. The default calibration factor of 0.98 was derrived by comparing the total solar production calculated against the inverter generation data provided via Modbus over 12 months
+
+* ct2_calibration is an AC calibration factor and is the divisor for the Riemann sum. CT2 measures the AC power output by the inverter and this factor converts this back to the DC power coming from the solar panels into the inverter, assuming an MPPT efficiency of 95% and DC-AC conversion efficiency of 97%. This aligns the solar panel generation with PV power, allowing the total solar generation from both primary (connected to the hybrid inverter) and secondary (connected via a separate solar inverter) panels to be combined correctly.
+
 
 ## Get PV Output Data
 
@@ -809,6 +820,10 @@ This setting can be:
 
 # Version Info
 
+2.8.2<br>
+Fix forecast.solar (after change to start parameter processing).
+Change logic around battery status so 0 is offline and others values are online.
+
 2.8.1<br>
 Update from v0 to v1 for scheduler API.
 PVEnergyTotal added to report variables.

foxesscloud-2.8.1/src/foxesscloud.egg-info/PKG-INFO → foxesscloud-2.8.2/README.md

@@ -1,17 +1,3 @@
-Metadata-Version: 2.1
-Name: foxesscloud
-Version: 2.8.1
-Summary: library for accessing Fox ESS cloud data using Open API
-Author-email: Tony Matthews <tony@quasair.co.uk>
-Project-URL: Homepage, https://github.com/TonyM1958/FoxESS-Cloud
-Project-URL: Bug Tracker, https://github.com/TonyM1958/FoxESS-Cloud/issues
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENCE
-
 # FoxESS-Cloud
 
 <a href="https://www.buymeacoffee.com/tonym1958" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174" align="right"></a>
@@ -620,6 +606,17 @@ Plunge pricing allows for the automatic configuration of charging periods when A
 # PV Output
 These functions produce CSV data for upload to [pvoutput.org](https://pvoutput.org) including PV generation, Export, Load and Grid consumption by day in Wh. The functions use the energy estimates created from the raw power data (see above). The estimates include PV energy generation that are not otherwise available from the Fox Cloud. Typically, the energy results are within 3% of the values reported by the meters built into the inverter.
 
+## Calibration
+PV generation data is created using the Riemann sum of the PV power and CT2 power as the history of the stats provided by the Fox cloud can be unreliable. You can change the calibration factors used:
+
+```
+f.pv_calibration = 0.98
+f.ct2_calibration = 0.92
+```
+* pv_calibration is a DC calibration factor and is multiplied by the Riemann sum. The default calibration factor of 0.98 was derrived by comparing the total solar production calculated against the inverter generation data provided via Modbus over 12 months
+
+* ct2_calibration is an AC calibration factor and is the divisor for the Riemann sum. CT2 measures the AC power output by the inverter and this factor converts this back to the DC power coming from the solar panels into the inverter, assuming an MPPT efficiency of 95% and DC-AC conversion efficiency of 97%. This aligns the solar panel generation with PV power, allowing the total solar generation from both primary (connected to the hybrid inverter) and secondary (connected via a separate solar inverter) panels to be combined correctly.
+
 
 ## Get PV Output Data
 
@@ -809,6 +806,10 @@ This setting can be:
 
 # Version Info
 
+2.8.2<br>
+Fix forecast.solar (after change to start parameter processing).
+Change logic around battery status so 0 is offline and others values are online.
+
 2.8.1<br>
 Update from v0 to v1 for scheduler API.
 PVEnergyTotal added to report variables.

{foxesscloud-2.8.1 → foxesscloud-2.8.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "foxesscloud"
-version = "2.8.1"
+version = "2.8.2"
 authors = [
   {name="Tony Matthews", email="tony@quasair.co.uk"},
 ]

{foxesscloud-2.8.1 → foxesscloud-2.8.2}/src/foxesscloud/foxesscloud.py

@@ -1,7 +1,7 @@
 ##################################################################################################
 """
 Module:   Fox ESS Cloud
-Updated:  12 March 2025
+Updated:  09 April 2025
 By:       Tony Matthews
 """
 ##################################################################################################
@@ -10,7 +10,7 @@ By:       Tony Matthews
 # ALL RIGHTS ARE RESERVED © Tony Matthews 2023
 ##################################################################################################
 
-version = "1.9.3"
+version = "1.9.4"
 print(f"FoxESS-Cloud version {version}")
 
 debug_setting = 1
@@ -657,11 +657,10 @@ def get_battery(info=1, rated=None, count=None):
     battery['soh'] = None
     battery['soh_supported'] = False
     if battery.get('status') is None:
-        battery['status'] = 0 if battery.get('volt') is None or battery['volt'] <= 0 else 1
-    if battery.get('status') is None or battery['status'] != 1:
+        battery['status'] = 0 if battery.get('volt') is None or battery['volt'] <= 10 else 1
+    if battery.get('status') is None or battery['status'] == 0:
         output(f"** get_battery(): battery status not available")
         return None
-    battery['status'] = 1
     if battery.get('residual') is not None:
         battery['residual'] *= residual_scale / 10
     if battery['residual_handling'] == 2:
@@ -736,7 +735,7 @@ def get_batteries(info=1, rated=None, count=None):
     while len(count) < len(batteries):
         count.append(None)
     for i,b in enumerate(batteries):
-        if b.get('status') is None or b['status'] != 1:
+        if b.get('status') is None or b['status'] == 0:
             output(f"** get_batteries(): battery {i+1} status not available")
             continue
         b['residual_handling'] = residual_handling
@@ -755,7 +754,7 @@ def get_batteries(info=1, rated=None, count=None):
         b['soh'] = int(soh) if soh.isnumeric() and int(soh) > 10 else None
         b['soh_supported'] = b['soh'] is not None
     for i, b in enumerate(batteries):
-        if b.get('status') is None or b['status'] != 1:
+        if b.get('status') is None or b['status'] == 0:
             continue
         if i == 0:
             residual_handling = b['residual_handling']
@@ -973,6 +972,7 @@ merge_settings = {                  # keys to add
         'h116__': 'operation_mode__work_mode',
         'h117__': 'operation_mode__work_mode',
 #        'k106__': 'operation_mode__work_mode',
+#        'k110__': 'operation_mode__work_mode',
         },
         'values': ['SelfUse', 'Feedin', 'Backup']},
     'ExportLimit': {'keys': {
@@ -980,6 +980,7 @@ merge_settings = {                  # keys to add
         'h116__': 'basic2__05',
         'h117__': 'basic2__05',
 #        'k106__': 'basic2__05',
+#        'k1110__': 'basic2__05',
         },
         'valueType': 'int'},
     'BatteryVolt': {'keys': {
@@ -987,6 +988,7 @@ merge_settings = {                  # keys to add
         'h116__': ['h116__15', 'h116__16', 'h116__17'],
         'h117__': ['h117__15', 'h117__16', 'h117__17'],
 #        'k106__': ['k106__xx', 'k106__xx', 'k106__xx'],
+#        'k110__': ['k110__xx', 'k110__xx', 'k110__xx'],
         },
         'type': 'list',
         'valueType': 'float',
@@ -996,6 +998,7 @@ merge_settings = {                  # keys to add
         'h116__': 'h116__18',
         'h117__': 'h117__18',
 #        'k106__': 'k106__xx',
+#        'k110__': 'k110__xx',
         },
         'type': 'list',
         'valueType': 'int',
@@ -3089,7 +3092,7 @@ def charge_needed(forecast=None, consumption=None, update_settings=0, timed_mode
     else:
     # get device and battery info from inverter
         get_battery()
-        if battery is None or battery['status'] != 1:
+        if battery is None or battery['status'] == 0:
             return None
         current_soc = battery['soc']
         bat_volt = battery['volt']
@@ -4485,7 +4488,7 @@ class Solar :
                 if debug_setting > 0 and not quiet:
                     print(f"Getting data for {name} array")
                 path = f"{a['lat']}/{a['lon']}/{a['dec']}/{a['az']}/{a['kwp']}"
-                params = {'start': '00:00', 'no_sun': 1, 'damping': a['dam'], 'inverter': a['inv'], 'horizon': a['hor']}
+                params = {'no_sun': 1, 'damping': a['dam'], 'inverter': a['inv'], 'horizon': a['hor']}
                 response = requests.get(solar_url + self.api_key + 'estimate/' + path, params = params)
                 if response.status_code != 200:
                     if response.status_code == 429:

{foxesscloud-2.8.1 → foxesscloud-2.8.2}/src/foxesscloud/openapi.py

@@ -1,7 +1,7 @@
 ##################################################################################################
 """
 Module:   Fox ESS Cloud using Open API
-Updated:  12 March 2025
+Updated:  09 April 2025
 By:       Tony Matthews
 """
 ##################################################################################################
@@ -10,7 +10,7 @@ By:       Tony Matthews
 # ALL RIGHTS ARE RESERVED © Tony Matthews 2024
 ##################################################################################################
 
-version = "2.8.1"
+version = "2.8.2"
 print(f"FoxESS-Cloud Open API version {version}")
 
 debug_setting = 1
@@ -597,11 +597,10 @@ def get_battery(info=0, v=None, rated=None, count=None):
     battery['soh'] = None
     battery['soh_supported'] = False
     if battery.get('status') is None:
-        battery['status'] = 0 if battery.get('volt') is None or battery['volt'] <= 0 else 1
-    if battery['status'] != 1:
+        battery['status'] = 0 if battery.get('volt') is None or battery['volt'] <= 10 else 1
+    if battery['status'] == 0:
         output(f"** get_battery(): battery status not available")
         return None
-    battery['status'] = 1
     if battery['residual_handling'] == 2:
         capacity = battery.get('residual')
         soc = battery.get('soc')
@@ -628,7 +627,6 @@ def get_battery(info=0, v=None, rated=None, count=None):
             battery['ratedCapacity'] = rated
     battery['capacity'] = round(capacity, 3)
     battery['residual'] = round(residual, 3)
-    battery['status'] = 1
     battery['charge_rate'] = None
     params = battery_params[battery['residual_handling']]
     battery['charge_loss'] = params['charge_loss']
@@ -2756,7 +2754,7 @@ def charge_needed(forecast=None, consumption=None, update_settings=0, timed_mode
     else:
     # get device and battery info from inverter
         get_battery()
-        if battery is None or battery['status'] != 1:
+        if battery is None or battery['status'] == 0:
             return None
         current_soc = battery['soc']
         bat_volt = battery['volt']
@@ -4153,7 +4151,7 @@ class Solar :
                 if debug_setting > 0 and not quiet:
                     print(f"Getting data for {name} array")
                 path = f"{a['lat']}/{a['lon']}/{a['dec']}/{a['az']}/{a['kwp']}"
-                params = {'start': '00:00', 'no_sun': 1, 'damping': a['dam'], 'inverter': a['inv'], 'horizon': a['hor']}
+                params = {'no_sun': 1, 'damping': a['dam'], 'inverter': a['inv'], 'horizon': a['hor']}
                 response = requests.get(solar_url + self.api_key + 'estimate/' + path, params = params)
                 if response.status_code != 200:
                     if response.status_code == 429:

foxesscloud-2.8.1/README.md → foxesscloud-2.8.2/src/foxesscloud.egg-info/PKG-INFO

@@ -1,3 +1,17 @@
+Metadata-Version: 2.1
+Name: foxesscloud
+Version: 2.8.2
+Summary: library for accessing Fox ESS cloud data using Open API
+Author-email: Tony Matthews <tony@quasair.co.uk>
+Project-URL: Homepage, https://github.com/TonyM1958/FoxESS-Cloud
+Project-URL: Bug Tracker, https://github.com/TonyM1958/FoxESS-Cloud/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENCE
+
 # FoxESS-Cloud
 
 <a href="https://www.buymeacoffee.com/tonym1958" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174" align="right"></a>
@@ -606,6 +620,17 @@ Plunge pricing allows for the automatic configuration of charging periods when A
 # PV Output
 These functions produce CSV data for upload to [pvoutput.org](https://pvoutput.org) including PV generation, Export, Load and Grid consumption by day in Wh. The functions use the energy estimates created from the raw power data (see above). The estimates include PV energy generation that are not otherwise available from the Fox Cloud. Typically, the energy results are within 3% of the values reported by the meters built into the inverter.
 
+## Calibration
+PV generation data is created using the Riemann sum of the PV power and CT2 power as the history of the stats provided by the Fox cloud can be unreliable. You can change the calibration factors used:
+
+```
+f.pv_calibration = 0.98
+f.ct2_calibration = 0.92
+```
+* pv_calibration is a DC calibration factor and is multiplied by the Riemann sum. The default calibration factor of 0.98 was derrived by comparing the total solar production calculated against the inverter generation data provided via Modbus over 12 months
+
+* ct2_calibration is an AC calibration factor and is the divisor for the Riemann sum. CT2 measures the AC power output by the inverter and this factor converts this back to the DC power coming from the solar panels into the inverter, assuming an MPPT efficiency of 95% and DC-AC conversion efficiency of 97%. This aligns the solar panel generation with PV power, allowing the total solar generation from both primary (connected to the hybrid inverter) and secondary (connected via a separate solar inverter) panels to be combined correctly.
+
 
 ## Get PV Output Data
 
@@ -795,6 +820,10 @@ This setting can be:
 
 # Version Info
 
+2.8.2<br>
+Fix forecast.solar (after change to start parameter processing).
+Change logic around battery status so 0 is offline and others values are online.
+
 2.8.1<br>
 Update from v0 to v1 for scheduler API.
 PVEnergyTotal added to report variables.