gryfsmartio 0.1__tar.gz

gryfsmartio-0.1/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Gryf Smart
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

gryfsmartio-0.1/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: gryfsmartio
+Version: 0.1
+Summary: Library for the GryfSmart system
+Home-page: https://github.com/karlowiczpl/gryfsmartio
+Author: @karlowiczpl
+Author-email: kkarlowicz@gryfsmart.pl
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENCE
+Requires-Dist: pyserial-asyncio==0.6
+Dynamic: license-file

gryfsmartio-0.1/gryfsmartio/parsing.py

@@ -0,0 +1,155 @@
+import logging
+
+from typing import List, Optional
+from pydantic import BaseModel, Field, EmailStr
+
+_LOGGER = logging.getLogger(__name__)
+
+class ParsedFunctions():
+    INPUTS = "I"
+    OUTPUTS = "O"
+    PWM = "LED"
+    COVER = "R"
+    TEMP = "T"
+    FIND = "AT+FIND"
+    PONG = "PONG"
+    PRESS_LONG = "PL"
+    PRESS_SHORT = "PS"
+
+broadcastingFunctions = [
+    ParsedFunctions.INPUTS,
+    ParsedFunctions.OUTPUTS,
+    ParsedFunctions.COVER,
+]
+
+subscriptableFunction = [
+    ParsedFunctions.INPUTS,
+    ParsedFunctions.OUTPUTS,
+    ParsedFunctions.PWM,
+    ParsedFunctions.COVER,
+    ParsedFunctions.TEMP,
+    ParsedFunctions.PRESS_SHORT,
+    ParsedFunctions.PRESS_LONG,
+]
+
+class ParsedData:
+
+    _function: str
+    _pin: int
+    _id: int
+    _parsed_states: list[str]
+    _broadcast_function: bool
+    _error = True
+
+    def __init__(self, data: str) -> None:
+
+        if('=' not in data or not data):
+            return
+
+        try:
+            parts = data.split('=', 1)
+
+            self._function = parts[0].upper()
+            self._parsed_states = parts[1].split(',')
+            self._id = int(self._parsed_states[0])
+
+            if(self._function in broadcastingFunctions):
+                self._broadcast_function = True
+            else:
+                self._broadcast_function = False
+
+            self._error = False
+
+        except Exception as e:
+            _LOGGER.error(f"Error occurred while parsing: {e}")
+
+    def error_occurred(self) -> bool:
+        return self._error
+
+    @property
+    def is_broadcast(self) -> bool:
+        return self._broadcast_function
+
+    @property
+    def function(self) -> str:
+        return self._function
+
+    @property
+    def parsed_states(self) -> list[str]:
+        return self._parsed_states
+
+    @property
+    def id(self) -> int:
+        return self._id
+
+    @property
+    def pin(self) -> int:
+        if(not self._broadcast_function):
+            return int(self._parsed_states[1])
+
+        return 0
+
+class Driver:
+    id: int
+    inputs: list[int]
+    outputs: list[int]
+    pwms: list[int]
+    covers: list[int]
+
+    def __init__(
+        self,
+        id: int
+    ) -> None:
+        self.id = id
+        self.inputs: list[int] = [0] * 20
+        self.outputs: list[int] = [0] * 20
+        self.pwms: list[int] = [0] * 20
+        self.covers: list[int] = [0] * 20
+
+    @property
+    def function_map(self) -> dict[str, list[int]]:
+        return {
+            ParsedFunctions.INPUTS: self.inputs,
+            ParsedFunctions.OUTPUTS: self.outputs,
+            ParsedFunctions.PWM: self.pwms,
+            ParsedFunctions.COVER: self.covers,
+        }
+
+    def __getitem__(self, key: str) -> list[int]:
+        return self.function_map[key]
+
+class Subscription:
+    _function: str
+    _id: int
+    _pin: int
+    _fun_ptr = None
+
+    def __init__(
+        self,
+        hardware_id: int,
+        hardware_pin: int,
+        function: str,
+        async_fun_ptr
+    ) -> None:
+        self._id = hardware_id
+        self._pin = hardware_pin
+        self._function = function.strip()
+
+        self._fun_ptr = async_fun_ptr
+
+    def cover_with_data(self, parsed_data: ParsedData) -> bool:
+        if(parsed_data.function.strip() != self._function):
+            return False
+
+        if(parsed_data.is_broadcast):
+            if(parsed_data.id == self._id):
+                return True
+        else:
+            if(parsed_data.id == self._id and parsed_data.pin == self._pin):
+                return True
+
+        return False
+
+    async def exec_fun(self, parsed_data):
+        await self._fun_ptr(parsed_data)
+

gryfsmartio-0.1/gryfsmartio/transport.py

