aioccl 2024.7__tar.gz

aioccl-2024.7/LICENSE

@@ -0,0 +1,201 @@
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 fkiscd@gmail.com
+
+   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.

aioccl-2024.7/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.1
+Name: aioccl
+Version: 2024.7
+Summary: A Python library for CCL API server
+Home-page: https://github.com/fkiscd/aioccl
+Download-URL: https://github.com/fkiscd/aioccl
+Author: fkiscd
+Author-email: fkiscd@gmail.com
+License: Apache License, Version 2.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Topic :: Home Automation
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>3
+Requires-Dist: aiohttp_cors>=0.7.0
+
+# aioCCL
+A Python library for CCL API server

aioccl-2024.7/README.md

@@ -0,0 +1,2 @@
+# aioCCL
+A Python library for CCL API server

aioccl-2024.7/aioccl/__init__.py

@@ -0,0 +1,5 @@
+"""aioEcoWitt API wrapper."""
+
+from .device import CCLDevice
+from .sensor import CCLSensor, CCLSensorTypes
+from .server import CCLServer

aioccl-2024.7/aioccl/device.py

@@ -0,0 +1,95 @@
+"""Mapping to create a CCL Device copy."""
+from __future__ import annotations
+
+import logging
+import time
+from typing import Callable
+
+from .sensor import CCLSensor
+
+_LOGGER = logging.getLogger(__name__)
+
+CCL_DEVICE_INFO_TYPES = ("serial_no", "mac_address", "model", "version")
+
+class CCLDevice:
+    def __init__(self, passkey: str):
+        """Initialize a CCL device."""
+        _LOGGER.debug('Initializing CCL Device: %s', self)
+        self._passkey = passkey
+        
+        self.serial_no: str | None
+        self.mac_address: str | None
+        self.model: str | None
+        self.version: str | None
+
+        self.last_updated_time: float = -10.0 # Offset
+        
+        self.sensors: dict[str, CCLSensor] | None = {}
+
+        self._new_sensors: list[CCLSensor] | None = []
+        
+        self._update_callbacks = set() 
+        self._new_sensor_callbacks = set()
+    
+    @property
+    def passkey(self) -> str:
+        return self._passkey
+    
+    @property
+    def device_id(self) -> str:
+        return self.mac_address.replace(":", "").lower()[-6:]
+    
+    def update_info(self, info: dict[str, None | str]) -> None:
+        """Add or update device info."""
+        self.serial_no = info.get('serial_no')
+        self.mac_address = info.get('mac_address')
+        self.model = info.get('model')
+        self.version = info.get('version')
+    
+    def update_sensors(self, sensors: dict[str, None | str | int | float]) -> None:
+        """Add or update all sensor values."""
+        for sensor, value in sensors.items():
+            if not self.sensors.get(sensor):
+                self.sensors[sensor] = CCLSensor(sensor)
+                self._new_sensors.append(self.sensors[sensor])
+            self.sensors[sensor].value = value
+        self._publish_new_sensors()
+        self._publish_updates()
+        self.last_updated_time = time.monotonic()
+        _LOGGER.debug("Sensors Updated: %s", self.last_updated_time)
+
+    def register_update_cb(self, callback: Callable[[], None]) -> None:
+        """Register callback, called when Sensor changes state."""
+        self._update_callbacks.add(callback)
+
+    def remove_update_cb(self, callback: Callable[[], None]) -> None:
+        """Remove previously registered callback."""
+        self._update_callbacks.discard(callback)
+
+    def _publish_updates(self) -> None:
+        """Schedule call all registered callbacks."""
+        try:
+            for callback in self._update_callbacks:
+                callback()
+        except Exception as err:
+            _LOGGER.warning("Error while publishing sensor updates: %s", err)
+
+    def register_new_sensor_cb(self, callback: Callable[[], None]) -> None:
+        """Register callback, called when Sensor changes state."""
+        self._new_sensor_callbacks.add(callback)
+
+    def remove_new_sensor_cb(self, callback: Callable[[], None]) -> None:
+        """Remove previously registered callback."""
+        self._new_sensor_callbacks.discard(callback)
+
+    def _publish_new_sensors(self) -> None:
+        """Schedule call all registered callbacks."""
+        try:
+            for sensor in self._new_sensors:
+                _LOGGER.debug("Publishing new sensor: %s", sensor)
+                _LOGGER.debug("Sensors remaining: %s", self._new_sensors)
+                for callback in self._new_sensor_callbacks:
+                    callback(sensor)
+            self._new_sensors.clear()
+        except Exception as err:
+            _LOGGER.warning("Error while publishing new sensors: %s", err)

