Allow using either serial or qtserial when device manifest mentions serial transport. (#52)

* fix available transport list changing after cutter has been restarted compared to available list right after device is created

Author: karliss

inkcut/device/dialogs.enaml

@@ -36,6 +36,8 @@ enamldef ConfigEditView(Include):
     attr configurable: Model # Pair of config model and config declaration
     attr plugin
     func load_config_view(config, declaration):
+        if not declaration:
+            return []
         View = declaration.config_view()
         kwargs = {
             'model': config
@@ -118,13 +120,13 @@ enamldef DeviceEditView(Notebook): notebook:
                 Label:
                     text = QApplication.translate("device", "Type")
                 ObjectCombo:
-                    attr supported_transports << device.transports \
-                        if device and device.transports else plugin.transports
+                    attr supported_transports << [transport for transport in plugin.transports\
+                        if device.supports_transport(transport)]
                     items << sorted(supported_transports, key=lambda t: t.name)
                     to_string = lambda t: QApplication.translate("device", t.name)
 
                     func get_selected(device):
-                        if not device or not device.connection:
+                        if not device or not device.connection or not device.connection.declaration:
                             return
                         tid = device.connection.declaration.id
                         for t in plugin.transports:
@@ -135,7 +137,8 @@ enamldef DeviceEditView(Notebook): notebook:
                     selected ::
                         # Since this will trigger when the device changes, only actually update
                         # if the connection changes
-                        if selected and selected.id != device.connection.declaration.id:
+                        if selected and device.connection and device.connection.declaration and\
+                            selected.id != device.connection.declaration.id:
                             declaration = selected
                             protocol = None
                             if device.connection and device.connection.protocol:

inkcut/device/extensions.py

@@ -27,7 +27,7 @@ def default_device_factory(driver, transports, protocols, config=None):
     driver: DeviceDriver
         The declaration of the device driver that was selected by the user
     transports: List[DeviceTransport]
-        A list of DeviceTransport declarations that this device driver supports 
+        A list of all available DeviceTransport declarations
     protocols: List[DeviceProtocol]
         A list of DeviceProtocol declarations that this device driver supports 
 
@@ -148,6 +148,9 @@ class DeviceTransport(Declarative):
     #: Id of the transport
     id = d_(Str())
 
+    #: transport category in case there are multiple backends supporting same type of transport
+    category = d_(Str())
+
     #: Name of the transport (optional)
     name = d_(Str())
 

inkcut/device/plugin.py

@@ -533,9 +533,6 @@ class Device(Model):
     #: Protocols supported by this device (ex the HPGLProtocol)
     protocols = List(extensions.DeviceProtocol)
 
-    #: Transports supported by this device (ex the SerialPort
-    transports = List(extensions.DeviceTransport)
-
     #: Filters that this device applies to the output
     filters = List(DeviceFilter).tag(config=True)
 
@@ -571,6 +568,9 @@ class Device(Model):
     status = Str()
 
     def __init__(self, *args, **kwargs):
+        transports = None
+        if 'transports' in kwargs:
+            transports = kwargs.pop('transports')
         super(Model, self).__init__(*args, **kwargs)
         (w, h) = kwargs.get('width'), kwargs.get('height')
         if w:
@@ -580,17 +580,46 @@ def __init__(self, *args, **kwargs):
         if not h:
             h = 900000
         self.config.area.size[1] = h
+        if not kwargs.get('connection'):
+            self.connection = self._make_default_connection(transports)
 
-    def _default_connection(self):
+    def _make_default_connection(self, transports):
         """ If no connection is set when the device is created,
         create one using the first "connection" type the driver supports.
         """
-        if not self.transports:
+
+        if not transports or not self.declaration:
+            return TestTransport(declaration=extensions.DeviceTransport())
+        preferred_decl = None
+        # prioritize available connections based on the order in device manifest
+        for supported_transform in self.declaration.connections:
+            if preferred_decl:
+                break
+            for transport in transports:
+                if transport.id == supported_transform or transport.category == supported_transform:
+                    preferred_decl = transport
+                    break
+        if not preferred_decl:
+            for transport in transports:
+                if self.supports_transport(transport):
+                    preferred_decl = transport
+                    break
+        if not preferred_decl:
             return TestTransport()
-        declaration = self.transports[0]
+
         driver = self.declaration
         protocol = self._default_protocol()
-        return declaration.factory(driver, declaration, protocol)
+        return preferred_decl.factory(driver, preferred_decl, protocol)
+
+    def supports_transport(self, transport_manifest):
+        if not self.declaration or not self.declaration.connections:
+            return True
+        conections = self.declaration.connections
+        if transport_manifest.id in conections or \
+                transport_manifest.id == "disk" or \
+                (transport_manifest.category and transport_manifest.category in conections):
+            return True
+        return False
 
     def _default_protocol(self):
         """ Create the protocol for this device. """
@@ -1273,17 +1302,13 @@ def get_device_from_driver(self, driver, config=None):
                 and processing the jobs.
 
         """
-        # Set the protocols based on the declaration
-        transports = [t for t in self.transports
-                      if not driver.connections or t.id == 'disk' or
-                      t.id in driver.connections]
 
         # Set the protocols based on the declaration
         protocols = [p for p in self.protocols
                      if not driver.protocols or p.id in driver.protocols]
 
         # Generate the device
-        return driver.factory(driver, transports, protocols, config)
+        return driver.factory(driver, self.transports, protocols, config)
 
     # -------------------------------------------------------------------------
     # Device Extensions API

inkcut/device/transports/qtserialport/manifest.enaml

@@ -41,6 +41,7 @@ enamldef QtSerialManifest(PluginManifest):
 
         DeviceTransport:
             id = 'qtserial'
+            category = 'serial'
             name = 'Qt SerialPort'
             factory = transport_factory
             config_view = config_view_factory