owlsensor 0.2__tar.gz → 0.3.1__tar.gz

{owlsensor-0.2 → owlsensor-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: owlsensor
-Version: 0.2
+Version: 0.3.1
 Summary: Library to read data from OWL Energy meters
 Home-page: https://github.com/PBrunot/owlsensor
 Author: Pascal Brunot

owlsensor-0.3.1/README.rst

@@ -0,0 +1,42 @@
+owlsensor - Library for OWL CM 160 Energy meter
+================================================
+
+This library lets you read sensor data from serial-connected OWL Energy meter.
+It current supports the following model:
+
+- CM 160
+
+Usage
+=====
+
+* Create a CMDataCollector with port name as first argument, and OWL model as second argument,
+
+```python
+cm.CMDataCollector("COM4", cm.SUPPORTED_SENSORS["TheOWL,CM160"])
+```
+
+```python
+cm.CMDataCollector("/dev/ttyUSB0", cm.SUPPORTED_SENSORS["TheOWL,CM160"])
+```
+
+* You can add several devices the same way, on different serial ports.
+
+* Connect will be called automatically by read_data.
+
+```python
+await s.connect()
+await s.read_data()
+```
+
+* read_data returns a dict (CMVALS=[CURRENT]) containing the acquired real-time value. Currently only current in ampere is returned.
+
+```
+print(await s.read_data())
+
+{'Current': 4.1}
+```
+
+Limitations
+===========
+
+* Historical data returned by the device at connection is discarded, only realtime transmissions are available

owlsensor-0.3.1/owlsensor/__init__.py

@@ -0,0 +1,13 @@
+from .serial_cm import CMDataCollector, SUPPORTED_SENSORS
+
+async def get_async_datacollector(port_url: str, model: str, scan_interval_s: int = 30) -> CMDataCollector:
+    """
+    Return asynchronous version of CMDataCollector interface
+    :param port_url: serial port, i.e. '/dev/ttyUSB0'
+    :param model: device type, i.e. "CM160"
+    :return: asynchronous implementation of Monoprice interface
+    """
+    if not model in SUPPORTED_SENSORS:
+        return None
+    
+    return CMDataCollector(port_url, SUPPORTED_SENSORS[model], scan_interval_s)

{owlsensor-0.2 → owlsensor-0.3.1}/owlsensor/const.py

@@ -1,5 +1,5 @@
 """ Constants """
-PACKET_LENGTH = 11
+
 ID_REPLY = "IDTCMV001"
 ID_WAIT_HISTORY = "IDTWAITPC"
 CONTINUE_REQUEST = [0xa5]
@@ -7,3 +7,12 @@ START_REQUEST = [0x5a]
 PACKET_ID_HISTORY = 0xa9
 PACKET_ID_HISTORY_DATA = 0x59
 PACKET_ID_REALTIME = 0x51
+
+RECORD_LENGTH = "RL"
+CURRENT = "Current"
+BAUD_RATE = "BAUD"
+BYTE_ORDER = "BO",
+LSB = "lsb"
+MSB = "msb"
+MULTIPLIER = "MP"
+TIMEOUT = "TO"

{owlsensor-0.2 → owlsensor-0.3.1}/owlsensor/serial_cm.py

@@ -4,27 +4,15 @@ Reading data from particulate matter sensors with a serial interface.
 import time
 import logging
 import asyncio
+from serial import SerialException
 import serial_asyncio_fast
 
-from .const import CONTINUE_REQUEST, ID_WAIT_HISTORY,ID_REPLY, PACKET_ID_HISTORY, PACKET_ID_HISTORY_DATA, PACKET_ID_REALTIME, START_REQUEST
-
-STARTBLOCK = "SB"
-RECORD_LENGTH = "RL"
-# Ofsets of the PM data (always 2 byte)
-CURRENT = "Current"
-BAUD_RATE = "BAUD"
-BYTE_ORDER = "BO",
-LSB = "lsb"
-MSB = "msb"
-DTR_ON = "DTR"
-DTR_OFF = "NOT_DTR"
-MULTIPLIER = "MP"
-TIMEOUT = "TO"
+from .const import *
+
 
 # Owl CM160 settings
 OWL_CM160 = {
     "TheOWL": "CM160",
-    STARTBLOCK: bytes([0x42, 0x4d, 0x00, 0x14]),
     RECORD_LENGTH: 11,
     CURRENT: 8,
     BAUD_RATE: 250000,
@@ -34,7 +22,7 @@ OWL_CM160 = {
 }
 
 SUPPORTED_SENSORS = {
-    "TheOWL,CM160": OWL_CM160
+    "CM160": OWL_CM160
 }
 
 DEVICE_STATES = {
@@ -75,23 +63,41 @@ class CMDataCollector():
         self.reader = None
         self.writer = None
         self.baudrate = configuration[BAUD_RATE]
+        self.connected = False
+        self.updateTask = None
 
-    async def connect(self):
+    async def connect(self) -> bool:
         """Establish the serial connection asynchronously."""
-        self.reader, self.writer = await serial_asyncio_fast.open_serial_connection(
-            url=self.serialdevice,
-            baudrate=self.baudrate
-        )
+        self.connected = False
+        try:
+            self.reader, self.writer = await serial_asyncio_fast.open_serial_connection(
+                url=self.serialdevice,
+                baudrate=self.baudrate
+            )
+        except SerialException as ex:
+            LOGGER.warning("Connect: %s", ex)
+            return False
+        
+        self.connected = True
+
+        if self.updateTask is not None:
+            try:
+                self.updateTask.cancel()
+                self.updateTask = None
+            except Exception as e:
+                LOGGER.warning("Exception while cancelling update Task: %s", e)
 
         if self.scan_interval > 0:
-            asyncio.create_task(self.refresh())
+            self.updateTask = asyncio.create_task(self.refresh())
+        
+        return True
 
     async def refresh(self):
         """Asynchronous background refreshing task."""
         while True:
             await self.read_data()
             await asyncio.sleep(self.scan_interval)
-            
+
     async def send_data(self, data: bytes):
         LOGGER.debug("-> %s", ''.join(format(x, '02x') for x in data))
         self.writer.write(data)
@@ -143,8 +149,13 @@ class CMDataCollector():
 
         return None
 
-    async def read_data(self):
+    async def read_data(self) -> dict | None:
         """Read data from the serial interface asynchronously."""
+
+        if not self.connected:
+            if not await self.connect():
+                return None
+
         mytime = asyncio.get_event_loop().time()
         if (self.last_poll is not None) and \
            (mytime - self.last_poll) <= 15 and \
@@ -155,12 +166,17 @@ class CMDataCollector():
         finished = False
 
         while not finished:
-            packet = await self.get_packet()
-            if packet:
-                result = await self.parse_packet(packet)
-                if result is not None:
-                    res = result
-                    finished = True
+            try:
+                packet = await self.get_packet()
+                if packet:
+                    result = await self.parse_packet(packet)
+                    if result is not None:
+                        res = result
+                        finished = True
+            except SerialException as ex:
+                LOGGER.warning(ex)
+                self.connected = False
+                return None
 
         self._data = res
         self.last_poll = asyncio.get_event_loop().time()

{owlsensor-0.2 → owlsensor-0.3.1}/owlsensor.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: owlsensor
-Version: 0.2
+Version: 0.3.1
 Summary: Library to read data from OWL Energy meters
 Home-page: https://github.com/PBrunot/owlsensor
 Author: Pascal Brunot

{owlsensor-0.2 → owlsensor-0.3.1}/setup.py

@@ -1,7 +1,7 @@
 from setuptools import setup, find_packages
 
 setup(name='owlsensor',
-      version='0.2',
+      version='0.3.1',
       description='Library to read data from OWL Energy meters',
       long_description='This package is designed for integrating into Home Assistant a serial-connected OWL energy meter.',
       long_description_content_type = 'text/x-rst',

owlsensor-0.2/README.rst

@@ -1,7 +0,0 @@
-owlsensor - Library for OWL CM 160 Energy meter
-================================================
-
-This library lets you read sensor data from serial-connected OWL Energy meter.
-It current supports the following model:
-
-- CM 160