open-fdd 3.1.3

Arrow-native HVAC fault detection runtime — lint, test, and run apply_faults_arrow rules on columnar telemetry (PyPI). Use GHCR Docker images for the full edge operator stack.

Open-FDD

Open-source supervisory fault detection for buildings — Arrow-native rules, optional DataFusion SQL rules for Rust-ready migration, optional PyPI embeddable runtime, and a full Docker/GHCR edge operator stack (BACnet, bridge API, dashboard, MCP).

---

Install / run

Full Open-FDD edge stack (Docker / GHCR)

Use GHCR (GitHub Container Registry — GitHub’s OCI image registry at ghcr.io) for BACnet polling, Operator Bridge API, React dashboard, historian, and MCP sidecar in a docker pull workflow.

Image	Role
ghcr.io/bbartling/openfdd-bridge	API, dashboard, historian
ghcr.io/bbartling/openfdd-commission	BACnet discover, read, poll
ghcr.io/bbartling/openfdd-mcp-rag	MCP + doc-search

Prefer pinned release tags in production (not floating latest). Set OPENFDD_IMAGE_TAG / --image-tag / NEW_TAG to the current release (today 3.1.3 — bump these on every release):

# Bootstrap a new edge host (no git clone) — creates ~/open-fdd, auth.env.local, BACnet bind
curl -fsSL -o /tmp/openfdd_edge_bootstrap.sh \
  https://github.com/bbartling/open-fdd/raw/refs/heads/master/scripts/openfdd_edge_bootstrap.sh
OPENFDD_IMAGE_TAG=3.1.3 bash /tmp/openfdd_edge_bootstrap.sh --start --image-tag 3.1.3

# Update an existing site — backup workspace, pull pinned GHCR tags, recreate containers
cd ~/open-fdd
./scripts/openfdd_site_backup.sh
NEW_TAG=3.1.3 ./scripts/openfdd_site_update.sh

From a repo checkout: ./scripts/openfdd_edge_bootstrap.sh --start --image-tag 3.1.3

Edge bootstrap: Run with Docker images · Site updates: Updating the stack

Python package (PyPI)

Use PyPI when you only need the embeddable Arrow-native FDD runtime — lint, test, and run rules in your own pipelines (cloud, IoT, notebooks) without Docker.

pip install open-fdd

import pyarrow as pa
import pyarrow.compute as pc

from open_fdd.arrow_runtime import run_arrow_rule


def high_sat(table, cfg, context=None):
    return pc.greater(table["SAT"], float(cfg["high"]))


table = pa.table({"SAT": [70.0, 90.0]})

result = run_arrow_rule(high_sat, table, {"high": 85})

print(result.true_count)  # 1

---

Develop

git clone https://github.com/bbartling/open-fdd.git && cd open-fdd
python -m venv .venv && source .venv/bin/activate
pip install -e ".[test,dev,analytics]"
pytest open_fdd/tests -q

Contributor layout: AGENTS.md and developer docs.

---

License

MIT — see LICENSE.