sensio-lib 0.1.0__tar.gz

sensio_lib-0.1.0/.gitignore

@@ -0,0 +1,125 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+*.egg-info/
+.installed.cfg
+*.egg
+dist/
+build/
+*.whl
+
+# Poetry / UV
+poetry.lock
+uv.lock
+
+# 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
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.env.*
+.venv
+.venv.*
+
+# Spyder project settings
+.spyderproject
+.spyderworkspace
+
+# 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/
+
+# Tests
+tests/integration/
+
+# Ignore vscode files
+.vscode/

sensio_lib-0.1.0/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.4
+Name: sensio-lib
+Version: 0.1.0
+Requires-Python: ~=3.10
+Requires-Dist: pytest<9,>=8.3.3
+Requires-Dist: requests<3,>=2.32.3
+Description-Content-Type: text/markdown
+
+# Sensio Library
+
+A small library designed to control the Sensio smart house controller. This library was developed by reverse engineering the communication between the Sensio smart home app and the controller. It retrieves all device information from the Sensio cloud, but after the initial setup, all devices can be controlled 100% locally from your LAN.
+
+More features could probably be implemented by additional reverse engineering.
+
+## Features (v0.1.0)
+
+- **Login to Sensio Cloud**
+  - Select between multiple projects
+  - Get a list of all light devices
+- **Basic Light Control**
+  - Turn lights on/off (Note: no actual state of lights is implemented)
+
+## Device Support
+
+This library has been tested with a Sensio X1 controller. Testing is limited, so your experience may vary.

sensio_lib-0.1.0/README.md

@@ -0,0 +1,17 @@
+# Sensio Library
+
+A small library designed to control the Sensio smart house controller. This library was developed by reverse engineering the communication between the Sensio smart home app and the controller. It retrieves all device information from the Sensio cloud, but after the initial setup, all devices can be controlled 100% locally from your LAN.
+
+More features could probably be implemented by additional reverse engineering.
+
+## Features (v0.1.0)
+
+- **Login to Sensio Cloud**
+  - Select between multiple projects
+  - Get a list of all light devices
+- **Basic Light Control**
+  - Turn lights on/off (Note: no actual state of lights is implemented)
+
+## Device Support
+
+This library has been tested with a Sensio X1 controller. Testing is limited, so your experience may vary.

sensio_lib-0.1.0/example.py

@@ -0,0 +1,57 @@
+from sensio_lib import Light
+from sensio_lib.light_state import LightState
+from sensio_lib.hub import Hub
+import logging
+
+# Configure the root logger
+logging.basicConfig(
+    level=logging.INFO,
+    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
+    handlers=[logging.StreamHandler()]
+)
+logger = logging.getLogger(__name__)
+
+def main():
+    logger.info("Starting Sensio integration")
+
+    # Configure the system. Replace the IP address with the IP address of your Sensio hub on your LAN. 
+    # Replace SENSIO_USERNAME and SENSIO_PASSWORD with your Sensio credentials (same username and password you use to log in to the Sensio app)
+    hub_adress = '192.168.xx.xx'
+    username = 'SENSIO_USERNAME'
+    password = 'SENSIO_PASSWORD'
+    hub = Hub(hub_adress, username, password)
+
+    # Login to Sensio cloud
+    hub.login()
+
+    # Retrieve all projects
+    if not hub.projects or len(hub.projects) == 0:
+        logger.error("No projects found")
+        return
+    else:
+        logger.info(hub.projects)
+
+    # Set the first project as the active project. Note: If you have multiple projects, you can select the project you want to control instead by using hub.projects['my_project_name']. 
+    # All available projects should be listed by the log command above when the script is run
+    project = hub.projects.popitem()[1]
+
+    # By setting the project in the hub the hub will add all lights to the hub.lights list
+    hub.set_project(project)
+
+    [logger.info(f'Light {i}: {light}') for i, light in enumerate(hub.lights)]
+    while True:
+        light = input("Enter light number: ")
+        if light.isdigit():
+            light = int(light)
+            if light < len(hub.lights):
+                if hub.lights[light].get_light_state() == LightState.ON or hub.lights[light].get_light_state() == LightState.UNKNOWN:
+                    logger.info(f'Light state is {hub.lights[light].get_light_state()}, turning off')
+                    hub.lights[light].turn_off()
+                else:
+                    logger.info(f'Light state is {hub.lights[light].get_light_state()}, turning on')
+                    hub.lights[light].turn_on()
+            else:
+                logger.error('Invalid light number to toggle')
+
+if __name__ == "__main__":
+    main()

sensio_lib-0.1.0/pyproject.toml

@@ -0,0 +1,14 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "sensio-lib"
+version = "0.1.0"
+description = ""
+requires-python = "~=3.10"
+readme = "README.md"
+dependencies = [
+    "requests>=2.32.3,<3",
+    "pytest>=8.3.3,<9",
+]

sensio_lib-0.1.0/sensio_lib/__init__.py

