feat: expose device_type on PyViCareDeviceConfig (#698)

Author: lackas

PyViCare/PyViCare.py

@@ -61,7 +61,7 @@ def __extract_devices(self):
 
                     logger.info("Device found: %s", device.modelId)
 
-                    yield PyViCareDeviceConfig(service, device.id, device.modelId, device.status)
+                    yield PyViCareDeviceConfig(service, device.id, device.modelId, device.status, device.deviceType)
 
 
 class DictWrap(object):

PyViCare/PyViCareDeviceConfig.py

@@ -22,11 +22,13 @@
 
 
 class PyViCareDeviceConfig:
-    def __init__(self, service, device_id, device_model, status):
+    # pylint: disable=too-many-arguments,too-many-positional-arguments
+    def __init__(self, service, device_id, device_model, status, device_type=None):
         self.service = service
         self.device_id = device_id
         self.device_model = device_model
         self.status = status
+        self.device_type = device_type
 
     def asGeneric(self):
         return HeatingDevice(self.service)
@@ -85,6 +87,12 @@ def getModel(self):
     def isOnline(self):
         return self.status == "Online"
 
+    def getDeviceType(self):
+        return self.device_type
+
+    def isGateway(self):
+        return self.service._isGateway()  # pylint: disable=protected-access
+
     # see: https://vitodata300.viessmann.com/vd300/ApplicationHelp/VD300/1031_de_DE/Ger%C3%A4teliste.html
     def asAutoDetectDevice(self):
         device_types = [

tests/test_PyViCareDeviceConfig.py

@@ -174,3 +174,25 @@ def test_e3_device(self):
         device = c.asAutoDetectDevice()
         self.assertEqual(device.isLegacyDevice(), False)
         self.assertEqual(device.isE3Device(), True)
+
+    def test_getDeviceType_heating(self):
+        c = PyViCareDeviceConfig(self.service, "0", "Vitocal", "Online", "heating")
+        self.assertEqual(c.getDeviceType(), "heating")
+
+    def test_getDeviceType_vitoconnect(self):
+        c = PyViCareDeviceConfig(self.service, "0", "Heatbox1", "Online", "vitoconnect")
+        self.assertEqual(c.getDeviceType(), "vitoconnect")
+
+    def test_getDeviceType_none_when_not_provided(self):
+        c = PyViCareDeviceConfig(self.service, "0", "Vitocal", "Online")
+        self.assertIsNone(c.getDeviceType())
+
+    def test_isGateway_true_for_gateway_role(self):
+        self.service._isGateway = Mock(return_value=True)  # pylint: disable=protected-access
+        c = PyViCareDeviceConfig(self.service, "0", "Heatbox1", "Online", "vitoconnect")
+        self.assertTrue(c.isGateway())
+
+    def test_isGateway_false_for_non_gateway_role(self):
+        self.service._isGateway = Mock(return_value=False)  # pylint: disable=protected-access
+        c = PyViCareDeviceConfig(self.service, "0", "Vitocal", "Online", "heating")
+        self.assertFalse(c.isGateway())