splight-lib 5.19.6__tar.gz → 5.19.7.dev0__tar.gz

{splight_lib-5.19.6 → splight_lib-5.19.7.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: splight-lib
-Version: 5.19.6
+Version: 5.19.7.dev0
 Summary: Splight Library
 Author: Splight Dev
 Author-email: dev@splight-ae.com

{splight_lib-5.19.6 → splight_lib-5.19.7.dev0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "splight-lib"
-version = "5.19.6"
+version = "5.19.7.dev0"
 description = "Splight Library"
 authors = [
     {name = "Splight Dev",email = "dev@splight-ae.com"}

{splight_lib-5.19.6 → splight_lib-5.19.7.dev0}/splight_lib/client/database/classmap.py

@@ -9,6 +9,7 @@ MODEL_NAME_MAP = {
     "tag": f"{ENGINE_PREFIX}/tags/",
     "assetkind": f"{ENGINE_PREFIX}/asset/kinds/",
     "attribute": f"{ENGINE_PREFIX}/asset/attributes/",
+    "battery": f"{ENGINE_PREFIX}/asset/batteries/",
     "bus": f"{ENGINE_PREFIX}/asset/buses/",
     "metadata": f"{ENGINE_PREFIX}/metadata/",
     "chart": f"{ENGINE_PREFIX}/dashboard/charts/",

{splight_lib-5.19.6 → splight_lib-5.19.7.dev0}/splight_lib/models/__init__.py

@@ -164,42 +164,24 @@ if api_version == SplightAPIVersion.V3:
 elif api_version == SplightAPIVersion.V4:
     from splight_lib.models._v4 import (
         DB_MODEL_TYPE_MAPPING,
-        AdvancedFilter,
-        Alert,
-        AlertItem,
         Asset,
         AssetKind,
         AssetRelationship,
         Attribute,
         AttributeType,
+        Battery,
         Boolean,
         Bus,
-        Chart,
-        ChartItem,
         Component,
         ComponentObject,
         ComponentObjectInstance,
         ComponentType,
         CustomType,
-        Dashboard,
-        DashboardAlertEventsChart,
-        DashboardAlertListChart,
-        DashboardAssetListChart,
-        DashboardBarChart,
-        DashboardBarGaugeChart,
-        DashboardGaugeChart,
-        DashboardHistogramChart,
-        DashboardImageChart,
-        DashboardStatChart,
-        DashboardTableChart,
-        DashboardTextChart,
-        DashboardTimeseriesChart,
         DataAddress,
         DataRequest,
         Endpoint,
         ExternalGrid,
         File,
-        Filter,
         Generator,
         Grid,
         HubComponent,
@@ -225,7 +207,6 @@ elif api_version == SplightAPIVersion.V4:
         SlackLine,
         SplightDatalakeBaseModel,
         String,
-        Tab,
         Tag,
         Trace,
         Transformer,
@@ -234,8 +215,6 @@ elif api_version == SplightAPIVersion.V4:
     )
 
     __all__ = [
-        "Alert",
-        "AlertItem",
         "Asset",
         "AssetRelationship",
         "Component",
@@ -254,25 +233,7 @@ elif api_version == SplightAPIVersion.V4:
         "get_field_value",
         "Parameter",
         "DB_MODEL_TYPE_MAPPING",
-        "AdvancedFilter",
         "SplightDatalakeBaseModel",
-        "Chart",
-        "ChartItem",
-        "Dashboard",
-        "DashboardAlertEventsChart",
-        "DashboardAlertListChart",
-        "DashboardAssetListChart",
-        "DashboardBarChart",
-        "DashboardBarGaugeChart",
-        "DashboardGaugeChart",
-        "DashboardHistogramChart",
-        "DashboardImageChart",
-        "DashboardStatChart",
-        "DashboardTableChart",
-        "DashboardTextChart",
-        "DashboardTimeseriesChart",
-        "Filter",
-        "Tab",
         "DataRequest",
         "PipelineStep",
         "Trace",
@@ -293,6 +254,7 @@ elif api_version == SplightAPIVersion.V4:
         "AssetKind",
         "ValueType",
         "AttributeType",
+        "Battery",
         "Bus",
         "ExternalGrid",
         "Generator",

{splight_lib-5.19.6 → splight_lib-5.19.7.dev0}/splight_lib/models/_v4/__init__.py

@@ -1,4 +1,3 @@
-from splight_lib.models._v4.alert import Alert, AlertItem
 from splight_lib.models._v4.asset import Asset, AssetKind, AssetRelationship
 from splight_lib.models._v4.attribute import Attribute
 from splight_lib.models._v4.base import (
@@ -6,6 +5,7 @@ from splight_lib.models._v4.base import (
     ResourceSummary,
     ValueType,
 )
+from splight_lib.models._v4.battery import Battery
 from splight_lib.models._v4.bus import Bus
 from splight_lib.models._v4.component import (
     DB_MODEL_TYPE_MAPPING,
@@ -26,26 +26,6 @@ from splight_lib.models._v4.component import (
     RoutineObjectInstance,
     get_field_value,
 )
-from splight_lib.models._v4.dashboard import (
-    AdvancedFilter,
-    Chart,
-    ChartItem,
-    Dashboard,
-    DashboardAlertEventsChart,
-    DashboardAlertListChart,
-    DashboardAssetListChart,
-    DashboardBarChart,
-    DashboardBarGaugeChart,
-    DashboardGaugeChart,
-    DashboardHistogramChart,
-    DashboardImageChart,
-    DashboardStatChart,
-    DashboardTableChart,
-    DashboardTextChart,
-    DashboardTimeseriesChart,
-    Filter,
-    Tab,
-)
 from splight_lib.models._v4.data_address import DataAddresses as DataAddress
 from splight_lib.models._v4.datalake import DataRequest, PipelineStep, Trace
 from splight_lib.models._v4.datalake_base import SplightDatalakeBaseModel
@@ -74,8 +54,6 @@ if api_settings.API_VERSION != SplightAPIVersion.V4:
 
 
 __all__ = [
-    "Alert",
-    "AlertItem",
     "Asset",
     "AssetRelationship",
     "Component",
@@ -95,24 +73,6 @@ __all__ = [
     "get_field_value",
     "Parameter",
     "DB_MODEL_TYPE_MAPPING",
-    "AdvancedFilter",
-    "Chart",
-    "ChartItem",
-    "Dashboard",
-    "DashboardAlertEventsChart",
-    "DashboardAlertListChart",
-    "DashboardAssetListChart",
-    "DashboardBarChart",
-    "DashboardBarGaugeChart",
-    "DashboardGaugeChart",
-    "DashboardHistogramChart",
-    "DashboardImageChart",
-    "DashboardStatChart",
-    "DashboardTableChart",
-    "DashboardTextChart",
-    "DashboardTimeseriesChart",
-    "Filter",
-    "Tab",
     "DataRequest",
     "DataAddress",
     "InputDataAddress",
@@ -133,6 +93,7 @@ __all__ = [
     "AssetKind",
     "ValueType",
     "AttributeType",
+    "Battery",
     "Bus",
     "ExternalGrid",
     "Generator",

splight_lib-5.19.7.dev0/splight_lib/models/_v4/battery.py

@@ -0,0 +1,31 @@
+from splight_lib.models._v4.asset import AssetParams, AssetRelationship
+from splight_lib.models._v4.attribute import Attribute
+from splight_lib.models._v4.metadata import Metadata
+from splight_lib.models.database import SplightDatabaseBaseModel
+
+
+class Battery(AssetParams, SplightDatabaseBaseModel):
+    # Input Attributes
+    active_power: Attribute | None = None
+    reactive_power: Attribute | None = None
+    state_of_charge: Attribute | None = None
+
+    # Computed Attributes
+    completed_cycles: Attribute | None = None
+    daily_ideal_revenue: Attribute | None = None
+    daily_revenue: Attribute | None = None
+    forecasted_charge_48H: Attribute | None = None
+    forecasted_daily_revenue_48H: Attribute | None = None
+    hourly_revenue: Attribute | None = None
+    trade_action: Attribute | None = None
+
+    # Metadata
+    capacity: Metadata | None = None
+    charge_speed: Metadata | None = None
+    cycles_per_market: Metadata | None = None
+    discharge_speed: Metadata | None = None
+    market_init: Metadata | None = None
+
+    # Relationships
+    bus: AssetRelationship | None = None
+    grid: AssetRelationship | None = None

{splight_lib-5.19.6 → splight_lib-5.19.7.dev0}/splight_lib/models/_v4/bus.py

@@ -10,14 +10,17 @@ class Bus(AssetParams, SplightDatabaseBaseModel):
     reactive_power: Attribute | None = None
 
     # Computed attributes
-    temperature: Attribute | None = None
-    wind_speed: Attribute | None = None
-    wind_direction: Attribute | None = None
-    irradiance: Attribute | None = None
+    energy_price: Attribute | None = None
+    energy_price_forecast: Attribute | None = None
     forecasted_temperature_48H: Attribute | None = None
     forecasted_wind_speed_48H: Attribute | None = None
+    irradiance: Attribute | None = None
+    temperature: Attribute | None = None
+    wind_direction: Attribute | None = None
+    wind_speed: Attribute | None = None
 
     # Metadata
+    bus_id: Metadata | None = None
     nominal_voltage: Metadata | None = None
 
     # Relationships

{splight_lib-5.19.6 → splight_lib-5.19.7.dev0}/splight_lib/models/_v4/exceptions.py

@@ -31,14 +31,6 @@ class MissingFunctionItemExpression(Exception):
     pass
 
 
-class InvalidAlertConfiguration(Exception):
-    pass
-
-
-class MissingAlertItemExpression(Exception):
-    pass
-
-
 class ForbiddenOperation(Exception):
     pass
 

{splight_lib-5.19.6 → splight_lib-5.19.7.dev0}/splight_lib/models/_v4/generator.py

@@ -19,20 +19,24 @@ class Generator(AssetParams, SplightDatabaseBaseModel):
     daily_curtail_power: Attribute | None = None
     daily_emissions_avoided: Attribute | None = None
     daily_energy: Attribute | None = None
+    daily_revenue_loss: Attribute | None = None
     forecasted_active_power: Attribute | None = None
     forecasted_available_active_power: Attribute | None = None
     forecasted_curtailment: Attribute | None = None
     forecasted_energy: Attribute | None = None
+    forecasted_hourly_revenue_loss_48H: Attribute | None = None
+    hourly_revenue_loss: Attribute | None = None
     injection_price: Attribute | None = None
+    market_induced_curtailment: Attribute | None = None
     monthly_curtail_energy: Attribute | None = None
     monthly_curtail_power: Attribute | None = None
     monthly_energy: Attribute | None = None
     regulation_setpoint: Attribute | None = None
 
     # Metadata
-    max_active_power: Metadata | None = None
     co2_intensity_per_kwh: Metadata | None = None
     installed_power: Metadata | None = None
+    max_active_power: Metadata | None = None
 
     # Relationships
     bus: AssetRelationship | None = None

{splight_lib-5.19.6 → splight_lib-5.19.7.dev0}/splight_lib/models/_v4/line.py

@@ -6,22 +6,22 @@ from splight_lib.models.database import SplightDatabaseBaseModel
 
 class Line(AssetParams, SplightDatabaseBaseModel):
     # Input attributes
-    active_power_start: Attribute | None = None
     active_power_end: Attribute | None = None
+    active_power_start: Attribute | None = None
     contingency: Attribute | None = None
-    current_r_start: Attribute | None = None
     current_r_end: Attribute | None = None
-    current_s_start: Attribute | None = None
+    current_r_start: Attribute | None = None
     current_s_end: Attribute | None = None
-    current_t_start: Attribute | None = None
+    current_s_start: Attribute | None = None
     current_t_end: Attribute | None = None
+    current_t_start: Attribute | None = None
     frequency: Attribute | None = None
-    reactive_power_start: Attribute | None = None
     reactive_power_end: Attribute | None = None
-    switch_status_start: Attribute | None = None
+    reactive_power_start: Attribute | None = None
     switch_status_end: Attribute | None = None
-    voltage_start: Attribute | None = None
+    switch_status_start: Attribute | None = None
     voltage_end: Attribute | None = None
+    voltage_start: Attribute | None = None
 
     # Computed attributes
     ampacity_aar: Attribute | None = None
@@ -31,14 +31,22 @@ class Line(AssetParams, SplightDatabaseBaseModel):
     ampacity_dlr_lte: Attribute | None = None
     ampacity_dlr_ste: Attribute | None = None
     contingency_solving_time: Attribute | None = None
-    forecasted_ampacity_aar: Attribute | None = None
-    forecasted_ampacity_dlr: Attribute | None = None
-    generators_output_vector: Attribute | None = None
-    historical_generators_output_vector: Attribute | None = None
-    loads_output_vector: Attribute | None = None
-    historical_loads_output_vector: Attribute | None = None
+    dlr_irradiance: Attribute | None = None
+    dlr_temperature: Attribute | None = None
+    dlr_wind_direction: Attribute | None = None
+    dlr_wind_speed: Attribute | None = None
+    forecasted_ampacity_aar_240H: Attribute | None = None
+    forecasted_ampacity_aar_48H: Attribute | None = None
+    forecasted_ampacity_aar_72H: Attribute | None = None
+    forecasted_ampacity_dlr_240H: Attribute | None = None
+    forecasted_ampacity_dlr_48H: Attribute | None = None
+    forecasted_ampacity_dlr_72H: Attribute | None = None
+    generators_vector: Attribute | None = None
     historical_segment_aar_vector: Attribute | None = None
     historical_segment_dlr_vector: Attribute | None = None
+    historical_generators_vector: Attribute | None = None
+    loads_vector: Attribute | None = None
+    historical_loads_vector: Attribute | None = None
     max_conductor_temp: Attribute | None = None
     max_temperature_segment_dlr: Attribute | None = None
     min_amp_segment_aar: Attribute | None = None

splight_lib-5.19.6/splight_lib/models/_v4/alert.py

@@ -1,283 +0,0 @@
-import json
-import re
-from enum import Enum, auto
-from typing import Annotated, Literal
-
-from pydantic import (
-    BaseModel,
-    Field,
-    PositiveInt,
-    ValidationError,
-    model_validator,
-)
-from strenum import LowercaseStrEnum, UppercaseStrEnum
-from typing_extensions import TypedDict
-
-from splight_lib.models._v4.exceptions import (
-    InvalidAlertConfiguration,
-    MissingAlertItemExpression,
-)
-from splight_lib.models.database import (
-    ResourceSummary,
-    SplightDatabaseBaseModel,
-)
-
-
-class AlertItemType(UppercaseStrEnum):
-    EXPRESSION = auto()
-    QUERY = auto()
-
-
-class QueryFilter(TypedDict):
-    id: str
-    name: str
-
-
-class GroupUnit(LowercaseStrEnum):
-    EMPTY = ""
-    SECOND = auto()
-    MINUTE = auto()
-    HOUR = auto()
-    DAY = auto()
-
-
-class GroupCriteria(LowercaseStrEnum):
-    EMPTY = ""
-    AVG = auto()
-    SUM = auto()
-    MIN = auto()
-    MAX = auto()
-    LAST = auto()
-
-
-class AlertItem(BaseModel):
-    id: Annotated[str | None, Field(max_length=100)]
-
-    ref_id: Annotated[str, Field(max_length=5)]
-    type: AlertItemType = AlertItemType.QUERY
-    label: str | None = None
-
-    expression: str | None = None
-    expression_plain: str | None = ""
-
-    query_filter_asset: QueryFilter | None = None
-    query_filter_attribute: QueryFilter | None = None
-    query_filter_metadata: QueryFilter | None = None
-
-    query_group_function: GroupCriteria | None = None
-    query_group_unit: GroupUnit | None = None
-
-    query_sort_field: str | None = None
-    query_sort_direction: Annotated[int | None, Field(-1, ge=-1, le=1)]
-
-    query_plain: str | None = ""
-    query_limit: Annotated[int, Field(10000, ge=1, le=10000)]
-
-    @model_validator(mode="after")
-    def validate_expression(self):
-        if self.type == AlertItemType.EXPRESSION:
-            if self.expression is None:
-                raise MissingAlertItemExpression(
-                    "Parameter 'expression' is required for expression type alert items"
-                )
-            self.expression_plain = (
-                self._get_expression_plain()
-                if self.expression_plain is None
-                else self.expression_plain
-            )
-        return self
-
-    @model_validator(mode="after")
-    def validate_query(self):
-        if self.type == AlertItemType.QUERY:
-            for attr in [
-                ("query_filter_asset", self.query_filter_asset),
-                ("query_filter_attribute", self.query_filter_attribute),
-            ]:
-                if attr is None:
-                    raise ValidationError(
-                        (
-                            f"Parameter '{attr}' is required for query type "
-                            "alert items"
-                        )
-                    )
-            self.query_plain = (
-                self._get_query_plain()
-                if self.query_plain is None
-                else self.query_plain
-            )
-        return self
-
-    def _get_expression_plain(self):
-        pattern = r"\$\w+"
-        args = re.findall(pattern, self.expression)
-        str_args = ", ".join(args)
-        body = f"function ({str_args}) {{ return {self.expression} }}"
-        expression_plain = {
-            "$function": {"body": body, "args": args, "lang": "js"}
-        }
-        return json.dumps(expression_plain)
-
-    def _get_query_plain(self):
-        query_plain = [
-            {
-                "$match": {
-                    "asset": self.query_filter_asset["id"],
-                    "attribute": self.query_filter_attribute["id"],
-                }
-            },
-        ]
-        if self.query_group_unit and self.query_group_function:
-            query_plain.extend(
-                [
-                    {
-                        "$addFields": {
-                            "timestamp": {
-                                "$dateTrunc": {
-                                    "date": "$timestamp",
-                                    "unit": self.query_group_unit,
-                                    "binSize": 1,
-                                }
-                            }
-                        }
-                    },
-                    {
-                        "$group": {
-                            "_id": "$timestamp",
-                            "value": {
-                                f"${self.query_group_function}": "$value"
-                            },
-                            "timestamp": {"$last": "$timestamp"},
-                        }
-                    },
-                ]
-            )
-        return json.dumps(query_plain)
-
-
-class AlertStatus(LowercaseStrEnum):
-    ALERT = auto()
-    NO_ALERT = auto()
-    NO_DATA = auto()
-    TIMEOUT = auto()
-    DISABLED = auto()
-    MISCONFIGURED = auto()
-    ERROR = auto()
-    WARNING = auto()
-
-
-class AlertType(LowercaseStrEnum):
-    CRON = auto()
-    RATE = auto()
-
-
-class StatementOperator(str, Enum):
-    GREATER_THAN = "gt"
-    GREATER_THAN_OR_EQUAL = "ge"
-    LOWER_THAN = "lt"
-    LOWER_THAN_OR_EQUAL = "le"
-    EQUAL = "eq"
-
-
-class ThresholdStatus(LowercaseStrEnum):
-    ALERT = auto()
-    WARNING = auto()
-    NO_ALERT = auto()
-
-
-class AlertSeverity(LowercaseStrEnum):
-    SEV1 = auto()
-    SEV2 = auto()
-    SEV3 = auto()
-    SEV4 = auto()
-    SEV5 = auto()
-    SEV6 = auto()
-    SEV7 = auto()
-    SEV8 = auto()
-
-
-class AlertThreshold(BaseModel):
-    value: float
-    status: ThresholdStatus
-    status_text: str | None
-
-
-class StatementAggregation(LowercaseStrEnum):
-    AVG = auto()
-    LAST = auto()
-    MAX = auto()
-    MIN = auto()
-    SUM = auto()
-
-
-class Alert(SplightDatabaseBaseModel):
-    id: Annotated[str | None, Field(None, max_length=100)]
-    name: str
-    description: str | None = None
-
-    tags: list[ResourceSummary] | None = None
-    assets: list[QueryFilter] = []
-    alert_items: list[AlertItem] = []
-    destinations_list: list[str] = []
-
-    type: AlertType
-
-    active: bool = True
-    status: AlertStatus = AlertStatus.NO_ALERT
-    status_text: Annotated[str | None, Field(default=None, max_length=400)]
-
-    stmt_time_window: int
-    stmt_target_variable: Annotated[
-        str | None, Field(default=None, max_length=5)
-    ]
-    stmt_operator: StatementOperator
-    stmt_aggregation: StatementAggregation
-    stmt_thresholds: list[AlertThreshold]
-
-    notify_no_data: bool = True
-    notify_error: bool = True
-    notify_timeout: bool = True
-    custom_message: Annotated[str | None, Field(default=None, max_length=200)]
-
-    cron_minutes: str | None = None
-    cron_hours: str | None = None
-    cron_dom: str | None = None
-    cron_month: str | None = None
-    cron_dow: str | None = None
-    cron_year: str | None = None
-
-    rate_value: PositiveInt | None = None
-    rate_unit: Literal["day", "hour", "minute"] | None = None
-
-    @model_validator(mode="after")
-    def validate_type(self):
-        if self.type == "cron":
-            for attr, value in [
-                ("cron_year", self.cron_year),
-                ("cron_moth", self.cron_month),
-                ("cron_hour", self.cron_hours),
-                ("cron_minutes", self.cron_minutes),
-                ("cron_dow", self.cron_dow),
-                ("cron_dom", self.cron_dom),
-            ]:
-                if value is None:
-                    raise InvalidAlertConfiguration(
-                        (
-                            f"Parameter {attr} is required for '{self.type}' "
-                            "type alerts"
-                        )
-                    )
-        if self.type == "rate":
-            for attr in [
-                ("rate_value", self.rate_value),
-                ("rate_unit", self.rate_unit),
-            ]:
-                if attr is None:
-                    raise InvalidAlertConfiguration(
-                        (
-                            f"Parameter {attr} is required for '{self.type}' "
-                            "type alerts"
-                        )
-                    )
-
-        return self