tengo10 / pinout-overview

A simple Python tool to create pinout overviews of ICs.

Pinout Generator

A very work in progress pinout diagram generator using Python and drawsvg

Usage

Config Files

Configuration can be split across multiple config files to allow for sharing of common properties

"_style" fields are standard SVG properties like fill, font_family, etc.

Define types

types:
    pin:
        width: 80
        description: PIN NAME
        box_style:
            stroke: black
            fill: grey
        text_style:
            font_family: Roboto Mono
            fill: white
    ...

Define pin functions

pins:
    PIN1:
        - type: pin
            name: PD7
            alt: False
        - type: spacer
    ...

Map Pins to physical output on IC

mapping: [PIN1, PIN2, ...]

Styling

See the default files for further reference

pin: !include ../defaults/pin_qfn.yaml
label: !include ../defaults/label_qfn.yaml
package: !include ../defaults/package_qfn.yaml

Chip options

footprint: QFN-20 #Footprint-PinNumber
name: "IC NAME" 
subtitle: "SUBTITLE"
package_text:
  text: "ON PACKAGE TEXT"
  sub_text: "ON PACKAGE SUBTEXT"
canvas_width: 2000
canvas_height: 1000

Generating the Images

To generate a single Image

 py pinout.py [yaml file] [output file]

To generate a whole directory, first characters of yaml files should match directory name. SVGs will be saved in the directory

 py generate_dir.py [yaml dir]

TODO

• Error checking
• Documentation
• Improve SVG generation
• Add different styling options
• Added YAML functionality like Homeassistant and ESPHome has
• Improve modularity to allow for more complex footprints
• Clean up a lot of bad programming and improve readability
• Use config files and cli

pinout-overview's Issues

CH32V003 Add notes about clamping diodes

Port A = Clamp
Port D = Clamp
PC0 = Clamp
PC4 = Clamp
PC7 = Clamp
PC1,2,3,5,6 = No Clamp Pin V can be above VCC

ch32v003

• Some Pins still appear to have the wrong functions assigned,
• Improve Timer naming scheme
• remove unnecessary white space

Thoughts to a license

Have you given any thought to, or have any interest in assigning a license to your project?

Regards,
c.

classes

Hi Tengo,

I wanted to make a minor change to your generator and it morphed into a full refactoring into classes. Algorithmicaly, there is very little change, but structurally, virtually no part was left untouched. And there is a long way to go.

If you are interested, feel free to take what you like using whatever means that best meet your needs. Ill wait a bit before i move to the SOP package for any feedback, if any, from your team.

Thanks for a nice generator. It builds a truly pretty page.

CH32V003 Add NRST to PD7

Just as a note, it's a system pin, and while it can be disabled, it does exist and should be marked off.

Add installation instructions

py -3 -m ensurepip
py -3 -m pip install drawsvg pyyaml pyyaml-include
what else?