TISControlProtocol 1.0.36__tar.gz

tiscontrolprotocol-1.0.36/.gitignore

@@ -0,0 +1,2 @@
+.env
+dist

tiscontrolprotocol-1.0.36/.vscode/c_cpp_properties.json

@@ -0,0 +1,18 @@
+{
+  "configurations": [
+    {
+      "name": "windows-gcc-x64",
+      "includePath": [
+        "${workspaceFolder}/**"
+      ],
+      "compilerPath": "gcc",
+      "cStandard": "${default}",
+      "cppStandard": "${default}",
+      "intelliSenseMode": "windows-gcc-x64",
+      "compilerArgs": [
+        ""
+      ]
+    }
+  ],
+  "version": 4
+}

tiscontrolprotocol-1.0.36/.vscode/launch.json

@@ -0,0 +1,24 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "C/C++ Runner: Debug Session",
+      "type": "cppdbg",
+      "request": "launch",
+      "args": [],
+      "stopAtEntry": false,
+      "externalConsole": true,
+      "cwd": "d:/TIS/dev/TISControlProtocol",
+      "program": "d:/TIS/dev/TISControlProtocol/build/Debug/outDebug",
+      "MIMode": "gdb",
+      "miDebuggerPath": "gdb",
+      "setupCommands": [
+        {
+          "description": "Enable pretty-printing for gdb",
+          "text": "-enable-pretty-printing",
+          "ignoreFailures": true
+        }
+      ]
+    }
+  ]
+}

tiscontrolprotocol-1.0.36/.vscode/settings.json

@@ -0,0 +1,67 @@
+{
+  "C_Cpp_Runner.cCompilerPath": "gcc",
+  "C_Cpp_Runner.cppCompilerPath": "g++",
+  "C_Cpp_Runner.debuggerPath": "gdb",
+  "C_Cpp_Runner.cStandard": "",
+  "C_Cpp_Runner.cppStandard": "",
+  "C_Cpp_Runner.msvcBatchPath": "C:/Program Files/Microsoft Visual Studio/VR_NR/Community/VC/Auxiliary/Build/vcvarsall.bat",
+  "C_Cpp_Runner.useMsvc": false,
+  "C_Cpp_Runner.warnings": [
+    "-Wall",
+    "-Wextra",
+    "-Wpedantic",
+    "-Wshadow",
+    "-Wformat=2",
+    "-Wcast-align",
+    "-Wconversion",
+    "-Wsign-conversion",
+    "-Wnull-dereference"
+  ],
+  "C_Cpp_Runner.msvcWarnings": [
+    "/W4",
+    "/permissive-",
+    "/w14242",
+    "/w14287",
+    "/w14296",
+    "/w14311",
+    "/w14826",
+    "/w44062",
+    "/w44242",
+    "/w14905",
+    "/w14906",
+    "/w14263",
+    "/w44265",
+    "/w14928"
+  ],
+  "C_Cpp_Runner.enableWarnings": true,
+  "C_Cpp_Runner.warningsAsError": false,
+  "C_Cpp_Runner.compilerArgs": [],
+  "C_Cpp_Runner.linkerArgs": [],
+  "C_Cpp_Runner.includePaths": [],
+  "C_Cpp_Runner.includeSearch": [
+    "*",
+    "**/*"
+  ],
+  "C_Cpp_Runner.excludeSearch": [
+    "**/build",
+    "**/build/**",
+    "**/.*",
+    "**/.*/**",
+    "**/.vscode",
+    "**/.vscode/**"
+  ],
+  "C_Cpp_Runner.useAddressSanitizer": false,
+  "C_Cpp_Runner.useUndefinedSanitizer": false,
+  "C_Cpp_Runner.useLeakSanitizer": false,
+  "C_Cpp_Runner.showCompilationTime": false,
+  "C_Cpp_Runner.useLinkTimeOptimization": false,
+  "C_Cpp_Runner.msvcSecureNoWarnings": false,
+  "cSpell.words": [
+    "clientsession",
+    "DGRAM",
+    "dotenv",
+    "Fernet",
+    "hass",
+    "homeassistant"
+  ]
+}

tiscontrolprotocol-1.0.36/.vscode/tasks.json

