aioccl 2024.1__tar.gz

aioccl-2024.1/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 CCL Electronics Ltd
+
+   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.1/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.4
+Name: aioccl
+Version: 2024.1
+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
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+# aioCCL
+A Python library for CCL API server

aioccl-2024.1/README.md

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

aioccl-2024.1/aioccl/__init__.py

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

aioccl-2024.1/aioccl/device.py

@@ -0,0 +1,194 @@
+"""CCL device mapping."""
+
+from __future__ import annotations
+
+import logging
+import time
+from typing import Callable, TypedDict
+
+from .sensor import CCLSensor, CCL_SENSORS
+
+_LOGGER = logging.getLogger(__name__)
+
+CCL_DEVICE_INFO_TYPES = ("serial_no", "mac_address", "model", "fw_ver")
+
+
+class CCLDevice:
+    """Mapping for a CCL device."""
+
+    def __init__(self, passkey: str):
+        """Initialize a CCL device."""
+
+        class Info(TypedDict):
+            """Store device information."""
+            fw_ver: str | None
+            last_update_time: float | None
+            mac_address: str | None
+            model: str | None
+            passkey: str
+            serial_no: str | None
+
+        self._info: Info = {
+            "fw_ver": None,
+            "last_update_time": None,
+            "mac_address": None,
+            "model": None,
+            "passkey": passkey,
+            "serial_no": None,
+        }
+
+        self._binary_sensors: dict[str, CCLSensor] | None = {}
+        self._sensors: dict[str, CCLSensor] | None = {}
+        self._update_callbacks = {}
+
+        self._new_binary_sensor_callbacks = set()
+        self._new_sensors: list[CCLSensor] | None = []
+        self._new_sensor_callbacks = set()
+
+    @property
+    def passkey(self) -> str:
+        """Return the passkey."""
+        return self._info["passkey"]
+
+    @property
+    def device_id(self) -> str | None:
+        """Return the device ID."""
+        if self.mac_address is None:
+            return None
+        return self.mac_address.replace(":", "").lower()[-6:]
+
+    @property
+    def last_update_time(self) -> str | None:
+        """Return the last update time."""
+        return self._info["last_update_time"]
+
+    @property
+    def name(self) -> str | None:
+        """Return the display name."""
+        if self.device_id is not None:
+            return self.model + " - " + self.device_id
+        return self._info["model"]
+
+    @property
+    def mac_address(self) -> str | None:
+        """Return the MAC address."""
+        return self._info["mac_address"]
+
+    @property
+    def model(self) -> str | None:
+        """Return the model."""
+        return self._info["model"]
+
+    @property
+    def fw_ver(self) -> str | None:
+        """Return the firmware version."""
+        return self._info["fw_ver"]
+
+    @property
+    def binary_sensors(self) -> dict[str, CCLSensor] | None:
+        """Store binary sensor data under this device."""
+        return self._binary_sensors
+
+    @property
+    def sensors(self) -> dict[str, CCLSensor] | None:
+        """Store sensor data under this device."""
+        return self._sensors
+
+    def update_info(self, new_info: dict[str, None | str]) -> None:
+        """Add or update device info."""
+        for key, value in new_info.items():
+            if key in self._info:
+                self._info[key] = str(value)
+        self._info["last_update_time"] = time.monotonic()
+
+    def update_sensors(self, sensors: dict[str, None | str | int | float]) -> None:
+        """Add or update all sensor values."""
+        for key, value in sensors.items():
+            if CCL_SENSORS.get(key).binary:
+                if key not in self.binary_sensors:
+                    self._binary_sensors[key] = CCLSensor(key)
+                    self._new_sensors.append(self.binary_sensors[key])
+                self._binary_sensors[key].value = value
+            else:
+                if key not in self.sensors:
+                    self._sensors[key] = CCLSensor(key)
+                    self._new_sensors.append(self.sensors[key])
+                self._sensors[key].value = value
+
+        add_count = self._publish_new_sensors()
+        _LOGGER.debug(
+            "Added %s new sensors for device %s at %s.",
+            add_count,
+            self.device_id,
+            self.last_update_time,
+        )
+
+        update_count = self._publish_updates()
+        _LOGGER.debug(
+            "Updated %s sensors in total for device %s at %s.",
+            update_count,
+            self.device_id,
+            self.last_update_time,
+        )
+
+    def register_update_cb(self, sensor_key, callback: Callable[[], None]) -> None:
+        """Register callback, called when Sensor changes state."""
+        self._update_callbacks[sensor_key] = callback
+
+    def remove_update_cb(self, sensor_key, callback: Callable[[], None]) -> None:
+        """Remove previously registered callback."""
+        self._update_callbacks.pop(sensor_key, None)
+
+    def _publish_updates(self) -> int:
+        """Schedule call all registered callbacks."""
+        count = 0
+        for sensor_key, callback in self._update_callbacks.items():
+            try:
+                callback()
+                count += 1
+            except Exception as err:  # pylint: disable=broad-exception-caught
+                _LOGGER.warning(
+                    "Error while updating sensor %s for device %s: %s",
+                    sensor_key,
+                    self.device_id,
+                    err,
+                )
+        return count
+
+    def register_new_binary_sensor_cb(self, callback: Callable[[], None]) -> None:
+        """Register callback, called when Sensor changes state."""
+        self._new_binary_sensor_callbacks.add(callback)
+
+    def remove_new_binary_sensor_cb(self, callback: Callable[[], None]) -> None:
+        """Remove previously registered callback."""
+        self._new_binary_sensor_callbacks.discard(callback)
+
+    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."""
+        count = 0
+        for sensor in self._new_sensors[:]:
+            try:
+                if sensor.binary:
+                    for callback in self._new_binary_sensor_callbacks:
+                        callback(sensor)
+                else:
+                    for callback in self._new_sensor_callbacks:
+                        callback(sensor)
+                self._new_sensors.remove(sensor)
+                count += 1
+            except Exception as err:  # pylint: disable=broad-exception-caught
+                _LOGGER.warning(
+                    "Error while adding sensor %s for device %s: %s",
+                    sensor.key,
+                    self.device_id,
+                    err,
+                )
+        return count

aioccl-2024.1/aioccl/sensor.py

@@ -0,0 +1,528 @@
+"""CCL sensor mapping."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+import enum
+
+
+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 = None
+
+        if key in CCL_SENSORS:
+            self._key = key
+
+    @property
+    def key(self) -> str:
+        """Key ID of the sensor."""
+        return self._key
+
+    @property
+    def name(self) -> str:
+        """Display name of the sensor."""
+        return CCL_SENSORS[self._key].name
+
+    @property
+    def sensor_type(self) -> CCLSensorTypes:
+        """Type of the sensor."""
+        return CCL_SENSORS[self._key].sensor_type
+
+    @property
+    def compartment(self) -> None | str:
+        """Decide which compartment it belongs to."""
+        if CCL_SENSORS[self._key].compartment in CCLDeviceCompartment:
+            return CCL_SENSORS[self._key].compartment.value
+        return None
+
+    @property
+    def binary(self) -> bool:
+        """Decide if the sensor is binary."""
+        return CCL_SENSORS[self._key].binary
+
+    @property
+    def value(self) -> None | str | int | float:
+        """Return the intrinsic sensor value."""
+        if self.sensor_type.name in CCL_SENSOR_VALUES:
+            return CCL_SENSOR_VALUES[self.sensor_type.name].get(self._value)
+        if self.sensor_type == CCLSensorTypes.BATTERY_BINARY:
+            try:
+                return int(self._value) - 1
+            except ValueError:
+                pass
+        return self._value
+
+    @value.setter
+    def value(self, new_value):
+        self._value = new_value
+
+
+@dataclass
+class CCLSensorPreset:
+    """Attributes of a CCL sensor."""
+
+    name: str
+    sensor_type: str
+    compartment: CCLDeviceCompartment | None = None
+    binary: bool = False
+
+
+class CCLSensorTypes(enum.Enum):
+    """List of CCL sensor types."""
+
+    PRESSURE = 1
+    TEMPERATURE = 2
+    HUMIDITY = 3
+    WIND_DIRECITON = 4
+    WIND_SPEED = 5
+    RAIN_RATE = 6
+    RAINFALL = 7
+    UVI = 8
+    RADIATION = 9
+    BATTERY_BINARY = 10
+    CONNECTION = 11
+    CH_SENSOR_TYPE = 12
+    CO = 13
+    CO2 = 14
+    VOLATILE = 15
+    VOC = 16
+    PM10 = 17
+    PM25 = 18
+    AQI = 19
+    LEAKAGE = 20
+    BATTERY = 21
+    LIGHTNING_DISTANCE = 22
+    LIGHTNING_DURATION = 23
+    LIGHTNING_FREQUENCY = 24
+    BATTERY_VOLTAGE = 25
+
+
+class CCLDeviceCompartment(enum.Enum):
+    """Grouping of CCL sensors."""
+
+    MAIN = "Console & Sensor Array"
+    OTHER = "Other Sensors"
+    STATUS = "Status"
+
+
+CCL_SENSOR_VALUES: dict[str, dict[str, str]] = {
+    "CH_SENSOR_TYPE": {
+        2: "thermo-hygro",
+        3: "pool",
+        4: "soil",
+    },
+    "LEAKAGE": {
+        0: "no_leak",
+        1: "leaking",
+    },
+}
+
+CCL_SENSORS: dict[str, CCLSensorPreset] = {
+    # Main Sensors 12-34
+    "abar": CCLSensorPreset(
+        "Air Pressure (Absolute)", CCLSensorTypes.PRESSURE, CCLDeviceCompartment.MAIN
+    ),
+    "rbar": CCLSensorPreset(
+        "Air Pressure (Relative)", CCLSensorTypes.PRESSURE, CCLDeviceCompartment.MAIN
+    ),
+    "t1dew": CCLSensorPreset(
+        "Index: Dew Point", CCLSensorTypes.TEMPERATURE, CCLDeviceCompartment.MAIN
+    ),
+    "t1feels": CCLSensorPreset(
+        "Index: Feels Like", CCLSensorTypes.TEMPERATURE, CCLDeviceCompartment.MAIN
+    ),
+    "t1heat": CCLSensorPreset(
+        "Index: Heat Index", CCLSensorTypes.TEMPERATURE, CCLDeviceCompartment.MAIN
+    ),
+    "t1wbgt": CCLSensorPreset(
+        "Index: WBGT", CCLSensorTypes.TEMPERATURE, CCLDeviceCompartment.MAIN
+    ),
+    "t1chill": CCLSensorPreset(
+        "Index: Wind Chill", CCLSensorTypes.TEMPERATURE, CCLDeviceCompartment.MAIN
+    ),
+    "inhum": CCLSensorPreset(
+        "Indoor Humidity", CCLSensorTypes.HUMIDITY, CCLDeviceCompartment.MAIN
+    ),
+    "intem": CCLSensorPreset(
+        "Indoor Temperature", CCLSensorTypes.TEMPERATURE, CCLDeviceCompartment.MAIN
+    ),
+    "t1solrad": CCLSensorPreset(
+        "Light Intensity", CCLSensorTypes.RADIATION, CCLDeviceCompartment.MAIN
+    ),
+    "t1hum": CCLSensorPreset(
+        "Outdoor Humidity", CCLSensorTypes.HUMIDITY, CCLDeviceCompartment.MAIN
+    ),
+    "t1tem": CCLSensorPreset(
+        "Outdoor Temperature", CCLSensorTypes.TEMPERATURE, CCLDeviceCompartment.MAIN
+    ),
+    "t1rainra": CCLSensorPreset(
+        "Rain Rate", CCLSensorTypes.RAIN_RATE, CCLDeviceCompartment.MAIN
+    ),
+    "t1rainhr": CCLSensorPreset(
+        "Rainfall: Hourly ", CCLSensorTypes.RAINFALL, CCLDeviceCompartment.MAIN
+    ),
+    "t1raindy": CCLSensorPreset(
+        "Rainfall: Daily", CCLSensorTypes.RAINFALL, CCLDeviceCompartment.MAIN
+    ),
+    "t1rainwy": CCLSensorPreset(
+        "Rainfall: Weekly", CCLSensorTypes.RAINFALL, CCLDeviceCompartment.MAIN
+    ),
+    "t1rainmth": CCLSensorPreset(
+        "Rainfall: Monthly", CCLSensorTypes.RAINFALL, CCLDeviceCompartment.MAIN
+    ),
+    "t1rainyr": CCLSensorPreset(
+        "Rainfall: Yearly", CCLSensorTypes.RAINFALL, CCLDeviceCompartment.MAIN
+    ),
+    "t1uvi": CCLSensorPreset("UV Index", CCLSensorTypes.UVI, CCLDeviceCompartment.MAIN),
+    "t1wdir": CCLSensorPreset(
+        "Wind Direction", CCLSensorTypes.WIND_DIRECITON, CCLDeviceCompartment.MAIN
+    ),
+    "t1wgust": CCLSensorPreset(
+        "Wind Gust", CCLSensorTypes.WIND_SPEED, CCLDeviceCompartment.MAIN
+    ),
+    "t1ws": CCLSensorPreset(
+        "Wind Speed", CCLSensorTypes.WIND_SPEED, CCLDeviceCompartment.MAIN
+    ),
+    "t1ws10mav": CCLSensorPreset(
+        "Wind Speed (10 mins AVG.)",
+        CCLSensorTypes.WIND_SPEED,
+        CCLDeviceCompartment.MAIN,
+    ),
+    # Additional Sensors 35-77
+    "t11co": CCLSensorPreset(
+        "Air Quality: CO", CCLSensorTypes.CO, CCLDeviceCompartment.OTHER
+    ),
+    "t10co2": CCLSensorPreset(
+        "Air Quality: CO\u2082", CCLSensorTypes.CO2, CCLDeviceCompartment.OTHER
+    ),
+    "t9hcho": CCLSensorPreset(
+        "Air Quality: HCHO", CCLSensorTypes.VOLATILE, CCLDeviceCompartment.OTHER
+    ),
+    "t8pm10": CCLSensorPreset(
+        "Air Quality: PM10", CCLSensorTypes.PM10, CCLDeviceCompartment.OTHER
+    ),
+    "t8pm10ai": CCLSensorPreset(
+        "Air Quality: PM10 AQI", CCLSensorTypes.AQI, CCLDeviceCompartment.OTHER
+    ),
+    "t8pm25": CCLSensorPreset(
+        "Air Quality: PM2.5", CCLSensorTypes.PM25, CCLDeviceCompartment.OTHER
+    ),
+    "t8pm25ai": CCLSensorPreset(
+        "Air Quality: PM2.5 AQI", CCLSensorTypes.AQI, CCLDeviceCompartment.OTHER
+    ),
+    "t9voclv": CCLSensorPreset(
+        "Air Quality: VOC Level", CCLSensorTypes.VOC, CCLDeviceCompartment.OTHER
+    ),
+    "t234c1tem": CCLSensorPreset(
+        "CH1 Temperature", CCLSensorTypes.TEMPERATURE, CCLDeviceCompartment.OTHER
+    ),
+    "t234c1hum": CCLSensorPreset(
+        "CH1 Humidity", CCLSensorTypes.HUMIDITY, CCLDeviceCompartment.OTHER
+    ),
+    "t234c1tp": CCLSensorPreset(
+        "CH1 Type", CCLSensorTypes.CH_SENSOR_TYPE, CCLDeviceCompartment.OTHER
+    ),
+    "t234c2tem": CCLSensorPreset(
+        "CH2 Temperature", CCLSensorTypes.TEMPERATURE, CCLDeviceCompartment.OTHER
+    ),
+    "t234c2hum": CCLSensorPreset(
+        "CH2 Humidity", CCLSensorTypes.HUMIDITY, CCLDeviceCompartment.OTHER
+    ),
+    "t234c2tp": CCLSensorPreset(
+        "CH2 Type", CCLSensorTypes.CH_SENSOR_TYPE, CCLDeviceCompartment.OTHER
+    ),
+    "t234c3tem": CCLSensorPreset(
+        "CH3 Temperature", CCLSensorTypes.TEMPERATURE, CCLDeviceCompartment.OTHER
+    ),
+    "t234c3hum": CCLSensorPreset(
+        "CH3 Humidity", CCLSensorTypes.HUMIDITY, CCLDeviceCompartment.OTHER
+    ),
+    "t234c3tp": CCLSensorPreset(
+        "CH3 Type", CCLSensorTypes.CH_SENSOR_TYPE, CCLDeviceCompartment.OTHER
+    ),
+    "t234c4tem": CCLSensorPreset(
+        "CH4 Temperature", CCLSensorTypes.TEMPERATURE, CCLDeviceCompartment.OTHER
+    ),
+    "t234c4hum": CCLSensorPreset(
+        "CH4 Humidity", CCLSensorTypes.HUMIDITY, CCLDeviceCompartment.OTHER
+    ),
+    "t234c4tp": CCLSensorPreset(
+        "CH4 Type", CCLSensorTypes.CH_SENSOR_TYPE, CCLDeviceCompartment.OTHER
+    ),
+    "t234c5tem": CCLSensorPreset(
+        "CH5 Temperature", CCLSensorTypes.TEMPERATURE, CCLDeviceCompartment.OTHER
+    ),
+    "t234c5hum": CCLSensorPreset(
+        "CH5 Humidity", CCLSensorTypes.HUMIDITY, CCLDeviceCompartment.OTHER
+    ),
+    "t234c5tp": CCLSensorPreset(
+        "CH5 Type", CCLSensorTypes.CH_SENSOR_TYPE, CCLDeviceCompartment.OTHER
+    ),
+    "t234c6tem": CCLSensorPreset(
+        "CH6 Temperature", CCLSensorTypes.TEMPERATURE, CCLDeviceCompartment.OTHER
+    ),
+    "t234c6hum": CCLSensorPreset(
+        "CH6 Humidity", CCLSensorTypes.HUMIDITY, CCLDeviceCompartment.OTHER
+    ),
+    "t234c6tp": CCLSensorPreset(
+        "CH6 Type", CCLSensorTypes.CH_SENSOR_TYPE, CCLDeviceCompartment.OTHER
+    ),
+    "t234c7tem": CCLSensorPreset(
+        "CH7 Temperature", CCLSensorTypes.TEMPERATURE, CCLDeviceCompartment.OTHER
+    ),
+    "t234c7hum": CCLSensorPreset(
+        "CH7 Humidity", CCLSensorTypes.HUMIDITY, CCLDeviceCompartment.OTHER
+    ),
+    "t234c7tp": CCLSensorPreset(
+        "CH7 Type", CCLSensorTypes.CH_SENSOR_TYPE, CCLDeviceCompartment.OTHER
+    ),
+    "t6c1wls": CCLSensorPreset(
+        "Leakage CH1", CCLSensorTypes.LEAKAGE, CCLDeviceCompartment.OTHER
+    ),
+    "t6c2wls": CCLSensorPreset(
+        "Leakage CH2", CCLSensorTypes.LEAKAGE, CCLDeviceCompartment.OTHER
+    ),
+    "t6c3wls": CCLSensorPreset(
+        "Leakage CH3", CCLSensorTypes.LEAKAGE, CCLDeviceCompartment.OTHER
+    ),
+    "t6c4wls": CCLSensorPreset(
+        "Leakage CH4", CCLSensorTypes.LEAKAGE, CCLDeviceCompartment.OTHER
+    ),
+    "t6c5wls": CCLSensorPreset(
+        "Leakage CH5", CCLSensorTypes.LEAKAGE, CCLDeviceCompartment.OTHER
+    ),
+    "t6c6wls": CCLSensorPreset(
+        "Leakage CH6", CCLSensorTypes.LEAKAGE, CCLDeviceCompartment.OTHER
+    ),
+    "t6c7wls": CCLSensorPreset(
+        "Leakage CH7", CCLSensorTypes.LEAKAGE, CCLDeviceCompartment.OTHER
+    ),
+    "t5lskm": CCLSensorPreset(
+        "Lightning Distance",
+        CCLSensorTypes.LIGHTNING_DISTANCE,
+        CCLDeviceCompartment.OTHER,
+    ),
+    "t5lsf": CCLSensorPreset(
+        "Lightning: Past 60 mins Strikes",
+        CCLSensorTypes.LIGHTNING_FREQUENCY,
+        CCLDeviceCompartment.OTHER,
+    ),
+    "t5ls30mtc": CCLSensorPreset(
+        "Lightning: Strikes in 30 mins",
+        CCLSensorTypes.LIGHTNING_FREQUENCY,
+        CCLDeviceCompartment.OTHER,
+    ),
+    "t5ls5mtc": CCLSensorPreset(
+        "Lightning: Strikes in 5 mins",
+        CCLSensorTypes.LIGHTNING_FREQUENCY,
+        CCLDeviceCompartment.OTHER,
+    ),
+    "t5ls1dtc": CCLSensorPreset(
+        "Lightning: Strikes in day",
+        CCLSensorTypes.LIGHTNING_FREQUENCY,
+        CCLDeviceCompartment.OTHER,
+    ),
+    "t5ls1htc": CCLSensorPreset(
+        "Lightning: Strikes in hour",
+        CCLSensorTypes.LIGHTNING_FREQUENCY,
+        CCLDeviceCompartment.OTHER,
+    ),
+    # Status 78-119
+    "t234c1bat": CCLSensorPreset(
+        "Battery: CH1", CCLSensorTypes.BATTERY_BINARY, CCLDeviceCompartment.STATUS, True
+    ),
+    "t234c2bat": CCLSensorPreset(
+        "Battery: CH2", CCLSensorTypes.BATTERY_BINARY, CCLDeviceCompartment.STATUS, True
+    ),
+    "t234c3bat": CCLSensorPreset(
+        "Battery: CH3", CCLSensorTypes.BATTERY_BINARY, CCLDeviceCompartment.STATUS, True
+    ),
+    "t234c4bat": CCLSensorPreset(
+        "Battery: CH4", CCLSensorTypes.BATTERY_BINARY, CCLDeviceCompartment.STATUS, True
+    ),
+    "t234c5bat": CCLSensorPreset(
+        "Battery: CH5", CCLSensorTypes.BATTERY_BINARY, CCLDeviceCompartment.STATUS, True
+    ),
+    "t234c6bat": CCLSensorPreset(
+        "Battery: CH6", CCLSensorTypes.BATTERY_BINARY, CCLDeviceCompartment.STATUS, True
+    ),
+    "t234c7bat": CCLSensorPreset(
+        "Battery: CH7", CCLSensorTypes.BATTERY_BINARY, CCLDeviceCompartment.STATUS, True
+    ),
+    "t11bat": CCLSensorPreset(
+        "Battery Level: CO", CCLSensorTypes.BATTERY, CCLDeviceCompartment.STATUS
+    ),
+    "t10bat": CCLSensorPreset(
+        "Battery Level: CO\u2082", CCLSensorTypes.BATTERY, CCLDeviceCompartment.STATUS
+    ),
+    "inbat": CCLSensorPreset(
+        "Battery: Console",
+        CCLSensorTypes.BATTERY_BINARY,
+        CCLDeviceCompartment.STATUS,
+        True,
+    ),
+    "t9bat": CCLSensorPreset(
+        "Battery Level: HCHO/VOC", CCLSensorTypes.BATTERY, CCLDeviceCompartment.STATUS
+    ),
+    "t6c1bat": CCLSensorPreset(
+        "Battery: Leakage CH1",
+        CCLSensorTypes.BATTERY_BINARY,
+        CCLDeviceCompartment.STATUS,
+        True,
+    ),
+    "t6c2bat": CCLSensorPreset(
+        "Battery: Leakage CH2",
+        CCLSensorTypes.BATTERY_BINARY,
+        CCLDeviceCompartment.STATUS,
+        True,
+    ),
+    "t6c3bat": CCLSensorPreset(
+        "Battery: Leakage CH3",
+        CCLSensorTypes.BATTERY_BINARY,
+        CCLDeviceCompartment.STATUS,
+        True,
+    ),
+    "t6c4bat": CCLSensorPreset(
+        "Battery: Leakage CH4",
+        CCLSensorTypes.BATTERY_BINARY,
+        CCLDeviceCompartment.STATUS,
+        True,
+    ),
+    "t6c5bat": CCLSensorPreset(
+        "Battery: Leakage CH5",
+        CCLSensorTypes.BATTERY_BINARY,
+        CCLDeviceCompartment.STATUS,
+        True,
+    ),
+    "t6c6bat": CCLSensorPreset(
+        "Battery: Leakage CH6",
+        CCLSensorTypes.BATTERY_BINARY,
+        CCLDeviceCompartment.STATUS,
+        True,
+    ),
+    "t6c7bat": CCLSensorPreset(
+        "Battery: Leakage CH7",
+        CCLSensorTypes.BATTERY_BINARY,
+        CCLDeviceCompartment.STATUS,
+        True,
+    ),
+    "t5lsbat": CCLSensorPreset(
+        "Battery: Lightning Sensor",
+        CCLSensorTypes.BATTERY_BINARY,
+        CCLDeviceCompartment.STATUS,
+        True,
+    ),
+    "t1bat": CCLSensorPreset(
+        "Battery: Sensor Array",
+        CCLSensorTypes.BATTERY_BINARY,
+        CCLDeviceCompartment.STATUS,
+        True,
+    ),
+    "t1batvt": CCLSensorPreset(
+        "Battery Voltage: Sensor Array",
+        CCLSensorTypes.BATTERY_VOLTAGE,
+        CCLDeviceCompartment.STATUS,
+    ),
+    "t8bat": CCLSensorPreset(
+        "Battery Level: PM2.5/10", CCLSensorTypes.BATTERY, CCLDeviceCompartment.STATUS
+    ),
+    "t234c1cn": CCLSensorPreset(
+        "Connection: CH1", CCLSensorTypes.CONNECTION, CCLDeviceCompartment.STATUS, True
+    ),
+    "t234c2cn": CCLSensorPreset(
+        "Connection: CH2", CCLSensorTypes.CONNECTION, CCLDeviceCompartment.STATUS, True
+    ),
+    "t234c3cn": CCLSensorPreset(
+        "Connection: CH3", CCLSensorTypes.CONNECTION, CCLDeviceCompartment.STATUS, True
+    ),
+    "t234c4cn": CCLSensorPreset(
+        "Connection: CH4", CCLSensorTypes.CONNECTION, CCLDeviceCompartment.STATUS, True
+    ),
+    "t234c5cn": CCLSensorPreset(
+        "Connection: CH5", CCLSensorTypes.CONNECTION, CCLDeviceCompartment.STATUS, True
+    ),
+    "t234c6cn": CCLSensorPreset(
+        "Connection: CH6", CCLSensorTypes.CONNECTION, CCLDeviceCompartment.STATUS, True
+    ),
+    "t234c7cn": CCLSensorPreset(
+        "Connection: CH7", CCLSensorTypes.CONNECTION, CCLDeviceCompartment.STATUS, True
+    ),
+    "t6c1cn": CCLSensorPreset(
+        "Connection: Leakage CH1",
+        CCLSensorTypes.CONNECTION,
+        CCLDeviceCompartment.STATUS,
+        True,
+    ),
+    "t6c2cn": CCLSensorPreset(
+        "Connection: Leakage CH2",
+        CCLSensorTypes.CONNECTION,
+        CCLDeviceCompartment.STATUS,
+        True,
+    ),
+    "t6c3cn": CCLSensorPreset(
+        "Connection: Leakage CH3",
+        CCLSensorTypes.CONNECTION,
+        CCLDeviceCompartment.STATUS,
+        True,
+    ),
+    "t6c4cn": CCLSensorPreset(
+        "Connection: Leakage CH4",
+        CCLSensorTypes.CONNECTION,
+        CCLDeviceCompartment.STATUS,
+        True,
+    ),
+    "t6c5cn": CCLSensorPreset(
+        "Connection: Leakage CH5",
+        CCLSensorTypes.CONNECTION,
+        CCLDeviceCompartment.STATUS,
+        True,
+    ),
+    "t6c6cn": CCLSensorPreset(
+        "Connection: Leakage CH6",
+        CCLSensorTypes.CONNECTION,
+        CCLDeviceCompartment.STATUS,
+        True,
+    ),
+    "t6c7cn": CCLSensorPreset(
+        "Connection: Leakage CH7",
+        CCLSensorTypes.CONNECTION,
+        CCLDeviceCompartment.STATUS,
+        True,
+    ),
+    "t5lscn": CCLSensorPreset(
+        "Connection: Lightning Sensor",
+        CCLSensorTypes.CONNECTION,
+        CCLDeviceCompartment.STATUS,
+        True,
+    ),
+    "t11cn": CCLSensorPreset(
+        "Connection: CO", CCLSensorTypes.CONNECTION, CCLDeviceCompartment.STATUS, True
+    ),
+    "t10cn": CCLSensorPreset(
+        "Connection: CO\u2082",
+        CCLSensorTypes.CONNECTION,
+        CCLDeviceCompartment.STATUS,
+        True,
+    ),
+    "t9cn": CCLSensorPreset(
+        "Connection: HCHO/VOC",
+        CCLSensorTypes.CONNECTION,
+        CCLDeviceCompartment.STATUS,
+        True,
+    ),
+    "t1cn": CCLSensorPreset(
+        "Connection: Sensor Array",
+        CCLSensorTypes.CONNECTION,
+        CCLDeviceCompartment.STATUS,
+        True,
+    ),
+    "t8cn": CCLSensorPreset(
+        "Connection: PM2.5/10",
+        CCLSensorTypes.CONNECTION,
+        CCLDeviceCompartment.STATUS,
+        True,
+    ),
+}

