diff --git a/geda_sch2sym.md b/geda_sch2sym.md index 7489acc..6ec81a9 100644 --- a/geda_sch2sym.md +++ b/geda_sch2sym.md @@ -1 +1,61 @@ --- \ No newline at end of file +*See also: [sch2sym.py](sch2sym.py "wikilink")* + +## About + +Documentation: + +1. Readme contained in the downlodable archive +2. On Launchpad [1](https://bugs.launchpad.net/geda/+bug/698670) +3. (Original)Post on gEDA-dev list + [2](http://www.mail-archive.com/geda-dev@moria.seul.org/msg03722.html) +4. Also on gmane archives - seach for *"gEDA Schematic to Symbol + Generator"* + +## Installation + +1. Download here: + [3](https://bugs.launchpad.net/geda/+bug/698670/+attachment/1785830/+files/geda_sch2sym.tar.gz) + or [4](http://www.xs4all.nl/~ljh4timm/downloads/geda_sch2sym.tar.gz) +2. Extract all files from the arvhive +3. Apply the Patch: + - There is a bug in the original which prevents reading of the + user-configuration (geda\_sch2sym.ini) file. The patch is + temporarily available + [here](http://www.cedt.iisc.ernet.in/people/students/kabhijit/files/.geda/geda_sch2sym.bsh.patch). + Apply the patch using the command *' patch original\_file + patch\_file*' +4. If required, add the location of geda\_sch2sym.bsh to your $PATH + environmental variable. + +## Usage + +### Prerequisites + +1. A copy of the geda\_sch2sym.ini file in the same directory as the + schematic. +2. Hierarchy traversal MUST be disabled for correct netlisting. +3. Configuring options in the ini file: + 1. Edit geda\_sch2sym.ini to edit configuration: + 1. In the \[sch\_IO\_devices\] section: + - Edit the table on lines 44-46, replacing IPAD, OPAD and + IOPAD with the actual names of IO devices used in the + schematic. + - Add one line for each class if IO device on the + schematic + 2. Run one of the following commands + +### Commands + +`[program path]geda_sch2sym.bsh –s adder1b.sch                          //Convert schematic to symbol` +`[program path]geda_sch2sym.bsh -p [input path]anyname.sch              //Convert schematic to ini file ` +`[program path]geda_sch2sym.bsh -t [input path]anyname_IO_ports.ini     //Convert ini file to symbol` + +Note: Watch the pinnumber and pinseq attributes, since these need to +match the order in subcircuit definition. It may be preferable to +generate the \*ini file, verify and modify it if needed and then +generate the symbol. + +## Caveats + +1. All IO ports of the circuits should be assigned net names. +2. Parameter values must be added separately to the symbol. \ No newline at end of file