pyindrav2h 0.0.2__py3-none-any.whl

pyindrav2h/__init__.py

@@ -0,0 +1,7 @@
+__version__ = "0.0.2"
+
+V2H_MODES = {
+    'LOAD_MATCH': 'loadmatch',
+    'SCHEDULE': 'clear',
+    'IDLE': 'idle',
+}

pyindrav2h/cli.py

@@ -0,0 +1,75 @@
+import logging
+from getpass import getpass
+import argparse
+import configparser
+import asyncio
+import os
+from pyindrav2h.connection import Connection
+from pyindrav2h.v2hclient import v2hClient
+
+logging.basicConfig()
+logging.root.setLevel(logging.WARNING)
+
+_LOGGER = logging.getLogger(__name__)
+
+async def main(args):
+    userEmail = args.email or input("Please enter your Indra login email: ")
+    userPass = args.password or getpass(prompt="Indra password: ")
+
+    if args.debug:
+        logging.root.setLevel(logging.DEBUG)
+
+    _LOGGER.debug(f"using {userEmail}, {userPass}")
+
+    # create connection
+    conn = Connection(userEmail, userPass)
+    await conn.checkAPICreds()
+
+    client = v2hClient(conn)
+
+    # refresh device/stats data
+    await client.refresh()
+    
+    if (args.command == "device"):
+        print(client.device.showDevice())
+    elif (args.command == "statistics"):
+        print(client.device.showStats())
+    elif (args.command == "all"):
+        print(client.device.showAll())
+    elif (args.command == "loadmatch"):
+        print(await client.device.load_match())
+    elif (args.command == "idle"):
+        print(await client.device.idle())
+    elif (args.command == "schedule"):
+        print(await client.device.schedule())
+
+def cli():
+    config = configparser.ConfigParser()
+    config["indra-account"] = {"email": "", "password": ""}
+    config.read([".indra.cfg", os.path.expanduser("~/.indra.cfg")])
+    parser = argparse.ArgumentParser(prog="indracli", description="Indra V2H CLI")
+    parser.add_argument(
+        "-u",
+        "--email",
+        dest="email",
+        default=config.get("indra-account", "email"),
+    )
+    parser.add_argument(
+        "-p",
+        "--password",
+        dest="password",
+        default=config.get("indra-account", "password")
+    )
+    parser.add_argument("-d", "--debug", dest="debug", action="store_true")
+    subparsers = parser.add_subparsers(dest="command", required=True)
+    subparsers.add_parser("statistics", help="show device statistics")
+    subparsers.add_parser("device", help="show device info")
+    subparsers.add_parser("all", help="show all info")
+    subparsers.add_parser("loadmatch", help="set mode to load matching")
+    subparsers.add_parser("idle", help="set mode to IDLE")
+    subparsers.add_parser("schedule", help="return to scheuduled mode")
+
+    args = parser.parse_args()
+
+    loop = asyncio.get_event_loop()
+    loop.run_until_complete(main(args))

pyindrav2h/connection.py

