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

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

export OPENFDD_IMAGE_TAG=3.0.30   # match your release
docker pull ghcr.io/bbartling/openfdd-bridge:${OPENFDD_IMAGE_TAG}
docker pull ghcr.io/bbartling/openfdd-commission:${OPENFDD_IMAGE_TAG}
docker pull ghcr.io/bbartling/openfdd-mcp-rag:${OPENFDD_IMAGE_TAG}

Edge bootstrap: Run with Docker images.

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
from open_fdd.arrow_runtime import run_arrow_rule

code = '''
import pyarrow.compute as pc
def apply_faults_arrow(table, cfg, context=None):
    return pc.greater(table["SAT"], float(cfg["high"]))
'''
result = run_arrow_rule(code, pa.table({"SAT": [70.0, 90.0]}), {"high": 85})
print(result.true_count)
Need Use
Run FDD in your Python / cloud pipeline PyPI open-fdd
BACnet + UI + bridge on an edge host GHCR Docker images
Portfolio / MCP agent over Tailscale Docker stack + portfolio docs

Examples: examples/. Release: developer/release-process.


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.0.34.tar.gz (54.8 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.0.34-py3-none-any.whl (61.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: open_fdd-3.0.34.tar.gz
  • Upload date:
  • Size: 54.8 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.0.34.tar.gz
Algorithm Hash digest
SHA256 8b326693e38eb6bc8380427e7067880bc821e13e421af4e441f71750f0ce9673
MD5 73c555a727c51c9f878ac0eb2c9df828
BLAKE2b-256 0891001930e0fff3048a7a53dd777a884c166a7155772fc967ac22aa49818131

See more details on using hashes here.

Provenance

The following attestation bundles were made for open_fdd-3.0.34.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.0.34-py3-none-any.whl.

File metadata

  • Download URL: open_fdd-3.0.34-py3-none-any.whl
  • Upload date:
  • Size: 61.9 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.0.34-py3-none-any.whl
Algorithm Hash digest
SHA256 3d65d99487cea56c5b9717237e70eaf6b89127ac720708abf3ebffd3ec65e7fc
MD5 7a31f85c62a1bc18701f6446ae00d95c
BLAKE2b-256 88e44447c02740785cb515521701f06ebf4128f1b2ceb176e1a61582119b04a3

See more details on using hashes here.

Provenance

The following attestation bundles were made for open_fdd-3.0.34-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