pykoplenti 1.2.2__py3-none-any.whl → 1.4.0__py3-none-any.whl

pykoplenti/api.py

@@ -13,17 +13,16 @@ import warnings
 
 from Crypto.Cipher import AES
 from aiohttp import ClientResponse, ClientSession, ClientTimeout
-from pydantic import parse_obj_as
 from yarl import URL
 
 from .model import (
     EventData,
     MeData,
     ModuleData,
-    ProcessData,
     ProcessDataCollection,
     SettingsData,
     VersionData,
+    process_data_list,
 )
 
 _logger: Final = logging.getLogger(__name__)
@@ -86,6 +85,20 @@ class ModuleNotFoundException(ApiException):
         self.error = error
 
 
+def _relogin(fn):
+    """Decorator for automatic re-login if session was expired."""
+
+    @functools.wraps(fn)
+    async def _wrapper(self: "ApiClient", *args, **kwargs):
+        with contextlib.suppress(AuthenticationException, NotAuthorizedException):
+            return await fn(self, *args, **kwargs)
+        _logger.debug("Request failed - try to re-login")
+        await self._login()
+        return await fn(self, *args, **kwargs)
+
+    return _wrapper
+
+
 class ApiClient(contextlib.AbstractAsyncContextManager):
     """Client for the REST-API of Kostal Plenticore inverters.
 
@@ -265,7 +278,7 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
         client_signature = hmac.new(
             stored_key, auth_msg.encode("utf-8"), hashlib.sha256
         ).digest()
-        client_proof = bytes([a ^ b for a, b in zip(client_key, client_signature)])
+        client_proof = bytes(a ^ b for a, b in zip(client_key, client_signature))
 
         server_key = hmac.new(
             salted_passwd, "Server Key".encode("utf-8"), hashlib.sha256
@@ -343,47 +356,32 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
         """Check if the given response contains an error and throws
         the appropriate exception."""
 
-        if resp.status != 200:
-            try:
-                response = await resp.json()
-                error = response["message"]
-            except Exception:
-                error = None
-
-            if resp.status == 400:
-                raise AuthenticationException(resp.status, error)
+        if resp.status == 200:
+            return
 
-            if resp.status == 401:
-                raise NotAuthorizedException(resp.status, error)
-
-            if resp.status == 403:
-                raise UserLockedException(resp.status, error)
+        try:
+            response = await resp.json()
+            error = response["message"]
+        except Exception:
+            error = None
 
-            if resp.status == 404:
-                raise ModuleNotFoundException(resp.status, error)
+        if resp.status == 400:
+            raise AuthenticationException(resp.status, error)
 
-            if resp.status == 503:
-                raise InternalCommunicationException(resp.status, error)
+        if resp.status == 401:
+            raise NotAuthorizedException(resp.status, error)
 
-            # we got an undocumented status code
-            raise ApiException(f"Unknown API response [{resp.status}] - {error}")
+        if resp.status == 403:
+            raise UserLockedException(resp.status, error)
 
-    @staticmethod
-    def _relogin(fn):
-        """Decorator for automatic re-login if session was expired."""
+        if resp.status == 404:
+            raise ModuleNotFoundException(resp.status, error)
 
-        @functools.wraps(fn)
-        async def _wrapper(self, *args, **kwargs):
-            try:
-                return await fn(self, *args, **kwargs)
-            except (AuthenticationException, NotAuthorizedException):
-                pass
+        if resp.status == 503:
+            raise InternalCommunicationException(resp.status, error)
 
-            _logger.debug("Request failed - try to re-login")
-            await self._login()
-            return await fn(self, *args, **kwargs)
-
-        return _wrapper
+        # we got an undocumented status code
+        raise ApiException(f"Unknown API response [{resp.status}] - {error}")
 
     async def logout(self):
         """Logs the current user out."""
@@ -422,7 +420,7 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
         if lang is None:
             lang = locale.getlocale()[0]
 
-        language = lang[0:2].lower()
+        language = lang[:2].lower()
         variant = lang[3:5].lower()
         if language not in ApiClient.SUPPORTED_LANGUAGES.keys():
             # Fallback to default
@@ -466,38 +464,33 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
         self,
         module_id: str,
         processdata_id: str,
-    ) -> Mapping[str, ProcessDataCollection]:
-        ...
+    ) -> Mapping[str, ProcessDataCollection]: ...
 
     @overload
     async def get_process_data_values(
         self,
         module_id: str,
         processdata_id: Iterable[str],
-    ) -> Mapping[str, ProcessDataCollection]:
-        ...
+    ) -> Mapping[str, ProcessDataCollection]: ...
 
     @overload
     async def get_process_data_values(
         self,
         module_id: str,
-    ) -> Mapping[str, ProcessDataCollection]:
-        ...
+    ) -> Mapping[str, ProcessDataCollection]: ...
 
     @overload
     async def get_process_data_values(
         self,
         module_id: Mapping[str, Iterable[str]],
-    ) -> Mapping[str, ProcessDataCollection]:
-        ...
+    ) -> Mapping[str, ProcessDataCollection]: ...
 
     @overload
     async def get_process_data_values(
         self,
         module_id: Union[str, Mapping[str, Iterable[str]]],
         processdata_id: Union[str, Iterable[str], None] = None,
-    ) -> Mapping[str, ProcessDataCollection]:
-        ...
+    ) -> Mapping[str, ProcessDataCollection]: ...
 
     @_relogin
     async def get_process_data_values(
@@ -523,7 +516,7 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
                 data_response = await resp.json()
                 return {
                     data_response[0]["moduleid"]: ProcessDataCollection(
-                        parse_obj_as(list[ProcessData], data_response[0]["processdata"])
+                        process_data_list(data_response[0]["processdata"])
                     )
                 }
 
@@ -536,7 +529,7 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
                 data_response = await resp.json()
                 return {
                     data_response[0]["moduleid"]: ProcessDataCollection(
-                        parse_obj_as(list[ProcessData], data_response[0]["processdata"])
+                        process_data_list(data_response[0]["processdata"])
                     )
                 }
 
@@ -552,7 +545,7 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
                 data_response = await resp.json()
                 return {
                     data_response[0]["moduleid"]: ProcessDataCollection(
-                        parse_obj_as(list[ProcessData], data_response[0]["processdata"])
+                        process_data_list(data_response[0]["processdata"])
                     )
                 }
 
@@ -562,7 +555,7 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
             for mid, pids in module_id.items():
                 # the json encoder expects that iterables are either list or tuples,
                 # other types has to be converted
-                if isinstance(pids, list) or isinstance(pids, tuple):
+                if isinstance(pids, (list, tuple)):
                     request.append(dict(moduleid=mid, processdataids=pids))
                 else:
                     request.append(dict(moduleid=mid, processdataids=list(pids)))
@@ -574,7 +567,7 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
                 data_response = await resp.json()
                 return {
                     x["moduleid"]: ProcessDataCollection(
-                        parse_obj_as(List[ProcessData], x["processdata"])
+                        process_data_list(x["processdata"])
                     )
                     for x in data_response
                 }
@@ -588,9 +581,9 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
             response = await resp.json()
             result: Dict[str, List[SettingsData]] = {}
             for module in response:
-                id = module["moduleid"]
-                data = list([SettingsData(**x) for x in module["settings"]])
-                result[id] = data
+                mid = module["moduleid"]
+                data = [SettingsData(**x) for x in module["settings"]]
+                result[mid] = data
 
             return result
 
@@ -599,30 +592,26 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
         self,
         module_id: str,
         setting_id: str,
-    ) -> Mapping[str, Mapping[str, str]]:
-        ...
+    ) -> Mapping[str, Mapping[str, str]]: ...
 
     @overload
     async def get_setting_values(
         self,
         module_id: str,
         setting_id: Iterable[str],
-    ) -> Mapping[str, Mapping[str, str]]:
-        ...
+    ) -> Mapping[str, Mapping[str, str]]: ...
 
     @overload
     async def get_setting_values(
         self,
         module_id: str,
-    ) -> Mapping[str, Mapping[str, str]]:
-        ...
+    ) -> Mapping[str, Mapping[str, str]]: ...
 
     @overload
     async def get_setting_values(
         self,
         module_id: Mapping[str, Iterable[str]],
-    ) -> Mapping[str, Mapping[str, str]]:
-        ...
+    ) -> Mapping[str, Mapping[str, str]]: ...
 
     @_relogin
     async def get_setting_values(
@@ -672,12 +661,11 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
             for mid, pids in module_id.items():
                 # the json encoder expects that iterables are either list or tuples,
                 # other types has to be converted
-                if isinstance(pids, list) or isinstance(pids, tuple):
+                if isinstance(pids, (list, tuple)):
                     request.append(dict(moduleid=mid, settingids=pids))
                 else:
                     request.append(dict(moduleid=mid, settingids=list(pids)))
 
-
             async with self._session_request(
                 "settings", method="POST", json=request
             ) as resp:
@@ -696,7 +684,7 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
         request = [
             {
                 "moduleid": module_id,
-                "settings": list([dict(value=v, id=k) for k, v in values.items()]),
+                "settings": [dict(value=v, id=k) for k, v in values.items()],
             }
         ]
         async with self._session_request(

pykoplenti/cli.py

@@ -1,13 +1,16 @@
 from ast import literal_eval
 import asyncio
 from collections import defaultdict
+from dataclasses import dataclass
 from inspect import iscoroutinefunction
 import os
+from pathlib import Path
 from pprint import pprint
 import re
 import tempfile
 import traceback
-from typing import Any, Awaitable, Callable, Dict, Union
+from typing import Any, Awaitable, Callable, Dict, Optional, Union
+import warnings
 
 from aiohttp import ClientSession, ClientTimeout
 import click
@@ -20,40 +23,43 @@ from pykoplenti.extended import ExtendedApiClient
 class SessionCache:
     """Persistent the session in a temporary file."""
 
-    def __init__(self, host):
-        self.host = host
+    def __init__(self, host: str, user: str):
+        self._cache_file = Path(
+            tempfile.gettempdir(), f"pykoplenti-session-{host}-{user}"
+        )
 
     def read_session_id(self) -> Union[str, None]:
-        file = os.path.join(tempfile.gettempdir(), f"pykoplenti-session-{self.host}")
-        if os.path.isfile(file):
-            with open(file, "rt") as f:
+        if self._cache_file.is_file():
+            with self._cache_file.open("rt") as f:
                 return f.readline(256)
         else:
             return None
 
     def write_session_id(self, id: str):
-        file = os.path.join(tempfile.gettempdir(), f"pykoplenti-session-{self.host}")
-        f = os.open(file, os.O_WRONLY | os.O_TRUNC | os.O_CREAT, mode=0o600)
+        f = os.open(self._cache_file, os.O_WRONLY | os.O_TRUNC | os.O_CREAT, mode=0o600)
         try:
             os.write(f, id.encode("ascii"))
         finally:
             os.close(f)
 
+    def remove(self):
+        self._cache_file.unlink(missing_ok=True)
+
 
 class ApiShell:
     """Provides a shell-like access to the inverter."""
 
-    def __init__(self, client: ApiClient):
+    def __init__(self, client: ApiClient, user: str):
         super().__init__()
         self.client = client
-        self._session_cache = SessionCache(self.client.host)
+        self._session_cache = SessionCache(self.client.host, user)
 
-    async def prepare_client(self, passwd):
+    async def prepare_client(self, key: Optional[str], service_code: Optional[str]):
         # first try to reuse existing session
         session_id = self._session_cache.read_session_id()
         if session_id is not None:
             self.client.session_id = session_id
-            print_formatted_text("Trying to reuse existing session... ", end=None)
+            print_formatted_text("Trying to reuse existing session... ", end="")
             me = await self.client.get_me()
             if me.is_authenticated:
                 print_formatted_text("Success")
@@ -61,18 +67,21 @@ class ApiShell:
 
             print_formatted_text("Failed")
 
-        if passwd is not None:
-            print_formatted_text("Logging in... ", end=None)
-            await self.client.login(passwd)
-            self._session_cache.write_session_id(self.client.session_id)
+        if key is not None:
+            print_formatted_text("Logging in... ", end="")
+            await self.client.login(key=key, service_code=service_code)
+            if self.client.session_id is not None:
+                self._session_cache.write_session_id(self.client.session_id)
             print_formatted_text("Success")
+        else:
+            print_formatted_text("Session could not be reused and no key given")
 
     def print_exception(self):
         """Prints an excpetion from executing a method."""
         print_formatted_text(traceback.format_exc())
 
-    async def run(self, passwd):
-        session = PromptSession()
+    async def run(self, key: Optional[str], service_code: Optional[str]):
+        session = PromptSession[str]()
         print_formatted_text(flush=True)  # Initialize output
 
         # Test commands:
@@ -83,7 +92,7 @@ class ApiShell:
         # get_setting_values 'scb:time'
         # set_setting_values 'devices:local' {'Battery:MinSoc':'15'}
 
-        await self.prepare_client(passwd)
+        await self.prepare_client(key, service_code)
 
         while True:
             try:
@@ -153,82 +162,171 @@ class ApiShell:
             self.print_exception()
 
 
-async def repl_main(host, port, passwd):
+async def repl_main(
+    host: str, port: int, key: Optional[str], service_code: Optional[str]
+):
     async with ClientSession(timeout=ClientTimeout(total=10)) as session:
         client = ExtendedApiClient(session, host=host, port=port)
 
-        shell = ApiShell(client)
-        await shell.run(passwd)
+        shell = ApiShell(client, "user" if service_code is None else "master")
+        await shell.run(key, service_code)
 
 
 async def command_main(
-    host: str, port: int, passwd: str, fn: Callable[[ApiClient], Awaitable[Any]]
+    host: str,
+    port: int,
+    key: Optional[str],
+    service_code: Optional[str],
+    fn: Callable[[ApiClient], Awaitable[Any]],
 ):
     async with ClientSession(timeout=ClientTimeout(total=10)) as session:
         client = ExtendedApiClient(session, host=host, port=port)
-        session_cache = SessionCache(host)
+        session_cache = SessionCache(host, "user" if service_code is None else "master")
 
         # Try to reuse an existing session
         client.session_id = session_cache.read_session_id()
         me = await client.get_me()
         if not me.is_authenticated:
+            if key is None:
+                raise ValueError("Could not reuse session and no login key is given.")
+
             # create a new session
-            await client.login(passwd)
+            await client.login(key=key, service_code=service_code)
+
             if client.session_id is not None:
                 session_cache.write_session_id(client.session_id)
 
         await fn(client)
 
 
+@dataclass
 class GlobalArgs:
     """Global arguments over all sub commands."""
 
-    def __init__(self):
-        self.host = None
-        self.port = None
-        self.password = None
-        self.password_file = None
+    host: str = ""
+    """The hostname or ip of the inverter."""
+
+    port: int = 0
+    """The port on which the API listens on the inverter."""
+
+    key: Optional[str] = None
+    """The key (password or master key) to login into the API.
+
+    If None, a previous session cache is used. If the session
+    cache has no valid session, no login is executed.
+    """
+
+    service_code: Optional[str] = None
+    """The service code for master access.
+
+    Only necessary for master access. If missing, user acess is used.
+    """
 
 
 pass_global_args = click.make_pass_decorator(GlobalArgs, ensure=True)
 
 
+def _parse_credentials_file(path: Path) -> tuple[Optional[str], Optional[str]]:
+    """Parse credentials file returning (key, service_code)"""
+    key = service_code = None
+    for line in path.read_text().splitlines():
+        if "=" not in line:
+            return line.strip(), None
+
+        name, _, value = line.partition("=")
+        name = name.strip()
+        if name in ("password", "key", "master-key"):
+            key = value.strip()
+        elif name == "service-code":
+            service_code = value.strip()
+    return key, service_code
+
+
 @click.group()
-@click.option("--host", help="hostname or ip of the inverter")
-@click.option("--port", default=80, help="port of the inverter (default 80)")
-@click.option("--password", default=None, help="the password")
+@click.option("--host", help="Hostname or IP of the inverter")
+@click.option("--port", default=80, help="Port of the inverter", show_default=True)
+@click.option(
+    "--password", default=None, help="Password or master key (also device id)"
+)
+@click.option("--service-code", default=None, help="service code for installer access")
 @click.option(
     "--password-file",
     default="secrets",
-    help='password file (default "secrets" in the current working directory)',
+    help="Path to password file - deprecated, use --credentials",
+    show_default=True,
+    type=click.Path(exists=False, dir_okay=False, readable=True, path_type=Path),
+)
+@click.option(
+    "--credentials",
+    default=None,
+    help="Path to the credentials file. This has a simple ini-format without sections. "
+    "For user access, use the 'password'. For installer access, use the 'master-key' "
+    "and 'service-key'.",
+    type=click.Path(exists=True, dir_okay=False, readable=True, path_type=Path),
 )
 @pass_global_args
-def cli(global_args, host, port, password, password_file):
+def cli(
+    global_args: GlobalArgs,
+    host: str,
+    port: int,
+    password: Optional[str],
+    service_code: Optional[str],
+    password_file: Path,
+    credentials: Path,
+):
     """Handling of global arguments with click"""
-    if password is not None:
-        global_args.passwd = password
-    elif os.path.isfile(password_file):
-        with open(password_file, "rt") as f:
-            global_args.passwd = f.readline()
-    else:
-        global_args.passwd = None
-
     global_args.host = host
     global_args.port = port
 
+    if password is not None:
+        global_args.key = password
+    elif password_file.is_file():
+        with password_file.open("rt") as f:
+            global_args.key = f.readline()
+        warnings.warn(
+            "--password-file is deprecated. Use --credentials instead.",
+            DeprecationWarning,
+        )
+
+    if service_code is not None:
+        global_args.service_code = service_code
+
+    if credentials is not None:
+        if password is not None:
+            raise click.BadOptionUsage(
+                "password", "password cannot be used with credentials"
+            )
+        if password_file is not None and password_file.is_file():
+            raise click.BadOptionUsage(
+                "password-file", "password-file cannot be used with credentials"
+            )
+        if service_code is not None:
+            raise click.BadOptionUsage(
+                "service_code", "service_code cannot be used with credentials"
+            )
+
+        global_args.key, global_args.service_code = _parse_credentials_file(credentials)
+
 
 @cli.command()
 @pass_global_args
-def repl(global_args):
+def repl(global_args: GlobalArgs):
     """Provides a simple REPL for executing API requests to the inverter."""
-    asyncio.run(repl_main(global_args.host, global_args.port, global_args.passwd))
+    asyncio.run(
+        repl_main(
+            global_args.host,
+            global_args.port,
+            global_args.key,
+            global_args.service_code,
+        )
+    )
 
 
 @cli.command()
 @click.option("--lang", default=None, help="language for events")
 @click.option("--count", default=10, help="number of events to read")
 @pass_global_args
-def read_events(global_args, lang, count):
+def read_events(global_args: GlobalArgs, lang, count):
     """Returns the last events"""
 
     async def fn(client: ApiClient):
@@ -236,11 +334,17 @@ def read_events(global_args, lang, count):
         for event in data:
             print(
                 f"{event.is_active < 5} {event.start_time} {event.end_time} "
-                "{event.description}"
+                f"{event.description}"
             )
 
     asyncio.run(
-        command_main(global_args.host, global_args.port, global_args.passwd, fn)
+        command_main(
+            global_args.host,
+            global_args.port,
+            global_args.key,
+            global_args.service_code,
+            fn,
+        )
     )
 
 
@@ -254,20 +358,26 @@ def read_events(global_args, lang, count):
 @click.option("--begin", type=click.DateTime(["%Y-%m-%d"]), help="first day to export")
 @click.option("--end", type=click.DateTime(["%Y-%m-%d"]), help="last day to export")
 @pass_global_args
-def download_log(global_args, out, begin, end):
+def download_log(global_args: GlobalArgs, out, begin, end):
     """Download the log data from the inverter to a file."""
 
     async def fn(client: ApiClient):
         await client.download_logdata(writer=out, begin=begin, end=end)
 
     asyncio.run(
-        command_main(global_args.host, global_args.port, global_args.passwd, fn)
+        command_main(
+            global_args.host,
+            global_args.port,
+            global_args.key,
+            global_args.service_code,
+            fn,
+        )
     )
 
 
 @cli.command()
 @pass_global_args
-def all_processdata(global_args):
+def all_processdata(global_args: GlobalArgs):
     """Returns a list of all available process data."""
 
     async def fn(client: ApiClient):
@@ -277,14 +387,20 @@ def all_processdata(global_args):
                 print(f"{k}/{x}")
 
     asyncio.run(
-        command_main(global_args.host, global_args.port, global_args.passwd, fn)
+        command_main(
+            global_args.host,
+            global_args.port,
+            global_args.key,
+            global_args.service_code,
+            fn,
+        )
     )
 
 
 @cli.command()
 @click.argument("ids", required=True, nargs=-1)
 @pass_global_args
-def read_processdata(global_args, ids):
+def read_processdata(global_args: GlobalArgs, ids):
     """Returns the values of the given process data.
 
     IDS is the identifier (<module_id>/<processdata_id>) of one or more processdata
