foxesscloud 2.7.6__tar.gz → 2.7.7__tar.gz

{foxesscloud-2.7.6 → foxesscloud-2.7.7}/LICENCE

@@ -1,4 +1,4 @@
-Copyright (c) 2023 Tony Matthews
+Copyright (c) 2023-2025 Tony Matthews
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{foxesscloud-2.7.6/src/foxesscloud.egg-info → foxesscloud-2.7.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxesscloud
-Version: 2.7.6
+Version: 2.7.7
 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
@@ -629,7 +629,7 @@ f.get_pvoutput(d, tou)
 ```
 
 + d is the date or a list of dates, to get data for. The default is yesterday.
-+ tou: optional, setting tou=1 uploads data with time of use. The default, tou=0 does not split data and is more accurate.
++ tou: the default, tou=0, does not split data and is more accurate. Setting tou=1 uploads data with time of use. Setting tou=2 integrates all values and allows set_pvoutput() to work with pv inverters that do not provide energy stats.
 + setting integrate_load_power to 1 will calculate load energy by integrating the load power instead of using data from Fox. This tries to overcome the limitation where the inverter does not track load power / energy correctly when there is secondary generation. When set to 0 (default), the  Fox load energy is used.
 
 You can copy and paste the output data to the pvoutput data CSV Loader, using the following settings:
@@ -652,7 +652,7 @@ f.set_pvoutput(d, system_id, tou, push, run_after)
 
 + d is optional and is the date, or a list of dates, to upload
 + system_id is optional and allow you to select where data is uploaded to (where you have more than 1 registered system)
-+ tou: optional, setting tou=1 uploads data with time of use. The default, tou=0 does not split data and is more accurate
++ tou: the default, tou=0, does not split data and is more accurate. Setting tou=1 uploads data with time of use. Setting tou=2 integrates all values and allows set_pvoutput() to work with pv inverters that do not provide energy stats.
 + push: optional. 0 = do not sent to pushover, 1 = send summary to pushover, 2 = send first day summary only
 + run_after: optional. Only generate data on or after this hour. Default 0.
 
@@ -807,6 +807,10 @@ This setting can be:
 
 # Version Info
 
+2.7.7<br>
+Updates to get_pvoutput() to support solar inverters that don't provide grid energy by setting tou=2.
+Default tariff changed to None.
+
 2.7.6<br>
 Updates to support F, G, R and S series inverters.
 Updates to set_named_settings() to load metadata if not already done and save new value.

{foxesscloud-2.7.6 → foxesscloud-2.7.7}/README.md

@@ -615,7 +615,7 @@ f.get_pvoutput(d, tou)
 ```
 
 + d is the date or a list of dates, to get data for. The default is yesterday.
-+ tou: optional, setting tou=1 uploads data with time of use. The default, tou=0 does not split data and is more accurate.
++ tou: the default, tou=0, does not split data and is more accurate. Setting tou=1 uploads data with time of use. Setting tou=2 integrates all values and allows set_pvoutput() to work with pv inverters that do not provide energy stats.
 + setting integrate_load_power to 1 will calculate load energy by integrating the load power instead of using data from Fox. This tries to overcome the limitation where the inverter does not track load power / energy correctly when there is secondary generation. When set to 0 (default), the  Fox load energy is used.
 
 You can copy and paste the output data to the pvoutput data CSV Loader, using the following settings:
@@ -638,7 +638,7 @@ f.set_pvoutput(d, system_id, tou, push, run_after)
 
 + d is optional and is the date, or a list of dates, to upload
 + system_id is optional and allow you to select where data is uploaded to (where you have more than 1 registered system)
-+ tou: optional, setting tou=1 uploads data with time of use. The default, tou=0 does not split data and is more accurate
++ tou: the default, tou=0, does not split data and is more accurate. Setting tou=1 uploads data with time of use. Setting tou=2 integrates all values and allows set_pvoutput() to work with pv inverters that do not provide energy stats.
 + push: optional. 0 = do not sent to pushover, 1 = send summary to pushover, 2 = send first day summary only
 + run_after: optional. Only generate data on or after this hour. Default 0.
 
@@ -793,6 +793,10 @@ This setting can be:
 
 # Version Info
 
+2.7.7<br>
+Updates to get_pvoutput() to support solar inverters that don't provide grid energy by setting tou=2.
+Default tariff changed to None.
+
 2.7.6<br>
 Updates to support F, G, R and S series inverters.
 Updates to set_named_settings() to load metadata if not already done and save new value.

{foxesscloud-2.7.6 → foxesscloud-2.7.7}/pyproject.toml

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

{foxesscloud-2.7.6 → foxesscloud-2.7.7}/src/foxesscloud/foxesscloud.py

@@ -1,7 +1,7 @@
 ##################################################################################################
 """
 Module:   Fox ESS Cloud
-Updated:  13 December 2024
+Updated:  11 January 2025
 By:       Tony Matthews
 """
 ##################################################################################################
@@ -10,7 +10,7 @@ By:       Tony Matthews
 # ALL RIGHTS ARE RESERVED © Tony Matthews 2023
 ##################################################################################################
 
-version = "1.8.7"
+version = "1.8.8"
 print(f"FoxESS-Cloud version {version}")
 
 debug_setting = 1
@@ -2380,7 +2380,7 @@ custom_periods = {'name': 'Custom',
     }
 
 tariff_list = [octopus_flux, intelligent_octopus, octopus_cosy, octopus_go, agile_octopus, bg_driver, eon_drive, economy_7, custom_periods]
-tariff = octopus_flux
+tariff = None
 
 ##################################################################################################
 # Strategy - schedule templates
@@ -3857,18 +3857,19 @@ integrate_load_power = 0
 ##################################################################################################
 
 # get pvoutput data for upload to pvoutput api or via Bulk Loader
-# tou: 0 = no time of use, 1 = use time of use periods if available
+# tou: 0 = no time of use, 1 = use time of use periods if available, 2 = integrate all values
 
 def get_pvoutput(d = None, tou = 0):
     global tariff, pv_calibration, ct2_calibration, integrate_load_power
     if d is None:
         d = date_list()[0]
-    tou = 0 if tariff is None else 1 if tou == 1 or tou == True else 0
     if type(d) is list:
         print(f"---------------- get_pvoutput ------------------")
         print(f"Date range {d[0]} to {d[-1]} has {len(d)} days")
         if tou == 1:
             print(f"Time of use: {tariff['name']}")
+        elif tou == 2:
+            print(f"All values integrated from power")
         if integrate_load_power == 1:
             print(f"Consumption integrated from Load Power")
         print(f"------------------------------------------------")
@@ -3882,12 +3883,15 @@ def get_pvoutput(d = None, tou = 0):
     v = ['feedin', 'gridConsumption']
     if integrate_load_power == 0:
         v.append('loads')
-    report_data = get_report('day', d=d, v=v, summary=2)
-    if report_data is None:
-        return None
+    if tou == 2:
+        report_data = []
+    else:
+        report_data = get_report('day', d=d, v=v, summary=2)
+        if report_data is None:
+            return None
     # get raw power data for the day
-    v = ['pvPower', 'meterPower2', 'feedinPower', 'gridConsumptionPower'] if tou == 1 else ['pvPower', 'meterPower2']
-    if integrate_load_power == 1:
+    v = ['pvPower', 'meterPower2', 'feedinPower', 'gridConsumptionPower'] if tou > 0 else ['pvPower', 'meterPower2']
+    if integrate_load_power == 1 or tou == 2:
         v.append('loadsPower')
     raw_data = get_raw('day', d=d + ' 00:00:00', v=v , summary=1)
     if raw_data is None or len(raw_data) == 0 or raw_data[0].get('kwh') is None or raw_data[0].get('max') is None:
@@ -3937,10 +3941,12 @@ def get_pvoutput(d = None, tou = 0):
             generate = f"{wh},"
             power = f"{int(var['max'] * 1000)},{var['max_time']},"
         elif var['variable'] == 'feedinPower':
+            export_wh = wh if tou == 2 else export_wh
             calibrate = export_wh / wh if wh > 0.0 else 1.0
             export = f","
             export_tou = f"{int(peak * calibrate)},{int(off_peak * calibrate)},{int((wh - peak - off_peak) * calibrate)},0"
         elif var['variable'] == 'gridConsumptionPower':
+            grid_wh = wh if tou == 2 else grid_wh
             calibrate = grid_wh / wh if wh > 0.0 else 1.0
             grid = f"{int(peak * calibrate)},{int(off_peak * calibrate)},{int((wh - peak - off_peak) * calibrate)},0,"
         elif var['variable'] == 'loadsPower':

{foxesscloud-2.7.6 → foxesscloud-2.7.7}/src/foxesscloud/openapi.py

@@ -1,7 +1,7 @@
 ##################################################################################################
 """
 Module:   Fox ESS Cloud using Open API
-Updated:  13 December 2024
+Updated:  11 January 2025
 By:       Tony Matthews
 """
 ##################################################################################################
@@ -10,7 +10,7 @@ By:       Tony Matthews
 # ALL RIGHTS ARE RESERVED © Tony Matthews 2024
 ##################################################################################################
 
-version = "2.7.6"
+version = "2.7.7"
 print(f"FoxESS-Cloud Open API version {version}")
 
 debug_setting = 1
@@ -2052,7 +2052,7 @@ custom_periods = {'name': 'Custom',
     }
 
 tariff_list = [octopus_flux, intelligent_octopus, octopus_cosy, octopus_go, agile_octopus, bg_driver, eon_drive, economy_7, custom_periods]
-tariff = octopus_flux
+tariff = None
 
 ##################################################################################################
 # Strategy - schedule templates
@@ -3529,18 +3529,19 @@ integrate_load_power = 0
 ##################################################################################################
 
 # get pvoutput data for upload to pvoutput api or via Bulk Loader
-# tou: 0 = no time of use, 1 = use time of use periods if available
+# tou: 0 = no time of use, 1 = use time of use periods if available, 2 = integrate all values
 
 def get_pvoutput(d = None, tou = 0):
     global tariff, pv_calibration, ct2_calibration, integrate_load_power
     if d is None:
         d = date_list()[0]
-    tou = 0 if tariff is None else 1 if tou == 1 or tou == True else 0
     if type(d) is list:
         print(f"---------------- get_pvoutput ------------------")
         print(f"Date range {d[0]} to {d[-1]} has {len(d)} days")
         if tou == 1:
             print(f"Time of use: {tariff['name']}")
+        elif tou == 2:
+            print(f"All values integrated from power")
         if integrate_load_power == 1:
             print(f"Consumption integrated from Load Power")
         print(f"------------------------------------------------")
@@ -3554,12 +3555,15 @@ def get_pvoutput(d = None, tou = 0):
     v = ['feedin', 'gridConsumption']
     if integrate_load_power == 0:
         v.append('loads')
-    report_data = get_report('day', d=d, v=v, summary=2)
-    if report_data is None:
-        return None
+    if tou == 2:
+        report_data = []
+    else:
+        report_data = get_report('day', d=d, v=v, summary=2)
+        if report_data is None:
+            return None
     # get raw power data for the day
-    v = ['pvPower', 'meterPower2', 'feedinPower', 'gridConsumptionPower'] if tou == 1 else ['pvPower', 'meterPower2']
-    if integrate_load_power == 1:
+    v = ['pvPower', 'meterPower2', 'feedinPower', 'gridConsumptionPower'] if tou > 0 else ['pvPower', 'meterPower2']
+    if integrate_load_power == 1 or tou == 2:
         v.append('loadsPower')
     raw_data = get_raw('day', d=d + ' 00:00:00', v=v , summary=1)
     if raw_data is None or len(raw_data) == 0 or raw_data[0].get('kwh') is None or raw_data[0].get('max') is None:
@@ -3609,10 +3613,12 @@ def get_pvoutput(d = None, tou = 0):
             generate = f"{wh},"
             power = f"{int(var['max'] * 1000)},{var['max_time']},"
         elif var['variable'] == 'feedinPower':
+            export_wh = wh if tou == 2 else export_wh
             calibrate = export_wh / wh if wh > 0.0 else 1.0
             export = f","
             export_tou = f"{int(peak * calibrate)},{int(off_peak * calibrate)},{int((wh - peak - off_peak) * calibrate)},0"
         elif var['variable'] == 'gridConsumptionPower':
+            grid_wh = wh if tou == 2 else grid_wh
             calibrate = grid_wh / wh if wh > 0.0 else 1.0
             grid = f"{int(peak * calibrate)},{int(off_peak * calibrate)},{int((wh - peak - off_peak) * calibrate)},0,"
         elif var['variable'] == 'loadsPower':

{foxesscloud-2.7.6 → foxesscloud-2.7.7/src/foxesscloud.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxesscloud
-Version: 2.7.6
+Version: 2.7.7
 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
@@ -629,7 +629,7 @@ f.get_pvoutput(d, tou)
 ```
 
 + d is the date or a list of dates, to get data for. The default is yesterday.
-+ tou: optional, setting tou=1 uploads data with time of use. The default, tou=0 does not split data and is more accurate.
++ tou: the default, tou=0, does not split data and is more accurate. Setting tou=1 uploads data with time of use. Setting tou=2 integrates all values and allows set_pvoutput() to work with pv inverters that do not provide energy stats.
 + setting integrate_load_power to 1 will calculate load energy by integrating the load power instead of using data from Fox. This tries to overcome the limitation where the inverter does not track load power / energy correctly when there is secondary generation. When set to 0 (default), the  Fox load energy is used.
 
 You can copy and paste the output data to the pvoutput data CSV Loader, using the following settings:
@@ -652,7 +652,7 @@ f.set_pvoutput(d, system_id, tou, push, run_after)
 
 + d is optional and is the date, or a list of dates, to upload
 + system_id is optional and allow you to select where data is uploaded to (where you have more than 1 registered system)
-+ tou: optional, setting tou=1 uploads data with time of use. The default, tou=0 does not split data and is more accurate
++ tou: the default, tou=0, does not split data and is more accurate. Setting tou=1 uploads data with time of use. Setting tou=2 integrates all values and allows set_pvoutput() to work with pv inverters that do not provide energy stats.
 + push: optional. 0 = do not sent to pushover, 1 = send summary to pushover, 2 = send first day summary only
 + run_after: optional. Only generate data on or after this hour. Default 0.
 
@@ -807,6 +807,10 @@ This setting can be:
 
 # Version Info
 
+2.7.7<br>
+Updates to get_pvoutput() to support solar inverters that don't provide grid energy by setting tou=2.
+Default tariff changed to None.
+
 2.7.6<br>
 Updates to support F, G, R and S series inverters.
 Updates to set_named_settings() to load metadata if not already done and save new value.