open-energymesh-offline-fir.../README.md

1.5 KiB

Open-EnergyMesh Offline-First MVP (Node.js)

This repository provides a minimal Open-EnergyMesh scaffold focused on an offline-first, distributed microgrid orchestration flow. It implements a small in-memory data model (Device, Inverter, Meter, DER, PriceQuote, Forecast) and a lightweight EnergyMesh orchestrator with a simple energy-flow calculation. It also includes a placeholder ADMM-like solver to demonstrate how a compositional optimization layer can be integrated on top of the runtime.

What you get in this MVP:

  • Core data model for energy devices and components
  • Basic energy-flow computation: generation minus consumption
  • A lightweight ADMM-lite adapter surface (solver_admm.js)
  • Delta-sync helper and an API surface to apply per-device deltas
  • Simple tests that exercise computeFlow, delta-sync, and ADMM integration
  • Lightweight, well-scoped scaffolding suitable for MVP testing and iteration

Usage

  • Install dependencies: npm install
  • Run tests: npm test
  • The repository exports Open-EnergyMesh primitives via src/mesh.js for extension.

Roadmap (high level)

  • Finalize a 0.2 core protocol and two starter adapters
  • Implement an ADMM-lite local solver with offline/partially-connected rounds (delta-sync)
  • Add privacy-preserving options and governance hooks
  • Provide a small reference adapter SDK and HIL testbed

This project is designed to be extended incrementally. See AGENTS.md for architectural rules and contribution guidelines.

Commit messages follow a concise rationale-focused style suitable for collaborative reviews.