implemented get_powermeters() (#80)

* implemented get_powermeters()

Author: bullitt186

e3dc/_e3dc.py

@@ -22,6 +22,7 @@
 )
 from ._e3dc_rscp_web import E3DC_RSCP_web
 from ._rscpLib import rscpFindTag, rscpFindTagIndex
+from ._rscpTags import getPowermeterType
 
 REMOTE_ADDRESS = "https://s10.e3dc.com/s10/phpcmd/cmd.php"
 REQUEST_INTERVAL_SEC = 10  # minimum interval between requests
@@ -1746,6 +1747,50 @@ def get_pvis_data(self, pvis=None, keepAlive=False):
 
         return outObj
 
+    def get_powermeters(self, keepAlive=False):
+        """Scans for installed power meters via rscp protocol locally.
+
+        Args:
+            keepAlive (Optional[bool]): True to keep connection alive
+
+        Returns:
+            dict: Dictionary containing the found powermeters as follows.::
+
+                "powermeters": [
+                    {'index': 0, 'type': 1, 'typeName': 'PM_TYPE_ROOT'},
+                    {'index': 1, 'type': 4, 'typeName': 'PM_TYPE_ADDITIONAL_CONSUMPTION'}
+                ]
+        """
+        maxPowermeters = 8
+        outObj = []
+        for pmIndex in range(
+            maxPowermeters
+        ):  # max 8 powermeters according to E3DC spec
+            res = self.sendRequest(
+                (
+                    "PM_REQ_DATA",
+                    "Container",
+                    [
+                        ("PM_INDEX", "Uint16", pmIndex),
+                        ("PM_REQ_TYPE", "None", None),
+                    ],
+                ),
+                keepAlive=True if pmIndex < (maxPowermeters - 1) else keepAlive,
+            )
+
+            pmType = rscpFindTagIndex(res, "PM_TYPE")
+
+            if pmType is not None:
+                outObj.append(
+                    {
+                        "index": pmIndex,
+                        "type": pmType,
+                        "typeName": getPowermeterType(pmType),
+                    }
+                )
+
+        return outObj
+
     def get_powermeter_data(self, pmIndex=None, keepAlive=False):
         """Polls the power meter data via rscp protocol locally.
 

e3dc/_rscpTags.py

@@ -2101,6 +2101,18 @@ def getTag(tag_hex):
     0xFFFFFFFF: "UNEXPECTED ERROR",  # happens for example in get_db_data if time and span is invalid (not available)
 }
 
+powermeterTypes = {
+    0x00: "PM_TYPE_UNDEFINED",
+    0x01: "PM_TYPE_ROOT",
+    0x02: "PM_TYPE_ADDITIONAL",
+    0x03: "PM_TYPE_ADDITIONAL_PRODUCTION",
+    0x04: "PM_TYPE_ADDITIONAL_CONSUMPTION",
+    0x05: "PM_TYPE_FARM",
+    0x06: "PM_TYPE_UNUSED",
+    0x07: "PM_TYPE_WALLBOX",
+    0x08: "PM_TYPE_FARM_ADDITIONAL",
+}
+
 
 def getHexDatatype(type_str):
     """Get data type as hex.
@@ -2139,3 +2151,15 @@ def getErrorcode(error_hex):
         str: String representation of the given error_hex
     """
     return rscpErrorCodes[error_hex]
+
+
+def getPowermeterType(powermetertype_hex):
+    """Get powermeter type as string.
+
+    Attributes:
+        powermeterType_hex (int): type of the powermeter as hex
+
+    Returns:
+        str: String representation of the given powermeterType_hex
+    """
+    return powermeterTypes[powermetertype_hex]