Prefer lower e-series values for resistors and capacitors (#430)

The series is added to a sort in the resistor and capacitor table. The
idea is to prefer more common parts where they fit. Inductors not
modified since they are much more nonstandard.

Removes the "E1" series, since it is nonstandard and promotes capacitors
jumping from 4.7uF to 10uF. Also removes the 24+192 series and the like,
those have a nonstandard key. The higher series are not used in the
examples, and if desired some similar function can be added in the
future.

In practice (from the netlist diffs), this picks better resistors. These
may be more concerning:
- This changes RF and crystal caps. TBD if that is problematic, but they
are still within their stated tolerance, and in any case it was not
selecting intelligently before at all.
- The SMU example needs to be updated to up the min clamp current,
otherwise the resistance picked is too high for the sink.

Fixes some OLED capacitor definitions to tighten the range. The new rule
is only the 2.2uF caps are allowed to extend, but not the 4.7uF which is
considered more standard.

Resolves #85

Author: ducky64

edg/abstract_parts/AbstractCapacitor.py

@@ -4,6 +4,7 @@
 import math
 
 from ..electronics_model import *
+from .ESeriesUtil import ESeriesUtil
 from .PartsTable import PartsTableColumn, PartsTableRow, PartsTable
 from .PartsTablePart import PartsTableSelector
 from .Categories import *
@@ -196,6 +197,10 @@ def _row_filter(self, row: PartsTableRow) -> bool:
   def _row_filter_capacitance(self, row: PartsTableRow) -> bool:
     return row[self.CAPACITANCE].fuzzy_in(self.get(self.capacitance))
 
+  @classmethod
+  def _row_sort_by(cls, row: PartsTableRow) -> Any:
+    return (ESeriesUtil.series_of(row[cls.NOMINAL_CAPACITANCE], default=ESeriesUtil.SERIES_MAX + 1),
+            super()._row_sort_by(row))
 
 @non_library
 class TableDeratingCapacitor(TableCapacitor):

edg/abstract_parts/AbstractResistor.py

@@ -1,7 +1,8 @@
 import re
-from typing import Optional, cast, Mapping, Dict
+from typing import Optional, cast, Mapping, Dict, Any
 
 from ..electronics_model import *
+from .ESeriesUtil import ESeriesUtil
 from .PartsTable import PartsTableColumn, PartsTableRow
 from .PartsTablePart import PartsTableSelector
 from .Categories import *
@@ -120,6 +121,11 @@ def _row_generate(self, row: PartsTableRow) -> None:
     self.assign(self.actual_power_rating, row[self.POWER_RATING])
     self.assign(self.actual_voltage_rating, row[self.VOLTAGE_RATING])
 
+  @classmethod
+  def _row_sort_by(cls, row: PartsTableRow) -> Any:
+    return (ESeriesUtil.series_of(row[cls.RESISTANCE].center(), default=ESeriesUtil.SERIES_MAX + 1),
+            super()._row_sort_by(row))
+
 
 class PullupResistor(DiscreteApplication):
   """Pull-up resistor with an VoltageSink for automatic implicit connect to a Power line."""

edg/abstract_parts/ESeriesUtil.py

@@ -2,11 +2,14 @@
 import math
 from abc import ABCMeta, abstractmethod
 from collections import deque
-from typing import Sequence, Optional, TypeVar, Tuple, List, Generic, Type
+from typing import Sequence, Optional, TypeVar, Tuple, List, Generic, Type, Union, overload
 
 from ..electronics_model import *
 
 
+SeriesDefaultType = TypeVar('SeriesDefaultType')
+
+
 class ESeriesUtil:
   """Helper methods for working with the E series of preferred numbers."""
   @staticmethod
@@ -59,9 +62,10 @@ def choose_preferred_number(cls, within: Range, series: Sequence[float], toleran
 
   ROUND_DIGITS = 5
 
+  SERIES_MAX = 192
+
   E24_DIFF = {  # series as difference from prior series
-    1: [1.0],
-    3: [2.2, 4.7],
+    3: [1.0, 2.2, 4.7],
     6: [1.5, 3.3, 6.8],
     12: [1.2, 1.8, 2.7, 3.9, 5.6, 8.2],
     24: [1.1, 1.3, 1.6, 2.0, 2.4, 3.0, 3.6, 4.3, 5.1, 6.2, 7.5, 9.1],
@@ -87,26 +91,36 @@ def choose_preferred_number(cls, within: Range, series: Sequence[float], toleran
   }
 
   SERIES = {  # whole series in zigzag order
-    1: list(itertools.chain(E24_DIFF[1])),
-    3: list(itertools.chain(E24_DIFF[1], E24_DIFF[3])),
-    6: list(itertools.chain(E24_DIFF[1], E24_DIFF[3], E24_DIFF[6])),
-    12: list(itertools.chain(E24_DIFF[1], E24_DIFF[3], E24_DIFF[6], E24_DIFF[12])),
-    24: list(itertools.chain(E24_DIFF[1], E24_DIFF[3], E24_DIFF[6], E24_DIFF[12], E24_DIFF[24])),
+    3: list(itertools.chain(E24_DIFF[3])),
+    6: list(itertools.chain(E24_DIFF[3], E24_DIFF[6])),
+    12: list(itertools.chain(E24_DIFF[3], E24_DIFF[6], E24_DIFF[12])),
+    24: list(itertools.chain(E24_DIFF[3], E24_DIFF[6], E24_DIFF[12], E24_DIFF[24])),
 
     # These are E192 without the E24 series
     48: list(itertools.chain(E192_DIFF[48])),
     96: list(itertools.chain(E192_DIFF[48], E192_DIFF[96])),
     192: list(itertools.chain(E192_DIFF[48], E192_DIFF[96], E192_DIFF[192])),
-
-    # These are E24 + E192, prioritizing E24
-    2448: list(itertools.chain(E24_DIFF[1], E24_DIFF[3], E24_DIFF[6], E24_DIFF[12], E24_DIFF[24],
-                               E192_DIFF[48])),
-    2496: list(itertools.chain(E24_DIFF[1], E24_DIFF[3], E24_DIFF[6], E24_DIFF[12], E24_DIFF[24],
-                               E192_DIFF[48], E192_DIFF[96])),
-    24192: list(itertools.chain(E24_DIFF[1], E24_DIFF[3], E24_DIFF[6], E24_DIFF[12], E24_DIFF[24],
-                                E192_DIFF[48], E192_DIFF[96], E192_DIFF[192])),
   }
 
+  # reverse mapping of value to series, reverse SERIES so lower series preferred
+  VALUE_SERIES = {v: k for k, series in reversed(SERIES.items()) for v in series}
+
+  @classmethod
+  @overload
+  def series_of(cls, value: float) -> Optional[int]: ...
+  @classmethod
+  @overload
+  def series_of(cls, value: float, *, default: SeriesDefaultType) -> Union[int, SeriesDefaultType]: ...
+
+  @classmethod
+  def series_of(cls, value: float, *, default: Optional[SeriesDefaultType] = None) -> Union[None, int, SeriesDefaultType]:
+    """Returns the E-series that contains the given value, or None if not found.
+    Performs limited rounding to account for floating point issues."""
+    if value <= 0:
+      return default
+    normalized_value = value * math.pow(10, -math.floor(math.log10(value)))
+    return cls.VALUE_SERIES.get(cls.round_sig(normalized_value, cls.ROUND_DIGITS), default)
+
 
 ESeriesRatioValueType = TypeVar('ESeriesRatioValueType', bound='ESeriesRatioValue')
 class ESeriesRatioValue(Generic[ESeriesRatioValueType], metaclass=ABCMeta):

edg/abstract_parts/test_e_series.py

@@ -41,8 +41,6 @@ def test_preferred_number(self) -> None:
                      1000)
     self.assertEqual(ESeriesUtil.choose_preferred_number(Range(220, 820), ESeriesUtil.SERIES[24], 0.01),
                      470)
-    self.assertEqual(ESeriesUtil.choose_preferred_number(Range(220, 820), ESeriesUtil.SERIES[24192], 0.01),
-                     470)
 
     # Test dynamic range edge cases
     self.assertEqual(ESeriesUtil.choose_preferred_number(Range(999, 1500), ESeriesUtil.SERIES[24], 0.01),
@@ -58,3 +56,14 @@ def test_ratio_product(self):
                       (2, 1), (1, 2), (2, 2),
                       (3, 1), (1, 3), (3, 2), (2, 3), (3, 3),
                       (4, 1), (1, 4), (4, 2), (2, 4), (4, 3), (3, 4), (4, 4)])
+
+  def test_series_of(self):
+    self.assertEqual(ESeriesUtil.series_of(1.0), 3)
+    self.assertEqual(ESeriesUtil.series_of(2.2), 3)
+    self.assertEqual(ESeriesUtil.series_of(6.8), 6)
+    self.assertEqual(ESeriesUtil.series_of(6800), 6)
+    self.assertEqual(ESeriesUtil.series_of(0.91), 24)
+    self.assertEqual(ESeriesUtil.series_of(0.01), 3)
+    self.assertEqual(ESeriesUtil.series_of(9.88), 192)
+    self.assertEqual(ESeriesUtil.series_of(0.42), None)
+    self.assertEqual(ESeriesUtil.series_of(0.42, default=1000), 1000)

edg/abstract_parts/test_resistive_divider.py

@@ -38,7 +38,7 @@ def test_resistor_divider(self) -> None:
       (820, 100))
 
   def test_impossible(self) -> None:
