solaredge2mqtt 0.1.1__tar.gz

solaredge2mqtt-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 learningHouse
+
+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.

solaredge2mqtt-0.1.1/MANIFEST.in

@@ -0,0 +1,16 @@
+# Include the README
+include *.md
+
+# Include the license file
+include LICENSE
+
+# Include information about third party licensors
+include THIRD-PARTY-NOTICES
+
+include requirements.txt
+
+recursive-include solaredge2mqtt *.py
+
+# Include information about version
+include versioneer.py
+include solaredge2mqtt/_version.py

solaredge2mqtt-0.1.1/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.1
+Name: solaredge2mqtt
+Version: 0.1.1
+Summary: Read data from SolarEdge Inverter and publish it to MQTT
+Home-page: https://github.com/deroetzi/solaredge2mqtt
+Author: Johannes Ott
+Author-email: info@johannes-ott.net
+Project-URL: Bug Reports, https://github.com/deroetzi/solaredge2mqtt/issues
+Keywords: smart home
+Classifier: Development Status :: 4 - Beta
+Classifier: Topic :: Home Automation
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.10, <4
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: solaredge_modbus==0.8.0
+Requires-Dist: pydantic==2.3.0
+Requires-Dist: pydantic-settings==2.0.3
+Requires-Dist: loguru==0.7.2
+Requires-Dist: gmqtt==0.6.13
+
+# SolarEdge 2 MQTT Service
+[![License](https://img.shields.io/github/license/DerOetzi/solaredge2mqtt)](https://github.com/DerOetzi/solaredge2mqtt/blob/main/LICENSE) [![Release](https://img.shields.io/github/v/release/DerOetzi/solaredge2mqtt)](https://github.com/DerOetzi/solaredge2mqtt/releases/latest) [![Build Status](https://img.shields.io/github/actions/workflow/status/DerOetzi/solaredge2mqtt/build_project.yml?branch=main)](https://github.com/DerOetzi/solaredge2mqtt/actions/workflows/build_project.yml) [![PyPI version](https://img.shields.io/pypi/v/solaredge2mqtt.svg)](https://pypi.org/project/solaredge2mqtt/) 
+
+The SolarEdge2MQTT service is a project designed to read data from a SolarEdge inverter and publish it to an MQTT broker. The service is useful for integrating SolarEdge inverters into home automation systems or other applications that use MQTT for data exchange. It provides real-time monitoring of power flow and other parameters from the inverter. The project is open-source and can be customized to suit specific needs.
+
+*The SolarEdge2MQTT service is currently in an early stage of development. While it is functional and can be used to read data from a SolarEdge inverter and publish it to an MQTT broker, it is still undergoing active development. Features may be added, removed, or changed, and there may be bugs. Users should be aware of this and use the service with caution. Despite its early state, the project is open-source and contributions are welcome.*
+
+## Installation and Configuration
+
+Install and update using pip.
+```
+pip install -U solaredge2mqtt
+```
+
+Install and update using docker
+```
+docker pull ghcr.io/deroetzi/solaredge2mqtt:latest
+```
+
+### Service configuration
+
+The service is configured by environment variables. The following options can be set:
+
+Environment Variable             | default (production/development) | description                                            
+-------------------------------- | -------------------------------- | ------------------------------------------------------ 
+SE2MQTT_ENVIRONMENT              | production                       | Choose the default environment settings: production or development. 
+SE2MQTT_MODBUS_HOST              | *None*                           | IP address of your inverter
+SE2MQTT_MODBUS_PORT              | 1502                             | Modbus port of your inverter
+SE2MQTT_MODBUS_TIMEOUT           | 1                                | Timeout for the modbus connection
+SE2MQTT_MODBUS_UNIT              | 1                                | Modbus unit address
+SE2MQTT_CLIENT_ID                | solaredge2mqtt                   | MQTT client id
+SE2MQTT_BROKER                   | *None*                           | IP address of your MQTT broker
+SE2MQTT_PORT                     | 1883                             | Port of your MQTT broker
+SE2MQTT_USERNAME                 | *None*                           | Username to authenticate to your MQTT broker
+SE2MQTT_PASSWORD                 | *None*                           | Password to authenticate to your MQTT broker
+SE2MQTT_TOPIC_PREFIX             | solaredge                        | SolarEdge2MQTT will use this as prefix topic
+SE2MQTT_INTERVAL                 | 5                                | Interval between requests in seconds
+SE2MQTT_LOGGING_LEVEL            | INFO                             | Set logging level to DEBUG, INFO, WARNING, ERROR, CRITICAL
+
+
+#### Example configuration
+
+You can download [.env.example](https://raw.githubusercontent.com/DerOetzi/solaredge2mqtt/master/core/.env.example) and rename it to `.env`. Inside, you can modify the default configuration values to meet your needs in this file.
+
+## Run the service 
+
+### In the console
+
+Copy the [.env.example](https://raw.githubusercontent.com/DerOetzi/solaredge2mqtt/master/core/.env.example) file to .env and modify it according to your needs.
+
+Then, simply run `solaredge2mqtt` to start the service.
+
+### With docker:
+
+```
+docker run --name solaredge2mqtt --rm \
+    -e "SE2MQTT_MODBUS_HOST=<INVERTER_IP>" \
+    -e "SE2MQTT_BROKER=<BROKER_IP>" \
+    -e "SE2MQTT_USERNAME=<MQTT_USERNAME>" \
+    -e "SE2MQTT_PASSWORD=<MQTT_PASSWORD>" \
+    -e "TZ=Europe/Berlin" \
+    ghcr.io/deroetzi/solaredge2mqtt:latest
+```
+
+Add optional environment arguments from above to fit to your setup.

solaredge2mqtt-0.1.1/README.md

@@ -0,0 +1,65 @@
+# SolarEdge 2 MQTT Service
+[![License](https://img.shields.io/github/license/DerOetzi/solaredge2mqtt)](https://github.com/DerOetzi/solaredge2mqtt/blob/main/LICENSE) [![Release](https://img.shields.io/github/v/release/DerOetzi/solaredge2mqtt)](https://github.com/DerOetzi/solaredge2mqtt/releases/latest) [![Build Status](https://img.shields.io/github/actions/workflow/status/DerOetzi/solaredge2mqtt/build_project.yml?branch=main)](https://github.com/DerOetzi/solaredge2mqtt/actions/workflows/build_project.yml) [![PyPI version](https://img.shields.io/pypi/v/solaredge2mqtt.svg)](https://pypi.org/project/solaredge2mqtt/) 
+
+The SolarEdge2MQTT service is a project designed to read data from a SolarEdge inverter and publish it to an MQTT broker. The service is useful for integrating SolarEdge inverters into home automation systems or other applications that use MQTT for data exchange. It provides real-time monitoring of power flow and other parameters from the inverter. The project is open-source and can be customized to suit specific needs.
+
+*The SolarEdge2MQTT service is currently in an early stage of development. While it is functional and can be used to read data from a SolarEdge inverter and publish it to an MQTT broker, it is still undergoing active development. Features may be added, removed, or changed, and there may be bugs. Users should be aware of this and use the service with caution. Despite its early state, the project is open-source and contributions are welcome.*
+
+## Installation and Configuration
+
+Install and update using pip.
+```
+pip install -U solaredge2mqtt
+```
+
+Install and update using docker
+```
+docker pull ghcr.io/deroetzi/solaredge2mqtt:latest
+```
+
+### Service configuration
+
+The service is configured by environment variables. The following options can be set:
+
+Environment Variable             | default (production/development) | description                                            
+-------------------------------- | -------------------------------- | ------------------------------------------------------ 
+SE2MQTT_ENVIRONMENT              | production                       | Choose the default environment settings: production or development. 
+SE2MQTT_MODBUS_HOST              | *None*                           | IP address of your inverter
+SE2MQTT_MODBUS_PORT              | 1502                             | Modbus port of your inverter
+SE2MQTT_MODBUS_TIMEOUT           | 1                                | Timeout for the modbus connection
+SE2MQTT_MODBUS_UNIT              | 1                                | Modbus unit address
+SE2MQTT_CLIENT_ID                | solaredge2mqtt                   | MQTT client id
+SE2MQTT_BROKER                   | *None*                           | IP address of your MQTT broker
+SE2MQTT_PORT                     | 1883                             | Port of your MQTT broker
+SE2MQTT_USERNAME                 | *None*                           | Username to authenticate to your MQTT broker
+SE2MQTT_PASSWORD                 | *None*                           | Password to authenticate to your MQTT broker
+SE2MQTT_TOPIC_PREFIX             | solaredge                        | SolarEdge2MQTT will use this as prefix topic
+SE2MQTT_INTERVAL                 | 5                                | Interval between requests in seconds
+SE2MQTT_LOGGING_LEVEL            | INFO                             | Set logging level to DEBUG, INFO, WARNING, ERROR, CRITICAL
+
+
+#### Example configuration
+
+You can download [.env.example](https://raw.githubusercontent.com/DerOetzi/solaredge2mqtt/master/core/.env.example) and rename it to `.env`. Inside, you can modify the default configuration values to meet your needs in this file.
+
+## Run the service 
+
+### In the console
+
+Copy the [.env.example](https://raw.githubusercontent.com/DerOetzi/solaredge2mqtt/master/core/.env.example) file to .env and modify it according to your needs.
+
+Then, simply run `solaredge2mqtt` to start the service.
+
+### With docker:
+
+```
+docker run --name solaredge2mqtt --rm \
+    -e "SE2MQTT_MODBUS_HOST=<INVERTER_IP>" \
+    -e "SE2MQTT_BROKER=<BROKER_IP>" \
+    -e "SE2MQTT_USERNAME=<MQTT_USERNAME>" \
+    -e "SE2MQTT_PASSWORD=<MQTT_PASSWORD>" \
+    -e "TZ=Europe/Berlin" \
+    ghcr.io/deroetzi/solaredge2mqtt:latest
+```
+
+Add optional environment arguments from above to fit to your setup.

solaredge2mqtt-0.1.1/THIRD-PARTY-NOTICES

@@ -0,0 +1,37 @@
+ThirdPartyNotices
+-----------------
+Solaredge 2 MQTT uses third-party software or other resources that
+may be distributed under licenses different from deroetzi/se2mqtt
+software.
+In the event that we overlooked to list a required notice, please bring this
+to our attention by opening an issue on:
+https://github.com/deroetzi/se2mqtt/issues
+
+Components:
+-----------
+
+Component: Python3
+Licensor: Python Software Foundation
+Website: https://www.python.org
+License: PSF License
+
+Component: Pydantic
+Licensor: Samuel Colvin
+Website: https://github.com/samuelcolvin/pydantic
+License: MIT License
+
+Component: Loguru
+Licensor: Loguru Contributors
+Website: https://github.com/Delgan/loguru
+License: MIT License
+
+Component: solaredge_modbus
+Licensor: nmakel
+Website: https://github.com/nmakel/solaredge_modbus
+License: MIT License
+
+Component: GMQTT
+Licensor: Mikhail Turchunovich
+Website: https://github.com/wialon/gmqtt
+License: MIT License
+

solaredge2mqtt-0.1.1/requirements.txt

@@ -0,0 +1,5 @@
+solaredge_modbus==0.8.0
+pydantic==2.3.0
+pydantic-settings==2.0.3
+loguru==0.7.2
+gmqtt==0.6.13

solaredge2mqtt-0.1.1/setup.cfg

@@ -0,0 +1,15 @@
+[metadata]
+license_files = LICENSE
+
+[versioneer]
+VCS = git
+style = pep440
+versionfile_source = solaredge2mqtt/_version.py
+versionfile_build = solaredge2mqtt/_version.py
+tag_prefix = v
+parentdir_prefix = 
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

solaredge2mqtt-0.1.1/setup.py

@@ -0,0 +1,42 @@
+from os import path
+
+import setuptools
+
+import versioneer
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+with open("requirements.txt", "r", encoding="utf-8") as fh:
+    requirements = fh.readlines()
+
+
+packages = setuptools.find_packages(exclude=["tests"])
+
+setuptools.setup(
+    name="solaredge2mqtt",
+    version=versioneer.get_version(),
+    cmdclass=versioneer.get_cmdclass(),
+    description="Read data from SolarEdge Inverter and publish it to MQTT",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/deroetzi/solaredge2mqtt",
+    author="Johannes Ott",
+    author_email="info@johannes-ott.net",
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Topic :: Home Automation",
+        "License :: OSI Approved :: MIT License",
+        "Natural Language :: English",
+        "Programming Language :: Python :: 3 :: Only",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+    ],
+    keywords="smart home",
+    packages=packages,
+    include_package_data=True,
+    python_requires=">=3.10, <4",
+    install_requires=[req for req in requirements if not req.startswith("#")],
+    entry_points={"console_scripts": ["solaredge2mqtt=solaredge2mqtt.service:run"]},
+    project_urls={"Bug Reports": "https://github.com/deroetzi/solaredge2mqtt/issues"},
+)

solaredge2mqtt-0.1.1/solaredge2mqtt/__init__.py

@@ -0,0 +1,3 @@
+
+from . import _version
+__version__ = _version.get_versions()['version']

solaredge2mqtt-0.1.1/solaredge2mqtt/__main__.py

@@ -0,0 +1,4 @@
+from solaredge2mqtt.service import run
+
+if __name__ == "__main__":
+    run()

solaredge2mqtt-0.1.1/solaredge2mqtt/_version.py

@@ -0,0 +1,21 @@
+
+# This file was generated by 'versioneer.py' (0.29) from
+# revision-control system data, or from the parent directory name of an
+# unpacked source archive. Distribution tarballs contain a pre-generated copy
+# of this file.
+
+import json
+
+version_json = '''
+{
+ "date": "2023-12-17T21:22:44+0100",
+ "dirty": false,
+ "error": null,
+ "full-revisionid": "bcbec905adce10daca8fe3026b6157af112eca26",
+ "version": "0.1.1"
+}
+'''  # END VERSION_JSON
+
+
+def get_versions():
+    return json.loads(version_json)

solaredge2mqtt-0.1.1/solaredge2mqtt/core/logging.py

@@ -0,0 +1,33 @@
+import logging
+import sys
+
+from loguru import logger
+
+from solaredge2mqtt.models.base import EnumModel
+
+LOGGING_DEVICE_INFO = "{device} ({info.manufacturer} {info.model} {info.serialnumber})"
+
+
+class LoggingLevelEnum(EnumModel):
+    DEBUG = "DEBUG", logging.DEBUG
+    INFO = "INFO", logging.INFO
+    WARNING = "WARNING", logging.WARNING
+    ERROR = "ERROR", logging.ERROR
+    CRITICAL = "CRITICAL", logging.CRITICAL
+
+    def __init__(self, description: str, level: int):
+        # pylint: disable=super-init-not-called
+        self._description: str = description
+        self._level: int = level
+
+    @property
+    def description(self) -> str:
+        return self._description
+
+    @property
+    def level(self) -> int:
+        return self._level
+
+
+def initialize_logging(logging_level: LoggingLevelEnum) -> None:
+    logger.configure(handlers=[{"sink": sys.stdout, "level": logging_level.level}])

solaredge2mqtt-0.1.1/solaredge2mqtt/core/settings.py

@@ -0,0 +1,72 @@
+from pydantic import Field
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+from solaredge2mqtt.core.logging import LoggingLevelEnum
+from solaredge2mqtt.models.base import EnumModel
+
+
+class ServiceSettings(BaseSettings):
+    environment: str = "production"
+
+    modbus_host: str
+    modbus_port: int = Field(1502)
+    modbus_timeout: int = Field(1)
+    modbus_unit: int = Field(1)
+
+    client_id: str = Field("solaredge2mqtt")
+    broker: str
+    port: int = Field(1883)
+    username: str
+    password: str
+    topic_prefix: str = Field("solaredge")
+
+    interval: int = Field(5)
+
+    logging_level: LoggingLevelEnum = LoggingLevelEnum.INFO
+
+    model_config = SettingsConfigDict(
+        env_file=".env",
+        env_prefix="se2mqtt_",
+    )
+
+
+class DevelopmentSettings(ServiceSettings):
+    debug: bool = Field(True)
+
+    environment: str = "development"
+
+    model_config = SettingsConfigDict(
+        env_file=".env",
+        env_prefix="se2mqtt_",
+    )
+
+
+class ServiceEnvironment(EnumModel):
+    PROD = "production", ServiceSettings
+    DEV = "development", DevelopmentSettings
+
+    def __init__(self, description: str, settings_class: ServiceSettings):
+        # pylint: disable=super-init-not-called
+        self._description: str = description
+        self._settings_class: ServiceSettings = settings_class
+
+    @property
+    def description(self) -> str:
+        return self._description
+
+    @property
+    def settings_class(self) -> ServiceSettings:
+        return self._settings_class
+
+
+class ServiceBaseSettings(BaseSettings):
+    environment: ServiceEnvironment = ServiceEnvironment.PROD
+
+    model_config = SettingsConfigDict(
+        env_file=".env", env_prefix="se2mqtt_", extra="ignore"
+    )
+
+
+def service_settings() -> ServiceSettings:
+    environment = ServiceBaseSettings().environment
+    return environment.settings_class()

solaredge2mqtt-0.1.1/solaredge2mqtt/models/__init__.py

@@ -0,0 +1,15 @@
+from pydantic import BaseModel
+
+
+class PowerFlow(BaseModel):
+    pv_production: int
+    inverter: int
+    inverter_consumption: int
+    inverter_delivery: int
+    house_consumption: int
+    grid: int
+    grid_consumption: int
+    grid_delivery: int
+    battery: int
+    battery_charge: int
+    battery_discharge: int

solaredge2mqtt-0.1.1/solaredge2mqtt/models/base.py

@@ -0,0 +1,32 @@
+from enum import Enum
+from pydantic import model_serializer
+
+
+class EnumModel(Enum):
+    def __new__(cls, *args):
+        obj = object.__new__(cls)
+        obj._value_ = args[0]
+        return obj
+
+    def __str__(self) -> str:
+        return str(self._value_)
+
+    def __repr__(self) -> str:
+        return str(self._value_)
+
+    def __eq__(self, obj) -> bool:
+        return isinstance(obj, self.__class__) and self.value == obj.value
+
+    def __hash__(self):
+        return hash(self.value)
+
+    @classmethod
+    def from_string(cls, value: str):
+        for item in cls.__members__.values():
+            if item.value == value:
+                return item
+        raise ValueError(f"No enum value {value} found.")
+
+    @model_serializer
+    def serialize(self):
+        return self.value