@@ -0,0 +1,115 @@
+import logging
+import httpx
+from typing import Text
+from bs4 import BeautifulSoup as bs
+
+from .exceptions import V2HException
+from .exceptions import WrongCredentialsException
+from .exceptions import TimeoutException
+
+_LOGGER = logging.getLogger(__name__)
+
+loginUrl = "https://smartportal.indra.co.uk"
+apiBaseUrl = "https://api.indra.co.uk/api"
+
+class Connection:
+    def __init__(
+        self, userEmail: Text = None, userPass: Text = None, timeout: int = 20
+    ) -> None:
+        """Initialize connection object."""
+        self.timeout = timeout
+        self.email = userEmail
+        self.password = userPass
+        self._headers = {"User-Agent": "Wget/1.14 (linux-gnu)"}
+        self._xsrfToken = None
+        self._bearerToken = None
+        self._cookies = None
+        _LOGGER.debug("New connection created")
+
+    async def checkAPICreds(self):
+        self._xsrfToken = await self.getXsrf(loginUrl)
+        _LOGGER.debug(f"XSRF token: {self._xsrfToken}")
+        self._bearerToken = await self.getAuth("POST", "/login")
+        self._headers["Authorization"] = self._bearerToken
+        succ = {'success': 'True'}
+        if succ['success'] == False:
+            raise WrongCredentialsException()
+    
+    async def send(self, method, url, json=None):
+        # params = {'api_key': self.email, 'api_secret': self.password}
+        async with httpx.AsyncClient(
+            headers=self._headers, timeout=self.timeout
+        ) as httpclient:
+            # theUrl = apiBaseUrl + url
+            theUrl = url
+            try:
+                _LOGGER.debug(f"{method} {url} {theUrl}")
+                response = await httpclient.request(method, theUrl, json=json)
+            except httpx.ReadTimeout:
+                raise TimeoutException()
+            else:
+                if response.status_code == 200:
+                    return response.json()
+                elif response.status_code == 202:
+                    return True
+                elif response.status_code == 401:
+                    raise WrongCredentialsException()
+                raise V2HException(response.status_code)
+    
+    async def get(self, url, data=None):
+        url = apiBaseUrl + url
+        return await self.send("GET", url, data)
+    
+    async def post(self, url, data=None):
+        url = apiBaseUrl + url
+        return await self.send("POST", url, data)
+    
+    async def getXsrf(self, url, method = "GET"):
+        # loginResponse = await self.send("GET", url)
+        async with httpx.AsyncClient(
+            headers=self._headers, timeout=self.timeout
+        ) as httpclient:
+            theUrl = url
+            try:
+                _LOGGER.debug(f"{method} {url} {theUrl}")
+                response = await httpclient.request(method, theUrl)
+            except httpx.ReadTimeout:
+                raise TimeoutException()
+            else:
+                if response.status_code == 200:
+                    htmlBody = response.content
+                    self._cookies = response.cookies
+                    soup = bs(htmlBody, "lxml")
+                    return soup.find('input', {"name": "__RequestVerificationToken"})['value']
+                elif response.status_code == 401:
+                    raise WrongCredentialsException()
+                raise V2HException(response.status_code)
+    
+
+    async def getAuth(self, method, url, json=None):
+        data = {'user_email': self.email, 'user_password': self.password, '__RequestVerificationToken': self._xsrfToken}
+        async with httpx.AsyncClient(
+            headers=self._headers, timeout=self.timeout
+        ) as httpclient:
+            theUrl = loginUrl + url
+            try:
+                _LOGGER.debug(f"{method} {url} {theUrl}")
+                response = await httpclient.post(theUrl, data=data, cookies=self._cookies, follow_redirects=True)
+            except httpx.ReadTimeout:
+                raise TimeoutException()
+            else:
+                if response.status_code == 200:
+                    htmlBody = response.content
+                    self._cookies = response.cookies
+                    soup = bs(htmlBody, "lxml")
+                    jwtToken = soup.find('input', {"name": "JWTToken"})
+                    if jwtToken:
+                        return jwtToken['value']
+                    else:
+                        raise WrongCredentialsException()
+
+                    # _LOGGER.debug(f"RESPONSE: {response.text}")
+                    # return response.json()
+                elif response.status_code == 401:
+                    raise WrongCredentialsException()
+                raise V2HException(response.status_code)

pyindrav2h/exceptions.py

@@ -0,0 +1,27 @@
+import logging
+
+_LOGGER = logging.getLogger(__name__)
+
+class V2HException(Exception):
+    def __init__(self, code=None, *args, **kwargs):
+        self.message = ""
+        super().__init__(*args, **kwargs)
+        if code is not None:
+            self.code = code
+            if isinstance(code, str):
+                self.message = self.code
+                return
+            if self.code == 401:
+                self.message = "UNAUTHORIZED"
+            elif self.code == 404:
+                self.message = "NOT_FOUND"
+
+
+class WrongCredentialsException(V2HException):
+    """Class of exceptions for incomplete credentials."""
+    pass
+
+
+class TimeoutException(V2HException):
+    """Class of exceptions for incomplete credentials."""
+    pass

pyindrav2h/v2hclient.py

@@ -0,0 +1,23 @@
+import logging
+from .connection import Connection
+from .v2hdevice import v2hDevice
+
+_LOGGER = logging.getLogger(__name__)
+
+class v2hClient:
+    def __init__(
+        self, connection: Connection
+    ) -> None:
+        self._connection = connection
+        self._device = None
+
+    async def refresh(self):
+        if self._device is None:
+            self._device = v2hDevice(self._connection)
+
+        await self._device.refresh_device_info()
+        await self._device.refresh_stats()
+
+    @property
+    def device(self):
+        return self._device

pyindrav2h/v2hdevice.py

