knotlink 0.0.0__tar.gz

knotlink-0.0.0/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.1
+Name: knotlink
+Version: 0.0.0
+Summary: A Py-based client for KnotLink communication
+Author: HXH
+Author-email: 1768224274@qq.com
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Intended Audience :: Developers
+Description-Content-Type: text/markdown
+
+# KnotLink 使用教程

knotlink-0.0.0/README.md

@@ -0,0 +1 @@
+# KnotLink 使用教程

knotlink-0.0.0/knotlink/OpenSocketQuerier.py

@@ -0,0 +1,92 @@
+# OpenSocketQuerier.py
+# Copyright (C) 2025 HXH
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see https://www.gnu.org/licenses/
+
+from .tcpclient import TcpClient  # 确保 tcpclient.py 在同一目录下
+import threading
+
+class OpenSocketQuerier:
+    def __init__(self, APPID: str, OpenSocketID: str):
+        self.appID = APPID
+        self.openSocketID = OpenSocketID
+        self.callback = None  # 用户设置的回调函数
+        self.query_result = None  # 用于存储同步查询的结果
+        self.query_event = threading.Event()  # 用于同步查询的事件
+        self.is_querying = False  # 标记是否正在进行同步查询
+        self.init()
+
+    def init(self):
+        self.KLquerier = TcpClient()
+        self.KLquerier.connect_to_server("127.0.0.1", 6376)
+        self.KLquerier.received_data_callback = self._internal_data_recv  # 设置内部数据接收回调
+
+    def set_config(self, APPID: str, OpenSocketID: str):
+        self.appID = APPID
+        self.openSocketID = OpenSocketID
+
+    def query(self, data: str) -> str:
+        self.query_result = None  # 重置查询结果
+        self.query_event.clear()  # 重置事件
+        self.is_querying = True  # 标记开始同步查询
+        self._query(self.appID, self.openSocketID, data.encode("utf-8"))
+        self.query_event.wait()  # 等待事件被触发
+        self.is_querying = False  # 标记结束同步查询
+        return self.query_result
+
+    def query_async(self, data: str):
+        self._query(self.appID, self.openSocketID, data.encode("utf-8"))
+
+    def _query(self, APPID: str, OpenSocketID: str, data: bytes):
+        s_key = f"{APPID}-{OpenSocketID}&*&"
+        s_key_bytes = s_key.encode("utf-8")
+        s_data = s_key_bytes + data
+        self.KLquerier.send_data(s_data)
+
+    def _internal_data_recv(self, data: bytes):
+        received_text = data.decode("utf-8", errors="ignore")  # 解码为字符串
+        if self.is_querying:
+            # 如果正在进行同步查询，保存结果并触发事件
+            self.query_result = received_text
+            self.query_event.set()
+        else:
+            # 如果不是同步查询，调用用户设置的回调函数
+            if self.callback:
+                self.callback(received_text)
+
+    def set_RecvFunc(self, callback):
+        """
+        设置接收到数据后的回调函数。
+        :param callback: 回调函数，接收一个 str 类型的参数。
+        """
+        self.callback = callback
+
+# 示例用法
+if __name__ == "__main__":
+    def my_callback(data: str):
+        print(f"Callback received data: {data}")
+
+    querier = OpenSocketQuerier(APPID="0x00000001", OpenSocketID="0x00000002")
+    querier.set_RecvFunc(my_callback)  # 设置回调函数
+
+    # 同步查询示例
+    result = querier.query("Hello, Server!")
+    print(f"Synchronous query result: {result}")
+
+    import time
+    # 异步查询示例
+    querier.query_async("Another message")
+    time.sleep(60)  # 等待一段时间以接收数据
+
+    querier.KLquerier.disconnect()

knotlink-0.0.0/knotlink/OpenSocketResponser.py

