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

foxesscloud/foxesscloud.py

@@ -1,7 +1,7 @@
 ##################################################################################################
 """
 Module:   Fox ESS Cloud
-Updated:  28 January 2025
+Updated:  12 March 2025
 By:       Tony Matthews
 """
 ##################################################################################################
@@ -10,7 +10,7 @@ By:       Tony Matthews
 # ALL RIGHTS ARE RESERVED © Tony Matthews 2023
 ##################################################################################################
 
-version = "1.9.0"
+version = "1.9.3"
 print(f"FoxESS-Cloud version {version}")
 
 debug_setting = 1
@@ -590,6 +590,7 @@ battery_settings = None
 
 # 1 = Residual Energy, 2 = Residual Capacity (HV), 3 = Residual Capacity per battery (Mira)
 residual_handling = 1
+residual_scale = 0.01
 
 # charge rates based on residual_handling. Index is bms temperature
 battery_params = {
@@ -619,7 +620,7 @@ battery_params = {
 }
 
 def get_battery(info=1, rated=None, count=None):
-    global device_id, battery, debug_setting, messages, residual_handling, battery_params
+    global device_id, battery, debug_setting, messages, residual_handling, battery_params, residual_scale
     if get_device() is None:
         return None
     output(f"getting battery", 2)
@@ -655,11 +656,14 @@ def get_battery(info=1, rated=None, count=None):
     battery['residual_handling'] = residual_handling
     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:
         output(f"** get_battery(): battery status not available")
         return None
+    battery['status'] = 1
     if battery.get('residual') is not None:
-        battery['residual'] /= 1000
+        battery['residual'] *= residual_scale / 10
     if battery['residual_handling'] == 2:
         capacity = battery.get('residual')
         soc = battery.get('soc')
@@ -1826,7 +1830,7 @@ def rescale_history(data, steps):
 # station = 0: use device_id, 1 = use station_id
 ##################################################################################################
 
-report_vars = ['yield', 'input','generation', 'feedin', 'loads', 'gridConsumption', 'chargeEnergyToTal', 'dischargeEnergyToTal']
+report_vars = ['PVEnergyTotal', 'input','generation', 'feedin', 'loads', 'gridConsumption', 'chargeEnergyToTal', 'dischargeEnergyToTal']
 report_names = ['PV Yield', 'Input', 'Generation', 'Grid Export', 'Consumption', 'Grid Import', 'Battery Charge', 'Battery Discharge']
 
 # fix power values after fox corrupts high word of 32-bit energy total
@@ -3093,7 +3097,10 @@ def charge_needed(forecast=None, consumption=None, update_settings=0, timed_mode
         bat_current = battery['current']
         temperature = battery['temperature']
         residual = battery['residual']
-        capacity = charge_config['capacity'] if charge_config.get('capacity') is not None else battery.get('capacity')
+        capacity = battery.get('capacity')
+        if charge_config.get('capacity') is not None:
+            capacity = charge_config['capacity']
+            residual = (capacity * current_soc / 100) if capacity is not None and current_soc is not None else None
         if capacity is None:
             output(f"Battery capacity could not be estimated. Please add the parameter 'capacity=xx' in kWh")
             return None

foxesscloud/openapi.py

@@ -1,7 +1,7 @@
 ##################################################################################################
 """
 Module:   Fox ESS Cloud using Open API
-Updated:  27 January 2025
+Updated:  12 March 2025
 By:       Tony Matthews
 """
 ##################################################################################################
@@ -10,7 +10,7 @@ By:       Tony Matthews
 # ALL RIGHTS ARE RESERVED © Tony Matthews 2024
 ##################################################################################################
 
-version = "2.7.9"
+version = "2.8.1"
 print(f"FoxESS-Cloud Open API version {version}")
 
 debug_setting = 1
@@ -1010,7 +1010,7 @@ def get_flag():
         return None
     output(f"getting flag", 2)
     body = {'deviceSN': device_sn}
-    response = signed_post(path="/op/v0/device/scheduler/get/flag", body=body)
+    response = signed_post(path="/op/v1/device/scheduler/get/flag", body=body)
     if response.status_code != 200:
         output(f"** get_flag() got response code {response.status_code}: {response.reason}")
         return None
@@ -1040,7 +1040,7 @@ def get_schedule():
         return None
     output(f"getting schedule", 2)
     body = {'deviceSN': device_sn}
-    response = signed_post(path="/op/v0/device/scheduler/get", body=body)
+    response = signed_post(path="/op/v1/device/scheduler/get", body=body)
     if response.status_code != 200:
         output(f"** get_schedule() got response code {response.status_code}: {response.reason}")
         return None
@@ -1133,7 +1133,7 @@ def set_period(start=None, end=None, mode=None, min_soc=None, max_soc=None, fdso
     period = {'enable': enable, 'startHour': start_hour, 'startMinute': start_minute, 'endHour': end_hour, 'endMinute': end_minute, 'workMode': mode,
         'minSocOnGrid': int(min_soc), 'fdSoc': int(fdsoc), 'fdPwr': int(fdpwr)}
     if max_soc is not None:
-        period['maxsoc'] = int(max_soc)
+        period['maxSoc'] = int(max_soc)
     return period
 
 # set a schedule from a period or list of time segment periods
@@ -1160,7 +1160,7 @@ def set_schedule(periods=None, enable=True):
             output(f"** set_schedule(): maximum of 8 periods allowed, {len(periods)} provided")
         body = {'deviceSN': device_sn, 'groups': periods[-8:]}
         setting_delay()
-        response = signed_post(path="/op/v0/device/scheduler/enable", body=body)
+        response = signed_post(path="/op/v1/device/scheduler/enable", body=body)
         if response.status_code != 200:
             output(f"** set_schedule() periods response code {response.status_code}: {response.reason}")
             return None
@@ -1171,7 +1171,7 @@ def set_schedule(periods=None, enable=True):
         schedule['periods'] = periods
     body = {'deviceSN': device_sn, 'enable': 1 if enable else 0}
     setting_delay()
-    response = signed_post(path="/op/v0/device/scheduler/set/flag", body=body)
+    response = signed_post(path="/op/v1/device/scheduler/set/flag", body=body)
     if response.status_code != 200:
         output(f"** set_schedule() flag response code {response.status_code}: {response.reason}")
         return None
@@ -1530,8 +1530,8 @@ def rescale_history(data, steps):
 # plot = 0: no plot, 1 = plot variables separately, 2 = combine variables
 ##################################################################################################
 
-report_vars = ['generation', 'feedin', 'loads', 'gridConsumption', 'chargeEnergyToTal', 'dischargeEnergyToTal']
-report_names = ['Generation', 'Grid Export', 'Consumption', 'Grid Import', 'Battery Charge', 'Battery Discharge']
+report_vars = ['generation', 'feedin', 'loads', 'gridConsumption', 'chargeEnergyToTal', 'dischargeEnergyToTal', 'PVEnergyTotal']
+report_names = ['Generation', 'Grid Export', 'Consumption', 'Grid Import', 'Battery Charge', 'Battery Discharge', 'PV Yield']
 
 # fix power values after corruption of high word of 32-bit energy total
 fix_values = 1
@@ -2764,7 +2764,10 @@ def charge_needed(forecast=None, consumption=None, update_settings=0, timed_mode
         bat_current = battery['current']
         temperature = battery['temperature']
         residual = battery['residual']
-        capacity = charge_config['capacity'] if charge_config.get('capacity') is not None else battery.get('capacity')
+        capacity = battery.get('capacity')
+        if charge_config.get('capacity') is not None:
+            capacity = charge_config['capacity']
+            residual = (capacity * current_soc / 100) if capacity is not None and current_soc is not None else None
         if capacity is None:
             output(f"Battery capacity could not be estimated. Please add the parameter 'capacity=xx' in kWh")
             return None

{foxesscloud-2.7.9.dist-info → foxesscloud-2.8.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxesscloud
-Version: 2.7.9
+Version: 2.8.1
 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
@@ -809,6 +809,11 @@ This setting can be:
 
 # Version Info
 
+2.8.1<br>
+Update from v0 to v1 for scheduler API.
+PVEnergyTotal added to report variables.
+Fix residual if capacity is specified for charge_needed().
+
 2.7.9<br>
 Add 'consumption' input for charge_needed().
 Avoid throwing exception in battery_info() if there is no capacity info.

foxesscloud-2.8.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+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,,

foxesscloud-2.7.9.dist-info/RECORD

@@ -1,7 +0,0 @@
-foxesscloud/foxesscloud.py,sha256=6subMmEgHYVGQWFvf7LZ5dOwfygUxNM4jRct74OfwkY,223877
-foxesscloud/openapi.py,sha256=FQVHqSsm5sEZ3rDq_MRutag1eGmTwPZTn1Qr-I3n8Ho,208291
-foxesscloud-2.7.9.dist-info/LICENCE,sha256=8JF-24QkE8UfdII-g6RaIEvM-PZ9zwaEcxlwYUDMt-4,1079
-foxesscloud-2.7.9.dist-info/METADATA,sha256=RdNw-jLKWmu-wko-wDa6215WoalBlsu_qzsRlIL5JVc,63366
-foxesscloud-2.7.9.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-foxesscloud-2.7.9.dist-info/top_level.txt,sha256=IWOrKSNZCLU6IDXSX_b4_bqCfbZoWAT4CC0w0Lg7PuU,12
-foxesscloud-2.7.9.dist-info/RECORD,,