2.0

.devcontainer/devcontainer.json

@@ -12,7 +12,7 @@
 	// Use 'forwardPorts' to make a list of ports inside the container available locally.
 	// "forwardPorts": [],
 	// Use 'postCreateCommand' to run commands after the container is created.
-	"postCreateCommand": "uv sync && uv run pre-commit install",
+	"postCreateCommand": "uv sync --all-extras --dev && uv run prek install",
 	// Configure tool-specific properties.
 	"customizations": {
 		"vscode": {

.github/workflows/docs.yml

@@ -0,0 +1,56 @@
+name: docs
+
+on:
+  release:
+    types:
+      - created
+  pull_request:
+    paths:
+      - docs/**
+      - mkdocs.yml
+      - pyproject.toml
+      - README.md
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Install docs dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Build site
+        run: uv run mkdocs build
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    if: github.event_name == 'release'
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/lint.yaml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        python-version: ["3.12", "3.13", "3.14"]
 
     steps:
       - uses: actions/checkout@v6
@@ -32,7 +32,7 @@ jobs:
       - name: Install the project
         run: uv sync --all-extras --dev
 
-      - name: Run pre-commit
+      - name: Run prek (pre-commit checks)
         env:
           SKIP: ${{ github.ref == 'refs/heads/main' && 'no-commit-to-branch' || '' }}
-        run: uv run pre-commit run --show-diff-on-failure --color=always --all-files
+        run: uv run prek run --show-diff-on-failure --color=always --all-files

.github/workflows/release.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
-          python-version: "3.x"
+          python-version: "3.12"
 
       - name: Retrieve version from tag name
         id: retrieve-version

.github/workflows/test.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        python-version: ["3.12", "3.13", "3.14"]
 
     steps:
       - uses: actions/checkout@v6

.pre-commit-config.yaml

@@ -16,7 +16,7 @@ repos:
     -   id: trailing-whitespace
     -   id: end-of-file-fixer
     -   id: check-json
-        exclude: .devcontainer
+        exclude: .devcontainer|.vscode
     -   id: check-yaml
     -   id: check-added-large-files
     -   id: no-commit-to-branch

.vscode/tasks.json

@@ -0,0 +1,18 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Docs: Serve (development)",
+            "type": "shell",
+            "command": "uv run mkdocs serve",
+            "problemMatcher": []
+        },
+        {
+            "label": "Docs: Build",
+            "type": "shell",
+            "command": "uv run mkdocs build --clean"
+        }
+    ]
+}

AGENTS.md

@@ -29,10 +29,10 @@ Always use full type annotations, generics, and other modern practices.
   # Install all dependencies:
   uv sync
 
-  # Run linting (with ruff), pre-commit checks and type checking (with mypy).
+  # Run linting (with ruff), prek (pre-commit alternative) checks and type checking (with mypy).
   # Note when you run this, ruff will auto-format and sort imports, resolving any
   # linter warnings about import ordering:
-  uv run pre-commit run --all-files
+  uv run prek run --all-files
 
   # Run tests:
   uv run pytest

README.md

@@ -35,37 +35,47 @@ pip install pyoverkiz
 
 ```python
 import asyncio
-import time
 
-from pyoverkiz.const import SUPPORTED_SERVERS
+from pyoverkiz.auth.credentials import UsernamePasswordCredentials
 from pyoverkiz.client import OverkizClient
-from pyoverkiz.enums import Server
+from pyoverkiz.models import Action, Command
+from pyoverkiz.enums import Server, OverkizCommand
 
 USERNAME = ""
 PASSWORD = ""
 
 
 async def main() -> None:
     async with OverkizClient(
-        USERNAME, PASSWORD, server=SUPPORTED_SERVERS[Server.SOMFY_EUROPE]
+        server=Server.SOMFY_EUROPE,
+        credentials=UsernamePasswordCredentials(USERNAME, PASSWORD),
     ) as client:
-        try:
-            await client.login()
-        except Exception as exception:  # pylint: disable=broad-except
-            print(exception)
-            return
+        await client.login()
 
         devices = await client.get_devices()
 
         for device in devices:
-            print(f"{device.label} ({device.id}) - {device.controllable_name}")
+            print(f"{device.label} ({device.device_url}) - {device.controllable_name}")
             print(f"{device.widget} - {device.ui_class}")
 
+        await client.execute_action_group(
+            actions=[
+                Action(
+                    device_url="io://1234-5678-1234/12345678",
+                    commands=[
+                        Command(name=OverkizCommand.SET_CLOSURE, parameters=[100])
+                    ]
+                )
+            ],
+            label="Execution via Python",
+            # mode=ExecutionMode.HIGH_PRIORITY
+        )
+
         while True:
             events = await client.fetch_events()
             print(events)
 
-            time.sleep(2)
+            await asyncio.sleep(2)
 
 
 asyncio.run(main())
@@ -75,43 +85,26 @@ asyncio.run(main())
 
 ```python
 import asyncio
-import time
-import aiohttp
 
+from pyoverkiz.auth.credentials import LocalTokenCredentials
 from pyoverkiz.client import OverkizClient
-from pyoverkiz.const import SUPPORTED_SERVERS, OverkizServer
-from pyoverkiz.enums import Server
+from pyoverkiz.utils import create_local_server_config
 
-USERNAME = ""
-PASSWORD = ""
 LOCAL_GATEWAY = "gateway-xxxx-xxxx-xxxx.local"  # or use the IP address of your gateway
 VERIFY_SSL = True  # set verify_ssl to False if you don't use the .local hostname
 
 
 async def main() -> None:
     token = ""  # generate your token via the Somfy app and include it here
 
-    # Local Connection
-    session = aiohttp.ClientSession(
-        connector=aiohttp.TCPConnector(verify_ssl=VERIFY_SSL)
-    )
-
     async with OverkizClient(
-        username="",
-        password="",
-        token=token,
-        session=session,
+        server=create_local_server_config(host=LOCAL_GATEWAY),
+        credentials=LocalTokenCredentials(token),
         verify_ssl=VERIFY_SSL,
-        server=OverkizServer(
-            name="Somfy TaHoma (local)",
-            endpoint=f"https://{LOCAL_GATEWAY}:8443/enduser-mobile-web/1/enduserAPI/",
-            manufacturer="Somfy",
-            configuration_url=None,
-        ),
     ) as client:
         await client.login()
 
-        print("Local API connection succesfull!")
+        print("Local API connection successful!")
 
         print(await client.get_api_version())
 
@@ -122,14 +115,14 @@ async def main() -> None:
         print(devices)
 
         for device in devices:
-            print(f"{device.label} ({device.id}) - {device.controllable_name}")
+            print(f"{device.label} ({device.device_url}) - {device.controllable_name}")
             print(f"{device.widget} - {device.ui_class}")
 
         while True:
             events = await client.fetch_events()
             print(events)
 
-            time.sleep(2)
+            await asyncio.sleep(2)
 
 
 asyncio.run(main())
@@ -158,7 +151,7 @@ If you use Visual Studio Code with Docker or GitHub Codespaces, you can take adv
 
 - Install [uv](https://docs.astral.sh/uv/getting-started/installation).
 - Clone this repository and navigate to it: `cd python-overkiz-api`
-- Initialize the project with `uv sync`, then run `uv run pre-commit install`
+- Initialize the project with `uv sync`, then run `uv run prek install`
 
 #### Tests