foxesscloud 2.7.5__py3-none-any.whl → 2.7.7__py3-none-any.whl

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.6"
+version = "1.8.8"
 print(f"FoxESS-Cloud version {version}")
 
 debug_setting = 1
@@ -435,7 +435,7 @@ device_sn = None
 var_list = None
 raw_vars = var_list
 
-def get_device(sn=None):
+def get_device(sn=None, device_type=None):
     global device_list, device, device_id, device_sn, firmware, battery, var_list, debug_setting, messages, flag, schedule, templates, remote_settings
     if get_token() is None:
         return None
@@ -490,31 +490,32 @@ def get_device(sn=None):
     firmware = get_firmware()
     remote_settings = get_ui()
     # parse the model code to work out attributes
-    model_code = device['deviceType'].upper()
-    if model_code[:1] == 'T':
-        model_code = 'T3-' + model_code[1:]
+    model_code = device['deviceType'].upper() if device_type is None else device_type
+    if model_code[0] in 'FGRST':
+        phase = '1' if model_code[0] in 'FGS' else '3'
+        model_code = model_code[0] + phase + '-' + model_code[1:]
     elif model_code[:2] == 'KH':
         model_code = 'KH-' + model_code[2:]
     elif model_code[:4] == 'AIO-':
         model_code = 'AIO' + model_code[4:]
-    device['eps'] = 'E' in model_code
+    device['eps'] = 'E' in model_code[2:]
     parts = model_code.split('-')
     model = parts[0]
-    if model not in ['T3', 'KH', 'H1', 'AC1', 'H3', 'AC3', 'AIOH1', 'AIOH3']:
+    if model not in ['F1', 'G1', 'R3', 'S1', 'T3', 'KH', 'H1', 'AC1', 'H3', 'AC3', 'AIOH1', 'AIOH3']:
         output(f"** device model not recognised for deviceType: {device['deviceType']}")
         return device
     device['model'] = model
     device['phase'] = 3 if model[-1:] == '3' else 1
     for p in parts[1:]:
         if p.replace('.','').isnumeric():
-            power = float(p)
-            if power >= 1.0 and power < 50.0:
-                device['power'] = float(p)
+            power = float(p)  / (1000 if model in ['F1', 'S1'] else 1.0)
+            if power >= 0.5 and power < 100.0:
+                device['power'] = power
             break
     if device.get('power') is None:
         output(f"** device power not found for deviceType: {device['deviceType']}")
     # set max charge current
-    if model in ['T3']:
+    if model in ['F1', 'G1', 'R3', 'S1', 'T3']:
         device['max_charge_current'] = None
     elif model in ['KH']:
         device['max_charge_current'] = 50
@@ -2379,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
@@ -3064,7 +3065,7 @@ def charge_needed(forecast=None, update_settings=0, timed_mode=None, show_data=N
         output(f"full_charge = {full_charge}")
     if test_soc is not None:
         current_soc = test_soc
-        capacity = 14.40
+        capacity = 14.36
         residual = test_soc * capacity / 100
         bat_volt = 317.4
         bat_power = 0.0
@@ -3856,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"------------------------------------------------")
@@ -3881,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:
@@ -3916,7 +3921,7 @@ def get_pvoutput(d = None, tou = 0):
     export_tou = ',,,'
     # process list of report_data values (no TOU)
     for var in report_data:
-        wh = int(var['total'] * 1000)
+        wh = int(var['total'] * 1000) if var['total'] is not None else 0
         if var['variable'] == 'feedin':
             export_wh = wh 
             export = f"{wh},"
@@ -3936,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/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.5"
+version = "2.7.7"
 print(f"FoxESS-Cloud Open API version {version}")
 
 debug_setting = 1
@@ -419,7 +419,7 @@ device_list = None
 device = None
 device_sn = None
 
-def get_device(sn=None):
+def get_device(sn=None, device_type=None):
     global device_list, device, device_sn, battery, debug_setting, schedule, remote_settings
     if get_vars() is None:
         return None
@@ -480,31 +480,32 @@ def get_device(sn=None):
     get_generation()
 #    remote_settings = get_ui()
     # parse the model code to work out attributes
-    model_code = device['deviceType'].upper()
-    if model_code[:1] == 'T':
-        model_code = 'T3-' + model_code[1:]
-    if model_code[:2] == 'KH':
+    model_code = device['deviceType'].upper() if device_type is None else device_type
+    if model_code[0] in 'FGRST':
+        phase = '1' if model_code[0] in 'FGS' else '3'
+        model_code = model_code[0] + phase + '-' + model_code[1:]
+    elif model_code[:2] == 'KH':
         model_code = 'KH-' + model_code[2:]
     elif model_code[:4] == 'AIO-':
         model_code = 'AIO' + model_code[4:]
-    device['eps'] = 'E' in model_code
+    device['eps'] = 'E' in model_code[2:]
     parts = model_code.split('-')
     model = parts[0]
-    if model not in ['T3', 'KH', 'H1', 'AC1', 'H3', 'AC3', 'AIOH1', 'AIOH3']:
+    if model not in ['F1', 'G1', 'R3', 'S1', 'T3', 'KH', 'H1', 'AC1', 'H3', 'AC3', 'AIOH1', 'AIOH3']:
         output(f"** device model not recognised for deviceType: {device['deviceType']}")
         return device
     device['model'] = model
     device['phase'] = 3 if model[-1:] == '3' else 1
     for p in parts[1:]:
         if p.replace('.','').isnumeric():
