template and source for hardware projects
Go to file
King Kévin e1bb7f4fba sch: add initial completed draft 2021-07-22 13:11:38 +02:00
coraleda/subc lib: add generated symbols and footprints 2021-07-22 13:11:32 +02:00
geda/symbols lib: add generated symbols and footprints 2021-07-22 13:11:32 +02:00
library@e482148d18 add parts library (as submodule) 2021-07-22 12:26:46 +02:00
.gitignore ignore output files 2021-07-22 12:36:45 +02:00
.gitmodules add parts library (as submodule) 2021-07-22 12:26:46 +02:00
.qeda.yaml lib: add used parts 2021-07-22 13:10:45 +02:00
LICENSE.txt add CERN-OHL-S license 2021-07-22 12:22:58 +02:00
NOTES add empty notes file 2021-07-22 12:23:28 +02:00
README.md add project README 2021-07-22 12:22:24 +02:00
Rakefile add output generation script 2021-07-22 12:34:35 +02:00
gafrc add schematic configuration and template 2021-07-22 12:28:19 +02:00
template.lht add board layout template 2021-07-22 12:32:23 +02:00
template.sch add schematic configuration and template 2021-07-22 12:28:19 +02:00
usb-bug-detector.sch sch: add initial completed draft 2021-07-22 13:11:38 +02:00
version add output generation script 2021-07-22 12:34:35 +02:00

README.md

these are the hardware design files for insert project name here.

purpose

usage

requirements

to be able to generate the outputs you need following software:

  • rake: the central script taking care of generating the output files (Makefile is too cumbersome to parse files)
  • QEDA: to generate footprints for the parts
  • Lepton EDA: for the schematic capture
  • pcb-rnd: for the board layout the output generation is automatized.

schematic

library

almost all of the symbols and footprints used in the schematic and board layout are defined in the QEDA format and generated for the CAD software. the library folder contains the QEDA parts definitions.

to install QEDA using NPM from the official repository:

sudo npm install -g qeda

to install QEDA from the sources:

git clone https://github.com/qeda/qeda
cd qeda
npm install
sudo npm install --global

to generate the parts:

rake library

this will use the parts definition (.yaml files) in the library to generate gEDA gschem/Lepton EDA symbols (.sym files) in the geda/symbols folder, and coralEDA pcb-rnd footprints (.lht files) in the coraleda/subc folder.

only the QEDA parts in subfolders within library come from the QEDA library, but the files are included in this project for simplicity and archiving purposes. all other parts are custom and written for this project.

schematic

the .sch file is the schematic source file. it has been drawn using Lepton EDA.

it uses standard symbols, and the ones in the geda/symbols/ folder. most symbols are generated by QEDA as described above.

to export the netlist (in tEDAx format):

rake netlist

to export as pdf:

rake print

BOM

to export the bill of material (as CSV):

rake bom

board

the .lht file is the board layout source file. it has been drawn using coralEDA pcb-rnd.

it uses the symbols from the coraleda/subc/ folder. most symbols are generated by QEDA as described above. oshw_logo.lht is just the Open Source Hardware Logo. it been generated from https://oshwlogo.cuvoodoo.info/.

to export gerber files for PCB manufacturer (and photo preview + overview document):

rake fabrication

fabrication