-    e1_calculator = ESeriesRatioUtil(ESeriesUtil.SERIES[1], 0.01, DividerValues)
+    e1_calculator = ESeriesRatioUtil([1.0], 0.01, DividerValues)
 
     with self.assertRaises(ESeriesRatioUtil.NoMatchException) as error:
       self.assertEqual(

edg/parts/Oled_Er_Oled_091_3.py

@@ -94,12 +94,12 @@ def contents(self):
         self.iref_res = self.Block(Resistor(resistance=560*kOhm(tol=0.05)))  # TODO dynamic sizing
         self.connect(self.iref_res.a, self.device.iref)
         self.connect(self.iref_res.b.adapt_to(Ground()), self.gnd)
-        self.vcomh_cap = self.Block(DecouplingCapacitor((2.2*.8, 20)*uFarad)).connected(self.gnd, self.device.vcomh)
+        self.vcomh_cap = self.Block(DecouplingCapacitor((2.2*.8, 10)*uFarad)).connected(self.gnd, self.device.vcomh)
 
         self.vdd_cap1 = self.Block(DecouplingCapacitor(capacitance=0.1*uFarad(tol=0.2))).connected(self.gnd, self.pwr)
         self.vdd_cap2 = self.Block(DecouplingCapacitor(capacitance=4.7*uFarad(tol=0.2))).connected(self.gnd, self.pwr)
 
         self.vcc_cap1 = self.Block(DecouplingCapacitor(capacitance=0.1*uFarad(tol=0.2)))\
             .connected(self.gnd, self.device.vcc)
-        self.vcc_cap2 = self.Block(DecouplingCapacitor(capacitance=(4.7*.8, 20)*uFarad))\
+        self.vcc_cap2 = self.Block(DecouplingCapacitor(capacitance=4.7*uFarad(tol=0.2)))\
             .connected(self.gnd, self.device.vcc)

edg/parts/Oled_Er_Oled_096_1_1.py

@@ -110,7 +110,7 @@ def contents(self):
             .connected(self.gnd, self.device.vdd)
         self.vbat_cap = self.Block(DecouplingCapacitor(capacitance=1*uFarad(tol=0.2)))\
             .connected(self.gnd, self.device.vbat)
-        self.vcc_cap = self.Block(DecouplingCapacitor(capacitance=(2.2*0.8, 20)*uFarad))\
+        self.vcc_cap = self.Block(DecouplingCapacitor(capacitance=(2.2*0.8, 10)*uFarad))\
             .connected(self.gnd, self.device.vcc)
 
     def generate(self):

examples/BldcController/BldcController.net

@@ -488,8 +488,8 @@
   (property (name "edg_path") (value "isense_clamp.res"))
   (property (name "edg_short_path") (value "isense_clamp"))
   (property (name "edg_refdes") (value "R18"))
-  (property (name "edg_part") (value "0603WAF3602T5E (UNI-ROYAL(Uniroyal Elec))"))
-  (property (name "edg_value") (value "±1% 1/10W Thick Film Resistors 75V ±100ppm/℃ -55℃~+155℃ 36kΩ 0603 Chip Resistor - Surface Mount ROHS"))
+  (property (name "edg_part") (value "0603WAF1002T5E (UNI-ROYAL(Uniroyal Elec))"))
+  (property (name "edg_value") (value "±1% 1/10W Thick Film Resistors 75V ±100ppm/℃ -55℃~+155℃ 10kΩ 0603 Chip Resistor - Surface Mount ROHS"))
   (sheetpath (names "/") (tstamps "/"))
   (tstamps "205a04f4"))
 (comp (ref "U4")

examples/DeskController/DeskController.net

@@ -488,8 +488,8 @@
   (property (name "edg_path") (value "oled.iref_res"))
   (property (name "edg_short_path") (value "oled.iref_res"))
   (property (name "edg_refdes") (value "DR5"))
-  (property (name "edg_part") (value "0603WAF4303T5E (UNI-ROYAL(Uniroyal Elec))"))
-  (property (name "edg_value") (value "±1% 1/10W Thick Film Resistors 75V ±100ppm/℃ -55℃~+155℃ 430kΩ 0603 Chip Resistor - Surface Mount ROHS"))
+  (property (name "edg_part") (value "0603WAF4703T5E (UNI-ROYAL(Uniroyal Elec))"))
+  (property (name "edg_value") (value "±1% 1/10W Thick Film Resistors 75V ±100ppm/℃ -55℃~+155℃ 470kΩ 0603 Chip Resistor - Surface Mount ROHS"))
   (sheetpath (names "/oled/") (tstamps "/043201a5/"))
   (tstamps "0ed90350"))
 (comp (ref "DC8")

examples/EspLora/EspLora.net

@@ -572,8 +572,8 @@
   (property (name "edg_path") (value "lora.balun.c"))
   (property (name "edg_short_path") (value "lora.balun.c"))
   (property (name "edg_refdes") (value "LC15"))
-  (property (name "edg_part") (value "0603CG3R0C500NT (FH(Guangdong Fenghua Advanced Tech))"))
-  (property (name "edg_value") (value "50V 3pF C0G ±0.25pF 0603 Multilayer Ceramic Capacitors MLCC - SMD/SMT ROHS"))
+  (property (name "edg_part") (value "CL10C2R7CB8NNNC (Samsung Electro-Mechanics)"))
+  (property (name "edg_value") (value "50V 2.7pF C0G ±0.25pF 0603 Multilayer Ceramic Capacitors MLCC - SMD/SMT ROHS"))
   (sheetpath (names "/lora/balun/") (tstamps "/044601af/060f0213/"))
   (tstamps "00640064"))
 (comp (ref "LC16")
@@ -824,8 +824,8 @@
   (property (name "edg_path") (value "oled.iref_res"))
   (property (name "edg_short_path") (value "oled.iref_res"))
   (property (name "edg_refdes") (value "LR11"))
-  (property (name "edg_part") (value "0603WAF4303T5E (UNI-ROYAL(Uniroyal Elec))"))
-  (property (name "edg_value") (value "±1% 1/10W Thick Film Resistors 75V ±100ppm/℃ -55℃~+155℃ 430kΩ 0603 Chip Resistor - Surface Mount ROHS"))
+  (property (name "edg_part") (value "0603WAF4703T5E (UNI-ROYAL(Uniroyal Elec))"))
+  (property (name "edg_value") (value "±1% 1/10W Thick Film Resistors 75V ±100ppm/℃ -55℃~+155℃ 470kΩ 0603 Chip Resistor - Surface Mount ROHS"))
   (sheetpath (names "/oled/") (tstamps "/043201a5/"))
   (tstamps "0ed90350"))
 (comp (ref "LC21")
@@ -1052,8 +1052,8 @@
   (property (name "edg_path") (value "nfc.xtal.cap_a"))
   (property (name "edg_short_path") (value "nfc.xtal.cap_a"))
   (property (name "edg_refdes") (value "LC34"))
-  (property (name "edg_part") (value "0603CG6R8C500NT (FH(Guangdong Fenghua Advanced Tech))"))
-  (property (name "edg_value") (value "50V 6.8pF C0G ±0.25pF 0603 Multilayer Ceramic Capacitors MLCC - SMD/SMT ROHS"))
+  (property (name "edg_part") (value "CL10C100JB8NNNC (Samsung Electro-Mechanics)"))
+  (property (name "edg_value") (value "50V 10pF C0G ±5% 0603 Multilayer Ceramic Capacitors MLCC - SMD/SMT ROHS"))
   (sheetpath (names "/nfc/xtal/") (tstamps "/027c0138/046e01ba/"))
   (tstamps "05e701f5"))
 (comp (ref "LC35")
@@ -1064,8 +1064,8 @@
   (property (name "edg_path") (value "nfc.xtal.cap_b"))
   (property (name "edg_short_path") (value "nfc.xtal.cap_b"))
   (property (name "edg_refdes") (value "LC35"))
-  (property (name "edg_part") (value "0603CG6R8C500NT (FH(Guangdong Fenghua Advanced Tech))"))
-  (property (name "edg_value") (value "50V 6.8pF C0G ±0.25pF 0603 Multilayer Ceramic Capacitors MLCC - SMD/SMT ROHS"))
+  (property (name "edg_part") (value "CL10C100JB8NNNC (Samsung Electro-Mechanics)"))
+  (property (name "edg_value") (value "50V 10pF C0G ±5% 0603 Multilayer Ceramic Capacitors MLCC - SMD/SMT ROHS"))
   (sheetpath (names "/nfc/xtal/") (tstamps "/027c0138/046e01ba/"))
   (tstamps "05e801f6"))
 (comp (ref "LR13")
@@ -1148,8 +1148,8 @@
   (property (name "edg_path") (value "nfc.emc.c1"))
   (property (name "edg_short_path") (value "nfc.emc.c1"))
   (property (name "edg_refdes") (value "LC38"))
-  (property (name "edg_part") (value "TCC0603X7R511K500CT (CCTC)"))
-  (property (name "edg_value") (value "50V 510pF X7R ±10% 0603 Multilayer Ceramic Capacitors MLCC - SMD/SMT ROHS"))
+  (property (name "edg_part") (value "TCC0603COG471J500CT (CCTC)"))
+  (property (name "edg_value") (value "50V 470pF C0G ±5% 0603 Multilayer Ceramic Capacitors MLCC - SMD/SMT ROHS"))
   (sheetpath (names "/nfc/emc/") (tstamps "/027c0138/026f0136/"))
   (tstamps "00f90095"))
 (comp (ref "LC39")
@@ -1160,8 +1160,8 @@
   (property (name "edg_path") (value "nfc.emc.c2"))
   (property (name "edg_short_path") (value "nfc.emc.c2"))
   (property (name "edg_refdes") (value "LC39"))
-  (property (name "edg_part") (value "TCC0603X7R511K500CT (CCTC)"))
-  (property (name "edg_value") (value "50V 510pF X7R ±10% 0603 Multilayer Ceramic Capacitors MLCC - SMD/SMT ROHS"))
+  (property (name "edg_part") (value "TCC0603COG471J500CT (CCTC)"))
+  (property (name "edg_value") (value "50V 470pF C0G ±5% 0603 Multilayer Ceramic Capacitors MLCC - SMD/SMT ROHS"))
   (sheetpath (names "/nfc/emc/") (tstamps "/027c0138/026f0136/"))
   (tstamps "00fa0096"))
 (comp (ref "LANT1")
@@ -1184,8 +1184,8 @@
   (property (name "edg_path") (value "nfc.damp.r1"))
   (property (name "edg_short_path") (value "nfc.damp.r1"))
   (property (name "edg_refdes") (value "LR15"))
-  (property (name "edg_part") (value "RTT032R55FTP (RALEC)"))
-  (property (name "edg_value") (value "±1% 1/10W Thick Film Resistors 75V ±200ppm/℃ -55℃~+155℃ 2.55Ω 0603 Chip Resistor - Surface Mount ROHS"))
+  (property (name "edg_part") (value "RC0603FR-072R61L (YAGEO)"))
+  (property (name "edg_value") (value "±1% 100mW Thick Film Resistors 75V ±200ppm/℃ -55℃~+155℃ 2.61Ω 0603 Chip Resistor - Surface Mount ROHS"))
   (sheetpath (names "/nfc/damp/") (tstamps "/027c0138/040101a3/"))
   (tstamps "011700a4"))
 (comp (ref "LR16")
@@ -1196,8 +1196,8 @@
   (property (name "edg_path") (value "nfc.damp.r2"))
   (property (name "edg_short_path") (value "nfc.damp.r2"))
   (property (name "edg_refdes") (value "LR16"))
-  (property (name "edg_part") (value "RTT032R55FTP (RALEC)"))
-  (property (name "edg_value") (value "±1% 1/10W Thick Film Resistors 75V ±200ppm/℃ -55℃~+155℃ 2.55Ω 0603 Chip Resistor - Surface Mount ROHS"))
+  (property (name "edg_part") (value "RC0603FR-072R61L (YAGEO)"))
+  (property (name "edg_value") (value "±1% 100mW Thick Film Resistors 75V ±200ppm/℃ -55℃~+155℃ 2.61Ω 0603 Chip Resistor - Surface Mount ROHS"))
   (sheetpath (names "/nfc/damp/") (tstamps "/027c0138/040101a3/"))
   (tstamps "011800a5"))
 (comp (ref "LC40")
@@ -1232,8 +1232,8 @@
   (property (name "edg_path") (value "nfc.match.cp1"))
   (property (name "edg_short_path") (value "nfc.match.cp1"))
   (property (name "edg_refdes") (value "LC42"))
-  (property (name "edg_part") (value "CL10C560JB8NNNC (Samsung Electro-Mechanics)"))
-  (property (name "edg_value") (value "50V 56pF C0G ±5% 0603 Multilayer Ceramic Capacitors MLCC - SMD/SMT ROHS"))
+  (property (name "edg_part") (value "CL10C470JB8NNNC (Samsung Electro-Mechanics)"))
+  (property (name "edg_value") (value "50V 47pF C0G ±5% 0603 Multilayer Ceramic Capacitors MLCC - SMD/SMT ROHS"))
   (sheetpath (names "/nfc/match/") (tstamps "/027c0138/0634020e/"))
   (tstamps "023d0105"))
 (comp (ref "LC43")
@@ -1244,8 +1244,8 @@
   (property (name "edg_path") (value "nfc.match.cp2"))
   (property (name "edg_short_path") (value "nfc.match.cp2"))
   (property (name "edg_refdes") (value "LC43"))
-  (property (name "edg_part") (value "CL10C560JB8NNNC (Samsung Electro-Mechanics)"))
-  (property (name "edg_value") (value "50V 56pF C0G ±5% 0603 Multilayer Ceramic Capacitors MLCC - SMD/SMT ROHS"))
+  (property (name "edg_part") (value "CL10C470JB8NNNC (Samsung Electro-Mechanics)"))
+  (property (name "edg_value") (value "50V 47pF C0G ±5% 0603 Multilayer Ceramic Capacitors MLCC - SMD/SMT ROHS"))
   (sheetpath (names "/nfc/match/") (tstamps "/027c0138/0634020e/"))
   (tstamps "023e0106"))
 (comp (ref "LC44")
@@ -1256,8 +1256,8 @@
   (property (name "edg_path") (value "tx_cpack.cap"))
   (property (name "edg_short_path") (value "tx_cpack"))
   (property (name "edg_refdes") (value "LC44"))
-  (property (name "edg_part") (value "0603CG8R2C500NT (FH(Guangdong Fenghua Advanced Tech))"))
-  (property (name "edg_value") (value "50V 8.2pF C0G ±0.25pF 0603 Multilayer Ceramic Capacitors MLCC - SMD/SMT ROHS"))
+  (property (name "edg_part") (value "CL10C100JB8NNNC (Samsung Electro-Mechanics)"))
+  (property (name "edg_value") (value "50V 10pF C0G ±5% 0603 Multilayer Ceramic Capacitors MLCC - SMD/SMT ROHS"))
   (sheetpath (names "/") (tstamps "/"))
   (tstamps "0f2d034e")))
 (nets