foxesscloud 2.5.2__tar.gz → 2.5.4__tar.gz

{foxesscloud-2.5.2 → foxesscloud-2.5.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxesscloud
-Version: 2.5.2
+Version: 2.5.4
 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:
 
@@ -525,11 +528,11 @@ This gets the latest 30 minute pricing and uses this to work out the best off pe
 + forecast_times: a list of times when a forecast can be obtained from Solcast / forecast.solar, aligned with the host system time
 + strategy: an optional list of times and work modes (see below)
 + update: optional, 1 (the default) sets the current tariff to Agile Octopus. Setting to 0 does not change the current tariff
-+ weighting: optional, default is None (see below)
++ weighting: optional, default is None / flat (see below)
 + time_shift: optional system time shift in hours. The default is for system time to be UTC and to apply the current day light saving time (e.g. GMT/BST)
 + plunge_price: list of prices in p/kWh when plunge pricing is used (see below). The default is [0, 5].
 + plunge_slots: the number of 30 minute slots to use for plunge pricing. The default is 6, allowing up to 3 hours.
-+ show_data: show 30 minute Agile pricing data. Default is 0.
++ show_data: show 30 minute Agile pricing data. Default is 1.
 + show_plot: plot 30 minute Agile pricing data. Default is 1.
 
 Product codes include: 
@@ -559,9 +562,7 @@ Region codes include:
 Pricing for tomorrow is updated around 5pm each day. If run before this time, prices from yesterday are used. By default, prices for tomorrow are fetched after 5pm. The setting for this is:
 + f.agile_update_time = 17
 
-The best charging period is determined based on the weighted average of the 30 minute prices over the duration. The default is flat (all prices are weighted equally). You can change the weighting by providing 'weighting'. The following preset weightings are provided:
-+ f.front_loaded: [1.0, 0.9, 0.8, 0.7, 0.6, 0.5]
-+ f.first_hour: [1.0, 1.0]
+The best charging period is determined based on the weighted average of the 30 minute prices over the duration. The default is flat (all prices are weighted equally, except the last slot, which is pro rata to the charge duration used). You can over-ride the default weighting by providing a list of 30 minute values to apply.
 
 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'.
@@ -742,7 +743,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 +783,19 @@ This setting can be:
 
 # Version Info
 
+2.5.4<br>
+Remove preset 'weighting' that were not used.
+Update weighting to apply the requested charge duration correctly.
+Reformat price and SoC tables to reduce wrapping and make them easier to read on small screens.
+Change default for set_tariff() to show Agile 30 minute prices.
+
+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.

foxesscloud-2.5.2/src/foxesscloud.egg-info/PKG-INFO → foxesscloud-2.5.4/README.md

@@ -1,17 +1,3 @@
-Metadata-Version: 2.1
-Name: foxesscloud
-Version: 2.5.2
-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:
 
@@ -525,11 +514,11 @@ This gets the latest 30 minute pricing and uses this to work out the best off pe
 + forecast_times: a list of times when a forecast can be obtained from Solcast / forecast.solar, aligned with the host system time
 + strategy: an optional list of times and work modes (see below)
 + update: optional, 1 (the default) sets the current tariff to Agile Octopus. Setting to 0 does not change the current tariff
-+ weighting: optional, default is None (see below)
++ weighting: optional, default is None / flat (see below)
 + time_shift: optional system time shift in hours. The default is for system time to be UTC and to apply the current day light saving time (e.g. GMT/BST)
 + plunge_price: list of prices in p/kWh when plunge pricing is used (see below). The default is [0, 5].
 + plunge_slots: the number of 30 minute slots to use for plunge pricing. The default is 6, allowing up to 3 hours.
-+ show_data: show 30 minute Agile pricing data. Default is 0.
++ show_data: show 30 minute Agile pricing data. Default is 1.
 + show_plot: plot 30 minute Agile pricing data. Default is 1.
 
 Product codes include: 
@@ -559,9 +548,7 @@ Region codes include:
 Pricing for tomorrow is updated around 5pm each day. If run before this time, prices from yesterday are used. By default, prices for tomorrow are fetched after 5pm. The setting for this is:
 + f.agile_update_time = 17
 
-The best charging period is determined based on the weighted average of the 30 minute prices over the duration. The default is flat (all prices are weighted equally). You can change the weighting by providing 'weighting'. The following preset weightings are provided:
-+ f.front_loaded: [1.0, 0.9, 0.8, 0.7, 0.6, 0.5]
-+ f.first_hour: [1.0, 1.0]
+The best charging period is determined based on the weighted average of the 30 minute prices over the duration. The default is flat (all prices are weighted equally, except the last slot, which is pro rata to the charge duration used). You can over-ride the default weighting by providing a list of 30 minute values to apply.
 
 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'.
@@ -742,7 +729,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 +769,19 @@ This setting can be:
 
 # Version Info
 
+2.5.4<br>
+Remove preset 'weighting' that were not used.
+Update weighting to apply the requested charge duration correctly.
+Reformat price and SoC tables to reduce wrapping and make them easier to read on small screens.
+Change default for set_tariff() to show Agile 30 minute prices.
+
+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.

{foxesscloud-2.5.2 → foxesscloud-2.5.4}/pyproject.toml

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