redbacktechpy 0.3.1__py3-none-any.whl

redbacktechpy/__init__.py

@@ -0,0 +1,19 @@
+from .constants import (
+    TIMEOUT,
+    DEVICEINFOREFRESH,
+    AUTH_ERROR_CODES,
+    BaseUrl,
+    Endpoint,
+    InverterOperationType,
+    InverterModeControl,
+    Header,
+    DeviceTypes,
+    DeviceInfo,
+)
+from .redbacktech_client  import (RedbackTechClient, LOGGER)
+from .exceptions import (RedbackTechClientError, AuthError)
+from .model import (Inverters, Batterys, DeviceInfo)
+from .str_enum import StrEnum
+
+
+__all__ = ['TIMEOUT','DEVICEINFOREFRESH','AUTH_ERROR_CODES','BaseUrl','Endpoint','InverterOperationType','InverterModeControl','Header','DeviceTypes','DeviceInfo']

redbacktechpy/constants.py

@@ -0,0 +1,62 @@
+from str_enum import StrEnum
+
+TIMEOUT = 5 * 60
+DEVICEINFOREFRESH = 30 * 60  #Number of seconds to wait before refreshing device info as it doesn't change very often
+
+AUTH_ERROR_CODES = [
+    'unauthorized_client',
+    'Login session expired.',
+]
+
+class BaseUrl(StrEnum):
+    API = 'https://api.redbacktech.com/'
+    PORTAL = 'https://portal.redbacktech.com/'
+
+class Endpoint(StrEnum):
+    
+    API_AUTH = 'Api/v2/Auth/token'
+    API_SITES = 'Api/v2/EnergyData'
+    API_NODES = 'Api/v2/EnergyData/With/Nodes'
+    API_STATIC = 'Api/v2/EnergyData/{self.siteId}/Static'
+    API_STATIC_MULTIPLE_BY_SERIAL = 'Api/v2/Configuration/Multiple/BySerialNumber/Configuration'
+    API_CONFIG_BY_SERIAL = 'Api/v2/Configuration/Configuration/BySerialNumber/'
+    API_STATIC_BY_SERIAL = 'Api/v2/EnergyData/Static/BySerialNumber/'
+    API_ENERGY_DYNAMIC_MULTIPLE_BY_SERIAL = 'Api/v2.21/EnergyData/Multiple/BySerialNumber/Dynamic'
+    API_ENERGY_DYNAMIC_BY_SERIAL = 'Api/v2.21/EnergyData/Dynamic/BySerialNumber/'
+    API_ENERGY_DYNAMIC_BY_SITE = 'Api/v2.21/EnergyData/{self.siteId}/Dynamic'
+    PORTAL_LOGIN = 'Account/Login'
+    PORTAL_CONFIGURE = 'productcontrol/Configure?serialNumber='
+    PORTAL_INVERTER_SET = 'productcontrol/Index'
+    PORTAL_LOGOFF = 'Account/LogOff/'
+    PORTAL_DETAILS = 'productcontrol/Details?serialNumber='
+    
+
+class InverterOperationType(StrEnum):
+    SET = 'Set'
+    
+class InverterModeControl(StrEnum):
+    AUTO = 'Auto'
+    CHARGE_BATTERY = 'ChargeBattery'
+    DISCHARGE_BATTERY = 'DischargeBattery'
+    IMPORT_POWER = 'ImportPower'
+    EXPORT_POWER = 'ExportPower'
+    CONSERVE = 'Conserve'
+    
+class Header(StrEnum):
+    ACCEPT = '*/*'
+    ENCODING = 'gzip, deflate'
+    CONTENT_TYPE = 'application/x-www-form-urlencoded; charset=UTF-8'
+    X_REQUESTED_WITH = 'XMLHttpRequest'
+    REFERER_UI = 'https://portal.redbacktech.com/ui/'
+    
+class DeviceTypes(StrEnum):
+    INVERTER = 'Inverter'
+    BATTERY = 'Battery'
+    METER = 'Meter'
+    LOAD = 'Load'
+
+class DeviceInfo(StrEnum):
+    MODEL = 'model'
+    SW_VERSION = 'sw_version'
+    HW_VERSION = 'hw_version'
+    SERIAL_NUMBER = 'serial_number'

redbacktechpy/exceptions.py

@@ -0,0 +1,17 @@
+"""Exceptions for RedbackTech"""
+
+from typing import Any
+
+class AuthError(Exception):
+    """Authentication issue from Redback api."""
+
+    def __init__(self, *args: Any) -> None:
+        """Initialize the exception."""
+        Exception.__init__(self, *args)
+        
+class RedbackTechClientError(Exception):
+    """Error from Redback api."""
+
+    def __init__(self, *args: Any) -> None:
+        """Initialize the exception."""
+        Exception.__init__(self, *args)

redbacktechpy/model.py

@@ -0,0 +1,42 @@
+""" Data classes for Redback Tech API """
+from __future__ import annotations
+
+from dataclasses import dataclass
+import datetime
+from typing import Any, Optional
+
+
+@dataclass
+class Site:
+    """Dataclass for Redback Sites."""
+
+    id: str
+    data: dict[str, Any]
+    type: str
+    
+@dataclass
+class Inverters:
+    """Dataclass for Redback Inverters."""
+
+    id: str
+    device_serial_number: str
+    data: dict[str, Any]
+    type: str
+
+@dataclass    
+class Batterys:
+    """Dataclass for RedBack Batteries."""
+
+    id: str
+    device_serial_number: str
+    data: dict[str, Any]
+    type: str
+
+@dataclass
+class DeviceInfo:
+    """Dataclass for Device Info."""
+
+    id: str
+    device_serial_number: str
+    data: dict[str, Any]
+    type: str