Categorization / general cleanup (#344)

Mostly cleanup of the categorization superclasses.

Also other minor cleanup:
- Remove nonfunctional mounting holes and labels, these should be added
to the layout as non-schematic footprints
  - Categorized into a new DeprecatedBlock
- Remove type from component names for IMU and magnetometer
  - Add deprecation aliases
- Add MultipackOpamp abstract block and MultipackOpampGenerator skeleton
base block
- Remove switch controller and fox project test cases, those probably
aren't contributing to coverage but still taking time

Author: ducky64

edg/BoardTop.py

@@ -51,7 +51,17 @@ class BoardTop(BaseBoardTop):
   pass
 
 
-class JlcToolingHoles(Mechanical, Block):
+class JlcToolingHole(InternalSubcircuit, FootprintBlock):
+  def contents(self):
+    super().contents()
+    self.footprint(
+      'H', 'edg:JlcToolingHole_1.152mm',
+      {},
+      datasheet='https://support.jlcpcb.com/article/92-how-to-add-tooling-holes-for-smt-assembly-order'
+    )
+
+
+class JlcToolingHoles(InternalSubcircuit, Block):
   def contents(self):
     super().contents()
     self.th1 = self.Block(JlcToolingHole())

electronics_abstract_parts/AbstractAntenna.py

@@ -5,7 +5,7 @@
 
 
 @abstract_block
-class Antenna(Block):
+class Antenna(Interface, Block):
   @init_in_parent
   def __init__(self, frequency: RangeLike, impedance: RangeLike = Range.all(), power: RangeLike = (0, 0*Watt)):
     super().__init__()

electronics_abstract_parts/AbstractOpamp.py

@@ -1,4 +1,4 @@
-from typing import Mapping
+from typing import Mapping, Tuple, List, NamedTuple
 
 from electronics_model import *
 from .Categories import Analog
@@ -29,3 +29,56 @@ def __init__(self) -> None:
 
 class OpampElement(Opamp):
   """Packed opamp element"""
+
+
+@abstract_block
+class MultipackOpamp(Analog, MultipackBlock):
+  """Base class for packed opamps - devices that have multiple opamps in a single package,
+  with shared power and ground connections. Typically used with the multipack feature to
+  fit individual opamps across the design hierarchy into one of these."""
+  def __init__(self):
+    super().__init__()
+    self.elements = self.PackedPart(PackedBlockArray(OpampElement()))
+    self.pwr = self.PackedExport(self.elements.ports_array(lambda x: x.pwr))
+    self.gnd = self.PackedExport(self.elements.ports_array(lambda x: x.gnd))
+    self.inp = self.PackedExport(self.elements.ports_array(lambda x: x.inp))
+    self.inn = self.PackedExport(self.elements.ports_array(lambda x: x.inn))
+    self.out = self.PackedExport(self.elements.ports_array(lambda x: x.out))
+
+
+@non_library
+class MultipackOpampGenerator(MultipackOpamp, GeneratorBlock):
+  """Skeleton base class that provides scaffolding for common packed opamp definitions"""
+  class OpampPorts(NamedTuple):
+    gnd: VoltageSink
+    pwr: VoltageSink
+    amps: List[Tuple[AnalogSink, AnalogSink, AnalogSource]]  # amp-, amp+, out
+
+  def __init__(self):
+    super().__init__()
+    self.generator_param(self.pwr.requested(), self.gnd.requested(),
+                         self.inn.requested(), self.inp.requested(), self.out.requested())
+
+  def _make_multipack_opamp(self) -> OpampPorts:
+    """Generates the opamp as a block in self, including any application circuit components like decoupling capacitors.
+    Returns (gnd, pwr, [(in-, in+, out)])."""
+    raise NotImplementedError  # implement me
+
+  def generate(self):
+    super().generate()
+    amp_ports = self._make_multipack_opamp()
+
+    self.gnd_merge = self.Block(PackedVoltageSource())
+    self.pwr_merge = self.Block(PackedVoltageSource())
+    self.connect(self.gnd_merge.pwr_out, amp_ports.gnd)
+    self.connect(self.pwr_merge.pwr_out, amp_ports.pwr)
+
+    requested = self.get(self.pwr.requested())
+    assert self.get(self.gnd.requested()) == self.get(self.inp.requested()) == \
+           self.get(self.inn.requested()) == self.get(self.out.requested()) == requested
+    for i, (amp_neg, amp_pos, amp_out) in zip(requested, amp_ports.amps):
+      self.connect(self.pwr.append_elt(VoltageSink.empty(), i), self.pwr_merge.pwr_ins.request(i))
+      self.connect(self.gnd.append_elt(VoltageSink.empty(), i), self.gnd_merge.pwr_ins.request(i))
+      self.connect(self.inn.append_elt(AnalogSink.empty(), i), amp_neg)
+      self.connect(self.inp.append_elt(AnalogSink.empty(), i), amp_pos)
+      self.connect(self.out.append_elt(AnalogSource.empty(), i), amp_out)

electronics_abstract_parts/Categories.py

@@ -174,6 +174,11 @@ class Sensor(Block):
   pass
 
 
+@abstract_block
+class CurrentSensor(Sensor):
+  pass
+
+
 @abstract_block
 class Accelerometer(Sensor):
   pass
@@ -200,13 +205,13 @@ class Magnetometer(Sensor):
 
 
 @abstract_block
-class DistanceSensor(Sensor):
+class Camera(Sensor):
+  """Imaging sensors, including visible / RGB, IR, and thermal."""
   pass
 
 
 @abstract_block
-class Mechanical(Block):
-  """Nonelectrical footprint, including plated and NPTH mounting holes."""
+class DistanceSensor(Sensor):
   pass
 
 
@@ -285,6 +290,20 @@ def contents(self):
 
 
 @abstract_block
-class Label(Block):
-  """Nonfunctional footprint, including copper and silkscreen labels."""
+class DeprecatedBlock(InternalBlock):
+  """Base class for blocks that are deprecated and planned to be removed"""
+  pass
+
+
+@abstract_block
+class Label(DeprecatedBlock):
+  """DEPRECATED: non-circuit footprints should be added in layout as non-schematic items.
+  Nonfunctional footprint, including copper and silkscreen labels."""
+  pass
+
+
+@abstract_block
+class Mechanical(DeprecatedBlock):
+  """DEPRECATED: non-circuit footprints should be added in layout as non-schematic items.
+  Nonelectrical footprint, including plated and NPTH mounting holes."""
   pass

electronics_abstract_parts/OpampCurrentSensor.py

@@ -1,15 +1,18 @@
 from typing import Dict
 
 from electronics_abstract_parts import CurrentSenseResistor, DifferentialAmplifier
-from .Categories import Sensor
+from .Categories import CurrentSensor
 from .DummyDevices import ForcedAnalogSignal
 from electronics_model import *
 
 
-class OpampCurrentSensor(Sensor, KiCadImportableBlock, Block):
+class OpampCurrentSensor(CurrentSensor, KiCadImportableBlock, Block):
   """Current sensor block using a resistive sense element and an opamp-based differential amplifier.
   For a positive current (flowing from pwr_in -> pwr_out), this generates a positive voltage on the output.
   Output reference can be floating (eg, at Vdd/2) to allow bidirectional current sensing.
+
+  Discrete diffamp circuits generally have poor accuracy as a result of resistor tolerances, including
+  very poor common-mode rejection.
   """
   @init_in_parent
   def __init__(self, resistance: RangeLike, ratio: RangeLike, input_impedance: RangeLike):

electronics_abstract_parts/PowerCircuits.py

@@ -3,10 +3,11 @@
 from .AbstractResistor import Resistor
 from .AbstractFets import SwitchFet
 from .GateDrivers import HalfBridgeDriver, HalfBridgeDriverIndependent, HalfBridgeDriverPwm
+from .Categories import PowerConditioner
 
 
 @abstract_block_default(lambda: FetHalfBridgeIndependent)
-class HalfBridge(Block):
+class HalfBridge(PowerConditioner, Block):
     """Half bridge circuit with logic-level inputs and current draw calculated from the output node.
     Two power rails: logic power (which can be used to power gate drivers), and the power rail."""
     def __init__(self):

electronics_abstract_parts/TouchPad.py

@@ -0,0 +1,14 @@
+from electronics_model import *
+from .Categories import HumanInterface
+
+
+class FootprintToucbPad(FootprintBlock, HumanInterface):
+    @init_in_parent
+    def __init__(self, touch_footprint: StringLike):
+        super().__init__()
+        self.pad = self.Port(TouchPadPort(), [Input])
+        self.touch_footprint = self.ArgParameter(touch_footprint)
+
+    def contents(self):
+        super().contents()
+        self.footprint('U', self.touch_footprint, {'1': self.pad})

electronics_abstract_parts/__init__.py

@@ -14,8 +14,9 @@
 from .Categories import PowerConditioner, PowerSwitch, MotorDriver, BrushedMotorDriver, BldcDriver
 from .Categories import PowerSource, Connector, ProgrammingConnector
 from .Categories import HumanInterface, Display, Lcd, Oled, EInk, Light
-from .Categories import Sensor, Accelerometer, Gyroscope, Magnetometer, DistanceSensor, EnvironmentalSensor, LightSensor
-from .Categories import Label, Testing, TypedJumper, TypedTestPoint, InternalSubcircuit, Mechanical
+from .Categories import Sensor, CurrentSensor, Accelerometer, Gyroscope, Magnetometer, DistanceSensor, Camera, \
+    EnvironmentalSensor, LightSensor
+from .Categories import Label, Testing, TypedJumper, TypedTestPoint, InternalSubcircuit, DeprecatedBlock, Mechanical
 
 from .ESeriesUtil import ESeriesUtil
 from .SmdStandardPackage import SmdStandardPackage, SmdStandardPackageSelector
@@ -55,7 +56,7 @@
 from .AbstractSwitch import Switch, TactileSwitch, MechanicalKeyswitch, DigitalSwitch
 from .AbstractSwitch import RotaryEncoder, RotaryEncoderSwitch, DigitalRotaryEncoder, DigitalRotaryEncoderSwitch
 from .AbstractSwitch import DirectionSwitch, DirectionSwitchCenter, DigitalDirectionSwitch, DigitalDirectionSwitchCenter
-from .AbstractOpamp import Opamp, OpampElement
+from .AbstractOpamp import Opamp, OpampElement, MultipackOpamp, MultipackOpampGenerator
 from .OpampCircuits import OpampFollower, Amplifier, DifferentialAmplifier, IntegratorInverting
 from .AbstractSpiMemory import SpiMemory, SpiMemoryQspi
 from .OpampCurrentSensor import OpampCurrentSensor
@@ -77,6 +78,7 @@
 from .AbstractTestPoint import AnalogRfTestPoint
 from .AbstractJumper import Jumper, DigitalJumper
 from .PassiveConnector import PassiveConnector, FootprintPassiveConnector
+from .TouchPad import FootprintToucbPad
 
 from .UsbConnectors import UsbConnector, UsbHostConnector, UsbDeviceConnector, UsbEsdDiode
 from .CanTransceiver import CanTransceiver, IsolatedCanTransceiver, CanEsdDiode

electronics_lib/BatteryProtector_S8261A.py

@@ -2,7 +2,7 @@
 from .JlcPart import JlcPart
 
 
-class BatteryProtector_S8261A_Device(InternalSubcircuit, JlcPart, FootprintBlock):
+class S8261A_Device(InternalSubcircuit, JlcPart, FootprintBlock):
   def __init__(self) -> None:
     super().__init__()
 
@@ -35,12 +35,14 @@ def contents(self) -> None:
     self.assign(self.lcsc_part, 'C28081')
     self.assign(self.actual_basic_part, False)
 
-class BatteryProtector_S8261A(PowerConditioner, Block):
+class S8261A(PowerConditioner, Block):
+  """1-cell LiIon/LiPo Battery protection IC protecting against overcharge, overdischarge, over current.
+  """
   @init_in_parent
   def __init__(self) -> None:
     super().__init__()
 
-    self.ic = self.Block(BatteryProtector_S8261A_Device())
+    self.ic = self.Block(S8261A_Device())
 
     self.pwr_out = self.Port(VoltageSource.empty())
     self.gnd_out = self.Port(GroundSource.empty())

electronics_lib/BootstrapVoltageAdder.py

@@ -1,7 +1,7 @@
 from electronics_abstract_parts import *
 
 
-class BootstrapVoltageAdder(KiCadSchematicBlock, Block):
+class BootstrapVoltageAdder(KiCadSchematicBlock, PowerConditioner, Block):
     """Bipolar (positive and negative) voltage adder using a switched cap circuit.
     """
     @init_in_parent