foxesscloud 2.7.7__tar.gz → 2.7.9__tar.gz

{foxesscloud-2.7.7/src/foxesscloud.egg-info → foxesscloud-2.7.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxesscloud
-Version: 2.7.7
+Version: 2.7.9
 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
@@ -358,7 +358,9 @@ All the parameters are optional:
 
 charge_needed() uses a number of models to better estimate the state of the battery.
 
-**Manual Consumption:** You can provide your 'annual_consumption' in kWh e.g. 5500. This figure is factored down to a daily consumption by dividing by 365 and applying **f.seasonality**. This normally decreases consumption in the summer and increases it in winter. Seasonality is a list of weightings by month for Jan, Feb, Mar, Apr etc. Preset lists are 'f.high_seasonality' (recommend where electric heating is ued), 'f.medium_seasonality' (default) amd 'f.no_seasonality' (all months the same). The daily consumption is profiled by hour using **f.daily_consumption**. This maps your consumption for a day to the hours when more or less energy is consumed. It is a list of 24 values for the times 00, 01, 02, 03 .. 23. Preset lists are 'f.high_profile' (larger peaks at 8am and 6pm), 'f.medium_profile' (default, more balanced) and 'f.no_profile' (flat).
+**Manual Consumption:** You can provide your expected 'consumption' in kWh e.g. 15. This figure is used directly.
+
+**Annual Consumption:** You can provide your 'annual_consumption' in kWh e.g. 5500. This figure is factored down to a daily consumption by dividing by 365 and applying **f.seasonality**. This normally decreases consumption in the summer and increases it in winter. Seasonality is a list of weightings by month for Jan, Feb, Mar, Apr etc. Preset lists are 'f.high_seasonality' (recommend where electric heating is ued), 'f.medium_seasonality' (default) amd 'f.no_seasonality' (all months the same). The daily consumption is profiled by hour using **f.daily_consumption**. This maps your consumption for a day to the hours when more or less energy is consumed. It is a list of 24 values for the times 00, 01, 02, 03 .. 23. Preset lists are 'f.high_profile' (larger peaks at 8am and 6pm), 'f.medium_profile' (default, more balanced) and 'f.no_profile' (flat).
 
 **Historic Consumption:** If annual_consumption is not provided, your consumption history is used. By default, this looks at your average consumption for the last 3 days using the load power reported by your inverter. For systems with multiple inverters where CT2 is not connected, the load power may not be correct. For this and other cases where you want to set your consumption, provide your annual_consumption.
 
@@ -807,6 +809,13 @@ This setting can be:
 
 # Version Info
 
+2.7.9<br>
+Add 'consumption' input for charge_needed().
+Avoid throwing exception in battery_info() if there is no capacity info.
+
+2.7.8<br>
+Update the battery_params charge rate table to 2025 values.
+
 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.

{foxesscloud-2.7.7 → foxesscloud-2.7.9}/README.md

@@ -344,7 +344,9 @@ All the parameters are optional:
 
 charge_needed() uses a number of models to better estimate the state of the battery.
 
-**Manual Consumption:** You can provide your 'annual_consumption' in kWh e.g. 5500. This figure is factored down to a daily consumption by dividing by 365 and applying **f.seasonality**. This normally decreases consumption in the summer and increases it in winter. Seasonality is a list of weightings by month for Jan, Feb, Mar, Apr etc. Preset lists are 'f.high_seasonality' (recommend where electric heating is ued), 'f.medium_seasonality' (default) amd 'f.no_seasonality' (all months the same). The daily consumption is profiled by hour using **f.daily_consumption**. This maps your consumption for a day to the hours when more or less energy is consumed. It is a list of 24 values for the times 00, 01, 02, 03 .. 23. Preset lists are 'f.high_profile' (larger peaks at 8am and 6pm), 'f.medium_profile' (default, more balanced) and 'f.no_profile' (flat).
+**Manual Consumption:** You can provide your expected 'consumption' in kWh e.g. 15. This figure is used directly.
+
+**Annual Consumption:** You can provide your 'annual_consumption' in kWh e.g. 5500. This figure is factored down to a daily consumption by dividing by 365 and applying **f.seasonality**. This normally decreases consumption in the summer and increases it in winter. Seasonality is a list of weightings by month for Jan, Feb, Mar, Apr etc. Preset lists are 'f.high_seasonality' (recommend where electric heating is ued), 'f.medium_seasonality' (default) amd 'f.no_seasonality' (all months the same). The daily consumption is profiled by hour using **f.daily_consumption**. This maps your consumption for a day to the hours when more or less energy is consumed. It is a list of 24 values for the times 00, 01, 02, 03 .. 23. Preset lists are 'f.high_profile' (larger peaks at 8am and 6pm), 'f.medium_profile' (default, more balanced) and 'f.no_profile' (flat).
 
 **Historic Consumption:** If annual_consumption is not provided, your consumption history is used. By default, this looks at your average consumption for the last 3 days using the load power reported by your inverter. For systems with multiple inverters where CT2 is not connected, the load power may not be correct. For this and other cases where you want to set your consumption, provide your annual_consumption.
 
@@ -793,6 +795,13 @@ This setting can be:
 
 # Version Info
 
+2.7.9<br>
+Add 'consumption' input for charge_needed().
+Avoid throwing exception in battery_info() if there is no capacity info.
+
+2.7.8<br>
+Update the battery_params charge rate table to 2025 values.
+
 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.

{foxesscloud-2.7.7 → foxesscloud-2.7.9}/pyproject.toml

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

{foxesscloud-2.7.7 → foxesscloud-2.7.9}/src/foxesscloud/foxesscloud.py

@@ -1,7 +1,7 @@
 ##################################################################################################
 """
 Module:   Fox ESS Cloud
-Updated:  11 January 2025
+Updated:  28 January 2025
 By:       Tony Matthews
 """
 ##################################################################################################
@@ -10,7 +10,7 @@ By:       Tony Matthews
 # ALL RIGHTS ARE RESERVED © Tony Matthews 2023
 ##################################################################################################
 
-version = "1.8.8"
+version = "1.9.0"
 print(f"FoxESS-Cloud version {version}")
 
 debug_setting = 1
@@ -591,25 +591,29 @@ battery_settings = None
 # 1 = Residual Energy, 2 = Residual Capacity (HV), 3 = Residual Capacity per battery (Mira)
 residual_handling = 1
 
-# charge rates based on residual_handling
+# charge rates based on residual_handling. Index is bms temperature
 battery_params = {
-#    cell temp    -5  0   5  10  15  20  25  30  35  40  45  50 55
 #    bms temp      5 10  15  20  25  30  35  40  45  50  55  60 65 
+#    cell temp    -5  0   5  10  15  20  25  30  35  40  45  50 55
     1: {'table': [ 0, 2, 10, 15, 25, 50, 50, 50, 50, 50, 30, 20, 0],
         'step': 5,
         'offset': 5,
         'charge_loss': 0.974,
         'discharge_loss': 0.974},
-    # HV BMS v2 with firmware 1.014 or later
-    2: {'table': [ 0, 2, 10, 10, 15, 15, 25, 50, 50, 50, 30, 20, 0],
+# HV BMS v2 with firmware 1.014 or later
+#    bms temp     10 15  20  25  30  35  40  45  50  55  60  65  70 
+#    cell temp     0  5  10  15  20  25  30  35  40  45  50  55  60
+    2: {'table': [ 0, 5, 10, 15, 25, 50, 50, 50, 50, 25, 20,  3,  0],
         'step': 5,
-        'offset': 5,
+        'offset': 11,
         'charge_loss': 1.08,
         'discharge_loss': 0.95},
-    # Mira BMS with firmware 1.014 or later
-    3: {'table': [ 0, 2, 10, 10, 15, 15, 25, 50, 50, 50, 30, 20, 0],
+# Mira BMS with firmware 1.014 or later
+#    bms temp     10 15  20  25  30  35  40  45  50  55  60  65  70 
+#    cell temp     0  5  10  15  20  25  30  35  40  45  50  55  60
+    3: {'table': [ 0, 5, 10, 15, 25, 50, 50, 50, 50, 25, 20,  3,  0],
         'step': 5,
-        'offset': 5,
+        'offset': 11,
         'charge_loss': 0.974,
         'discharge_loss': 0.974},
 }
@@ -2953,6 +2957,7 @@ charge_needed_app_key = "awcr5gro2v13oher3v1qu6hwnovp28"
 
 # work out the charge times to set using the parameters:
 #  forecast: the kWh expected tomorrow. If none, forecast data is loaded from solcast etc
+#  consumption: the kWh consumed. If none, consumption is loaded from history
 #  update_settings: 0 no updates, 1 update charge settings. The default is 0
 #  show_data: 1 shows battery SoC, 2 shows battery residual. Default = 0
 #  show_plot: 1 plots battery SoC, 2 plots battery residual. Default = 1
@@ -2960,7 +2965,7 @@ charge_needed_app_key = "awcr5gro2v13oher3v1qu6hwnovp28"
 #  forecast_times: list of hours when forecast can be fetched (UTC)
 #  force_charge: 1 = hold battery, 2 = charge for whole period
 
-def charge_needed(forecast=None, update_settings=0, timed_mode=None, show_data=None, show_plot=None, run_after=None, reload=2,
+def charge_needed(forecast=None, consumption=None, update_settings=0, timed_mode=None, show_data=None, show_plot=None, run_after=None, reload=2,
         forecast_times=None, force_charge=0, test_time=None, test_soc=None, test_charge=None, **settings):
     global device, seasonality, solcast_api_key, debug_setting, tariff, solar_arrays, legend_location, time_shift, charge_needed_app_key
     global timed_strategy, steps_per_hour, base_time, storage, battery, battery_params
@@ -3172,6 +3177,9 @@ def charge_needed(forecast=None, update_settings=0, timed_mode=None, show_data=N
         consumption = annual_consumption / 365 * seasonality[now.month - 1] / sum(seasonality) * 12
         consumption_by_hour = daily_consumption
         output(f"\nEstimated consumption: {consumption:.1f}kWh")
+    elif consumption is not None:
+        consumption_by_hour = daily_consumption
+        output(f"\nConsumption: {consumption:.1f}kWh")
     else:
         consumption_days = charge_config['consumption_days']
         consumption_days = 3 if consumption_days > 7 or consumption_days < 1 else consumption_days
@@ -3633,7 +3641,7 @@ def battery_info(log=0, plot=1, rated=None, count=None, info=1, bat=None):
     bat_current = bat['current']
     bat_power = bat['power']
     bms_temperature = bat['temperature']
-    capacity = bat['capacity']
+    capacity = bat.get('capacity')
     cell_volts = get_cell_volts()
     if cell_volts is None:
         output_close()
@@ -3678,7 +3686,8 @@ def battery_info(log=0, plot=1, rated=None, count=None, info=1, bat=None):
                     s +=f",{v:.0f}"
         return s
     output(f"Current SoC:         {current_soc}%")
-    output(f"Capacity:            {capacity:.2f}kWh" + (" (calculated)" if bat['residual_handling'] in [1,3] else ""))
+    if capacity is not None:
+        output(f"Capacity:            {capacity:.2f}kWh" + (" (calculated)" if bat['residual_handling'] in [1,3] else ""))
     output(f"Residual:            {residual:.2f}kWh" + (" (calculated)" if bat['residual_handling'] in [2,3] else ""))
     if rated_capacity is not None and bat_soh is not None:
         output(f"Rated Capacity:      {rated_capacity / 1000:.2f}kWh")

{foxesscloud-2.7.7 → foxesscloud-2.7.9}/src/foxesscloud/openapi.py

@@ -1,7 +1,7 @@
 ##################################################################################################
 """
 Module:   Fox ESS Cloud using Open API
-Updated:  11 January 2025
+Updated:  27 January 2025
 By:       Tony Matthews
 """
 ##################################################################################################
@@ -10,7 +10,7 @@ By:       Tony Matthews
 # ALL RIGHTS ARE RESERVED © Tony Matthews 2024
 ##################################################################################################
 
-version = "2.7.7"
+version = "2.7.9"
 print(f"FoxESS-Cloud Open API version {version}")
 
 debug_setting = 1
@@ -555,25 +555,29 @@ battery_data = ['soc', 'volt', 'current', 'power', 'temperature', 'residual']
 # 1 = Residual Energy, 2 = Residual Capacity (HV), 3 = Residual Capacity per battery (Mira)
 residual_handling = 1
 
-# charge rates based on residual_handling
+# charge rates based on residual_handling. Index is bms temperature
 battery_params = {
-#    cell temp    -5  0   5  10  15  20  25  30  35  40  45  50 55
 #    bms temp      5 10  15  20  25  30  35  40  45  50  55  60 65 
+#    cell temp    -5  0   5  10  15  20  25  30  35  40  45  50 55
     1: {'table': [ 0, 2, 10, 15, 25, 50, 50, 50, 50, 50, 30, 20, 0],
         'step': 5,
         'offset': 5,
         'charge_loss': 0.974,
         'discharge_loss': 0.974},
-    # HV BMS v2 with firmware 1.014 or later
-    2: {'table': [ 0, 2, 10, 10, 15, 15, 25, 50, 50, 50, 30, 20, 0],
+# HV BMS v2 with firmware 1.014 or later
+#    bms temp     10 15  20  25  30  35  40  45  50  55  60  65  70 
+#    cell temp     0  5  10  15  20  25  30  35  40  45  50  55  60
+    2: {'table': [ 0, 5, 10, 15, 25, 50, 50, 50, 50, 25, 20,  3,  0],
         'step': 5,
-        'offset': 5,
+        'offset': 11,
         'charge_loss': 1.08,
         'discharge_loss': 0.95},
-    # Mira BMS with firmware 1.014 or later
-    3: {'table': [ 0, 2, 10, 10, 15, 15, 25, 50, 50, 50, 30, 20, 0],
+# Mira BMS with firmware 1.014 or later
+#    bms temp     10 15  20  25  30  35  40  45  50  55  60  65  70 
+#    cell temp     0  5  10  15  20  25  30  35  40  45  50  55  60
+    3: {'table': [ 0, 5, 10, 15, 25, 50, 50, 50, 50, 25, 20,  3,  0],
         'step': 5,
-        'offset': 5,
+        'offset': 11,
         'charge_loss': 0.974,
         'discharge_loss': 0.974},
 }
@@ -2624,6 +2628,7 @@ charge_needed_app_key = "awcr5gro2v13oher3v1qu6hwnovp28"
 
 # work out the charge times to set using the parameters:
 #  forecast: the kWh expected tomorrow. If none, forecast data is loaded from solcast etc
+#  consumption: the kWh consumed. If none, consumption is loaded from history
 #  update_settings: 0 no updates, 1 update charge settings. The default is 0
 #  show_data: 1 shows battery SoC, 2 shows battery residual. Default = 0
 #  show_plot: 1 plots battery SoC, 2 plots battery residual. Default = 1
@@ -2631,7 +2636,7 @@ charge_needed_app_key = "awcr5gro2v13oher3v1qu6hwnovp28"
 #  forecast_times: list of hours when forecast can be fetched (UTC)
 #  force_charge: 1 = hold battery, 2 = charge for whole period
 
-def charge_needed(forecast=None, update_settings=0, timed_mode=None, show_data=None, show_plot=None, run_after=None, reload=2,
+def charge_needed(forecast=None, consumption=None, update_settings=0, timed_mode=None, show_data=None, show_plot=None, run_after=None, reload=2,
         forecast_times=None, force_charge=0, test_time=None, test_soc=None, test_charge=None, **settings):
     global device, seasonality, solcast_api_key, debug_setting, tariff, solar_arrays, legend_location, time_shift, charge_needed_app_key
     global timed_strategy, steps_per_hour, base_time, storage, battery, battery_params
@@ -2847,6 +2852,9 @@ def charge_needed(forecast=None, update_settings=0, timed_mode=None, show_data=N
         consumption = annual_consumption / 365 * seasonality[now.month - 1] / sum(seasonality) * 12
         consumption_by_hour = daily_consumption
         output(f"\nEstimated consumption: {consumption:.1f}kWh")
+    elif consumption is not None:
+        consumption_by_hour = daily_consumption
+        output(f"\nConsumption: {consumption:.1f}kWh")
     else:
         consumption_days = charge_config['consumption_days']
         consumption_days = 3 if consumption_days > 7 or consumption_days < 1 else consumption_days
@@ -3305,7 +3313,7 @@ def battery_info(log=0, plot=1, rated=None, count=None, info=1, bat=None):
     bat_current = bat['current']
     bat_power = bat['power']
     bms_temperature = bat['temperature']
-    capacity = bat['capacity']
+    capacity = bat.get('capacity')
     cell_volts = get_cell_volts()
     if cell_volts is None:
         output_close()
@@ -3350,7 +3358,8 @@ def battery_info(log=0, plot=1, rated=None, count=None, info=1, bat=None):
                     s +=f",{v:.0f}"
         return s
     output(f"Current SoC:         {current_soc}%")
-    output(f"Capacity:            {capacity:.2f}kWh" + (" (calculated)" if bat['residual_handling'] in [1,3] else ""))
+    if capacity is not None:
+        output(f"Capacity:            {capacity:.2f}kWh" + (" (calculated)" if bat['residual_handling'] in [1,3] else ""))
     output(f"Residual:            {residual:.2f}kWh" + (" (calculated)" if bat['residual_handling'] in [2,3] else ""))
     if rated_capacity is not None and bat_soh is not None:
         output(f"Rated Capacity:      {rated_capacity / 1000:.2f}kWh")

{foxesscloud-2.7.7 → foxesscloud-2.7.9/src/foxesscloud.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxesscloud
-Version: 2.7.7
+Version: 2.7.9
 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
@@ -358,7 +358,9 @@ All the parameters are optional:
 
 charge_needed() uses a number of models to better estimate the state of the battery.
 
-**Manual Consumption:** You can provide your 'annual_consumption' in kWh e.g. 5500. This figure is factored down to a daily consumption by dividing by 365 and applying **f.seasonality**. This normally decreases consumption in the summer and increases it in winter. Seasonality is a list of weightings by month for Jan, Feb, Mar, Apr etc. Preset lists are 'f.high_seasonality' (recommend where electric heating is ued), 'f.medium_seasonality' (default) amd 'f.no_seasonality' (all months the same). The daily consumption is profiled by hour using **f.daily_consumption**. This maps your consumption for a day to the hours when more or less energy is consumed. It is a list of 24 values for the times 00, 01, 02, 03 .. 23. Preset lists are 'f.high_profile' (larger peaks at 8am and 6pm), 'f.medium_profile' (default, more balanced) and 'f.no_profile' (flat).
+**Manual Consumption:** You can provide your expected 'consumption' in kWh e.g. 15. This figure is used directly.
+
+**Annual Consumption:** You can provide your 'annual_consumption' in kWh e.g. 5500. This figure is factored down to a daily consumption by dividing by 365 and applying **f.seasonality**. This normally decreases consumption in the summer and increases it in winter. Seasonality is a list of weightings by month for Jan, Feb, Mar, Apr etc. Preset lists are 'f.high_seasonality' (recommend where electric heating is ued), 'f.medium_seasonality' (default) amd 'f.no_seasonality' (all months the same). The daily consumption is profiled by hour using **f.daily_consumption**. This maps your consumption for a day to the hours when more or less energy is consumed. It is a list of 24 values for the times 00, 01, 02, 03 .. 23. Preset lists are 'f.high_profile' (larger peaks at 8am and 6pm), 'f.medium_profile' (default, more balanced) and 'f.no_profile' (flat).
 
 **Historic Consumption:** If annual_consumption is not provided, your consumption history is used. By default, this looks at your average consumption for the last 3 days using the load power reported by your inverter. For systems with multiple inverters where CT2 is not connected, the load power may not be correct. For this and other cases where you want to set your consumption, provide your annual_consumption.
 
@@ -807,6 +809,13 @@ This setting can be:
 
 # Version Info
 
+2.7.9<br>
+Add 'consumption' input for charge_needed().
+Avoid throwing exception in battery_info() if there is no capacity info.
+
+2.7.8<br>
+Update the battery_params charge rate table to 2025 values.
+
 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.