span-panel-api-schema-0 1.1.0__tar.gz → 1.1.2__tar.gz

{span_panel_api_schema_0-1.1.0 → span_panel_api_schema_0-1.1.2}/.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.0 → span_panel_api_schema_0-1.1.2}/CHANGELOG.md

@@ -9,6 +9,22 @@ 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.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.
+
+### Removed
+
+- **`denormalize_circuit_id`, which nothing called** — it restored the dashes a circuit's UUID is stripped of on the way in, a form no snapshot, command topic or consumer has ever asked for.
+
 ## [1.1.0]
 
 Requires `span-panel-api` **3.1.0 or newer**, and the two must be upgraded together in both directions: this wheel is rejected at discovery by a 3.0.x bootstrap, and a 1.0.0 wheel is rejected by 3.1.0.

{span_panel_api_schema_0-1.1.0 → span_panel_api_schema_0-1.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: span-panel-api-schema-0
-Version: 1.1.0
+Version: 1.1.2
 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

{span_panel_api_schema_0-1.1.0 → span_panel_api_schema_0-1.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "span-panel-api-schema-0"
-version = "1.1.0"
+version = "1.1.2"
 description = "Flat-schema (data-model-version absent) parser for span-panel-api"
 authors = [
     {name = "SpanPanel"}

{span_panel_api_schema_0-1.1.0 → span_panel_api_schema_0-1.1.2}/src/span_panel_api_schema_0/const.py

@@ -74,10 +74,3 @@ LUGS_DOWNSTREAM = "DOWNSTREAM"
 def normalize_circuit_id(node_id: str) -> str:
     """Strip dashes from Homie UUID for entity stability."""
     return node_id.replace("-", "")
-
-
-def denormalize_circuit_id(circuit_id: str) -> str:
-    """Restore dashes to a 32-char dashless UUID (8-4-4-4-12 format)."""
-    if len(circuit_id) == 32 and "-" not in circuit_id:
-        return f"{circuit_id[:8]}-{circuit_id[8:12]}-{circuit_id[12:16]}-{circuit_id[16:20]}-{circuit_id[20:]}"
-    return circuit_id

span_panel_api_schema_0-1.1.2/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"
+}