salus-it600-client 0.1.0__tar.gz

salus_it600_client-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Julius Vitkauskas
+
+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.

salus_it600_client-0.1.0/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: salus-it600-client
+Version: 0.1.0
+Summary: Asynchronous Python client for Salus iT600 local gateways
+Author: Julius Vitkauskas, Jordi-14
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Jordi-14/salus-it600-client
+Project-URL: Issues, https://github.com/Jordi-14/salus-it600-client/issues
+Project-URL: Source, https://github.com/Jordi-14/salus-it600-client
+Project-URL: Original, https://github.com/epoplavskis/pyit600
+Keywords: salus,it600,api,async,client,home-assistant
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Home Automation
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.9
+Requires-Dist: cryptography>=42.0.0
+Dynamic: license-file
+
+# salus-it600-client
+
+Asynchronous Python client for Salus iT600 devices.
+
+## For end users
+See https://github.com/Jordi-14/homeassistant_salus to use this in Home Assistant.
+
+FHEM users might be interested in https://github.com/dominikkarall/fhempy which provides subset of functionality.
+
+## About
+
+This package allows you to control and monitor your Salus iT600 smart home devices locally through Salus UG600 universal gateway. Currently heating thermostats, binary sensors, temperature sensors, covers and switches are supported. You have any other devices and would like to contribute - you are welcome to create an issue or submit a pull request.
+
+## Installation
+
+```bash
+pip install salus-it600-client
+```
+
+## Usage
+ - Instantiate the IT600Gateway device with local ip address and EUID of your gateway. You can find EUID written down on the bottom of your gateway (eg. `001E5E0D32906128`).
+ - Status can be polled using the `poll_status()` command.
+ - Callbacks to be notified of state updates can be added with the `add_climate_update_callback(method)` or `add_sensor_update_callback(method)` method.
+
+### Basic example
+
+```python
+from salus_it600.gateway import IT600Gateway
+
+async with IT600Gateway(host=args.host, euid=args.euid) as gateway:
+	await gateway.connect()
+	await gateway.poll_status()
+
+	climate_devices = gateway.get_climate_devices()
+
+	print("All climate devices:")
+	print(repr(climate_devices))
+
+	for climate_device_id in climate_devices:
+		print(f"Climate device {climate_device_id} status:")
+		print(repr(climate_devices.get(climate_device_id)))
+
+		print(f"Setting heating device {climate_device_id} temperature to 21 degrees celsius")
+		await gateway.set_climate_device_temperature(climate_device_id, 21)
+```
+
+### Supported devices
+
+Thermostats:
+* HTRP-RF(50)
+* TS600
+* VS10WRF/VS10BRF
+* VS20WRF/VS20BRF
+* SQ610
+* SQ610RF
+* FC600
+
+Binary sensors:
+* SW600
+* WLS600
+* OS600
+* SD600 (sometimes gateway may not expose required information for these devices to be detected, reason is unknown)
+* TRV10RFM (only heating state on/off)
+* RX10RF (only heating state on/off)
+
+Temperature sensors:
+* PS600
+
+Switch devices:
+* SPE600
+* RS600
+* SR600
+
+Cover devices:
+* RS600
+
+### Unsupported devices
+
+Buttons perform actions only in Salus Smart Home app:
+* SB600
+* CSB600
+
+### Untested devices
+
+These switch devices have not been tested, but may work:
+* SP600
+
+These binary sensors have not been tested, but may work:
+* MS600
+
+### Troubleshooting
+
+If you can't connect using EUID written down on the bottom of your gateway (which looks something like `001E5E0D32906128`), try using `0000000000000000` as EUID.
+
+Also check if you have "Local Wifi Mode" enabled:
+* Open Smart Home app on your phone
+* Sign in
+* Double tap your Gateway to open info screen
+* Press gear icon to enter configuration
+* Scroll down a bit and check if "Disable Local WiFi Mode" is set to "No"
+* Scroll all the way down and save settings
+* Restart Gateway by unplugging/plugging USB power
+
+
+### Contributing
+
+If you want to help to get your device supported, open GitHub issue and add your device model number and output of `main.py` program. Be sure to run this program with --debug option.
+
+## Project origin
+
+This project is a maintained fork/successor of `epoplavskis/pyit600`.
+It was renamed from the `pyit600` Python import namespace to `salus_it600`
+to avoid collisions with the original unmaintained package while preserving
+the original MIT license and attribution.

salus_it600_client-0.1.0/README.md

