rakopy 0.0.1__tar.gz

rakopy-0.0.1/.github/workflows/pylint.yml

@@ -0,0 +1,23 @@
+name: Pylint
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pylint
+    - name: Analysing the code with pylint
+      run: |
+        pylint $(git ls-files '*.py')

rakopy-0.0.1/.github/workflows/python-publish.yml

@@ -0,0 +1,45 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.12'
+    - name: Generate version file
+      run: |
+        echo "__version__ = \"$RELEASE_TAG\"" > src/rakopy/__version__.py
+        cat src/rakopy/__version__.py
+      env:
+        RELEASE_TAG: ${{ github.event.release.tag_name }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

rakopy-0.0.1/.gitignore

@@ -0,0 +1,162 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+.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
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs 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/

rakopy-0.0.1/.pylintrc

@@ -0,0 +1,7 @@
+[DESIGN]
+max-args = 8
+max-attributes = 8
+max-positional-arguments = 8
+
+[MASTER]
+init-hook='import sys; sys.path.append(".")'

rakopy-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Prince Kamalanathan
+
+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.

rakopy-0.0.1/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.3
+Name: rakopy
+Version: 0.0.1
+Summary: RakoPy is a Python library that allows you to control Rako Controls system programmatically.
+Project-URL: Homepage, https://github.com/princekama/rakopy
+Project-URL: Issues, https://github.com/princekama/rakopy/issues
+Author: @princekama
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# RakoPy
+RakoPy is a Python library that allows you to control [Rako Controls](https://rakocontrols.com) system programmatically.

rakopy-0.0.1/README.md

@@ -0,0 +1,2 @@
+# RakoPy
+RakoPy is a Python library that allows you to control [Rako Controls](https://rakocontrols.com) system programmatically.

rakopy-0.0.1/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "rakopy"
+dynamic = ["version"]
+authors = [
+  { name="@princekama" },
+]
+description = "RakoPy is a Python library that allows you to control Rako Controls system programmatically."
+readme = "README.md"
+requires-python = ">=3.12"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://github.com/princekama/rakopy"
+Issues = "https://github.com/princekama/rakopy/issues"
+
+[tool.hatch.version]
+path = "src/rakopy/__version__.py"

rakopy-0.0.1/src/rakopy/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.0.1"

rakopy-0.0.1/src/rakopy/consts.py

@@ -0,0 +1,3 @@
+"""Constants for rakopy module."""
+
+DEFAULT_PORT = 9762

rakopy-0.0.1/src/rakopy/errors.py

@@ -0,0 +1,7 @@
+"""Errors for rakopy module."""
+
+class ConfigValidationError(Exception):
+    """Exception when configuration validation fails."""
+
+class SendCommandError(Exception):
+    """Exception when send command fails."""

rakopy-0.0.1/src/rakopy/hub.py

@@ -0,0 +1,416 @@
+"""Core implementation of rakopi module."""
+from __future__ import annotations
+
+import asyncio
+import json
+from typing import Any, AsyncGenerator, List
+from rakopy.consts import DEFAULT_PORT
+from rakopy.errors import ConfigValidationError, SendCommandError
+from rakopy.model import (
+    Channel,
+    ChannelLevel,
+    HubStatus,
+    Level,
+    LevelChangedEvent,
+    LevelInfo,
+    Room,
+    Scene,
+    SceneChangedEvent
+)
+
+class Hub:
+    """Class to integrate with Rako Hub."""
+    def __init__(
+        self,
+        client_name: str,
+        host: str,
+        port: int = DEFAULT_PORT
+    ):
+        host = host.strip()
+        if not host:
+            raise ConfigValidationError("RakoHub: host parameter cannot be empty.")
+
+        if port < 0 or port > 65535:
+            raise ConfigValidationError("RakoHub: port should be between 0 and 65535.")
+
+        if not client_name:
+            raise ConfigValidationError("RakoHub: client_name parameter cannot be empty.")
+
+        self.host = host
+        self.port = port
+        self.client_name = client_name
+
+        self._reader = None
+        self._writer = None
+
+    async def get_hub_status(self) -> HubStatus:
+        """
+        Get Rako Hub status.
+        """
+        await self._reconnect()
+
+        request = {
+            "name": "status",
+            "payload": {}
+        }
+
+        self._writer.write(str.encode(json.dumps(request) + "\r\n"))
+        await self._writer.drain()
+
+        response = await self._reader.readline()
+        json_data = json.loads(response)
+
+        return HubStatus(
+            product_type= json_data["payload"]["productType"],
+            protocol_version= int(json_data["payload"]["protocolVersion"]),
+            id= json_data["payload"]["hubId"],
+            mac_address= json_data["payload"]["mac;"],
+            version= json_data["payload"]["hubVersion"]
+        )
+
+    async def get_levels(self, room_id: int = None) -> List[Level]:
+        """
+        Get levels for all the channels in a room.
+        If room_id is not specified, returns levels for all the rooms.
+        """
+        return await self._query("LEVEL", self._to_level, room_id)
+
+    async def get_rooms(self, room_id: int = None) -> List[Room]:
+        """
+        Get room by its id.
+        If room_id is not specified, returns all rooms.
+        """
+        return await self._query("SCENECHANNEL", self._to_room, room_id)
+
+    async def set_level(self, room_id: int, channel_id: int, level: int) -> None:
+        """
+        Set level for a given room and channel.
+        """
+        action = {
+            "command": "levelrate",
+            "level": level
+        }
+
+        request = self._build_send_request(room_id, channel_id, action)
+
+        await self._send(request)
+
+    async def set_rgb(
+            self,
+            room_id: int,
+            channel_id: int,
+            red: int,
+            green: int,
+            blue: int,
+            rgb_excludes_brightness: bool = False,
+            level: int = None
+        ) -> None:
+        """
+        Set RGB for a given room and channel.
+        """
+        color_send_type = "SEND_COLOR_AND_LEVEL"
+        if rgb_excludes_brightness and not level:
+            color_send_type = "SEND_COLOR_ONLY"
+
+        request = {
+            "name": "send-color",
+            "payload": {
+                "room": room_id,
+                "channel": channel_id,
+                "colorSendType": color_send_type,
+                "red": red,
+                "green": green,
+                "blue": blue,
+                "rgbExcludesBrightness": rgb_excludes_brightness,
+                "level": level
+            }
+        }
+
+        await self._send(request)
+
+    async def set_scene(self, room_id: int, channel_id: int, scene: int) -> None:
+        """
+        Set a scene for a given room and channel.
+        """
+        action = {
+            "command": "scene",
+            "scene": scene
+        }
+
+        request = self._build_send_request(room_id, channel_id, action)
+
+        await self._send(request)
+
+    async def set_temperature(
+            self,
+            room_id: int,
+            channel_id: int,
+            temperature: int,
+            level: int = None
+        ) -> None:
+        """
+        Set a colour temperature and level for a given room and channel.
+        """
+        color_send_type = "SEND_COLOR_ONLY"
+        if level:
+            color_send_type = "SEND_COLOR_AND_LEVEL"
+
+        request = {
+            "name": "send-colorTemp",
+            "payload": {
+                "room": room_id,
+                "channel": channel_id,
+                "colorSendType": color_send_type,
+                "temperature": temperature,
+                "level": level
+            }
+        }
+
+        await self._send(request)
+
+    async def start_fading_down(self, room_id: int, channel_id: int) -> None:
+        """
+        Start fading down brightness for a given room and channel
+        """
+        action = {
+            "command": "fade",
+            "down": True
+        }
+
+        request = self._build_send_request(room_id, channel_id, action)
+
+        await self._send(request)
+
+    async def start_fading_up(self, room_id: int, channel_id: int) -> None:
+        """
+        Start fading up brightness for a given room and channel.
+        """
+        action = {
+            "command": "fade",
+            "down": False
+        }
+
+        request = self._build_send_request(room_id, channel_id, action)
+
+        await self._send(request)
+
+    async def stop_fading(self, room_id: int, channel_id: int) -> None:
+        """
+        Stop fading brightness for a given room and channel
+        """
+        action = {
+            "command": "stop"
+        }
+
+        request = self._build_send_request(room_id, channel_id, action)
+
+        await self._send(request)
+
+    async def store_scene(self, room_id: int, channel_id: int, scene: int) -> None:
+        """
+        Store current levels as a scene for a given room and channel.
+        """
+        action = {
+            "command": "store",
+            "scene": scene
+        }
+
+        request = self._build_send_request(room_id, channel_id, action)
+
+        await self._send(request)
+
+    async def get_events(self) -> AsyncGenerator:
+        """
+        Subscribe and listen to events from Hub asynchronously.
+        """
+        reader, writer = await asyncio.open_connection(self.host, self.port)
+
+        payload = {
+            "version": 2,
+            "client_name": self.client_name,
+            "subscriptions": ["TRACKER"]
+        }
+        request = f"SUB,JSON,{json.dumps(payload)}\r\n"
+
+        writer.write(str.encode(request))
+        await writer.drain()
+
+        while True:
+            response = await reader.readline()
+            json_data = json.loads(response)
+            if json_data["name"] == "tracker":
+                if json_data["type"] == "scene":
+                    yield SceneChangedEvent(
+                        room_id= json_data["payload"]["roomId"],
+                        channel_id= json_data["payload"]["channelId"],
+                        scene_id= json_data["payload"]["scene"],
+                        active_scene_id= json_data["payload"]["activeScene"],
+                    )
+                elif json_data["type"] == "level":
+                    level_changed_event = LevelChangedEvent(
+                        room_id= json_data["payload"]["roomId"],
+                        channel_id= json_data["payload"]["channelId"],
+                        current_level= json_data["payload"]["currentLevel"],
+                        target_level= json_data["payload"]["targetLevel"],
+                        time_to_take= json_data["payload"]["timeToTake"],
+                        temporary= json_data["payload"]["temporary"],
+                    )
+                    yield level_changed_event
+
+    async def _query(self, query_type: str, func, room_id: int = None):
+        """
+        Executes query and returns result.
+        """
+        await self._reconnect()
+
+        if room_id is None:
+            room_id = 0
+
+        request = {
+            "name": "query",
+            "payload": {
+                "queryType": query_type,
+                "roomId": room_id
+            }
+        }
+
+        self._writer.write(str.encode(json.dumps(request) + "\r\n"))
+        await self._writer.drain()
+
+        response = (await self._reader.readline()).decode()
+        json_data = json.loads(response)
+
+        result = []
+        for data in json_data["payload"]:
+            result.append(func(data))
+
+        return result
+
+    async def _reconnect(self) -> None:
+        """
+        Try to reconnect to the Rako Hub if the connection was not previously
+        established or was closed.
+        """
+        if (self._writer is None or
+            self._writer.transport is None or
+            self._writer.transport.is_closing()
+        ):
+            self._reader, self._writer = await asyncio.open_connection(self.host, self.port)
+
+            payload = {
+                "version": 2,
+                "client_name": self.client_name,
+                "subscriptions": []
+            }
+            request = f"SUB,JSON,{json.dumps(payload)}\r\n"
+
+            self._writer.write(str.encode(request))
+            await self._writer.drain()
+
+            await self._reader.readline()
+
+    async def _send(self, request: Any) -> None:
+        """
+        Sends a command.
+        """
+        await self._reconnect()
+
+        self._writer.write(str.encode(json.dumps(request) + "\r\n"))
+        await self._writer.drain()
+
+        response = (await self._reader.readline()).decode()
+        json_data = json.loads(response)
+        if json_data["name"] == "error":
+            raise SendCommandError(
+                f"Failed to send {0} command. Error: {1}", request, json_data["payload"]
+            )
+
+    @staticmethod
+    def _build_send_request(room_id: int, channel_id: int, action: Any):
+        """
+        Returns a send command request.
+        """
+        return {
+            "name": "send",
+            "payload": {
+                "room": room_id,
+                "channel": channel_id,
+                "action": action
+            }
+        }
+
+    @staticmethod
+    def _to_level(data: Any) -> Level:
+        """
+        Converts list of str to Level.
+        """
+        channel_levels = []
+        for channel_level in data["channel"]:
+            level_info_data = channel_level["levelInfo"]
+            if level_info_data:
+                level_info = LevelInfo(
+                    kelvin= level_info_data["kelvin"],
+                    red= level_info_data["red"],
+                    green= level_info_data["green"],
+                    blue= level_info_data["blue"]
+                )
+            else:
+                level_info = None
+
+            channel_levels.append(
+                ChannelLevel(
+                    channel_id= channel_level["channelId"],
+                    current_level= channel_level["currentLevel"],
+                    target_level= channel_level["targetLevel"],
+                    level_info= level_info
+                )
+            )
+
+        return Level(
+            room_id= data["roomId"],
+            current_scene_id= data["currentScene"],
+            channel_levels= channel_levels
+        )
+
+    @staticmethod
+    def _to_room(data: Any) -> Room:
+        """
+        Converts JSON data to Room.
+        """
+        channels = []
+        for channel in data["channel"]:
+            channels.append(
+                Channel(
+                    id= channel["channelId"],
+                    title= channel["title"],
+                    type= channel["type"],
+                    color_type= channel["colorType"],
+                    color_title= channel["colorTitle"],
+                    multi_channel_component= channel["multiChannelComponent"]
+                )
+            )
+
+        scenes = []
+        scenes.append(
+            Scene(
+                id= 0,
+                title= "Off"
+            )
+        )
+
+        for scene in data["scene"]:
+            scenes.append(
+                Scene(
+                    id= scene["sceneId"],
+                    title= scene["title"]
+                )
+            )
+
+        return Room(
+            id= data["roomId"],
+            title= data["title"],
+            type= data["type"],
+            mode= data["mode"],
+            channels= channels,
+            scenes= scenes
+        )

rakopy-0.0.1/src/rakopy/model.py

@@ -0,0 +1,80 @@
+"""Data models for rakopy module."""
+
+from dataclasses import dataclass
+from typing import List
+
+@dataclass
+class HubStatus:
+    """Hub status data model."""
+    product_type: str
+    protocol_version: int
+    id: str
+    mac_address: str
+    version: str
+
+@dataclass
+class Channel:
+    """Channel data model."""
+    id: int
+    title: str
+    type: str
+    color_type: str
+    color_title: str
+    multi_channel_component: str
+
+@dataclass
+class Scene:
+    """Scene data model."""
+    id: int
+    title: int
+
+@dataclass
+class Room:
+    """Room data model."""
+    id: int
+    title: str
+    type: str
+    mode: str
+    channels: List[Channel]
+    scenes: List[Scene]
+
+@dataclass
+class LevelInfo:
+    """Channel level info data model."""
+    kelvin: int
+    red: int
+    green: int
+    blue: int
+
+@dataclass
+class ChannelLevel:
+    """Channel level data model."""
+    channel_id: int
+    current_level: int
+    target_level: int
+    level_info: LevelInfo
+
+@dataclass
+class Level:
+    """Level data model."""
+    room_id: int
+    current_scene_id: int
+    channel_levels: List[ChannelLevel]
+
+@dataclass
+class LevelChangedEvent:
+    """Level changed event data model."""
+    room_id: int
+    channel_id: int
+    current_level: int
+    target_level: int
+    time_to_take: int
+    temporary: bool
+
+@dataclass
+class SceneChangedEvent:
+    """Scene changed event data model."""
+    room_id: int
+    channel_id: int
+    scene_id: int
+    active_scene_id: int