faebryk 3.0.2

Open-source software-defined EDA

faebryk

[fˈɛbɹɪk]

Open-source software-defined EDA tool

In short faebryk is a python library that allows you to design ready-to-order electronics (PCBs, schematics, etc) in code. It aims to reduce the entry-barrier for hardware design by bridging the gap between software and hardware design.

---

Using faebryk

> pip install faebryk

import faebryk.library._F as F
from faebryk.core.core import Module
from faebryk.libs.brightness import TypicalLuminousIntensity
from faebryk.libs.examples.buildutil import apply_design_to_pcb

class App(Module):
    def __init__(self) -> None:
        super().__init__()

        class _NODES(Module.NODES()):
            led = F.PoweredLED()
            battery = F.Battery()

        self.NODEs = _NODES(self)

        self.NODEs.led.IFs.power.connect(self.NODEs.battery.IFs.power)

        # Parametrize
        self.NODEs.led.NODEs.led.PARAMs.color.merge(F.LED.Color.YELLOW)
        self.NODEs.led.NODEs.led.PARAMs.brightness.merge(
            TypicalLuminousIntensity.APPLICATION_LED_INDICATOR_INSIDE.value.value
        )


apply_design_to_pcb(App())

---

About

What [is faebryk]

faebryk is an open-source software-defined electronic design automation (EDA) tool. Think of it like the evolution from EDA tools like KiCAD, Altium, Eagle... in the way those were the next step from designing electronic circuits on paper. The main idea of faebryk is to describe your product on the highest level possible and then iteratively refining the description to arrive on a complete and detailed implementation. In comparison to classic EDA and design tools which use GUIs, faebryk uses code (Python) to create designs. While the main focus is on the EDA part currently, faebryk aims to become a holistic system design tool.

How [does designing with faebryk work]

faebryk itself is just a python library that you include in your project. It is providing you with all the tools to describe and design your system and to export that design into something useful like for example a netlist, a devicetree, gerbers etc, which you then can use in the next steps of your project. Key concepts of faebryk are the graph, importers, exporters, the library and the user application. To understand how to use faebryk in your project see using faebryk.

Who [is faebryk]

faebryk is a community driven project. That means faebryk does not only consist out of core developers but also users, external contributors, moderators and you! It is founded by a group of embedded, electrical, product design and software engineers with a love for making.

Why [do we make faebryk]

We noticed that the innovations of software engineering that make fast, scalable, robust solutions possible have not found their way into hardware design. Furthermore there is a lot of duplicate work done. Think of determining the pinout of a SoC and then having to translate that exact pinout into software again or having to constantly adapt designs for supply chain issues. Additionally, hardware design has quite a big barrier of entry for makers, but we don't think it has to. Currently hardware design is also quite labor intensive with very little automation. faebryk aims to tackle all those issues and also opens up some exciting possibilities, such as benefiting from the version management and collaboration tools that are used in modern software development.

When [is faebryk being developed]

faebryk is being continuously developed. The core team focuses on core functionality and features of faebryk, as well as the general direction of the project. The strength of the community can really shine with the development of importers, exporters, libraries, and projects, but everyone is welcome to help out where they can.

Where [do we develop faebryk]

faebryk is being developed completely in the open on Github. All the information you need to start using and contributing to faebryk will be in or linked to from this repository. If you have any questions you can ask them on our Discord. For pull requests and bug-reports, see our contributing guidelines.

---

Development

Installing from source

Setup

> git clone https://github.com/faebryk/faebryk.git
> cd faebryk
>
> poetry install

Running examples

> poetry shell
> python ./examples/<sample_name>.py

Versioning

faebryk uses semantic versioning in the releases.

As feabryk is still in the early stages of development new releases will have a lot of (breaking) changes in them. Our roadmap(TODO) will show you where the project is going to and what you can expect in future releases.

Contributing

See CONTRIBUTING.md

To get inspiration on things to work on check out the issues.

Running your own examples/Making samples

First follow the steps in get running from source. Then add a file in examples/ (you can use one of the examples as template). Call your file with python3 examples/<yourfile>.py.

Running tests

Run

> pytest test

Community Support

Community support is provided via Discord; see the Resources below for details.

Resources

• Source Code: https://github.com/faebryk/faebryk
• Chat: Real-time chat happens in faebryk's Discord Server. Use this Discord Invite to register
• Issues: https://github.com/faebryk/faebryk/issues

MIT License

Copyright (c) 2021 faebryk

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.