gridx-connector 1.0.1__tar.gz

gridx_connector-1.0.1/LICENSE

@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2019 Marvin Pinto and contributors
+
+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.

gridx_connector-1.0.1/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: gridx-connector
+Version: 1.0.1
+Summary: Connector for GridX to fetch live data from your Photovoltaic System
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: authlib
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+# Gridx Connector
+
+### **<h3 style="text-align: center;">This is not an Offical Gridx Library</h3>**
+
+Harness the power of your photovoltaic system with the GridboxConnector library. This versatile tool taps into the same REST API as the official dashboard and app, providing you with direct access to your data from the cloud.<br>
+
+Whether you're a developer looking to integrate solar data into your own project, or a power user seeking command-line access, GridboxConnector has you covered. With its dual functionality, you can either embed it into your Python project as a library or use it as a standalone command-line interface (CLI) tool.<br>
+
+**Take control of your solar data with GridboxConnector, and unlock the full potential of your photovoltaic system.**<br><br>
+![Screenshot vom mygridbox](images/screenshot.png)
+
+## Supported Realms
+* Viessmann (will shutdown end of 2025)
+* eon Home
+
+## Installation
+
+```script shell
+pip install gridx-connector
+```
+
+## Usage
+
+You can use the CLI to retrieve live data from the Viessmann Gridbox API or use the GridboxConnector class in your own code. <br>
+Use your Login data from the App or from https://company.gridx.de/login
+
+### CLI
+
+```script shell
+pip install gridx-connector
+viessmann --username <username> --password <password>
+```
+
+### in your code
+
+```python
+from gridx_connector import GridboxConnector
+from importlib.resources import files
+import json
+from supported_oem import SupportedOEM
+
+config_file = files('gridx_connector').joinpath(f'{oem}.config.json')
+with open(config_file, 'r') as file:
+    data = json.load(file)
+    data["login"]["username"] = username
+    data["login"]["password"] = password
+    connector = GridboxConnector(data)
+    # Retrieve live data
+    live_data = connector.retrieve_live_data()
+    return live_data
+```
+
+### Example Output
+
+```script json
+{
+    "consumption": 496,
+    "directConsumption": 413,
+    "directConsumptionEV": 0,
+    "directConsumptionHeatPump": 0,
+    "directConsumptionHeater": 0,
+    "directConsumptionHousehold": 413,
+    "directConsumptionRate": 1,
+    "grid": 83,
+    "gridMeterReadingNegative": 4318200000,
+    "gridMeterReadingPositive": 14499360000,
+    "measuredAt": "2023-08-04T11:29:43Z",
+    "photovoltaic": 413,
+    "production": 413,
+    "selfConsumption": 413,
+    "selfConsumptionRate": 1,
+    "selfSufficiencyRate": 0.8326612903225806,
+    "selfSupply": 413,
+    "totalConsumption": 496
+}
+```
+
+## Dependencies
+
+- requests
+
+## Contributing
+
+If you'd like to contribute to gridx-connector, please follow these steps:
+
+Fork the repository.
+Create a new branch for your feature or bug fix.
+Make your changes and write tests if possible.
+Run tests and ensure they pass.
+Submit a pull request.
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

gridx_connector-1.0.1/README.md

@@ -0,0 +1,94 @@
+# Gridx Connector
+
+### **<h3 style="text-align: center;">This is not an Offical Gridx Library</h3>**
+
+Harness the power of your photovoltaic system with the GridboxConnector library. This versatile tool taps into the same REST API as the official dashboard and app, providing you with direct access to your data from the cloud.<br>
+
+Whether you're a developer looking to integrate solar data into your own project, or a power user seeking command-line access, GridboxConnector has you covered. With its dual functionality, you can either embed it into your Python project as a library or use it as a standalone command-line interface (CLI) tool.<br>
+
+**Take control of your solar data with GridboxConnector, and unlock the full potential of your photovoltaic system.**<br><br>
+![Screenshot vom mygridbox](images/screenshot.png)
+
+## Supported Realms
+* Viessmann (will shutdown end of 2025)
+* eon Home
+
+## Installation
+
+```script shell
+pip install gridx-connector
+```
+
+## Usage
+
+You can use the CLI to retrieve live data from the Viessmann Gridbox API or use the GridboxConnector class in your own code. <br>
+Use your Login data from the App or from https://company.gridx.de/login
+
+### CLI
+
+```script shell
+pip install gridx-connector
+viessmann --username <username> --password <password>
+```
+
+### in your code
+
+```python
+from gridx_connector import GridboxConnector
+from importlib.resources import files
+import json
+from supported_oem import SupportedOEM
+
+config_file = files('gridx_connector').joinpath(f'{oem}.config.json')
+with open(config_file, 'r') as file:
+    data = json.load(file)
+    data["login"]["username"] = username
+    data["login"]["password"] = password
+    connector = GridboxConnector(data)
+    # Retrieve live data
+    live_data = connector.retrieve_live_data()
+    return live_data
+```
+
+### Example Output
+
+```script json
+{
+    "consumption": 496,
+    "directConsumption": 413,
+    "directConsumptionEV": 0,
+    "directConsumptionHeatPump": 0,
+    "directConsumptionHeater": 0,
+    "directConsumptionHousehold": 413,
+    "directConsumptionRate": 1,
+    "grid": 83,
+    "gridMeterReadingNegative": 4318200000,
+    "gridMeterReadingPositive": 14499360000,
+    "measuredAt": "2023-08-04T11:29:43Z",
+    "photovoltaic": 413,
+    "production": 413,
+    "selfConsumption": 413,
+    "selfConsumptionRate": 1,
+    "selfSufficiencyRate": 0.8326612903225806,
+    "selfSupply": 413,
+    "totalConsumption": 496
+}
+```
+
+## Dependencies
+
+- requests
+
+## Contributing
+
+If you'd like to contribute to gridx-connector, please follow these steps:
+
+Fork the repository.
+Create a new branch for your feature or bug fix.
+Make your changes and write tests if possible.
+Run tests and ensure they pass.
+Submit a pull request.
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

