switch-api 0.6.12__tar.gz → 0.6.14__tar.gz

{switch_api-0.6.12 → switch_api-0.6.14}/HISTORY.md

@@ -1,5 +1,21 @@
 # History
 
+#0.6.14
+### Modified
+In the `integration` module:
+- Updated `add_carbon_column()` to enforce priority selection of carbon calculation rules.
+- When overlapping date ranges exist for the same `ObjectPropertyId`, the rule with a non-null `ObjectPropertyTemplateID` is now preferred over the default (NULL) rule.
+- Ensured only one carbon calculation is applied per input row to prevent duplicate records.
+- Refactored logic to preserve original row count and avoid row loss during rule matching.
+
+#0.6.13
+### Added
+In the `controls` module
+- Add `submit_realtime_updates` method to support realtime updates for a single dataset
+- Subscribes to a single MQTT topic and retrieves retained message (if any)
+- Merges retained dataset with provided DataFrame using Id-based override and append logic
+- Publishes merged dataset back to the corresponding Realtime topic
+
 #0.6.12
 ### Modified
 In the `controls` module

{switch_api-0.6.12 → switch_api-0.6.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: switch_api
-Version: 0.6.12
+Version: 0.6.14
 Summary: A complete package for data ingestion into the Switch Automation Platform.
 Home-page: UNKNOWN
 Author: Switch Automation Pty Ltd.
@@ -38,6 +38,22 @@ pip install switch_api
 
 # History
 
+#0.6.14
+### Modified
+In the `integration` module:
+- Updated `add_carbon_column()` to enforce priority selection of carbon calculation rules.
+- When overlapping date ranges exist for the same `ObjectPropertyId`, the rule with a non-null `ObjectPropertyTemplateID` is now preferred over the default (NULL) rule.
+- Ensured only one carbon calculation is applied per input row to prevent duplicate records.
+- Refactored logic to preserve original row count and avoid row loss during rule matching.
+
+#0.6.13
+### Added
+In the `controls` module
+- Add `submit_realtime_updates` method to support realtime updates for a single dataset
+- Subscribes to a single MQTT topic and retrieves retained message (if any)
+- Merges retained dataset with provided DataFrame using Id-based override and append logic
+- Publishes merged dataset back to the corresponding Realtime topic
+
 #0.6.12
 ### Modified
 In the `controls` module

{switch_api-0.6.12 → switch_api-0.6.14}/setup.py

@@ -16,7 +16,7 @@ setup(
     long_description_content_type='text/markdown',
     license='MIT License',
     name="switch_api",
-    version="0.6.12",
+    version="0.6.14",
     packages=find_packages(include=["switch_api", "switch_api.*"]),
     install_requires=['pandas==1.5.3', 'requests', 'azure-storage-blob', 'pandera[io]==0.7.1', 'azure-servicebus',
                       'msal>=1.11.0', 'paho-mqtt==1.6.1', 'uvicorn==0.22.0', 'fastapi==0.98.0', 'pyodbc==4.0.39', 'cachetools==5.5.0', 

{switch_api-0.6.12 → switch_api-0.6.14}/switch_api/__init__.py

@@ -10,7 +10,7 @@ Data Ingestion into the Switch Automation
 Complete package for ingestion data into the Switch Automation Platform.
 """
 __all__ = ['dataset', 'analytics', 'pipeline', 'error_handlers', 'integration',
-           'initialize', 'cache', 'extensions', 'email', 'controls', '_compute', 'generate_filepath']
+           'initialize', 'cache', 'extensions', 'email', 'controls', 'realtime', '_compute', 'generate_filepath', 'set_mqtt_broker_config']
 
 from .initialize import initialize
 from . import dataset
@@ -23,8 +23,10 @@ from . import cache
 from . import extensions
 from . import email
 from . import controls
+from . import realtime
 from . import _compute
 from ._utils._utils import generate_filepath
+from ._utils._mqtt import set_mqtt_broker_config
 from . import _guide
 
 
@@ -40,4 +42,4 @@ from . import _guide
 # log.addHandler(_ch)
 # https://dev.to/joaomcteixeira/setting-up-python-logging-for-a-library-app-6ml
 
-__version__ = "0.6.12"
+__version__ = "0.6.14"

{switch_api-0.6.12 → switch_api-0.6.14}/switch_api/_utils/_constants.py

@@ -94,3 +94,9 @@ GUIDES_EXTERNAL_TYPES = Literal['SwitchGuides']
 GUIDES_SCOPE = Literal['Portfolio-wide']
 
 IMPORT_STATUS = Literal['New', 'ToImport', 'OnHold', 'Exclude', 'Edited', 'ToRemove']
+
+WS_DEFAULT_PORT = 443
+WS_MQTT_CONNECTION_TIMEOUT = 180
+WS_MQTT_DEFAULT_MAX_TIMEOUT = 180
+WS_MQTT_WAIT_TIME_INTERVAL = 0.1
+WS_MQTT_MESSAGE_WAIT_TIME_INTERVAL = 0.1

switch_api-0.6.14/switch_api/_utils/_mqtt.py

@@ -0,0 +1,124 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Switch Automation Pty Ltd.
+# Licensed under the MIT License.
+# -------------------------------------------------------------------------
+"""
+A module for mqtt related utils.
+"""
+
+from .._utils._constants import (
+    WS_DEFAULT_PORT,
+    WS_MQTT_DEFAULT_MAX_TIMEOUT,
+)
+
+global _control_api_endpoint
+global _control_ws_host
+global _control_ws_port
+global _control_ws_username
+global _control_ws_password
+global _control_ws_max_timeout
+
+_control_api_endpoint = ''
+_control_ws_host = ''
+_control_ws_port = WS_DEFAULT_PORT
+_control_ws_username = ''
+_control_ws_password = ''
+_control_ws_max_timeout = WS_MQTT_DEFAULT_MAX_TIMEOUT
+
+def get_control_config():
+    """
+    Retrieve Control MQTT Configuration
+
+    Returns the currently configured MQTT control variables used by the
+    controls module when communicating with the MQTT Broker.
+
+    These values are typically set via `set_control_variables()` during
+    local execution. In production environments, they may be populated
+    from deployment environment variables.
+
+    Returns
+    -------
+    dict
+        A dictionary containing the current control configuration:
+
+        - api_endpoint : str
+            Platform IoT API endpoint.
+        - ws_host : str
+            WebSocket MQTT host URL (wss://).
+        - ws_port : int
+            MQTT broker port.
+        - username : str
+            Username for MQTT authentication.
+        - password : str
+            Password for MQTT authentication.
+        - max_timeout : int
+            Maximum timeout (in seconds) for control operations.
+    """
+    return {
+        "api_endpoint": _control_api_endpoint,
+        "ws_host": _control_ws_host,
+        "ws_port": _control_ws_port,
+        "username": _control_ws_username,
+        "password": _control_ws_password,
+        "max_timeout": _control_ws_max_timeout,
+    }
+
+
+def set_mqtt_broker_config(api_endpoint: str, ws_host: str, user_name: str, password: str,
+                          ws_port: int = WS_DEFAULT_PORT, max_timeout: int = WS_MQTT_DEFAULT_MAX_TIMEOUT, bypass_username_password: bool = False):
+    """Set Control Variables
+
+    Set Control Variables needed to enable control request to MQTT Broker when running locally.
+
+    In Production, these are pulled from the deployment environment variables.
+
+    Parameters
+    ----------
+    api_endpoint : str
+        Platform IoT API Endpoint.
+    host : str
+        Host URL for MQTT connection. This needs to be datacenter specfic URL.
+    port : int
+        MQTT message broker port. Defaults to 443.
+    user_name : str
+        Username for MQTT connection
+    password: str
+        Password for MQTT connection
+    max_timeout : int
+        Max timeout set for the controls module. Defaults to 30 seconds.
+    """
+    global _control_api_endpoint
+    global _control_ws_host
+    global _control_ws_port
+    global _control_ws_username
+    global _control_ws_password
+    global _control_ws_max_timeout
+
+    # Check if endpoint is a valid URL
+    if not api_endpoint.startswith('https://'):
+        raise ValueError(
+            "Invalid IoT API Endpoint. The IoT host should start with 'https://'.")
+
+    # # Check if host is a valid URL
+    if not ws_host.startswith('wss://'):
+        raise ValueError(
+            "Invalid IoT Websocket MQTT Host. The IoT host should start with 'wss://'.")
+
+    # Check if user_name and password are not empty
+    if not bypass_username_password:
+        if not user_name:
+            raise ValueError("user_name cannot be empty.")
+        if not password:
+            raise ValueError("password cannot be empty.")
+
+    # Check if max_timeout is greated than 0
+    if max_timeout < 1:
+        raise ValueError("max_timeout should be greater than 0.")
+
+    # Set global variables
+    _control_api_endpoint = api_endpoint
+    _control_ws_host = ws_host
+    _control_ws_port = ws_port
+    _control_ws_username = user_name
+    _control_ws_password = password
+    _control_ws_max_timeout = max_timeout

{switch_api-0.6.12 → switch_api-0.6.14}/switch_api/controls/__init__.py

@@ -7,7 +7,6 @@
 A module for sending control request of sensors.
 """
 
-from .controls import submit_control, set_control_variables, submit_control_continue, add_control_component
+__all__ = ['submit_control', 'submit_control_continue', 'add_control_component']
 
-__all__ = ['submit_control', 'set_control_variables',
-           'submit_control_continue', 'add_control_component']
+from .controls import submit_control, submit_control_continue, add_control_component

{switch_api-0.6.12 → switch_api-0.6.14}/switch_api/controls/_constants.py

@@ -11,12 +11,6 @@ is not directly referenced by end users.
 IOT_RESPONSE_SUCCESS = 'success'
 IOT_RESPONSE_ERROR = 'error'
 
-WS_DEFAULT_PORT = 443
-WS_MQTT_CONNECTION_TIMEOUT = 180
-WS_MQTT_DEFAULT_MAX_TIMEOUT = 30
-WS_MQTT_WAIT_TIME_INTERVAL = 0.1
-WS_MQTT_MESSAGE_WAIT_TIME_INTERVAL = 0.1
-
 CONTROL_REQUEST_ACTION_ACK = 'control-request-ack'
 CONTROL_REQUEST_ACTION_RESULT = 'control-result'
 

{switch_api-0.6.12 → switch_api-0.6.14}/switch_api/controls/_mqtt.py

@@ -10,14 +10,13 @@ module is not directly referenced by end users.
 import json
 import logging
 import sys
-import time
 import threading
 from urllib.parse import urlparse
 import paho.mqtt.client as mqtt
 import pandas
 from paho.mqtt.client import MQTTMessage
-from ._constants import (CONTROL_REQUEST_ACTION_ACK, CONTROL_REQUEST_ACTION_RESULT, WS_DEFAULT_PORT,
-                         WS_MQTT_CONNECTION_TIMEOUT, WS_MQTT_WAIT_TIME_INTERVAL)
+from ._constants import (CONTROL_REQUEST_ACTION_ACK)
+from .._utils._constants import (WS_DEFAULT_PORT, WS_MQTT_CONNECTION_TIMEOUT)
 
 logger = logging.getLogger(__name__)
 logger.setLevel(logging.DEBUG)

{switch_api-0.6.12 → switch_api-0.6.14}/switch_api/controls/controls.py

@@ -9,51 +9,45 @@ A module for sending control request of sensors.
 
 import json
 import logging
-import os
 import sys
 import time
-from typing import Dict, List, Union, Optional
+from typing import List, Union
 import uuid
 import pandas
 import requests
-from requests.adapters import HTTPAdapter
-from urllib3.util.retry import Retry
 import requests
 
 from ._enums import ControlStatus
-from ._constants import (IOT_RESPONSE_ERROR, IOT_RESPONSE_SUCCESS, WS_DEFAULT_PORT, WS_MQTT_CONNECTION_TIMEOUT,
-                         WS_MQTT_DEFAULT_MAX_TIMEOUT, COL_CONTROL_DEFAULT_CONTROL_VALUE, COL_OBJECT_PROPERTY_ID, COL_CONTROL_NAME,
+from ._constants import (IOT_RESPONSE_ERROR, IOT_RESPONSE_SUCCESS, COL_CONTROL_DEFAULT_CONTROL_VALUE, COL_OBJECT_PROPERTY_ID, COL_CONTROL_NAME,
                          COL_CONTROL_LABEL, COL_CONTROL_VALUE, COL_CONTROL_CONTINUE_VALUE, COL_CONTROL_TTL, COL_CONTROL_PRIORITY,
                          COL_CONTROL_INSTALLATION_ID, COL_CONTROL_STATUS, COL_CONTROL_TIMESTAMP, COL_CONTROL_TIMESTAMP_LOCAL,
                          COL_CONTROL_PIVOTKEY, COL_CONTROL_INFOCOLUMNS, COL_CONTROL_IS_EXTENDED_CONTROL, COL_CONTROL_EXISTS_IN_CONTROL_CACHE)
 from ._mqtt import SwitchMQTT
+from .._utils import _mqtt
+from .._utils._constants import WS_MQTT_CONNECTION_TIMEOUT
 from .._utils._utils import ApiInputs, _with_func_attrs, is_valid_uuid, requests_retry_session2
 from ..cache.cache import get_cache, set_cache
 
+# -----------------------------------------------------------------------------
+# Logging Setup
+# -----------------------------------------------------------------------------
 logger = logging.getLogger(__name__)
 logger.setLevel(logging.DEBUG)
-consoleHandler = logging.StreamHandler(stream=sys.stdout)
-consoleHandler.setLevel(logging.INFO)
-
-logger.addHandler(consoleHandler)
-formatter = logging.Formatter('%(asctime)s  %(name)s.%(funcName)s  %(levelname)s: %(message)s',
-                              datefmt='%Y-%m-%dT%H:%M:%S')
-consoleHandler.setFormatter(formatter)
-
-global _control_api_endpoint
-global _control_ws_host
-global _control_ws_port
-global _control_ws_username
-global _control_ws_password
-global _control_ws_max_timeout
-
-_control_api_endpoint = ''
-_control_ws_host = ''
-_control_ws_port = WS_DEFAULT_PORT
-_control_ws_username = ''
-_control_ws_password = ''
-_control_ws_max_timeout = WS_MQTT_DEFAULT_MAX_TIMEOUT
 
+if not logger.handlers:
+    console_handler = logging.StreamHandler(stream=sys.stdout)
+    console_handler.setLevel(logging.INFO)
+
+    formatter = logging.Formatter(
+        "%(asctime)s  %(name)s.%(funcName)s  %(levelname)s: %(message)s",
+        datefmt="%Y-%m-%dT%H:%M:%S",
+    )
+    console_handler.setFormatter(formatter)
+    logger.addHandler(console_handler)
+
+# -----------------------------------------------------------------------------
+# Globals
+# -----------------------------------------------------------------------------
 global _control_components
 global _switch_mqtt
 global _session
@@ -62,65 +56,6 @@ _control_components = {}
 _switch_mqtt = None
 _session = None
 
-def set_control_variables(api_endpoint: str, ws_host: str, user_name: str, password: str,
-                          ws_port: int = WS_DEFAULT_PORT, max_timeout: int = WS_MQTT_DEFAULT_MAX_TIMEOUT, bypass_username_password: bool = False):
-    """Set Control Variables
-
-    Set Control Variables needed to enable control request to MQTT Broker when running locally.
-
-    In Production, these are pulled from the deployment environment variables.
-
-    Parameters
-    ----------
-    api_endpoint : str
-        Platform IoT API Endpoint.
-    host : str
-        Host URL for MQTT connection. This needs to be datacenter specfic URL.
-    port : int
-        MQTT message broker port. Defaults to 443.
-    user_name : str
-        Username for MQTT connection
-    password: str
-        Password for MQTT connection
-    max_timeout : int
-        Max timeout set for the controls module. Defaults to 30 seconds.
-    """
-    global _control_api_endpoint
-    global _control_ws_host
-    global _control_ws_port
-    global _control_ws_username
-    global _control_ws_password
-    global _control_ws_max_timeout
-
-    # Check if endpoint is a valid URL
-    if not api_endpoint.startswith('https://'):
-        raise ValueError(
-            "Invalid IoT API Endpoint. The IoT host should start with 'https://'.")
-
-    # # Check if host is a valid URL
-    if not ws_host.startswith('wss://'):
-        raise ValueError(
-            "Invalid IoT Websocket MQTT Host. The IoT host should start with 'wss://'.")
-
-    # Check if user_name and password are not empty
-    if not bypass_username_password:
-        if not user_name:
-            raise ValueError("user_name cannot be empty.")
-        if not password:
-            raise ValueError("password cannot be empty.")
-
-    # Check if max_timeout is greated than 0
-    if max_timeout < 1:
-        raise ValueError("max_timeout should be greater than 0.")
-
-    # Set global variables
-    _control_api_endpoint = api_endpoint
-    _control_ws_host = ws_host
-    _control_ws_port = ws_port
-    _control_ws_username = user_name
-    _control_ws_password = password
-    _control_ws_max_timeout = max_timeout
-
 def submit_control_continue(api_inputs: ApiInputs, data: pandas.DataFrame, information_columns: list = [], 
                             is_send_control: bool = True, ws_timeout_in_seconds: int = WS_MQTT_CONNECTION_TIMEOUT):
     """Submit control of sensor(s)
@@ -143,17 +78,16 @@ def submit_control_continue(api_inputs: ApiInputs, data: pandas.DataFrame, infor
             When value is set to 0 it defaults to max timeout value.
             When value is above max timeout value it defaults to max timeout value.
 
-
     Returns
     -------
     Dataframe
         control_response  = is the list of sensors that were controlled or not
     """
     global _control_components
-    global _control_ws_max_timeout
     global _switch_mqtt
     global _session
-    
+
+    mqtt_config = _mqtt.get_control_config()
     control_results = []
 
     # Validate Information Columns if existing
@@ -168,26 +102,26 @@ def submit_control_continue(api_inputs: ApiInputs, data: pandas.DataFrame, infor
 
     if ws_timeout_in_seconds < 0:
         logger.error(
-            f"Invalid timeout value. Timeout should be between 0 and {_control_ws_max_timeout}. Setting to zero will default to max timeout.")
+            f"Invalid timeout value. Timeout should be between 0 and {mqtt_config['max_timeout']}. Setting to zero will default to max timeout.")
         return pandas.DataFrame()
 
-    if ws_timeout_in_seconds > _control_ws_max_timeout:
+    if ws_timeout_in_seconds > mqtt_config["max_timeout"]:
         logger.critical(
             f'Timeout is greater than Max Timeout value. Setting timeout to Max Timeout Value instead.')
-        ws_timeout_in_seconds = _control_ws_max_timeout
+        ws_timeout_in_seconds = mqtt_config["max_timeout"]
 
     if ws_timeout_in_seconds == 0:
-        ws_timeout_in_seconds = _control_ws_max_timeout
+        ws_timeout_in_seconds = mqtt_config["max_timeout"]
 
     # [Create] SwitchMQTT
     if _switch_mqtt == None:
-        _switch_mqtt = SwitchMQTT(host_address=_control_ws_host, 
-                                        host_port=_control_ws_port,
-                                        username=_control_ws_username, 
-                                        password=_control_ws_password, 
-                                        client_id=api_inputs.data_feed_id, 
-                                        email=api_inputs.email_address,
-                                        project_id=api_inputs.api_project_id)
+        _switch_mqtt = SwitchMQTT(host_address=mqtt_config["ws_host"],
+                                  host_port=mqtt_config["ws_port"],
+                                  username=mqtt_config["username"], 
+                                  password=mqtt_config["password"], 
+                                  client_id=api_inputs.data_feed_id, 
+                                  email=api_inputs.email_address,
+                                  project_id=api_inputs.api_project_id)
 
     # [Connect] to MQTT Broker
     is_connected = _switch_mqtt.connect(timeout=ws_timeout_in_seconds)
@@ -348,6 +282,9 @@ def submit_control_continue(api_inputs: ApiInputs, data: pandas.DataFrame, infor
             
     _control_components = {}
 
+    if not control_results:
+        return pandas.DataFrame()  # return empty DataFrame safely
+
     return pandas.concat(control_results, ignore_index=True)
 
 
@@ -386,7 +323,6 @@ def __send_control(api_inputs: ApiInputs, installation_id: Union[uuid.UUID, str]
     Dataframe
         control_response  = is the list of sensors that were request to be controlled with status labelling if it was successful or not by the MQTTT message broker
     """
-    global _control_ws_max_timeout
     global _switch_mqtt
     global _session
 
@@ -670,18 +606,14 @@ def submit_control(api_inputs: ApiInputs, installation_id: Union[uuid.UUID, str]
     tuple
         control_response  = is the list of sensors that were request to be controlled with status labelling if it was successful or not by the MQTTT message broker
     """
-    global _control_api_endpoint
-    global _control_ws_host
-    global _control_ws_port
-    global _control_ws_username
-    global _control_ws_password
-    global _control_ws_max_timeout
     global _switch_mqtt
     global _session
 
     default_control_value_column = 'DefaultControlValue'
     default_priority = 8
 
+    mqtt_config = _mqtt.get_control_config()
+
     data_frame = df.copy()
 
     if api_inputs.api_base_url == '' or api_inputs.bearer_token == '':
@@ -698,16 +630,16 @@ def submit_control(api_inputs: ApiInputs, installation_id: Union[uuid.UUID, str]
 
     if timeout < 0:
         logger.error(
-            f"Invalid timeout value. Timeout should be between 0 and {_control_ws_max_timeout}. Setting to zero will default to max timeout.")
+            f"Invalid timeout value. Timeout should be between 0 and {mqtt_config['max_timeout']}. Setting to zero will default to max timeout.")
         return 'Invalid timeout.', pandas.DataFrame()
 
-    if timeout > _control_ws_max_timeout:
+    if timeout > mqtt_config["max_timeout"]:
         logger.critical(
             f'Timeout is greater than Max Timeout value. Setting timeout to Max Timeout Value instead.')
-        timeout = _control_ws_max_timeout
+        timeout = mqtt_config["max_timeout"]
 
     if timeout == 0:
-        timeout = _control_ws_max_timeout
+        timeout = mqtt_config["max_timeout"]
 
     if not is_valid_uuid(session_id):
         session_id = uuid.uuid4()
@@ -774,8 +706,8 @@ def submit_control(api_inputs: ApiInputs, installation_id: Union[uuid.UUID, str]
 
     # [Create] SwitchMQTT
     if _switch_mqtt == None:
-        _switch_mqtt = SwitchMQTT(host_address=_control_ws_host, host_port=_control_ws_port,
-                             username=_control_ws_username, password=_control_ws_password,
+        _switch_mqtt = SwitchMQTT(host_address=mqtt_config["ws_host"], host_port=mqtt_config["ws_port"],
+                             username=mqtt_config["username"], password=mqtt_config["password"],
                              client_id=api_inputs.data_feed_id, email=api_inputs.email_address,
                              project_id=api_inputs.api_project_id)
 
@@ -892,7 +824,7 @@ def submit_control(api_inputs: ApiInputs, installation_id: Union[uuid.UUID, str]
     control_results = process_paged_request(data_frame)
 
     return control_results
-
+ 
 
 def get_control_cache(api_inputs: ApiInputs, key: str, scope_id: str) -> pandas.DataFrame:
     """Gets Control Cache based on Portfolio.
@@ -1035,7 +967,8 @@ def add_control_component(name: str, column_with_object_installation_id: str, co
 
 def log_control_request(session: requests.Session, api_inputs: ApiInputs, df: pandas.DataFrame,
                         session_id: uuid.UUID, installation_id: uuid.UUID):
-
+    
+    mqtt_config = _mqtt.get_control_config()
     json_payload = {
         "sensors": df.to_dict(orient="records"),
         "email": api_inputs.email_address,
@@ -1043,7 +976,7 @@ def log_control_request(session: requests.Session, api_inputs: ApiInputs, df: pa
         "sessionId": str(session_id),
     }
 
-    url = f"{_control_api_endpoint}/api/gateway/{installation_id}/log-control-request"
+    url = f"{mqtt_config['api_endpoint']}/api/gateway/{installation_id}/log-control-request"
     headers = api_inputs.api_headers.default
 
     logger.info("Sending Control Request to IoT API: POST %s", url)

{switch_api-0.6.12 → switch_api-0.6.14}/switch_api/integration/integration.py

@@ -1855,6 +1855,7 @@ def upsert_timeseries(df: pandas.DataFrame, api_inputs: ApiInputs, is_local_time
         df = df.assign(Carbon=0.0)
 
         df = df.copy()
+        df['__row_id'] = np.arange(len(df))
         carbon_calcs_df = carbon_calculations_df.copy()
 
         if 'ObjectPropertyID' in carbon_calcs_df.columns:
@@ -1864,7 +1865,7 @@ def upsert_timeseries(df: pandas.DataFrame, api_inputs: ApiInputs, is_local_time
         if not pd.api.types.is_datetime64_any_dtype(df['TimestampLocal']):
             df['TimestampLocal'] = pd.to_datetime(df['TimestampLocal'])
 
-        required_carbon_cols = ['ObjectPropertyId', 'CarbonExpression', 'FromDate', 'ToDate']
+        required_carbon_cols = ['ObjectPropertyId', 'CarbonExpression', 'FromDate', 'ToDate', 'ObjectPropertyTemplateID']
         if not all(col in carbon_calcs_df.columns for col in required_carbon_cols):
             logger.error(f"Missing required columns in carbon calculations DataFrame. Required: {required_carbon_cols}")
             return df.assign(Carbon=0.0)
@@ -1877,29 +1878,47 @@ def upsert_timeseries(df: pandas.DataFrame, api_inputs: ApiInputs, is_local_time
         carbon_calcs_df['ToDate'] = pd.to_datetime(carbon_calcs_df['ToDate'])
 
         merged_df = pd.merge(df, carbon_calcs_df, on='ObjectPropertyId', how='left', indicator=True)
-        no_valid_carbon_calcs = merged_df[merged_df._merge== 'left_only']
 
         matches_mask = (merged_df['TimestampLocal'] >= merged_df['FromDate']) & \
                         (merged_df['TimestampLocal'] <= merged_df['ToDate'])
-        valid_carbon_calcs = merged_df[matches_mask]
 
-        if valid_carbon_calcs.shape[0]>0:
-            unique_expressions = valid_carbon_calcs['CarbonExpression'].unique()
+        valid_carbon_calcs = merged_df[matches_mask].copy()
+
+        if not valid_carbon_calcs.empty:
+            # priority: non-NULL ObjectPropertyTemplateID first
+            valid_carbon_calcs["__tmplt_priority"] = valid_carbon_calcs["ObjectPropertyTemplateID"].notna().astype(int)
+
+            # choose ONE calc row per original df row
+            valid_carbon_calcs = (
+                valid_carbon_calcs
+                .sort_values(["__row_id", "__tmplt_priority"], ascending=[True, False])
+                .drop_duplicates(subset="__row_id", keep="first")
+            )
+
+            unique_expressions = valid_carbon_calcs["CarbonExpression"].dropna().unique()
             for expr in unique_expressions:
-                expr_mask = valid_carbon_calcs['CarbonExpression'] == expr
-                numexpr_expression = expr.replace('[Value]', 'Value')
-                valid_carbon_calcs.loc[expr_mask, 'Carbon'] = numexpr.evaluate(
-                    numexpr_expression, 
-                    local_dict = {'Value': valid_carbon_calcs.loc[expr_mask, 'Value'].values}
+                expr_mask = valid_carbon_calcs["CarbonExpression"] == expr
+                numexpr_expression = expr.replace("[Value]", "Value")
+                valid_carbon_calcs.loc[expr_mask, "Carbon"] = numexpr.evaluate(
+                    numexpr_expression,
+                    local_dict={"Value": valid_carbon_calcs.loc[expr_mask, "Value"].values}
                 )
-        
-        final_df = pd.concat([no_valid_carbon_calcs, valid_carbon_calcs])
-        final_row_count = final_df.shape[0]
 
-        logger.info(f"Original row count = {original_row_count}, final row count = {final_row_count}. Matches = {original_row_count==final_row_count}")
-        final_df = final_df.drop(columns=['CarbonExpression', 'FromDate', 'ToDate', '_merge'])
+            df = df.merge(
+                valid_carbon_calcs[["__row_id", "Carbon"]],
+                on="__row_id",
+                how="left",
+                suffixes=("", "_calc"),
+            )
+            df["Carbon"] = df["Carbon_calc"].fillna(df["Carbon"])
+            df = df.drop(columns=["Carbon_calc"])
+
+        final_row_count = df.shape[0]
+        logger.info(
+            f"Original row count = {original_row_count}, final row count = {final_row_count}. Matches = {original_row_count==final_row_count}"
+        )
 
-        return final_df
+        return df.drop(columns=["__row_id"])
 
     def create_meta_column(df, slice_columns, save_slices, cost_carbon_calculation):
         """Handles creating the 'Meta' column and optionally saves additional columns as slices."""

switch_api-0.6.14/switch_api/realtime/__init__.py

@@ -0,0 +1,12 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Switch Automation Pty Ltd. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+"""
+A module for sending control request of sensors.
+"""
+
+from .realtime import submit_realtime_updates
+
+__all__ = ['submit_realtime_updates']