Skip to content

Logix Catalog Docs

These are Logix Catalog's docs. Its main page, what it is and how it's used, is www.openlogix.org/catalog; the data and code are on GitHub.

Every FPGA board, described once.

Logix Catalog is the open catalog of FPGA boards behind every Open Logix tool: each board's FPGA, how to program it, and what its pins are wired to, from clocks and LEDs to PMOD headers. It's one readable JSON file per board. Logix Engine builds it in and serves it to every tool, yours included.

In development. The format may still change before the first release.

Documentation

Page What it covers
Board model How a board is described: its file, variants, resources, requirements and AI hints
Design Why the catalog is shaped this way, how it grows, and how Logix Engine uses it

What's in the catalog

  • boards/: one file per board, boards/<id>.json.
  • fpgas/: every FPGA the toolchain supports, by ID, one file per FPGA family.
  • schemas/: the JSON Schemas, also served at www.openlogix.org/schemas/.

Using the data

Important

Use it through Logix Engine. The intended way for tools, scripts and AI agents to read Logix Catalog is Logix Engine's API (get_catalog), which downloads the catalog and serves it. The data is free to use and copy under MIT or Apache 2.0, but reading the files directly is at your own risk: their layout may change between releases.

The board file format stays stable for writing boards: your own boards and contributions.

Adding or fixing a board

  1. Copy a similar board's file to boards/<new-id>.json, or edit the board's file.
  2. Fill in what you know; leave out what you don't. Say where a fact comes from with source (see the board model).
  3. Run scripts/test.sh (Python 3). It checks every board and formats files the canonical way with tools/check.py --fix.
  4. Open a pull request.