foxesscloud 2.8.7__py3-none-any.whl → 2.8.8__py3-none-any.whl

foxesscloud/foxesscloud.py

@@ -1,7 +1,7 @@
 ##################################################################################################
 """
 Module:   Fox ESS Cloud
-Updated:  15 September 2025
+Updated:  2 October 2025
 By:       Tony Matthews
 """
 ##################################################################################################
@@ -10,7 +10,7 @@ By:       Tony Matthews
 # ALL RIGHTS ARE RESERVED © Tony Matthews 2023
 ##################################################################################################
 
-version = "1.9.7"
+version = "1.9.8"
 print(f"FoxESS-Cloud version {version}")
 
 debug_setting = 1
@@ -912,14 +912,14 @@ def get_min():
         output(f"** get_min(), no result data, {errno_message(errno)}")
         return None
     battery_settings['minSoc'] = result.get('minSoc')
-    battery_settings['minGridSoc'] = result.get('minGridSoc')
+    battery_settings['minSocOnGrid'] = result.get('minGridSoc')
     return battery_settings
 
 ##################################################################################################
 # set min soc from battery_settings or parameters
 ##################################################################################################
 
-def set_min(minGridSoc = None, minSoc = None, force = 0):
+def set_min(minSocOnGrid = None, minSoc = None, force = 0):
     global device_sn, battery_settings, debug_setting, messages
     if get_device() is None:
         return None
@@ -928,16 +928,24 @@ def set_min(minGridSoc = None, minSoc = None, force = 0):
             output(f"** set_min(): cannot set min SoC mode when a schedule is enabled")
             return None
         set_schedule(enable=0)
-    data = {'sn': device_sn}
     if battery_settings is None:
         battery_settings = {}
-    if minGridSoc is not None:
-        data['minGridSoc'] = minGridSoc
-        battery_settings['minGridSoc'] = minGridSoc
+    if minSocOnGrid is not None:
+        if minSocOnGrid < 0 or minSocOnGrid > 100:
+            output(f"** set_min(): invalid minSocOnGrid = {minSocOnGrid}. Must be between 0 and 100")
+            return None
+        battery_settings['minSocOnGrid'] = minSocOnGrid
     if minSoc is not None:
-        data['minSoc'] = minSoc
+        if minSoc < 0 or minSoc > 100:
+            output(f"** set_min(): invalid minSoc = {minSoc}. Must be between 0 and 100")
+            return None
         battery_settings['minSoc'] = minSoc
-    output(f"\nSetting minSoc = {battery_settings.get('minSoc')}, minGridSoc = {battery_settings.get('minGridSoc')}", 1)
+    data = {'sn': device_sn}
+    if battery_settings.get('minSocOnGrid') is not None:
+        data['minGridSoc'] = battery_settings['minSocOnGrid']
+    if battery_settings.get('minSoc') is not None:
+        data['minSoc'] = battery_settings['minSoc']
+    output(f"\nSetting minSocOnGrid = {battery_settings.get('minSocOnGrid')}, minSoc = {battery_settings.get('minSoc')}", 1)
     setting_delay()
     response = signed_post(path="/c/v0/device/battery/soc/set", data=data)
     if response.status_code != 200:

foxesscloud/openapi.py

@@ -1,7 +1,7 @@
 ##################################################################################################
 """
 Module:   Fox ESS Cloud using Open API
-Updated:  15 September 2025
+Updated:  2 October 2025
 By:       Tony Matthews
 """
 ##################################################################################################
@@ -10,7 +10,7 @@ By:       Tony Matthews
 # ALL RIGHTS ARE RESERVED © Tony Matthews 2024
 ##################################################################################################
 
-version = "2.8.7"
+version = "2.8.8"
 print(f"FoxESS-Cloud Open API version {version}")
 
 debug_setting = 1
@@ -823,13 +823,13 @@ def set_min(minSocOnGrid = None, minSoc = None, force = 0):
     if battery_settings is None:
         battery_settings = {}
     if minSocOnGrid is not None:
-        if minSocOnGrid < 10 or minSocOnGrid > 100:
-            output(f"** set_min(): invalid minSocOnGrid = {minSocOnGrid}. Must be between 10 and 100")
+        if minSocOnGrid < 0 or minSocOnGrid > 100:
+            output(f"** set_min(): invalid minSocOnGrid = {minSocOnGrid}. Must be between 0 and 100")
             return None
         battery_settings['minSocOnGrid'] = minSocOnGrid
     if minSoc is not None:
-        if minSoc < 10 or minSoc > 100:
-            output(f"** set_min(): invalid minSoc = {minSoc}. Must be between 10 and 100")
+        if minSoc < 0 or minSoc > 100:
+            output(f"** set_min(): invalid minSoc = {minSoc}. Must be between 0 and 100")
             return None
         battery_settings['minSoc'] = minSoc
     body = {'sn': device_sn}
@@ -837,7 +837,7 @@ def set_min(minSocOnGrid = None, minSoc = None, force = 0):
         body['minSocOnGrid'] = battery_settings['minSocOnGrid']
     if battery_settings.get('minSoc') is not None:
         body['minSoc'] = battery_settings['minSoc']
