Retrieve temperature, modem status and service flows (#16)

* Add retrieval for fun=144 (cmstatus)

* Add retrieval for interesting values of fun=136 (temperature)

Author: mbugert

connect_box/__init__.py

@@ -7,7 +7,14 @@
 from aiohttp.hdrs import REFERER, USER_AGENT
 import defusedxml.ElementTree as element_tree
 
-from .data import Device, DownstreamChannel, UpstreamChannel
+from .data import (
+    Device,
+    DownstreamChannel,
+    UpstreamChannel,
+    CmStatus,
+    ServiceFlow,
+    Temperature,
+)
 from . import exceptions
 
 _LOGGER = logging.getLogger(__name__)
@@ -19,6 +26,8 @@
 CMD_DEVICES = 123
 CMD_DOWNSTREAM = 10
 CMD_UPSTREAM = 11
+CMD_TEMPERATURE = 136
+CMD_CMSTATUS = 144
 
 
 class ConnectBox:
@@ -44,8 +53,12 @@ def __init__(
         self.devices: List[Device] = []
         self.ds_channels: List[DownstreamChannel] = []
         self.us_channels: List[UpstreamChannel] = []
+        self.cmstatus: Optional[CmStatus] = None
+        self.upstream_service_flows: List[ServiceFlow] = []
+        self.downstream_service_flows: List[ServiceFlow] = []
+        self.temperature: Optional[Temperature] = None
 
-    async def async_get_devices(self) -> List[Device]:
+    async def async_get_devices(self):
         """Scan for new devices and return a list with found device IDs."""
         if self.token is None:
             await self.async_initialize_token()
@@ -132,6 +145,75 @@ async def async_get_upstream(self):
             self.token = None
             raise exceptions.ConnectBoxNoDataAvailable() from None
 
+    async def async_get_cmstatus_and_service_flows(self):
+        """Get various status information."""
+        if self.token is None:
+            await self.async_initialize_token()
+
+        self.cmstatus = None
+        self.downstream_service_flows = []
+        self.upstream_service_flows = []
+        raw = await self._async_ws_function(CMD_CMSTATUS)
+
+        try:
+            xml_root = element_tree.fromstring(raw)
+            self.cmstatus = CmStatus(
+                provisioningStatus=xml_root.find("provisioning_st").text,
+                cmComment=xml_root.find("cm_comment").text,
+                cmDocsisMode=xml_root.find("cm_docsis_mode").text,
+                cmNetworkAccess=xml_root.find("cm_network_access").text,
+                numberOfCpes=int(xml_root.find("NumberOfCpes").text),
+                firmwareFilename=xml_root.find("FileName").text,
+                dMaxCpes=int(xml_root.find("dMaxCpes").text),
+                bpiEnable=int(xml_root.find("bpiEnable").text),
+            )
+            for elmt_service_flow in xml_root.iter("serviceflow"):
+                service_flow = ServiceFlow(
+                    id=int(elmt_service_flow.find("Sfid").text),
+                    pMaxTrafficRate=int(elmt_service_flow.find("pMaxTrafficRate").text),
+                    pMaxTrafficBurst=int(
+                        elmt_service_flow.find("pMaxTrafficBurst").text
+                    ),
+                    pMinReservedRate=int(
+                        elmt_service_flow.find("pMinReservedRate").text
+                    ),
+                    pMaxConcatBurst=int(elmt_service_flow.find("pMaxConcatBurst").text),
+                    pSchedulingType=int(elmt_service_flow.find("pSchedulingType").text),
+                )
+                direction = int(elmt_service_flow.find("direction").text)
+                if direction == 1:
+                    self.downstream_service_flows.append(service_flow)
+                elif direction == 2:
+                    self.upstream_service_flows.append(service_flow)
+                else:
+                    raise element_tree.ParseError(
+                        "Unknown service flow direction '{}'".format(direction)
+                    )
+        except (element_tree.ParseError, TypeError):
+            _LOGGER.warning("Can't read cmstatus from %s", self.host)
+            self.token = None
+            raise exceptions.ConnectBoxNoDataAvailable() from None
+
+    async def async_get_temperature(self):
+        """Get temperature information (in degrees Celsius)."""
+        if self.token is None:
+            await self.async_initialize_token()
+
+        self.temperature = None
+        raw = await self._async_ws_function(CMD_TEMPERATURE)
+
+        f_to_c = lambda f: (5.0 / 9) * (f - 32)
+        try:
+            xml_root = element_tree.fromstring(raw)
+            self.temperature = Temperature(
+                tunerTemperature=f_to_c(int(xml_root.find("TunnerTemperature").text)),
+                temperature=f_to_c(int(xml_root.find("Temperature").text)),
+            )
+        except (element_tree.ParseError, TypeError):
+            _LOGGER.warning("Can't read temperature from %s", self.host)
+            self.token = None
+            raise exceptions.ConnectBoxNoDataAvailable() from None
+
     async def async_close_session(self) -> None:
         """Logout and close session."""
         if not self.token:

connect_box/data.py

@@ -46,3 +46,42 @@ class UpstreamChannel:
     t4Timeouts: int = attr.ib()
     channelType: str = attr.ib()
     messageType: int = attr.ib()
+
+
+@attr.s
+class CmStatus:
+    provisioningStatus: str = attr.ib()
+    cmComment: str = attr.ib()
+    cmDocsisMode: str = attr.ib()
+    cmNetworkAccess: str = attr.ib()
+    firmwareFilename: str = attr.ib()
+
+    # number of IP addresses to assign via DHCP
+    numberOfCpes: int = attr.ib()
+
+    # ???
+    dMaxCpes: int = attr.ib()
+    bpiEnable: int = attr.ib()
+
+
+@attr.s
+class ServiceFlow:
+    id: int = attr.ib()
+    pMaxTrafficRate: int = attr.ib()
+    pMaxTrafficBurst: int = attr.ib()
+    pMinReservedRate: int = attr.ib()
+    pMaxConcatBurst: int = attr.ib()
+
+    # 2 seems to be Best Effort
+    pSchedulingType: int = attr.ib()
+
+
+@attr.s
+class Temperature:
+    # temperatures in degrees Celsius
+    tunerTemperature: float = attr.ib()
+    temperature: float = attr.ib()
+
+    # several other stats remain untapped here:
+    # wan_ipv4_addr
+    # wan_ipv6_addr, wan_ipv6_addr_entry

example.py

@@ -25,6 +25,16 @@ async def main():
         await client.async_get_devices()
         pprint(client.devices)
 
+        # Print details on general device status
+        await client.async_get_cmstatus_and_service_flows()
+        pprint(client.cmstatus)
+        pprint(client.downstream_service_flows)
+        pprint(client.upstream_service_flows)
+
+        # Print temperature status
+        await client.async_get_temperature()
+        pprint(client.temperature)
+
         await client.async_close_session()