envoy-schema 2.2.0__tar.gz → 2.3.1__tar.gz

{envoy_schema-2.2.0/src/envoy_schema.egg-info → envoy_schema-2.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: envoy_schema
-Version: 2.2.0
+Version: 2.3.1
 Summary: Envoy Schema - a collection of pydantic models compatible with the Envoy utility server
 Author: Battery Storage and Grid Integration Program
 License: The MIT License (MIT)
@@ -55,6 +55,8 @@ Requires-Dist: types-lxml; extra == "dev"
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: assertical; extra == "test"
+Provides-Extra: build
+Requires-Dist: twine; extra == "build"
 Dynamic: license-file
 
 # envoy-schema

{envoy_schema-2.2.0 → envoy_schema-2.3.1}/pyproject.toml

@@ -34,7 +34,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "envoy_schema"
-version = "2.2.0"
+version = "2.3.1"
 description = "Envoy Schema - a collection of pydantic models compatible with the Envoy utility server"
 authors = [{ name = "Battery Storage and Grid Integration Program" }]
 readme = "README.md"
@@ -71,6 +71,7 @@ Homepage = "https://github.com/bsgip/envoy-schema"
 all = ["envoy_schema[dev, test]"]
 dev = ["bandit", "ruff", "ty", "types-python-dateutil", "types-tzlocal", "types-lxml"]
 test = ["pytest", "assertical"]
+build = ["twine"]
 
 [tool.setuptools.package-data]
 "envoy_schema" = ["py.typed"]

{envoy_schema-2.2.0 → envoy_schema-2.3.1}/src/envoy_schema/admin/schema/pricing.py

@@ -25,6 +25,9 @@ class TariffRequest(BaseModel):
     price_power_of_ten_multiplier: int
     primacy: int
     fsa_id: int = 1  # The function set assignment ID that this Tariff will be grouped under
+    required_site_group_id: Optional[int] = (
+        None  # If set - only sites in this SiteGroup will "see" this Tariff. Globally visible otherwise
+    )
 
 
 class TariffResponse(TariffRequest):
@@ -63,11 +66,11 @@ class TariffComponentResponse(TariffComponentRequest):
 
 
 class TariffGeneratedRateRequest(BaseModel):
-    """Time of use tariff pricing - represents a price for a specific site for a specific range of time as defined
+    """Time of use tariff pricing - represents a price for a specific site group for a specific range of time as defined
     by the parent TariffComponent."""
 
     tariff_component_id: int  # The TariffComponent ID that this price entry sits underneath
-    site_id: int
+    site_group_id: int  # The SiteGroup id whose members will have this price available to them
     calculation_log_id: Optional[int]  # The ID of the CalculationLog that created this rate (or NULL if no link)
     start_time: datetime
     duration_seconds: int

{envoy_schema-2.2.0 → envoy_schema-2.3.1}/src/envoy_schema/admin/schema/site_control.py

@@ -9,7 +9,7 @@ class SiteControlRequest(BaseModel):
     """Used for encoding a "SiteControl" which can represent things like a Dynamic Operating Envelope, Setpoint or
     other form of control"""
 
-    site_id: int  # Corresponds to EndDevice id - the site that this control is targeting
+    site_group_id: int  # Corresponds to SiteGroup id - the members of this SiteGroup are targeted by this control
     calculation_log_id: Optional[int]  # The ID of the CalculationLog that created this control (or NULL if no link)
     duration_seconds: int
     start_time: datetime
@@ -70,6 +70,9 @@ class SiteControlGroupRequest(BaseModel):
     display_id: Optional[int] = (
         None  # If set - seed the auto generated MRID with this value. equal display_id means equal mrid
     )
+    required_site_group_id: Optional[int] = (
+        None  # If set - only sites in this SiteGroup will "see" this SiteControlGroup. Globally visible otherwise
+    )
 
 
 class SiteControlGroupResponse(SiteControlGroupRequest):

{envoy_schema-2.2.0 → envoy_schema-2.3.1}/src/envoy_schema/server/schema/uri.py

@@ -9,13 +9,19 @@ ConnectionPointUri = "/edev/{site_id}/cp"
 # Sep2 URIs
 AccountBalanceUri = "/ppy/{id1}/ab"
 ActiveBillingPeriodListUri = "/bill/{id1}/ca/{id2}/actbp"
-ActiveCreditRegisterListUri = ""  # noqa: E501. There is NO ActiveCreditRegisterList resource in Sep2 despite an ActiveCreditRegisterListLink being defined.
+ActiveCreditRegisterListUri = (
+    ""  # There is NO ActiveCreditRegisterList resource in Sep2 despite an ActiveCreditRegisterListLink being defined.
+)
 ActiveDERControlListUri = "/edev/{site_id}/derp/{der_program_id}/actderc"
 ActiveEndDeviceControlListUri = "/dr/{id1}/actedc"
-ActiveFlowReservationListUri = ""  # noqa: E501. There is NO ActiveFlowReservationList resource in Sep2 despite an ActiveFlowReservationListLink being defined.
-ActiveProjectionReadingListUri = ""  # noqa: E501. There is NO ActiveProjectionReadingList in resource Sep2 despite an ActiveProjectionReadingListLink being defined.
+ActiveFlowReservationListUri = (
+    ""  # There is NO ActiveFlowReservationList resource in Sep2 despite an ActiveFlowReservationListLink being defined.
+)
+ActiveProjectionReadingListUri = ""  # There is NO ActiveProjectionReadingList in resource Sep2
 ActiveSupplyInterruptionOverrideListUri = "/ppy/{id1}/actsi"
-ActiveTargetReadingListUri = ""  # noqa: E501. There is NO ActiveTargetReadingList resource in Sep2 despite an ActiveTargetReadingListLink being defined.
+ActiveTargetReadingListUri = (
+    ""  # There is NO ActiveTargetReadingList resource in Sep2 despite an ActiveTargetReadingListLink being defined.
+)
 ActiveTextMessageListUri = "/msg/{id1}/acttxt"
 ActiveTimeTariffIntervalListUri = "/tp/{id1}/rc/{id2}/acttti"
 AssociatedDERProgramListUri = "/edev/{site_id}/der/{der_id}/derp"

{envoy_schema-2.2.0 → envoy_schema-2.3.1/src/envoy_schema.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: envoy_schema
-Version: 2.2.0
+Version: 2.3.1
 Summary: Envoy Schema - a collection of pydantic models compatible with the Envoy utility server
 Author: Battery Storage and Grid Integration Program
 License: The MIT License (MIT)
@@ -55,6 +55,8 @@ Requires-Dist: types-lxml; extra == "dev"
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: assertical; extra == "test"
+Provides-Extra: build
+Requires-Dist: twine; extra == "build"
 Dynamic: license-file
 
 # envoy-schema

{envoy_schema-2.2.0 → envoy_schema-2.3.1}/src/envoy_schema.egg-info/requires.txt

@@ -4,6 +4,9 @@ pydantic_xml[lxml]>=2.12.0
 [all]
 envoy_schema[dev,test]
 
+[build]
+twine
+
 [dev]
 bandit
 ruff