-    output(f"\nSetting minSoc = {battery_settings.get('minSoc')}, minSocOnGrid = {battery_settings.get('minSocOnGrid')}", 1)
+    output(f"\nSetting minSocOnGrid = {battery_settings.get('minSocOnGrid')}, minSoc = {battery_settings.get('minSoc')}", 1)
     setting_delay()
     response = signed_post(path="/op/v0/device/battery/soc/set", body=body)
     if response.status_code != 200:
@@ -1665,6 +1665,10 @@ def get_report(dimension='day', d=None, v=None, summary=1, save=None, load=None,
         if errno > 0 or result is None or len(result) == 0:
             output(f"** get_report(), no report data available, {errno_message(response)}")
             return None
+        # correct variables in year report (AP 19/09/2025):
+        if dimension == 'year':
+            for i, var in enumerate(result):
+                var['variable'] = v[i]
         # correct errors in report values:
         if fix_values == 1:
             for var in result:

{foxesscloud-2.8.7.dist-info → foxesscloud-2.8.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxesscloud
-Version: 2.8.7
+Version: 2.8.8
 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
@@ -163,6 +163,7 @@ f.set_named_settings(name, value, force)
 set_min() applies new SoC settings to the inverter. The parameters update battery_settings:
 + minSocOnGrid: min Soc on Grid setting e.g. 15 = 15%
 + minSoc: min Soc setting e.g. 10 = 10%
++ force: setting to 1 will disable Mode Scheduler, if enabled. Default is 0.
 
 set_charge() takes the charge times from the battery_settings and applies these to the inverter. The parameters are optional and will update battery_settings. You should specify all 3 parameter for a time period:
 + ch1: enable charge from grid for period 1 (default True)
@@ -191,7 +192,7 @@ set_schedule() configures a list of scheduled work mode / soc changes with enabl
 
 set_named_settings() sets the 'name' setting to 'value'.
 + 'name' may also be a list of (name, value) pairs.
-+ 'force': setting to 1 will disable Mode Scheduler, if enabled. Default is 0.
++ force: setting to 1 will disable Mode Scheduler, if enabled. Default is 0.
 + a return value of 1 is success. 0 means setting failed. None is another error e.g. device not found, invalid name or value.
 + named_settings currently supported include: ExportLimit, MinSoc, MinSocOnGrid, MaxSoc, GridCode, WorkMode
 
@@ -820,6 +821,11 @@ This setting can be:
 
 # Version Info
 
+2.8.8<br>
+Fix problem where Open API returns conflicting variable names when reporting stats by year.
+Update daily template for Saturn Cloud to new YAML format.
+Update set_min() to accept 0 instead of 10.
+
 2.8.7<br>
 Added f.get_signal().
 Updated set_period so you don't have to call get_schedule before.

foxesscloud-2.8.8.dist-info/RECORD

@@ -0,0 +1,7 @@
+foxesscloud/foxesscloud.py,sha256=vd3nBwhrqxkRmKMRa6iOXOiFq8Eg4czmv9_NNghiSq0,225903
+foxesscloud/openapi.py,sha256=pgn4e_bVjTr_IWjHoeNFWM1GI3vlpD9dOOCkmpy4Yqg,211084
+foxesscloud-2.8.8.dist-info/LICENCE,sha256=8JF-24QkE8UfdII-g6RaIEvM-PZ9zwaEcxlwYUDMt-4,1079
+foxesscloud-2.8.8.dist-info/METADATA,sha256=zPZSZtAiAyBJPfe93ZsOVTWSFVrIYOYlvkw4Icxil4Y,66133
+foxesscloud-2.8.8.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+foxesscloud-2.8.8.dist-info/top_level.txt,sha256=IWOrKSNZCLU6IDXSX_b4_bqCfbZoWAT4CC0w0Lg7PuU,12
+foxesscloud-2.8.8.dist-info/RECORD,,

foxesscloud-2.8.7.dist-info/RECORD

@@ -1,7 +0,0 @@
-foxesscloud/foxesscloud.py,sha256=fUB4O3p4UvnHAU2YMzUYh5eunMYjqJu9FpIfE9mPtVE,225412
-foxesscloud/openapi.py,sha256=ZpVcrpMU11FI8oAQlrbhoXCiFGP-ooD6me7D37CbkkE,210915
-foxesscloud-2.8.7.dist-info/LICENCE,sha256=8JF-24QkE8UfdII-g6RaIEvM-PZ9zwaEcxlwYUDMt-4,1079
-foxesscloud-2.8.7.dist-info/METADATA,sha256=XqyaBg9PXtXn82IkUJmvRQ59GFOCgUKUyqtxfvfr1xk,65846
-foxesscloud-2.8.7.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-foxesscloud-2.8.7.dist-info/top_level.txt,sha256=IWOrKSNZCLU6IDXSX_b4_bqCfbZoWAT4CC0w0Lg7PuU,12
-foxesscloud-2.8.7.dist-info/RECORD,,