gridresilience-studio-offli.../docs/contract_sketch.md

1.0 KiB

Toy Contract Sketch: LocalDevicePlan / SharedSignals / PlanDelta

This document outlines a minimal, self-contained contract sketch to bootstrap interoperability between GridResilience primitives and cross-domain adapters.

  • LocalDevicePlan (Object): Represents a DER/load/pump with id, kind, and properties.
  • SharedSignals (Morphism): Represents telemetry/policy signals between two devices, with a version for consistency.
  • PlanDelta: Incremental islanding and load-shedding updates, with an optional cryptographic tag for integrity.
  • Example payload shapes (JSON-like):

Object example: { "id": "DER1", "type": "DER", "properties": {"rated_kW": 500} }

Morphism example: { "id": "SIG1", "source": "DER1", "target": "LOAD1", "signals": {"voltage": 1.02}, "version": 1 }

PlanDelta example: { "delta_id": "D1", "islanded": true, "actions": [{"type": "island", "target": "LOAD1"}], "tags": {"sig": "v1"} }

This sketch is intentionally lightweight and is meant to guide adapter implementations and API design. It is not a full specification.