span-panel-api-schema-0 1.1.1__tar.gz → 1.2.0__tar.gz

{span_panel_api_schema_0-1.1.1 → span_panel_api_schema_0-1.2.0}/.gitignore

@@ -40,8 +40,3 @@ coverage_output.log
 # of which belongs in a repository. The differential that reads them commits its
 # *verdict* only, never the capture, and skips when the file is absent.
 tests/fixtures/live_*.json
-
-# Peer checkouts. CI clones the eBus specification and SpanPanel/panelbench here so
-# the provenance checks have something to compare vendored bytes against; the same
-# layout works locally if you would rather not point .env at siblings.
-/peers/

{span_panel_api_schema_0-1.1.1 → span_panel_api_schema_0-1.2.0}/CHANGELOG.md

@@ -9,6 +9,23 @@ rather than by this version number. A release here means this parser changed, ne
 
 Pre-releases are not listed separately. A beta is a step towards the next public version, so its changes are folded into that version's entry as they land and are described against the last public release, never against the beta before it.
 
+## [1.2.0]
+
+The panel's one inverter is reported through `pv_inverters` as well as `pv`. Requires `span-panel-api` **3.6.0 or newer**.
+
+### Added
+
+- **`pv_inverters` holds the panel's one inverter** under the key `span-panel-api-schema-1` gives it, so a consumer can read every panel through that field.
+- **`pv.device_id` and `pv.node_id`** give the inverter's flat node id and its `pv_inverters` key.
+
+## [1.1.2]
+
+The reference schema document this parser is tested against now ships in the wheel.
+
+### Added
+
+- **`span_panel_api_schema_0/reference/homie_schema.json`** — the captured `GET /api/v2/homie/schema` response, shipped as package data so a downstream test suite reads the bytes its pinned version was tested against instead of vendoring a copy.
+
 ## [1.1.1]
 
 Still requires `span-panel-api` **3.1.0 or newer**, unchanged.

