foxesscloud 2.9.3__tar.gz → 2.9.5__tar.gz

{foxesscloud-2.9.3/src/foxesscloud.egg-info → foxesscloud-2.9.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxesscloud
-Version: 2.9.3
+Version: 2.9.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
@@ -118,7 +118,7 @@ f.get_peakshaving()
 f.get_flag()
 f.get_schedule()
 f.get_named_settings(name)
-f.get_battery_heating()
+f.get_heating()
 
 ```
 Each of these calls will return a dictionary or list containing the relevant information.
@@ -139,6 +139,7 @@ get_settings() will return the battery settings and is equivalent to get_charge(
 get_peakshaving() will return the current peak shaving settings for inverters that support this work mode.
 
 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.
 
 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().
@@ -147,7 +148,7 @@ get_named_settings() returns the value of a named setting. If 'name' is a list,
 + f.named_settings is updated. This is dictionary of information and current value, indexed by 'name'.
 + named_settings currently available are stored in f.name_list. The settings supported depends on the inverter model and firmware version. An error will be returned if an unsupported variable is used.
 
-get_battery_heating returns the current battery heating parameters and store these in f.battery_heating
+get_heating returns the current battery heating parameters and store these in f.device['heating']
 
 ## Inverter Settings
 You can change inverter settings using:
@@ -158,7 +159,7 @@ f.set_charge(ch1, st1, en1, ch2, st2, en2, enable)
 f.set_period(start, end, mode, min_soc, max_soc, fdsoc, fdpwr, price, segment)
 f.set_schedule(periods, enable)
 f.set_named_settings(name, value, force)
-f.set_battery_heating(enable, start, end, time1, time2, time3)
+f.set_heating(enable, start, end, time1, time2, time3)
 ```
 
 set_min() applies new SoC settings to the inverter. The parameters update battery_settings:
@@ -201,7 +202,7 @@ set_named_settings() sets the 'name' setting to 'value'.
 + a return value of 1 is success. 0 means setting failed. None is another error e.g. device not found, invalid name or value.
 + named_settings currently available are stored in f.name_list. The settings supported depend on the inverter model and firmware version. An error will be returned if an unsupported varaible is used.
 
-set_battery_heating() set the heating parameters as follows:
+set_heating() set the heating parameters as follows:
 + enable: optional, 0 or 1, default is 1
 + start, end: optional start and end temperatures. The defaults are start at 9C and end at 12C.
 + time1, time2, time3: optional times when the battery can heat from the grid time. The structure is {'enable': 1, 'start': '00:30', 'end': '05:30'}. The time slot is disabled by default.
@@ -496,7 +497,7 @@ This is an example of the output from battery_info():
 ## Date Ranges
 
 ```
-f.date_list(s, e, limit, span, today)
+f.date_list(s, e, limit, span, today, step)
 ```
 
 Returns a list of dates in the format 'YYYY-MM-DD'. This function will not return dates in the future. The last date will be yesterday or today (if today is True). All parameters are optional:
@@ -506,6 +507,7 @@ Returns a list of dates in the format 'YYYY-MM-DD'. This function will not retur
 + limit: maximum number of days. The default is 200
 + span: the range of dates. One of 'day', 'week', 'month' or 'year', '2days' or 'weekday'
 + today: 1 allows today to be included, 2 allows future dates to be included. Default is 0, date list will stop at yesterday
++ step: optional days to add (default is 1)
 
 You can use 'span' as follows:
 + 'day' provides a single day
@@ -830,6 +832,14 @@ This setting can be:
 
 # Version Info
 
+2.9.5 - 2026/02/27<br>
+Add step parameter to date_list().
+Get maxGroupCount from v3 scheduler and update f.max_periods with maximum number of time periods supported.
+
+2.9.4 - 2026/01/22<br>
+Rename get_battery_heating(), set_battery_heating() to get_heating() and set_heating().
+Update get_heating() to return a dictionary to simplify parameter access.
+
 2.9.3 - 2026/01/18<br>
 Update get_device() to use v1 API call.
 Update get_battery() to work out battery count and rated capacity from device battery list.

{foxesscloud-2.9.3 → foxesscloud-2.9.5}/README.md

@@ -104,7 +104,7 @@ f.get_peakshaving()
 f.get_flag()
 f.get_schedule()
 f.get_named_settings(name)
-f.get_battery_heating()
+f.get_heating()
 
 ```
 Each of these calls will return a dictionary or list containing the relevant information.
@@ -125,6 +125,7 @@ get_settings() will return the battery settings and is equivalent to get_charge(
 get_peakshaving() will return the current peak shaving settings for inverters that support this work mode.
 
 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.
 
 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().
@@ -133,7 +134,7 @@ get_named_settings() returns the value of a named setting. If 'name' is a list,
 + f.named_settings is updated. This is dictionary of information and current value, indexed by 'name'.
 + named_settings currently available are stored in f.name_list. The settings supported depends on the inverter model and firmware version. An error will be returned if an unsupported variable is used.
 
-get_battery_heating returns the current battery heating parameters and store these in f.battery_heating
+get_heating returns the current battery heating parameters and store these in f.device['heating']
 
 ## Inverter Settings
 You can change inverter settings using:
@@ -144,7 +145,7 @@ f.set_charge(ch1, st1, en1, ch2, st2, en2, enable)
 f.set_period(start, end, mode, min_soc, max_soc, fdsoc, fdpwr, price, segment)
 f.set_schedule(periods, enable)
 f.set_named_settings(name, value, force)
-f.set_battery_heating(enable, start, end, time1, time2, time3)
+f.set_heating(enable, start, end, time1, time2, time3)
 ```
 
 set_min() applies new SoC settings to the inverter. The parameters update battery_settings:
@@ -187,7 +188,7 @@ set_named_settings() sets the 'name' setting to 'value'.
 + a return value of 1 is success. 0 means setting failed. None is another error e.g. device not found, invalid name or value.
 + named_settings currently available are stored in f.name_list. The settings supported depend on the inverter model and firmware version. An error will be returned if an unsupported varaible is used.
 
-set_battery_heating() set the heating parameters as follows:
+set_heating() set the heating parameters as follows:
 + enable: optional, 0 or 1, default is 1
 + start, end: optional start and end temperatures. The defaults are start at 9C and end at 12C.
 + time1, time2, time3: optional times when the battery can heat from the grid time. The structure is {'enable': 1, 'start': '00:30', 'end': '05:30'}. The time slot is disabled by default.
@@ -482,7 +483,7 @@ This is an example of the output from battery_info():
 ## Date Ranges
 
 ```
-f.date_list(s, e, limit, span, today)
+f.date_list(s, e, limit, span, today, step)
 ```
 
 Returns a list of dates in the format 'YYYY-MM-DD'. This function will not return dates in the future. The last date will be yesterday or today (if today is True). All parameters are optional:
@@ -492,6 +493,7 @@ Returns a list of dates in the format 'YYYY-MM-DD'. This function will not retur
 + limit: maximum number of days. The default is 200
 + span: the range of dates. One of 'day', 'week', 'month' or 'year', '2days' or 'weekday'
 + today: 1 allows today to be included, 2 allows future dates to be included. Default is 0, date list will stop at yesterday
++ step: optional days to add (default is 1)
 
 You can use 'span' as follows:
 + 'day' provides a single day
@@ -816,6 +818,14 @@ This setting can be:
 
 # Version Info
 
+2.9.5 - 2026/02/27<br>
+Add step parameter to date_list().
+Get maxGroupCount from v3 scheduler and update f.max_periods with maximum number of time periods supported.
+
+2.9.4 - 2026/01/22<br>
+Rename get_battery_heating(), set_battery_heating() to get_heating() and set_heating().
+Update get_heating() to return a dictionary to simplify parameter access.
+
 2.9.3 - 2026/01/18<br>
 Update get_device() to use v1 API call.
 Update get_battery() to work out battery count and rated capacity from device battery list.

{foxesscloud-2.9.3 → foxesscloud-2.9.5}/pyproject.toml

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

{foxesscloud-2.9.3 → foxesscloud-2.9.5}/src/foxesscloud/foxesscloud.py

@@ -1,7 +1,7 @@
 ##################################################################################################
 """
 Module:   Fox ESS Cloud
-Updated:  18 January 2026
+Updated:  11 February 2026
 By:       Tony Matthews
 """
 ##################################################################################################
@@ -10,7 +10,7 @@ By:       Tony Matthews
 # ALL RIGHTS ARE RESERVED © Tony Matthews 2023
 ##################################################################################################
 
-version = "1.11.0"
+version = "1.11.1"
 print(f"FoxESS-Cloud version {version}")
 
 debug_setting = 1
@@ -3821,7 +3821,7 @@ def battery_monitor(interval=30, run=48, log=1, count=None, save=None, overwrite
 # span: 'week', 'month' or 'year' generated dates that span a week, month or year
 # quiet: do not print results if True
 
-def date_list(s = None, e = None, limit = None, span = None, today = 0, quiet = True):
+def date_list(s = None, e = None, limit = None, span = None, today = 0, quiet = True, step=1):
     global debug_setting
     latest_date = datetime.date(datetime.now())
     today = 0 if today == False else 1 if today == True else today
@@ -3830,7 +3830,6 @@ def date_list(s = None, e = None, limit = None, span = None, today = 0, quiet =
     first = datetime.date(datetime.strptime(s, '%Y-%m-%d')) if type(s) is str else s.date() if s is not None else None
     last = datetime.date(datetime.strptime(e, '%Y-%m-%d')) if type(e) is str else e.date() if e is not None else None
     last = latest_date if last is not None and last > latest_date and today != 2 else last
-    step = 1
     if first is None and last is None:
         last = latest_date
     if span is not None:

{foxesscloud-2.9.3 → foxesscloud-2.9.5}/src/foxesscloud/openapi.py

@@ -1,7 +1,7 @@
 ##################################################################################################
 """
 Module:   Fox ESS Cloud using Open API
-Updated:  18 January 2025
+Updated:  27 February 2026
 By:       Tony Matthews
 """
 ##################################################################################################
@@ -10,7 +10,7 @@ By:       Tony Matthews
 # ALL RIGHTS ARE RESERVED © Tony Matthews 2024
 ##################################################################################################
 
-version = "2.9.3"
+version = "2.9.5"
 print(f"FoxESS-Cloud Open API version {version}")
 
 debug_setting = 1
@@ -692,10 +692,8 @@ def get_battery_real():
 # battery heating settings
 ##################################################################################################
 
-battery_heating = None
-
-def get_battery_heating():
-    global device_sn, device, battery_heating
+def get_heating():
+    global device_sn, device
     if get_device() is None:
         return None
     output(f"getting battery heating", 2)
@@ -705,42 +703,59 @@ def get_battery_heating():
         output(f"** get_battery_heating() got response code {response.status_code}: {response.reason}")
         return None
     errno = response.json().get('errno')
-    if errno != 0:
-        if errno == 41200:
-            output(f"** get_battery_heating(): not supported")
-        else:
-            output(f"** get_battery_heating(): {errno_message(response)}")
-        return None
     result = response.json().get('result')
-    battery_heating = result
-    return result
+    if errno != 0 and errno != 41200:
+        output(f"** get_battery_heating(): {errno_message(response)}")
+        return None
+    if result is None:
+        items = None
+    else:
+        items = {'result': result}
+        for i in result['dataList']:
+            n = i['name']
+            if 'time' in n:
+                j = n[:5]
+                if items.get(j) is None:
+                    items[j] = {'enable': 0, 'start': 0.0, 'end': 0.0}
+                k = 'end' if 'End' in n else 'start' if 'Start' in n else 'enable'
+                if k == 'enable':
+                    items[j]['enable'] = 0 if i['value'] == 'disable' else 1
+                else:
+                    t = (int(i['value']) / 60) if 'Minute' in n else int(i['value'])
+                    items[j][k] += t
+            else:
+                items[i['name']] = i['value']
+    device['heating'] = items
+    return items
 
 def set_time(body, s, time):
     if time is None:
-        body[s + 'Enable'] = 0
-        body[s + 'StartHour'] = 0
-        body[s + 'StartMinute'] = 0
-        body[s + 'EndHour'] = 0
-        body[s + 'EndMinute'] = 0
+        body[s + 'Enable'] = 'disable'
+        body[s + 'StartHour'] = '0'
+        body[s + 'StartMinute'] = '0'
+        body[s + 'EndHour'] = '0'
+        body[s + 'EndMinute'] = '0'
     else:
-        body[s + 'Enable'] = time['enable']
+        body[s + 'Enable'] = 'enable' if time['enable'] == 1 else 'disable'
         t = time_hours(time['start'])
-        body[s + 'StartHour'] = int(t)
-        body[s + 'StartMinute'] = int(60 * (t - int(t)) + 0.5)
+        body[s + 'StartHour'] = str(int(t))
+        body[s + 'StartMinute'] = str(int(60 * (t - int(t)) + 0.5))
         t = time_hours(time['end'])
-        body[s + 'EndHour'] = int(t)
-        body[s + 'EndMinute'] = int(60 * (t - int(t)) + 0.5)
+        body[s + 'EndHour'] = str(int(t))
+        body[s + 'EndMinute'] = str(int(60 * (t - int(t)) + 0.5))
     return
 
-def set_battery_heating(enable=None, start=None, end=None, time1=None, time2=None, time3=None):
+def set_heating(enable=None, start=None, end=None, time1=None, time2=None, time3=None):
     global device_sn, device
     if get_device() is None:
         return None
+    if get_heating() is None:
+        return 0
     output(f"setting battery heating", 2)
     body = {'sn': device_sn}
-    body['batteryWarmUpEnable'] = enable if enable is not None else 1
-    body['startTemperature'] = start if start is not None else 9
-    body['endTemperature'] = end if end is not None else 12
+    body['batteryWarmUpEnable'] = 'disable' if enable is not None and enable == 0 else 'enable'
+    body['startTemperature'] = str(start if start is not None else 9)
+    body['endTemperature'] = str(end if end is not None else 12)
     set_time(body, 'time1', time1)
     set_time(body, 'time2', time2)
     set_time(body, 'time3', time3)
@@ -750,11 +765,8 @@ def set_battery_heating(enable=None, start=None, end=None, time1=None, time2=Non
         return None
     errno = response.json().get('errno')
     if errno != 0:
-        if errno == 41200:
-            output(f"** set_battery_heating(): not supported")
-        else:
-            output(f"** set_battery_heating(): {errno_message(response)}")
-        return None
+        output(f"** set_battery_heating(): {errno_message(response)}")
+        return 0
     return 1
 
 ##################################################################################################
@@ -1139,7 +1151,7 @@ max_periods = 8
 
 # get the current switch status
 def get_flag():
-    global device_sn, schedule, debug_setting
+    global device_sn, schedule, debug_setting, max_periods
     if get_device() is None:
         return None
     output(f"getting flag", 2)
@@ -1157,6 +1169,17 @@ def get_flag():
     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)
+        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}")
+            return None
+        result = response.json().get('result')
+        if result is not None:
+            schedule['maxGroupCount'] = result.get('maxGroupCount')
+            max_periods = schedule['maxGroupCount']
     return schedule
 
 ##################################################################################################
@@ -3608,7 +3631,7 @@ def battery_monitor(interval=30, run=48, log=1, count=None, save=None, overwrite
 # span: 'week', 'month' or 'year' generated dates that span a week, month or year
 # quiet: do not print results if True
 
-def date_list(s = None, e = None, limit = None, span = None, today = 0, quiet = True):
+def date_list(s = None, e = None, limit = None, span = None, today = 0, quiet = True, step=1):
     global debug_setting
     latest_date = datetime.date(datetime.now())
     today = 0 if today == False else 1 if today == True else today
@@ -3617,7 +3640,6 @@ def date_list(s = None, e = None, limit = None, span = None, today = 0, quiet =
     first = datetime.date(datetime.strptime(s, '%Y-%m-%d')) if type(s) is str else s.date() if s is not None else None
     last = datetime.date(datetime.strptime(e, '%Y-%m-%d')) if type(e) is str else e.date() if e is not None else None
     last = latest_date if last is not None and last > latest_date and today != 2 else last
-    step = 1
     if first is None and last is None:
         last = latest_date
     if span is not None:

{foxesscloud-2.9.3 → foxesscloud-2.9.5/src/foxesscloud.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxesscloud
-Version: 2.9.3
+Version: 2.9.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
@@ -118,7 +118,7 @@ f.get_peakshaving()
 f.get_flag()
 f.get_schedule()
 f.get_named_settings(name)
-f.get_battery_heating()
+f.get_heating()
 
 ```
 Each of these calls will return a dictionary or list containing the relevant information.
@@ -139,6 +139,7 @@ get_settings() will return the battery settings and is equivalent to get_charge(
 get_peakshaving() will return the current peak shaving settings for inverters that support this work mode.
 
 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.
 
 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().
@@ -147,7 +148,7 @@ get_named_settings() returns the value of a named setting. If 'name' is a list,
 + f.named_settings is updated. This is dictionary of information and current value, indexed by 'name'.
 + named_settings currently available are stored in f.name_list. The settings supported depends on the inverter model and firmware version. An error will be returned if an unsupported variable is used.
 
-get_battery_heating returns the current battery heating parameters and store these in f.battery_heating
+get_heating returns the current battery heating parameters and store these in f.device['heating']
 
 ## Inverter Settings
 You can change inverter settings using:
@@ -158,7 +159,7 @@ f.set_charge(ch1, st1, en1, ch2, st2, en2, enable)
 f.set_period(start, end, mode, min_soc, max_soc, fdsoc, fdpwr, price, segment)
 f.set_schedule(periods, enable)
 f.set_named_settings(name, value, force)
-f.set_battery_heating(enable, start, end, time1, time2, time3)
+f.set_heating(enable, start, end, time1, time2, time3)
 ```
 
 set_min() applies new SoC settings to the inverter. The parameters update battery_settings:
@@ -201,7 +202,7 @@ set_named_settings() sets the 'name' setting to 'value'.
 + a return value of 1 is success. 0 means setting failed. None is another error e.g. device not found, invalid name or value.
 + named_settings currently available are stored in f.name_list. The settings supported depend on the inverter model and firmware version. An error will be returned if an unsupported varaible is used.
 
-set_battery_heating() set the heating parameters as follows:
+set_heating() set the heating parameters as follows:
 + enable: optional, 0 or 1, default is 1
 + start, end: optional start and end temperatures. The defaults are start at 9C and end at 12C.
 + time1, time2, time3: optional times when the battery can heat from the grid time. The structure is {'enable': 1, 'start': '00:30', 'end': '05:30'}. The time slot is disabled by default.
@@ -496,7 +497,7 @@ This is an example of the output from battery_info():
 ## Date Ranges
 
 ```
-f.date_list(s, e, limit, span, today)
+f.date_list(s, e, limit, span, today, step)
 ```
 
 Returns a list of dates in the format 'YYYY-MM-DD'. This function will not return dates in the future. The last date will be yesterday or today (if today is True). All parameters are optional:
@@ -506,6 +507,7 @@ Returns a list of dates in the format 'YYYY-MM-DD'. This function will not retur
 + limit: maximum number of days. The default is 200
 + span: the range of dates. One of 'day', 'week', 'month' or 'year', '2days' or 'weekday'
 + today: 1 allows today to be included, 2 allows future dates to be included. Default is 0, date list will stop at yesterday
++ step: optional days to add (default is 1)
 
 You can use 'span' as follows:
 + 'day' provides a single day
@@ -830,6 +832,14 @@ This setting can be:
 
 # Version Info
 
+2.9.5 - 2026/02/27<br>
+Add step parameter to date_list().
+Get maxGroupCount from v3 scheduler and update f.max_periods with maximum number of time periods supported.
+
+2.9.4 - 2026/01/22<br>
+Rename get_battery_heating(), set_battery_heating() to get_heating() and set_heating().
+Update get_heating() to return a dictionary to simplify parameter access.
+
 2.9.3 - 2026/01/18<br>
 Update get_device() to use v1 API call.
 Update get_battery() to work out battery count and rated capacity from device battery list.