foxesscloud 2.5.1__tar.gz → 2.5.3__tar.gz

{foxesscloud-2.5.1 → foxesscloud-2.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxesscloud
-Version: 2.5.1
+Version: 2.5.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
@@ -71,6 +71,9 @@ If a value is set for f.plot_file, any charts created will also be saved to an i
 
 If you set f.pushover_user_key to your user_key for pushover.net, a summary from set_tariff(), charge_needed(), set_pvoutput() and battery_info() will be sent to your pushover app.
 
+You can set 'f.storage' to a path to save files to a different location such as cloud storage. The default is to use the current working directory.
+
+
 ## User info
 Return information about the current user:
 
@@ -239,7 +242,7 @@ The summary includes the following attributes:
 
 For power values (unit = kW), the summary performs a Riemann sum of the data, integrating kW over the day to estimate energy in kWh. In this case, the following attributes are also added:
 + kwh: the total energy generated or consumed
-+ kwh_off: the total energy consumed or generated during the off-peak time of use (off_peak1, off_peak2, off_peak3)
++ kwh_off: the total energy consumed or generated during the off-peak time of use (off_peak1, off_peak2, off_peak3, off_peak4)
 + kwh_peak: the total energy consumed or generated during the peak time of use (peak1, peak2)
 + kwh_neg: the total energy from -ve power flow (all other totals are based on +ve power flow)
 
@@ -565,7 +568,7 @@ The best charging period is determined based on the weighted average of the 30 m
 
 set_tariff() can configure multiple off-peak and peak periods for any tariff using the 'times' parameter. Times is a list of tuples:
 + containing values for key, 'start', 'end' and optional 'force'.
-+ recongnised keys are: 'off_peak1', 'off_peak2', 'off_peak3', 'peak1', 'peak2'
++ recongnised keys are: 'off_peak1', 'off_peak2', 'off_peak3', 'off_peak4', 'peak1', 'peak2'
 + a tuple containing a key with no values will remove the time period from the tariff.
 
 For example, this parameter configures an AM charging period between 11pm and 8am and a PM charging period between 12 noon and 4pm and removes the time period 'peak2':
@@ -742,7 +745,7 @@ f.get_suntimes(date, utc)
 + date: 'YYYY-MM-DD'
 + utc: 1 = return time in UTC. 0 = return local time (default)
 
-'shading' adjusts the forecast and sets delays and losses caused as the sun rise and set for Solcast and Solar. The forecast is multiplied by 'adjust'. The (AM/PM) delay is the time after sunrise or before sunset that is applied and 'loss' is the amount that the solar forecast is reduced. The default structure above is used by Solcast and Solar when called from charge_needed() or they can be passed directly as parameters when forecasts are being created using 'f.Solcast()' and 'f.Solar()'.
+'shading' adjusts the forecast and sets delays and losses caused as the sun rise and set for Solcast and Solar. The forecast is multiplied by 'adjust'. The (AM/PM) delay is the time after sunrise or before sunset that is applied and 'loss' is the amount that the solar forecast is reduced. The default structure above is used by Solcast and Solar when called from charge_needed() or they can be passed directly as parameters when forecasts are being created using 'f.Solcast()' and 'f.Solar()'. If the delays are presented as a list, they are values for winter, spring, summer and autumn.
 
 
 # Pushover
@@ -782,6 +785,19 @@ This setting can be:
 
 # Version Info
 
+2.5.3<br>
+Reverted change to allow updates during a charge period to avoid removing charge in progress.
+Update contingency and show how this relates to battery SoC.
+Add PV cover, the ratio of PV generation to consumption.
+Add f.storage path so files can be saved to different locations if needed.
+Allow delays in 'shading' to be a seaonal list of 4 values (winter, spring, summer, autumn).
+
+2.5.2<br>
+Updates to allow charge_needed() to run during a charge period.
+Add suport for 'off_peak4' charge period.
+Change Solcast forecast in charge_needed() so it does not get todays estimate to save API calls.
+Include contingency and reserve when checking minimum battery level.
+
 2.5.1<br>
 Fix anomaly in scheduler support when get_device and get_flag return different results.
 Add 'show_data' to charge_compare() and display run time and starting SoC.

foxesscloud-2.5.1/src/foxesscloud.egg-info/PKG-INFO → foxesscloud-2.5.3/README.md

@@ -1,17 +1,3 @@
-Metadata-Version: 2.1
-Name: foxesscloud
-Version: 2.5.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
-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>
@@ -71,6 +57,9 @@ If a value is set for f.plot_file, any charts created will also be saved to an i
 
 If you set f.pushover_user_key to your user_key for pushover.net, a summary from set_tariff(), charge_needed(), set_pvoutput() and battery_info() will be sent to your pushover app.
 
+You can set 'f.storage' to a path to save files to a different location such as cloud storage. The default is to use the current working directory.
+
+
 ## User info
 Return information about the current user:
 
@@ -239,7 +228,7 @@ The summary includes the following attributes:
 
 For power values (unit = kW), the summary performs a Riemann sum of the data, integrating kW over the day to estimate energy in kWh. In this case, the following attributes are also added:
 + kwh: the total energy generated or consumed
-+ kwh_off: the total energy consumed or generated during the off-peak time of use (off_peak1, off_peak2, off_peak3)
++ kwh_off: the total energy consumed or generated during the off-peak time of use (off_peak1, off_peak2, off_peak3, off_peak4)
 + kwh_peak: the total energy consumed or generated during the peak time of use (peak1, peak2)
 + kwh_neg: the total energy from -ve power flow (all other totals are based on +ve power flow)
 
@@ -565,7 +554,7 @@ The best charging period is determined based on the weighted average of the 30 m
 
 set_tariff() can configure multiple off-peak and peak periods for any tariff using the 'times' parameter. Times is a list of tuples:
 + containing values for key, 'start', 'end' and optional 'force'.
-+ recongnised keys are: 'off_peak1', 'off_peak2', 'off_peak3', 'peak1', 'peak2'
++ recongnised keys are: 'off_peak1', 'off_peak2', 'off_peak3', 'off_peak4', 'peak1', 'peak2'
 + a tuple containing a key with no values will remove the time period from the tariff.
 
 For example, this parameter configures an AM charging period between 11pm and 8am and a PM charging period between 12 noon and 4pm and removes the time period 'peak2':
@@ -742,7 +731,7 @@ f.get_suntimes(date, utc)
 + date: 'YYYY-MM-DD'
 + utc: 1 = return time in UTC. 0 = return local time (default)
 
-'shading' adjusts the forecast and sets delays and losses caused as the sun rise and set for Solcast and Solar. The forecast is multiplied by 'adjust'. The (AM/PM) delay is the time after sunrise or before sunset that is applied and 'loss' is the amount that the solar forecast is reduced. The default structure above is used by Solcast and Solar when called from charge_needed() or they can be passed directly as parameters when forecasts are being created using 'f.Solcast()' and 'f.Solar()'.
+'shading' adjusts the forecast and sets delays and losses caused as the sun rise and set for Solcast and Solar. The forecast is multiplied by 'adjust'. The (AM/PM) delay is the time after sunrise or before sunset that is applied and 'loss' is the amount that the solar forecast is reduced. The default structure above is used by Solcast and Solar when called from charge_needed() or they can be passed directly as parameters when forecasts are being created using 'f.Solcast()' and 'f.Solar()'. If the delays are presented as a list, they are values for winter, spring, summer and autumn.
 
 
 # Pushover
@@ -782,6 +771,19 @@ This setting can be:
 
 # Version Info
 
+2.5.3<br>
+Reverted change to allow updates during a charge period to avoid removing charge in progress.
+Update contingency and show how this relates to battery SoC.
+Add PV cover, the ratio of PV generation to consumption.
+Add f.storage path so files can be saved to different locations if needed.
+Allow delays in 'shading' to be a seaonal list of 4 values (winter, spring, summer, autumn).
+
+2.5.2<br>
+Updates to allow charge_needed() to run during a charge period.
+Add suport for 'off_peak4' charge period.
+Change Solcast forecast in charge_needed() so it does not get todays estimate to save API calls.
+Include contingency and reserve when checking minimum battery level.
+
 2.5.1<br>
 Fix anomaly in scheduler support when get_device and get_flag return different results.
 Add 'show_data' to charge_compare() and display run time and starting SoC.

{foxesscloud-2.5.1 → foxesscloud-2.5.3}/pyproject.toml

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