@@ -0,0 +1,114 @@
+# salus-it600-client
+
+Asynchronous Python client for Salus iT600 devices.
+
+## For end users
+See https://github.com/Jordi-14/homeassistant_salus to use this in Home Assistant.
+
+FHEM users might be interested in https://github.com/dominikkarall/fhempy which provides subset of functionality.
+
+## About
+
+This package allows you to control and monitor your Salus iT600 smart home devices locally through Salus UG600 universal gateway. Currently heating thermostats, binary sensors, temperature sensors, covers and switches are supported. You have any other devices and would like to contribute - you are welcome to create an issue or submit a pull request.
+
+## Installation
+
+```bash
+pip install salus-it600-client
+```
+
+## Usage
+ - Instantiate the IT600Gateway device with local ip address and EUID of your gateway. You can find EUID written down on the bottom of your gateway (eg. `001E5E0D32906128`).
+ - Status can be polled using the `poll_status()` command.
+ - Callbacks to be notified of state updates can be added with the `add_climate_update_callback(method)` or `add_sensor_update_callback(method)` method.
+
+### Basic example
+
+```python
+from salus_it600.gateway import IT600Gateway
+
+async with IT600Gateway(host=args.host, euid=args.euid) as gateway:
+	await gateway.connect()
+	await gateway.poll_status()
+
+	climate_devices = gateway.get_climate_devices()
+
+	print("All climate devices:")
+	print(repr(climate_devices))
+
+	for climate_device_id in climate_devices:
+		print(f"Climate device {climate_device_id} status:")
+		print(repr(climate_devices.get(climate_device_id)))
+
+		print(f"Setting heating device {climate_device_id} temperature to 21 degrees celsius")
+		await gateway.set_climate_device_temperature(climate_device_id, 21)
+```
+
+### Supported devices
+
+Thermostats:
+* HTRP-RF(50)
+* TS600
+* VS10WRF/VS10BRF
+* VS20WRF/VS20BRF
+* SQ610
+* SQ610RF
+* FC600
+
+Binary sensors:
+* SW600
+* WLS600
+* OS600
+* SD600 (sometimes gateway may not expose required information for these devices to be detected, reason is unknown)
+* TRV10RFM (only heating state on/off)
+* RX10RF (only heating state on/off)
+
+Temperature sensors:
+* PS600
+
+Switch devices:
+* SPE600
+* RS600
+* SR600
+
+Cover devices:
+* RS600
+
+### Unsupported devices
+
+Buttons perform actions only in Salus Smart Home app:
+* SB600
+* CSB600
+
+### Untested devices
+
+These switch devices have not been tested, but may work:
+* SP600
+
+These binary sensors have not been tested, but may work:
+* MS600
+
+### Troubleshooting
+
+If you can't connect using EUID written down on the bottom of your gateway (which looks something like `001E5E0D32906128`), try using `0000000000000000` as EUID.
+
+Also check if you have "Local Wifi Mode" enabled:
+* Open Smart Home app on your phone
+* Sign in
+* Double tap your Gateway to open info screen
+* Press gear icon to enter configuration
+* Scroll down a bit and check if "Disable Local WiFi Mode" is set to "No"
+* Scroll all the way down and save settings
+* Restart Gateway by unplugging/plugging USB power
+
+
+### Contributing
+
+If you want to help to get your device supported, open GitHub issue and add your device model number and output of `main.py` program. Be sure to run this program with --debug option.
+
+## Project origin
+
+This project is a maintained fork/successor of `epoplavskis/pyit600`.
+It was renamed from the `pyit600` Python import namespace to `salus_it600`
+to avoid collisions with the original unmaintained package while preserving
+the original MIT license and attribution.

