TISApi 0.0.1__tar.gz

tisapi-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,50 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*.*.*" # Triggers on tags like v0.0.1
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Extract version from tag
+        shell: bash
+        run: echo "VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
+
+      - name: Update pyproject.toml version
+        run: |
+          sed -i "s/^version =.*/version = \"${VERSION#v}\"/" pyproject.toml
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine wheel
+          pip install -r requirements.txt
+
+      - name: Build package
+        run: python -m build
+
+      - name: Sign the distributions
+        env:
+          GPG_SIGNING_KEY: ${{ secrets.GPG_SIGNING_KEY }}
+        run: |
+          echo "$GPG_SIGNING_KEY" | gpg --import
+          gpg --detach-sign --armor dist/*.tar.gz
+          gpg --detach-sign --armor dist/*.whl
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: |
+          twine upload --skip-existing dist/* dist/*.asc

tisapi-0.0.1/.gitignore

@@ -0,0 +1,5 @@
+.env
+dist
+mykey.pub
+mykey.asc
+*.pyc

tisapi-0.0.1/.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
+}

tisapi-0.0.1/.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/TISApi",
+      "program": "d:/TIS/dev/TISApi/build/Debug/outDebug",
+      "MIMode": "gdb",
+      "miDebuggerPath": "gdb",
+      "setupCommands": [
+        {
+          "description": "Enable pretty-printing for gdb",
+          "text": "-enable-pretty-printing",
+          "ignoreFailures": true
+        }
+      ]
+    }
+  ]
+}

tisapi-0.0.1/.vscode/settings.json

@@ -0,0 +1,59 @@
+{
+  "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
+}

tisapi-0.0.1/.vscode/tasks.json

@@ -0,0 +1,53 @@
+{
+    "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": "twine",
+            "args": [
+                "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."
+        }
+    ]
+}

tisapi-0.0.1/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.

tisapi-0.0.1/PKG-INFO

@@ -0,0 +1,60 @@
+Metadata-Version: 2.4
+Name: TISApi
+Version: 0.0.1
+Summary: A library for TIS Control
+Project-URL: Homepage, https://github.com/IbrahimMohamed2001
+Project-URL: Issues, https://github.com/IbrahimMohamed2001/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
+
+# TISApi
+
+![Build Status](https://img.shields.io/badge/build-passing-brightgreen)
+![Version 0.5.14](https://img.shields.io/badge/version-0.5.14-blue)
+![License MIT](https://img.shields.io/badge/license-MIT-green)
+![Python](https://img.shields.io/badge/python-3.11+-orange)
+![signed](https://img.shields.io/badge/signed-yes-green)
+
+TISApi 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 TISApi by adding it to your Manifest file or by using pip. Here's how you can install it using pip:
+
+```bash
+pip install TISApi
+```
+
+## Verifying Package Signatures
+
+This package is signed with GPG to ensure authenticity. Follow these steps to verify:
+
+1. **Install GPG**: Ensure you have GPG installed (`gpg --version`).
+2. **Get My Public Key**:
+    - Import from a keyserver: `gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys 97DADF7C6008FBCEB93506624A93BA55D2B45649`
+    - Import it: `gpg --import mykey.pub`
+3. **Download Files**: Get the `.tar.gz`, `.whl`, and `.asc` files from PyPI or GitHub Releases.
+4. **Verify**:
+
+```bash
+gpg --verify TISApi-0.5.14.tar.gz.asc TISApi-0.5.14.tar.gz
+gpg --verify TISApi-0.5.14-py3-none-any.whl.asc TISApi-0.5.14-py3-none-any.whl
+```
+
+## License
+
+TISApi is licensed under the MIT license. See the [LICENSE](https://github.com/IbrahimMohamed2001/TISApi/blob/main/LICENSE) file for details.

tisapi-0.0.1/README.md

@@ -0,0 +1,46 @@
+# TISApi
+
+![Build Status](https://img.shields.io/badge/build-passing-brightgreen)
+![Version 0.5.14](https://img.shields.io/badge/version-0.5.14-blue)
+![License MIT](https://img.shields.io/badge/license-MIT-green)
+![Python](https://img.shields.io/badge/python-3.11+-orange)
+![signed](https://img.shields.io/badge/signed-yes-green)
+
+TISApi 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 TISApi by adding it to your Manifest file or by using pip. Here's how you can install it using pip:
+
+```bash
+pip install TISApi
+```
+
+## Verifying Package Signatures
+
+This package is signed with GPG to ensure authenticity. Follow these steps to verify:
+
+1. **Install GPG**: Ensure you have GPG installed (`gpg --version`).
+2. **Get My Public Key**:
+    - Import from a keyserver: `gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys 97DADF7C6008FBCEB93506624A93BA55D2B45649`
+    - Import it: `gpg --import mykey.pub`
+3. **Download Files**: Get the `.tar.gz`, `.whl`, and `.asc` files from PyPI or GitHub Releases.
+4. **Verify**:
+
+```bash
+gpg --verify TISApi-0.5.14.tar.gz.asc TISApi-0.5.14.tar.gz
+gpg --verify TISApi-0.5.14-py3-none-any.whl.asc TISApi-0.5.14-py3-none-any.whl
+```
+
+## License
+
+TISApi is licensed under the MIT license. See the [LICENSE](https://github.com/IbrahimMohamed2001/TISApi/blob/main/LICENSE) file for details.

tisapi-0.0.1/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)

tisapi-0.0.1/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "TISApi"
+version = "0.0.1"
+description = "A library for TIS Control"
+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/IbrahimMohamed2001"
+Issues = "https://github.com/IbrahimMohamed2001/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/TISApi"]

tisapi-0.0.1/requirements.txt

@@ -0,0 +1,126 @@
+2to3==1.0
+acme==2.8.0
+aiodns==3.2.0
+aiofiles==24.1.0
+aiohttp==3.9.5
+aiohttp-cors==0.7.0
+aiohttp-fast-url-dispatcher==0.3.0
+aiohttp-isal==0.2.0
+aiohttp-session==2.12.0
+aiooui==0.1.5
+aiosignal==1.3.1
+anyio==4.3.0
+astral==2.2
+async-interrupt==1.1.1
+async-timeout==4.0.3
+asyncio==3.4.3
+atomicwrites==1.4.1
+atomicwrites-homeassistant==1.4.1
+attrs==23.2.0
+awesomeversion==24.2.0
+bcrypt==4.1.2
+bleak==0.21.1
+bleak-retry-connector==3.5.0
+bluetooth-adapters==0.19.0
+bluetooth-auto-recovery==1.4.1
+bluetooth-data-tools==1.19.0
+boto3==1.34.88
+botocore==1.34.88
+btsocket==0.2.0
+build==1.2.1
+certifi==2024.2.2
+cffi==1.16.0
+charset-normalizer==3.3.2
+ciso8601==2.3.1
+colorama==0.4.6
+cryptography==42.0.5
+dbus-fast==2.21.1
+docutils==0.21.2
+ecdsa==0.19.0
+envs==1.4
+fnv-hash-fast==0.5.0
+fnvhash==0.1.0
+frozenlist==1.4.1
+gmqtt==0.6.14
+greenlet==3.0.3
+h11==0.14.0
+ha-philipsjs==3.1.1
+habluetooth==2.8.0
+hass-nabucasa==0.78.0
+home-assistant-bluetooth==1.12.0
+httpcore==1.0.5
+httpx==0.27.0
+idna==3.6
+ifaddr==0.2.0
+importlib_metadata==7.1.0
+isal==1.6.1
+jaraco.classes==3.4.0
+jaraco.context==5.3.0
+jaraco.functools==4.0.1
+Jinja2==3.1.3
+jmespath==1.0.1
+josepy==1.14.0
+keyring==25.2.1
+lru-dict==1.3.0
+markdown-it-py==3.0.0
+MarkupSafe==2.1.5
+mdurl==0.1.2
+more-itertools==10.2.0
+multidict==6.0.5
+nh3==0.2.17
+numpy==1.26.4
+orjson==3.10.1
+packaging==24.0
+paho-mqtt==1.6.0
+pillow==10.3.0
+pkginfo==1.11.0
+psutil==5.9.8
+psutil-home-assistant==0.0.1
+pyasn1==0.6.0
+pycares==4.4.0
+pycognito==2023.5.0
+pycparser==2.22
+Pygments==2.18.0
+PyJWT==2.8.0
+pyOpenSSL==24.1.0
+pyproject_hooks==1.1.0
+pyRFC3339==1.1
+PyRIC==0.1.6.3
+python-dateutil==2.9.0.post0
+python-dotenv==1.0.1
+python-jose==3.3.0
+python-slugify==8.0.4
+pytz==2024.1
+PyYAML==6.0.1
+readme_renderer==43.0
+requests==2.31.0
+requests-toolbelt==1.0.0
+rfc3986==2.0.0
+rich==13.7.1
+rsa==4.9
+ruff==0.4.1
+s3transfer==0.10.1
+setuptools==68.2.2
+six==1.16.0
+slugify==0.0.1
+sniffio==1.3.1
+snitun==0.36.2
+SQLAlchemy==2.0.29
+text-unidecode==1.3
+TISControlProtocol==0.5.11
+tiscontrolv2==0.0.14
+toml==0.10.2
+tqdm==4.66.2
+twine==5.1.0
+typing_extensions==4.11.0
+uart-devices==0.1.0
+ulid-transform==0.9.0
+urllib3==1.26.18
+usb-devices==0.4.5
+voluptuous==0.13.1
+voluptuous-serialize==2.6.0
+watchdog==4.0.0
+wheel==0.41.2
+yarl==1.9.4
+zipp==3.19.2
+

tisapi-0.0.1/src/TISApi/BytesHelper.py

@@ -0,0 +1,65 @@
+import binascii
+from TISApi.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]

tisapi-0.0.1/src/TISApi/DiscoveryHelpers.py

@@ -0,0 +1,6 @@
+DEVICE_APPLIANCES = {
+    (0x1B, 0xBA): {
+        "name": "RCU-8OUT-8IN",
+        "appliances": {"switch": 8},
+    }
+}

tisapi-0.0.1/src/TISApi/Protocols/__init__.py

@@ -0,0 +1,23 @@
+from asyncio import get_event_loop, AbstractEventLoop
+import socket
+from TISApi.Protocols.udp.PacketProtocol import PacketProtocol
+from homeassistant.core import HomeAssistant
+
+loop = get_event_loop()
+
+
+async def setup_udp_protocol(
+    sock: socket,
+    loop: AbstractEventLoop,
+    udp_ip: str,
+    udp_port: int,
+    hass: HomeAssistant,
+) -> 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

tisapi-0.0.1/src/TISApi/Protocols/udp/AckCoordinator.py

@@ -0,0 +1,22 @@
+import logging
+import asyncio
+from TISApi.shared import ack_events
+from typing import Union
+
+
+class AckCoordinator:
+    def __init__(self):
+        self.ack_events = ack_events
+
+    def create_ack_event(self, unique_id: Union[str, tuple]) -> asyncio.Event:
+        logging.error(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]

tisapi-0.0.1/src/TISApi/Protocols/udp/PacketDispatcher.py

@@ -0,0 +1,20 @@
+from homeassistant.core import HomeAssistant
+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.error(f"unknown operation code: {info['operation_code']}")
+        except Exception as e:
+            logging.error(f"error in dispatching packet: {e} , {info}")