ebus-panel-sim 0.3.0__py3-none-any.whl

ebus_panel_sim/wire/catalogs/info.json

@@ -0,0 +1,52 @@
+{
+  "$schema": "https://ebus.energy/schemas/property-catalog.json",
+  "schema_version": "property-schema-v1",
+  "kind": "capability-catalog",
+  "capability": "energy.ebus.capability.info",
+  "version": "0.2",
+  "status": "DRAFT",
+  "date": "2026-07-30",
+  "properties": {
+    "vendor-name": {
+      "datatype": "string",
+      "req": "SHOULD",
+      "description": "Manufacturer name (e.g., \"SPAN\", \"Tesla\", \"Rheem\")."
+    },
+    "serial-number": {
+      "datatype": "string",
+      "req": "SHOULD",
+      "description": "Device serial number."
+    },
+    "model": {
+      "datatype": "string",
+      "req": "SHOULD",
+      "description": "The human-facing model or product designation, the name a person recognizes (e.g., `Powerwall 3`, `IQ Battery 5P`, or a configuration code such as `MAIN_32`). This is the display designation, not the orderable part code (that is `part-number`). The valid set is publisher-defined and MAY be advertised via Homie `$format` on the property."
+    },
+    "part-number": {
+      "datatype": "string",
+      "req": "MAY",
+      "description": "The vendor's orderable part or SKU code (e.g., Tesla `1232100-00-E`): the specific hardware variant beneath `model`, finer-grained so distinct part numbers (packaging, regional, or minor-revision variants) can share one `model`. A publisher that has both a coded identifier and a human-facing name publishes the code here and the designation in `model`, not a separate product-name property."
+    },
+    "hardware-version": {
+      "datatype": "string",
+      "req": "MAY",
+      "description": "Hardware revision."
+    },
+    "firmware-version": {
+      "datatype": "string",
+      "req": "SHOULD",
+      "description": "Firmware version. Published when the device has firmware; a bare or surveyed device (e.g., a dumb load center) omits it."
+    },
+    "data-model-version": {
+      "datatype": "string",
+      "req": "SHOULD",
+      "description": "Version of the eBus data model this device publishes (e.g., `\"1.0\"`)."
+    },
+    "nameplate-capacity": {
+      "datatype": "float",
+      "unit": "energy",
+      "req": "MAY",
+      "description": "Rated nameplate energy capacity, a term of art for energy-storage devices, reported in the device's native energy unit (a BESS in kWh electrical, a storage water heater in Wh thermal) via `$unit`. It is the static manufacturer rating: `soc` is roughly `soe` / `nameplate-capacity`, while the precise, dynamic denominator is `soc`'s `total-energy-storage` (which diverges from the nameplate figure as the reservoir degrades). Energy-storage device types (BESS, thermal storage) SHOULD publish it; power-rated devices (PV, inverter, EVSE) publish rated power via `nominal-power` instead."
+    }
+  }
+}

ebus_panel_sim/wire/catalogs/load-shed.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://ebus.energy/schemas/property-catalog.json",
+  "schema_version": "property-schema-v1",
+  "kind": "capability-catalog",
+  "capability": "energy.ebus.capability.load-shed",
+  "version": "0.3",
+  "status": "DRAFT",
+  "date": "2026-07-30",
+  "properties": {
+    "priority": {
+      "datatype": "enum",
+      "format": "UNKNOWN,NEVER,OFF_GRID,SOC_THRESHOLD",
+      "settable": true,
+      "req": "SHOULD",
+      "description": "The circuit's shedding class. Baseline (every host): `UNKNOWN`, `NEVER`, `OFF_GRID`. Optional additional triggers are advertised in the property's `$format`: `SOC_THRESHOLD` and future spec- or vendor-defined values."
+    }
+  }
+}

ebus_panel_sim/wire/catalogs/meter.json

