aioccl 2024.7.1__tar.gz → 2024.7.3__tar.gz

{aioccl-2024.7.1 → aioccl-2024.7.3}/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2024 fkiscd@gmail.com
+   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.

{aioccl-2024.7.1 → aioccl-2024.7.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aioccl
-Version: 2024.7.1
+Version: 2024.7.3
 Summary: A Python library for CCL API server
 Home-page: https://github.com/fkiscd/aioccl
 Download-URL: https://github.com/fkiscd/aioccl

{aioccl-2024.7.1 → aioccl-2024.7.3}/aioccl/device.py

@@ -5,7 +5,7 @@ import logging
 import time
 from typing import Callable
 
-from .sensor import CCLSensor
+from .sensor import CCLSensor, CCL_SENSORS
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -17,14 +17,13 @@ class CCLDevice:
         _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._serial_no: str | None
+        self._mac_address: str | None
+        self._model: str | None
+        self._version: str | None
+        self._binary_sensors: dict[str, CCLSensor] | None = {}
+        self._sensors: dict[str, CCLSensor] | None = {}
+        self._last_updated_time: float | None
 
         self._new_sensors: list[CCLSensor] | None = []
         
@@ -36,26 +35,56 @@ class CCLDevice:
         return self._passkey
     
     @property
-    def device_id(self) -> str:
-        return self.mac_address.replace(":", "").lower()[-6:]
+    def device_id(self) -> str | None:
+        return self._mac_address.replace(":", "").lower()[-6:]
+    
+    @property
+    def serial_no(self) -> str | None:
+        return self._serial_no
+    
+    @property
+    def mac_address(self) -> str | None:
+        return self._mac_address
+    
+    @property
+    def model(self) -> str | None:
+        return self._model
+    
+    @property
+    def version(self) -> str | None:
+        return self._version
+    
+    @property
+    def binary_sensors(self) -> dict[str, CCLSensor] | None:
+        return self._binary_sensors
+    
+    @property
+    def sensors(self) -> dict[str, CCLSensor] | None:
+        return self._sensors
     
     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')
+        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
+        for key, value in sensors.items():
+            if CCL_SENSORS[key].binary:
+                if not self._binary_sensors.get(key):
+                    self._binary_sensors[key] = CCLSensor(key)
+                    self._new_sensors.append(self._binary_sensors[key])
+                self._binary_sensors[key].value = value
+            else:
+                if not self._sensors.get(key):
+                    self._sensors[key] = CCLSensor(key)
+                    self._new_sensors.append(self.sensors[key])
+                self._sensors[key].value = value
         self._publish_new_sensors()
         self._publish_updates()
-        self.last_updated_time = time.monotonic()
+        self._last_updated_time = time.monotonic()
         _LOGGER.debug("Sensors Updated: %s", self.last_updated_time)
 
     def register_update_cb(self, callback: Callable[[], None]) -> None:
@@ -87,7 +116,6 @@ class CCLDevice:
         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()

aioccl-2024.7.3/aioccl/sensor.py

@@ -0,0 +1,99 @@
+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) -> str:
+        return self._key
+    
+    @property
+    def name(self) -> str:
+        return CCL_SENSORS[self._key].name
+    
+    @property
+    def sensor_type(self) -> CCLSensorTypes:
+        return CCL_SENSORS[self._key].sensor_type
+    
+    @property
+    def binary(self) -> bool:
+        return CCL_SENSORS[self._key].binary
+
+    @property
+    def value(self):
+        if self.sensor_type == CCLSensorTypes.CH_SENSOR_TYPE:
+            return CCL_CH_SENSOR_TYPES[self.sensor_type]
+        return self._value
+    
+    @value.setter
+    def value(self, new_value):
+        self._value = new_value
+
+@dataclass
+class CCLSensorPreset:
+    name: str
+    sensor_type: str
+    binary: bool = False
+    
+class CCLSensorTypes(enum.Enum):
+    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
+    
+CCL_CH_SENSOR_TYPES: list[str] = [None, None, 'Thermo-Hygro', 'Pool', 'Soil']
+    
+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('Wind Direction', CCLSensorTypes.WIND_DIRECITON),
+    't1ws': CCLSensorPreset('Wind Speed', CCLSensorTypes.WIND_SPEED),
+    't1ws10mav': CCLSensorPreset('Wind Speed (10 mins avg.)', CCLSensorTypes.WIND_SPEED),
+    't1wgust': CCLSensorPreset('Wind Gust', CCLSensorTypes.WIND_SPEED),
+    't1rainra': CCLSensorPreset('Rain Rate', CCLSensorTypes.RAIN_RATE),
+    't1rainhr': CCLSensorPreset('Hourly Rainfall', CCLSensorTypes.RAINFALL),
+    't1raindy': CCLSensorPreset('Daily Rainfall', CCLSensorTypes.RAINFALL),
+    't1rainwy': CCLSensorPreset('Weekly Rainfall', CCLSensorTypes.RAINFALL),
+    't1rainmth': CCLSensorPreset('Monthly Rainfall', CCLSensorTypes.RAINFALL),
+    't1uvi': CCLSensorPreset('UV Index', CCLSensorTypes.UVI),
+    't1solrad': CCLSensorPreset('Light Intensity', CCLSensorTypes.RADIATION),
+    't1bat': CCLSensorPreset('CH0 Battery', CCLSensorTypes.BATTERY_BINARY, True),
+    't1cn': CCLSensorPreset('CH0 Connection', CCLSensorTypes.CONNECTION),
+    't1feels': CCLSensorPreset('Feels Like', CCLSensorTypes.TEMPERATURE),
+    't1chill': CCLSensorPreset('Wind Chill', CCLSensorTypes.TEMPERATURE),
+    't1heat': CCLSensorPreset('Heat Index', CCLSensorTypes.TEMPERATURE),
+    't1dew': CCLSensorPreset('Dew Point', CCLSensorTypes.TEMPERATURE),
+    't1wbgt': CCLSensorPreset('WBGT Index', CCLSensorTypes.TEMPERATURE),
+    't234c1tem': CCLSensorPreset('CH1 Temperature', CCLSensorTypes.TEMPERATURE),
+    't234c1hum': CCLSensorPreset('CH1 Humidity', CCLSensorTypes.HUMIDITY),
+    't234c1bat': CCLSensorPreset('CH1 Battery', CCLSensorTypes.BATTERY_BINARY, True),
+    't234c1cn': CCLSensorPreset('CH1 Connection', CCLSensorTypes.CONNECTION, True),
+    't234c1tp': CCLSensorPreset('CH1 Sensor Type', CCLSensorTypes.CH_SENSOR_TYPE),
+    't234c2tem': CCLSensorPreset('CH2 Temperature', CCLSensorTypes.TEMPERATURE),
+    't234c2hum': CCLSensorPreset('CH2 Humidity', CCLSensorTypes.HUMIDITY),
+    't234c2bat': CCLSensorPreset('CH2 Battery', CCLSensorTypes.BATTERY_BINARY, True),
+    't234c2cn': CCLSensorPreset('CH2 Connection', CCLSensorTypes.CONNECTION, True),
+    't234c2tp': CCLSensorPreset('CH2 Sensor Type', CCLSensorTypes.CH_SENSOR_TYPE),
+}

{aioccl-2024.7.1 → aioccl-2024.7.3}/aioccl.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aioccl
-Version: 2024.7.1
+Version: 2024.7.3
 Summary: A Python library for CCL API server
 Home-page: https://github.com/fkiscd/aioccl
 Download-URL: https://github.com/fkiscd/aioccl

{aioccl-2024.7.1 → aioccl-2024.7.3}/setup.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 from setuptools import find_packages, setup
 
-VERSION = "2024.7.1"
+VERSION = "2024.7.3"
 
 ROOT_DIR = Path(__file__).parent.resolve()
 

aioccl-2024.7.1/aioccl/sensor.py

@@ -1,49 +0,0 @@
-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),
-}