aioccl-2024.1/aioccl/server.py

@@ -0,0 +1,98 @@
+"""CCL API server and handler."""
+
+from __future__ import annotations
+
+import logging
+
+from aiohttp import web
+
+from .device import CCLDevice, CCL_DEVICE_INFO_TYPES
+from .sensor import CCL_SENSORS
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class CCLServer:
+    """Represent a CCL server manager."""
+
+    LISTEN_PORT = 42373
+
+    devices: dict[str, CCLDevice] = {}
+
+    @staticmethod
+    def register(device: CCLDevice) -> None:
+        """Register a device with a passkey."""
+        CCLServer.devices[device.passkey] = device
+        _LOGGER.debug("Device registered: %s", device.passkey)
+
+    @staticmethod
+    async def handler(request: web.BaseRequest | web.Request) -> web.Response:
+        """Handle POST requests for data updating."""
+        body: dict[str, None | str | int | float] = {}
+        device: CCLDevice = None
+        info: dict[str, None | str] = {}
+        passkey: str = ""
+        sensors: dict[str, None | str | int | float] = {}
+        status: None | int = None
+        text: None | str = None
+
+        _LOGGER.debug("Request received: %s", passkey)
+        try:
+            passkey = request.path[-8:]
+            for ref_passkey, ref_device in CCLServer.devices.items():
+                if passkey == ref_passkey:
+                    device = ref_device
+                    break
+            assert isinstance(device, CCLDevice), 404
+
+            assert request.content_type == "application/json", 400
+            assert 0 < request.content_length <= 5000, 400
+
+            body = await request.json()
+
+        except Exception as err:  # pylint: disable=broad-exception-caught
+            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)
+            return web.Response(status=status, text=text)
+
+        for key, value in body.items():
+            if key in CCL_DEVICE_INFO_TYPES:
+                info.setdefault(key, value)
+            elif key in CCL_SENSORS:
+                sensors.setdefault(key, value)
+
+        device.update_info(info)
+        device.update_sensors(sensors)
+        status = 200
+        text = "200 OK"
+        _LOGGER.debug("Request processed: %s", passkey)
+        return web.Response(status=status, text=text)
+
+    app = web.Application()
+    app.add_routes([web.get("/{passkey}", handler)])
+    runner = web.AppRunner(app)
+
+    @staticmethod
+    async def run() -> None:
+        """Try to run the API server."""
+        try:
+            _LOGGER.debug("Trying to start the API server.")
+            await CCLServer.runner.setup()
+            site = web.TCPSite(CCLServer.runner, port=CCLServer.LISTEN_PORT)
+            await site.start()
+        except Exception as err:  # pylint: disable=broad-exception-caught
+            _LOGGER.warning("Failed to run the API server: %s", err)
+        else:
+            _LOGGER.debug("Successfully started the API server.")
+
+    @staticmethod
+    async def stop() -> None:
+        """Stop running the API server."""
+        await CCLServer.runner.cleanup()

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

@@ -0,0 +1,33 @@
+Metadata-Version: 2.4
+Name: aioccl
+Version: 2024.1
+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
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+# aioCCL
+A Python library for CCL API server

aioccl-2024.1/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.1/aioccl.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

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

@@ -0,0 +1 @@
+aiohttp>3

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

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

aioccl-2024.1/setup.cfg

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

aioccl-2024.1/setup.py

@@ -0,0 +1,35 @@
+"""Setup module for aioCCL."""
+
+from pathlib import Path
+from setuptools import find_packages, setup
+
+VERSION = "2024.1"
+
+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"
+      ],
+  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",
+  ],
+)