@@ -318,7 +434,13 @@ def read_processdata(global_args, ids):
                 print(f"{k}/{x.id}={x.value}")
 
     asyncio.run(
-        command_main(global_args.host, global_args.port, global_args.passwd, fn)
+        command_main(
+            global_args.host,
+            global_args.port,
+            global_args.key,
+            global_args.service_code,
+            fn,
+        )
     )
 
 
@@ -327,7 +449,7 @@ def read_processdata(global_args, ids):
     "--rw", is_flag=True, default=False, help="display only writable settings"
 )
 @pass_global_args
-def all_settings(global_args, rw):
+def all_settings(global_args: GlobalArgs, rw: bool):
     """Returns the ids of all settings."""
 
     async def fn(client: ApiClient):
@@ -338,14 +460,20 @@ def all_settings(global_args, rw):
                     print(f"{k}/{x.id}")
 
     asyncio.run(
-        command_main(global_args.host, global_args.port, global_args.passwd, fn)
+        command_main(
+            global_args.host,
+            global_args.port,
+            global_args.key,
+            global_args.service_code,
+            fn,
+        )
     )
 
 
 @cli.command()
 @click.argument("ids", required=True, nargs=-1)
 @pass_global_args
-def read_settings(global_args, ids):
+def read_settings(global_args: GlobalArgs, ids):
     """Read the value of the given settings.
 
     IDS is the identifier (<module_id>/<setting_id>) of one or more settings to read
@@ -376,14 +504,20 @@ def read_settings(global_args, ids):
                 print(f"{k}/{i}={v}")
 
     asyncio.run(
-        command_main(global_args.host, global_args.port, global_args.passwd, fn)
+        command_main(
+            global_args.host,
+            global_args.port,
+            global_args.key,
+            global_args.service_code,
+            fn,
+        )
     )
 
 
 @cli.command()
 @click.argument("id_values", required=True, nargs=-1)
 @pass_global_args
-def write_settings(global_args, id_values):
+def write_settings(global_args: GlobalArgs, id_values):
     """Write the values of the given settings.
 
     ID_VALUES is the identifier plus the the value to write
