Connect Box event log support (#26)

* Add support for fetching and parsing Connect Box event logs

My UPC/Magenta Austria Connect Box (Rev 5.01, Firmware release
"CH7465LG-NCIP-6.12.18.26-3p7-1-NOSH") operates in "modem" aka bridge
mode, and exposes an event log in its web interface, available under
'Advanced settings' > 'Tools' > 'Network status'. It contains events
such as login( attempt)s to the web interface, as well as the modem
having trouble getting its DOCSIS connection established.

This patch makes this data available as a timestamp-sorted list.

* Display Connect Box event log data

Author: jtru

connect_box/__init__.py

@@ -22,6 +22,7 @@
     FilterState, 
     FilterStatesList, 
     FiltersTimeMode,
+    LogEvent,
 )
 
 from . import exceptions
@@ -40,6 +41,7 @@
 CMD_SET_IPV6_FILTER_RULE = 112
 CMD_TEMPERATURE = 136
 CMD_CMSTATUS = 144
+CMD_EVENTLOG = 13
 
 
 class ConnectBox:
@@ -360,6 +362,30 @@ async def async_get_temperature(self):
             self.token = None
             raise exceptions.ConnectBoxNoDataAvailable() from None
 
+    async def async_get_eventlog(self):
+        """Get network-related eventlog data."""
+        if self.token is None:
+            await self.async_initialize_token()
+
+        self.eventlog = []
+        raw = await self._async_ws_get_function(CMD_EVENTLOG)
+
+        try:
+            xml_root = element_tree.fromstring(raw)
+            for elmt_log_event in xml_root.iter("eventlog"):
+                log_event = LogEvent(
+                elmt_log_event.find("prior").text,
+                elmt_log_event.find("text").text,
+                elmt_log_event.find("time").text,
+                int(elmt_log_event.find("t").text),
+                )
+                self.eventlog.append(log_event)
+        except (element_tree.ParseError, TypeError):
+            _LOGGER.warning("Can't read eventlog from %s", self.host)
+            self.token = None
+            raise exceptions.ConnectBoxNoDataAvailable() from None
+        self.eventlog.sort(key=(lambda e: e.evEpoch))
+
     async def async_close_session(self) -> None:
         """Logout and close session."""
         if not self.token:

connect_box/data.py

@@ -130,3 +130,12 @@ class Temperature:
     # several other stats remain untapped here:
     # wan_ipv4_addr
     # wan_ipv6_addr, wan_ipv6_addr_entry
+
+
+@attr.s
+class LogEvent:
+    """An entry in the eventlog_table"""
+    evPrio: str = attr.ib()
+    evMsg: str = attr.ib()
+    evTime: str = attr.ib()
+    evEpoch: int = attr.ib()

example.py

@@ -46,6 +46,10 @@ async def main():
         await client.async_get_temperature()
         pprint(client.temperature)
 
+        # Print event log entries
+        await client.async_get_eventlog()
+        pprint(client.eventlog)
+
         await client.async_close_session()