@@ -0,0 +1,201 @@
+{
+  "$schema": "https://ebus.energy/schemas/property-catalog.json",
+  "schema_version": "property-schema-v1",
+  "kind": "capability-catalog",
+  "capability": "energy.ebus.capability.meter",
+  "version": "0.2",
+  "status": "DRAFT",
+  "date": "2026-07-31",
+  "properties": {
+    "active-power": {
+      "datatype": "float",
+      "unit": "W",
+      "req": "MAY",
+      "description": "Total active power. Sign per the reference-direction rule below."
+    },
+    "reactive-power": {
+      "datatype": "float",
+      "unit": "var",
+      "req": "MAY",
+      "description": "Total reactive power."
+    },
+    "apparent-power": {
+      "datatype": "float",
+      "unit": "VA",
+      "req": "MAY",
+      "description": "Total apparent power."
+    },
+    "power-factor": {
+      "datatype": "float",
+      "format": "-1.0:1.0",
+      "req": "MAY",
+      "description": "System power factor, signed: positive = lagging (inductive), negative = leading (capacitive); range `[-1.0, 1.0]`."
+    },
+    "frequency": {
+      "datatype": "float",
+      "unit": "Hz",
+      "req": "MAY",
+      "description": "Line frequency."
+    },
+    "voltage": {
+      "datatype": "float",
+      "unit": "V",
+      "req": "MAY",
+      "description": "RMS voltage at a single-point meter (one measured conductor, e.g. a branch circuit or a device's single AC boundary). A split-phase or three-phase meter uses the per-conductor `voltage-{a,b,c}` instead."
+    },
+    "current": {
+      "datatype": "float",
+      "unit": "A",
+      "req": "MAY",
+      "description": "RMS current at a single-point meter (one measured conductor). A split-phase or three-phase meter uses the per-conductor `current-{a,b,c,n}` instead."
+    },
+    "imported-energy": {
+      "datatype": "float",
+      "unit": "Wh",
+      "req": "MAY",
+      "description": "Cumulative active energy imported: the energy counterpart of positive `active-power` (into the metered device / consumption in the default frame; which register accrues follows the reference-direction rule below). Monotonically non-decreasing."
+    },
+    "exported-energy": {
+      "datatype": "float",
+      "unit": "Wh",
+      "req": "MAY",
+      "description": "Cumulative active energy exported: the energy counterpart of negative `active-power` (out of the metered device / production or backfeed in the default frame; which register accrues follows the reference-direction rule below). Monotonically non-decreasing."
+    },
+    "imported-reactive-energy": {
+      "datatype": "float",
+      "unit": "varh",
+      "req": "MAY",
+      "description": "Cumulative reactive energy imported."
+    },
+    "exported-reactive-energy": {
+      "datatype": "float",
+      "unit": "varh",
+      "req": "MAY",
+      "description": "Cumulative reactive energy exported."
+    },
+    "apparent-energy-imported": {
+      "datatype": "float",
+      "unit": "VAh",
+      "req": "MAY",
+      "description": "Cumulative apparent energy imported."
+    },
+    "apparent-energy-exported": {
+      "datatype": "float",
+      "unit": "VAh",
+      "req": "MAY",
+      "description": "Cumulative apparent energy exported."
+    }
+  },
+  "property_patterns": {
+    "voltage-{a,b,c}": {
+      "datatype": "float",
+      "unit": "V",
+      "req": "MAY",
+      "description": "RMS voltage on the named phase, line-to-neutral (or line-to-virtual-neutral on a delta service).",
+      "expand": [
+        "a",
+        "b",
+        "c"
+      ]
+    },
+    "current-{a,b,c,n}": {
+      "datatype": "float",
+      "unit": "A",
+      "req": "MAY",
+      "description": "RMS current on the named conductor. Neutral current (`current-n`) may be measured or imputed.",
+      "expand": [
+        "a",
+        "b",
+        "c",
+        "n"
+      ]
+    },
+    "active-power-{a,b,c}": {
+      "datatype": "float",
+      "unit": "W",
+      "req": "MAY",
+      "description": "Per-phase active power. Sign matches the system `active-power`.",
+      "expand": [
+        "a",
+        "b",
+        "c"
+      ]
+    },
+    "reactive-power-{a,b,c}": {
+      "datatype": "float",
+      "unit": "var",
+      "req": "MAY",
+      "description": "Per-phase reactive power.",
+      "expand": [
+        "a",
+        "b",
+        "c"
+      ]
+    },
+    "apparent-power-{a,b,c}": {
+      "datatype": "float",
+      "unit": "VA",
+      "req": "MAY",
+      "description": "Per-phase apparent power.",
+      "expand": [
+        "a",
+        "b",
+        "c"
+      ]
+    },
+    "power-factor-{a,b,c}": {
+      "datatype": "float",
+      "req": "MAY",
+      "description": "Per-phase power factor, signed as for the system value.",
+      "expand": [
+        "a",
+        "b",
+        "c"
+      ]
+    },
+    "voltage-angle-{a,b,c}": {
+      "datatype": "float",
+      "unit": "°",
+      "req": "MAY",
+      "description": "Voltage angle relative to phase-A voltage (`voltage-angle-a` = `0`).",
+      "expand": [
+        "a",
+        "b",
+        "c"
+      ]
+    },
+    "current-angle-{a,b,c}": {
+      "datatype": "float",
+      "unit": "°",
+      "req": "MAY",
+      "description": "Current angle relative to the same-phase voltage.",
+      "expand": [
+        "a",
+        "b",
+        "c"
+      ]
+    },
+    "imported-energy-{a,b,c}": {
+      "datatype": "float",
+      "unit": "Wh",
+      "req": "MAY",
+      "description": "Per-conductor cumulative imported energy.",
+      "expand": [
+        "a",
+        "b",
+        "c"
+      ]
+    },
+    "exported-energy-{a,b,c}": {
+      "datatype": "float",
+      "unit": "Wh",
+      "req": "MAY",
+      "description": "Per-conductor cumulative exported energy.",
+      "expand": [
+        "a",
+        "b",
+        "c"
+      ]
+    }
+  }
+}

