foxesscloud 2.8.1__py3-none-any.whl → 2.8.3__py3-none-any.whl

foxesscloud/foxesscloud.py

@@ -1,7 +1,7 @@
 ##################################################################################################
 """
 Module:   Fox ESS Cloud
-Updated:  12 March 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.3"
+version = "1.9.5"
 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,12 +998,20 @@ merge_settings = {                  # keys to add
         'h116__': 'h116__18',
         'h117__': 'h117__18',
 #        'k106__': 'k106__xx',
+#        'k110__': 'k110__xx',
         },
         'type': 'list',
         'valueType': 'int',
         '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:
@@ -1066,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)
@@ -1098,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:
@@ -1106,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
@@ -1118,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)
@@ -1131,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'):
@@ -1141,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")
@@ -3089,7 +3101,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 +4497,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/openapi.py

@@ -1,7 +1,7 @@
 ##################################################################################################
 """
 Module:   Fox ESS Cloud using Open API
-Updated:  12 March 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.1"
+version = "2.8.3"
 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']
@@ -863,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}")
@@ -1018,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
@@ -1057,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
@@ -2756,7 +2756,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 +4153,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.dist-info → foxesscloud-2.8.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxesscloud
-Version: 2.8.1
+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
@@ -620,6 +621,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 +821,13 @@ 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.
+
 2.8.1<br>
 Update from v0 to v1 for scheduler API.
 PVEnergyTotal added to report variables.

foxesscloud-2.8.3.dist-info/RECORD

@@ -0,0 +1,7 @@
+foxesscloud/foxesscloud.py,sha256=E48TEwk75XrLcJNXNvuMwG93VjjIYknuPERqSYGhRDE,224825
+foxesscloud/openapi.py,sha256=d-qKK_XjpnRQpnAQ7HcLZSP7hbViHQ9tckM5o4Xf0eE,208484
+foxesscloud-2.8.3.dist-info/LICENCE,sha256=8JF-24QkE8UfdII-g6RaIEvM-PZ9zwaEcxlwYUDMt-4,1079
+foxesscloud-2.8.3.dist-info/METADATA,sha256=ECLbKmesBVJ5HRnvGXTw842d9q8XPhAc2y0MKuP9AyE,65179
+foxesscloud-2.8.3.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+foxesscloud-2.8.3.dist-info/top_level.txt,sha256=IWOrKSNZCLU6IDXSX_b4_bqCfbZoWAT4CC0w0Lg7PuU,12
+foxesscloud-2.8.3.dist-info/RECORD,,

foxesscloud-2.8.1.dist-info/RECORD

@@ -1,7 +0,0 @@
-foxesscloud/foxesscloud.py,sha256=keJUa9j7OhAJF1lnbNAbTaFTnJm3T-XyiyuWOwF8KdM,224235
-foxesscloud/openapi.py,sha256=HTYc-ueI_gZRelOduaABzWBzaGsJTZlpo_1fWqkEhSc,208461
-foxesscloud-2.8.1.dist-info/LICENCE,sha256=8JF-24QkE8UfdII-g6RaIEvM-PZ9zwaEcxlwYUDMt-4,1079
-foxesscloud-2.8.1.dist-info/METADATA,sha256=ptLAC2vtyV5pYu-HE8p8Ot_JoMPgnTCYNChXA0dCmv0,63522
-foxesscloud-2.8.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-foxesscloud-2.8.1.dist-info/top_level.txt,sha256=IWOrKSNZCLU6IDXSX_b4_bqCfbZoWAT4CC0w0Lg7PuU,12
-foxesscloud-2.8.1.dist-info/RECORD,,