-            power = float(p)
-            if power >= 1.0 and power < 50.0:
-                device['power'] = float(p)
+            power = float(p)  / (1000 if model in ['F1', 'S1'] else 1.0)
+            if power >= 0.5 and power < 100.0:
+                device['power'] = power
             break
     if device.get('power') is None:
         output(f"** device power not found for deviceType: {device['deviceType']}")
     # set max charge current
-    if model in ['T3']:
+    if model in ['F1', 'G1', 'R3', 'S1', 'T3']:
         device['max_charge_current'] = None
     elif model in ['KH']:
         device['max_charge_current'] = 50
@@ -842,7 +843,7 @@ def get_settings():
 named_settings = {}
 
 def get_remote_settings(name):
-    global device_sn, debug_setting, messages, name_data
+    global device_sn, debug_setting, messages, name_data, named_settings
     if get_device() is None:
         return None
     output(f"getting remote settings", 2)
@@ -878,7 +879,7 @@ def get_named_settings(name):
     return get_remote_settings(name)
 
 def set_named_settings(name, value, force=0):
-    global device_sn, debug_setting
+    global device_sn, debug_setting, named_settings
     if get_device() is None:
         return None
     if force == 1 and get_schedule().get('enable'):
@@ -888,6 +889,10 @@ 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.get(name) is None:
+        result = get_named_settings(name)
+        if result is None:
+            return None
     output(f"\nSetting {name} to {value}", 1)
     body = {'sn': device_sn, 'key': name, 'value': f"{value}"}
     setting_delay()
@@ -901,8 +906,9 @@ def set_named_settings(name, value, force=0):
             output(f"** cannot update {name} when schedule is active")
         else:
             output(f"** set_named_settings(): ({name}, {value}) {errno_message(response)}")
-        return 0
-    return 1
+        return None
+    named_settings[name]['value'] = f"{value}"
+    return value
 
 ##################################################################################################
 # wrappers for named settings
@@ -2046,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
@@ -2730,7 +2736,7 @@ def charge_needed(forecast=None, update_settings=0, timed_mode=None, show_data=N
         output(f"full_charge = {full_charge}")
     if test_soc is not None:
         current_soc = test_soc
-        capacity = 14.40
+        capacity = 14.36
         residual = test_soc * capacity / 100
         bat_volt = 317.4
         bat_power = 0.0
@@ -3523,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"------------------------------------------------")
@@ -3548,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:
@@ -3583,7 +3593,7 @@ def get_pvoutput(d = None, tou = 0):
     export_tou = ',,,'
     # process list of report_data values (no TOU)
     for var in report_data:
-        wh = int(var['total'] * 1000)
+        wh = int(var['total'] * 1000) if var['total'] is not None else 0
         if var['variable'] == 'feedin':
             export_wh = wh 
             export = f"{wh},"
@@ -3603,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.5.dist-info → foxesscloud-2.7.7.dist-info}/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.5.dist-info → foxesscloud-2.7.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxesscloud
-Version: 2.7.5
+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,15 @@ 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.
+Fix divide by zero error when using pvoutput with solar only inverters.
+
 2.7.5<br>
 Update to support T series inverters.
 

foxesscloud-2.7.7.dist-info/RECORD

@@ -0,0 +1,7 @@
+foxesscloud/foxesscloud.py,sha256=mh_Yopg3c5Hx8rl1LVet58EUnzacoUjjh0g2n68KwPQ,223311
+foxesscloud/openapi.py,sha256=e9Uf9NTAFPWTh2xzCyTg-6vS8obogmwok-41u5c1lhE,207725
+foxesscloud-2.7.7.dist-info/LICENCE,sha256=8JF-24QkE8UfdII-g6RaIEvM-PZ9zwaEcxlwYUDMt-4,1079
+foxesscloud-2.7.7.dist-info/METADATA,sha256=luevOoQZLqPj4c74WkyG6FLYFmlq6GwNd_O3xJ3J490,63042
+foxesscloud-2.7.7.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+foxesscloud-2.7.7.dist-info/top_level.txt,sha256=IWOrKSNZCLU6IDXSX_b4_bqCfbZoWAT4CC0w0Lg7PuU,12
+foxesscloud-2.7.7.dist-info/RECORD,,

foxesscloud-2.7.5.dist-info/RECORD

@@ -1,7 +0,0 @@
-foxesscloud/foxesscloud.py,sha256=b7DcJs3Ms538CPyMvl8llTile5-gYR6bi31Jf7linqQ,222841
-foxesscloud/openapi.py,sha256=wn3dJhTth0IKNOT8Uv4bMYxiB5W1WVTEVJhNQqu7pMw,207033
-foxesscloud-2.7.5.dist-info/LICENCE,sha256=-3xv8CElCJV8Bc8PbAsg3iyxMpAK8MoJneM3rXigxqI,1074
-foxesscloud-2.7.5.dist-info/METADATA,sha256=NaUsXWSxDtnQFURfkVYYjTQ4eIqYsze3CKg1rvgIpno,62438
-foxesscloud-2.7.5.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-foxesscloud-2.7.5.dist-info/top_level.txt,sha256=IWOrKSNZCLU6IDXSX_b4_bqCfbZoWAT4CC0w0Lg7PuU,12
-foxesscloud-2.7.5.dist-info/RECORD,,