foxesscloud 2.9.7__tar.gz → 2.9.9__tar.gz

{foxesscloud-2.9.7 → foxesscloud-2.9.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxesscloud
-Version: 2.9.7
+Version: 2.9.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
@@ -116,7 +116,7 @@ f.get_charge()
 f.get_min()
 f.get_peakshaving()
 f.get_flag()
-f.get_schedule()
+f.get_schedule(filter)
 f.get_named_settings(name)
 f.get_heating()
 
@@ -140,9 +140,10 @@ get_peakshaving() will return the current peak shaving settings for inverters th
 
 get_flag() returns the current scheduler enable / support / maxsoc flags. By default support for Max Soc is set to False.
 + f.max_periods / schedule['maxGroupCount'] gives the maximum number of time periods that are supported.
++ f.schedule['properties'] details the parameters supported in Mode Scheduler for the current inverter.
 
 get_schedule() returns the current work mode / soc schedule settings. The result is stored in f.schedule.
-+ if the schedule returned contains any values for 'maxSoc', the f.schedule['maxsoc'] is set to True to indicate that the current inverter supports setting Max Soc in schedules and Max Soc values are set by set_schedule().
++ filter: 1 = remove Remain Time period (00:00-23:59) from results. 0 = don't remove. Default 1.
 
 get_named_settings() returns the value of a named setting. If 'name' is a list, it returns a list of values.
 + f.named_settings is updated. This is dictionary of information and current value, indexed by 'name'.
@@ -157,7 +158,7 @@ You can change inverter settings using:
 f.set_min(minSocOnGrid, minSoc)
 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.set_schedule(periods, enable)
+f.set_schedule(periods, enable, is_default)
 f.set_named_settings(name, value, force)
 f.set_heating(enable, start, end, time1, time2, time3)
 ```
@@ -186,7 +187,6 @@ set_period() returns a period structure that can be used to build a list for set
 + export_limit: optional, default is None (not set).
 + pv_limit: optional, default is 1.5 x inverter rating.
 + price: optional, default None. Used to display plunge pricing for time period.
-+ enable: sets whether this time segment is enable (1) or disabled (0). The default is enabled.
 + segment: optional, allows the parameters for the period to be passed as a dictionary instead of individual values.
 
 Before calling set_period(), do at least one call to get_schedule(). This will inspect the schedule result to check if max_soc is supported and set the flag f.schedule['maxsoc'] to enable or disable this field as appropriate.
@@ -196,6 +196,7 @@ The variable f.max_periods is used to check the number of time periods allowed.
 set_schedule() configures a list of scheduled work mode / soc changes with enable=1. If called with enable=0, any existing schedules are disabled. To enable a schedule, you must provide a list of time segments
 + periods: a time segment or list of time segments created using f.set_period().
 + enable: 1 to enable schedules, 0 to disable schedules. The default is 1.
++ is_default: False (default): parameters not provided remain unchanged. True: parameters not provided are restored to system defaults
 
 set_named_settings() sets the 'name' setting to 'value'.
 + 'name' may also be a list of (name, value) pairs.
@@ -427,7 +428,7 @@ min_hours: 0.25                # minimum charge time to set (in decimal hours)
 min_kwh: 0.5                   # minimum charge to add in kwh
 solcast_adjust: 100            # % adjustment to make to Solcast forecast
 solar_adjust:  100             # % adjustment to make to Solar forecast
-forecast_selection: 1          # 1 = only update charge times if forecast is available, 0 = use best available data. Default is 1.
+forecast_selection: 0          # 1 = only update charge times if forecast is available, 0 = use best available data.
 annual_consumption: None       # optional annual consumption in kWh. If set, this replaces consumption history
 timed_mode: 0                  # 0 = None, 1 = use timed work mode, 2 = strategy mode
 special_contingency: 35        # contingency for special days when consumption might be higher
@@ -833,6 +834,23 @@ This setting can be:
 
 # Version Info
 
+2.9.9 - 2026/04/03<br>
+Add 'isRemainMode' flag to time periods (not currently processed by Open API).
+Add 'filter' to f.get_schedule() to drop Remain Time period (00:00-23:59) to avoid overlap with other time periods.
+
+2.9.8 - 2026/03/22<br>
+** potential breaking changes **
+Update to use Mode Scheduler API v3.
+This adds 'properties' to f.schedule that describes the work modes and parameters supported on different inverters.
+f.work_modes and f.settable_modes are now set dynamically from the properties.
+The period parameters that are sent are trimmed to the supported set and unused parameters for the mode are removed.
+** API v3 rejects unsupported parameters. This limits the testing I can do for different inverters. Please report any issues **
+API v3 removes the previous ability to send disabled time periods. If you try to send a disabled period, set_period() will return None.
+set_period() now supports 'reactive_power' as a parameter.
+set_schedule() now supports 'is_default'. See Open API documentation for more info on what this does.
+charge_needed() changed from using min_soc for battery hold to using ForceDischarge with fdpwr=0 when timed_mode=2.
+charge_needed() default configuration now has forecast_selection=0 so settings will be updated if a forecast is not available.
+
 2.9.7 - 2026/03/18<br>
 Add pv_limit to set_period().
 Default import_linit to 0 for force discharge in set_period()

foxesscloud-2.9.7/src/foxesscloud.egg-info/PKG-INFO → foxesscloud-2.9.9/README.md

@@ -1,17 +1,3 @@
-Metadata-Version: 2.1
-Name: foxesscloud
-Version: 2.9.7
-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>
@@ -116,7 +102,7 @@ f.get_charge()
 f.get_min()
 f.get_peakshaving()
 f.get_flag()
-f.get_schedule()
+f.get_schedule(filter)
 f.get_named_settings(name)
 f.get_heating()
 
@@ -140,9 +126,10 @@ get_peakshaving() will return the current peak shaving settings for inverters th
 
 get_flag() returns the current scheduler enable / support / maxsoc flags. By default support for Max Soc is set to False.
 + f.max_periods / schedule['maxGroupCount'] gives the maximum number of time periods that are supported.
++ f.schedule['properties'] details the parameters supported in Mode Scheduler for the current inverter.
 
 get_schedule() returns the current work mode / soc schedule settings. The result is stored in f.schedule.
-+ if the schedule returned contains any values for 'maxSoc', the f.schedule['maxsoc'] is set to True to indicate that the current inverter supports setting Max Soc in schedules and Max Soc values are set by set_schedule().
++ filter: 1 = remove Remain Time period (00:00-23:59) from results. 0 = don't remove. Default 1.
 
 get_named_settings() returns the value of a named setting. If 'name' is a list, it returns a list of values.
 + f.named_settings is updated. This is dictionary of information and current value, indexed by 'name'.
@@ -157,7 +144,7 @@ You can change inverter settings using:
 f.set_min(minSocOnGrid, minSoc)
 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.set_schedule(periods, enable)
+f.set_schedule(periods, enable, is_default)
 f.set_named_settings(name, value, force)
 f.set_heating(enable, start, end, time1, time2, time3)
 ```
@@ -186,7 +173,6 @@ set_period() returns a period structure that can be used to build a list for set
 + export_limit: optional, default is None (not set).
 + pv_limit: optional, default is 1.5 x inverter rating.
 + price: optional, default None. Used to display plunge pricing for time period.
-+ enable: sets whether this time segment is enable (1) or disabled (0). The default is enabled.
 + segment: optional, allows the parameters for the period to be passed as a dictionary instead of individual values.
 
 Before calling set_period(), do at least one call to get_schedule(). This will inspect the schedule result to check if max_soc is supported and set the flag f.schedule['maxsoc'] to enable or disable this field as appropriate.
@@ -196,6 +182,7 @@ The variable f.max_periods is used to check the number of time periods allowed.
 set_schedule() configures a list of scheduled work mode / soc changes with enable=1. If called with enable=0, any existing schedules are disabled. To enable a schedule, you must provide a list of time segments
 + periods: a time segment or list of time segments created using f.set_period().
 + enable: 1 to enable schedules, 0 to disable schedules. The default is 1.
++ is_default: False (default): parameters not provided remain unchanged. True: parameters not provided are restored to system defaults
 
 set_named_settings() sets the 'name' setting to 'value'.
 + 'name' may also be a list of (name, value) pairs.
@@ -427,7 +414,7 @@ min_hours: 0.25                # minimum charge time to set (in decimal hours)
 min_kwh: 0.5                   # minimum charge to add in kwh
 solcast_adjust: 100            # % adjustment to make to Solcast forecast
 solar_adjust:  100             # % adjustment to make to Solar forecast
-forecast_selection: 1          # 1 = only update charge times if forecast is available, 0 = use best available data. Default is 1.
+forecast_selection: 0          # 1 = only update charge times if forecast is available, 0 = use best available data.
 annual_consumption: None       # optional annual consumption in kWh. If set, this replaces consumption history
 timed_mode: 0                  # 0 = None, 1 = use timed work mode, 2 = strategy mode
 special_contingency: 35        # contingency for special days when consumption might be higher
@@ -833,6 +820,23 @@ This setting can be:
 
 # Version Info
 
+2.9.9 - 2026/04/03<br>
+Add 'isRemainMode' flag to time periods (not currently processed by Open API).
+Add 'filter' to f.get_schedule() to drop Remain Time period (00:00-23:59) to avoid overlap with other time periods.
+
+2.9.8 - 2026/03/22<br>
+** potential breaking changes **
+Update to use Mode Scheduler API v3.
+This adds 'properties' to f.schedule that describes the work modes and parameters supported on different inverters.
+f.work_modes and f.settable_modes are now set dynamically from the properties.
+The period parameters that are sent are trimmed to the supported set and unused parameters for the mode are removed.
+** API v3 rejects unsupported parameters. This limits the testing I can do for different inverters. Please report any issues **
+API v3 removes the previous ability to send disabled time periods. If you try to send a disabled period, set_period() will return None.
+set_period() now supports 'reactive_power' as a parameter.
+set_schedule() now supports 'is_default'. See Open API documentation for more info on what this does.
+charge_needed() changed from using min_soc for battery hold to using ForceDischarge with fdpwr=0 when timed_mode=2.
+charge_needed() default configuration now has forecast_selection=0 so settings will be updated if a forecast is not available.
+
 2.9.7 - 2026/03/18<br>
 Add pv_limit to set_period().
 Default import_linit to 0 for force discharge in set_period()

{foxesscloud-2.9.7 → foxesscloud-2.9.9}/pyproject.toml

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

{foxesscloud-2.9.7 → foxesscloud-2.9.9}/src/foxesscloud/openapi.py

@@ -1,7 +1,7 @@
 ##################################################################################################
 """
 Module:   Fox ESS Cloud using Open API
-Updated:  18 March 2026
+Updated:  03 April 2026
 By:       Tony Matthews
 """
 ##################################################################################################
@@ -10,7 +10,7 @@ By:       Tony Matthews
 # ALL RIGHTS ARE RESERVED © Tony Matthews 2024
 ##################################################################################################
 
-version = "2.9.7"
+version = "2.9.9"
 print(f"FoxESS-Cloud Open API version {version}")
 
 debug_setting = 1
@@ -1144,6 +1144,51 @@ def set_work_mode(mode, force = 0):
     work_mode = mode
     return work_mode
 
+##################################################################################################
+# Modbus Commands
+##################################################################################################
+
+slave_address = 247
+modbus_timeout = 10
+
+def modbus_data(function, register, value=None):
+    return None
+
+def get_modbus(register, slave=None, function=None, timeout=None):
+    global device_sn, modbus_timeout
+    function = 4 if function is None else function
+    output(f"\nGetting Modbus: {mode}", 1)
+    packet = modbus_data(function, register)
+    body = {'sn': device_sn, 'timeout': modbus_timeout, 'data': packet}
+    response = signed_post(path="/op/v0/module/modbus/commands", body=body)
+    if response.status_code != 200:
+        output(f"** get_modbus() got response code {response.status_code}: {response.reason}")
+        return None
+    errno = response.json().get('errno')
+    if errno != 0:
+        output(f"** get_modbus(), {errno_message(response)}")
+        return None
+    result = response.json().get('result')
+    return result
+
+def set_modbus(register, value, slave=None, function=None, timeout=None):
+    global device_sn, modbus_timeout
+    function = 16 if type(value) is list else 6
+    output(f"\nSetting Modbus: {mode}", 1)
+    packet = modbus_data(function, register, value)
+    body = {'sn': device_sn, 'timeout': modbus_timeout, 'data': packet}
+    setting_delay()
+    response = signed_post(path="/op/v0/module/modbus/commands", body=body)
+    if response.status_code != 200:
+        output(f"** get_modbus() got response code {response.status_code}: {response.reason}")
+        return None
+    errno = response.json().get('errno')
+    if errno != 0:
+        output(f"** get_modbus(), {errno_message(response)}")
+        return None
+    result = response.json().get('result')
+    return result
+
 
 ##################################################################################################
 # get flag
@@ -1154,7 +1199,7 @@ max_periods = 8
 
 # get the current switch status
 def get_flag():
-    global device_sn, schedule, debug_setting, max_periods
+    global device_sn, schedule, debug_setting, max_periods, work_modes, settable_modes
     if get_device() is None:
         return None
     output(f"getting flag", 2)
@@ -1167,22 +1212,29 @@ def get_flag():
     if result is None:
         return None
     if schedule is None:
-        schedule = {'enable': None, 'support': None, 'periods': None, 'maxsoc': None}
+        schedule = {'enable': None, 'support': None, 'periods': [], 'maxsoc': None}
     schedule['enable'] = result.get('enable')
     schedule['support'] = result.get('support')
     if device.get('function') is not None and device['function'].get('scheduler') is not None:
         device['function']['scheduler'] = schedule['support']
     if schedule.get('maxGroupCount') is None:
-        output(f"getting maxGroupCount", 2)
+        output(f"getting properties", 2)
         body = {'deviceSN': device_sn}
         response = signed_post(path="/op/v3/device/scheduler/get", body=body)
         if response.status_code != 200:
-            output(f"** get_flag() got response code getting maxGroupCount {response.status_code}: {response.reason}")
+            output(f"** get_flag() got response code getting properties {response.status_code}: {response.reason}")
             return None
         result = response.json().get('result')
         if result is not None:
             schedule['maxGroupCount'] = result.get('maxGroupCount')
             max_periods = schedule['maxGroupCount']
+            schedule['properties'] = result.get('properties')
+            if schedule['properties'] is not None:
+                schedule['maxsoc'] = schedule['properties'].get('maxsoc') is not None
+                modes = schedule['properties'].get('workmode')
+                if modes is not None:
+                    work_modes = sorted(modes['enumList'])
+                    settable_modes = [w for w in work_modes if 'Force' not in w]
     return schedule
 
 ##################################################################################################
@@ -1190,7 +1242,7 @@ def get_flag():
 ##################################################################################################
 
 # get the current schedule
-def get_schedule():
+def get_schedule(filter=1):
     global device_sn, schedule, debug_setting, work_modes
     if get_flag() is None:
         return None
@@ -1199,7 +1251,7 @@ def get_schedule():
         return None
     output(f"getting schedule", 2)
     body = {'deviceSN': device_sn}
-    response = signed_post(path="/op/v2/device/scheduler/get", body=body)
+    response = signed_post(path="/op/v3/device/scheduler/get", body=body)
     if response.status_code != 200:
         output(f"** get_schedule() got response code {response.status_code}: {response.reason}")
         return None
@@ -1212,13 +1264,13 @@ def get_schedule():
         enable = True if enable == 1 else False
     schedule['enable'] = enable
     schedule['periods'] = []
-    schedule['maxsoc'] = False
     # remove invalid work mode from periods
     for g in result['groups']:
-        if g['enable'] == 1 and g['workMode'] in work_modes:
-            schedule['periods'].append(g)
-            if g.get('extraParam') is not None and g['extraParam'].get('maxSoc') is not None:
-                schedule['maxsoc'] = True
+        if g['workMode'] in work_modes:
+            remain_mode = g['startHour'] == 0 and g['startMinute'] == 0 and g['endHour'] == 23 and g['endMinute'] == 59
+            g['isRemainMode'] = remain_mode
+            if not remain_mode or filter == 0:
+                schedule['periods'].append(g)
     return schedule
 
 # build strategy using current schedule
@@ -1246,9 +1298,10 @@ def build_strategy_from_schedule():
 ##################################################################################################
 
 # create time segment structure. Note: end time is exclusive.
-def set_period(start=None, end=None, mode=None, min_soc=None, max_soc=None, fdsoc=None, fdpwr=None, import_limit=None, export_limit=None, pv_limit=None, price=None, segment=None, enable=1, quiet=1):
+def set_period(start=None, end=None, mode=None, min_soc=None, max_soc=None, fdsoc=None, fdpwr=None, import_limit=None, export_limit=None, pv_limit=None, reactive_power=None
+        , price=None, segment=None, enable=1, quiet=1):
     global schedule, device
-    if schedule is None or schedule.get('maxsoc') is None:
+    if schedule is None:
         get_schedule()
     if segment is not None and type(segment) is dict:
         start = segment.get('start')
@@ -1261,40 +1314,34 @@ def set_period(start=None, end=None, mode=None, min_soc=None, max_soc=None, fdso
         import_limit = segment.get('import_limit')
         export_limit = segment.get('export_limit')
         pv_limit = segment.get('pv_limit')
+        reactive_power = segment.get('reactive_power')
         price = segment.get('price')
+    if enable == 0:
+        return None
     start = time_hours(start)
     # adjust exclusive time to inclusive
     end = time_hours(end)
     if start is None or end is None or start >= end:
         output(f"set_period(): ** invalid period times: {hours_time(start)}-{hours_time(end)}")
         return None
+    remain_mode = start == 0 and end == 24
     end = round_time(end - 1/60)
     mode = 'SelfUse' if mode is None else mode
     if mode not in work_modes:
         output(f"** mode must be one of {work_modes}")
         return None
+    properties = schedule.get('properties')
     min_soc = 10 if min_soc is None else min_soc
-    max_soc = None if schedule is None or schedule.get('maxsoc') is None or schedule['maxsoc'] == False else 100 if max_soc is None else max_soc
+    max_soc = None if properties.get('maxsoc') is None or 'ForceCharge' not in mode else 100 if max_soc is None else max_soc
     if 'ForceCharge' in mode and fdsoc is None:
         fdsoc = max_soc if max_soc is not None else 100
-    fdsoc = min_soc if fdsoc is None else fdsoc
+    fdsoc = None if properties.get('fdsoc') is None or 'Force' not in mode else min_soc if fdsoc is None else fdsoc
     power = (device['power'] * 1000) if device.get('power') is not None else None
-    fdpwr = power if fdpwr is None and device.get('power') is not None and ('ForceCharge' in mode or 'ForceDischarge' in mode) else fdpwr
-    pv_limit = int(1.5 * power) if pv_limit is None and device.get('power') is not None and ('ForceCharge' in mode or 'ForceDischarge' in mode) else pv_limit
-    import_limit = 0 if import_limit is None and 'ForceDischarge' in mode else import_limit
-    fdpwr = 0 if fdpwr is None else fdpwr
-    if min_soc < 0 or min_soc > 100:
-        output(f"set_period(): ** min_soc must be between 0 and 100")
-        return None
-    if max_soc is not None and (max_soc < 10 or max_soc > 100):
-        output(f"set_period(): ** max_soc must be between 10 and 100")
-        return None
-    if fdpwr < 0 or fdpwr > 30000:
-        output(f"set_period(): ** fdpwr must be between 0 and 30000")
-        return None
-    if fdsoc < min_soc or fdsoc > 100:
-        output(f"set_period(): ** fdsoc must between {min_soc} and 100")
-        return None
+    fdpwr = None if properties.get('fdpwr') is None else power if fdpwr is None and device.get('power') is not None and ('Force' in mode) else fdpwr
+    pv_limit = None if properties.get('pvlimit') is None else int(1.5 * power) if pv_limit is None and device.get('power') is not None and ('Force' in mode) else pv_limit
+    import_limit = None if properties.get('importlimit') is None else 0 if import_limit is None and 'ForceDischarge' in mode else import_limit
+    export_limit = None if properties.get('exportlimit') is None else export_limit
+    reactive_power = None if properties.get('reactivepower') is None else reactive_power
     if quiet == 0:
         s = f"   {hours_time(start)}-{hours_time(end)} {mode}, minsoc {min_soc}%"
         s += f", maxsoc {max_soc}%" if max_soc is not None and 'ForceCharge' in mode else ""
@@ -1303,16 +1350,30 @@ def set_period(start=None, end=None, mode=None, min_soc=None, max_soc=None, fdso
         s += f", importLimit {int(import_limit)}W" if import_limit is not None else ""
         s += f", pvLimit {int(pv_limit)}W" if pv_limit is not None else ""
         s += f", {price:.2f}p/kWh" if price is not None else ""
+        s += f", Remain Mode" if remain_mode else ""
         output(s, 1)
     start_hour, start_minute = split_hours(start)
     end_hour, end_minute = split_hours(end)
-    period = {'enable': enable, 'startHour': start_hour, 'startMinute': start_minute, 'endHour': end_hour, 'endMinute': end_minute, 'workMode': mode,
-        'extraParam': {'minSocOnGrid': int(min_soc), 'fdSoc': int(fdsoc), 'fdPwr': int(fdpwr), 'maxSoc': max_soc, 'importLimit': import_limit,
-        'exportLimit': export_limit, 'pvLimit': pv_limit}}
+    period = {'startHour': start_hour, 'startMinute': start_minute, 'endHour': end_hour, 'endMinute': end_minute, 'workMode': mode, 'isRemainMode': remain_mode
+        , 'extraParam': {'minSocOnGrid': min_soc}}
+    if max_soc is not None:
+        period['extraParam']['maxSoc'] = max_soc
+    if fdsoc is not None:
+        period['extraParam']['fdSoc'] = int(fdsoc)
+    if fdpwr is not None:
+        period['extraParam']['fdPwr'] = int(fdpwr)
+    if import_limit is not None:
+        period['extraParam']['importLimit'] = import_limit
+    if export_limit is not None:
+        period['extraParam']['exportLimit'] = export_limit
+    if pv_limit is not None:
+        period['extraParam']['pvLimit'] = pv_limit
+    if reactive_power is not None:
+        period['extraParam']['reactivePower'] = reactive_power
     return period
 
 # set a schedule from a period or list of time segment periods
-def set_schedule(periods=None, enable=True):
+def set_schedule(periods=None, enable=True, is_default=False):
     global device_sn, debug_setting, schedule, max_periods
     if get_flag() is None:
         return None
@@ -1325,18 +1386,18 @@ def set_schedule(periods=None, enable=True):
         return None
     if type(enable) is int:
         enable = True if enable == 1 else False
-    if enable == False:
-        output(f"\nDisabling schedule", 1)
-    else:
+    if enable:
         output(f"\nEnabling schedule", 1)
+    else:
+        output(f"\nDisabling schedule", 1)
     if periods is not None:
         if type(periods) is not list:
             periods = [periods]
         if len(periods) > max_periods:
             output(f"** set_schedule(): maximum of {max_periods} periods allowed, {len(periods)} provided")
-        body = {'deviceSN': device_sn, 'groups': periods[-max_periods:]}
+        body = {'deviceSN': device_sn, 'isDefault': is_default, 'groups': periods[-max_periods:]}
         setting_delay()
-        response = signed_post(path="/op/v2/device/scheduler/enable", body=body)
+        response = signed_post(path="/op/v3/device/scheduler/enable", body=body)
         if response.status_code != 200:
             output(f"** set_schedule() periods response code {response.status_code}: {response.reason}")
             return None
@@ -2734,10 +2795,10 @@ def charge_periods(work_mode_timed, base_hour, min_soc, capacity):
             elif 'ForceCharge' in period['mode']:
                 s['max_soc'] = period.get('max_soc')
             elif period['mode'] == 'SelfUse' and period['hold'] == 1:
-                s['min_soc'] = min([int(period['kwh'] / capacity * 100 + 0.5), 100])
-                s['end'] = (start + 1 / steps_per_hour) % 24
-                for p in times:
-                    p['min_soc'] = s['min_soc']
+                s['mode'] = 'ForceDischarge'
+                s['fdpwr'] = 0
+                s['fdsoc'] = min([int(period['kwh'] / capacity * 100 + 0.5), 100])
+                s['min_soc'] = 10
             if s['mode'] != 'SelfUse' or s['min_soc'] != min_soc:
                 strategy.append(s)
             start = h
@@ -2790,7 +2851,7 @@ charge_config = {
     'use_today': 21.0,                # hour when todays consumption and generation can be used
     'min_hours': 0.5,                 # minimum charge time in decimal hours
     'min_kwh': 0.5,                   # minimum to add in kwh
-    'forecast_selection': 1,          # 0 = use available forecast / generation, 1 only update settings with forecast
+    'forecast_selection': 0,          # 0 = use available forecast / generation, 1 only update settings with forecast
     'annual_consumption': None,       # optional annual consumption in kWh
     'timed_mode': 0,                  # 0 = None, 1 = timed mode, 2 = strategy mode
     'special_contingency': 35,        # contingency for special days when consumption might be higher

foxesscloud-2.9.7/README.md → foxesscloud-2.9.9/src/foxesscloud.egg-info/PKG-INFO

@@ -1,3 +1,17 @@
+Metadata-Version: 2.1
+Name: foxesscloud
+Version: 2.9.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
+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>
@@ -102,7 +116,7 @@ f.get_charge()
 f.get_min()
 f.get_peakshaving()
 f.get_flag()
-f.get_schedule()
+f.get_schedule(filter)
 f.get_named_settings(name)
 f.get_heating()
 
@@ -126,9 +140,10 @@ get_peakshaving() will return the current peak shaving settings for inverters th
 
 get_flag() returns the current scheduler enable / support / maxsoc flags. By default support for Max Soc is set to False.
 + f.max_periods / schedule['maxGroupCount'] gives the maximum number of time periods that are supported.
++ f.schedule['properties'] details the parameters supported in Mode Scheduler for the current inverter.
 
 get_schedule() returns the current work mode / soc schedule settings. The result is stored in f.schedule.
-+ if the schedule returned contains any values for 'maxSoc', the f.schedule['maxsoc'] is set to True to indicate that the current inverter supports setting Max Soc in schedules and Max Soc values are set by set_schedule().
++ filter: 1 = remove Remain Time period (00:00-23:59) from results. 0 = don't remove. Default 1.
 
 get_named_settings() returns the value of a named setting. If 'name' is a list, it returns a list of values.
 + f.named_settings is updated. This is dictionary of information and current value, indexed by 'name'.
@@ -143,7 +158,7 @@ You can change inverter settings using:
 f.set_min(minSocOnGrid, minSoc)
 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.set_schedule(periods, enable)
+f.set_schedule(periods, enable, is_default)
 f.set_named_settings(name, value, force)
 f.set_heating(enable, start, end, time1, time2, time3)
 ```
@@ -172,7 +187,6 @@ set_period() returns a period structure that can be used to build a list for set
 + export_limit: optional, default is None (not set).
 + pv_limit: optional, default is 1.5 x inverter rating.
 + price: optional, default None. Used to display plunge pricing for time period.
-+ enable: sets whether this time segment is enable (1) or disabled (0). The default is enabled.
 + segment: optional, allows the parameters for the period to be passed as a dictionary instead of individual values.
 
 Before calling set_period(), do at least one call to get_schedule(). This will inspect the schedule result to check if max_soc is supported and set the flag f.schedule['maxsoc'] to enable or disable this field as appropriate.
@@ -182,6 +196,7 @@ The variable f.max_periods is used to check the number of time periods allowed.
 set_schedule() configures a list of scheduled work mode / soc changes with enable=1. If called with enable=0, any existing schedules are disabled. To enable a schedule, you must provide a list of time segments
 + periods: a time segment or list of time segments created using f.set_period().
 + enable: 1 to enable schedules, 0 to disable schedules. The default is 1.
++ is_default: False (default): parameters not provided remain unchanged. True: parameters not provided are restored to system defaults
 
 set_named_settings() sets the 'name' setting to 'value'.
 + 'name' may also be a list of (name, value) pairs.
@@ -413,7 +428,7 @@ min_hours: 0.25                # minimum charge time to set (in decimal hours)
 min_kwh: 0.5                   # minimum charge to add in kwh
 solcast_adjust: 100            # % adjustment to make to Solcast forecast
 solar_adjust:  100             # % adjustment to make to Solar forecast
-forecast_selection: 1          # 1 = only update charge times if forecast is available, 0 = use best available data. Default is 1.
+forecast_selection: 0          # 1 = only update charge times if forecast is available, 0 = use best available data.
 annual_consumption: None       # optional annual consumption in kWh. If set, this replaces consumption history
 timed_mode: 0                  # 0 = None, 1 = use timed work mode, 2 = strategy mode
 special_contingency: 35        # contingency for special days when consumption might be higher
@@ -819,6 +834,23 @@ This setting can be:
 
 # Version Info
 
+2.9.9 - 2026/04/03<br>
+Add 'isRemainMode' flag to time periods (not currently processed by Open API).
+Add 'filter' to f.get_schedule() to drop Remain Time period (00:00-23:59) to avoid overlap with other time periods.
+
+2.9.8 - 2026/03/22<br>
+** potential breaking changes **
+Update to use Mode Scheduler API v3.
+This adds 'properties' to f.schedule that describes the work modes and parameters supported on different inverters.
+f.work_modes and f.settable_modes are now set dynamically from the properties.
+The period parameters that are sent are trimmed to the supported set and unused parameters for the mode are removed.
+** API v3 rejects unsupported parameters. This limits the testing I can do for different inverters. Please report any issues **
+API v3 removes the previous ability to send disabled time periods. If you try to send a disabled period, set_period() will return None.
+set_period() now supports 'reactive_power' as a parameter.
+set_schedule() now supports 'is_default'. See Open API documentation for more info on what this does.
+charge_needed() changed from using min_soc for battery hold to using ForceDischarge with fdpwr=0 when timed_mode=2.
+charge_needed() default configuration now has forecast_selection=0 so settings will be updated if a forecast is not available.
+
 2.9.7 - 2026/03/18<br>
 Add pv_limit to set_period().
 Default import_linit to 0 for force discharge in set_period()