ebus_panel_sim/wire/catalogs/pcs.json

@@ -0,0 +1,111 @@
+{
+  "$schema": "https://ebus.energy/schemas/property-catalog.json",
+  "schema_version": "property-schema-v1",
+  "kind": "capability-catalog",
+  "capability": "energy.ebus.capability.pcs",
+  "version": "0.3",
+  "status": "DRAFT",
+  "date": "2026-07-14",
+  "properties": {
+    "enabled": {
+      "datatype": "boolean",
+      "req": "SHOULD",
+      "description": "Is the PCS enabled on this enclosure?"
+    },
+    "active": {
+      "datatype": "boolean",
+      "req": "SHOULD",
+      "description": "Is the PCS actively limiting import right now?"
+    },
+    "import-limit": {
+      "datatype": "float",
+      "unit": "A",
+      "req": "SHOULD",
+      "description": "The **effective** enforced import limit: the `min()` across all active constraints reconciled to amps (the amps-native limits below, plus the reconciled `doe` and `voltage-response`)."
+    },
+    "binding-constraint": {
+      "datatype": "enum",
+      "format": "FSR,DOE,VOLTAGE,OFF_GRID,REQUESTED,OPERATOR,NONE,UNKNOWN",
+      "req": "SHOULD",
+      "description": "Which constraint class currently sets `import-limit`: `FSR`, `DOE`, `VOLTAGE`, `OFF_GRID`, `REQUESTED`, `OPERATOR`, `NONE`, `UNKNOWN`. The provenance of the enforced limit; publishers MAY extend via `$format` (see the note on vendor-specific sources below)."
+    },
+    "feed-import-limit": {
+      "datatype": "float",
+      "unit": "A",
+      "req": "SHOULD",
+      "description": "The **FSR**: commissioned firm feed / service capacity (premises-equipment protection), set at install. The always-on floor. May be less than the main-breaker rating when the upstream feed conductor is smaller (e.g. a 200 A panel on a 100 A service feed publishes `feed-import-limit = 100`)."
+    },
+    "feed-import-limit-enablement": {
+      "datatype": "enum",
+      "format": "UNSPECIFIED,UNCONFIGURED,DISABLED,ENABLED",
+      "req": "SHOULD",
+      "description": "`UNSPECIFIED`, `UNCONFIGURED`, `DISABLED`, `ENABLED`."
+    },
+    "feed-import-limit-active": {
+      "datatype": "boolean",
+      "req": "SHOULD",
+      "description": "Is this constraint currently enforcing (enabled **and** its activation conditions met)? Distinct from `binding-constraint`: several constraints may be active at once, but only the most restrictive is binding."
+    },
+    "off-grid-import-limit": {
+      "datatype": "float",
+      "unit": "A",
+      "req": "MAY",
+      "description": "Import cap when islanded (from BESS / DER)."
+    },
+    "off-grid-import-limit-enablement": {
+      "datatype": "enum",
+      "format": "UNSPECIFIED,UNCONFIGURED,DISABLED,ENABLED",
+      "req": "MAY",
+      "description": "Same domain."
+    },
+    "off-grid-import-limit-active": {
+      "datatype": "boolean",
+      "req": "MAY",
+      "description": "Typically active only while islanded. See `feed-import-limit-active`."
+    },
+    "requested-import-limit": {
+      "datatype": "float",
+      "unit": "A",
+      "req": "MAY",
+      "description": "A **voluntary**, self-imposed temporary limit requested by the homeowner or installer (e.g. via a mobile app). Self-revocable. Distinct from an externally imposed operator cap (`operator-import-limit`) and from the utility grid envelope (`doe`)."
+    },
+    "requested-import-limit-enablement": {
+      "datatype": "enum",
+      "format": "UNSPECIFIED,UNCONFIGURED,DISABLED,ENABLED",
+      "req": "MAY",
+      "description": "Same domain."
+    },
+    "requested-import-limit-active": {
+      "datatype": "boolean",
+      "req": "MAY",
+      "description": "See `feed-import-limit-active`."
+    },
+    "operator-import-limit": {
+      "datatype": "float",
+      "unit": "A",
+      "req": "MAY",
+      "description": "An **externally imposed** cap set by a fleet / aggregator operator over a management API (a DER aggregator, VPP, or utility program acting through the vendor's fleet REST interface). Persists until the operator changes or clears it. Distinct from `requested-import-limit` (self-imposed) and from `doe` (the standardized IEEE 2030.5 / CSIP watts envelope): `operator-import-limit` is a vendor-API amps cap, not a CSIP DOE."
+    },
+    "operator-import-limit-enablement": {
+      "datatype": "enum",
+      "format": "UNSPECIFIED,UNCONFIGURED,DISABLED,ENABLED",
+      "req": "MAY",
+      "description": "Same domain."
+    },
+    "operator-import-limit-active": {
+      "datatype": "boolean",
+      "req": "MAY",
+      "description": "See `feed-import-limit-active`."
+    },
+    "managed": {
+      "datatype": "boolean",
+      "req": "MAY",
+      "description": "Is this circuit managed by the host's PCS?"
+    },
+    "priority": {
+      "datatype": "integer",
+      "req": "MAY",
+      "description": "PCS priority ranking, consulted when an active import limit is binding (which circuits shed first)."
+    }
+  }
+}

