foxesscloud 2.6.8__tar.gz → 2.7.0__tar.gz

{foxesscloud-2.6.8 → foxesscloud-2.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxesscloud
-Version: 2.6.8
+Version: 2.7.0
 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
@@ -104,8 +104,8 @@ Once an inverter is selected, you can make other calls to get information:
 
 ```
 f.get_generation()
-f.get_battery()
-f.get_batteries()
+f.get_battery(info, rated, count)
+f.get_batteries(info, rated, count)
 f.get_settings()
 f.get_charge()
 f.get_min()
@@ -119,7 +119,12 @@ Each of these calls will return a dictionary or list containing the relevant inf
 get_generation() will return the latest generation information for the device. The results are also stored in f.device as 'generationToday', 'generationMonth' and 'generationTotal'.
 
 get_battery() / get_batteries() returns the current battery status, including 'soc', 'volt', 'current', 'power', 'temperature' and 'residual'. The result also updates f.battery / f.batteries.
-get_batteries() returns multiple batteries (if available) as a list. get_battery() returns the first battery. Additional battery attributes include:
+get_batteries() returns multiple batteries (if available) as a list. get_battery() returns the first battery. Parameters:
++ 'info': get battery serial number info, if available. Default 0 (not available via Open API)
++ 'rated': optional rated capacity for the battery in Wh to work out SoH. If not provided, it will try to work this out.
++ 'count': optional battery count. If not provided, it will try to work this out.
+
+Additional battery attributes provided include:
 + 'capacity': the estimated battery capacity, derrived from 'residual' and 'soc'
 + 'charge_rate': the estimated BMS charge rate available, based on the current 'temperature' of the BMS
 + 'charge_loss': the ratio of the kWh added to the battery for each kWh applied during charging
@@ -145,7 +150,7 @@ f.set_charge(ch1, st1, en1, ch2, st2, en2, enable)
 f.set_period(start, end, mode, min_soc, max_soc, fdsoc, fdpwr, price, segment)
 f.charge_periods(st0, en0, st1, en1, st2, en2, min_soc, target_soc, start_soc)
 f.set_schedule(periods, enable)
-f.set_named_settings(name, value)
+f.set_named_settings(name, value, force)
 ```
 
 set_min() applies new SoC settings to the inverter. The parameters update battery_settings:
@@ -188,7 +193,9 @@ 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.
-+ the only 'name' currently supported by Fox is 'ExportLimit' on H3 inverters
++ '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'
 
 
 ## Real Time Data
@@ -334,7 +341,7 @@ The previous section provides functions that can be used to access and control y
 Uses forecast PV yield for tomorrow to work out if charging from grid is needed tonight to deliver the expected consumption for tomorrow. If charging is needed, the charge times are configured. If charging is not needed, the charge times are cleared. The results are sent to the inverter.
 
 ```
-f.charge_needed(forecast, force_charge, forecast_selection, forecast_times, update_setings, show_data, show_plot)
+f.charge_needed(forecast, force_charge, forecast_selection, forecast_times, update_setings, show_data, show_plot, timed_mode)
 ```
 
 All the parameters are optional:
@@ -345,6 +352,7 @@ All the parameters are optional:
 + update_settings: 0 no changes, 1 update charge settings. The default is 0
 + show_data: 1 show battery SoC data, 2 show battery Residual data, 3 show timed data. The default is 1.
 + show_plot: 1 plot battery SoC data. 2 plot battery Residual, Generation and Consumption. 3 plot 2 + Charge and Discharge The default is 3
++ timed_mode: 0 use charge times, 1 use charge times and follow strategy, 2 use Mode Scheduler
 
 ### Modelling
 
@@ -387,6 +395,8 @@ export_limit: None             # maximum export power in kW. None uses the inver
 dc_ac_loss: 0.970              # loss converting battery DC power to AC grid power
 pv_loss: 0.950                 # loss converting PV power to DC battery charge power
 ac_dc_loss: 0.960              # loss converting AC grid power to DC battery charge power
+charge_loss: None              # loss converting charge energy to stored energy
+discharge_loss: None           # loss converting stored energy to discharge energy
 inverter_power: None           # inverter power consumption in W (dynamically set)
 bms_power: 50                  # BMS power consumption in W
 force_charge_power: 5.00       # power used when Force Charge is scheduled
@@ -797,6 +807,19 @@ This setting can be:
 
 # Version Info
 
+2.7.0<br>
+Allow charge_loss / discharge_loss to be configured for charge_needed().
+Change 'Force Charge' to 'Battery Hold' in charge times to avoid confusion with Force Charge work mode.
+Correct problem with missing periods of actual data in forecast.compare()
+
+2.6.9<br>
+Add get and set_named_settings() (for WorkMode and ExportLimit).
+If a list of named settings is provided, the return value is a list indicating which settings succeeded (1) or failed (0).
+Updates to get_battery() / get_batteries() to add optional rated and count parameters.
+Updates to charge_needed() to end prediction at start of next charge period.
+Correct charge time for Octopus Go tariff.
+Update charge_needed() to show contingency achieved rather than requested.
+
 2.6.8<br>
 Add residual_handling=3 for Mira BMS with firmware 1.014 or later that returns residual capacity per battery.
 Calculate 'ratedCapacity' in get_battery() and 'soh' for HV2600 and Mira.

foxesscloud-2.6.8/src/foxesscloud.egg-info/PKG-INFO → foxesscloud-2.7.0/README.md

@@ -1,17 +1,3 @@
-Metadata-Version: 2.1
-Name: foxesscloud
-Version: 2.6.8
-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
-Project-URL: Bug Tracker, https://github.com/TonyM1958/FoxESS-Cloud/issues
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENCE
-
 # FoxESS-Cloud
 
 <a href="https://www.buymeacoffee.com/tonym1958" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174" align="right"></a>
@@ -104,8 +90,8 @@ Once an inverter is selected, you can make other calls to get information:
 
 ```
 f.get_generation()
-f.get_battery()
-f.get_batteries()
+f.get_battery(info, rated, count)
+f.get_batteries(info, rated, count)
 f.get_settings()
 f.get_charge()
 f.get_min()
@@ -119,7 +105,12 @@ Each of these calls will return a dictionary or list containing the relevant inf
 get_generation() will return the latest generation information for the device. The results are also stored in f.device as 'generationToday', 'generationMonth' and 'generationTotal'.
 
 get_battery() / get_batteries() returns the current battery status, including 'soc', 'volt', 'current', 'power', 'temperature' and 'residual'. The result also updates f.battery / f.batteries.
-get_batteries() returns multiple batteries (if available) as a list. get_battery() returns the first battery. Additional battery attributes include:
+get_batteries() returns multiple batteries (if available) as a list. get_battery() returns the first battery. Parameters:
++ 'info': get battery serial number info, if available. Default 0 (not available via Open API)
++ 'rated': optional rated capacity for the battery in Wh to work out SoH. If not provided, it will try to work this out.
++ 'count': optional battery count. If not provided, it will try to work this out.
+
+Additional battery attributes provided include:
 + 'capacity': the estimated battery capacity, derrived from 'residual' and 'soc'
 + 'charge_rate': the estimated BMS charge rate available, based on the current 'temperature' of the BMS
 + 'charge_loss': the ratio of the kWh added to the battery for each kWh applied during charging
@@ -145,7 +136,7 @@ f.set_charge(ch1, st1, en1, ch2, st2, en2, enable)
 f.set_period(start, end, mode, min_soc, max_soc, fdsoc, fdpwr, price, segment)
 f.charge_periods(st0, en0, st1, en1, st2, en2, min_soc, target_soc, start_soc)
 f.set_schedule(periods, enable)
-f.set_named_settings(name, value)
+f.set_named_settings(name, value, force)
 ```
 
 set_min() applies new SoC settings to the inverter. The parameters update battery_settings:
@@ -188,7 +179,9 @@ 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.
-+ the only 'name' currently supported by Fox is 'ExportLimit' on H3 inverters
++ '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'
 
 
 ## Real Time Data
@@ -334,7 +327,7 @@ The previous section provides functions that can be used to access and control y
 Uses forecast PV yield for tomorrow to work out if charging from grid is needed tonight to deliver the expected consumption for tomorrow. If charging is needed, the charge times are configured. If charging is not needed, the charge times are cleared. The results are sent to the inverter.
 
 ```
-f.charge_needed(forecast, force_charge, forecast_selection, forecast_times, update_setings, show_data, show_plot)
+f.charge_needed(forecast, force_charge, forecast_selection, forecast_times, update_setings, show_data, show_plot, timed_mode)
 ```
 
 All the parameters are optional:
@@ -345,6 +338,7 @@ All the parameters are optional:
 + update_settings: 0 no changes, 1 update charge settings. The default is 0
 + show_data: 1 show battery SoC data, 2 show battery Residual data, 3 show timed data. The default is 1.
 + show_plot: 1 plot battery SoC data. 2 plot battery Residual, Generation and Consumption. 3 plot 2 + Charge and Discharge The default is 3
++ timed_mode: 0 use charge times, 1 use charge times and follow strategy, 2 use Mode Scheduler
 
 ### Modelling
 
@@ -387,6 +381,8 @@ export_limit: None             # maximum export power in kW. None uses the inver
 dc_ac_loss: 0.970              # loss converting battery DC power to AC grid power
 pv_loss: 0.950                 # loss converting PV power to DC battery charge power
 ac_dc_loss: 0.960              # loss converting AC grid power to DC battery charge power
+charge_loss: None              # loss converting charge energy to stored energy
+discharge_loss: None           # loss converting stored energy to discharge energy
 inverter_power: None           # inverter power consumption in W (dynamically set)
 bms_power: 50                  # BMS power consumption in W
 force_charge_power: 5.00       # power used when Force Charge is scheduled
@@ -797,6 +793,19 @@ This setting can be:
 
 # Version Info
 
+2.7.0<br>
+Allow charge_loss / discharge_loss to be configured for charge_needed().
+Change 'Force Charge' to 'Battery Hold' in charge times to avoid confusion with Force Charge work mode.
+Correct problem with missing periods of actual data in forecast.compare()
+
+2.6.9<br>
+Add get and set_named_settings() (for WorkMode and ExportLimit).
+If a list of named settings is provided, the return value is a list indicating which settings succeeded (1) or failed (0).
+Updates to get_battery() / get_batteries() to add optional rated and count parameters.
+Updates to charge_needed() to end prediction at start of next charge period.
+Correct charge time for Octopus Go tariff.
+Update charge_needed() to show contingency achieved rather than requested.
+
 2.6.8<br>
 Add residual_handling=3 for Mira BMS with firmware 1.014 or later that returns residual capacity per battery.
 Calculate 'ratedCapacity' in get_battery() and 'soh' for HV2600 and Mira.

{foxesscloud-2.6.8 → foxesscloud-2.7.0}/pyproject.toml

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