@@ -0,0 +1,96 @@
+# OpenSocketResponser.py
+# Copyright (C) 2025 HXH
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see https://www.gnu.org/licenses/
+
+from .tcpclient import TcpClient  # 确保 tcpclient.py 在同一目录下
+from queue import Queue
+import threading
+import time
+
+class OpenSocketResponser:
+    def __init__(self, APPID: str, OpenSocketID: str):
+        self.appID = APPID
+        self.openSocketID = OpenSocketID
+        self.recv_func = None  # 回调函数（str 类型）
+        self.data_queue = Queue()  # 线程安全队列
+        self.init()
+
+    def init(self):
+        self.KLresponser = TcpClient()
+        self.KLresponser.connect_to_server("127.0.0.1", 6378)
+        self.KLresponser.received_data_callback = self._internal_data_recv
+
+        s_key = f"{self.appID}-{self.openSocketID}"
+        s_key_bytes = s_key.encode("utf-8")  # 转换为 UTF-8 编码的 QByteArray
+        self.KLresponser.send_data(s_key_bytes)
+
+        # 启动一个线程处理队列中的数据
+        threading.Thread(target=self._process_queue, daemon=True).start()
+
+    def sendBack(self, data: str, key: str):
+        """向客户端发送响应数据"""
+        s_key = f"{key}&*&"
+        s_key_bytes = s_key.encode("utf-8")
+        s_data = s_key_bytes + data.encode("utf-8")
+        self.KLresponser.send_data(s_data)
+
+    def _internal_data_recv(self, data: bytes):
+        """内部数据接收处理"""
+        try:
+            key_end = data.index(b"&*&")
+            key = data[:key_end].decode("utf-8")
+            payload = data[key_end + 3:]  # 跳过 "&*&"
+        except (ValueError, UnicodeDecodeError) as e:
+            print(f"解析数据失败：{e}")
+            return
+
+        if payload:
+            self.data_queue.put((payload.decode("utf-8", errors="ignore"), key))
+
+    def _process_queue(self):
+        """处理队列中的数据"""
+        while True:
+            if not self.data_queue.empty():
+                payload, key = self.data_queue.get()
+                if self.recv_func:
+                    response = self.recv_func(payload)
+                    if response is not None:
+                        self.sendBack(response, key)
+                self.data_queue.task_done()
+            time.sleep(0.01)  # 添加一个小的延时
+
+    def set_RecvFunc(self, recv_func):
+        """
+        设置接收到字符串数据后的处理函数。
+        :param recv_func: 处理函数，接收一个参数：str 类型的数据。
+                          处理函数返回一个 str 类型的响应。
+        """
+        self.recv_func = recv_func
+
+# 示例用法
+if __name__ == "__main__":
+    import time
+    def on_received_data(data: str) -> str:
+        print(f"接收到字符串数据：{data}")
+        time.sleep(5)
+        return f"Hello, Client! Your message has been received."
+
+    responser = OpenSocketResponser("0x00000001", "0x00000002")
+    responser.set_RecvFunc(on_received_data)
+
+    # 模拟运行一段时间
+    
+    time.sleep(60)
+    responser.KLresponser.disconnect()

knotlink-0.0.0/knotlink/SignalSender.py

@@ -0,0 +1,51 @@
+# SignalSender.py
+# Copyright (C) 2025 HXH
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see https://www.gnu.org/licenses/
+
+from .tcpclient import TcpClient  # 确保 tcpclient.py 在同一目录下
+import time
+
+class SignalSender:
+    def __init__(self, APPID=None, SignalID=None):
+        self.appID = APPID
+        self.signalID = SignalID
+        self.KLsender = TcpClient()
+        self.KLsender.connect_to_server("127.0.0.1", 6370)
+
+    def set_config(self, APPID, SignalID):
+        self.appID = APPID
+        self.signalID = SignalID
+
+    def emitt(self, data):
+        self._emitt(self.appID, self.signalID, data)
+
+    def _emitt(self, APPID, SignalID, data):
+        if isinstance(data, str):
+            data = data.encode('utf-8')
+        self.__emitt(APPID, SignalID, data)
+
+    def __emitt(self, APPID, SignalID, data):
+        s_key = f"{APPID}-{SignalID}&*&"
+        s_key_bytes = s_key.encode('utf-8')
+        s_data = s_key_bytes + data
+        self.KLsender.send_data(s_data)
+
+# 示例用法
+if __name__ == "__main__":
+    signal_sender = SignalSender(APPID="1", SignalID="1")
+    signal_sender.emitt("Hello, Server!")
+    # 等待一段时间以确保数据发送完成
+    time.sleep(10)
+    signal_sender.KLsender.disconnect()

knotlink-0.0.0/knotlink/SignalSubscriber.py