gridx_connector-1.0.1/gridx_connector/GridboxConnector.py

@@ -0,0 +1,133 @@
+import requests
+import time
+import logging
+import os
+from authlib.integrations.requests_client import OAuth2Session
+class GridboxConnector:
+    id_token: str = ""
+    gateways: list[str] = []
+    token: dict = {}
+    client: OAuth2Session = None
+    config: dict = {}
+    username: str = ""
+    password: str = ""
+
+    def __init__(self, config, logger=None):
+        if not logger:
+            self.init_logging()
+        self.config = config
+        self.login_url = config["urls"]["login"]
+        self.login_body = config["login"]
+        self.gateway_url = config["urls"]["gateways"]
+        self.live_url = config["urls"]["live"]
+        self.historical_url = config["urls"]["historical"]
+        self.username = os.getenv('USERNAME', self.login_body["username"])
+        self.password = os.getenv('PASSWORD', self.login_body["password"])
+        self.init_auth()
+
+    def init_logging(self):
+        self.logger = logging.getLogger(__name__)
+        formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(funcName)s - %(message)s')
+        console_handler = logging.StreamHandler()
+        console_handler.setFormatter(formatter)
+        self.logger.addHandler(console_handler)
+    
+    def set_loglevel(self, loglevel):
+        self.logger.setLevel(logging.getLevelName(loglevel))
+    
+    def get_new_token(self):
+        self.token = self.client.fetch_token(
+            self.login_url,
+            username=self.login_body["username"],
+            password=self.login_body["password"],
+            grant_type=self.login_body['grant_type'],
+            audience=self.login_body['audience'],
+            realm=self.login_body['realm'],
+            scope=self.login_body['scope']
+        )
+        self.logger.debug(f"Token expires at {self.token['expires_at']}")
+    
+    # Funktion zum Überprüfen und Erneuern des Tokens
+    def ensure_valid_token(self):
+        # Prüfe, ob das Token abgelaufen ist
+        expires_at = self.token.get('expires_at')
+        if expires_at is None or expires_at < time.time():
+            self.logger.info("Token ist abgelaufen oder nicht vorhanden, erneuern...")
+            self.get_new_token()  
+
+    def get_header(self):
+        self.ensure_valid_token()
+        return {"Authorization": f'Bearer {self.token["id_token"]}'}    
+    
+    def init_auth(self):
+        client_id = self.login_body["client_id"]
+        client_secret = self.login_body["client_secret"]
+        self.client = OAuth2Session(client_id, client_secret, scope=self.login_body["scope"])
+        self.get_new_token()
+        self.get_gateway_id()
+
+    def get_gateway_id(self):
+        self.gateways.clear()
+        try:
+            response = requests.get(self.gateway_url, headers=self.get_header())
+            response_json = response.json()
+            for gateway in response_json:
+                self.gateways.append(gateway["system"]["id"])
+        except Exception as e:
+            self.logger.error(e)
+            time.sleep(60)
+            self.get_gateway_id()
+
+    def get_gateways(self):
+        return self.gateways
+
+    def retrieve_live_data_by_id(self, id):
+        try:
+            response = requests.get(self.live_url.format(id), headers=self.get_header())
+            if response.status_code == 200:
+                return response
+            else:
+                self.logger.warning(f"Status Code {response.status_code} with response {response.json()}")
+                return response
+        except Exception as e:
+            self.logger.error(e)
+
+    def retrieve_live_data(self):
+        responses = []
+        for id in self.gateways:
+            try:
+                response = self.retrieve_live_data_by_id(id)
+                if response.status_code == 200:
+                    response_json = response.json()
+                    responses.append(response_json)
+            except Exception as e:
+                self.logger.error(e)
+        return responses
+
+    def retrieve_historical_data_by_id(self, id, start, end, resolution='15m'):
+        interval = f"{start}/{end}"
+        import urllib.parse
+        encoded_string = urllib.parse.quote(interval)
+        self.historical_url_created = self.historical_url.format(id, encoded_string, resolution)
+        try:
+            response = requests.get(self.historical_url_created, headers=self.get_header())
+            if response.status_code == 200:
+                return response
+            else:
+                self.logger.warning("Requested url {}".format(self.historical_url_created))
+                self.logger.warning(f"Status Code {response.status_code} with response {response.json()}")
+                return response
+        except Exception as e:
+            self.logger.error(e)
+    
+    def retrieve_historical_data(self, start, end, resolution='15m'):
+        responses = []
+        for id in self.gateways:
+            try:
+                response = self.retrieve_historical_data_by_id(id, start, end, resolution)
+                if response.status_code == 200:
+                    response_json = response.json()
+                    responses.append(response_json)
+            except Exception as e:
+                self.logger.error(e)
+        return responses

