Skip to main content

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.

Project description

Open-FDD

Discord CI MIT Beta Python 3.10+

Open-FDD logo

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).

Documentation PDF documentation


Install / run

Full Open-FDD edge stack (Docker / GHCR)

Use GHCR 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):

# 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.0.34 bash /tmp/openfdd_edge_bootstrap.sh --start --image-tag 3.0.34

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

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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

open_fdd-3.1.1.tar.gz (60.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

open_fdd-3.1.1-py3-none-any.whl (67.4 kB view details)

Uploaded Python 3

File details

Details for the file open_fdd-3.1.1.tar.gz.

File metadata

  • Download URL: open_fdd-3.1.1.tar.gz
  • Upload date:
  • Size: 60.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for open_fdd-3.1.1.tar.gz
Algorithm Hash digest
SHA256 dec77f55090fe2d63c734a15a21ae21a327d836c0c5ffce03a83809d8d6d1bcb
MD5 4876e3eec2d369bbeda15e1e6d606d08
BLAKE2b-256 24a9c9c65062d152039c4f59b9aadb7d9cf6846e7aae9a0b7707b55e6bf3155e

See more details on using hashes here.

Provenance

The following attestation bundles were made for open_fdd-3.1.1.tar.gz:

Publisher: publish-open-fdd.yml on bbartling/open-fdd

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file open_fdd-3.1.1-py3-none-any.whl.

File metadata

  • Download URL: open_fdd-3.1.1-py3-none-any.whl
  • Upload date:
  • Size: 67.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for open_fdd-3.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5626f8ddf3680f3ada3aa263b5399438bcf5bdfc24a50261719b880887f160aa
MD5 487984d1c741d9ebf02f4b1c58749da9
BLAKE2b-256 788e0bde1394d2e5a34f0933a0efc7430068f0859947e05f962f8085a4471e05

See more details on using hashes here.

Provenance

The following attestation bundles were made for open_fdd-3.1.1-py3-none-any.whl:

Publisher: publish-open-fdd.yml on bbartling/open-fdd

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page