@@ -0,0 +1,71 @@
+# SignalSubscriber.py
+# Copyright (C) 2025 HXH
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see https://www.gnu.org/licenses/
+
+from .tcpclient import TcpClient  # 确保 tcpclient.py 在同一目录下
+
+class SignalSubscriber:
+    def __init__(self, APPID, SignalID):
+        self.appID = APPID
+        self.signalID = SignalID
+        self.callback = None  # 用于存储回调函数
+        self.init()
+
+    def init(self):
+        self.KLsubscriber = TcpClient()
+        self.KLsubscriber.connect_to_server("127.0.0.1", 6372)
+        print("OKK")
+        self.KLsubscriber.received_data_callback = self.data_recv  # 设置数据接收回调
+        s_key = f"{self.appID}-{self.signalID}"
+        s_key_bytes = s_key.encode('utf-8')
+        self.KLsubscriber.send_data(s_key_bytes)
+
+    def subscribe(self, APPID, SignalID):
+        self.appID = APPID
+        self.signalID = SignalID
+        s_key = f"{self.appID}-{self.signalID}"
+        s_key_bytes = s_key.encode('utf-8')
+        self.KLsubscriber.send_data(s_key_bytes)
+
+    def data_recv(self, data):
+        # 将接收到的字节数据解码为字符串
+        try:
+            received_text = data.decode('utf-8', errors='ignore')  # 解码并忽略错误
+        except Exception as e:
+            print(f"解码失败: {e}")
+            received_text = ""
+        
+        # 调用用户设置的回调函数（如果已设置）
+        if self.callback:
+            self.callback(received_text)
+
+    def set_RecvFunc(self, callback):
+        """
+        设置接收到数据后的回调函数。
+        :param callback: 回调函数，接收一个 str 类型的参数。
+        """
+        self.callback = callback
+
+# 示例用法
+if __name__ == "__main__":
+    def my_callback(data: str):
+        print(f"Callback received data: {data}")
+
+    subscriber = SignalSubscriber(APPID="1", SignalID="1")
+    subscriber.set_RecvFunc(my_callback)  # 设置回调函数
+    # 等待一段时间以接收数据
+    import time
+    time.sleep(60)
+    subscriber.KLsubscriber.disconnect()

knotlink-0.0.0/knotlink/__init__.py

@@ -0,0 +1,22 @@
+# Copyright (C) 2025 HXH
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/ >.
+
+# KnotLinkClient_Py/__init__.py
+from .kludf import *
+from .OpenSocketQuerier import *
+from .OpenSocketResponser import *
+from .SignalSender import *
+from .SignalSubscriber import *
+from .tcpclient import *

knotlink-0.0.0/knotlink/kludf.py

@@ -0,0 +1,66 @@
+# KLUDF.py
+# Copyright (C) 2025 HXH
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see https://www.gnu.org/licenses/
+
+class KLUDF:
+    def __init__(self):
+        pass
+
+
+class KLKVMap(dict):
+    def serialize(self):
+        """
+        将 KLKVMap 序列化为键值对字符串
+        :return: 键值对字符串
+        """
+        return ";".join(f"{key}={value}" for key, value in self.items())
+
+    def deserialize(self, keyValueString):
+        """
+        将键值对字符串反序列化为 KLKVMap
+        :param keyValueString: 键值对字符串
+        """
+        self.clear()  # 清空当前映射
+        pairs = keyValueString.split(";")
+        for pair in pairs:
+            keyValue = pair.split("=", maxsplit=1)
+            if len(keyValue) == 2:
+                self[keyValue[0]] = keyValue[1]
+
+    def get(self, key , defaultVal = ""):
+        """
+        安全地读取键值对
+        :param key: 键
+        :return: 键对应的值，如果键不存在则返回空字符串
+        """
+        return super().get(key, defaultVal)
+
+
+# 测试代码
+if __name__ == "__main__":
+    kv_map = KLKVMap()
+    kv_map["key1"] = "value1"
+    kv_map["key2"] = "value2"
+
+    print("序列化前：", kv_map)
+    serialized = kv_map.serialize()
+    print("序列化后：", serialized)
+
+    new_kv_map = KLKVMap()
+    new_kv_map.deserialize(serialized)
+    print("反序列化后：", new_kv_map)
+
+    print("获取 key1 的值：", new_kv_map.get("key1"))
+    print("获取不存在的 key3 的值：", new_kv_map.get("key3"))

knotlink-0.0.0/knotlink/tcpclient.py

