fix(loop): support color and proper pin when un-ordered

Author: laurierloi

examples/ex11.yml

@@ -8,21 +8,25 @@ connectors:
       - first: 1
         second: 2
         side: LEFT
+        color: PK
       - first: LB3
         second: LB4
         side: LEFT
   X2:
     type: Stewart Connector SS-37000-002
     subtype: male
-    pinlabels: [LB5,LB6,DA+,DD+,DD-,DA-,LB7,LB8]
+    pins: [3, 4, 5, 6, 1, 2, 7, 8]
+    pinlabels: [DA+, D+, D-, A-, LB5, LB6, LB7, LB8]
     loops:
       - first: 1
         second: 2
         side: RIGHT
         show_label: false
+        color: RD
       - first: LB7
         second: LB8
         side: LEFT
+        color: GN
 
 cables:
   W1:

src/wireviz/wv_dataclasses.py

@@ -79,6 +79,10 @@ def __str__(self):
         ]
         return ":".join([snip for snip in snippets if snip != ""])
 
+    @property
+    def pin(self):
+        return self.index+1
+
     @property
     def category(self):
         return BomCategory.PIN
@@ -216,20 +220,26 @@ class Loop():
     second: PinClass = None
     side: Side = None
     show_label: bool = True
+    color: Optional[MultiColor] = None
 
     def __post_init__(self):
         if self.side.upper() == 'LEFT':
             self.side = Side.LEFT
         elif self.side.upper() == 'RIGHT':
             self.side = Side.RIGHT
 
+        self.color = MultiColor(self.color)
+
     @property
     def label(self):
         if self.show_label:
-            return f'{self.first}<->{self.second}'
+            return f'{self.first}⇿{self.second}'
         else:
             return ''
 
+    def html_color(self):
+        return self.color[0].html
+
 
 @dataclass
 class Connector(GraphicalComponent):
@@ -354,38 +364,32 @@ def to_int_pin(pin):
             self.show_pincount = self.style != "simple"
 
         def get_pin_object(value):
-            pin_id = None
-            if value in self.pinlabels:
-                pin_id = self.pins[self.pinlabels.index(value)]
-            else:
-                err = f'{value} not found in {self.pinlabels}'
-                try:
-                    value = int(value)
-                except ValueError as exc:
-                    raise ValueError(f'{err} and is not an int')
+            # is label?
+            pin_match_label = [p for p in self.pin_objects.values() if p.label == value]
+            if pin_match_label:
+                return pin_match_label[0]
+            err = f'{value} not found in {self.pinlabels}'
 
-                if value in self.pins:
-                    pin_id = value
-
-            if pin_id is not None:
-                return self.pin_objects[pin_id]
+            try:
+                value = int(value)
+            except ValueError as exc:
+                raise ValueError(f'{err} and is not an int')
 
-            raise ValueError(f'{err} and is not one of the pins {self.pins}')
+            pin_match_id = [p for p in self.pin_objects.values() if p.id == value]
+            if not pin_match_id:
+                raise ValueError(f'{err} and is not one of the pins {self.pins}')
+            return pin_match_id[0]
 
         self.loops = [Loop(
             first=get_pin_object(loop['first']),
             second=get_pin_object(loop['second']),
             side=loop.get('side'),
             show_label=loop.get('show_label', True),
+            color=loop.get('color'),
         ) for loop in self.loops]
 
 
-        #self.loops = [[to_int_pin(p) for p in loop] for loop in self.loops]
         for loop in self.loops:
-            # TODO: check that pins to connect actually exist
-            # TODO: allow using pin labels in addition to pin numbers,
-            #       just like when defining regular connections
-            # TODO: include properties of wire used to create the loop
             self.activate_pin(loop.first.id, side=loop.side, is_connection=True)
             self.activate_pin(loop.second.id, side=loop.side, is_connection=True)
 

src/wireviz/wv_graphviz.py

@@ -54,8 +54,8 @@ def gv_connector_loops(connector: Connector) -> List:
             this_loop_side = 'l'
             this_loop_dir = 'w'
 
-        head = f"{connector.designator}:p{loop.first.id}{this_loop_side}:{this_loop_dir}"
-        tail = f"{connector.designator}:p{loop.second.id}{this_loop_side}:{this_loop_dir}"
+        head = f"{connector.designator}:p{loop.first.pin}{this_loop_side}:{this_loop_dir}"
+        tail = f"{connector.designator}:p{loop.second.pin}{this_loop_side}:{this_loop_dir}"
         loop_edges.append((loop, head, tail))
     return loop_edges
 

src/wireviz/wv_harness.py

@@ -315,10 +315,9 @@ def create_graph(self) -> Graph:
             )
             # generate edges for connector loops
             if len(connector.loops) > 0:
-                dot.attr("edge", color="#000000")
                 loops = gv_connector_loops(connector)
                 for loop, head, tail in loops:
-                    dot.edge(head, tail, xlabel=loop.label)
+                    dot.edge(head, tail, xlabel=loop.label, color=loop.html_color())
 
         # determine if there are double- or triple-colored wires in the harness;
         # if so, pad single-color wires to make all wires of equal thickness