foxesscloud 2.8.2__tar.gz → 2.8.3__tar.gz

{foxesscloud-2.8.2/src/foxesscloud.egg-info → foxesscloud-2.8.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxesscloud
-Version: 2.8.2
+Version: 2.8.3
 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
@@ -132,13 +132,14 @@ Additional battery attributes provided include:
 
 get_settings() will return the battery settings and is equivalent to get_charge() and get_min(). The results are stored in f.battery_settings. The settings include minSoc, minSocOnGrid, enable charge from grid and the charge times.
 
-get_flag() returns the current scheduler enable / support / maxsoc flags
+get_flag() returns the current scheduler enable / support / maxsoc flags. By default support for Max Soc is set to False.
 
 get_schedule() returns the current work mode / soc schedule settings. The result is stored in f.schedule.
++ if the schedule returned contains any values for 'maxSoc', the f.schedule['maxsoc'] is set to True to indicate that the current inverter supports setting Max Soc in schedules and Max Soc values are set by set_schedule().
 
 get_named_settings() returns the value of a named setting. If 'name' is a list, it returns a list of values.
-+ f.named_settings is updated. This is dictionary of information and current value, indexed by 'name.
-+ the only name currently supported by Fox is 'ExportLimit' and this is only available for H3 inverters.
++ f.named_settings is updated. This is dictionary of information and current value, indexed by 'name'.
++ named_settings current supported include: ExportLimit, MinSoc, MinSocOnGrid, MaxSoc, GridCode
 
 
 ## Inverter Settings
@@ -194,8 +195,8 @@ 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.
-+ A return value of 1 is success. 0 means setting failed. None is another error e.g. device not found, invalid name or value.
-+ the only 'name' currently supported is 'ExportLimit'
++ 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 current supported include: ExportLimit, MinSoc, MinSocOnGrid, MaxSoc, GridCode
 
 
 ## Real Time Data
@@ -820,6 +821,9 @@ This setting can be:
 
 # Version Info
 
+2.8.3<br>
+Update to support setting Max Soc in schedules now this is supported by Fox using Open API.
+
 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.

{foxesscloud-2.8.2 → foxesscloud-2.8.3}/README.md

@@ -118,13 +118,14 @@ Additional battery attributes provided include:
 
 get_settings() will return the battery settings and is equivalent to get_charge() and get_min(). The results are stored in f.battery_settings. The settings include minSoc, minSocOnGrid, enable charge from grid and the charge times.
 
-get_flag() returns the current scheduler enable / support / maxsoc flags
+get_flag() returns the current scheduler enable / support / maxsoc flags. By default support for Max Soc is set to False.
 
 get_schedule() returns the current work mode / soc schedule settings. The result is stored in f.schedule.
++ if the schedule returned contains any values for 'maxSoc', the f.schedule['maxsoc'] is set to True to indicate that the current inverter supports setting Max Soc in schedules and Max Soc values are set by set_schedule().
 
 get_named_settings() returns the value of a named setting. If 'name' is a list, it returns a list of values.
-+ f.named_settings is updated. This is dictionary of information and current value, indexed by 'name.
-+ the only name currently supported by Fox is 'ExportLimit' and this is only available for H3 inverters.
++ f.named_settings is updated. This is dictionary of information and current value, indexed by 'name'.
++ named_settings current supported include: ExportLimit, MinSoc, MinSocOnGrid, MaxSoc, GridCode
 
 
 ## Inverter Settings
@@ -180,8 +181,8 @@ 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.
-+ A return value of 1 is success. 0 means setting failed. None is another error e.g. device not found, invalid name or value.
-+ the only 'name' currently supported is 'ExportLimit'
++ 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 current supported include: ExportLimit, MinSoc, MinSocOnGrid, MaxSoc, GridCode
 
 
 ## Real Time Data
@@ -806,6 +807,9 @@ This setting can be:
 
 # Version Info
 
+2.8.3<br>
+Update to support setting Max Soc in schedules now this is supported by Fox using Open API.
+
 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.

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

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

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

@@ -1,7 +1,7 @@
 ##################################################################################################
 """
 Module:   Fox ESS Cloud
-Updated:  09 April 2025
+Updated:  16 April 2025
 By:       Tony Matthews
 """
 ##################################################################################################
@@ -10,7 +10,7 @@ By:       Tony Matthews
 # ALL RIGHTS ARE RESERVED © Tony Matthews 2023
 ##################################################################################################
 
-version = "1.9.4"
+version = "1.9.5"
 print(f"FoxESS-Cloud version {version}")
 
 debug_setting = 1
@@ -1005,6 +1005,13 @@ merge_settings = {                  # keys to add
         'unit': '℃'},
 }
 
