PySaxPower 2.0.0__tar.gz → 2.0.2__tar.gz

{pysaxpower-2.0.0 → pysaxpower-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PySaxPower
-Version: 2.0.0
+Version: 2.0.2
 Summary: Python package to read and write data from/to SAX Power Home Plus batteries.
 Author: Hannes
 License-Expression: MIT
@@ -19,17 +19,15 @@ Dynamic: license-file
 
 ## Overview
 
-Here’s a more polished and concise version of your text with improved clarity, flow, and grammar:
-
----
-
-With **PySaxPower**, you can read Modbus registers from **SAX Power Home Plus** batteries. The package is divided into two protocol implementations: **SunSpec** and **Basic**. The **Basic** protocol supports read-only operations.
+With **PySaxPower**, you can read Modbus registers from **SAX Power Home Plus** batteries. 
+The package is divided into two protocol implementations: **SunSpec** and **Basic**. 
+The **Basic** protocol supports read-only operations. 
+View the [manual](https://sax-power.net/download/Handbuch_SAX_Home_Plus_7,7_EN.pdf) for more informations.
 
 > **Note:**
-> Due to a firmware bug in SAX devices, **only the SunSpec protocol supports writing to registers**.
-> To use this feature, ensure your battery has at least **Master V61** and **Gateway V54** firmware versions. If not, you may need to update your firmware or contact **Customer Support**.
-
----
+> Due to a firmware error in SAX devices, only the SunSpec protocol supports writing to registers.
+> To use this function, please ensure that at least firmware versions `Master V61` and `Gateway V54`, are installed on your battery. If this is not the case, you will need to update your firmware.
+> You have to contact the customer support for this.
 
 ---
 
@@ -38,7 +36,7 @@ With **PySaxPower**, you can read Modbus registers from **SAX Power Home Plus**
 
 | **Device**                        | **Documentation**                                                                |
 | --------------------------------- |----------------------------------------------------------------------------------|
-| Power Home Plus 5.8 kWh / 7.7 kWh | [Product page](https://sax-power.net/download/Handbuch_SAX_Home_Plus_7,7_EN.pdf) |
+| Power Home Plus 5.8 kWh / 7.7 kWh | [Product page](https://sax-power.net/en/products/sax-power-home-plus-7-7-kwh/) |
 
 
 ---
@@ -89,6 +87,8 @@ write_values = {
 device.write_registers(write_values)
 ```
 
+---
+
 ### Basic
 ```python
 from pysaxpower import PowerHomePlusBasic

{pysaxpower-2.0.0 → pysaxpower-2.0.2}/PySaxPower.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PySaxPower
-Version: 2.0.0
+Version: 2.0.2
 Summary: Python package to read and write data from/to SAX Power Home Plus batteries.
 Author: Hannes
 License-Expression: MIT
@@ -19,17 +19,15 @@ Dynamic: license-file
 
 ## Overview
 
-Here’s a more polished and concise version of your text with improved clarity, flow, and grammar:
-
----
-
-With **PySaxPower**, you can read Modbus registers from **SAX Power Home Plus** batteries. The package is divided into two protocol implementations: **SunSpec** and **Basic**. The **Basic** protocol supports read-only operations.
+With **PySaxPower**, you can read Modbus registers from **SAX Power Home Plus** batteries. 
+The package is divided into two protocol implementations: **SunSpec** and **Basic**. 
+The **Basic** protocol supports read-only operations. 
+View the [manual](https://sax-power.net/download/Handbuch_SAX_Home_Plus_7,7_EN.pdf) for more informations.
 
 > **Note:**
-> Due to a firmware bug in SAX devices, **only the SunSpec protocol supports writing to registers**.
-> To use this feature, ensure your battery has at least **Master V61** and **Gateway V54** firmware versions. If not, you may need to update your firmware or contact **Customer Support**.
-
----
+> Due to a firmware error in SAX devices, only the SunSpec protocol supports writing to registers.
+> To use this function, please ensure that at least firmware versions `Master V61` and `Gateway V54`, are installed on your battery. If this is not the case, you will need to update your firmware.
+> You have to contact the customer support for this.
 
 ---
 
@@ -38,7 +36,7 @@ With **PySaxPower**, you can read Modbus registers from **SAX Power Home Plus**
 
 | **Device**                        | **Documentation**                                                                |
 | --------------------------------- |----------------------------------------------------------------------------------|
-| Power Home Plus 5.8 kWh / 7.7 kWh | [Product page](https://sax-power.net/download/Handbuch_SAX_Home_Plus_7,7_EN.pdf) |
+| Power Home Plus 5.8 kWh / 7.7 kWh | [Product page](https://sax-power.net/en/products/sax-power-home-plus-7-7-kwh/) |
 
 
 ---
@@ -89,6 +87,8 @@ write_values = {
 device.write_registers(write_values)
 ```
 
+---
+
 ### Basic
 ```python
 from pysaxpower import PowerHomePlusBasic

{pysaxpower-2.0.0 → pysaxpower-2.0.2}/README.md

@@ -6,17 +6,15 @@
 
 ## Overview
 
-Here’s a more polished and concise version of your text with improved clarity, flow, and grammar:
-
----
-
-With **PySaxPower**, you can read Modbus registers from **SAX Power Home Plus** batteries. The package is divided into two protocol implementations: **SunSpec** and **Basic**. The **Basic** protocol supports read-only operations.
+With **PySaxPower**, you can read Modbus registers from **SAX Power Home Plus** batteries. 
+The package is divided into two protocol implementations: **SunSpec** and **Basic**. 
+The **Basic** protocol supports read-only operations. 
+View the [manual](https://sax-power.net/download/Handbuch_SAX_Home_Plus_7,7_EN.pdf) for more informations.
 
 > **Note:**
-> Due to a firmware bug in SAX devices, **only the SunSpec protocol supports writing to registers**.
-> To use this feature, ensure your battery has at least **Master V61** and **Gateway V54** firmware versions. If not, you may need to update your firmware or contact **Customer Support**.
-
----
+> Due to a firmware error in SAX devices, only the SunSpec protocol supports writing to registers.
+> To use this function, please ensure that at least firmware versions `Master V61` and `Gateway V54`, are installed on your battery. If this is not the case, you will need to update your firmware.
+> You have to contact the customer support for this.
 
 ---
 
@@ -25,7 +23,7 @@ With **PySaxPower**, you can read Modbus registers from **SAX Power Home Plus**
 
 | **Device**                        | **Documentation**                                                                |
 | --------------------------------- |----------------------------------------------------------------------------------|
-| Power Home Plus 5.8 kWh / 7.7 kWh | [Product page](https://sax-power.net/download/Handbuch_SAX_Home_Plus_7,7_EN.pdf) |
+| Power Home Plus 5.8 kWh / 7.7 kWh | [Product page](https://sax-power.net/en/products/sax-power-home-plus-7-7-kwh/) |
 
 
 ---
@@ -76,6 +74,8 @@ write_values = {
 device.write_registers(write_values)
 ```
 
+---
+
 ### Basic
 ```python
 from pysaxpower import PowerHomePlusBasic
@@ -96,4 +96,4 @@ values = device.get_values(read_values)
 print(values)
 
 device.close()
-```
+```

{pysaxpower-2.0.0 → pysaxpower-2.0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "PySaxPower"
-version = "2.0.0"
+version = "2.0.2"
 description = "Python package to read and write data from/to SAX Power Home Plus batteries."
 readme = "README.md"
 requires-python = ">=3.7"
@@ -17,4 +17,4 @@ dependencies = [
 ]
 
 [project.urls]
-Homepage = "https://github.com/Hans-4/pysaxpower"
+Homepage = "https://github.com/Hans-4/pysaxpower"

pysaxpower-2.0.2/pysaxpower/sunspec/scalefactors.py

@@ -0,0 +1,55 @@
+from pysaxpower.sunspec.register import SunSpecRegister
+
+
+class SunSpecScaleFactors(object):
+
+    def __init__(self):
+        self.register = SunSpecRegister()
+
+    def search_scale_factor(self, address: int) -> int | None:
+        r = self.register
+
+        if 40017 <= address <= 40020:
+            return r.AC_Current_Scalefactor
+        elif 40022 <= address <= 40027:
+            return r.Voltage_Scalefactor
+        elif address == 40029:
+            return r.ActivePower_Scalefactor
+        elif address == 40031:
+            return r.Frequency_Scalefactor
+        elif address == 40033:
+            return r.ApparentPower_Scalefactor
+        elif address == 40035:
+            return r.ReactivePower_Scalefactor
+        elif address == 40037:
+            return r.PowerFactor_Scalefactor
+        elif address == 40041:
+            return r.Temperature_Scalefactor
+        elif address == 40045:
+            return r.PV_Power_Scalefactor
+        elif address == 40049:
+            return r.PowerTargetScalefactor
+        elif 40056 <= address <= 40059:
+            return r.AC_Current_Scalefactor_Grid
+        elif 40061 <= address <= 40068:
+            return r.Voltage_Scalefactor_Grid
+        elif address == 40070:
+            return r.Frequency_Scalefactor_Grid
+        elif 40072 <= address <= 40075:
+            return r.ActiveGridPower_Scalefactor
+        elif 40077 <= address <= 40080:
+            return r.ApparentPower_Scalefactor_Grid
+        elif 40082 <= address <= 40085:
+            return r.ReactivePower_Scalefactor_Grid
+        elif 40087 <= address <= 40090:
+            return r.PowerFactor_Scalefactor_Grid
+        elif address == 40097:
+            return r.Capacity_Scalefactor
+        elif 40098 <= address <= 40099:
+            return r.ChargeDischargePower_Scalefactor
+        elif 40100 <= address <= 40102:
+            return r.SoC_Scalefactor
+        elif address == 40109:
+            return r.CellVoltage_Scalefactor
+        else:
+            return None

pysaxpower-2.0.0/pysaxpower/sunspec/scalefactors.py

@@ -1,86 +0,0 @@
-from pysaxpower.sunspec.register import SunSpecRegister
-
-
-class SunSpecScaleFactors(object):
-    """Ordnet einer Registeradresse die Adresse des zugehoerigen sunsf-Registers zu.
-
-    Rueckgabe ist die ADRESSE des Scalefaktor-Registers, nicht dessen Wert.
-    None bedeutet: fuer dieses Register existiert laut Dokumentation kein
-    Scalefaktor (Well-Known-Werte, Enums, Timeouts, sunsf-Register selbst).
-    """
-
-    def __init__(self):
-        self.register = SunSpecRegister()
-
-    def search_scale_factor(self, address: int) -> int | None:
-        r = self.register
-
-        # ------------------------------------------------------------------
-        # Modell 103 - Speicherelektronik (40015 - 40046)
-        # ------------------------------------------------------------------
-        if 40017 <= address <= 40020:                  # AC Strom Speicher Summe/A/B/C
-            return r.AC_Current_Scalefactor            # 40021, SF = -2
-        elif 40022 <= address <= 40027:                # Spannung Speicher L-L und A/B/C
-            return r.Voltage_Scalefactor               # 40028, SF = -1
-        elif address == 40029:                         # Wirkleistung Speicher Summe
-            return r.ActivePower_Scalefactor           # 40030, SF = 0
-        elif address == 40031:                         # Netzfrequenz (Speicher)
-            return r.Frequency_Scalefactor             # 40032, SF = -2
-        elif address == 40033:                         # Scheinleistung Speicher Summe
-            return r.ApparentPower_Scalefactor         # 40034, SF = 0
-        elif address == 40035:                         # Blindleistung Speicher Summe
-            return r.ReactivePower_Scalefactor         # 40036, SF = 0
-        elif address == 40037:                         # Leistungsfaktor Speicher Summe
-            return r.PowerFactor_Scalefactor           # 40038, SF = -3
-        elif address == 40041:                         # Maximale Zelltemperatur
-            return r.Temperature_Scalefactor           # 40042, SF = 0
-        elif address == 40045:                         # PV-Leistung (nur mit ADW200)
-            return r.PV_Power_Scalefactor              # 40046, SF = 1
-
-        # ------------------------------------------------------------------
-        # Modell 123 - Immediate Controls (40047 - 40053)
-        # ------------------------------------------------------------------
-        elif address == 40049:                         # Leistungsvorgabe prozentual
-            return r.PowerTargetScalefactor            # 40052, SF = -2
-        # 40050 Timeout (s), 40051 Steuermodus (Enum),
-        # 40053 Referenzwert Maximalleistung (W, Well-Known) -> kein SF
-
-        # ------------------------------------------------------------------
-        # Modell 203 - WYE Connect 3Ph Meter ABC / ADW200 (40054 - 40094)
-        # ------------------------------------------------------------------
-        elif 40056 <= address <= 40059:                # AC Strom Netz Summe/L1/L2/L3
-            return r.AC_Current_Scalefactor_Grid       # 40060, SF = -1
-        elif 40061 <= address <= 40068:                # Netzspannungen L-N und L-L
-            return r.Voltage_Scalefactor_Grid          # 40069, SF = -1
-        elif address == 40070:                         # Netzfrequenz
-            return r.Frequency_Scalefactor_Grid        # 40071, SF = -2
-        elif 40072 <= address <= 40075:                # Wirkleistung Netz Summe/L1/L2/L3
-            return r.ActiveGridPower_Scalefactor       # 40076, SF = 1
-        elif 40077 <= address <= 40080:                # Scheinleistung Netz Summe/L1/L2/L3
-            return r.ApparentPower_Scalefactor_Grid    # 40081, SF = 1
-        elif 40082 <= address <= 40085:                # Blindleistung Netz Summe/L1/L2/L3
-            return r.ReactivePower_Scalefactor_Grid    # 40086, SF = 1
-        elif 40087 <= address <= 40090:                # Leistungsfaktor Netz Summe/L1/L2/L3
-            return r.PowerFactor_Scalefactor_Grid      # 40091, SF = -3
-
-        # ------------------------------------------------------------------
-        # Modell 802 - Battery Base Model (40095 - 40114)
-        # ------------------------------------------------------------------
-        elif address == 40097:                         # Kapazitaet Speichersystem (Wh)
-            return r.Capacity_Scalefactor              # 40110, SF = 0
-        elif 40098 <= address <= 40099:                # Verf. Lade-/Entladeleistung (W)
-            return r.ChargeDischargePower_Scalefactor  # 40111, SF = 0
-        elif 40100 <= address <= 40102:                # Max/Min/Aktueller SoC (%)
-            return r.SoC_Scalefactor                   # 40112, SF = 0
-        elif address == 40109:                         # Durchschnittliche Zellspannung (mV)
-            return r.CellVoltage_Scalefactor           # 40114, SF = 0
-
-        # 40103 Entladetiefe (%): in der Dokumentation ist KEIN Scalefaktor
-        # zugeordnet. Kandidat waere 40113 (Reserve, int16 sunsf, Wert 0),
-        # das an der Position von DoD_SF im SunSpec-Modell 802 steht.
-        # Bewusst nicht geraten -> None.
-
-        # 40000-40016, 40039/40040, 40043/40044, 40092-40094, 40104-40108,
-        # sowie alle sunsf-Register selbst haben keinen Scalefaktor.
-        else:
-            return None