gridx_connector-1.0.1/gridx_connector/__init__.py

@@ -0,0 +1 @@
+from .GridboxConnector import GridboxConnector

gridx_connector-1.0.1/gridx_connector/cli.py

@@ -0,0 +1,29 @@
+import argparse
+from gridx_connector import GridboxConnector
+from importlib.resources import files
+import json
+from supported_oem import SupportedOEM
+
+def retrieve_live_data(username: str, password: str, oem: str = SupportedOEM.VIESSMANN):
+    config_file = files('gridx_connector').joinpath(f'{oem}.config.json')
+    with open(config_file, 'r') as file:
+        data = json.load(file)
+        data["login"]["username"] = username
+        data["login"]["password"] = password
+        connector = GridboxConnector(data)
+        # Retrieve live data
+        live_data = connector.retrieve_live_data()
+        return live_data
+
+def main():
+    parser = argparse.ArgumentParser(description='Retrieve live data from GridX Gridbox.')
+    parser.add_argument('-u', '--username', required=True, help='The username to use.')
+    parser.add_argument('-p', '--password', required=True, help='The password to use.')
+    parser.add_argument('-o', '--oem', default=SupportedOEM.VIESSMANN, help='The OEM configuration to use.', choices=[SupportedOEM.VIESSMANN, SupportedOEM.EON_HOME])
+    args = parser.parse_args()
+
+    live_data = retrieve_live_data(args.username, args.password, args.oem)
+    print(live_data)
+
+if __name__ == '__main__':
+    main()

gridx_connector-1.0.1/gridx_connector/eon-home.config.json

@@ -0,0 +1,18 @@
+{
+  "urls": {
+    "login": "https://gridx.eu.auth0.com/oauth/token",
+    "gateways": "https://api.gridx.de/gateways",
+    "live": "https://api.gridx.de/systems/{}/live",
+    "historical": "https://api.gridx.de/systems/{}/historical?interval={}&resolution={}"
+  },
+  "login": {
+    "grant_type": "http://auth0.com/oauth/grant-type/password-realm",
+    "username": "username",
+    "password": "password!",
+    "audience": "my.gridx",
+    "client_id": "mG0Phmo7DmnvAqO7p6B0WOYBODppY3cc",
+    "scope": "email openid offline_access",
+    "realm": "eon-home-authentication-db",
+    "client_secret": ""
+  }
+}

gridx_connector-1.0.1/gridx_connector/supported_oem.py

@@ -0,0 +1,3 @@
+class SupportedOEM:
+    VIESSMANN = "viessmann" # Will depracted in future
+    EON_HOME = "eon-home"

gridx_connector-1.0.1/gridx_connector/viessmann.config.json

@@ -0,0 +1,18 @@
+{
+  "urls": {
+    "login": "https://gridx.eu.auth0.com/oauth/token",
+    "gateways": "https://api.gridx.de/gateways",
+    "live": "https://api.gridx.de/systems/{}/live",
+    "historical": "https://api.gridx.de/systems/{}/historical?interval={}&resolution={}"
+  },
+  "login": {
+    "grant_type": "http://auth0.com/oauth/grant-type/password-realm",
+    "username": "username",
+    "password": "password!",
+    "audience": "my.gridx",
+    "client_id": "oZpr934Ikn8OZOHTJEcrgXkjio0I0Q7b",
+    "scope": "email openid",
+    "realm": "viessmann-authentication-db",
+    "client_secret": ""
+  }
+}