aioccl-2024.7/aioccl/sensor.py

@@ -0,0 +1,49 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+import enum
+from typing import TypedDict
+
+class CCLSensor:
+    """Class that represents a CCLSensor object in the aioCCL API."""
+    
+    def __init__(self, key: str):
+        """Initialize a CCL sensor."""
+        self.value: None | str | int | float
+    
+        if key in CCL_SENSORS.keys():
+            self._key = key
+    
+    @property
+    def key(self):
+        return self._key
+    
+    @property
+    def name(self):
+        return CCL_SENSORS[self._key].name
+    
+    @property
+    def sensor_type(self):
+        return CCL_SENSORS[self._key].sensor_type
+
+@dataclass
+class CCLSensorPreset:
+    name: str
+    sensor_type: str
+    
+class CCLSensorTypes(enum.Enum):
+    PRESSURE = 1
+    TEMPERATURE = 2
+    HUMIDITY = 3
+    WIND_DIRECITON = 4
+    WIND_SPEED = 5
+    
+CCL_SENSORS: dict[str, CCLSensorPreset] = {
+    'rbar': CCLSensorPreset('Air Pressure', CCLSensorTypes.PRESSURE),
+    'intem': CCLSensorPreset('Indoor Temperature', CCLSensorTypes.TEMPERATURE),
+    'inhum': CCLSensorPreset('Indoor Humidity', CCLSensorTypes.HUMIDITY),
+    't1tem': CCLSensorPreset('Outdoor Temperature', CCLSensorTypes.TEMPERATURE),
+    't1hum': CCLSensorPreset('Outdoor Humidity', CCLSensorTypes.HUMIDITY),
+    't1wdir': CCLSensorPreset('Outdoor Wind Direction', CCLSensorTypes.WIND_DIRECITON),
+    't1ws': CCLSensorPreset('Outdoor Wind Speed', CCLSensorTypes.WIND_SPEED),
+}

aioccl-2024.7/aioccl/server.py

@@ -0,0 +1,112 @@
+"""CCL API server and handler."""
+from __future__ import annotations
+
+import asyncio
+import logging
+
+from aiohttp import web
+import aiohttp_cors
+
+from .device import CCLDevice, CCL_DEVICE_INFO_TYPES
+from .ccl_sensor import CCL_SENSORS
+
+_LOGGER = logging.getLogger(__name__)
+
+class CCLServer:
+    LISTEN_PORT = 42373
+    
+    devices: dict[str, CCLDevice] = {}
+    
+    def add_copy(device: CCLDevice) -> None:
+        """Attach a device copy to the server."""
+        CCLServer.devices.setdefault(device.passkey, device)
+        _LOGGER.debug(CCLServer.devices)
+
+    routes = web.RouteTableDef()
+
+    async def _handler(request: web.BaseRequest) -> web.Response:
+        """Handle POST requests for data updating."""
+        class HandlerStorage:
+            body: dict[str, None | str | int | float]
+            info: dict[str, None | str]
+            sensors: dict[str, None | str | int | float]
+        
+        _LOGGER.debug("Request received.")
+        
+        # Resetting variables
+        _device: CCLDevice = None
+
+        HandlerStorage.body = {}
+        HandlerStorage.info = {}
+        HandlerStorage.sensors = {}
+        
+        _status: None | int = None
+        _text: None | str = None
+        
+        try:
+            for passkey in CCLServer.devices:
+                if passkey == request.match_info['passkey']:
+                    _device = CCLServer.devices[passkey]
+                    break
+            assert _device, 404
+            
+            assert request.content_type == 'application/json', 400
+            assert 0 < request.content_length <= 5000, 400
+            
+            HandlerStorage.body = await request.json()
+            
+        except Exception as err:
+            _status = err.args[0]
+            if _status == 400: _text = "400 Bad Request"
+            elif _status == 404: _text = "404 Not Found"
+            else:
+                _status = 500
+                _text = "500 Internal Server Error"
+            _LOGGER.debug("Request exception occured: %s", err)
+        
+        else:
+            for key, value in HandlerStorage.body.items():
+                if key in CCL_DEVICE_INFO_TYPES:
+                    HandlerStorage.info.setdefault(key, value)
+                elif key in CCL_SENSORS.keys():
+                    HandlerStorage.sensors.setdefault(key, value)
+                    
+            _device.update_info(HandlerStorage.info)
+            _device.update_sensors(HandlerStorage.sensors)
+            _status = 200
+            _text = "200 OK"
+            _LOGGER.debug("Request processed.")
+        
+        finally:
+            return web.Response(status=_status, text=_text)
+
+    app = web.Application()
+
+    cors = aiohttp_cors.setup(app)
+
+    resource = cors.add(app.router.add_resource("/{passkey}"))
+    route = cors.add(
+        resource.add_route("POST", _handler), {
+            "*": aiohttp_cors.ResourceOptions(
+                allow_credentials=True,
+                expose_headers="*",
+                allow_headers="*",
+            )
+        })
+
+    async def run() -> None:
+        """Try to run the API server in case none is available."""
+        try:
+            _LOGGER.debug("Trying to start the API server.")
+            runner = web.AppRunner(CCLServer.app)
+            await runner.setup()
+            site = web.TCPSite(runner, port=CCLServer.LISTEN_PORT)
+            await site.start()
+        except Exception as err:
+            _LOGGER.warning("Failed to run the API server: %s", err)
+        else:
+            _LOGGER.debug("Successfully started the API server.")
+
+    async def stop() -> None:
+        """Stop running the API server."""
+        await CCLServer.runner.cleanup()