ebus_panel_sim/wire/catalogs/power-flows.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "https://ebus.energy/schemas/property-catalog.json",
+  "schema_version": "property-schema-v1",
+  "kind": "capability-catalog",
+  "capability": "energy.ebus.capability.power-flows",
+  "version": "0.1",
+  "status": "DRAFT",
+  "date": "2026-07-11",
+  "properties": {
+    "grid": {
+      "datatype": "float",
+      "unit": "W",
+      "req": "SHOULD",
+      "description": "Grid power flow (positive = importing from grid)."
+    },
+    "battery": {
+      "datatype": "float",
+      "unit": "W",
+      "req": "SHOULD",
+      "description": "Battery power flow (positive = discharging)."
+    },
+    "pv": {
+      "datatype": "float",
+      "unit": "W",
+      "req": "SHOULD",
+      "description": "Solar PV power flow (positive = producing)."
+    },
+    "site": {
+      "datatype": "float",
+      "unit": "W",
+      "req": "SHOULD",
+      "description": "Total site power consumption."
+    }
+  }
+}

ebus_panel_sim/wire/catalogs/shed-forecast.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "https://ebus.energy/schemas/property-catalog.json",
+  "schema_version": "property-schema-v1",
+  "kind": "capability-catalog",
+  "capability": "energy.ebus.capability.shed-forecast",
+  "version": "0.1",
+  "status": "DRAFT",
+  "date": "2026-07-11",
+  "properties": {
+    "total-time-remaining": {
+      "datatype": "integer",
+      "unit": "min",
+      "req": "SHOULD",
+      "description": "At current state of energy, total time before all backed-up loads go unpowered."
+    },
+    "time-to-priority-shed": {
+      "datatype": "integer",
+      "unit": "min",
+      "req": "SHOULD",
+      "description": "At current state of energy, time until priority-shed (e.g. `SOC_THRESHOLD`) circuits are auto-shed."
+    },
+    "full-charge-total-time-remaining": {
+      "datatype": "integer",
+      "unit": "min",
+      "req": "SHOULD",
+      "description": "At 100% state of energy, total backup-duration capability."
+    },
+    "full-charge-time-to-priority-shed": {
+      "datatype": "integer",
+      "unit": "min",
+      "req": "SHOULD",
+      "description": "At 100% state of energy, capability time until the priority-shed event."
+    },
+    "confidence": {
+      "datatype": "enum",
+      "format": "LOW,MEDIUM,HIGH",
+      "req": "SHOULD",
+      "description": "The algorithm's self-assessed confidence: `LOW`, `MEDIUM`, `HIGH`. Reflects accumulated usage history."
+    }
+  }
+}