@@ -0,0 +1,100 @@
+# Copyright (C) 2025 HXH
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/ >.
+
+import socket
+import threading
+import time
+
+class TcpClient:
+    def __init__(self):
+        self.tcp_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+        self.heart_beat_interval = 180  # 设置心跳包发送间隔为180秒（3分钟）
+        self.heart_beat_timer = None
+        self.connected = False
+        self.received_data_callback = None
+
+    def connect_to_server(self, ip, port):
+        try:
+            self.tcp_socket.connect((ip, port))
+            self.connected = True
+            print("连接成功")
+            self.start_heart_beat()
+            threading.Thread(target=self.receive_data, daemon=True).start()
+        except socket.error as e:
+            print("连接失败：", e)
+
+    def start_heart_beat(self):
+        self.heart_beat_timer = threading.Timer(self.heart_beat_interval, self.send_heart_beat)
+        self.heart_beat_timer.start()
+
+    def send_heart_beat(self):
+        if self.connected:
+            try:
+                self.tcp_socket.sendall(b"heartbeat")
+                print("发送心跳包成功")
+            except socket.error as e:
+                print("发送心跳包失败：", e)
+                self.connected = False
+        else:
+            print("无法发送心跳包，连接已断开。")
+        self.start_heart_beat()
+
+    def receive_data(self):
+        while self.connected:
+            try:
+                data = self.tcp_socket.recv(1024)
+                if not data:
+                    print("连接已断开")
+                    self.connected = False
+                    break
+                print("收到数据：", data)
+                if data != b"heartbeat_response":
+                    self.handle_received_data(data)
+            except socket.error as e:
+                print("接收数据失败：", e)
+                self.connected = False
+                break
+
+    def handle_received_data(self, data):
+        # 在这里处理接收到的数据
+        print("处理数据：", data)
+        if self.received_data_callback:
+            self.received_data_callback(data)
+
+    def send_data(self, data):
+        if self.connected:
+            try:
+                self.tcp_socket.sendall(data)
+            except socket.error as e:
+                print("发送数据失败：", e)
+                self.connected = False
+        else:
+            print("无法发送数据，连接已断开。")
+
+    def disconnect(self):
+        self.connected = False
+        self.tcp_socket.close()
+        if self.heart_beat_timer:
+            self.heart_beat_timer.cancel()
+        print("已断开连接")
+
+# 示例用法
+if __name__ == "__main__":
+    client = TcpClient()
+    client.connect_to_server("127.0.0.1", 6370)  # 替换为服务器的 IP 和端口
+    time.sleep(10)  # 等待一段时间
+    client.send_data(b"Hello, Server!")
+    time.sleep(60)  # 继续等待一段时间
+    client.disconnect()

knotlink-0.0.0/knotlink.egg-info/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.1
+Name: knotlink
+Version: 0.0.0
+Summary: A Py-based client for KnotLink communication
+Author: HXH
+Author-email: 1768224274@qq.com
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Intended Audience :: Developers
+Description-Content-Type: text/markdown
+
+# KnotLink 使用教程

knotlink-0.0.0/knotlink.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+README.md
+setup.py
+knotlink/OpenSocketQuerier.py
+knotlink/OpenSocketResponser.py
+knotlink/SignalSender.py
+knotlink/SignalSubscriber.py
+knotlink/__init__.py
+knotlink/kludf.py
+knotlink/tcpclient.py
+knotlink.egg-info/PKG-INFO
+knotlink.egg-info/SOURCES.txt
+knotlink.egg-info/dependency_links.txt
+knotlink.egg-info/top_level.txt

knotlink-0.0.0/knotlink.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

knotlink-0.0.0/knotlink.egg-info/top_level.txt

@@ -0,0 +1 @@
+knotlink

knotlink-0.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

knotlink-0.0.0/setup.py

@@ -0,0 +1,20 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='knotlink',  # 包名
+    version='0.0.0',  # 版本号
+    packages=find_packages(),  # 自动发现包和模块
+    description='A Py-based client for KnotLink communication',  # 简短描述
+    long_description=open('README.md', encoding='utf-8').read(),  # 从 README.md 读取长描述
+    long_description_content_type='text/markdown',  # 长描述的格式
+    author='HXH',  # 作者
+    author_email='1768224274@qq.com',  # 作者邮箱
+    install_requires=[  # 依赖包
+    ],
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'Operating System :: OS Independent',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+        'Intended Audience :: Developers',
+    ],
+)