README.adoc

ASIC Pinout Drawer

This is simple IC-case drawer with proper pin assignment

Note	Russian description available here: http://idoka.ru/php-asic-pinout-generator/

Intro

Simplifying diagram to explanation tool works:

AsciiDoc    -->    CSV    -->      JSON       -->    SVG    -->      PNG
 table                          (optional)                        (optional)

Dependencies

• bash tool: grep, sed, make

• PHP

Optional

• PT fonts - that awesome font family include Latin and Cyrillic characters and covers almost all minority languages of the Russian Federation. Direct link to download PT Sans that preffer use to SVG generate

• ImageMagick (for png generate)

• Atom with asciidoc-preview plugin for comfortable creation and live-preview of asciidoc tables

Features

Usage

1. Customize the IC case geometry by defining proper parameters ()

2. Prepare table with IC pins definitions

3. Run make

The first stage of conversion make json-container of pin description and might be useful for any custom purposes (input format for other tools).

In some cases you need to customize function DecidePinColour() in file DecidePinColour.php.

Example

Click by link below for reveal step-by-step example of conversion from source doc to finish drawing:

AsciiDoc table or AsciiDoc raw → CSV → JSON → SVG → PNG

Figure 1. Example of result of tool works (PNG)

Caution

Unfortunately Github don’t support embed svg-image on README page. Do not yet?…​

ToDo

• ✓ Place the Partnumber on the top of chip

• ✓ Add legend to output

• ❏ Add local link to every pin name for easy navigate into final doc

• ❏ Read config from JSON- or ini-file (prefferable)

• ❏ Case with BGA-matrix supporting:

  • ❏ basic functionality for drawer

  • ❏ supporting list of absent pins

  • ❏ geometry pin-coding in additional to color coding (see the Xilinx FPGA pinout Documentation as Reference)

• ❏ Obvious idea for PHP-based tools: make this tool available as SaaS (online drawer)

Useful link that helps me develop that tool

ASCIIDOC

• AsciiDoc table syntax

• Advanced Syntax for Asciidoctor: Styling Cells in Tables

sed

• one-line sed scripts (RU)

PHP

• Function preg_match

• Function fgetcsv

• Function json_encode

• Function json-decode

• How do I pass parameters into a PHP script?

• Arrays by example (RU)

SVG

• SVG basic usage by Examples (RU)

• Chapter "Text" of SVG W3C Recommendation 16 August 2011 (Second Edition)

• The SVG transform attribute

• The SVG text-anchor attribute

• Text in SVG (Font, Anchor, Alignment)

Tag cloud

asciidoc, json, verilog, asic, pinout, hdl, svg, csv, automated publishing