@@ -412,7 +546,13 @@ def write_settings(global_args, id_values):
             await client.set_setting_values(module_id, setting_values)
 
     asyncio.run(
-        command_main(global_args.host, global_args.port, global_args.passwd, fn)
+        command_main(
+            global_args.host,
+            global_args.port,
+            global_args.key,
+            global_args.service_code,
+            fn,
+        )
     )
 
 

pykoplenti/model.py

@@ -1,6 +1,7 @@
 from datetime import datetime
-from typing import Iterator, Mapping
+from typing import Final, Iterator, Mapping, Optional
 
+import pydantic
 from pydantic import BaseModel, Field
 
 
@@ -55,7 +56,7 @@ class ProcessDataCollection(Mapping):
         try:
             return next(x for x in self._process_data if x.id == item)
         except StopIteration:
-            raise KeyError(item)
+            raise KeyError(item) from None
 
     def __eq__(self, __other: object) -> bool:
         if not isinstance(__other, ProcessDataCollection):
@@ -77,11 +78,11 @@ class ProcessDataCollection(Mapping):
 class SettingsData(BaseModel):
     """Represents a single settings data."""
 
-    min: str | None
-    max: str | None
-    default: str | None
+    min: Optional[str]
+    max: Optional[str]
+    default: Optional[str]
     access: str