@@ -0,0 +1,5 @@
+from sensio_lib.light import Light
+from sensio_lib.hub import Hub
+from sensio_lib.light_state import LightState
+
+__all__ = ['Light', 'Hub', 'LightState']

sensio_lib-0.1.0/sensio_lib/const.py

@@ -0,0 +1,18 @@
+
+SENSIO_AGENT_REQUEST = {
+  "DeviceName": "sdk_gphone_x86",
+  "DeviceId": "97e2cd6e-002d-4cfe-a596-5eb7a34c7582",
+  "DeviceOsVersion": "11 (sdk_gphone_x86-userdebug 11 RSR1.210722.013.A2 10067904 dev-keys)",
+  "DeviceType": "Android",
+  "ClientType": "SensioHaPanelApp",
+  "ClientVersion": "6.12.2 (320)"
+}
+
+# URLS
+SENSIO_BASE_URL = 'https://unity.sensio.no/api/v1'
+SENSIO_TOKEN_URL = 'https://unity.sensio.no/api/v1/tokens'
+SENSIO_PROJECTS_URL = 'https://unity.sensio.no/api/v1/users/self/projects?include=controllers&installerProjectsOnly=false&siteIdentifier=self'
+
+# Hex
+COMMAND_PREFIX = '\x01'
+COMMAND_POSTFIX = '\x02'

sensio_lib-0.1.0/sensio_lib/hub.py

@@ -0,0 +1,85 @@
+from sensio_lib.const import SENSIO_AGENT_REQUEST, SENSIO_TOKEN_URL, SENSIO_PROJECTS_URL, SENSIO_BASE_URL
+from sensio_lib.light import Light
+import requests
+import logging
+import base64
+
+logger = logging.getLogger(__name__)
+
+class Hub:
+    def __init__(self, server_address: str, username: str, password: str):
+        self.username = username
+        self.password = password
+        self.server_address = server_address      
+
+    def login(self) -> list:
+        ''' Authenticate with the Sensio API and retrieve a list of projects '''
+
+        self.token = self._get_auth_token()
+        return self._get_projects()
+    
+    def get_lights(self, project_id) -> list:
+        ''' Retrieve a list of lights for the specified project '''
+
+        entities_url = f'{SENSIO_BASE_URL}/projects/{project_id}/functions'
+        entities_response = requests.get(entities_url, headers={'Authorization': f'Token {self.token}'})
+        if entities_response.status_code != 200:
+            raise Exception("Failed to retrieve entities")
+        
+        logger.debug(entities_response.json())
+        
+        switches = self._create_function_list(entities_response.json())
+        return [Light(switch['switch']['name'], switch['switch']['command_on'], switch['switch']['command_off'], self.server_address) for switch in switches]
+        
+        
+    def _get_auth_token(self):
+        response = requests.post(SENSIO_TOKEN_URL, auth=(self.username, self.password), json=SENSIO_AGENT_REQUEST, headers={"Content-Type": "application/json"})
+        if response.status_code != 200:
+            raise Exception("Failed to retrieve token")
+        
+        token_str = f'{response.json()["tokenId"]}:{response.json()["tokenSecret"]}'
+        token_bytes = token_str.encode('utf-8')
+        return base64.b64encode(token_bytes).decode('utf-8')
+        
+    def _get_projects(self):
+        if not self.token:
+            raise Exception("Token not set")
+
+        # Get a list of projects
+        project_response = requests.get(SENSIO_PROJECTS_URL, headers={'Authorization': f'Token {self.token}'})
+        if project_response.status_code != 200:
+            raise Exception("Failed to retrieve projects")
+        
+        # We want to populate projects with the project ID and project name for each project
+        return {project['name']: project['projectId'] for project in project_response.json()['projects']}
+    
+    
+    def _create_function_list(self, entity_json) -> list:
+        ''' Create a list of functions from the entity data. This is.....ugly.'''
+        
+        switch_info = []
+        intermediate_switches = {}
+
+        for switch in entity_json['functions']:
+            name = switch['name']
+            sub_type = switch['subType']
+            # Strip postfix to get the base name
+            base_name = name.rsplit('_', 1)[0]
+            # Determine command based on postfix
+            if sub_type in ['light_on', 'light_off', 'LightOffRoom', 'LightOnRoom']:
+                if base_name not in intermediate_switches:
+                    intermediate_switches[base_name] = {
+                        'name': base_name,
+                        'command_on': '',
+                        'command_off': ''
+                    }
+
+                if name.endswith('_OFF'):
+                    intermediate_switches[base_name]['command_off'] = switch["address"]
+                elif name.endswith('_ON'):
+                    intermediate_switches[base_name]['command_on'] = switch["address"]
+
+                if intermediate_switches[base_name]['command_on'] and intermediate_switches[base_name]['command_off']:
+                    switch_info.append({'switch': intermediate_switches.pop(base_name)})
+        
+        return switch_info

sensio_lib-0.1.0/sensio_lib/light.py

