poolcop 0.0.1__tar.gz

poolcop-0.0.1/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2023 Sander Striker
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

poolcop-0.0.1/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.1
+Name: poolcop
+Version: 0.0.1
+Summary: Asynchronous Python client for the PoolCopilot API
+Home-page: https://github.com/sstriker/python-poolcop
+License: Apache-2.0
+Keywords: poolcop,poolcopilot,api,async,client
+Author: Sander Striker
+Author-email: s.striker@striker.nl
+Maintainer: Sander Striker
+Maintainer-email: s.striker@striker.nl
+Requires-Python: >=3.10,<4.0
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: aiohttp (>=3.0.0)
+Requires-Dist: yarl (>=1.6.0)
+Project-URL: Bug Tracker, https://github.com/sstriker/python-poolcop/issues
+Project-URL: Changelog, https://github.com/sstriker/python-poolcop/releases
+Project-URL: Documentation, https://github.com/sstriker/python-poolcop
+Project-URL: Repository, https://github.com/sstriker/python-poolcop
+Description-Content-Type: text/markdown
+
+Asynchronous Python client for the [PoolCopilot API][poolcopilot-api].
+
+## About
+
+A python package to interact with a [PoolCop][poolcop] device.
+
+## Installation
+
+```bash
+pip install poolcop
+```
+
+## Usage
+
+```python
+import asyncio
+import json
+from poolcop import PoolCopilot
+
+API_KEY="xxxxxxxxxxxxxxxxxxxxxxx"
+
+async def main() -> None:
+    """Show example on fetching the status from PoolCop."""
+    async with PoolCopilot(api_key=API_KEY) as client:
+        status = await client.status()
+    print(json.dumps(status, indent=2))
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+[poolcop]: https://www.poolcop.com/
+[poolcopilot-api]: https://poolcopilot.com/api/docs/
+

poolcop-0.0.1/README.md

@@ -0,0 +1,33 @@
+Asynchronous Python client for the [PoolCopilot API][poolcopilot-api].
+
+## About
+
+A python package to interact with a [PoolCop][poolcop] device.
+
+## Installation
+
+```bash
+pip install poolcop
+```
+
+## Usage
+
+```python
+import asyncio
+import json
+from poolcop import PoolCopilot
+
+API_KEY="xxxxxxxxxxxxxxxxxxxxxxx"
+
+async def main() -> None:
+    """Show example on fetching the status from PoolCop."""
+    async with PoolCopilot(api_key=API_KEY) as client:
+        status = await client.status()
+    print(json.dumps(status, indent=2))
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+[poolcop]: https://www.poolcop.com/
+[poolcopilot-api]: https://poolcopilot.com/api/docs/

poolcop-0.0.1/poolcop/__init__.py

@@ -0,0 +1,17 @@
+"""Asynchronous Python client for the PoolCopilot API (https://poolcopilot.com/api/docs/)."""
+
+from .poolcop import PoolCopilot
+from .exceptions import (
+    PoolCopilotConnectionError,
+    PoolCopilotError,
+    PoolCopilotInvalidKeyError,
+    PoolCopilotRateLimitError,
+)
+
+__all__ = [
+    "PoolCopilot",
+    "PoolCopilotConnectionError",
+    "PoolCopilotError",
+    "PoolCopilotInvalidKeyError",
+    "PoolCopilotRateLimitError",
+]

poolcop-0.0.1/poolcop/const.py

@@ -0,0 +1,6 @@
+"""Constants for PoolCopilot API client."""
+from importlib import metadata
+from typing import Final
+
+API_HOST: Final = "poolcopilot.com"
+USER_AGENT: Final = f"python-poolcop/{metadata.version(__package__)}"

poolcop-0.0.1/poolcop/exceptions.py

@@ -0,0 +1,17 @@
+"""Exceptions for PoolCopilot API client."""
+
+
+class PoolCopilotError(Exception):
+    """Generic PoolCopilot exception."""
+
+
+class PoolCopilotConnectionError(PoolCopilotError):
+    """PoolCopilot - Connection error."""
+
+
+class PoolCopilotInvalidKeyError(PoolCopilotError):
+    """PoolCopilot - API Key invalid."""
+
+
+class PoolCopilotRateLimitError(PoolCopilotError):
+    """PoolCopilot - Rate limit reached."""