@@ -0,0 +1,294 @@
+import asyncio
+import logging
+import re
+import serial_asyncio
+
+from .parsing import ParsedData, ParsedFunctions, Subscription, subscriptableFunction 
+from gryfsmartio.parsing import Driver
+
+_LOGGER = logging.getLogger(__name__)
+
+TCP_PORT = 4510
+SERIAL_BAUDRATE = 115200
+
+class WriterBase:
+
+    def __init__(
+            self,
+            port: str,
+    ) -> None:
+        pass
+
+    def write(
+        self,
+        data: str
+    ) -> None:
+        pass
+
+    async def read(self) -> str:
+        return ""
+
+    async def close(self) -> None:
+        pass
+
+    async def open(self) -> None:
+        pass
+
+class SerialWriter(WriterBase):
+    _port: str
+    _baudrate: int
+    _reader: asyncio.StreamReader | None = None
+    _writer: asyncio.StreamWriter | None = None
+
+    def __init__(self, port: str, baudrate: int = SERIAL_BAUDRATE) -> None:
+        self._port = port
+        self._baudrate = baudrate
+
+    async def open(self) -> None:
+        self._reader, self._writer = await serial_asyncio.open_serial_connection(
+            url=self._port,
+            baudrate=self._baudrate
+        )
+
+    async def write(
+            self,
+            data: str
+    ) -> None:
+        if self._writer is None or self._writer.is_closing():
+            return
+
+        try:
+            if not data.endswith("\n"):
+                data += "\n"
+
+            self._writer.write(data.encode("utf-8"))
+   
+            await self._writer.drain()
+            _LOGGER.debug(f"Serial sent: {data.strip()}")
+
+        except Exception as err:
+            _LOGGER.error(f"Error while serial send: {err}")
+
+    async def read(self) -> str:
+        if self._reader is None:
+            return ""
+
+        line_bytes = await asyncio.wait_for(self._reader.readline(), timeout=10.0)
+
+        return line_bytes.decode("utf-8", errors="ignore").strip()
+
+    async def close(self) -> None:
+        if self._writer is not None:
+            try:
+                self._writer.close()
+                await self._writer.wait_closed()
+            except Exception:
+                pass
+
+        self._reader = None
+        self._writer = None
+
+class TcpWriter(WriterBase):
+    _ip: str
+    _reader = None
+    _writer = None
+
+    def __init__(
+            self,
+            ip: str,
+    ) -> None:
+        self._ip = ip 
+
+    async def write(
+        self,
+        data: str
+    ) -> None:
+        if self._writer is None or self._writer.is_closing():
+            _LOGGER.error("No active TCP connecction - cannot send data")
+            return
+
+        try:
+            if not data.endswith("\n"):
+                data += "\n"
+
+            self._writer.write(data.encode("utf-8"))
+            await self._writer.drain()
+
+            _LOGGER.debug(f"Command sended: {data.strip()}")
+
+        except Exception as err:
+            _LOGGER.error(f"En Error while bufforing TCP data: {err}")
+
+    async def read(self) -> str:
+        if self._reader is None:
+            _LOGGER.error("Connection don't exist")
+
+        try:
+            line_bytes = await asyncio.wait_for(self._reader.readline(), timeout=1000.0)
+
+            if not line_bytes:
+                _LOGGER.error("Connection don't exist")
+
+            return line_bytes.decode("utf-8", errors="ignore").strip()
+
+        except (AttributeError, Exception) as err:
+            _LOGGER.debug(f"En Error occurred while reading TCP: {err}")
+            raise err
+
+    async def close(self) -> None:
+        if self._writer is not None:
+            try:
+                self._writer.close()
+
+                await self._writer.wait_closed()
+            except Exception as e:
+                _LOGGER.error(f"An Error occurred while closing connection: {self._ip}")
+
+        self._reader = None
+        self._writer = None
+
+    async def open(self) -> None:
+        self._reader, self._writer = await asyncio.wait_for(
+            asyncio.open_connection(self._ip, TCP_PORT), 
+            timeout=5.0
+        )
+
+        sock = self._writer.get_extra_info('socket')
+        if sock is not None:
+            import socket
+            sock.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
+
+class Transport():
+
+    _connection: WriterBase
+    _target: str
+    _subscriptions = None
+    _task: asyncio.Task | None = None
+    _drivers_data: list[Driver] = []
+    
+    def __init__(
+            self,
+            connection_target: str
+        ) -> None:
+
+        self._target = connection_target
+
+        ipv4_patern = r"\b(?:\d{1,3}\.){3}\d{1,3}\b"
+        serial_port_patern = r"/dev/tty\S*"
+
+        if re.search(ipv4_patern , connection_target):
+            self._connection = TcpWriter(connection_target)
+        elif re.search(serial_port_patern , connection_target):
+            pass
+        else:
+            _LOGGER.error(f"Incorrect Communication Port: {connection_target}")
+
+    def register_subscription(self, subscription: Subscription):
+        if self._subscriptions is None:
+            self._subscriptions = []
+
+        self._subscriptions.append(subscription)
+
+    async def write(
+            self,
+            data: str,
+    ) -> None:
+        await self._connection.write(data)
+
+    def start_communication(self) -> None:
+
+        if self._task is not None and not self._task.done():
+            _LOGGER.warning("Communication: %s already exists!", self._target)
+            return
+
+        self._task = asyncio.create_task(
+            self.communication_task(),
+            name=f"transport_task_{self._target}"
+        )
+
+    async def stop_communication(self) -> None:
+
+        if self._task is not None:
+            self._task.cancel()
+            try:
+                await self._task
+            except asyncio.CancelledError:
+                pass
+            finally:
+                self._task = None
+
+    async def communication_task(self):
+
+        while True:
+            try:
+                _LOGGER.info(f"Connecting with: {self._target}")
+                await self._connection.open()
+
+                _LOGGER.info(f"Successfuly connected to: {self._target}")
+
+                while True:
+                    try:
+                        readed = await self._connection.read()
+                        
+                        if(readed):
+                            _LOGGER.info(f"New command has arived: {readed}")
+
+                            if(readed == "??????????"):
+                                continue
+
+                            parsed_data = ParsedData(readed)
+
+                            if(parsed_data.error_occurred() or parsed_data.function not in subscriptableFunction):
+                                continue
+
+                            if(self._subscriptions is not None):
+                                for sub in self._subscriptions:
+                                    if(sub.cover_with_data(parsed_data)):
+                                        await sub.exec_fun(parsed_data)
+
+                            exist = False
+                            for item in self._drivers_data:
+                                if item.id == parsed_data.id:
+                                    exist = True
+
+                            if not exist:
+                                self._drivers_data.append(Driver(parsed_data.id))
+
+                            for item in self._drivers_data:
+                                if item.id == parsed_data.id:
+                                    if parsed_data.is_broadcast:
+                                        pass
+                                    else:
+                                        item[parsed_data.function][int(parsed_data.parsed_states[1])] = int(parsed_data.parsed_states[2])
+
+
+                    except asyncio.TimeoutError:
+                        _LOGGER.debug("Sending heartbeat to keep TCP connection alive...")
+                        await self._connection.write("\n")
+
+            except asyncio.CancelledError:
+                _LOGGER.info("Stopping Transport loop...")
+
+                await self._connection.close()
+
+                break
+
+            except Exception as err:
+                _LOGGER.error("Connection ERROR(%s): %s. Next connection attempt in 3s", self._target, err)
+
+                await self._connection.close()
+                await asyncio.sleep(3)
+        
+    async def set_led(
+        self,
+        id: int,
+        pin: int,
+        level: int,
+    ) -> None:
+        attempts = 0
+        while attempts < 10:
+            await self.write(f"SetLED={id},{pin},{level}")
+            await self.write(f"StateLED={id},{pin}")
+
+            await asyncio.sleep(attempts * 0.1)
+            attempts += 1