@@ -0,0 +1,32 @@
+from sensio_lib.light_state import LightState
+from sensio_lib.socket_manager import SocketManager
+import uuid
+import logging
+
+logger = logging.getLogger(__name__)
+
+class Light:
+    def __init__(self, name, on_address, off_address, server_address=None):
+        self.state = LightState.UNKNOWN
+        self.id = uuid.uuid4()
+        self.name = name
+        self.on_address = on_address
+        self.off_address = off_address
+        self.server_address = server_address
+        self.socket_manager = SocketManager(self.server_address)
+
+    def turn_on(self):
+        logger.debug(f"Turning on light with ID: {self.name}")
+        self.socket_manager.send_command(f'new_state {self.on_address} 0')
+        self.state = LightState.ON
+
+    def turn_off(self):
+        logger.debug(f"Turning off light with ID: {self.name}")
+        self.socket_manager.send_command(f'new_state {self.off_address} 0')
+        self.state = LightState.OFF
+
+    def update(self):
+        logger.debug('Not implemented')
+
+    def __repr__(self):
+        return f'LightEntity: {self.name} - {self.state}'

sensio_lib-0.1.0/sensio_lib/light_state.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+class LightState(Enum):
+    ON = "on"
+    OFF = "off"
+    UNKNOWN = "unknown"

sensio_lib-0.1.0/sensio_lib/socket_manager.py

@@ -0,0 +1,25 @@
+import socket
+from sensio_lib.const import COMMAND_PREFIX, COMMAND_POSTFIX
+
+class SocketManager:
+    _instance = None
+
+    def __new__(cls, server_address):
+        if cls._instance is None:
+            cls._instance = super(SocketManager, cls).__new__(cls)
+            cls._instance.server_address = server_address
+            cls._instance.server_port = 10023
+            cls._instance.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+            cls._instance.socket.settimeout(15)
+            cls._instance.socket.connect((server_address, 10023))
+        return cls._instance
+
+    def send_command(self, command):
+        command = f'{COMMAND_PREFIX}{command}{COMMAND_POSTFIX}'
+        self.socket.sendall(command.encode('utf-8'))
+        #response = self.socket.recv(1024)
+        #return response.decode('utf-8')
+
+    def close(self):
+        self.socket.close()
+        SocketManager._instance = None

sensio_lib-0.1.0/tests/unit/test_hub.py

@@ -0,0 +1,70 @@
+import pytest
+import requests
+from unittest.mock import patch, Mock
+from sensio_lib.hub import Hub
+
+# Mock constants
+SENSIO_PROJECTS_URL = "https://example.com/projects"
+
+@pytest.fixture
+def hub():
+    with patch('sensio_lib.hub.SENSIO_PROJECTS_URL', SENSIO_PROJECTS_URL):
+        with patch.object(Hub, '_get_auth_token', return_value="mocked_token"):
+            with patch.object(Hub, '_get_projects', return_value={}):
+                return Hub("1.1.1.1", "username", "password")
+
+def test_get_projects_success(hub):
+    mock_response = Mock()
+    mock_response.status_code = 200
+    mock_response.json.return_value = {
+        'projects': [
+            {'name': 'Project1', 'projectId': '123'},
+            {'name': 'Project2', 'projectId': '456'}
+        ]
+    }
+
+    with patch('requests.get', return_value=mock_response):
+        projects = hub._get_projects()
+        assert projects == {'Project1': '123', 'Project2': '456'}
+
+def test_get_auth_token_success(hub):
+    mock_response = Mock()
+    mock_response.status_code = 200
+    mock_response.json.return_value = {
+        'tokenId': 'mocked_token_id',
+        'tokenSecret': 'mocked_token_secret'
+    }
+
+    with patch('requests.post', return_value=mock_response):
+        token = hub._get_auth_token()
+        assert token == "bW9ja2VkX3Rva2VuX2lkOm1vY2tlZF90b2tlbl9zZWNyZXQ="
+
+def test_get_projects_no_token(hub):
+    hub.token = None
+    with pytest.raises(Exception, match="Token not set"):
+        hub._get_projects()
+
+def test_get_projects_failure(hub):
+    mock_response = Mock()
+    mock_response.status_code = 500
+
+    with patch('requests.get', return_value=mock_response):
+        with pytest.raises(Exception, match="Failed to retrieve projects"):
+            hub._get_projects()
+
+def test_create_function_list(hub):
+    mock_entity_json = {
+        'functions': [
+            {'name': 'light_1_OFF', 'subType': 'light_off', 'address': '0'},
+            {'name': 'light_1_ON', 'subType': 'light_on', 'address': '1'},
+            {'name': 'light_2_OFF', 'subType': 'light_off', 'address': '2'},
+            {'name': 'light_2_ON', 'subType': 'light_on', 'address': '3'},
+        ]
+    }
+
+    light_list = hub._create_function_list(mock_entity_json)
+    assert light_list == [
+        { 'switch': {'name': 'light_1', 'command_on': '1', 'command_off': '0'}},
+        { 'switch': {'name': 'light_2', 'command_on': '3', 'command_off': '2'}}
+    ]
+