-    unit: str | None
+    unit: Optional[str]
     id: str
     type: str
 
@@ -97,3 +98,24 @@ class EventData(BaseModel):
     description: str
     group: str
     is_active: bool
+
+
+# pydantic version specific code
+# In pydantic 2.x `parse_obj_as` is no longer supported. To stay compatible to
+# both version a small wrapper function is used.
+
+if pydantic.VERSION.startswith("2."):
+    from pydantic import TypeAdapter
+
+    _process_list_adapter: Final = TypeAdapter(list[ProcessData])
+
+    def process_data_list(json) -> list[ProcessData]:
+        """Process json as a list of ProcessData objects."""
+        return _process_list_adapter.validate_python(json)
+
+else:
+    from pydantic import parse_obj_as
+
+    def process_data_list(json) -> list[ProcessData]:
+        """Process json as a list of ProcessData objects."""
+        return parse_obj_as(list[ProcessData], json)

{pykoplenti-1.2.2.dist-info → pykoplenti-1.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: pykoplenti
-Version: 1.2.2
+Version: 1.4.0
 Summary: Python REST-Client for Kostal Plenticore Solar Inverters
 Home-page: https://github.com/stegm/pyclient_koplenti
 Author: @stegm
@@ -13,17 +13,20 @@ Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: aiohttp ~=3.8
-Requires-Dist: pycryptodome ~=3.19
-Requires-Dist: pydantic ~=1.10
+Requires-Dist: aiohttp~=3.8
+Requires-Dist: pycryptodome~=3.19
+Requires-Dist: pydantic>=1.10
 Provides-Extra: cli
-Requires-Dist: prompt-toolkit >=3.0 ; extra == 'cli'
-Requires-Dist: click >=7.1 ; extra == 'cli'
+Requires-Dist: prompt_toolkit>=3.0; extra == "cli"
+Requires-Dist: click>=8.0; extra == "cli"
+Dynamic: license-file
 
 # Python Library for Accessing Kostal Plenticore Inverters
 
@@ -75,22 +78,28 @@ Installing the libray with `CLI` provides a new command.
 
 ```shell
 $ pykoplenti --help
-Usage: pykoplenti [OPTIONS] COMMAND [ARGS]...
+Usage: python -m pykoplenti.cli [OPTIONS] COMMAND [ARGS]...
 
   Handling of global arguments with click
 
 Options:
-  --host TEXT           hostname or ip of the inverter
-  --port INTEGER        port of the inverter (default 80)
-  --password TEXT       the password
-  --password-file TEXT  password file (default "secrets" in the current
-                        working directory)
-
+  --host TEXT           Hostname or IP of the inverter
+  --port INTEGER        Port of the inverter  [default: 80]
+  --password TEXT       Password or master key (also device id)
+  --service-code TEXT   service code for installer access
+  --password-file FILE  Path to password file - deprecated, use --credentials
+                        [default: secrets]
+  --credentials FILE    Path to the credentials file. This has a simple ini-
+                        format without sections. For user access, use the
+                        'password'. For installer access, use the 'master-key'
+                        and 'service-key'.
   --help                Show this message and exit.
 
 Commands:
   all-processdata   Returns a list of all available process data.
   all-settings      Returns the ids of all settings.
+  download-log      Download the log data from the inverter to a file.
+  read-events       Returns the last events
   read-processdata  Returns the values of the given process data.
   read-settings     Read the value of the given settings.
   repl              Provides a simple REPL for executing API requests to...
@@ -155,9 +164,11 @@ await client.login(my_master_key, service_code=my_service_code)
 - [click](https://click.palletsprojects.com/) - command line interface framework
 - [black](https://github.com/psf/black) - Python code formatter
 - [ruff](https://github.com/astral-sh/ruff) - Python linter
+- [pydantic](https://docs.pydantic.dev/latest/) - Data validation library
 - [pytest](https://docs.pytest.org/) - Python test framework
 - [mypy](https://mypy-lang.org/) - Python type checker
 - [setuptools](https://github.com/pypa/setuptools) - Python packager
+- [tox](https://tox.wiki) - Automate testing
 
 ## License
 

pykoplenti-1.4.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+pykoplenti/__init__.py,sha256=w9ooy6_JaT9lGvMDAaBHyvYu1uTFTkb1g21WRxp3Kzw,756
+pykoplenti/api.py,sha256=ViT25KQt3caH78fO30G014IawcWQ1lMvy28M9QLBypg,26111
+pykoplenti/cli.py,sha256=AIc2sdzEAhexYwU8C9UTQvKtu0gPYiEnz8fJDcEILI4,17042
+pykoplenti/extended.py,sha256=_MCDtP-6BaAiTFqJ44CLK_Ihkh6nCC0vWWv1lsQfEFs,9311
+pykoplenti/model.py,sha256=lFOHDJvWyhOdQrcoun6HeT-4XaGY5I2gy1j6M5u3u6A,3016
+pykoplenti/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pykoplenti-1.4.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+pykoplenti-1.4.0.dist-info/METADATA,sha256=elvtTQ9SMFTl29_j_WHUaboSpmdlCc49T1iv7ciH5Ms,6356
+pykoplenti-1.4.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+pykoplenti-1.4.0.dist-info/entry_points.txt,sha256=Ix-p1uzKNyOMTK0TOlAC0nsfWS6ATXVuaNDJ5-TwBJw,56
+pykoplenti-1.4.0.dist-info/top_level.txt,sha256=Bi915FGIFYzCujwn5Kwhu3B-sxElgc7gX3gNaYjl4j8,11
+pykoplenti-1.4.0.dist-info/RECORD,,

{pykoplenti-1.2.2.dist-info → pykoplenti-1.4.0.dist-info}/WHEEL

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

pykoplenti-1.2.2.dist-info/RECORD

@@ -1,12 +0,0 @@
-pykoplenti/__init__.py,sha256=w9ooy6_JaT9lGvMDAaBHyvYu1uTFTkb1g21WRxp3Kzw,756
-pykoplenti/api.py,sha256=gYWWd8yZ9winj7qPt1-rzx4stX_DLPfy5nOduuamtH4,26431
-pykoplenti/cli.py,sha256=LAiQHlSgoJz07kTtFh0bNyahyYz7gCenhRfradex5wE,12972
-pykoplenti/extended.py,sha256=_MCDtP-6BaAiTFqJ44CLK_Ihkh6nCC0vWWv1lsQfEFs,9311
-pykoplenti/model.py,sha256=g-KyYTF1M1p6OAebyA74OAP_-561u6Hylhgy_jnpMto,2266
-pykoplenti/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pykoplenti-1.2.2.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-pykoplenti-1.2.2.dist-info/METADATA,sha256=YCvoky9ow6vbvRA_qTQpbkm3hMHvMAwnpewjjQmBuGc,5625
-pykoplenti-1.2.2.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
-pykoplenti-1.2.2.dist-info/entry_points.txt,sha256=Ix-p1uzKNyOMTK0TOlAC0nsfWS6ATXVuaNDJ5-TwBJw,56
-pykoplenti-1.2.2.dist-info/top_level.txt,sha256=Bi915FGIFYzCujwn5Kwhu3B-sxElgc7gX3gNaYjl4j8,11
-pykoplenti-1.2.2.dist-info/RECORD,,