Skip to content

development.md

Latest commit

 

History

History
100 lines (71 loc) · 2.64 KB

development.md

File metadata and controls

100 lines (71 loc) · 2.64 KB
Raw

Working with the source

Project structure

📦<root>
 ┣ 📂build `Here you can find the "usefull" files after building this project localy`
 ┃ ┣ 📂faebryk
 ┃ ┣ 📂kicad
 ┣ 📂docs `Project documentation is placed in this folder`
 ┣ 📂source
 ┃ ┣ 📂faebryk
 ┃ ┃ ┣ 📂library
 ┃ ┃ ┃ ┣ 📂library
 ┃ ┃ ┃ ┃ ┗ 📜components.py `In this file you can put the components that are not in the standard faebryk library`
 ┃ ┃ ┣ 📂modules
 ┃ ┃ ┗ 📜main.py `This is the main faberyk file of this project. Any changes should be made here`
 ┃ ┣ 📂kicad `KiCad project files`
 ┃ ┃ ┗ 📂main
 ┃ ┃ ┃ ┣ 📜main.kicad_pcb
 ┃ ┃ ┃ ┣ 📜main.kicad_pro
 ┃ ┃ ┃ ┣ 📜main.kicad_sch
 ┣ 📜.gitignore
 ┣ 📜render.png
 ┣ 📜overview.png
 ┣ 📜LICENSE
 ┣ 📜README.md `Project "homepage"`
 ┗ 📜requirements.txt `Required python/pip packages`

Prerequisites

To start working on this project you will need the following.

Step 1

Install the following programs:

Step 2

Clone this repository and install the requirements

git clone https://github.com/IoannisP-ITENG/CableTester
cd CableTester

# create venv (optional)
mkdir .local
python -m venv .local/venv
source .local/venv/bin/activate

pip install -r requirements.txt

Step 3

Run the project to see if everything is installed correctly

python3 ./source/faebryk/main.py

This should output a netlist file in the ./build/faebryk/netlist/ folder.

Step 4

Check if KiCad works

Open the ./source/kicad/main.prj file in KiCad.

Editing the project

The files you will work with most are ./source/faebryk/main.py and ./source/faebryk/cable_tester.py. Here you describe your design in faebryk.

If you want to create your own components, traits or modules specific to this project you can place them in ./source/faebryk/library/<thing you want to add>.

The PCB layout can be eddited in KiCad 7 by edditing the ./souce/kicad/main/main.kicad_pcb file. If you changed anything in the faebryk source, you have to re-import the netlist into KiCad like so:

  • file > import > netlist
  • Select the file ./build/faebryk/faebryk.net
  • Press Load and Test Netlist
  • If there are no errors, press Update PCB

Running the project

To run the project and output the build files do as follow:

python ./source/faebryk/main.py

The output files will be in ./build/faebryk/