aioccl-2024.7/aioccl.egg-info/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.1
+Name: aioccl
+Version: 2024.7
+Summary: A Python library for CCL API server
+Home-page: https://github.com/fkiscd/aioccl
+Download-URL: https://github.com/fkiscd/aioccl
+Author: fkiscd
+Author-email: fkiscd@gmail.com
+License: Apache License, Version 2.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Topic :: Home Automation
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>3
+Requires-Dist: aiohttp_cors>=0.7.0
+
+# aioCCL
+A Python library for CCL API server

aioccl-2024.7/aioccl.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+setup.cfg
+setup.py
+aioccl/__init__.py
+aioccl/device.py
+aioccl/sensor.py
+aioccl/server.py
+aioccl.egg-info/PKG-INFO
+aioccl.egg-info/SOURCES.txt
+aioccl.egg-info/dependency_links.txt
+aioccl.egg-info/requires.txt
+aioccl.egg-info/top_level.txt

aioccl-2024.7/aioccl.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

aioccl-2024.7/aioccl.egg-info/requires.txt

@@ -0,0 +1,2 @@
+aiohttp>3
+aiohttp_cors>=0.7.0

aioccl-2024.7/aioccl.egg-info/top_level.txt

@@ -0,0 +1 @@
+aioccl

aioccl-2024.7/setup.cfg

@@ -0,0 +1,7 @@
+[metadata]
+description-file = README.md
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

aioccl-2024.7/setup.py

@@ -0,0 +1,34 @@
+from pathlib import Path
+from setuptools import find_packages, setup
+
+VERSION = "2024.7"
+
+ROOT_DIR = Path(__file__).parent.resolve()
+
+setup(
+  name = "aioccl",
+  packages=find_packages(exclude=["tests", "misc"]),
+  version=VERSION,
+  license="Apache License, Version 2.0",
+  description="A Python library for CCL API server",
+  long_description=(ROOT_DIR / "README.md").read_text(encoding="utf-8"),
+  long_description_content_type="text/markdown",
+  author="fkiscd",
+  author_email="fkiscd@gmail.com",
+  url="https://github.com/fkiscd/aioccl",
+  download_url="https://github.com/fkiscd/aioccl",
+  install_requires=[
+          "aiohttp>3",
+          "aiohttp_cors>=0.7.0"
+      ],
+  include_package_data=True,
+  classifiers=[
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "License :: OSI Approved :: Apache Software License",
+    "Topic :: Home Automation",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+  ],
+)