poolcop-0.0.1/poolcop/poolcop.py

@@ -0,0 +1,237 @@
+"""Asynchronous client for the PoolCopilot API."""
+from __future__ import annotations
+
+import asyncio
+import socket
+import time
+from dataclasses import dataclass
+from typing import Any, cast
+
+import async_timeout
+from http import HTTPStatus
+from aiohttp.client import ClientError, ClientResponseError, ClientSession
+from aiohttp.hdrs import METH_GET, METH_POST
+from yarl import URL
+
+from .const import API_HOST, USER_AGENT
+from .exceptions import (
+    PoolCopilotConnectionError,
+    PoolCopilotInvalidKeyError,
+    PoolCopilotRateLimitError,
+    PoolCopilotError,
+)
+
+
+@dataclass
+class PoolCopilot:
+    """Main class for handling data fetching from PoolCopilot."""
+
+    api_key: str | None = None
+    request_timeout: float = 10.0
+    session: ClientSession | None = None
+
+    _close_session: bool = False
+    _token: str = None
+    _token_expire: int = 0
+    _token_limit: int | None = None
+    _poolcop_id: int | None = None
+
+    @property
+    def poolcop_id(self):
+        """Primary PoolCop Identifier"""
+        return self._poolcop_id
+
+    def _build_url(self, uri):
+        return URL.build(scheme="https", host=API_HOST, path=f"/api/v1/{uri}")
+
+    def _headers(self):
+        headers = {
+            "Accept": "application/json",
+            "User-Agent": USER_AGENT,
+        }
+        if self._token is not None:
+            headers["PoolCop-Token"] = self._token
+        return headers
+
+    async def _authenticate(self) -> None:
+        """Authenticate and store a token"""
+
+        expire_in = self._token_expire - time.time()
+        if self._token is not None and expire_in > 0:
+            # Valid token
+            return
+
+        self._token = None
+        self._token_limit = None
+        try:
+            async with async_timeout.timeout(self.request_timeout):
+                response = await self.session.post(
+                    self._build_url("token"),
+                    data={"APIKEY": self.api_key},
+                    headers=self._headers(),
+                    ssl=True,
+                )
+                response.raise_for_status()
+        except asyncio.TimeoutError as exception:
+            raise PoolCopilotConnectionError(
+                "Timeout occurred while connecting to the API."
+            ) from exception
+        except ClientResponseError as exception:
+            if exception.code == HTTPStatus.FORBIDDEN:
+                raise PoolCopilotInvalidKeyError(
+                    "Could not authenticate with the provided API key."
+                ) from exception
+            raise PoolCopilotConnectionError(
+                "Error occurred while communicating with the API."
+            ) from exception
+        except (ClientError, socket.gaierror) as exception:
+            raise PoolCopilotConnectionError(
+                "Error occurred while communicating with the API."
+            ) from exception
+
+        data = await response.json()
+
+        self._token = data.get("token", None)
+        if self._token is None:
+            raise PoolCopilotInvalidKeyError(
+                "Could not authenticate with the provided API key."
+            )
+        # self._parse_token(data.get("values", {"max_limit": 1}))
+
+    def _parse_token(self, api_token):
+        self._token_limit = int(api_token.get("max_limit", 0))
+        self._token_expire = int(api_token.get("expire", 0))
+        self._poolcop_id = api_token.get("poolcop_id", self._poolcop_id)
+
+    async def _request(
+        self,
+        uri: str,
+        *,
+        method: str = METH_GET,
+        params: dict[str, Any] | None = None,
+    ) -> Any:
+        """Handle a request to the API of PoolCopilot.
+
+        Args:
+        ----
+            uri: Request URI, without leading '/', e.g. 'status'
+            method: HTTP method to use, e.g. 'GET'
+
+        Returns:
+        -------
+            A Python dictionary (json) with the response from PoolCopilot.
+
+        Raises:
+        ------
+            PoolCopilotConnectionError: An error occurred while
+                communicating with the API.
+            PoolCopilotRateLimitError: The request limit for
+                the API token was exceeded.
+            PoolCopilotError: Received an unexpected response from
+                the API.
+        """
+
+        if self.session is None:
+            self.session = ClientSession()
+            self._close_session = True
+
+        await self._authenticate()
+
+        if self._token_limit == 0:
+            raise PoolCopilotRateLimitError("Rate limit hit")
+
+        try:
+            async with async_timeout.timeout(self.request_timeout):
+                response = await self.session.request(
+                    method,
+                    self._build_url(uri),
+                    headers=self._headers(),
+                    ssl=True,
+                )
+                response.raise_for_status()
+        except asyncio.TimeoutError as exception:
+            msg = "Timeout occurred while connecting to the API."
+            raise PoolCopilotConnectionError(
+                msg,
+            ) from exception
+        except (ClientError, socket.gaierror) as exception:
+            msg = "Error occurred while communicating with the API."
+            raise PoolCopilotConnectionError(
+                msg,
+            ) from exception
+
+        content_type = response.headers.get("Content-Type", "")
+        if "application/json" not in content_type:
+            text = await response.text()
+            msg = "Unexpected content type response from the PoolCopilot API"
+            raise PoolCopilotError(
+                msg,
+                {"Content-Type": content_type, "response": text},
+            )
+
+        data = cast(dict[str, Any], await response.json())
+        self._parse_token(data.get("api_token", {}))
+        return data
+
+    async def status(self) -> dict[str, Any]:
+        """Get PoolCop status."""
+        data = await self._request(
+            "status",
+        )
+        return data
+
+    async def alarm_history(self, offset: int = 0) -> dict[str, Any]:
+        """Get PoolCop alarm history."""
+        data = await self._request(
+            f"history/alarms/{offset}",
+        )
+        return data
+
+    async def command_history(self, offset: int = 0) -> dict[str, Any]:
+        """Get PoolCop command history."""
+        return await self._request(f"history/commands/{offset}")
+
+    async def toggle_pump(self) -> dict[str, Any]:
+        """Toggle pump on/off."""
+        return await self._request("command/pump", method=METH_POST)
+
+    async def set_pump_speed(self, speed: int) -> dict[str, Any]:
+        """Set pump to a certain speed."""
+        assert speed in {1, 2, 3}
+        return await self._request(f"command/pump/{speed}", method=METH_POST)
+
+    async def toggle_aux(self, aux_id: int) -> dict[str, Any]:
+        """Toggle aux on/off."""
+        return await self._request("command/aux/{aux_id}", method=METH_POST)
+
+    async def clear_alarm(self) -> dict[str, Any]:
+        """Clear alarm."""
+        return await self._request("command/clear_alarm", method=METH_POST)
+
+    async def set_valve_position(self, position: int) -> dict[str, Any]:
+        """Set valve in a certain position."""
+        return await self._request("command/valve/{position}", method=METH_POST)
+
+    async def close(self) -> None:
+        """Close open client session."""
+        if self.session and self._close_session:
+            await self.session.close()
+            self.session = None
+
+    async def __aenter__(self) -> PoolCopilot:
+        """Async enter.
+
+        Returns
+        -------
+            The PoolCopilot object.
+        """
+        return self
+
+    async def __aexit__(self, *_exc_info: Any) -> None:
+        """Async exit.
+
+        Args:
+        ----
+            _exc_info: Exec type.
+        """
+        await self.close()

poolcop-0.0.1/pyproject.toml

@@ -0,0 +1,38 @@
+[tool.poetry]
+name = "poolcop"
+version = "0.0.1"
+description = "Asynchronous Python client for the PoolCopilot API"
+authors = ["Sander Striker <s.striker@striker.nl>"]
+maintainers = ["Sander Striker <s.striker@striker.nl>"]
+license = "Apache-2.0"
+readme = "README.md"
+homepage = "https://github.com/sstriker/python-poolcop"
+repository = "https://github.com/sstriker/python-poolcop"
+documentation = "https://github.com/sstriker/python-poolcop"
+keywords = ["poolcop", "poolcopilot", "api", "async", "client"]
+classifiers = [
+    "Framework :: AsyncIO",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+packages = [
+    { include = "poolcop" }
+]
+
+[tool.poetry.dependencies]
+aiohttp = ">=3.0.0"
+python = "^3.10"
+yarl = ">=1.6.0"
+
+[tool.poetry.urls]
+"Bug Tracker" = "https://github.com/sstriker/python-poolcop/issues"
+Changelog = "https://github.com/sstriker/python-poolcop/releases"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"