Expose DIP pin names in SVG and legends

Author: ydah

CHANGELOG.md

@@ -5,6 +5,7 @@
 - Export printable assembly guides with bills of materials and staged diagrams.
 - Exclude nonphysical annotation wires from assembly guides and live reload watched HTML after successful changes.
 - Highlight the exact wire routes reported by short-circuit annotations.
+- Show DIP functional pin names in SVG hover titles and optional printed legends.
 - Show rail-mounted parts as logical edge pin maps at their declared rail holes.
 - Allow validated custom color palettes and embedded fonts in breadboard output.
 - Resolve named switch states directly and reject HTML viewers that exceed the 256-state budget.

README.md

@@ -239,6 +239,8 @@ across `--step` images. The breadboard and netlist views accept v2 JSON IR.
 - The built-in TO-92 transistors, trimmer potentiometer, `sc56_11ewa`
   seven-segment display, and `wp154a4sureqbfzgc` RGB LED have dedicated
   diagram shapes.
+- DIP pin numbers show functional names on hover. Add `--legend` to print a
+  readable pin map below the board, such as `1 GND · 2 TRIG` for an NE555.
 - Occupied holes and connected holes have different markers. LED colors accept
   CSS names and hexadecimal values such as `#6d5af0`. Hover over an occupied
   or connected hole in the SVG to see its hole ID and net.

lib/breadkit/render/svg_renderer.rb

@@ -524,7 +524,9 @@ def dip_svg(component, pins)
                     fill: "none", stroke: @colors[:dip_notch], stroke_width: 0.8)
         pins.each do |pin, hole|
           display = display_hole(hole)
-          out << text(px(display.x), py(display.y) + (display.y > 4 ? 4 : -2), pin.number, "font-size" => 3.5, "text-anchor" => "middle")
+          number = text(px(display.x), py(display.y) + (display.y > 4 ? 4 : -2), pin.number,
+                        "font-size" => 3.5, "text-anchor" => "middle")
+          out << %(<g data-dip-pin="#{escape(component.ref)}.#{escape(pin.name)}"><title>Pin #{escape(pin.number)}: #{escape(pin.name)}</title>#{number}</g>)
         end
         out.join
       end
@@ -1005,6 +1007,11 @@ def legend_svg
             out << text(x + 15, y, net.name, "font-size" => 5.5)
             y += 9
           end
+          dip_pin_map_lines.each do |pin_line|
+            out << text(x, y, pin_line, "font-size" => 5.5)
+            y += 7
+          end
+          y += 2 unless dip_pin_map_lines.empty?
         end
         @annotations.each_with_index do |item, index|
           message = read(item, "message") || read(item, "rule")
@@ -1045,6 +1052,13 @@ def legend_nets
         @nets.select { |net| visible_net?(net) && !(net.members.length == 1 && net.holes.empty?) }
       end
 
+      def dip_pin_map_lines
+        @visible_components.select { |component| component.part.data.dig("render", "shape") == "dip" }.flat_map do |component|
+          names = component.pins.values.sort_by { |pin| pin.number.to_i }.map { |pin| "#{pin.number} #{pin.name}" }
+          annotation_lines("#{component.ref} pins: #{names.join(' · ')}")
+        end
+      end
+
       def annotations_svg
         badge_counts = Hash.new(0)
         @annotations.each_with_index.map do |item, index|
@@ -1247,7 +1261,7 @@ def view_box(mode)
       def legend_height
         return 0 unless @legend_enabled || !@annotations.empty?
 
-        20 + (@legend_enabled ? legend_nets.length * 9 : 0) +
+        20 + (@legend_enabled ? legend_nets.length * 9 + dip_pin_map_lines.length * 7 + (dip_pin_map_lines.empty? ? 0 : 2) : 0) +
           @annotations.each_with_index.sum { |item, index| annotation_lines("#{index + 1}. #{read(item, "message") || read(item, "rule")}").length * 7 + 2 }
       end
 

spec/breadkit/render_spec.rb

@@ -98,6 +98,16 @@
     expect(REXML::XPath.match(document, "//g[@data-ref='RGB1']//*[@data-channel]").map { |node| node.attributes["data-channel"] }).to eq(%w[R G B])
   end
 
+  it "shows DIP functional pin names on hover and in the optional legend" do
+    input = File.expand_path("../../../breadkit/examples/02_555_blinker.bk.rb", __dir__)
+    document = REXML::Document.new(described_class.new.render(Breadkit.load(input), legend: true, orientation: "landscape"))
+    pins = REXML::XPath.match(document, "//g[@id='components']//g[@data-ref='U1']//g[@data-dip-pin]")
+    expect(pins.length).to eq(8)
+    expect(pins.map { |pin| pin.elements["title"].text }).to include("Pin 1: GND", "Pin 2: TRIG", "Pin 4: RESET", "Pin 8: VCC")
+    legend = REXML::XPath.match(document, "//g[@id='legend']//text").map(&:text).join(" ")
+    expect(legend).to include("U1 pins:", "1 GND", "2 TRIG", "8 VCC")
+  end
+
   it "draws TO-92 transistor and trimmer potentiometer bodies" do
     builder = Breadkit::DSL::Builder.new
     builder.instance_eval('board :mini; transistor :Q1, "BC547", pins: %w[a1 a2 a3]; pot :RV1, at: "a7"', "bodies.bk.rb", 1)