@@ -0,0 +1,146 @@
+import logging
+
+from .connection import Connection
+from . import V2H_MODES
+
+_LOGGER = logging.getLogger(__name__)
+
+class v2hDevice:
+    def __init__(self, connection: Connection) -> None:
+        self.connection = connection
+        self.data = {}
+        self.stats = {}
+        self.active = {}
+
+    async def refresh_device_info(self):
+        d = await self.connection.get("/authorize/validate")
+        self.data = d
+    
+    async def __set_mode(self, mode):
+        s = await self.connection.post("/transactions/" + self.id + 
+                                        "/interrupt/" + mode)
+        return s
+    
+    async def load_match(self):
+        return await self.__set_mode(V2H_MODES['LOAD_MATCH'])
+
+    async def idle(self):
+        return await self.__set_mode(V2H_MODES['IDLE'])       
+
+    async def schedule(self):
+        return await self.__set_mode(V2H_MODES['SCHEDULE'])  
+
+    async def refresh_stats(self):
+        s = await self.connection.get("/telemetry/devices/" + self.serial + 
+                                      "/latest")
+        self.stats = s
+        _LOGGER.debug(f"Stats: {s}")
+        a = await self.connection.get("/transactions/" + self.serial + 
+                                      "/00000000-0000-0000-0000-000000000000/active")
+        self.active = a
+
+    @property
+    def id(self):
+        return self.active["id"]
+
+    @property
+    def serial(self):
+        return self.data["devices"][0]["deviceUID"]
+
+    @property
+    def lastOn(self):
+        return self.data["lastOn"]
+
+    @property
+    def isActive(self):
+        return self.data["devices"][0]["active"]
+
+    @property
+    def updateTime(self):
+        return self.stats["time"]
+
+    @property
+    def isBoosting(self):
+        return self.stats["isBoosting"]
+
+    @property
+    def mode(self):
+        return self.stats["mode"]
+    
+    @property
+    def state(self):
+        return self.stats["state"]
+
+    @property
+    def activeEnergyFromEv(self):
+        return self.stats["data"]["activeEnergyFromEv"]
+
+    @property
+    def activeEnergyToEv(self):
+        return self.stats["data"]["activeEnergyToEv"]
+
+    @property
+    def powerToEv(self):
+        return self.stats["data"]["powerToEv"]
+
+    @property
+    def houseLoad(self):
+        return self.stats["data"]["ctClamp"]
+
+    @property
+    def current(self):
+        return self.stats["data"]["current"]
+
+    @property
+    def voltage(self):
+        return self.stats["data"]["voltage"]
+
+    @property
+    def freq(self):
+        return self.stats["data"]["freq"]
+
+    @property
+    def temperature(self):
+        return self.stats["data"]["temp"]
+
+    @property
+    def soc(self):
+        return self.stats["data"]["soc"]
+
+    @property
+    def isInterrupted(self):
+        return self.active["isInterrupted"]
+    
+    
+    def showDevice(self):
+        ret = ""
+        
+        ret = ret + "--- Device info ---\n"
+        ret = ret + f"Device UID: {self.serial}\n"
+        ret = ret + f"Last On date: {self.lastOn}\n"
+        ret = ret + f"Device active: {self.isActive}"
+
+        return ret
+
+    def showStats(self):
+        ret = ""
+
+        ret = ret + "--- Statistics ---\n"
+        ret = ret + f"Update time: {self.updateTime}\n"
+        ret = ret + f"Boost mode on?: {self.isBoosting}\n"
+        ret = ret + f"Mode: {self.mode}\n"
+        ret = ret + f"State: {self.state}\n"
+        ret = ret + f"Active Energy from EV: {self.activeEnergyFromEv}\n"
+        ret = ret + f"Active Energy to EV: {self.activeEnergyToEv}\n"
+        ret = ret + f"EV load + / discharge - (W): {self.powerToEv}\n"
+        ret = ret + f"House load + / Export - (W): {self.houseLoad}\n"
+        ret = ret + f"Current: {self.current}\n"
+        ret = ret + f"Voltage: {self.voltage}\n"
+        ret = ret + f"Frequency: {self.freq}\n"
+        ret = ret + f"Temperature: {self.temperature}\n"
+        ret = ret + f"Vehicle SoC: {self.soc}\n"
+        ret = ret + f"Schedule active?: {not self.isInterrupted}\n"
+        return ret
+
+    def showAll(self):
+        return self.showDevice() + "\n\n" + self.showStats()

pyindrav2h-0.0.2.dist-info/LICENSE

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

pyindrav2h-0.0.2.dist-info/METADATA

