add transistors

Author: dragoncoder047

.vscode/settings.json

@@ -1,6 +1,9 @@
 {
     "cSpell.words": [
         "Cbox",
+        "MOSFET",
+        "NFET",
+        "PFET",
         "polylinegon",
         "rendec",
         "schemascii",

format.md

@@ -51,12 +51,12 @@ Components are able to accept "flags", which are other punctuation characters an
 
 To include component values, pin numbers, etc, somewhere in the drawing but not touching any wires or other components, you can write component values - these are formatted as the reference designator (same as in circuit) followed by a `:` and the value parameter (which stops at the first whitespace). *I usually put these in a "BOM section" below the circuit itself but you could also put them right next to the component.*
 
-For simple components, this is usually just a value rating, but *without* the units (only the Metric prefix). For more specific components (mostly semiconductor devices) this is usually the part number.
+For simple components, this is usually just a value rating, but *without* the units (only the Metric prefix). For more specific components (mostly semiconductor devices) this is usually the part number and/or some string to determine how to draw the component.
 
 Examples:
 
 * `C33:2.2u` -- "2.2 µF"
-* `Q1001:TIP102` -- just the part number; printed verbatim
+* `Q1001:pnp:TIP102` -- "pnp" or "npn" to determine what kind of transistor, just the part number; printed verbatim
 * `L51:0.33` -- this is rewritten to "330 mH" so that it has no decimal point.
 * `F3:1500m` -- rewritten: "1.5 A"
 * `D7:1N4001` -- again, part number

schemascii/components_render.py

@@ -2,10 +2,10 @@
 from cmath import phase, rect
 from math import pi
 from warnings import warn
-from .utils import (Cbox, Terminal, BOMData, XML, Side,
+from .utils import (Cbox, Terminal, BOMData, XML, Side, arrow_points,
                     polylinegon, id_text, make_text_point,
                     bunch_o_lines, deep_transform, make_plus, make_variable,
-                    sort_counterclockwise, light_arrows)
+                    sort_counterclockwise, light_arrows, sort_for_flags, is_clockwise)
 from .errors import TerminalsError, BOMError, UnsupportedComponentError
 
 RENDERERS = {}
@@ -291,6 +291,60 @@ def jack(
         + id_text(box, bom_data, terminals, None, sc_text_pt, **options))
 
 
+@component("Q", "MOSFET", "MOS", "FET")
+@n_terminal(3)
+@no_ambiguous
+def transistor(
+        box: Cbox,
+        terminals: list[Terminal],
+        bom_data: BOMData,
+        **options):
+    "Draw a bipolar transistor (PNP/NPN) or FET (NFET/PFET)"
+    if all(x not in bom_data.data.lower() for x in ("pnp:", "npn:", "nfet:", "pfet:")):
+        raise BOMError(
+            f"Need type of transistor for {box.type}{box.id}")
+    silicon_type, part_num = bom_data.data.split(":")
+    silicon_type = silicon_type.lower()
+    bom_data = BOMData(bom_data.type, bom_data.id, part_num)
+    if 'fet' in silicon_type:
+        ae, se, ctl = sort_for_flags(terminals, box, "s", "d", "g")
+    else:
+        ae, se, ctl = sort_for_flags(terminals, box, "e", "c", "b")
+    ap, sp = ae.pt, se.pt
+    mid = (ap + sp) / 2 # TODO: slide this to line up with middle
+    theta = phase(ap - sp)
+    backwards = 1 if is_clockwise([ae, se, ctl]) else -1
+    thetaquarter = theta + (backwards * pi / 2)
+    out_lines = [
+        (ap, mid + rect(.8, theta)),  # Lead in
+        (sp, mid - rect(.8, theta)),  # Lead out
+    ]
+    if 'fet' in silicon_type:
+        arr = mid + rect(.8, theta), mid + rect(.8, theta) + rect(.7, thetaquarter)
+        if 'nfet' == silicon_type:
+            arr = arr[1], arr[0]
+        out_lines.extend([
+            *arrow_points(*arr),
+            (mid - rect(.8, theta), mid - rect(.8, theta) + rect(.7, thetaquarter)),
+            (mid + rect(1, theta) + rect(.7, thetaquarter),
+             mid - rect(1, theta) + rect(.7, thetaquarter)),
+            (mid + rect(.5, theta) + rect(1, thetaquarter),
+             mid - rect(.5, theta) + rect(1, thetaquarter)),
+        ])
+    else:
+        arr = mid + rect(.8, theta), mid + rect(.4, theta) + rect(1, thetaquarter)
+        if 'npn' == silicon_type:
+            arr = arr[1], arr[0]
+        out_lines.extend([
+            *arrow_points(*arr),
+            (mid - rect(.8, theta), mid - rect(.4, theta) + rect(1, thetaquarter)),
+            (mid + rect(1, theta) + rect(1, thetaquarter),
+             mid - rect(1, theta) + rect(1, thetaquarter)),
+        ])
+    text_pt = make_text_point(ap, sp, **options)
+    return (id_text(box, bom_data, [ae, se], None, text_pt, **options)
+            + bunch_o_lines(out_lines, **options))
+
 # code for drawing stuff
 # https://github.com/pfalstad/circuitjs1/tree/master/src/com/lushprojects/circuitjs1/client
 # https://github.com/KenKundert/svg_schematic/blob/0abb5dc/svg_schematic.py

schemascii/utils.py

@@ -4,8 +4,9 @@
 from math import pi
 from cmath import phase, rect
 from typing import Callable
-from .metric import format_metric_unit
 import re
+from .metric import format_metric_unit
+from .errors import TerminalsError
 
 Cbox = namedtuple('Cbox', 'p1 p2 type id')
 BOMData = namedtuple('BOMData', 'type id data')
@@ -114,7 +115,8 @@ def mk_tag(*contents, **attrs) -> str:
                 if isinstance(v, float):
                     v = fix_number(v)
                 elif isinstance(v, str):
-                    v = re.sub(r"\d+(\.\d+)", lambda m: fix_number(float(m.group())), v)
+                    v = re.sub(r"\d+(\.\d+)",
+                               lambda m: fix_number(float(m.group())), v)
                 out += f'{k.removesuffix("_").replace("__", "-")}="{v}" '
             out = out.rstrip() + '>' + ''.join(contents)
             return out + f'</{tag}>'
@@ -293,7 +295,37 @@ def sort_counterclockwise(terminals: list[Terminal]) -> list[Terminal]:
             terminals,
             lambda t: t.side)}
     return list(chain(
-        sorted(partitioned[Side.LEFT],   key=lambda t:  t.pt.imag),
-        sorted(partitioned[Side.BOTTOM], key=lambda t:  t.pt.real),
-        sorted(partitioned[Side.RIGHT],  key=lambda t: -t.pt.imag),
-        sorted(partitioned[Side.TOP],    key=lambda t: -t.pt.real)))
+        sorted(partitioned.get(Side.LEFT, []),   key=lambda t:  t.pt.imag),
+        sorted(partitioned.get(Side.BOTTOM, []), key=lambda t:  t.pt.real),
+        sorted(partitioned.get(Side.RIGHT, []),  key=lambda t: -t.pt.imag),
+        sorted(partitioned.get(Side.TOP, []),    key=lambda t: -t.pt.real)))
+
+
+def is_clockwise(terminals: list[Terminal]) -> bool:
+    "Return true if the terminals are clockwise order."
+    sort = sort_counterclockwise(terminals)
+    for _ in range(len(sort)):
+        if sort == terminals:
+            return True
+        sort = sort[1:] + [sort[0]]
+    return False
+
+
+def sort_for_flags(terminals: list[Terminal], box: Cbox, *flags: list[str]) -> list[Terminal]:
+    """Sorts out the terminals in the specified order using the flags.
+    Raises and error if the flags are absent."""
+    out = ()
+    for flag in flags:
+        matching_terminals = list(filter(lambda t: t.flag == flag, terminals))
+        if len(matching_terminals) > 1:
+            raise TerminalsError(
+                f"Multiple terminals with the same flag {flag} "
+                f"on component {box.type}{box.id}")
+        if len(matching_terminals) == 0:
+            raise TerminalsError(
+                f"Need a terminal with the flag {flag} "
+                f"on component {box.type}{box.id}")
+        terminal, = matching_terminals
+        out = *out, terminal
+        terminals.remove(terminal)
+    return out

test_data/test1.txt

@@ -1,4 +1,32 @@
------LED1+-----
-LED1:red
------VR1###------
-VR1:10k
+-------sMOSFET1d-----
+          g  MOSFET1:nfet:2N7000
+          *--------
+
+-------eQ1c-----
+         b   Q1:pnp:TIP102
+         *------
+
+-------dMOSFET2s-----
+          g  MOSFET2:pfet:2N7001
+          *--------
+
+-------cQ2e-----
+         b   Q2:npn:TIP103
+         *------
+
+-------dMOSFET3s-----
+          g  MOSFET3:nfet:2N7000
+          *--------
+
+-------cQ3e-----
+         b   Q3:pnp:TIP102
+         *------
+
+-------sMOSFET4d-----
+          g  MOSFET4:pfet:2N7001
+          *--------
+
+-------eQ4c-----
+         b   Q4:npn:TIP103
+         *------
+!padding=30!