{span_panel_api_schema_0-1.1.1 → span_panel_api_schema_0-1.2.0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.5
 Name: span-panel-api-schema-0
-Version: 1.1.1
+Version: 1.2.0
 Summary: Flat-schema (data-model-version absent) parser for span-panel-api
 Project-URL: Homepage, https://github.com/SpanPanel/span-panel-api
 Project-URL: Issues, https://github.com/SpanPanel/span-panel-api/issues
 Author: SpanPanel
 License-Expression: MIT
 Requires-Python: <4.0,>=3.14
-Requires-Dist: span-panel-api<4.0,>=3.1.0
+Requires-Dist: span-panel-api<4.0,>=3.6.0
 Description-Content-Type: text/markdown
 
 # span-panel-api-schema-0

{span_panel_api_schema_0-1.1.1 → span_panel_api_schema_0-1.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "span-panel-api-schema-0"
-version = "1.1.1"
+version = "1.2.0"
 description = "Flat-schema (data-model-version absent) parser for span-panel-api"
 authors = [
     {name = "SpanPanel"}
@@ -16,7 +16,10 @@ dependencies = [
     # for `set_*_target` instead of `set_*_topic`. Against 3.0.x this wheel is
     # rejected at discovery for carrying names that bootstrap does not require —
     # so the floor moves with the rename rather than trailing it.
-    "span-panel-api>=3.1.0,<4.0",
+    # Raised to 3.6.0, the first bootstrap whose snapshot carries `pv_inverters`
+    # and the inverter's `device_id` and `node_id`, which this parser fills.
+    # Against an earlier one, building a snapshot fails on those arguments.
+    "span-panel-api>=3.6.0,<4.0",
 ]
 
 [project.urls]

{span_panel_api_schema_0-1.1.1 → span_panel_api_schema_0-1.2.0}/src/span_panel_api_schema_0/consumer.py

@@ -423,13 +423,18 @@ class HomieDeviceConsumer:
         feed = self._acc.get_prop(pv_node, "feed")
         rel_pos = self._acc.get_prop(pv_node, "relative-position")
 
+        feed_circuit_id = normalize_circuit_id(feed) if feed else None
         return SpanPVSnapshot(
             vendor_name=vn if vn else None,
             model=pn if pn else None,
             software_version=sw if sw else None,
             nameplate_capacity_w=_parse_float(nc) if nc else None,
-            feed_circuit_id=normalize_circuit_id(feed) if feed else None,
+            feed_circuit_id=feed_circuit_id,
             relative_position=rel_pos.upper() if rel_pos else None,
+            device_id=pv_node,
+            # The same key schema_1 gives this inverter, so a consumer's handle
+            # for it survives the panel's upgrade to the parent/child schema.
+            node_id=feed_circuit_id or pv_node,
         )
 
     def _build_evse_devices(self) -> dict[str, SpanEvseSnapshot]:
@@ -726,5 +731,8 @@ class HomieDeviceConsumer:
             circuits=circuits,
             battery=battery,
             pv=pv,
+            # Flat publishes one inverter at most, so this is `pv` again, keyed
+            # as schema_1 keys each of its inverters.
+            pv_inverters={pv.node_id: pv} if pv.node_id is not None else {},
             evse=evse,
         )

span_panel_api_schema_0-1.2.0/src/span_panel_api_schema_0/reference/homie_schema.json

@@ -0,0 +1,420 @@
+{
+    "firmwareVersion": "spanos2/r202603/05",
+    "homieDomain": "ebus",
+    "homieVersion": 5,
+    "types": {
+        "energy.ebus.device.distribution-enclosure.core": {
+            "vendor-name": {
+                "name": "Vendor name",
+                "datatype": "string"
+            },
+            "serial-number": {
+                "name": "Serial number",
+                "datatype": "string"
+            },
+            "hardware-version": {
+                "name": "Hardware version",
+                "datatype": "string"
+            },
+            "software-version": {
+                "name": "Software version",
+                "datatype": "string"
+            },
+            "door": {
+                "name": "Door state",
+                "datatype": "enum",
+                "format": "UNKNOWN,OPEN,CLOSED"
+            },
+            "grid-islandable": {
+                "name": "Capable of operating with power while disconnected from the grid",
+                "datatype": "boolean"
+            },
+            "dominant-power-source": {
+                "name": "Current dominant power source, load-shedding trigger",
+                "datatype": "enum",
+                "format": "GRID,BATTERY,PV,GENERATOR,NONE,UNKNOWN",
+                "settable": true
+            },
+            "relay": {
+                "name": "Main relay",
+                "datatype": "enum",
+                "format": "UNKNOWN,OPEN,CLOSED"
+            },
+            "l1-voltage": {
+                "name": "L1 voltage",
+                "datatype": "float",
+                "unit": "V"
+            },
+            "l2-voltage": {
+                "name": "L2 voltage",
+                "datatype": "float",
+                "unit": "V"
+            },
+            "breaker-rating": {
+                "name": "Main breaker rating",
+                "datatype": "integer",
+                "unit": "A"
+            },
+            "ethernet": {
+                "name": "Is Ethernet network interface operational?",
+                "datatype": "boolean"
+            },
+            "wifi": {
+                "name": "Is Wi-Fi network interface operational?",
+                "datatype": "boolean"
+            },
+            "wifi-ssid": {
+                "name": "SSID to which Wi-Fi network interface is connected",
+                "datatype": "string"
+            },
+            "vendor-cloud": {
+                "name": "Device connected to vendor cloud?",
+                "datatype": "enum",
+                "format": "UNKNOWN,UNCONNECTED,CONNECTED"
+            },
+            "postal-code": {
+                "name": "Postal (Zip) code",
+                "datatype": "string"
+            },
+            "time-zone": {
+                "name": "Time zone",
+                "datatype": "string"
+            }
+        },
+        "energy.ebus.device.lugs": {
+            "direction": {
+                "name": "Lugs feed direction: upstream or downstream",
+                "datatype": "enum",
+                "format": "UPSTREAM,DOWNSTREAM"
+            },
+            "feed": {
+                "name": "Device the lugs are connected to, if known",
+                "datatype": "string"
+            },
+            "l1-current": {
+                "name": "L1 current",
+                "datatype": "float",
+                "unit": "A"
+            },
+            "l2-current": {
+                "name": "L2 current",
+                "datatype": "float",
+                "unit": "A"
+            },
+            "active-power": {
+                "name": "Active power",
+                "datatype": "float",
+                "unit": "W"
+            },
+            "imported-energy": {
+                "name": "Imported energy",
+                "datatype": "float",
+                "unit": "Wh"
+            },
+            "exported-energy": {
+                "name": "Exported energy",
+                "datatype": "float",
+                "unit": "Wh"
+            }
+        },
+        "energy.ebus.device.circuit": {
+            "name": {
+                "name": "Circuit name",
+                "datatype": "string"
+            },
+            "relay": {
+                "name": "Circuit relay state",
+                "datatype": "enum",
+                "format": "UNKNOWN,OPEN,CLOSED",
+                "settable": true
+            },
+            "relay-requester": {
+                "name": "Actor requesting the relay state",
+                "datatype": "enum",
+                "format": "UNKNOWN,NONE,BACKUP,USER,PCS,PCS_FAIL_SAFE,ALWAYS_ON,NEVER_BACKUP,INVERTER,FAULT"
+            },
+            "breaker-rating": {
+                "name": "Circuit breaker rating",
+                "datatype": "integer",
+                "unit": "A"
+            },
+            "current": {
+                "name": "Measured current",
+                "datatype": "float",
+                "unit": "A"
+            },
+            "active-power": {
+                "name": "Measured active power",
+                "datatype": "float",
+                "unit": "kW"
+            },
+            "imported-energy": {
+                "name": "Measured energy imported",
+                "datatype": "float",
+                "unit": "Wh"
+            },
+            "exported-energy": {
+                "name": "Measured energy exported",
+                "datatype": "float",
+                "unit": "Wh"
+            },
+            "space": {
+                "name": "Circuit breaker space number within load center",
+                "datatype": "integer",
+                "format": "1:32:1"
+            },
+            "dipole": {
+                "name": "Does circuit land on a two-pole breaker?",
+                "datatype": "boolean"
+            },
+            "shed-priority": {
+                "name": "Configured priority of circuit shedding when off-grid (dominant-power-source != GRID)",
+                "datatype": "enum",
+                "format": "UNKNOWN,OFF_GRID,SOC_THRESHOLD,NEVER",
+                "settable": true
+            },
+            "pcs-managed": {
+                "name": "Is circuit managed by PCS?",
+                "datatype": "boolean"
+            },
+            "pcs-priority": {
+                "name": "Circuit PCS priority ranking",
+                "datatype": "integer"
+            },
+            "sheddable": {
+                "name": "Is circuit configured to be sheddable?",
+                "datatype": "boolean"
+            },
+            "never-backup": {
+                "name": "Is circuit configured to be never-backup?",
+                "datatype": "boolean"
+            },
+            "always-on": {
+                "name": "Is circuit configured to be always on?",
+                "datatype": "boolean"
+            }
+        },
+        "energy.ebus.device.bess": {
+            "vendor-name": {
+                "name": "Vendor name",
+                "datatype": "string"
+            },
+            "product-name": {
+                "name": "Product name",
+                "datatype": "string"
+            },
+            "model": {
+                "name": "Model",
+                "datatype": "string"
+            },
+            "serial-number": {
+                "name": "Serial number",
+                "datatype": "string"
+            },
+            "software-version": {
+                "name": "Software version",
+                "datatype": "string"
+            },
+            "nameplate-capacity": {
+                "name": "Nameplate capacity",
+                "datatype": "float",
+                "unit": "kWh"
+            },
+            "relative-position": {
+                "name": "Relative position of the commissioned backup system WRT the distribution enclosure",
+                "datatype": "enum",
+                "format": "UPSTREAM,DOWNSTREAM,IN_PANEL"
+            },
+            "feed": {
+                "name": "Circuit ID upon which the commissioned backup system is landed",
+                "datatype": "enum"
+            },
+            "soc": {
+                "name": "State of charge",
+                "datatype": "float",
+                "unit": "%"
+            },
+            "soe": {
+                "name": "State of energy",
+                "datatype": "float",
+                "unit": "kWh"
+            },
+            "connected": {
+                "name": "Connected to backup system?",
+                "datatype": "boolean"
+            },
+            "grid-state": {
+                "name": "Grid connection state",
+                "datatype": "enum",
+                "format": "UNKNOWN,ON_GRID,OFF_GRID"
+            }
+        },
+        "energy.ebus.device.pv": {
+            "vendor-name": {
+                "name": "Vendor name",
+                "datatype": "string"
+            },
+            "product-name": {
+                "name": "Product name",
+                "datatype": "string"
+            },
+            "serial-number": {
+                "name": "Serial number",
+                "datatype": "string"
+            },
+            "software-version": {
+                "name": "Software version",
+                "datatype": "string"
+            },
+            "nameplate-capacity": {
+                "name": "Nameplate capacity",
+                "datatype": "float",
+                "unit": "W"
+            },
+            "relative-position": {
+                "name": "Relative position of the commissioned PV system WRT the distribution enclosure",
+                "datatype": "enum",
+                "format": "UPSTREAM,DOWNSTREAM,IN_PANEL"
+            },
+            "feed": {
+                "name": "Circuit ID upon which the commissioned PV system is landed",
+                "datatype": "enum"
+            }
+        },
+        "energy.ebus.device.evse": {
+            "vendor-name": {
+                "name": "Vendor name",
+                "datatype": "string"
+            },
+            "product-name": {
+                "name": "Product name",
+                "datatype": "string"
+            },
+            "part-number": {
+                "name": "Part number",
+                "datatype": "string"
+            },
+            "serial-number": {
+                "name": "Serial number",
+                "datatype": "string"
+            },
+            "software-version": {
+                "name": "Software version",
+                "datatype": "string"
+            },
+            "feed": {
+                "name": "Circuit ID upon which the commissioned EVSE is landed",
+                "datatype": "enum"
+            },
+            "lock-state": {
+                "name": "Lock state",
+                "datatype": "enum",
+                "format": "UNKNOWN,LOCKED,UNLOCKED"
+            },
+            "status": {
+                "name": "Status",
+                "datatype": "enum",
+                "format": "UNKNOWN,AVAILABLE,PREPARING,CHARGING,SUSPENDED_EV,SUSPENDED_EVSE,FINISHING,RESERVED,FAULTED,UNAVAILABLE"
+            },
+            "advertised-current": {
+                "name": "Current EVSE is advertising to the EV",
+                "datatype": "float",
+                "unit": "A"
+            }
+        },
+        "energy.ebus.device.pcs": {
+            "enabled": {
+                "name": "PCS system enabled",
+                "datatype": "boolean"
+            },
+            "active": {
+                "name": "PCS system actively controlling one (or more) loads",
+                "datatype": "boolean"
+            },
+            "import-limit": {
+                "name": "The power import limit currently being managed to",
+                "datatype": "float",
+                "unit": "A"
+            },
+            "feed-import-limit": {
+                "name": "Limit of maximum power feeding the distribution enclosure",
+                "datatype": "float",
+                "unit": "A"
+            },
+            "feed-import-limit-enablement": {
+                "name": "Enablement status of the feed-import-limit",
+                "datatype": "enum",
+                "format": "UNSPECIFIED,UNCONFIGURED,DISABLED,ENABLED"
+            },
+            "feed-import-limit-active": {
+                "name": "Is feed-import-limit currently being enforced?",
+                "datatype": "boolean"
+            },
+            "grid-import-limit": {
+                "name": "Grid limit maximum import power",
+                "datatype": "float",
+                "unit": "A"
+            },
+            "grid-import-limit-enablement": {
+                "name": "Enablement status of the grid-import-limit",
+                "datatype": "enum",
+                "format": "UNSPECIFIED,UNCONFIGURED,DISABLED,ENABLED"
+            },
+            "grid-import-limit-active": {
+                "name": "Is grid-import-limit currently being enforced?",
+                "datatype": "boolean"
+            },
+            "off-grid-import-limit": {
+                "name": "Off-Grid limit maximum import power",
+                "datatype": "float",
+                "unit": "A"
+            },
+            "off-grid-import-limit-enablement": {
+                "name": "Enablement status of the off-grid-import-limit",
+                "datatype": "enum",
+                "format": "UNSPECIFIED,UNCONFIGURED,DISABLED,ENABLED"
+            },
+            "off-grid-import-limit-active": {
+                "name": "Is off-grid-import-limit currently being enforced?",
+                "datatype": "boolean"
+            },
+            "requested-import-limit": {
+                "name": "Requested limit maximum import power",
+                "datatype": "float",
+                "unit": "A"
+            },
+            "requested-import-limit-enablement": {
+                "name": "Enablement status of the requested-import-limit",
+                "datatype": "enum",
+                "format": "UNSPECIFIED,UNCONFIGURED,DISABLED,ENABLED"
+            },
+            "requested-import-limit-active": {
+                "name": "Is requested-import-limit currently being enforced?",
+                "datatype": "boolean"
+            }
+        },
+        "energy.ebus.device.power-flows": {
+            "pv": {
+                "name": "PV power flow",
+                "datatype": "float",
+                "unit": "W"
+            },
+            "battery": {
+                "name": "Battery/BESS power flow",
+                "datatype": "float",
+                "unit": "W"
+            },
+            "grid": {
+                "name": "Grid power flow",
+                "datatype": "float",
+                "unit": "W"
+            },
+            "site": {
+                "name": "Site power flow",
+                "datatype": "float",
+                "unit": "W"
+            }
+        }
+    },
+    "typesSchemaHash": "sha256:d347556a07d98f40"
+}