@@ -0,0 +1,43 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Update Version",
+      "type": "shell",
+      "command": "python",
+      "args": [
+        "${workspaceFolder}/dev/pump_version.py",
+        "${workspaceFolder}/pyproject.toml"
+      ],
+      "problemMatcher": [],
+      "detail": "Interactively update the version in pyproject.toml."
+    },
+    {
+      "label": "Build Package",
+      "type": "shell",
+      "command": "python",
+      "args": ["-m", "build"],
+      "problemMatcher": [],
+      "detail": "Build the latest version of the package.",
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      }
+    },
+    {
+      "label": "Upload Package",
+      "type": "shell",
+      "command": "python",
+      "args": ["-m", "twine", "upload", "dist/*"],
+      "problemMatcher": [],
+      "detail": "Upload the latest version of the package to PyPI."
+    },
+    {
+      "label": "Update, Build, and Upload",
+      "dependsOn": ["Update Version", "Build Package", "Upload Package"],
+      "dependsOrder": "sequence",
+      "problemMatcher": [],
+      "detail": "Update the version, build the package, and upload it to PyPI."
+    }
+  ]
+}

tiscontrolprotocol-1.0.36/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+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.

tiscontrolprotocol-1.0.36/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include src/TISControlProtocol/views *

tiscontrolprotocol-1.0.36/PKG-INFO

