pysma-plus 0.1.0__tar.gz

pysma-plus-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 kellerza
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pysma-plus-0.1.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include LICENSE README.md
+#graft pysma
+graft tests
+recursive-exclude * *.py[co]

pysma-plus-0.1.0/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.1
+Name: pysma-plus
+Version: 0.1.0
+Summary: Library to interface SMA Devices via WebConnect, EnnexOS and Energy Meter Devices
+Home-page: https://github.com/littleyoda/pysma
+Download-URL: https://github.com/littleyoda/pysma/tarball/0.1.0
+Author: Sven Bursch-Osewold, Johann Kellerman and other
+Author-email: Sven Bursch-Osewold <sb_pysma@bursch.com>, Johann Kellerman <kellerza@gmail.com>
+License: The MIT License (MIT)
+        
+        Copyright (c) 2016 kellerza
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/littleyoda/pysma
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp<4,>3.3
+Requires-Dist: attrs>18
+Requires-Dist: jmespath<2
+
+
+# pysma-plus library
+
+Python 3 library to retrieve data from various SMA](https://www.sma.de/) devices.
+Based on a fork of the [pysma lib from kellerza](https://github.com/kellerza/pysma).
+The long-term goal is to integrate the change into the original library.
+
+SMA Webconnect library for Python 3. The library was created
+to integrate SMA inverters with HomeAssistant
+
+* Devices with Webconnect-Interface
+* Devices based on  ennexOS
+e.g. the Tripower X series released in 2022
+* SMA Energy Meter (EMETER-10, EMETER-20) und ### Sunny Home Manager 2.0 (shm2)
+
+
+## Example usage
+
+See [example.py](./example.py) for a basic usage and tests
+
+
+

pysma-plus-0.1.0/README.md

@@ -0,0 +1,22 @@
+
+# pysma-plus library
+
+Python 3 library to retrieve data from various SMA](https://www.sma.de/) devices.
+Based on a fork of the [pysma lib from kellerza](https://github.com/kellerza/pysma).
+The long-term goal is to integrate the change into the original library.
+
+SMA Webconnect library for Python 3. The library was created
+to integrate SMA inverters with HomeAssistant
+
+* Devices with Webconnect-Interface
+* Devices based on  ennexOS
+e.g. the Tripower X series released in 2022
+* SMA Energy Meter (EMETER-10, EMETER-20) und ### Sunny Home Manager 2.0 (shm2)
+
+
+## Example usage
+
+See [example.py](./example.py) for a basic usage and tests
+
+
+

pysma-plus-0.1.0/pyproject.toml

@@ -0,0 +1,35 @@
+# pyproject.toml
+
+[build-system]
+requires      = ["setuptools>=61.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pysma-plus"
+version = "0.1.0"
+description = "Library to interface SMA Devices via WebConnect, EnnexOS and Energy Meter Devices"
+readme = "README.md"
+authors = [{ name = "Sven Bursch-Osewold", email = "sb_pysma@bursch.com" },{ name = "Johann Kellerman" , email ="kellerza@gmail.com"} ]
+license = { file = "LICENSE" }
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+]
+dependencies = [
+    "aiohttp>3.3,<4",
+    "attrs>18",
+    "jmespath<2",
+]
+requires-python = ">=3.9"
+
+[tool.setuptools]
+include-package-data = false
+
+[tool.setuptools.packages.find]
+include = ["pysmaplus"]
+exclude = ["pysma/*"]
+
+
+[project.urls]
+Homepage = "https://github.com/littleyoda/pysma"

pysma-plus-0.1.0/pysma_plus.egg-info/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.1
+Name: pysma-plus
+Version: 0.1.0
+Summary: Library to interface SMA Devices via WebConnect, EnnexOS and Energy Meter Devices
+Home-page: https://github.com/littleyoda/pysma
+Download-URL: https://github.com/littleyoda/pysma/tarball/0.1.0
+Author: Sven Bursch-Osewold, Johann Kellerman and other
+Author-email: Sven Bursch-Osewold <sb_pysma@bursch.com>, Johann Kellerman <kellerza@gmail.com>
+License: The MIT License (MIT)
+        
+        Copyright (c) 2016 kellerza
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/littleyoda/pysma
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp<4,>3.3
+Requires-Dist: attrs>18
+Requires-Dist: jmespath<2
+
+
+# pysma-plus library
+
+Python 3 library to retrieve data from various SMA](https://www.sma.de/) devices.
+Based on a fork of the [pysma lib from kellerza](https://github.com/kellerza/pysma).
+The long-term goal is to integrate the change into the original library.
+
+SMA Webconnect library for Python 3. The library was created
+to integrate SMA inverters with HomeAssistant
+
+* Devices with Webconnect-Interface
+* Devices based on  ennexOS
+e.g. the Tripower X series released in 2022
+* SMA Energy Meter (EMETER-10, EMETER-20) und ### Sunny Home Manager 2.0 (shm2)
+
+
+## Example usage
+
+See [example.py](./example.py) for a basic usage and tests
+
+
+

pysma-plus-0.1.0/pysma_plus.egg-info/SOURCES.txt

@@ -0,0 +1,27 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+setup.cfg
+setup.py
+pysma_plus.egg-info/PKG-INFO
+pysma_plus.egg-info/SOURCES.txt
+pysma_plus.egg-info/dependency_links.txt
+pysma_plus.egg-info/requires.txt
+pysma_plus.egg-info/top_level.txt
+pysma_plus.egg-info/zip-safe
+pysmaplus/__init__.py
+pysmaplus/const.py
+pysmaplus/definitions.py
+pysmaplus/device.py
+pysmaplus/exceptions.py
+pysmaplus/helpers.py
+pysmaplus/sensor.py
+pysmaplus/smaennexos.py
+pysmaplus/smaspeedwireem.py
+pysmaplus/smawebconnect.py
+tests/__init__.py
+tests/test_definitions.py
+tests/test_helpers.py
+tests/test_init.py
+tests/test_sensor.py

pysma-plus-0.1.0/pysma_plus.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pysma-plus-0.1.0/pysma_plus.egg-info/requires.txt

@@ -0,0 +1,3 @@
+aiohttp<4,>3.3
+attrs>18
+jmespath<2

pysma-plus-0.1.0/pysma_plus.egg-info/top_level.txt

@@ -0,0 +1 @@
+pysmaplus

pysma-plus-0.1.0/pysma_plus.egg-info/zip-safe

@@ -0,0 +1 @@
+

pysma-plus-0.1.0/pysmaplus/__init__.py

@@ -0,0 +1,68 @@
+"""SMA WebConnect library for Python.
+
+See: http://www.sma.de/en/products/monitoring-control/webconnect.html
+
+Source: http://www.github.com/kellerza/pysma
+"""
+import asyncio
+import copy
+import json
+import logging
+from typing import Any, Dict, Optional
+
+import jmespath  # type: ignore
+from aiohttp import ClientSession, ClientTimeout, client_exceptions, hdrs
+from .sensor import Sensor
+from . import definitions
+from .const import (
+    DEFAULT_LANG,
+    DEFAULT_TIMEOUT,
+    DEVICE_INFO,
+    ENERGY_METER_VIA_INVERTER,
+    FALLBACK_DEVICE_INFO,
+    GENERIC_SENSORS,
+    OPTIMIZERS_VIA_INVERTER,
+    URL_ALL_PARAMS,
+    URL_ALL_VALUES,
+    URL_DASH_LOGGER,
+    URL_DASH_VALUES,
+    URL_LOGGER,
+    URL_LOGIN,
+    URL_LOGOUT,
+    URL_VALUES,
+    USERS,
+)
+from .exceptions import (
+    SmaAuthenticationException,
+    SmaConnectionException,
+    SmaReadException,
+)
+from .helpers import version_int_to_string
+from .sensor import Sensors
+from .smawebconnect import SMAwebconnect
+from .smaennexos import SMAennexos
+from .smaspeedwireem import SMAspeedwireEM
+from .device import Device
+_LOGGER = logging.getLogger(__name__)
+
+
+# Backward compatibility
+def SMA(session, url, password, group):
+    return SMAwebconnect(session, url, password=password, group=group)
+
+
+def getDevice(session: ClientSession,
+        url: str,
+        password: Optional[str] = None,
+        groupuser: str = "user",
+        accessmethod: str = "webconnect"
+    ) -> Device:
+        _LOGGER.debug(f"Device Called! Url: {url} User/Group: {groupuser} Accessmethod: {accessmethod}")
+        if (accessmethod == "webconnect"):
+            return SMAwebconnect(session, url, password=password, group=groupuser)
+        elif (accessmethod == "ennexos"):
+            return SMAennexos(session, url, password=password, group=groupuser)
+        elif (accessmethod == "speedwire"):
+              return SMAspeedwireEM()
+        else:
+             return None

pysma-plus-0.1.0/pysmaplus/const.py

@@ -0,0 +1,156 @@
+"""Constants for SMA WebConnect library for Python."""
+URL_LOGIN = "/dyn/login.json"
+URL_LOGOUT = "/dyn/logout.json"
+URL_VALUES = "/dyn/getValues.json"
+URL_ALL_VALUES = "/dyn/getAllOnlValues.json"
+URL_ALL_PARAMS = "/dyn/getAllParamValues.json"
+URL_LOGGER = "/dyn/getLogger.json"
+URL_DASH_LOGGER = "/dyn/getDashLogger.json"
+URL_DASH_VALUES = "/dyn/getDashValues.json"
+
+USERS = {"user": "usr", "installer": "istl"}
+
+DEFAULT_TIMEOUT = 15
+DEFAULT_LANG = "en-US"
+
+JMESPATH_VAL = "val"
+JMESPATH_VAL_TAG = JMESPATH_VAL + "[0].tag"
+JMESPATH_VAL_STR = "[?str==sum([`1`,`{}`])].val | [0]"
+JMESPATH_VAL_IDX = "* | [0][{}].val"
+JMESPATH_VAL_IDX_TAG = JMESPATH_VAL_IDX + "[0].tag"
+
+JMESPATHS_TAG = (JMESPATH_VAL_IDX_TAG, JMESPATH_VAL_TAG)
+
+LEGACY_MAP = {
+    "pv_power": {"old_key": "6100_0046C200", "new_sensor": "pv_power_a"},
+    "pv_voltage": {
+        "old_key": "6380_40451F00",
+        "new_sensor": "pv_power_a",
+    },
+    "pv_current": {
+        "old_key": "6380_40452100",
+        "new_sensor": "pv_current_a",
+    },
+}
+
+FALLBACK_DEVICE_INFO = {
+    "manufacturer": "SMA",
+    "name": "SMA Device",
+    "type": "",
+    "serial": "9999999999",
+}
+
+GENERIC_SENSORS = "generic"
+OPTIMIZERS_VIA_INVERTER = "optimizers"
+ENERGY_METER_VIA_INVERTER = "energy-meter"
+DEVICE_INFO = "device-info"
+
+
+class Identifier():
+    pv_power_a : str = "pv_power_a"
+    pv_power_b : str = "pv_power_b"
+    pv_power_c : str = "pv_power_c"
+    pv_voltage_a : str = "pv_voltage_a"
+    pv_voltage_b : str = "pv_voltage_b"
+    pv_voltage_c : str = "pv_voltage_c"
+    pv_current_a : str = "pv_current_a"
+    pv_current_b : str = "pv_current_b"
+    pv_current_c : str = "pv_current_c"
+    insulation_residual_current : str = "insulation_residual_current"
+    pv_power : str = "pv_power"
+    grid_power : str = "grid_power"
+    frequency : str = "frequency"
+    power_l1 : str = "power_l1"
+    power_l2 : str = "power_l2"
+    power_l3 : str = "power_l3"
+    temp_a : str = "temp_a"
+    temp_b : str = "temp_b"
+    temp_c : str = "temp_c"
+    grid_reactive_power : str = "grid_reactive_power"
+    grid_reactive_power_l1 : str = "grid_reactive_power_l1"
+    grid_reactive_power_l2 : str = "grid_reactive_power_l2"
+    grid_reactive_power_l3 : str = "grid_reactive_power_l3"
+    grid_apparent_power : str = "grid_apparent_power"
+    grid_apparent_power_l1 : str = "grid_apparent_power_l1"
+    grid_apparent_power_l2 : str = "grid_apparent_power_l2"
+    grid_apparent_power_l3 : str = "grid_apparent_power_l3"
+    grid_power_factor : str = "grid_power_factor"
+    current_l1 : str = "current_l1"
+    current_l2 : str = "current_l2"
+    current_l3 : str = "current_l3"
+    current_total : str = "current_total"
+    voltage_l1 : str = "voltage_l1"
+    voltage_l2 : str = "voltage_l2"
+    voltage_l3 : str = "voltage_l3"
+    total_yield : str = "total_yield"
+    daily_yield : str = "daily_yield"
+    metering_power_supplied : str = "metering_power_supplied"
+    metering_power_absorbed : str = "metering_power_absorbed"
+    metering_frequency : str = "metering_frequency"
+    metering_total_yield : str = "metering_total_yield"
+    metering_total_absorbed : str = "metering_total_absorbed"
+    metering_current_l1 : str = "metering_current_l1"
+    metering_current_l2 : str = "metering_current_l2"
+    metering_current_l3 : str = "metering_current_l3"
+    metering_voltage_l1 : str = "metering_voltage_l1"
+    metering_voltage_l2 : str = "metering_voltage_l2"
+    metering_voltage_l3 : str = "metering_voltage_l3"
+    metering_active_power_feed_l1 : str = "metering_active_power_feed_l1"
+    metering_active_power_feed_l2 : str = "metering_active_power_feed_l2"
+    metering_active_power_feed_l3 : str = "metering_active_power_feed_l3"
+    metering_active_power_draw_l1 : str = "metering_active_power_draw_l1"
+    metering_active_power_draw_l2 : str = "metering_active_power_draw_l2"
+    metering_active_power_draw_l3 : str = "metering_active_power_draw_l3"
+    metering_current_consumption : str = "metering_current_consumption"
+    pv_gen_meter : str = "pv_gen_meter"
+    sps_voltage : str = "sps_voltage"
+    sps_current : str = "sps_current"
+    sps_power : str = "sps_power"
+    optimizer_serial : str = "optimizer_serial"
+    optimizer_power : str = "optimizer_power"
+    optimizer_current : str = "optimizer_current"
+    optimizer_voltage : str = "optimizer_voltage"
+    optimizer_temp : str = "optimizer_temp"
+    battery_soc_total : str = "battery_soc_total"
+    battery_soc_a : str = "battery_soc_a"
+    battery_soc_b : str = "battery_soc_b"
+    battery_soc_c : str = "battery_soc_c"
+    battery_voltage_a : str = "battery_voltage_a"
+    battery_voltage_b : str = "battery_voltage_b"
+    battery_voltage_c : str = "battery_voltage_c"
+    battery_current_a : str = "battery_current_a"
+    battery_current_b : str = "battery_current_b"
+    battery_current_c : str = "battery_current_c"
+    battery_temp_a : str = "battery_temp_a"
+    battery_temp_b : str = "battery_temp_b"
+    battery_temp_c : str = "battery_temp_c"
+    battery_capacity_total : str = "battery_capacity_total"
+    battery_capacity_a : str = "battery_capacity_a"
+    battery_capacity_b : str = "battery_capacity_b"
+    battery_capacity_c : str = "battery_capacity_c"
+    battery_charging_voltage_a : str = "battery_charging_voltage_a"
+    battery_charging_voltage_b : str = "battery_charging_voltage_b"
+    battery_charging_voltage_c : str = "battery_charging_voltage_c"
+    battery_power_charge_total : str = "battery_power_charge_total"
+    battery_power_charge_a : str = "battery_power_charge_a"
+    battery_power_charge_b : str = "battery_power_charge_b"
+    battery_power_charge_c : str = "battery_power_charge_c"
+    battery_charge_total : str = "battery_charge_total"
+    battery_charge_a : str = "battery_charge_a"
+    battery_charge_b : str = "battery_charge_b"
+    battery_charge_c : str = "battery_charge_c"
+    battery_power_discharge_total : str = "battery_power_discharge_total"
+    battery_power_discharge_a : str = "battery_power_discharge_a"
+    battery_power_discharge_b : str = "battery_power_discharge_b"
+    battery_power_discharge_c : str = "battery_power_discharge_c"
+    battery_discharge_total : str = "battery_discharge_total"
+    battery_discharge_a : str = "battery_discharge_a"
+    battery_discharge_b : str = "battery_discharge_b"
+    battery_discharge_c : str = "battery_discharge_c"
+    serial_number : str = "serial_number"
+    device_name : str = "device_name"
+    device_type : str = "device_type"
+    device_manufacturer : str = "device_manufacturer"
+    device_sw_version : str = "device_sw_version"
+    inverter_power_limit : str = "inverter_power_limit"
+    energy_meter : str = "energy_meter"