gridx_connector-1.0.1/gridx_connector.egg-info/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: gridx-connector
+Version: 1.0.1
+Summary: Connector for GridX to fetch live data from your Photovoltaic System
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: authlib
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+# Gridx Connector
+
+### **<h3 style="text-align: center;">This is not an Offical Gridx Library</h3>**
+
+Harness the power of your photovoltaic system with the GridboxConnector library. This versatile tool taps into the same REST API as the official dashboard and app, providing you with direct access to your data from the cloud.<br>
+
+Whether you're a developer looking to integrate solar data into your own project, or a power user seeking command-line access, GridboxConnector has you covered. With its dual functionality, you can either embed it into your Python project as a library or use it as a standalone command-line interface (CLI) tool.<br>
+
+**Take control of your solar data with GridboxConnector, and unlock the full potential of your photovoltaic system.**<br><br>
+![Screenshot vom mygridbox](images/screenshot.png)
+
+## Supported Realms
+* Viessmann (will shutdown end of 2025)
+* eon Home
+
+## Installation
+
+```script shell
+pip install gridx-connector
+```
+
+## Usage
+
+You can use the CLI to retrieve live data from the Viessmann Gridbox API or use the GridboxConnector class in your own code. <br>
+Use your Login data from the App or from https://company.gridx.de/login
+
+### CLI
+
+```script shell
+pip install gridx-connector
+viessmann --username <username> --password <password>
+```
+
+### in your code
+
+```python
+from gridx_connector import GridboxConnector
+from importlib.resources import files
+import json
+from supported_oem import SupportedOEM
+
+config_file = files('gridx_connector').joinpath(f'{oem}.config.json')
+with open(config_file, 'r') as file:
+    data = json.load(file)
+    data["login"]["username"] = username
+    data["login"]["password"] = password
+    connector = GridboxConnector(data)
+    # Retrieve live data
+    live_data = connector.retrieve_live_data()
+    return live_data
+```
+
+### Example Output
+
+```script json
+{
+    "consumption": 496,
+    "directConsumption": 413,
+    "directConsumptionEV": 0,
+    "directConsumptionHeatPump": 0,
+    "directConsumptionHeater": 0,
+    "directConsumptionHousehold": 413,
+    "directConsumptionRate": 1,
+    "grid": 83,
+    "gridMeterReadingNegative": 4318200000,
+    "gridMeterReadingPositive": 14499360000,
+    "measuredAt": "2023-08-04T11:29:43Z",
+    "photovoltaic": 413,
+    "production": 413,
+    "selfConsumption": 413,
+    "selfConsumptionRate": 1,
+    "selfSufficiencyRate": 0.8326612903225806,
+    "selfSupply": 413,
+    "totalConsumption": 496
+}
+```
+
+## Dependencies
+
+- requests
+
+## Contributing
+
+If you'd like to contribute to gridx-connector, please follow these steps:
+
+Fork the repository.
+Create a new branch for your feature or bug fix.
+Make your changes and write tests if possible.
+Run tests and ensure they pass.
+Submit a pull request.
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

gridx_connector-1.0.1/gridx_connector.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+README.md
+setup.py
+gridx_connector/GridboxConnector.py
+gridx_connector/__init__.py
+gridx_connector/cli.py
+gridx_connector/eon-home.config.json
+gridx_connector/supported_oem.py
+gridx_connector/viessmann.config.json
+gridx_connector.egg-info/PKG-INFO
+gridx_connector.egg-info/SOURCES.txt
+gridx_connector.egg-info/dependency_links.txt
+gridx_connector.egg-info/entry_points.txt
+gridx_connector.egg-info/requires.txt
+gridx_connector.egg-info/top_level.txt

gridx_connector-1.0.1/gridx_connector.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

gridx_connector-1.0.1/gridx_connector.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+gridx = gridx_connector.cli:main

gridx_connector-1.0.1/gridx_connector.egg-info/requires.txt

@@ -0,0 +1,2 @@
+requests
+authlib

gridx_connector-1.0.1/gridx_connector.egg-info/top_level.txt

@@ -0,0 +1 @@
+gridx_connector

gridx_connector-1.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

gridx_connector-1.0.1/setup.py

@@ -0,0 +1,22 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='gridx-connector',
+    version='1.0.1',
+    long_description=open('README.md').read(),
+    long_description_content_type='text/markdown',
+    description="Connector for GridX to fetch live data from your Photovoltaic System",
+    packages=find_packages(),
+    install_requires=[
+        'requests',
+        'authlib'
+    ],
+    package_data={
+        'gridx_connector': ['eon-home.config.json','viessmann.config.json'],
+    },
+    entry_points={
+        'console_scripts': [
+            'gridx=gridx_connector.cli:main',
+        ],
+    },
+)