salus_it600_client-0.1.0/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["setuptools>=77", "wheel", "packaging>=24.2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "salus-it600-client"
+version = "0.1.0"
+description = "Asynchronous Python client for Salus iT600 local gateways"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "MIT"
+authors = [
+  { name = "Julius Vitkauskas" },
+  { name = "Jordi-14" }
+]
+keywords = ["salus", "it600", "api", "async", "client", "home-assistant"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Framework :: AsyncIO",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Home Automation"
+]
+dependencies = [
+  "aiohttp>=3.9",
+  "cryptography>=42.0.0"
+]
+
+[project.urls]
+Homepage = "https://github.com/Jordi-14/salus-it600-client"
+Issues = "https://github.com/Jordi-14/salus-it600-client/issues"
+Source = "https://github.com/Jordi-14/salus-it600-client"
+Original = "https://github.com/epoplavskis/pyit600"
+
+[tool.setuptools.packages.find]
+include = ["salus_it600", "salus_it600.*"]

salus_it600_client-0.1.0/salus_it600/__init__.py

@@ -0,0 +1,18 @@
+"""Asynchronous Python client for Salus iT600 smart devices."""
+
+from .__version__ import __version__
+from .exceptions import (
+    IT600AuthenticationError,
+    IT600CommandError,
+    IT600ConnectionError,
+)
+
+
+def __getattr__(name: str):
+    """Load gateway classes lazily so utility imports stay lightweight."""
+    if name == "IT600Gateway":
+        from .gateway import IT600Gateway
+
+        return IT600Gateway
+
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

salus_it600_client-0.1.0/salus_it600/__version__.py

@@ -0,0 +1,3 @@
+"""Asynchronous Python client for Salus iT600 smart devices."""
+
+__version__ = "0.1.0"

salus_it600_client-0.1.0/salus_it600/const.py

@@ -0,0 +1,48 @@
+"""Constants for the Salus iT600 smart devices."""
+
+# Degree units
+DEGREE = "°"
+
+# Temperature units
+TEMP_CELSIUS = f"{DEGREE}C"
+
+# States
+STATE_UNKNOWN = "unknown"
+
+# Supported climate features
+SUPPORT_TARGET_TEMPERATURE = 1
+SUPPORT_FAN_MODE = 8
+SUPPORT_PRESET_MODE = 16
+
+# Supported cover features
+SUPPORT_OPEN = 1
+SUPPORT_CLOSE = 2
+SUPPORT_SET_POSITION = 4
+
+# HVAC modes
+HVAC_MODE_OFF = "off"
+HVAC_MODE_HEAT = "heat"
+HVAC_MODE_COOL = "cool"
+HVAC_MODE_AUTO = "auto"
+
+# HVAC states
+CURRENT_HVAC_OFF = "off"
+CURRENT_HVAC_HEAT = "heating"
+CURRENT_HVAC_HEAT_IDLE = "heating (idling)"
+CURRENT_HVAC_COOL = "cooling"
+CURRENT_HVAC_COOL_IDLE = "cooling (idling)"
+CURRENT_HVAC_IDLE = "idle"
+
+# Supported presets
+PRESET_FOLLOW_SCHEDULE = "Follow Schedule"
+PRESET_PERMANENT_HOLD = "Permanent Hold"
+PRESET_TEMPORARY_HOLD = "Temporary Hold"
+PRESET_ECO = "Eco"
+PRESET_OFF = "Off"
+
+# Supported fan modes
+FAN_MODE_AUTO = "Auto"
+FAN_MODE_HIGH = "High"
+FAN_MODE_MEDIUM = "Medium"
+FAN_MODE_LOW = "Low"
+FAN_MODE_OFF = "Off"

salus_it600_client-0.1.0/salus_it600/encryptor.py

@@ -0,0 +1,28 @@
+"""Encryptor for Salus iT600 local mode communication."""
+
+import hashlib
+
+from cryptography.hazmat.backends import default_backend
+from cryptography.hazmat.primitives import padding
+from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
+
+
+class IT600Encryptor:
+    iv = bytes([0x88, 0xa6, 0xb0, 0x79, 0x5d, 0x85, 0xdb, 0xfc, 0xe6, 0xe0, 0xb3, 0xe9, 0xa6, 0x29, 0x65, 0x4b])
+
+    def __init__(self, euid: str):
+        key: bytes = hashlib.md5(f"Salus-{euid.lower()}".encode("utf-8")).digest() + bytes([0] * 16)
+        self.cipher = Cipher(algorithms.AES(key), modes.CBC(self.iv), default_backend())
+
+    def encrypt(self, plain: str) -> bytes:
+        encryptor = self.cipher.encryptor()
+        padder = padding.PKCS7(128).padder()
+        padded_data: bytes = padder.update(plain.encode("utf-8")) + padder.finalize()
+        return encryptor.update(padded_data) + encryptor.finalize()
+
+    def decrypt(self, cypher: bytes) -> str:
+        decryptor = self.cipher.decryptor()
+        padded_data: bytes = decryptor.update(cypher) + decryptor.finalize()
+        unpadder = padding.PKCS7(128).unpadder()
+        plain: bytes = unpadder.update(padded_data) + unpadder.finalize()
+        return plain.decode("utf-8")

salus_it600_client-0.1.0/salus_it600/exceptions.py

@@ -0,0 +1,25 @@
+"""Exceptions for Salus iT600 smart devices."""
+
+
+class IT600Error(Exception):
+    """Salus iT600 exception."""
+
+    pass
+
+
+class IT600AuthenticationError(IT600Error):
+    """Salus iT600 authentication exception."""
+
+    pass
+
+
+class IT600CommandError(IT600Error):
+    """Salus iT600 command exception."""
+
+    pass
+
+
+class IT600ConnectionError(IT600Error):
+    """Salus iT600 connection exception."""
+
+    pass