@@ -0,0 +1,51 @@
+Metadata-Version: 2.4
+Name: TISControlProtocol
+Version: 1.0.36
+Summary: A library for TIS Control Protocol
+Project-URL: Homepage, https://github.com/TISControlHass
+Project-URL: Issues, https://github.com/TISControlHass/issues
+Author-email: Ibrahim Mohamed <ibrali2001.ia@gmail.com>
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# TISControlProtocol
+
+![Build Status](https://img.shields.io/badge/build-passing-brightgreen)
+![Version 0.1.0](https://img.shields.io/badge/version-3.0.0-blue)
+![License MIT](https://img.shields.io/badge/license-MIT-green)
+
+TISControlProtocol is a powerful Python package for controlling TIS devices. It provides a simple and intuitive API for interacting with TIS devices, making it easy to integrate TIS devices into your Python applications.
+
+## Features
+
+- ✅ Fully Supports Asynchronous Operations
+- ✅ Flawless feedback mechanism to prevent data loss
+- ✅ Debounce mechanism to prevent multiple commands from being sent for protection
+- ✅ Easy to use API for controlling TIS devices
+- ✅ Clean and simple codebase
+- ✅ Ready to integrate with Home Assistant
+
+## Installation
+
+You can install TISControlProtocol by adding it to your Manifest file or by using pip. Here's how you can install it using pip:
+
+```bash
+pip install TISControlProtocol
+```
+
+## Building
+
+To build the package, you can use the following commands:
+
+```bash
+python -m build
+twine upload dist/*
+```
+
+## License
+
+TISControlProtocol is licensed under the MIT license. See the [LICENSE](https://your-license-link) file for details.

tiscontrolprotocol-1.0.36/README.md

@@ -0,0 +1,37 @@
+# TISControlProtocol
+
+![Build Status](https://img.shields.io/badge/build-passing-brightgreen)
+![Version 0.1.0](https://img.shields.io/badge/version-3.0.0-blue)
+![License MIT](https://img.shields.io/badge/license-MIT-green)
+
+TISControlProtocol is a powerful Python package for controlling TIS devices. It provides a simple and intuitive API for interacting with TIS devices, making it easy to integrate TIS devices into your Python applications.
+
+## Features
+
+- ✅ Fully Supports Asynchronous Operations
+- ✅ Flawless feedback mechanism to prevent data loss
+- ✅ Debounce mechanism to prevent multiple commands from being sent for protection
+- ✅ Easy to use API for controlling TIS devices
+- ✅ Clean and simple codebase
+- ✅ Ready to integrate with Home Assistant
+
+## Installation
+
+You can install TISControlProtocol by adding it to your Manifest file or by using pip. Here's how you can install it using pip:
+
+```bash
+pip install TISControlProtocol
+```
+
+## Building
+
+To build the package, you can use the following commands:
+
+```bash
+python -m build
+twine upload dist/*
+```
+
+## License
+
+TISControlProtocol is licensed under the MIT license. See the [LICENSE](https://your-license-link) file for details.

tiscontrolprotocol-1.0.36/dev/pump_version.py

@@ -0,0 +1,53 @@
+import toml
+import sys
+
+
+def bump_version(version, part):
+    major, minor, patch = map(int, version.split("."))
+    if part == "major":
+        major += 1
+        minor = 0
+        patch = 0
+    elif part == "minor":
+        minor += 1
+        patch = 0
+    elif part == "patch":
+        patch += 1
+    else:
+        raise ValueError("Part must be 'major', 'minor', or 'patch'")
+    return f"{major}.{minor}.{patch}"
+
+
+def update_version_file(file_path, part):
+    with open(file_path, "r") as f:
+        data = toml.load(f)
+
+    current_version = data["project"]["version"]
+    new_version = bump_version(current_version, part)
+    data["project"]["version"] = new_version
+
+    with open(file_path, "w") as f:
+        toml.dump(data, f)
+
+    print(f"Version updated from {current_version} to {new_version}")
+
+
+if __name__ == "__main__":
+    if len(sys.argv) != 2:
+        print("Usage: python update_version_interactive.py <path_to_pyproject.toml>")
+        sys.exit(1)
+
+    file_path = sys.argv[1]
+    print("Select the part to bump:")
+    print("1. Major")
+    print("2. Minor")
+    print("3. Patch")
+    choice = input("Enter the number (1/2/3): ").strip()
+
+    part_map = {"1": "major", "2": "minor", "3": "patch"}
+    part = part_map.get(choice)
+    if not part:
+        print("Invalid choice. Must be 1, 2, or 3.")
+        sys.exit(1)
+
+    update_version_file(file_path, part)

tiscontrolprotocol-1.0.36/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "TISControlProtocol"
+version = "1.0.36"
+description = "A library for TIS Control Protocol"
+readme = "README.md"
+requires-python = ">=3.11"
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: POSIX :: Linux",
+]
+[[project.authors]]
+name = "Ibrahim Mohamed"
+email = "ibrali2001.ia@gmail.com"
+
+[project.urls]
+Homepage = "https://github.com/TISControlHass"
+Issues = "https://github.com/TISControlHass/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/TISControlProtocol"]

tiscontrolprotocol-1.0.36/src/TISControlProtocol/BytesHelper.py

@@ -0,0 +1,65 @@
+import binascii
+from TISControlProtocol.crc import checkCRC, packCRC
+
+
+def bytes2hex(data, rtype=[]):
+    """A helper function to parse bytes to hex
+
+    :param data: the raw bytes array
+    :type data: bytes array
+    :param rtype: determine return type whether list of ints or single hex str, defaults to []
+    :type rtype: list, optional
+    :return: list of ints or hex string
+    :rtype: list | str
+    """
+    hex_string = binascii.hexlify(data).decode()
+    hex_list = [int(hex_string[i : i + 2], 16) for i in range(0, len(hex_string), 2)]
+    if isinstance(rtype, list):
+        return hex_list
+    else:
+        return hex_string
+
+
+def build_packet(
+    operation_code: list,
+    ip_address: str,
+    destination_mac: str = "AA:AA:AA:AA:AA:AA:AA:AA",
+    source_mac: str = "CB:CB:CB:CB:CB:CB:CB:CB",
+    device_id: list = [],
+    source_device_id: list = [0x01, 0xFE],
+    additional_packets: list = [],
+    header="SMARTCLOUD",
+):
+
+    # test if all params are loaded
+    ip_bytes = [int(part) for part in ip_address.split(".")]
+    header_bytes = [ord(char) for char in header]
+    source_mac = [int(part, 16) for part in source_mac.split(":")]
+    destination_mac = [int(part, 16) for part in destination_mac.split(":")]
+    # TODO: modify length
+    # length = 21 + len(additional_packets)
+    length = 11 + len(additional_packets)
+    packet = (
+        ip_bytes
+        + header_bytes
+        + [0xAA, 0xAA]
+        + [length]
+        # + source_mac
+        + source_device_id
+        + [0xFF, 0xFE]
+        + operation_code
+        # + destination_mac
+        + device_id
+        + additional_packets
+    )
+    packet = packCRC(packet)
+    return packet
+
+
+def decode_mac(mac: list):
+    return ":".join([f"{byte:02X}" for byte in mac])
+
+
+def int_to_8_bit_binary(number):
+    binary_string = bin(number)[2:]
+    return binary_string.zfill(8)[::-1]

tiscontrolprotocol-1.0.36/src/TISControlProtocol/Protocols/__init__.py

@@ -0,0 +1,18 @@
+from asyncio import get_event_loop, AbstractEventLoop
+import socket
+from TISControlProtocol.Protocols.udp.PacketProtocol import PacketProtocol
+
+loop = get_event_loop()
+
+
+async def setup_udp_protocol(
+    sock: socket, loop: AbstractEventLoop, udp_ip, udp_port, hass
+) -> tuple[socket.socket, PacketProtocol]:
+    transport, protocol = await loop.create_datagram_endpoint(
+        lambda: PacketProtocol(sock, udp_ip, udp_port, hass),
+        remote_addr=(udp_ip, udp_port),
+        local_addr=("0.0.0.0", udp_port),
+        allow_broadcast=True,
+        reuse_port=True,
+    )
+    return transport, protocol

tiscontrolprotocol-1.0.36/src/TISControlProtocol/Protocols/udp/AckCoordinator.py

@@ -0,0 +1,50 @@
+import asyncio
+from TISControlProtocol.shared import ack_events
+from typing import Union
+import logging
+
+class AckCoordinator:
+    def __init__(self):
+        self.ack_events = ack_events
+
+    def create_ack_event(self, unique_id: Union[str, tuple]) -> asyncio.Event:
+        logging.info(f"creating ack event for {unique_id}")
+        event = asyncio.Event()
+        self.ack_events[unique_id] = event
+        return event
+
+    def get_ack_event(self, unique_id: Union[str, tuple]) -> Union[asyncio.Event, None]:
+        return self.ack_events.get(unique_id)
+
+    def remove_ack_event(self, unique_id: Union[str, tuple]) -> None:
+        if unique_id in self.ack_events:
+            del self.ack_events[unique_id]
+
+    # async def create_ack_task(
+    #     self,
+    #     sender,
+    #     packet,
+    #     packet_dict=None,
+    #     channel_number=None,
+    #     attempts=3,
+    #     timeout=5.0,
+    # ) -> bool:
+    #     unique_id = (
+    #         (tuple(packet_dict["device_id"])),
+    #         packet_dict["operation_code"],
+    #         channel_number,
+    #     )
+    #     event = self.create_ack_event(unique_id)
+
+    #     for attempt in range(attempts):
+    #         sender.send_packet(packet)
+    #         try:
+    #             await asyncio.wait_for(event.wait(), timeout)
+    #             self.remove_ack_event(unique_id)
+    #             return True
+    #         except asyncio.TimeoutError:
+    #             print(
+    #                 f"ack not received within {timeout} seconds, attempt {attempt + 1}"
+    #             )
+
+    #     return False

tiscontrolprotocol-1.0.36/src/TISControlProtocol/Protocols/udp/PacketDispatcher.py

@@ -0,0 +1,20 @@
+from homeassistant.core import HomeAssistant  # type: ignore
+import logging
+
+
+class PacketDispatcher:
+    def __init__(self, hass: HomeAssistant, OPERATIONS_DICT: dict):
+        self.hass = hass
+        self.operations_dict = OPERATIONS_DICT
+
+    async def dispatch_packet(self, info):
+        try:
+            packet_handler = self.operations_dict.get(
+                tuple(info["operation_code"]), "unknown operation"
+            )
+            if packet_handler != "unknown operation":
+                await packet_handler(self.hass, info)
+            else:
+                logging.info(f"unknown operation code: {info['operation_code']}")
+        except Exception as e:
+            logging.info(f"error in dispatching packet: {e} , {info}")

tiscontrolprotocol-1.0.36/src/TISControlProtocol/Protocols/udp/PacketExtractor.py

@@ -0,0 +1,22 @@
+from TISControlProtocol.BytesHelper import checkCRC
+import logging
+
+
+# PacketExtractor.py
+class PacketExtractor:
+    @staticmethod
+    def extract_info(packet: list):
+        packet_check = checkCRC(packet)
+        info = {}
+        if packet_check:
+            logging.info("correct packet")
+            info["source_ip"] = packet[0:4]
+            info["device_id"] = packet[17:19]
+            info["device_type"] = packet[19:21]
+            info["operation_code"] = packet[21:23]
+            info["source_device_id"] = packet[23:25]
+            info["additional_bytes"] = packet[25:-2]
+
+        else:
+            logging.info("wrong packet")
+        return info

tiscontrolprotocol-1.0.36/src/TISControlProtocol/Protocols/udp/PacketHandlers/AnalogFeedbackHandler.py

@@ -0,0 +1,23 @@
+from homeassistant.core import HomeAssistant
+import logging
+
+#TODO get a way to set 4 sensors together
+async def handle_analog_feedback(hass: HomeAssistant, info: dict):
+    """
+    Handle the feedback from an analog sensor.
+    """
+    device_id = info["device_id"]
+    channels_num = int(info["additional_bytes"][0])
+    analog = info["additional_bytes"][1:channels_num + 1]
+
+    event_data = {
+        "device_id": device_id,
+        "feedback_type": "analog_feedback",
+        "analog": analog,
+        "additional_bytes": info["additional_bytes"],
+    }
+
+    try:
+        hass.bus.async_fire(str(info["device_id"]), event_data)
+    except Exception as e:
+        logging.error(f"error in firing event for feedback: {e}")

tiscontrolprotocol-1.0.36/src/TISControlProtocol/Protocols/udp/PacketHandlers/AutoBinaryFeedbackHandler.py

@@ -0,0 +1,18 @@
+from homeassistant.core import HomeAssistant  # type: ignore
+import logging
+
+
+async def handle_auto_binary_feedback(hass: HomeAssistant, info: dict):
+    logging.info(f"Auto Binary Feedback: {info}")
+    channels_number: int = info["additional_bytes"][0]
+    channels_values: list = info["additional_bytes"][channels_number :]
+
+    event_data = {
+        "device_id": info["device_id"],
+        "feedback_type": "auto_binary_feedback",
+        "channels_values": channels_values,
+    }
+    # try:
+    #     hass.bus.async_fire(str(info["device_id"]), event_data)
+    # except Exception as e:
+    #     logging.error(f"error in firing event: {e}")

tiscontrolprotocol-1.0.36/src/TISControlProtocol/Protocols/udp/PacketHandlers/BinaryFeedbackHandler.py

@@ -0,0 +1,17 @@
+from homeassistant.core import HomeAssistant  # type: ignore
+import logging
+
+
+async def handle_binary_feedback(hass: HomeAssistant, info: dict):
+    # remove auxilary bytes which represents number of scenarios
+    len_aux = info["additional_bytes"][0]
+    info["additional_bytes"] = info["additional_bytes"][len_aux + 1 :]
+    event_data = {
+        "device_id": info["device_id"],
+        "feedback_type": "binary_feedback",
+        "additional_bytes": info["additional_bytes"],
+    }
+    try:
+        hass.bus.async_fire(str(info["device_id"]), event_data)
+    except Exception as e:
+        logging.error(f"error in firing event: {e}")

tiscontrolprotocol-1.0.36/src/TISControlProtocol/Protocols/udp/PacketHandlers/ClimateBinaryFeedbackHandler.py

@@ -0,0 +1,62 @@
+from homeassistant.core import HomeAssistant
+import logging
+
+AC_NUMBER_MAP = {0x19: 0, 0x1A: 1, 0x1B: 2, 0x1C: 3, 0x1D: 4, 0x1E: 5, 0x1F: 6, 0x20: 7}
+FLOOR_NUMBER_MAP = {0x22: 0, 0x23: 1, 0x24: 2, 0x25: 3}
+
+
+async def handle_climate_binary_feedback(hass: HomeAssistant, info: dict):
+    # NOTE: Sometimes the packet contains number of floor heater and sometimes no floor heater num is given
+    # check sub_operation or number
+    if info["additional_bytes"][0] <= 0x18:
+        sub_operation = info["additional_bytes"][0]
+        operation_value = info["additional_bytes"][1]
+
+        if info["additional_bytes"][0] < 0x14:
+            feedback_type = "ac_feedback"
+            number = 0
+
+        else:
+            feedback_type = "floor_feedback"
+            number = 0
+                
+    elif info["additional_bytes"][0] == 0x2E:
+        number = (info["additional_bytes"][1]) - 1
+        new_sub_operation = info["additional_bytes"][2] 
+        if new_sub_operation == 0x03:
+            sub_operation = 0x14
+
+        elif new_sub_operation == 0x04:
+            sub_operation = 0x18
+
+        operation_value = info["additional_bytes"][3]
+
+        
+
+    else:
+        ac_number = AC_NUMBER_MAP.get(info["additional_bytes"][0], None)
+        floor_number = FLOOR_NUMBER_MAP.get(info["additional_bytes"][0], None)
+        sub_operation = info["additional_bytes"][1]
+        operation_value = info["additional_bytes"][2]
+
+        if ac_number is not None:
+            feedback_type = "ac_feedback"
+            number = ac_number
+
+        else:
+            feedback_type = "floor_feedback"
+            number = floor_number
+
+    event_data = {
+        "device_id": info["device_id"],
+        "feedback_type": feedback_type,
+        "number": number,
+        "sub_operation": sub_operation,
+        "operation_value": operation_value,
+    }
+
+    try:
+        hass.bus.async_fire(str(info["device_id"]), event_data)
+
+    except Exception as e:
+        logging.error(f"error in firing event: {e}")