foxesscloud 2.8.4__tar.gz → 2.8.6__tar.gz

{foxesscloud-2.8.4 → foxesscloud-2.8.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxesscloud
-Version: 2.8.4
+Version: 2.8.6
 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
@@ -15,7 +15,7 @@ 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>
-This site contains sample python code for accessing the Fox cloud data via the REST API used by the Fox ESS Cloud web site and app.
+This site contains sample python code for accessing the Fox cloud data via the REST API.
 
 There is also a number of Jupyter Lab notebooks with examples of how to run the sample code.
 
@@ -109,6 +109,7 @@ f.get_batteries(info, rated, count)
 f.get_settings()
 f.get_charge()
 f.get_min()
+f.get_peakshaving()
 f.get_flag()
 f.get_schedule()
 f.get_named_settings(name)
@@ -132,6 +133,8 @@ Additional battery attributes provided include:
 
 get_settings() will return the battery settings and is equivalent to get_charge() and get_min(). The results are stored in f.battery_settings. The settings include minSoc, minSocOnGrid, enable charge from grid and the charge times.
 
+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.
 
 get_schedule() returns the current work mode / soc schedule settings. The result is stored in f.schedule.
@@ -205,7 +208,7 @@ Real time data reports the latest values for inverter variables, collected every
 ```
 f.invert_ct2 = 1
 f.get_vars()
-f.get_real(v)
+f.get_real(v, sns, version)
 ```
 
 f.invert_ct2 determines how the meterPower2 data is handled. When invert_ct2 = 0, meterPower2 produces +ve power values during secondary generation. If meterPower2 produces -ve power values during secondary generation, setting invert_ct2 = 1 will flip the values so they are +ve when generating. The default setting is 1 (invert).
@@ -220,6 +223,8 @@ There are also pre-defined lists:
 
 f.get_real returns the latest values for a list of variables.
 + v is a variable, or list of variables. The default is to return the latest value for all available variables
++ sns is an optional inverter serial number or a list of inverter serial numbers to get data for. The default is the current device
++ version determines the format of the output. By default, get_real() returns a list of variables for a single inverter (legacy mode). Setting version=1 returns a list of inverter results using the v1 Open API format.
 
 
 ## History Data
@@ -821,6 +826,14 @@ This setting can be:
 
 # Version Info
 
+2.8.6<br>#
+Update to charge_needed() to get current work mode.
+
+2.8.5<br>
+Update battery variables to include SOH.
+Add get_peakshaving().
+Update get_real() to support a list of inverters using Open API v1.
+
 2.8.4<br>
 Fix exception when calling pvoutput with tou=1 but no tariff set.
 

foxesscloud-2.8.4/src/foxesscloud.egg-info/PKG-INFO → foxesscloud-2.8.6/README.md

@@ -1,21 +1,7 @@
-Metadata-Version: 2.1
-Name: foxesscloud
-Version: 2.8.4
-Summary: library for accessing Fox ESS cloud data using Open API
-Author-email: Tony Matthews <tony@quasair.co.uk>
-Project-URL: Homepage, https://github.com/TonyM1958/FoxESS-Cloud
-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>
-This site contains sample python code for accessing the Fox cloud data via the REST API used by the Fox ESS Cloud web site and app.
+This site contains sample python code for accessing the Fox cloud data via the REST API.
 
 There is also a number of Jupyter Lab notebooks with examples of how to run the sample code.
 
@@ -109,6 +95,7 @@ f.get_batteries(info, rated, count)
 f.get_settings()
 f.get_charge()
 f.get_min()
+f.get_peakshaving()
 f.get_flag()
 f.get_schedule()
 f.get_named_settings(name)
@@ -132,6 +119,8 @@ Additional battery attributes provided include:
 
 get_settings() will return the battery settings and is equivalent to get_charge() and get_min(). The results are stored in f.battery_settings. The settings include minSoc, minSocOnGrid, enable charge from grid and the charge times.
 
+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.
 
 get_schedule() returns the current work mode / soc schedule settings. The result is stored in f.schedule.
@@ -205,7 +194,7 @@ Real time data reports the latest values for inverter variables, collected every
 ```
 f.invert_ct2 = 1
 f.get_vars()
-f.get_real(v)
+f.get_real(v, sns, version)
 ```
 
 f.invert_ct2 determines how the meterPower2 data is handled. When invert_ct2 = 0, meterPower2 produces +ve power values during secondary generation. If meterPower2 produces -ve power values during secondary generation, setting invert_ct2 = 1 will flip the values so they are +ve when generating. The default setting is 1 (invert).
@@ -220,6 +209,8 @@ There are also pre-defined lists:
 
 f.get_real returns the latest values for a list of variables.
 + v is a variable, or list of variables. The default is to return the latest value for all available variables
++ sns is an optional inverter serial number or a list of inverter serial numbers to get data for. The default is the current device
++ version determines the format of the output. By default, get_real() returns a list of variables for a single inverter (legacy mode). Setting version=1 returns a list of inverter results using the v1 Open API format.
 
 
 ## History Data
@@ -821,6 +812,14 @@ This setting can be:
 
 # Version Info
 
+2.8.6<br>#
+Update to charge_needed() to get current work mode.
+
+2.8.5<br>
+Update battery variables to include SOH.
+Add get_peakshaving().
+Update get_real() to support a list of inverters using Open API v1.
+
 2.8.4<br>
 Fix exception when calling pvoutput with tou=1 but no tariff set.
 

{foxesscloud-2.8.4 → foxesscloud-2.8.6}/pyproject.toml

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

{foxesscloud-2.8.4 → foxesscloud-2.8.6}/src/foxesscloud/openapi.py

@@ -1,7 +1,7 @@
 ##################################################################################################
 """
 Module:   Fox ESS Cloud using Open API
-Updated:  20 May 2025
+Updated:  5 July 2025
 By:       Tony Matthews
 """
 ##################################################################################################
@@ -10,7 +10,7 @@ By:       Tony Matthews
 # ALL RIGHTS ARE RESERVED © Tony Matthews 2024
 ##################################################################################################
 
-version = "2.8.4"
+version = "2.8.6"
 print(f"FoxESS-Cloud Open API version {version}")
 
 debug_setting = 1
@@ -549,8 +549,8 @@ def get_generation(update=1):
 battery = None
 batteries = None
 battery_settings = None
-battery_vars = ['SoC', 'invBatVolt', 'invBatCurrent', 'invBatPower', 'batTemperature', 'ResidualEnergy' ]
-battery_data = ['soc', 'volt', 'current', 'power', 'temperature', 'residual']
+battery_vars = ['SoC', 'invBatVolt', 'invBatCurrent', 'invBatPower', 'batTemperature', 'ResidualEnergy','SOH' ]
+battery_data = ['soc', 'volt', 'current', 'power', 'temperature', 'residual', 'soh']
 
 # 1 = Residual Energy, 2 = Residual Capacity (HV), 3 = Residual Capacity per battery (Mira)
 residual_handling = 1
@@ -837,6 +837,33 @@ def get_settings():
     get_min()
     return battery_settings
 
+##################################################################################################
+# get peak shaving settings
+##################################################################################################
+
+def get_peakshaving():
+    global device_sn, debug_setting
+    if get_device() is None:
+        return None
+    output(f"getting peak shaving", 2)
+    body = {'sn': device_sn}
+    response = signed_post(path="/op/v0/device/peakShaving/get", body=body)
+    if response.status_code != 200:
+        output(f"** get_peakshaving() got response code {response.status_code}: {response.reason}")
+        return None
+    errno = response.json().get('errno')
+    if errno != 0:
+        if errno == 40257:
+            output(f"** Peak Shaving is not available")
+        else:
+            output(f"** get_peakshaving(), {errno_message(response)}")
+        return None
+    result = response.json().get('result')
+    if result is None:
+        output(f"** get_peakshaving(), no result data, {errno_message(response)}")
+        return None
+    return result
+
 ##################################################################################################
 # get remote settings
 ##################################################################################################
@@ -923,8 +950,6 @@ def get_work_mode():
     global work_mode
     if get_device() is None:
         return None
-    # not implemented by Open API, skip to avoid error
-    return None
     work_mode = get_named_settings('WorkMode')
     return work_mode
 
@@ -1191,20 +1216,21 @@ def set_schedule(periods=None, enable=True):
 residual_scale = 0.01
 
 # get real time data
-def get_real(v = None):
+def get_real(v = None, sns = None, version = 0):
     global device_sn, debug_setting, device, power_vars, invert_ct2, residual_scale
-    if get_device() is None:
-        return None
-    if device['status'] > 1:
-        status_code = device['status']
-        state = 'fault' if status_code == 2 else 'off-line' if status_code == 3 else 'unknown'
-        output(f"** get_real(): device {device_sn} is not on-line, status = {state} ({device['status']})")
-        return None
+    if sns is None:
+        if get_device() is None:
+            return None
+        if device['status'] > 1:
+            status_code = device['status']
+            state = 'fault' if status_code == 2 else 'off-line' if status_code == 3 else 'unknown'
+            output(f"** get_real(): device {device_sn} is not on-line, status = {state} ({device['status']})")
+            return None
     output(f"getting real-time data", 2)
-    body = {'deviceSN': device_sn}
+    body = {'sns': sns if sns is not None and type(sns) is list else [sns] if sns is not None else [device_sn]}
     if v is not None:
         body['variables'] = v if type(v) is list else [v]
-    response = signed_post(path="/op/v0/device/real/query", body=body)
+    response = signed_post(path="/op/v1/device/real/query", body=body)
     if response.status_code != 200:
         output(f"** get_real() got response code {response.status_code}: {response.reason}")
         return None
@@ -1214,17 +1240,18 @@ def get_real(v = None):
         return None
     if len(result) < 1:
         return None
-    elif len(result) > 1:
-        output(f"** get_real(), more than 1 value returned: {result}")
-    result = result[0]['datas']
-    for var in result:
-        if var.get('variable') == 'meterPower2' and invert_ct2 == 1:
-            var['value'] *= -1
-        elif var.get('variable') == 'ResidualEnergy':
-            var['unit'] = 'kWh'
-            var['value'] = var['value'] * residual_scale
-        elif var.get('unit') is None:
-            var['unit'] = ''
+    for r in result:
+        datas = r['datas']
+        for var in datas:
+            if var.get('variable') == 'meterPower2' and invert_ct2 == 1:
+                var['value'] *= -1
+            elif var.get('variable') == 'ResidualEnergy':
+                var['unit'] = 'kWh'
+                var['value'] = var['value'] * residual_scale
+            elif var.get('unit') is None:
+                var['unit'] = ''
+    if version == 0 and type(sns) is not list:
+        result = result[0]['datas'] 
     return result
 
 

foxesscloud-2.8.4/README.md → foxesscloud-2.8.6/src/foxesscloud.egg-info/PKG-INFO

@@ -1,7 +1,21 @@
+Metadata-Version: 2.1
+Name: foxesscloud
+Version: 2.8.6
+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>
-This site contains sample python code for accessing the Fox cloud data via the REST API used by the Fox ESS Cloud web site and app.
+This site contains sample python code for accessing the Fox cloud data via the REST API.
 
 There is also a number of Jupyter Lab notebooks with examples of how to run the sample code.
 
@@ -95,6 +109,7 @@ f.get_batteries(info, rated, count)
 f.get_settings()
 f.get_charge()
 f.get_min()
+f.get_peakshaving()
 f.get_flag()
 f.get_schedule()
 f.get_named_settings(name)
@@ -118,6 +133,8 @@ Additional battery attributes provided include:
 
 get_settings() will return the battery settings and is equivalent to get_charge() and get_min(). The results are stored in f.battery_settings. The settings include minSoc, minSocOnGrid, enable charge from grid and the charge times.
 
+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.
 
 get_schedule() returns the current work mode / soc schedule settings. The result is stored in f.schedule.
@@ -191,7 +208,7 @@ Real time data reports the latest values for inverter variables, collected every
 ```
 f.invert_ct2 = 1
 f.get_vars()
-f.get_real(v)
+f.get_real(v, sns, version)
 ```
 
 f.invert_ct2 determines how the meterPower2 data is handled. When invert_ct2 = 0, meterPower2 produces +ve power values during secondary generation. If meterPower2 produces -ve power values during secondary generation, setting invert_ct2 = 1 will flip the values so they are +ve when generating. The default setting is 1 (invert).
@@ -206,6 +223,8 @@ There are also pre-defined lists:
 
 f.get_real returns the latest values for a list of variables.
 + v is a variable, or list of variables. The default is to return the latest value for all available variables
++ sns is an optional inverter serial number or a list of inverter serial numbers to get data for. The default is the current device
++ version determines the format of the output. By default, get_real() returns a list of variables for a single inverter (legacy mode). Setting version=1 returns a list of inverter results using the v1 Open API format.
 
 
 ## History Data
@@ -807,6 +826,14 @@ This setting can be:
 
 # Version Info
 
+2.8.6<br>#
+Update to charge_needed() to get current work mode.
+
+2.8.5<br>
+Update battery variables to include SOH.
+Add get_peakshaving().
+Update get_real() to support a list of inverters using Open API v1.
+
 2.8.4<br>
 Fix exception when calling pvoutput with tou=1 but no tariff set.