+# change named settings, if required, so names match between Fox API and Open API
+translate_names = {
+    'MaxSoc': 'MaximumSoC',
+    'MinSoc': 'MinimumSoC',
+    'MinSocOnGrid': 'MinimumSoC-OnGrid'
+}
+
 def get_ui():
     global device_id, debug_setting, messages, remote_settings, named_settings, merge_settings
     if get_device() is None:
@@ -1069,7 +1076,7 @@ def get_ui():
     return remote_settings
 
 def get_remote_settings(key):
-    global device_id, debug_setting, messages
+    global device_id, debug_setting, messages, translate_settings
     if get_device() is None:
         return None
     output(f"getting remote settings", 2)
@@ -1101,7 +1108,7 @@ def get_remote_settings(key):
     return values
 
 def get_named_settings(name):
-    global named_settings
+    global named_settings, translate_names
     if get_device() is None:
         return None
     if type(name) is list:
@@ -1109,10 +1116,11 @@ def get_named_settings(name):
         for n in name:
             result.append(get_named_settings(n))
         return result
-    if named_settings is None or named_settings.get(name) is None:
+    key_name = translate_names[name] if translate_names.get(name) is not None else name
+    if named_settings is None or named_settings.get(key_name) is None:
         output(f"** get_named_settings(): {name} was not recognised")
         return None
-    keys = named_settings[name].get('keys')
+    keys = named_settings[key_name].get('keys')
     if keys is None:
         output(f"** get_named_settings(): no keys for name: {name}")
         return None
@@ -1121,8 +1129,8 @@ def get_named_settings(name):
     if result is None:
         output(f"** get_named_settings(): no result for {name} using key: {keys}")
         return None
-    result_type = named_settings[name].get('type')
-    value_type = named_settings[name].get('valueType')
+    result_type = named_settings[key_name].get('type')
+    value_type = named_settings[key_name].get('valueType')
     if result_type is None:
         v = result.get([k for k in result.keys()][0])
         return v if value_type is None else c_float(v) if value_type == 'float' else c_int(v)
@@ -1134,7 +1142,7 @@ def get_named_settings(name):
     return result
 
 def set_named_settings(name, value, force=0):
-    global named_settings
+    global named_settings, translate_names
     if get_device() is None:
         return None
     if force == 1 and get_schedule().get('enable'):
@@ -1144,18 +1152,19 @@ def set_named_settings(name, value, force=0):
         for (n, v) in name:
             result.append(set_named_settings(name=n, value=v))
         return result
-    if named_settings is None or named_settings.get(name) is None:
+    key_name = translate_names[name] if translate_names.get(name) is not None else name
+    if named_settings is None or named_settings.get(key_name) is None:
         output(f"** set_named_settings(): {name} was not recognised")
         return None
-    keys = named_settings[name].get('keys')
+    keys = named_settings[key_name].get('keys')
     if keys is None:
         output(f"** set_named_settings(): no keys for name: {name}")
         return None
-    item_type = named_settings[name].get('type')
+    item_type = named_settings[key_name].get('type')
     if item_type is None:
         values = {keys: str(value)}
     elif item_type == 'block':
