meshviz-studio-decentralize.../AGENTS.md

1.4 KiB

MeshViz Studio - Agent Architecture

Overview

  • Decentralized, offline-first real-time visualization layer built on CRDTs.
  • Delta-sync driven sharing to minimize bandwidth while preserving historical fidelity.
  • Registry-based data contracts to enable cross-organization dashboard sharing without raw data exposure.
  • Pluggable adapters marketplace for heterogeneous protocols (MQTT, CoAP, OPC UA, REST).
  • Privacy-preserving visuals with on-device aggregation and role-based access hints.
  • Web dashboard with offline capability (PWA) and WebGL rendering groundwork.
  • Provenance and governance logging for dashboards and data contracts.
  • Extensible plugin system for new widgets and data sources.

Architecture (high level)

  • Core: DeltaCRDT (time-series deltas per device) with merge/export interfaces.
  • API: FastAPI-based endpoints to push deltas, merge remote state, and retrieve current state.
  • Contracts: Registry in JSON describing datasets, privacy flags, and widget schemas.
  • Adapters: Marketplace stub with dynamic loading; MQTT adapter example included.
  • UI: Placeholder; backend is designed to be consumed by a web frontend (not implemented here).

How to run tests locally

  • Install dependencies (pytest, fastapi, httpx, etc.).
  • Run tests: ./test.sh
  • Packaging check: python3 -m build

Testing commands

  • pytest tests/
  • python3 -m build

Contributing

  • This repo uses a minimal, production-ready scaffold. Follow the file structure and tests.