foxesscloud 2.5.3__py3-none-any.whl → 2.5.5__py3-none-any.whl

foxesscloud/foxesscloud.py

@@ -1,7 +1,7 @@
 ##################################################################################################
 """
 Module:   Fox ESS Cloud
-Updated:  23 September 2024
+Updated:  26 September 2024
 By:       Tony Matthews
 """
 ##################################################################################################
@@ -10,7 +10,7 @@ By:       Tony Matthews
 # ALL RIGHTS ARE RESERVED © Tony Matthews 2023
 ##################################################################################################
 
-version = "1.6.5"
+version = "1.6.7"
 print(f"FoxESS-Cloud version {version}")
 
 debug_setting = 1
@@ -721,7 +721,7 @@ def set_charge(ch1=None, st1=None, en1=None, ch2=None, st2=None, en2=None, force
         output(f"success", 2) 
     return battery_settings
 
-def charge_periods(st1=None, en1=None, st2=None, en2=None, min_soc=10, target_soc=100, start_soc=10):
+def charge_periods(st1=None, en1=None, st2=None, en2=None, min_soc=10, end_soc=100, start_soc=10):
     output(f"\nConfiguring schedule",1)
     charge = []
     st1 = time_hours(st1)
@@ -730,7 +730,7 @@ def charge_periods(st1=None, en1=None, st2=None, en2=None, min_soc=10, target_so
     en2 = time_hours(en2)
     span = None
     if st2 is not None and en2 is not None and st2 != en2:
-        charge.append({'start': st2, 'end': en2, 'mode': 'ForceCharge', 'min_soc': min_soc, 'max_soc': target_soc})
+        charge.append({'start': st2, 'end': en2, 'mode': 'ForceCharge', 'min_soc': min_soc, 'max_soc': end_soc})
         span = {'start': st2, 'end': en2}
         if st1 is not None and en1 is not None and st1 != en1:
             charge.append({'start': st1, 'end': en1, 'mode': 'SelfUse', 'min_soc': start_soc})
@@ -2221,6 +2221,7 @@ def get_strategy(use=None, strategy=None, quiet=1, remove=None, reserve=0):
         if use.get('agile') is not None and use['agile'].get('strategy') is not None:
             base_time_adjust = hours_difference(base_time, use['agile'].get('base_time') )
             for s in use['agile']['strategy']:
+                s['valid_for'] = [int((s['hour'] - base_time_adjust) * steps_per_hour + i) for i in range(0, steps_per_hour // 2)] if s.get('hour') is not None else None
                 strategy.append(s)
     if strategy is None or len(strategy) == 0:
         return []
@@ -2230,7 +2231,7 @@ def get_strategy(use=None, strategy=None, quiet=1, remove=None, reserve=0):
         start = s['start']
         end = s['end']
         if hour_overlap(s, remove):
-            output(f"   {hours_time(start)}-{hours_time(end)} ** removed ** (overlaps charge period)", 2)
+            output(f"   {hours_time(start)}-{hours_time(end)} was removed from strategy", 2)
             continue
         # add segment
         min_soc_now = s['min_soc'] if s.get('min_soc') is not None and s['min_soc'] > 10 else 10
@@ -2239,9 +2240,9 @@ def get_strategy(use=None, strategy=None, quiet=1, remove=None, reserve=0):
         fdsoc = s.get('fdsoc')
         fdpwr = s.get('fdpwr')
         price = s.get('price')
-        expires = int((s['valid_to'] - base_time_adjust) * steps_per_hour) if s.get('valid_to') is not None else None
+        valid_for = s.get('valid_for')
         segment = {'start': start, 'end': end, 'mode': mode, 'min_soc': min_soc_now, 'max_soc': max_soc,
-            'fdsoc': fdsoc, 'fdpwr': fdpwr, 'price': price, 'expires': expires}
+            'fdsoc': fdsoc, 'fdpwr': fdpwr, 'price': price, 'valid_for': valid_for}
         if quiet == 0:
             s = f"   {hours_time(start)}-{hours_time(end)} {mode}, min_soc {min_soc_now}%"
             s += f", max_soc {max_soc}%" if max_soc is not None else ""
@@ -2264,11 +2265,6 @@ regions = {'A':'Eastern England', 'B':'East Midlands', 'C':'London', 'D':'Mersey
     'J':'South Eastern England', 'K':'Southern Wales', 'L':'South Western England', 'M':'Yorkshire', 'N':'Southern Scotland', 'P':'Northern Scotland'}
 
 
-# preset weightings for average 30 minute pricing over charging duration:
-front_loaded = [1.0, 0.9, 0.8, 0.7, 0.6, 0.5]           # 3 hour average, front loaded
-first_hour =   [1.0, 1.0]                               # lowest average price for first hour
-
-
 tariff_config = {
     'product': "AGILE-24-04-03",          # product code to use for Octopus API
     'region': "H",                        # region code to use for Octopus API
@@ -2277,7 +2273,7 @@ tariff_config = {
     'plunge_price': [1, 10],              # plunge price in p/kWh inc VAT over 24 hours from 7am, 7pm
     'plunge_slots': 6,                    # number of 30 minute slots to use
     'data_wrap': 6,                       # prices to show per line
-    'show_data': 0,                       # show pricing data
+    'show_data': 1,                       # show pricing data
     'show_plot': 1                        # plot pricing data
 }
 
@@ -2322,21 +2318,22 @@ def get_agile_times(tariff=agile_octopus, d=None):
     # extract times and prices. Times are Zulu (UTC)
     prices = []         # ordered list of 30 minute prices
     for i in range(0, len(results)):
-        start = (now.hour + i / 2) % 24
+        hour = i / 2
+        start = (now.hour + hour) % 24
         time_offset = daylight_saving(results[i]['valid_from'][:16]) if daylight_saving is not None else 0
         prices.append({
             'start': start,
             'end': round_time(start + 0.5),
             'time': hours_time(time_hours(results[i]['valid_from'][11:16]) + time_offset + time_shift),
             'price': results[i]['value_inc_vat'],
-            'valid_to': i / 2 + 0.5})
+            'hour': hour})
     tariff['agile']['base_time'] = period_from.replace('T', ' ')
     tariff['agile']['prices'] = prices
     plunge = []
     plunge_price = tariff_config['plunge_price'] if tariff_config.get('plunge_price') is not None else 2
     plunge_price = [plunge_price] if type(plunge_price) is not list else plunge_price
     plunge_slots = tariff_config['plunge_slots'] if tariff_config.get('plunge_slots') is not None else 6
-    for i in range(0, min([48, len(prices)])):
+    for i in range(0, len(prices)):
         # hour relative index into list of plunge prices, starting at 7am
         x = int(((now.hour - 7 + i / 2) % 24) * len(plunge_price) / 24)
         if prices[i] is not None and prices[i]['price'] < plunge_price[x]:
@@ -2361,13 +2358,13 @@ def get_agile_times(tariff=agile_octopus, d=None):
     # show the results
     if tariff_config['show_data'] > 0:
         data_wrap = tariff_config['data_wrap'] if tariff_config.get('data_wrap') is not None else 6
-        t = (now.hour * 2) % data_wrap
-        s = f"\nPricing on {today} p/kWh inc VAT:\n" + " " * t * 13
+        col = (now.hour * 2) % data_wrap
+        s = f"\nPrice p/kWh inc VAT on {today}:"
         for i in range(0, len(prices)):
-            s += "\n" if i > 0 and t % data_wrap == 0 else ""
-            s += f"  {prices[i]['time']} {prices[i]['price']:4.1f},"
-            t += 1
-        output(s[:-1])
+            s += (f"\n  {prices[i]['time']} " + " " * col * 6) if i == 0 or col == 0 else ""
+            s += f"  {prices[i]['price']:4.1f}"
+            col = (col + 1) % data_wrap
+        output(s)
     if tariff_config['show_plot'] > 0:
         plt.figure(figsize=(figure_width, figure_width/2))
         x_timed = [i for i in range(0, len(prices))]
@@ -2394,7 +2391,8 @@ def get_best_charge_period(start, duration):
     key = [k for k in ['off_peak1', 'off_peak2', 'off_peak3', 'off_peak4'] if hour_in(start, tariff.get(k))]
     key = key[0] if len(key) > 0 else None
     end = tariff[key]['end'] if key is not None else round_time(start + duration)
-    span = int(duration * 2 + 0.99)
+    span = int(duration * 2 + 0.99)         # number of slots needed for charging
+    last = (duration * 2) % 1               # amount of last slot used for charging
     coverage = max([round_time(end - start), duration])
     period = {'start': start, 'end': round_time(start + coverage)}
     prices = tariff['agile']['prices']
@@ -2403,13 +2401,14 @@ def get_best_charge_period(start, duration):
         return None
     elif len(slots) == 1:
         best = slots
-        price = prices[slots[0]]['price']
         best_start = start
+        price = prices[best[0]]['price']
     else:
         # best charge time for duration
         weighting = tariff_config.get('weighting')
         times = []
-        weights = ([1.0] * span) if weighting is None else (weighting + [1.0] * span)[:span]
+        weights = ([1.0] * (span)) if weighting is None else (weighting + [1.0] * span)[:span]
+        weights[-1] *= last if last > 0.0 else 1.0
         best = None
         price = None
         for i in range(0, len(slots) - span + 1):
@@ -2594,7 +2593,7 @@ def strategy_timed(timed_mode, base_hour, run_time, min_soc=10, max_soc=100, cur
         if strategy is not None:
             period['mode'] = 'SelfUse'
             for d in strategy:
-                if hour_in(h, d) and (d.get('expires') is None or i < d['expires']):
+                if hour_in(h, d) and (d.get('valid_for') is None or i in d['valid_for']):
                     mode = d['mode']
                     period['mode'] = mode
                     min_soc_now = d['min_soc'] if d.get('min_soc') is not None else min_soc
@@ -2964,7 +2963,7 @@ def charge_needed(forecast=None, update_settings=0, timed_mode=None, show_data=N
             solcast_value = fsolcast.daily[forecast_day]['kwh']
             solcast_timed = forecast_value_timed(fsolcast, today, tomorrow, base_hour, run_time, time_offset)
             solcast_from = time_hours(fsolcast.daily[today]['from']) if fsolcast.daily[today].get('from') is not None else 0
-            output(f"\nSolcast forecast for {tomorrow}: {fsolcast.daily[tomorrow]['kwh']:.1f}")    # get forecast.solar data and produce time line
+            output(f"\nSolcast: {tomorrow} {fsolcast.daily[tomorrow]['kwh']:.1f}kWh")    # get forecast.solar data and produce time line
     solar_value = None
     solar_profile = None
     if forecast is None and solar_arrays is not None and (system_time.hour in forecast_times or run_after == 0):
@@ -2972,7 +2971,7 @@ def charge_needed(forecast=None, update_settings=0, timed_mode=None, show_data=N
         if fsolar is not None and hasattr(fsolar, 'daily') and fsolar.daily.get(forecast_day) is not None:
             solar_value = fsolar.daily[forecast_day]['kwh']
             solar_timed = forecast_value_timed(fsolar, today, tomorrow, base_hour, run_time, 0)
-            output(f"\nSolar forecast for {tomorrow}: {fsolar.daily[tomorrow]['kwh']:.1f}")
+            output(f"\nSolar: {tomorrow} {fsolar.daily[tomorrow]['kwh']:.1f}kWh")
     if solcast_value is None and solar_value is None and debug_setting > 1:
         output(f"\nNo forecasts available at this time")
     # get generation data
@@ -3061,19 +3060,18 @@ def charge_needed(forecast=None, update_settings=0, timed_mode=None, show_data=N
     start_residual = interpolate(time_to_start, bat_timed)      # residual when charge time starts
     start_soc = int(start_residual / capacity * 100 + 0.5)
     end_residual = interpolate(time_to_end, bat_timed)          # residual when charge time ends without charging
-    target_soc = charge_config['target_soc'] if charge_config.get('target_soc') is not None else None
-    target_kwh = target_soc / 100 * capacity if target_soc is not None else 0
+    target_soc = charge_config.get('target_soc')
+    target_kwh = capacity if full_charge is not None or force_charge == 2 else (target_soc / 100 * capacity) if target_soc is not None else 0
     if target_kwh > (end_residual + kwh_needed):
         kwh_needed = target_kwh - end_residual
-    elif full_charge is not None or force_charge == 2:
-        kwh_needed = capacity - start_residual
     elif test_charge is not None:
         output(f"\nTest charge of {test_charge}kWh")
         kwh_needed = test_charge
         charge_message = "** test charge **"
     # work out charge needed
-    if kwh_min > (reserve + kwh_contingency) and kwh_needed < charge_config['min_kwh']:
-        output(f"\nNo charging needed ({today} {hours_time(hour_now)} {current_soc:.0f}%)")
+    if kwh_min > (reserve + kwh_contingency) and kwh_needed < charge_config['min_kwh'] and test_charge is None:
+        output(f"\nNo charging needed:")
+        output(f"  SoC now:     {current_soc:.0f}% at {hours_time(hour_now)} on {today}")
         charge_message = "no charge needed"
         kwh_needed = 0.0
         hours = 0.0
@@ -3086,26 +3084,32 @@ def charge_needed(forecast=None, update_settings=0, timed_mode=None, show_data=N
                 work_mode_timed[t]['min_soc'] = start_soc
     else:
         if test_charge is None:
-            output(f"\nCharge needed {kwh_needed:.2f}kWh ({today} {hours_time(hour_now)} {current_soc:.0f}%)")
+            output(f"\nCharge needed {kwh_needed:.2f}kWh:")
             charge_message = "with charge added"
-        output(f"  Start SoC:   {start_residual / capacity * 100:.0f}% at {hours_time(adjusted_hour(time_to_start, time_line))} ({start_residual:.2f}kWh)")
+        output(f"  SoC now:     {current_soc:.0f}% at {hours_time(hour_now)} on {today}")
         # work out time to add kwh_needed to battery
-        taper_time = 10/60 if (start_residual + kwh_needed) >= (capacity * 0.95) else 0
-        hours = round_time(kwh_needed / (charge_power * charge_loss) + taper_time)
-        # charge time exceeded or charge needed exceeds capacity
-        if hours > charge_time or (start_residual + kwh_needed) > capacity:
-            kwh_needed = capacity - start_residual
-            hours = charge_time
-        elif hours < charge_config['min_hours']:
+        charge_rate = charge_power * charge_loss
+        hours = round_time(kwh_needed / charge_rate)
+        # check if charge time exceeded or charge needed exceeds capacity
+        hours_to_full = round_time((capacity - start_residual) / (charge_rate) + 10)
+        if hours < charge_config['min_hours']:
             hours = charge_config['min_hours']
-        end_soc = min([int((start_residual + kwh_needed) / capacity * 100 + 0.5), 100])
+        elif hours > charge_time:
+            hours = charge_time
+        elif hours > hours_to_full:
+            kwh_shortfall = (hours - hours_to_full) * charge_rate        # amount of energy that won't be added
+            required = hours_to_full + charge_time * kwh_shortfall / (end_residual - start_residual)  # time to recover energy not added
+            hours = required if required < charge_time else charge_time
         # rework charge and discharge
         charge_period = get_best_charge_period(start_at, hours)
         charge_offset = round_time(charge_period['start'] - start_at) if charge_period is not None else 0
         price = charge_period.get('price') if charge_period is not None else None
         start_timed = time_to_start + charge_offset * steps_per_hour
         end_timed = (start_timed + hours * steps_per_hour) if force_charge == 0 else time_to_end
-        output(f"  Charge:      {hours_time(adjusted_hour(start_timed, time_line))}-{hours_time(adjusted_hour(end_timed, time_line))}" + (f" at {price:5.2f}p/kWh" if price is not None else ""))
+        start_residual = interpolate(start_timed, bat_timed)
+        end_soc = min([int((start_residual + kwh_needed) / capacity * 100 + 0.5), 100])
+        output(f"  Start SoC:   {start_residual / capacity * 100:.0f}% at {hours_time(adjusted_hour(start_timed, time_line))} ({start_residual:.2f}kWh)")
+        output(f"  Charge to:   {end_soc:.0f} {hours_time(adjusted_hour(start_timed, time_line))}-{hours_time(adjusted_hour(end_timed, time_line))}" + (f" at {price:5.2f}p/kWh" if price is not None else ""))
         for i in range(int(time_to_start), int(end_timed) + 1):
             j = i + 1
             # work out time (fraction of hour) when charging in hour from i to j
@@ -3136,17 +3140,16 @@ def charge_needed(forecast=None, update_settings=0, timed_mode=None, show_data=N
         output(f"  PV cover:    {expected / consumption * 100:.0f}% ({expected:.1f}/{consumption:.1f})")
     if show_data > 0:
         data_wrap = charge_config['data_wrap'] if charge_config.get('data_wrap') is not None else 6
-        s = f"\nBattery Energy kWh:\n" if show_data == 2 else f"\nBattery SoC:\n"
+        s = f"\nBattery Energy kWh:" if show_data == 2 else f"\nBattery SoC:"
         h = base_hour + 1
         t = steps_per_hour
-        s += " " * (14 if show_data == 2 else 13) * (h % data_wrap)
         while t < len(time_line) and bat_timed[t] is not None:
-            s += "\n" if t > steps_per_hour and h % data_wrap == 0 else ""
-            s += f"  {hours_time(time_line[t])}"
-            s += f" {bat_timed[t]:5.2f}" if show_data == 2 else f" {bat_timed[t] / capacity * 100:3.0f}%,"
+            col = h % data_wrap
+            s += (f"\n  {hours_time(time_line[t])}" + " " * col *  6) if t == steps_per_hour or col == 0 else ""
+            s += f" {bat_timed[t]:5.2f}" if show_data == 2 else f"  {bat_timed[t] / capacity * 100:3.0f}%"
             h += 1
             t += steps_per_hour
-        output(s[:-1])
+        output(s)
     if show_plot > 0:
         print()
         plt.figure(figsize=(figure_width, figure_width/2))
@@ -3198,7 +3201,7 @@ def charge_needed(forecast=None, update_settings=0, timed_mode=None, show_data=N
         end1 = start1 if force_charge == 0 else start2
         end2 = round_time(base_hour + (end_timed if force_charge == 0 else time_to_end) / steps_per_hour)
         if timed_mode > 1:
-            periods = charge_periods(st1=start1, en1=end1, st2=start2, en2=end2, min_soc=min_soc, target_soc=end_soc, start_soc=start_soc)
+            periods = charge_periods(st1=start1, en1=end1, st2=start2, en2=end2, min_soc=min_soc, end_soc=end_soc, start_soc=start_soc)
             set_schedule(periods = periods)
         else:
             set_charge(ch1=False, st1=start1, en1=end1, ch2=True, st2=start2, en2=end2, force=1)
@@ -3274,17 +3277,16 @@ def charge_compare(save=None, v=None, show_data=1, show_plot=3):
             plots[v][i] = plots[v][i] / count[v][i] if count[v][i] > 0 else None
     if show_data > 0 and plots.get('SoC') is not None:
         data_wrap = charge_config['data_wrap'] if charge_config.get('data_wrap') is not None else 6
-        s = f"\nBattery Energy kWh:\n" if show_data == 2 else f"\nBattery SoC:\n"
+        s = f"\nBattery Energy kWh:" if show_data == 2 else f"\nBattery SoC:"
         h = base_hour + 1
         t = steps_per_hour
-        s += " " * (14 if show_data == 2 else 13) * (h % data_wrap)
-        while t < len(time_line) and plots['SoC'][t] is not None:
-            s += "\n" if t > steps_per_hour and h % data_wrap == 0 else ""
-            s += f"  {hours_time(time_line[t])}"
-            s += f" {plots['SoC'][t]:5.2f}" if show_data == 2 else f" {plots['SoC'][t] / capacity * 100:3.0f}%,"
+        while t < len(time_line) and bat_timed[t] is not None:
+            col = h % data_wrap
+            s += (f"\n  {hours_time(time_line[t])}" + " " * col * 6) if t == steps_per_hour or col == 0 else ""
+            s += f" {plots['SoC'][t]:5.2f}" if show_data == 2 else f"  {plots['SoC'][t] / capacity * 100:3.0f}%"
             h += 1
             t += steps_per_hour
-        print(s[:-1])
+        print(s)
     if show_plot > 0:
         print()
         plt.figure(figsize=(figure_width, figure_width/2))

foxesscloud/openapi.py

@@ -1,7 +1,7 @@
 ##################################################################################################
 """
 Module:   Fox ESS Cloud using Open API
-Updated:  23 September 2024
+Updated:  26 September 2024
 By:       Tony Matthews
 """
 ##################################################################################################
@@ -10,7 +10,7 @@ By:       Tony Matthews
 # ALL RIGHTS ARE RESERVED © Tony Matthews 2024
 ##################################################################################################
 
-version = "2.5.3"
+version = "2.5.5"
 print(f"FoxESS-Cloud Open API version {version}")
 
 debug_setting = 1
@@ -669,7 +669,7 @@ def set_charge(ch1=None, st1=None, en1=None, ch2=None, st2=None, en2=None, force
         output(f"success", 2) 
     return battery_settings
 
-def charge_periods(st1=None, en1=None, st2=None, en2=None, min_soc=10, target_soc=100, start_soc=10):
+def charge_periods(st1=None, en1=None, st2=None, en2=None, min_soc=10, end_soc=100, start_soc=10):
     output(f"\nConfiguring schedule",1)
     charge = []
     st1 = time_hours(st1)
@@ -678,7 +678,7 @@ def charge_periods(st1=None, en1=None, st2=None, en2=None, min_soc=10, target_so
     en2 = time_hours(en2)
     span = None
     if st2 is not None and en2 is not None and st2 != en2:
-        charge.append({'start': st2, 'end': en2, 'mode': 'ForceCharge', 'min_soc': min_soc, 'max_soc': target_soc})
+        charge.append({'start': st2, 'end': en2, 'mode': 'ForceCharge', 'min_soc': min_soc, 'max_soc': end_soc})
         span = {'start': st2, 'end': en2}
         if st1 is not None and en1 is not None and st1 != en1:
             charge.append({'start': st1, 'end': en1, 'mode': 'SelfUse', 'min_soc': start_soc})
@@ -2085,6 +2085,7 @@ def get_strategy(use=None, strategy=None, quiet=1, remove=None, reserve=0):
         if use.get('agile') is not None and use['agile'].get('strategy') is not None:
             base_time_adjust = hours_difference(base_time, use['agile'].get('base_time') )
             for s in use['agile']['strategy']:
+                s['valid_for'] = [int((s['hour'] - base_time_adjust) * steps_per_hour + i) for i in range(0, steps_per_hour // 2)] if s.get('hour') is not None else None
                 strategy.append(s)
     if strategy is None or len(strategy) == 0:
         return []
@@ -2094,7 +2095,7 @@ def get_strategy(use=None, strategy=None, quiet=1, remove=None, reserve=0):
         start = s['start']
         end = s['end']
         if hour_overlap(s, remove):
-            output(f"   {hours_time(start)}-{hours_time(end)} ** removed ** (overlaps charge period)", 2)
+            output(f"   {hours_time(start)}-{hours_time(end)} was removed from strategy", 2)
             continue
         # add segment
         min_soc_now = s['min_soc'] if s.get('min_soc') is not None and s['min_soc'] > 10 else 10
@@ -2103,9 +2104,9 @@ def get_strategy(use=None, strategy=None, quiet=1, remove=None, reserve=0):
         fdsoc = s.get('fdsoc')
         fdpwr = s.get('fdpwr')
         price = s.get('price')
-        expires = int((s['valid_to'] - base_time_adjust) * steps_per_hour) if s.get('valid_to') is not None else None
+        valid_for = s.get('valid_for')
         segment = {'start': start, 'end': end, 'mode': mode, 'min_soc': min_soc_now, 'max_soc': max_soc,
-            'fdsoc': fdsoc, 'fdpwr': fdpwr, 'price': price, 'expires': expires}
+            'fdsoc': fdsoc, 'fdpwr': fdpwr, 'price': price, 'valid_for': valid_for}
         if quiet == 0:
             s = f"   {hours_time(start)}-{hours_time(end)} {mode}, min_soc {min_soc_now}%"
             s += f", max_soc {max_soc}%" if max_soc is not None else ""
@@ -2128,11 +2129,6 @@ regions = {'A':'Eastern England', 'B':'East Midlands', 'C':'London', 'D':'Mersey
     'J':'South Eastern England', 'K':'Southern Wales', 'L':'South Western England', 'M':'Yorkshire', 'N':'Southern Scotland', 'P':'Northern Scotland'}
 
 
-# preset weightings for average 30 minute pricing over charging duration:
-front_loaded = [1.0, 0.9, 0.8, 0.7, 0.6, 0.5]           # 3 hour average, front loaded
-first_hour =   [1.0, 1.0]                               # lowest average price for first hour
-
-
 tariff_config = {
     'product': "AGILE-24-04-03",          # product code to use for Octopus API
     'region': "H",                        # region code to use for Octopus API
@@ -2141,7 +2137,7 @@ tariff_config = {
     'plunge_price': [1, 10],              # plunge price in p/kWh inc VAT over 24 hours from 7am, 7pm
     'plunge_slots': 6,                    # number of 30 minute slots to use
     'data_wrap': 6,                       # prices to show per line
-    'show_data': 0,                       # show pricing data
+    'show_data': 1,                       # show pricing data
     'show_plot': 1                        # plot pricing data
 }
 
@@ -2186,21 +2182,22 @@ def get_agile_times(tariff=agile_octopus, d=None):
     # extract times and prices. Times are Zulu (UTC)
     prices = []         # ordered list of 30 minute prices
     for i in range(0, len(results)):
-        start = (now.hour + i / 2) % 24
+        hour = i / 2
+        start = (now.hour + hour) % 24
         time_offset = daylight_saving(results[i]['valid_from'][:16]) if daylight_saving is not None else 0
         prices.append({
             'start': start,
             'end': round_time(start + 0.5),
             'time': hours_time(time_hours(results[i]['valid_from'][11:16]) + time_offset + time_shift),
             'price': results[i]['value_inc_vat'],
-            'valid_to': i / 2 + 0.5})
+            'hour': hour})
     tariff['agile']['base_time'] = period_from.replace('T', ' ')
     tariff['agile']['prices'] = prices
     plunge = []
     plunge_price = tariff_config['plunge_price'] if tariff_config.get('plunge_price') is not None else 2
     plunge_price = [plunge_price] if type(plunge_price) is not list else plunge_price
     plunge_slots = tariff_config['plunge_slots'] if tariff_config.get('plunge_slots') is not None else 6
-    for i in range(0, min([48, len(prices)])):
+    for i in range(0, len(prices)):
         # hour relative index into list of plunge prices, starting at 7am
         x = int(((now.hour - 7 + i / 2) % 24) * len(plunge_price) / 24)
         if prices[i] is not None and prices[i]['price'] < plunge_price[x]:
@@ -2225,13 +2222,13 @@ def get_agile_times(tariff=agile_octopus, d=None):
     # show the results
     if tariff_config['show_data'] > 0:
         data_wrap = tariff_config['data_wrap'] if tariff_config.get('data_wrap') is not None else 6
-        t = (now.hour * 2) % data_wrap
-        s = f"\nPricing on {today} p/kWh inc VAT:\n" + " " * t * 13
+        col = (now.hour * 2) % data_wrap
+        s = f"\nPrice p/kWh inc VAT on {today}:"
         for i in range(0, len(prices)):
-            s += "\n" if i > 0 and t % data_wrap == 0 else ""
-            s += f"  {prices[i]['time']} {prices[i]['price']:4.1f},"
-            t += 1
-        output(s[:-1])
+            s += (f"\n  {prices[i]['time']} " + " " * col * 6) if i == 0 or col == 0 else ""
+            s += f"  {prices[i]['price']:4.1f}"
+            col = (col + 1) % data_wrap
+        output(s)
     if tariff_config['show_plot'] > 0:
         plt.figure(figsize=(figure_width, figure_width/2))
         x_timed = [i for i in range(0, len(prices))]
@@ -2258,7 +2255,8 @@ def get_best_charge_period(start, duration):
     key = [k for k in ['off_peak1', 'off_peak2', 'off_peak3', 'off_peak4'] if hour_in(start, tariff.get(k))]
     key = key[0] if len(key) > 0 else None
     end = tariff[key]['end'] if key is not None else round_time(start + duration)
-    span = int(duration * 2 + 0.99)
+    span = int(duration * 2 + 0.99)         # number of slots needed for charging
+    last = (duration * 2) % 1               # amount of last slot used for charging
     coverage = max([round_time(end - start), duration])
     period = {'start': start, 'end': round_time(start + coverage)}
     prices = tariff['agile']['prices']
@@ -2267,13 +2265,14 @@ def get_best_charge_period(start, duration):
         return None
     elif len(slots) == 1:
         best = slots
-        price = prices[slots[0]]['price']
         best_start = start
+        price = prices[best[0]]['price']
     else:
         # best charge time for duration
         weighting = tariff_config.get('weighting')
         times = []
-        weights = ([1.0] * span) if weighting is None else (weighting + [1.0] * span)[:span]
+        weights = ([1.0] * (span)) if weighting is None else (weighting + [1.0] * span)[:span]
+        weights[-1] *= last if last > 0.0 else 1.0
         best = None
         price = None
         for i in range(0, len(slots) - span + 1):
@@ -2458,7 +2457,7 @@ def strategy_timed(timed_mode, base_hour, run_time, min_soc=10, max_soc=100, cur
         if strategy is not None:
             period['mode'] = 'SelfUse'
             for d in strategy:
-                if hour_in(h, d) and (d.get('expires') is None or i < d['expires']):
+                if hour_in(h, d) and (d.get('valid_for') is None or i in d['valid_for']):
                     mode = d['mode']
                     period['mode'] = mode
                     min_soc_now = d['min_soc'] if d.get('min_soc') is not None else min_soc
@@ -2827,7 +2826,7 @@ def charge_needed(forecast=None, update_settings=0, timed_mode=None, show_data=N
         if fsolcast is not None and hasattr(fsolcast, 'daily') and fsolcast.daily.get(forecast_day) is not None:
             solcast_value = fsolcast.daily[forecast_day]['kwh']
             solcast_timed = forecast_value_timed(fsolcast, today, tomorrow, base_hour, run_time, time_offset)
-            output(f"\nSolcast forecast for {tomorrow}: {fsolcast.daily[tomorrow]['kwh']:.1f}")
+            output(f"\nSolcast: {tomorrow} {fsolcast.daily[tomorrow]['kwh']:.1f}kWh")
     # get forecast.solar data and produce time line
     solar_value = None
     solar_profile = None
@@ -2836,7 +2835,7 @@ def charge_needed(forecast=None, update_settings=0, timed_mode=None, show_data=N
         if fsolar is not None and hasattr(fsolar, 'daily') and fsolar.daily.get(forecast_day) is not None:
             solar_value = fsolar.daily[forecast_day]['kwh']
             solar_timed = forecast_value_timed(fsolar, today, tomorrow, base_hour, run_time, 0)
-            output(f"\nSolar forecast for {tomorrow}: {fsolar.daily[tomorrow]['kwh']:.1f}")
+            output(f"\nSolar: {tomorrow} {fsolar.daily[tomorrow]['kwh']:.1f}kWh")
     if solcast_value is None and solar_value is None and debug_setting > 1:
         output(f"\nNo forecasts available at this time")
     # get generation data
@@ -2925,19 +2924,18 @@ def charge_needed(forecast=None, update_settings=0, timed_mode=None, show_data=N
     start_residual = interpolate(time_to_start, bat_timed)      # residual when charge time starts
     start_soc = int(start_residual / capacity * 100 + 0.5)
     end_residual = interpolate(time_to_end, bat_timed)          # residual when charge time ends without charging
-    target_soc = charge_config['target_soc'] if charge_config.get('target_soc') is not None else None
-    target_kwh = target_soc / 100 * capacity if target_soc is not None else 0
+    target_soc = charge_config.get('target_soc')
+    target_kwh = capacity if full_charge is not None or force_charge == 2 else (target_soc / 100 * capacity) if target_soc is not None else 0
     if target_kwh > (end_residual + kwh_needed):
         kwh_needed = target_kwh - end_residual
-    elif full_charge is not None or force_charge == 2:
-        kwh_needed = capacity - start_residual
     elif test_charge is not None:
         output(f"\nTest charge of {test_charge}kWh")
         kwh_needed = test_charge
         charge_message = "** test charge **"
     # work out charge needed
-    if kwh_min > (reserve + kwh_contingency) and kwh_needed < charge_config['min_kwh'] and full_charge is None and test_charge is None and force_charge != 2:
-        output(f"\nNo charging needed ({today} {hours_time(hour_now)} {current_soc:.0f}%)")
+    if kwh_min > (reserve + kwh_contingency) and kwh_needed < charge_config['min_kwh'] and test_charge is None:
+        output(f"\nNo charging needed:")
+        output(f"  SoC now:     {current_soc:.0f}% at {hours_time(hour_now)} on {today}")
         charge_message = "no charge needed"
         kwh_needed = 0.0
         hours = 0.0
@@ -2950,26 +2948,32 @@ def charge_needed(forecast=None, update_settings=0, timed_mode=None, show_data=N
                 work_mode_timed[t]['min_soc'] = start_soc
     else:
         if test_charge is None:
-            output(f"\nCharge needed {kwh_needed:.2f}kWh ({today} {hours_time(hour_now)} {current_soc:.0f}%)")
+            output(f"\nCharge needed {kwh_needed:.2f}kWh:")
             charge_message = "with charge added"
-        output(f"  Start SoC:   {start_residual / capacity * 100:.0f}% at {hours_time(adjusted_hour(time_to_start, time_line))} ({start_residual:.2f}kWh)")
+        output(f"  SoC now:     {current_soc:.0f}% at {hours_time(hour_now)} on {today}")
         # work out time to add kwh_needed to battery
-        taper_time = 10/60 if (start_residual + kwh_needed) >= (capacity * 0.95) else 0
-        hours = round_time(kwh_needed / (charge_power * charge_loss) + taper_time)
-        # charge time exceeded or charge needed exceeds capacity
-        if hours > charge_time or (start_residual + kwh_needed) > (capacity * 1.01):
-            kwh_needed = capacity - start_residual
-            hours = charge_time
-        elif hours < charge_config['min_hours']:
+        charge_rate = charge_power * charge_loss
+        hours = round_time(kwh_needed / charge_rate)
+        # check if charge time exceeded or charge needed exceeds capacity
+        hours_to_full = round_time((capacity - start_residual) / (charge_rate) + 10)
+        if hours < charge_config['min_hours']:
             hours = charge_config['min_hours']
-        end_soc = min([int((start_residual + kwh_needed) / capacity * 100 + 0.5), 100])
+        elif hours > charge_time:
+            hours = charge_time
+        elif hours > hours_to_full:
+            kwh_shortfall = (hours - hours_to_full) * charge_rate        # amount of energy that won't be added
+            required = hours_to_full + charge_time * kwh_shortfall / (end_residual - start_residual)  # time to recover energy not added
+            hours = required if required < charge_time else charge_time
         # rework charge and discharge
         charge_period = get_best_charge_period(start_at, hours)
         charge_offset = round_time(charge_period['start'] - start_at) if charge_period is not None else 0
         price = charge_period.get('price') if charge_period is not None else None
         start_timed = time_to_start + charge_offset * steps_per_hour
         end_timed = (start_timed + hours * steps_per_hour) if force_charge == 0 else time_to_end
-        output(f"  Charge:      {hours_time(adjusted_hour(start_timed, time_line))}-{hours_time(adjusted_hour(end_timed, time_line))}" + (f" at {price:5.2f}p/kWh" if price is not None else ""))
+        start_residual = interpolate(start_timed, bat_timed)
+        end_soc = min([int((start_residual + kwh_needed) / capacity * 100 + 0.5), 100])
+        output(f"  Start SoC:   {start_residual / capacity * 100:.0f}% at {hours_time(adjusted_hour(start_timed, time_line))} ({start_residual:.2f}kWh)")
+        output(f"  Charge to:   {end_soc:.0f}% {hours_time(adjusted_hour(start_timed, time_line))}-{hours_time(adjusted_hour(end_timed, time_line))}" + (f" at {price:5.2f}p/kWh" if price is not None else ""))
         for i in range(int(time_to_start), int(end_timed) + 1):
             j = i + 1
             # work out time (fraction of hour) when charging in hour from i to j
@@ -3000,17 +3004,16 @@ def charge_needed(forecast=None, update_settings=0, timed_mode=None, show_data=N
         output(f"  PV cover:    {expected / consumption * 100:.0f}% ({expected:.1f}/{consumption:.1f})")
     if show_data > 0:
         data_wrap = charge_config['data_wrap'] if charge_config.get('data_wrap') is not None else 6
-        s = f"\nBattery Energy kWh:\n" if show_data == 2 else f"\nBattery SoC:\n"
+        s = f"\nBattery Energy kWh:" if show_data == 2 else f"\nBattery SoC:"
         h = base_hour + 1
         t = steps_per_hour
-        s += " " * (14 if show_data == 2 else 13) * (h % data_wrap)
         while t < len(time_line) and bat_timed[t] is not None:
-            s += "\n" if t > steps_per_hour and h % data_wrap == 0 else ""
-            s += f"  {hours_time(time_line[t])}"
-            s += f" {bat_timed[t]:5.2f}" if show_data == 2 else f" {bat_timed[t] / capacity * 100:3.0f}%,"
+            col = h % data_wrap
+            s += (f"\n  {hours_time(time_line[t])}" + " " * col *  6) if t == steps_per_hour or col == 0 else ""
+            s += f" {bat_timed[t]:5.2f}" if show_data == 2 else f"  {bat_timed[t] / capacity * 100:3.0f}%"
             h += 1
             t += steps_per_hour
-        output(s[:-1])
+        output(s)
     if show_plot > 0:
         print()
         plt.figure(figsize=(figure_width, figure_width/2))
@@ -3062,7 +3065,7 @@ def charge_needed(forecast=None, update_settings=0, timed_mode=None, show_data=N
         end1 = start1 if force_charge == 0 else start2
         end2 = round_time(base_hour + (end_timed if force_charge == 0 else time_to_end) / steps_per_hour)
         if timed_mode > 1:
-            periods = charge_periods(st1=start1, en1=end1, st2=start2, en2=end2, min_soc=min_soc, target_soc=end_soc, start_soc=start_soc)
+            periods = charge_periods(st1=start1, en1=end1, st2=start2, en2=end2, min_soc=min_soc, end_soc=end_soc, start_soc=start_soc)
             set_schedule(periods = periods)
         else:
             set_charge(ch1=False, st1=start1, en1=end1, ch2=True, st2=start2, en2=end2, force=1)
@@ -3137,17 +3140,16 @@ def charge_compare(save=None, v=None, show_data=1, show_plot=3):
             plots[v][i] = plots[v][i] / count[v][i] if count[v][i] > 0 else None
     if show_data > 0 and plots.get('SoC') is not None:
         data_wrap = charge_config['data_wrap'] if charge_config.get('data_wrap') is not None else 6
-        s = f"\nBattery Energy kWh:\n" if show_data == 2 else f"\nBattery SoC:\n"
+        s = f"\nBattery Energy kWh:" if show_data == 2 else f"\nBattery SoC:"
         h = base_hour + 1
         t = steps_per_hour
-        s += " " * (14 if show_data == 2 else 13) * (h % data_wrap)
-        while t < len(time_line) and plots['SoC'][t] is not None:
-            s += "\n" if t > steps_per_hour and h % data_wrap == 0 else ""
-            s += f"  {hours_time(time_line[t])}"
-            s += f" {plots['SoC'][t]:5.2f}" if show_data == 2 else f" {plots['SoC'][t] / capacity * 100:3.0f}%,"
+        while t < len(time_line) and bat_timed[t] is not None:
+            col = h % data_wrap
+            s += (f"\n  {hours_time(time_line[t])}" + " " * col * 6) if t == steps_per_hour or col == 0 else ""
+            s += f" {plots['SoC'][t]:5.2f}" if show_data == 2 else f"  {plots['SoC'][t] / capacity * 100:3.0f}%"
             h += 1
             t += steps_per_hour
-        print(s[:-1])
+        print(s)
     if show_plot > 0:
         print()
         plt.figure(figsize=(figure_width, figure_width/2))

{foxesscloud-2.5.3.dist-info → foxesscloud-2.5.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxesscloud
-Version: 2.5.3
+Version: 2.5.5
 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
@@ -528,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: 
@@ -562,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'.
@@ -785,6 +783,18 @@ This setting can be:
 
 # Version Info
 
+2.5.5<br>
+Improve validation of plunge price periods so they don't repeat across days.
+Correct start and end soc times and values when charging using best Agile time periods.
+Extend charge times when charge needed exceeds battery capacity.
+
+
+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.

foxesscloud-2.5.5.dist-info/RECORD

@@ -0,0 +1,7 @@
+foxesscloud/foxesscloud.py,sha256=biC30gvvQHFTu3CCDhuK6KRGNi2hFbgFxHjSykj-UpE,211062
+foxesscloud/openapi.py,sha256=MEzJPleAV8-2gR17e2qmQezVeotiqkHMzeCBDVJOfsY,204698
+foxesscloud-2.5.5.dist-info/LICENCE,sha256=-3xv8CElCJV8Bc8PbAsg3iyxMpAK8MoJneM3rXigxqI,1074
+foxesscloud-2.5.5.dist-info/METADATA,sha256=kvZCDYUyu7v1OkE_dik_f_4V4OXQTaZKwOYWYFTircU,55462
+foxesscloud-2.5.5.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+foxesscloud-2.5.5.dist-info/top_level.txt,sha256=IWOrKSNZCLU6IDXSX_b4_bqCfbZoWAT4CC0w0Lg7PuU,12
+foxesscloud-2.5.5.dist-info/RECORD,,

foxesscloud-2.5.3.dist-info/RECORD

@@ -1,7 +0,0 @@
-foxesscloud/foxesscloud.py,sha256=LkRglTcW4sAVPRgXxkhqyt7fcDcDk00ui_nnsdSU51Y,210817
-foxesscloud/openapi.py,sha256=2hyHrGpYNUQybmKCLRZmujW8CfnyS0bjKdxZwPpkjCU,204531
-foxesscloud-2.5.3.dist-info/LICENCE,sha256=-3xv8CElCJV8Bc8PbAsg3iyxMpAK8MoJneM3rXigxqI,1074
-foxesscloud-2.5.3.dist-info/METADATA,sha256=iXU6pABWNwPSUXW4-NrJWCiy3ZecYsiJPIKNAamHR-g,54937
-foxesscloud-2.5.3.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-foxesscloud-2.5.3.dist-info/top_level.txt,sha256=IWOrKSNZCLU6IDXSX_b4_bqCfbZoWAT4CC0w0Lg7PuU,12
-foxesscloud-2.5.3.dist-info/RECORD,,