grafikeye 0.1.0__tar.gz

grafikeye-0.1.0/.github/workflows/release.yaml

@@ -0,0 +1,64 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v6
+
+      - name: Verify version
+        run: |
+          python - <<'PY'
+          import os
+          import tomllib
+
+          with open("pyproject.toml", "rb") as file:
+              version = tomllib.load(file)["project"]["version"]
+
+          tag = os.environ["GITHUB_REF_NAME"]
+
+          if tag != f"v{version}":
+              raise SystemExit(f"Release tag {tag} does not match package version {version}")
+          PY
+
+      - name: Build package
+        run: uv build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: distributions
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/grafikeye
+
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: distributions
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

grafikeye-0.1.0/.gitignore

@@ -0,0 +1,223 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# uv
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Conda environments
+conda-meta/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs/Zensical documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
+#   can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, you
+#   could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

grafikeye-0.1.0/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.5
+Name: grafikeye
+Version: 0.1.0
+Summary: Asynchronous Python client for Lutron GRAFIK Eye 3000 and 4000 Series lighting systems
+License-Expression: MIT
+Requires-Python: >=3.10
+Requires-Dist: telnetlib3
+Description-Content-Type: text/markdown
+
+# GRAFIK Eye
+
+Asynchronous Python library for controlling Lutron GRAFIK Eye lighting systems over Telnet.
+
+Supports the GRAFIK Eye 3000 and 4000 Series through the GRX-CI-NWK-E Ethernet interface.
+
+## Installation
+
+```bash
+pip install grafikeye
+```
+
+## Documentation
+
+- [GRAFIK Eye RS232/Ethernet Protocol Reference](https://assets.lutron.com/a/documents/040196d.pdf)
+- [GRAFIK Eye Control Interface Operating Instructions](https://assets.lutron.com/a/documents/040229aeng.pdf)

grafikeye-0.1.0/README.md

@@ -0,0 +1,16 @@
+# GRAFIK Eye
+
+Asynchronous Python library for controlling Lutron GRAFIK Eye lighting systems over Telnet.
+
+Supports the GRAFIK Eye 3000 and 4000 Series through the GRX-CI-NWK-E Ethernet interface.
+
+## Installation
+
+```bash
+pip install grafikeye
+```
+
+## Documentation
+
+- [GRAFIK Eye RS232/Ethernet Protocol Reference](https://assets.lutron.com/a/documents/040196d.pdf)
+- [GRAFIK Eye Control Interface Operating Instructions](https://assets.lutron.com/a/documents/040229aeng.pdf)

grafikeye-0.1.0/pyproject.toml

@@ -0,0 +1,58 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "grafikeye"
+version = "0.1.0"
+description = "Asynchronous Python client for Lutron GRAFIK Eye 3000 and 4000 Series lighting systems"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+dependencies = [
+    "telnetlib3",
+]
+
+[dependency-groups]
+dev = [
+    "textual",
+    "pytest",
+    "pytest-asyncio",
+    "ruff",
+    "pytest-cov>=7.1.0",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/grafikeye"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = ["--import-mode=importlib"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+
+[tool.ruff]
+target-version = "py310"
+line-length = 88
+
+[tool.ruff.lint]
+select = [
+    "E4",     # Import errors
+    "E7",     # Statement errors
+    "E9",     # Runtime errors
+    "F",      # Pyflakes
+    "I",      # Import sorting
+    "UP",     # Modern Python syntax
+    "B",      # Common bugs
+    "ASYNC",  # Async programming
+    "RUF",    # Ruff-specific rules
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[tool.uv.workspace]
+members = [
+    "test",
+]

grafikeye-0.1.0/src/grafikeye/__init__.py

@@ -0,0 +1,19 @@
+from .client import ConnectionStatus, ControlUnit, GrafikEyeClient
+from .exceptions import (
+    GrafikEyeAuthenticationError,
+    GrafikEyeClientError,
+    GrafikEyeConnectionError,
+    GrafikEyeConnectionInUseError,
+    GrafikEyeConnectionTimeoutError,
+)
+
+__all__ = [
+    "ConnectionStatus",
+    "ControlUnit",
+    "GrafikEyeAuthenticationError",
+    "GrafikEyeClient",
+    "GrafikEyeClientError",
+    "GrafikEyeConnectionError",
+    "GrafikEyeConnectionInUseError",
+    "GrafikEyeConnectionTimeoutError",
+]

grafikeye-0.1.0/src/grafikeye/client.py

@@ -0,0 +1,294 @@
+import asyncio
+import logging
+import re
+from collections.abc import Callable
+from dataclasses import dataclass
+from enum import Enum, auto
+
+import telnetlib3
+
+from .const import DEFAULT_LOGIN, DEFAULT_PORT
+from .exceptions import (
+    GrafikEyeAuthenticationError,
+    GrafikEyeConnectionError,
+    GrafikEyeConnectionInUseError,
+    GrafikEyeConnectionTimeoutError,
+)
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class ConnectionStatus(Enum):
+    DISCONNECTED = auto()
+    CONNECTING = auto()
+    CONNECTED = auto()
+
+
+@dataclass(frozen=True)
+class ControlUnit:
+    id: int
+    active_scene: int
+
+
+class GrafikEyeClient:
+    SCENE_CODES = "0123456789ABCDEFG"
+
+    def __init__(
+        self,
+        host: str,
+        port: int = DEFAULT_PORT,
+        login: str = DEFAULT_LOGIN,
+        poll_interval: float | None = None,
+    ) -> None:
+        if poll_interval is not None and poll_interval <= 0:
+            raise ValueError("Poll interval must be greater than zero")
+
+        self._host = host
+        self._port = port
+        self._login = login
+        self._poll_interval = poll_interval
+        self._connection_status = ConnectionStatus.DISCONNECTED
+        self._reader: telnetlib3.TelnetReader | None = None
+        self._writer: telnetlib3.TelnetWriter | None = None
+        self._reader_task: asyncio.Task[None] | None = None
+        self._poll_task: asyncio.Task[None] | None = None
+        self._connection_status_callbacks: list[Callable[[ConnectionStatus], None]] = []
+        self._disconnect_callbacks: list[Callable[[], None]] = []
+        self._active_scenes_callbacks: list[Callable[[dict[int, int]], None]] = []
+        self._scene_callbacks: dict[int, list[Callable[[int], None]]] = {
+            i + 1: [] for i in range(8)
+        }
+        self._button_callbacks: dict[int, list[Callable[[int, bool], None]]] = {
+            i + 1: [] for i in range(8)
+        }
+        self._message_handlers: dict[re.Pattern[str], Callable[[re.Match[str]], None]] = {
+            re.compile(r":ss\s*([0-9A-HMLR]{8})"): self._handle_active_scenes,
+            re.compile(r"^([A-Ha-h])(\d+)$"): self._handle_button,
+        }
+
+    @property
+    def connection_status(self) -> ConnectionStatus:
+        return self._connection_status
+
+    async def connect(self) -> None:
+        self._set_connection_status(ConnectionStatus.CONNECTING)
+        _LOGGER.debug("Connecting to %s:%d", self._host, self._port)
+
+        try:
+            async with asyncio.timeout(10):
+                self._reader, self._writer = await telnetlib3.open_connection(
+                    host=self._host,
+                    port=self._port,
+                    connect_minwait=1.0,
+                )
+                await self._authenticate()
+        except BaseException as error:
+            await self._cleanup()
+            if isinstance(error, GrafikEyeConnectionError):
+                raise
+            if isinstance(error, TimeoutError):
+                raise GrafikEyeConnectionTimeoutError from error
+            if isinstance(error, OSError):
+                raise GrafikEyeConnectionError from error
+            raise
+
+        _LOGGER.debug("Connected to %s:%d", self._host, self._port)
+        self._reader_task = asyncio.create_task(self._read_messages())
+
+        if self._poll_interval is not None:
+            self._poll_task = asyncio.create_task(self._poll_active_scenes())
+
+        self._set_connection_status(ConnectionStatus.CONNECTED)
+
+    async def disconnect(self) -> None:
+        was_connected = self._connection_status == ConnectionStatus.CONNECTED
+
+        await self._cleanup()
+
+        if was_connected:
+            _LOGGER.debug("Disconnected from %s:%d", self._host, self._port)
+
+    async def select_scene(self, scene: int, control_units: int | list[int]) -> None:
+        if not 0 <= scene <= 16:
+            raise ValueError("Scene must be between 0 and 16")
+
+        scene_code = self.SCENE_CODES[scene]
+        control_units_str = (
+            str(control_units)
+            if isinstance(control_units, int)
+            else "".join(map(str, control_units))
+        )
+        self._send_command(f"A{scene_code}{control_units_str}")
+
+    async def get_control_units(self) -> list[ControlUnit]:
+        received = asyncio.Event()
+        scenes: dict[int, int] = {}
+
+        def callback(active_scenes: dict[int, int]) -> None:
+            nonlocal scenes
+            scenes = active_scenes
+            received.set()
+
+        unsubscribe = self._register_active_scenes_callback(callback)
+
+        try:
+            self._send_command("G")
+            await asyncio.wait_for(received.wait(), timeout=5)
+            return [
+                ControlUnit(id=unit_id, active_scene=scene)
+                for unit_id, scene in scenes.items()
+            ]
+        finally:
+            unsubscribe()
+
+    def register_connection_status_callback(
+        self,
+        callback: Callable[[ConnectionStatus], None],
+    ) -> Callable[[], None]:
+        self._connection_status_callbacks.append(callback)
+        return lambda: self._connection_status_callbacks.remove(callback)
+
+    def register_disconnect_callback(
+        self,
+        callback: Callable[[], None],
+    ) -> Callable[[], None]:
+        self._disconnect_callbacks.append(callback)
+        return lambda: self._disconnect_callbacks.remove(callback)
+
+    def register_scene_callback(
+        self,
+        control_unit_id: int,
+        scene_callback: Callable[[int], None],
+    ) -> Callable[[], None]:
+        callbacks = self._scene_callbacks[control_unit_id]
+        callbacks.append(scene_callback)
+        return lambda: callbacks.remove(scene_callback)
+
+    def register_button_callback(
+        self,
+        control_unit_id: int,
+        button_callback: Callable[[int, bool], None],
+    ) -> Callable[[], None]:
+        callbacks = self._button_callbacks[control_unit_id]
+        callbacks.append(button_callback)
+        return lambda: callbacks.remove(button_callback)
+
+    def _register_active_scenes_callback(
+        self,
+        callback: Callable[[dict[int, int]], None],
+    ) -> Callable[[], None]:
+        self._active_scenes_callbacks.append(callback)
+        return lambda: self._active_scenes_callbacks.remove(callback)
+
+    def _set_connection_status(self, status: ConnectionStatus) -> None:
+        if self._connection_status == status:
+            return
+
+        was_connected = self._connection_status == ConnectionStatus.CONNECTED
+        self._connection_status = status
+
+        for callback in self._connection_status_callbacks.copy():
+            callback(status)
+
+        if was_connected and status == ConnectionStatus.DISCONNECTED:
+            for callback in self._disconnect_callbacks.copy():
+                callback()
+
+    async def _authenticate(self) -> None:
+        try:
+            await self._reader.readuntil(b"login: ")
+        except asyncio.IncompleteReadError as error:  # EOF
+            raise GrafikEyeConnectionError from error
+
+        self._writer.write(self._login + "\r\n")
+
+        while True:
+            response = await self._reader.readline()
+            if response == "":  # EOF
+                raise GrafikEyeConnectionError
+            if "login incorrect" in response:
+                raise GrafikEyeAuthenticationError
+            if "connection in use" in response:
+                raise GrafikEyeConnectionInUseError
+            if "connection established" in response:
+                return
+
+    async def _poll_active_scenes(self) -> None:
+        while True:
+            try:
+                await self.get_control_units()
+            except TimeoutError:
+                _LOGGER.debug("Timed out polling active scenes")
+
+            await asyncio.sleep(self._poll_interval)
+
+    async def _read_messages(self) -> None:
+        while True:
+            try:
+                message = await self._reader.readline()
+            except OSError as error:
+                _LOGGER.warning("Connection error: %s", error)
+                await self.disconnect()
+                return
+
+            if message == "":  # EOF
+                await self.disconnect()
+                return
+
+            message = message.strip()
+            _LOGGER.debug("Received message: %s", message)
+
+            for pattern, handler in self._message_handlers.items():
+                if match := pattern.search(message):
+                    _LOGGER.debug("Matched message handler %s -> %s", pattern.pattern, handler.__name__)
+                    handler(match)
+                    break
+
+    async def _cleanup(self) -> None:
+        for task in (self._poll_task, self._reader_task):
+            if task is not None and task is not asyncio.current_task():
+                task.cancel()
+                try:
+                    await task
+                except asyncio.CancelledError:
+                    pass
+
+        self._poll_task = None
+        self._reader_task = None
+
+        if self._writer is not None:
+            self._writer.close()
+            self._writer = None
+
+        self._reader = None
+        self._set_connection_status(ConnectionStatus.DISCONNECTED)
+
+    def _handle_active_scenes(self, match: re.Match[str]) -> None:
+        scenes = {
+            i + 1: self.SCENE_CODES.index(scene)
+            for i, scene in enumerate(match.group(1))
+            if scene not in "HMRL"
+        }
+
+        _LOGGER.debug("Active scenes updated: %s", scenes)
+
+        for callback in self._active_scenes_callbacks.copy():
+            callback(scenes)
+
+        for control_unit_id, scene_id in scenes.items():
+            for callback in self._scene_callbacks[control_unit_id].copy():
+                callback(scene_id)
+
+    def _handle_button(self, match: re.Match[str]) -> None:
+        address = match.group(1)
+        control_unit_id = ord(address.upper()) - ord("A") + 1
+        button = int(match.group(2))
+        pressed = address.isupper()
+
+        _LOGGER.debug("Control unit %d: button %d %s", control_unit_id, button, "pressed" if pressed else "released")
+
+        for callback in self._button_callbacks[control_unit_id].copy():
+            callback(button, pressed)
+
+    def _send_command(self, command: str) -> None:
+        self._writer.write(command + "\r\n")

grafikeye-0.1.0/src/grafikeye/const.py

@@ -0,0 +1,2 @@
+DEFAULT_PORT = 23
+DEFAULT_LOGIN = "nwk2"