ebus_panel_sim/wire/catalogs/shed.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://ebus.energy/schemas/property-catalog.json",
+  "schema_version": "property-schema-v1",
+  "kind": "capability-catalog",
+  "capability": "energy.ebus.capability.shed",
+  "version": "0.2",
+  "status": "DRAFT",
+  "date": "2026-07-30",
+  "properties": {
+    "asserted-islanding-state": {
+      "datatype": "enum",
+      "format": "NONE,ON_GRID,OFF_GRID",
+      "settable": true,
+      "req": "MAY",
+      "description": "Consumer-asserted islanding-state for the host's own island scope, consulted only while the host has lost or degraded communication with the device that senses that state (its MID / BESS). Advertised in `$format` as `NONE`, `ON_GRID`, `OFF_GRID` (default `NONE`). See \"Asserted islanding-state\" below."
+    },
+    "policy": {
+      "datatype": "json",
+      "settable": true,
+      "req": "MAY",
+      "description": "The host's shedding algorithm and its parameters: `{ \"algorithm\": <id>, \"parameters\": { … } }`. The parameter object's shape is advertised as a JSON Schema in the property's `$format`. See \"Shed policy\" below."
+    }
+  }
+}

ebus_panel_sim/wire/catalogs/soc.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "https://ebus.energy/schemas/property-catalog.json",
+  "schema_version": "property-schema-v1",
+  "kind": "capability-catalog",
+  "capability": "energy.ebus.capability.soc",
+  "version": "0.1",
+  "status": "DRAFT",
+  "date": "2026-07-11",
+  "properties": {
+    "soc": {
+      "datatype": "float",
+      "unit": "%",
+      "req": "MAY",
+      "description": "State of charge: the fraction of capacity currently held (`0` = empty, `100` = full). A dimensionless ratio, comparable across all reservoirs."
+    },
+    "soe": {
+      "datatype": "float",
+      "unit": "energy",
+      "req": "MAY",
+      "description": "State of energy: the energy currently stored and available to draw (the discharge side). Reported in the device's native energy unit (a BESS in kWh electrical, a water heater in Wh thermal)."
+    },
+    "total-energy-storage": {
+      "datatype": "float",
+      "unit": "energy",
+      "req": "MAY",
+      "description": "The reservoir's total energy capacity (empty to full), in the same unit as `soe`."
+    },
+    "loadup-headroom": {
+      "datatype": "float",
+      "unit": "energy",
+      "req": "MAY",
+      "description": "The energy the reservoir can absorb **now** (the charge side), approximately `total-energy-storage − soe`. The dispatchable charge a load-up / charge action can take on."
+    }
+  }
+}