-        items = named_setting[name]['items']
+        items = named_setting[key_name]['items']
         n = len(items)
         if type(value) is not list or n != len(value):
             output(f"** set_named_settings(): {name} requires list of {n} values")

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

@@ -1,7 +1,7 @@
 ##################################################################################################
 """
 Module:   Fox ESS Cloud using Open API
-Updated:  09 April 2025
+Updated:  16 April 2025
 By:       Tony Matthews
 """
 ##################################################################################################
@@ -10,7 +10,7 @@ By:       Tony Matthews
 # ALL RIGHTS ARE RESERVED © Tony Matthews 2024
 ##################################################################################################
 
-version = "2.8.2"
+version = "2.8.3"
 print(f"FoxESS-Cloud Open API version {version}")
 
 debug_setting = 1
@@ -861,6 +861,7 @@ def get_remote_settings(name):
                 values[x] = v[x]
         return values
     body = {'sn': device_sn, 'key': name}
+    setting_delay()
     response = signed_post(path="/op/v0/device/setting/get", body=body)
     if response.status_code != 200:
         output(f"** get_remote_settings() got response code {response.status_code}: {response.reason}")
@@ -1016,10 +1017,9 @@ def get_flag():
     if result is None:
         return None
     if schedule is None:
-        schedule = {'enable': None, 'support': None, 'periods': None}
+        schedule = {'enable': None, 'support': None, 'periods': None, 'maxsoc': False}
     schedule['enable'] = result.get('enable')
     schedule['support'] = result.get('support')
-    schedule['maxsoc'] = False
     if device.get('function') is not None and device['function'].get('scheduler') is not None:
         device['function']['scheduler'] = schedule['support']
     return schedule
@@ -1055,6 +1055,8 @@ def get_schedule():
     for g in result['groups']:
         if g['enable'] == 1 and g['workMode'] in work_modes:
             schedule['periods'].append(g)
+            if g.get('maxSoc') is not None:
+                schedule['maxsoc'] = True
     return schedule
 
 # build strategy using current schedule

{foxesscloud-2.8.2 → foxesscloud-2.8.3/src/foxesscloud.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxesscloud
-Version: 2.8.2
+Version: 2.8.3
 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
@@ -132,13 +132,14 @@ Additional battery attributes provided include:
 
 get_settings() will return the battery settings and is equivalent to get_charge() and get_min(). The results are stored in f.battery_settings. The settings include minSoc, minSocOnGrid, enable charge from grid and the charge times.
 
-get_flag() returns the current scheduler enable / support / maxsoc flags
+get_flag() returns the current scheduler enable / support / maxsoc flags. By default support for Max Soc is set to False.
 
 get_schedule() returns the current work mode / soc schedule settings. The result is stored in f.schedule.
++ if the schedule returned contains any values for 'maxSoc', the f.schedule['maxsoc'] is set to True to indicate that the current inverter supports setting Max Soc in schedules and Max Soc values are set by set_schedule().
 
 get_named_settings() returns the value of a named setting. If 'name' is a list, it returns a list of values.
-+ f.named_settings is updated. This is dictionary of information and current value, indexed by 'name.
-+ the only name currently supported by Fox is 'ExportLimit' and this is only available for H3 inverters.
++ f.named_settings is updated. This is dictionary of information and current value, indexed by 'name'.
++ named_settings current supported include: ExportLimit, MinSoc, MinSocOnGrid, MaxSoc, GridCode
 
 
 ## Inverter Settings
@@ -194,8 +195,8 @@ 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.
-+ A return value of 1 is success. 0 means setting failed. None is another error e.g. device not found, invalid name or value.
-+ the only 'name' currently supported is 'ExportLimit'
++ 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 current supported include: ExportLimit, MinSoc, MinSocOnGrid, MaxSoc, GridCode
 
 
 ## Real Time Data
@@ -820,6 +821,9 @@ This setting can be:
 
 # Version Info
 
+2.8.3<br>
+Update to support setting Max Soc in schedules now this is supported by Fox using Open API.
+
 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.