@@ -0,0 +1,121 @@
+Metadata-Version: 2.1
+Name: pyindrav2h
+Version: 0.0.2
+Summary: API client and example CLI to interact with Indra V2H Chargers
+Author-email: Paul Morris <paul@creatingwake.com>
+License: MIT License
+        
+        Copyright (c) 2024 creatingwake
+        
+        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/creatingwake/pyindrav2h
+Keywords: v2h,indra,v2g,v2x
+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: httpx
+Requires-Dist: bs4
+Requires-Dist: lxml
+
+
+# pyindrav2h
+
+A basic API client and example CLI to interact with Indra V2H Chargers.  Required by Home Assistant.
+
+This is a very early Alpha release, and functionality may change very rapidly.
+
+NOTE: Indra Renewable Technologies Limited are aware of this integration.  However, this is an unofficial integration and Indra are not able to provide support for direct API integrations.  The Indra API will likely change in future which may result in functionality provided by this integration failing at any time.
+
+
+
+## Installation
+
+Install pyindrav2h with pip.  Using venv is recommended.
+
+```bash
+  pip install pyindrav2h
+```
+to update pyindrav2h
+```bash
+  pip install pyindrav2h -U
+```
+On installation a CLI will become available: ```indracli```
+## Usage/Examples
+
+### CLI
+
+```bash
+usage: indracli [-h] [-u EMAIL] [-p PASSWORD] [-d]
+           {statistics,device,all,loadmatch,idle,schedule} ...
+
+Indra V2H CLI
+
+positional arguments:
+  {statistics,device,all,loadmatch,idle,schedule}
+    statistics          show device statistics
+    device              show device info
+    all                 show all info
+    loadmatch           set mode to load matching
+    idle                set mode to IDLE
+    schedule            return to scheuduled mode
+
+options:
+  -h, --help            show this help message and exit
+  -u EMAIL, --email EMAIL
+  -p PASSWORD, --password PASSWORD
+  -d, --debug
+```
+
+It is possible to provide a configuration file to provide Indra Smart Portal credentials.  If no username/email or password is provided it will be retrieved from ```./.indra.cfg``` or ```~/.indra.cfg```
+
+#### Example .indra.cfg Configuration file
+```
+[indra-account]
+email=useremail@email.com
+password=yourindrapassword
+```
+
+### Library Usage
+
+Intended for use with Indra V2H Home Assistant integration.
+Documentation to follow.
+
+## Support
+
+This is a community project that lacks formal support.
+
+
+For support from the community please join the Indra V2H trial support community: https://indra.v2h.zendesk.com/hc/en-gb/community/topics
+
+
+
+For bugs or feature requests please create a GitHub Issue: https://github.com/creatingwake/pyindrav2h/issues
+
+---
+#### NOTE: Please do not contact Indra Support.  Indra are unable to assist with unofficial API integrations.
+
+
+## Acknowledgements
+
+ - [trizmark](https://github.com/trizmark) for help with home assistant API integration examples
+
+

pyindrav2h-0.0.2.dist-info/RECORD

@@ -0,0 +1,12 @@
+pyindrav2h/__init__.py,sha256=8lYuQZCRvR83cx9sx2LnwHztWfwzwe_hiBNHeC2Cwes,114
+pyindrav2h/cli.py,sha256=qL_dzmbzxdG9bMMvnykaMBFp9RaWsFTVnfwEy-bSsVQ,2451
+pyindrav2h/connection.py,sha256=dlz4QBbTsHdGm-jaMSJ2DnYLef3Srw_L_KQLsufIfR0,4634
+pyindrav2h/exceptions.py,sha256=lTYAIIuKK9WOydQSetXghMl-y_3ajbV3T8WU5yXrAYM,746
+pyindrav2h/v2hclient.py,sha256=Qr4yjfJQ0QNv6GOO693ZMOOWOFPcDEUqvNFN8fksXQM,551
+pyindrav2h/v2hdevice.py,sha256=sBMPMkgECAVZk5L6KjHZ19N5aloZzmdjRg2r5QSa_p8,4066
+pyindrav2h-0.0.2.dist-info/LICENSE,sha256=oHutMahDk37Dtf6mzS7bfjn4KOF6e_sSB3-S2vns3vk,1068
+pyindrav2h-0.0.2.dist-info/METADATA,sha256=Xt3wUGD9lJLy27YngRFU7hGAZGOg1MzbTdSN0oTir7M,4183
+pyindrav2h-0.0.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+pyindrav2h-0.0.2.dist-info/entry_points.txt,sha256=htV_PSdnt-lyUBephTyTHnw0ztGpxKra_kffUYhPqVw,48
+pyindrav2h-0.0.2.dist-info/top_level.txt,sha256=9L6PkzDDQdqBnXPubaAtGsrkWs4GTVDQ-dvX4je0lzs,11
+pyindrav2h-0.0.2.dist-info/RECORD,,

pyindrav2h-0.0.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.43.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pyindrav2h-0.0.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+indracli = pyindrav2h.cli:cli

pyindrav2h-0.0.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+pyindrav2h