ebus_panel_sim/wire/catalogs/status.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://ebus.energy/schemas/property-catalog.json",
+  "schema_version": "property-schema-v1",
+  "kind": "capability-catalog",
+  "capability": "energy.ebus.capability.status",
+  "version": "0.1",
+  "status": "DRAFT",
+  "date": "2026-07-11",
+  "properties": {
+    "fault-state": {
+      "datatype": "enum",
+      "format": "OK,FAULT,UNKNOWN",
+      "req": "MAY",
+      "description": "Overall fault state: `OK`, `FAULT`, `UNKNOWN`. Publishers MAY extend the value set via `$format` for device-specific fault categories."
+    },
+    "communication-state": {
+      "datatype": "enum",
+      "format": "OK,DEGRADED,LOST,UNKNOWN",
+      "req": "MAY",
+      "description": "The publisher's view of its own communication / link health, to the device it represents (for a proxy) or to its backhaul (for a native device): `OK`, `DEGRADED`, `LOST`, `UNKNOWN`. Orthogonal to whether the eBus publisher is currently reporting to *its* consumers."
+    },
+    "active-alerts": {
+      "datatype": "string",
+      "req": "MAY",
+      "description": "Human-readable current alert(s), when the device exposes them."
+    }
+  }
+}

ebus_panel_sim/wire/catalogs/switch.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "https://ebus.energy/schemas/property-catalog.json",
+  "schema_version": "property-schema-v1",
+  "kind": "capability-catalog",
+  "capability": "energy.ebus.capability.switch",
+  "version": "0.1",
+  "status": "DRAFT",
+  "date": "2026-07-05",
+  "properties": {
+    "relay": {
+      "datatype": "enum",
+      "format": "OPEN,CLOSED,UNKNOWN",
+      "settable": true,
+      "req": "MUST",
+      "description": "Relay state: `OPEN`, `CLOSED`, `UNKNOWN`. Settable when `relay-controllable = true`."
+    },
+    "relay-controllable": {
+      "datatype": "boolean",
+      "req": "SHOULD",
+      "description": "True = the relay can be opened and closed by command or automatic shed. False = locked (for example a circuit commissioned as permanently on)."
+    },
+    "relay-requester": {
+      "datatype": "enum",
+      "format": "USER,LOAD_SHED,PCS,CONFIGURATION,FAULT,NONE,UNKNOWN",
+      "req": "SHOULD",
+      "description": "Source attribution for the last relay change: `USER`, `LOAD_SHED`, `PCS`, `CONFIGURATION`, `FAULT`, `NONE`, `UNKNOWN`. Publishers MAY extend via `$format`."
+    }
+  }
+}