gryfsmartio-0.1/gryfsmartio.egg-info/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: gryfsmartio
+Version: 0.1
+Summary: Library for the GryfSmart system
+Home-page: https://github.com/karlowiczpl/gryfsmartio
+Author: @karlowiczpl
+Author-email: kkarlowicz@gryfsmart.pl
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENCE
+Requires-Dist: pyserial-asyncio==0.6
+Dynamic: license-file

gryfsmartio-0.1/gryfsmartio.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENCE
+pyproject.toml
+setup.cfg
+gryfsmartio/__init__.py
+gryfsmartio/parsing.py
+gryfsmartio/transport.py
+gryfsmartio.egg-info/PKG-INFO
+gryfsmartio.egg-info/SOURCES.txt
+gryfsmartio.egg-info/dependency_links.txt
+gryfsmartio.egg-info/requires.txt
+gryfsmartio.egg-info/top_level.txt

gryfsmartio-0.1/gryfsmartio.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

gryfsmartio-0.1/gryfsmartio.egg-info/requires.txt

@@ -0,0 +1 @@
+pyserial-asyncio==0.6

gryfsmartio-0.1/gryfsmartio.egg-info/top_level.txt

@@ -0,0 +1 @@
+gryfsmartio

gryfsmartio-0.1/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"

gryfsmartio-0.1/setup.cfg

@@ -0,0 +1,24 @@
+[metadata]
+name = gryfsmartio
+version = 0.1
+author = @karlowiczpl
+author_email = kkarlowicz@gryfsmart.pl
+description = Library for the GryfSmart system
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/karlowiczpl/gryfsmartio
+license = MIT
+classifiers = 
+	Programming Language :: Python :: 3
+	Operating System :: OS Independent
+
+[options]
+packages = find:
+python_requires = >=3.8
+install_requires = 
+	pyserial-asyncio==0.6
+
+[egg_info]
+tag_build = 
+tag_date = 0
+