desk2ha-agent 0.3.0__tar.gz

desk2ha_agent-0.3.0/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install ruff
+      - run: ruff check desk2ha_agent/ tests/
+      - run: ruff format --check desk2ha_agent/ tests/
+
+  test:
+    strategy:
+      matrix:
+        python: ["3.11", "3.12", "3.13"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - run: pip install -e ".[dev]"
+      - run: pytest tests/ -x --tb=short

desk2ha_agent-0.3.0/.github/workflows/release.yml

@@ -0,0 +1,23 @@
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install build
+      - run: python -m build
+      - uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+      - uses: pypa/gh-action-pypi-publish@release/v1

desk2ha_agent-0.3.0/.gitignore

@@ -0,0 +1,20 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+dist/
+build/
+*.egg-info/
+*.egg
+.eggs/
+.venv/
+venv/
+*.log
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.coverage
+htmlcov/
+*.toml.bak
+desk2ha-agent.toml
+test-config.toml

desk2ha_agent-0.3.0/.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.6
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

desk2ha_agent-0.3.0/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+
+### Added
+- Initial project structure
+- Collector ABC and plugin registry scaffold
+- CI pipeline (ruff, mypy, pytest)
+- Pre-commit hooks

desk2ha_agent-0.3.0/CLAUDE.md

@@ -0,0 +1,57 @@
+# desk2ha-agent — Development Guide
+
+You are working on the **Desk2HA Agent**, a cross-platform Python service that
+runs on endpoint devices and exposes local telemetry via HTTP and MQTT.
+
+## Quick Reference
+
+- Python package: `desk2ha_agent`
+- Entry point: `python -m desk2ha_agent`
+- Config format: TOML (`desk2ha-agent.toml`)
+- API port: 9693
+
+## Autonomie-Regeln
+
+Du darfst OHNE Rueckfrage:
+- Code, Tests, Doku auf Feature-Branches schreiben, committen und pushen
+- Draft-PRs erstellen
+- Lint/Format/Type-Fehler fixen
+- Dependencies in pyproject.toml hinzufuegen (mit Begruendung im Commit)
+
+Du MUSST den User fragen fuer:
+- PR auf main mergen (ausser docs/*)
+- Release taggen
+- Deploy auf Live-System
+- OpenAPI Spec oder ARCHITECTURE.md aendern
+- CLAUDE.md aendern
+
+## Vor jedem Commit
+
+```bash
+ruff check . && ruff format --check . && mypy desk2ha_agent/ && pytest tests/unit/ -x
+```
+
+## Projektstruktur
+
+- `desk2ha_agent/collector/platform/` — OS-specific host telemetry (Windows/Linux/macOS)
+- `desk2ha_agent/collector/generic/` — Standard protocols (DDC/CI, UVC, BLE, HID)
+- `desk2ha_agent/collector/vendor/` — Vendor plugins (Dell, HP, Lenovo, Logitech)
+- `desk2ha_agent/transport/` — HTTP, MQTT, Prometheus transports
+- `desk2ha_agent/lifecycle/` — Self-update, config API, service manager
+- `desk2ha_agent/images/` — Product image fetcher + cache
+- `desk2ha_agent/tray/` — Windows system tray helper
+
+## Coding Standards
+
+- Type hints on all public functions
+- `from __future__ import annotations` in every module
+- Async by default (aiohttp event loop)
+- Collectors inherit from `collector.base.Collector`
+- Use `logging` (no print statements)
+- Keep platform-specific imports behind `sys.platform` guards
+
+## Commit Convention
+
+Format: `{type}: {description}`
+Types: feat, fix, refactor, test, docs, ci, chore
+All commits end with: `Co-Authored-By: Claude <noreply@anthropic.com>`

desk2ha_agent-0.3.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

desk2ha_agent-0.3.0/PKG-INFO

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: desk2ha-agent
+Version: 0.3.0
+Summary: Multi-vendor desktop telemetry agent for Home Assistant
+Project-URL: Homepage, https://github.com/maximusIIxII/desk2ha-agent
+Project-URL: Repository, https://github.com/maximusIIxII/desk2ha-agent
+Project-URL: Issues, https://github.com/maximusIIxII/desk2ha-agent/issues
+Author: maximusIIxII
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+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
+Requires-Dist: aiohttp>=3.9
+Requires-Dist: hidapi>=0.14
+Requires-Dist: monitorcontrol>=3.0
+Requires-Dist: paho-mqtt>=2.0
+Requires-Dist: psutil>=5.9
+Requires-Dist: pydantic>=2.5
+Requires-Dist: zeroconf>=0.131
+Provides-Extra: dev
+Requires-Dist: datamodel-code-generator>=0.25; extra == 'dev'
+Requires-Dist: mypy>=1.9; extra == 'dev'
+Requires-Dist: pre-commit>=3.7; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Provides-Extra: linux
+Requires-Dist: bleak>=0.21; extra == 'linux'
+Provides-Extra: macos
+Requires-Dist: bleak>=0.21; extra == 'macos'
+Provides-Extra: windows
+Requires-Dist: pillow>=10.0; extra == 'windows'
+Requires-Dist: pystray>=0.19; extra == 'windows'
+Requires-Dist: pywin32>=306; extra == 'windows'
+Requires-Dist: winrt-windows-devices-bluetooth>=2.0; extra == 'windows'
+Requires-Dist: wmi>=1.5; extra == 'windows'
+Description-Content-Type: text/markdown
+
+# Desk2HA Agent
+
+Multi-vendor desktop telemetry agent for [Home Assistant](https://www.home-assistant.io/).
+
+Collects hardware metrics, peripheral status, and display settings from Windows, Linux, and macOS — and exposes them via HTTP and MQTT for the [Desk2HA HA integration](https://github.com/maximusIIxII/hass-desk2ha).
+
+## Features
+
+- **Cross-platform**: Windows, Linux, macOS
+- **3-tier collector model**: Platform (OS) → Generic (DDC/CI, HID, BLE) → Vendor (Dell, HP, ...)
+- **Display control**: Brightness, contrast, volume, input source, KVM switch via DDC/CI
+- **Dual transport**: HTTP API (OpenAPI v2.0.0) + MQTT with HA Discovery
+- **Auto-discovery**: Zeroconf/mDNS (`_desk2ha._tcp.local.`)
+- **Self-update**: Version check via GitHub Releases + pip upgrade
+- **System tray**: Windows tray icon with status menu
+
+## Collectors
+
+| Tier | Collector | Metrics |
+|------|-----------|---------|
+| Platform | Windows (WMI + psutil) | CPU, RAM, disk, battery, network, GPU, OS info |
+| Platform | Linux (sysfs + psutil) | Same as above |
+| Platform | macOS (IOKit + psutil) | Same as above |
+| Generic | DDC/CI | Monitor brightness, contrast, volume, input, power, KVM, PBP |
+| Generic | USB PD | Charger connected, voltage, charging state |
+| Generic | HeadsetControl | Headset battery, sidetone, LED, chatmix |
+| Generic | HID Battery | USB peripheral battery levels |
+| Generic | BLE Battery | Bluetooth device batteries |
+| Vendor | Dell Command Monitor | CPU/GPU/SSD thermals, fan speeds, AC adapter wattage |
+
+## Installation
+
+```bash
+pip install desk2ha-agent
+# Windows extras (WMI, tray icon):
+pip install desk2ha-agent[windows]
+```
+
+## Quick Start
+
+1. Create a config file (`desk2ha-agent.toml`):
+
+```toml
+[http]
+enabled = true
+bind = "0.0.0.0"
+port = 9693
+auth_token = "YOUR_RANDOM_TOKEN"
+```
+
+2. Run the agent:
+
+```bash
+desk2ha-agent --config desk2ha-agent.toml
+```
+
+3. In Home Assistant, add the [Desk2HA integration](https://github.com/maximusIIxII/hass-desk2ha) and point it to `http://<agent-ip>:9693`.
+
+## Configuration
+
+See [`examples/full-config.toml`](examples/full-config.toml) for all options.
+
+| Section | Key Options |
+|---------|-------------|
+| `[http]` | `bind`, `port`, `auth_token` |
+| `[mqtt]` | `broker`, `port`, `username`, `password_env`, `base_topic` |
+| `[collectors]` | `disabled`, `intervals` (per-collector poll rate) |
+| `[logging]` | `level` (DEBUG/INFO/WARNING) |
+
+## API Endpoints
+
+| Method | Path | Auth | Description |
+|--------|------|------|-------------|
+| GET | `/v1/health` | No | Health check |
+| GET | `/v1/info` | Yes | Device identity + collector status |
+| GET | `/v1/metrics` | Yes | All collected metrics |
+| GET | `/v1/commands` | Yes | List available commands |
+| POST | `/v1/commands` | Yes | Execute a command (e.g. set brightness) |
+| GET | `/v1/update/check` | Yes | Check for new agent release |
+| POST | `/v1/update/install` | Yes | Install agent update |
+
+## Recommended Vendor Software
+
+The agent works out of the box with basic metrics via standard OS APIs. For **full telemetry** (detailed thermals, fan speeds, battery health, thermal profile control), install the vendor-specific software for your hardware:
+
+### Dell
+
+| Software | What it unlocks | Download |
+|----------|----------------|----------|
+| **Dell Command \| Monitor** | CPU/GPU/SSD/skin thermals, fan RPM, AC adapter wattage, thermal profile control | [Dell Support](https://www.dell.com/support/kbdoc/en-us/000177080/dell-command-monitor) |
+| **Dell Peripheral Manager** | Webcam settings, keyboard backlight, mouse DPI for Dell peripherals | [Dell Support](https://www.dell.com/support/kbdoc/en-us/000201446/dell-peripheral-manager) |
+
+### HP
+
+| Software | What it unlocks | Download |
+|----------|----------------|----------|
+| **HP System Event Utility** | BIOS settings, thermal profile, fan control | [HP Support](https://support.hp.com/drivers) (search your model) |
+| **HP Notifications** | Battery health, power delivery info | Included with HP Support Assistant |
+
+### Lenovo
+
+| Software | What it unlocks | Download |
+|----------|----------------|----------|
+| **Lenovo Vantage** | Thermal mode, battery thresholds, keyboard backlight | [Microsoft Store](https://apps.microsoft.com/detail/9WZDNCRFJ4MV) |
+| **Lenovo System Interface Foundation** | WMI access for BIOS settings, fan speed | [Lenovo Support](https://support.lenovo.com/solutions/ht503475) |
+
+### Linux (ThinkPad)
+
+| Module | What it unlocks | How to enable |
+|--------|----------------|---------------|
+| `thinkpad_acpi` | Fan speed, thermal mode | Usually auto-loaded. Check: `lsmod \| grep thinkpad` |
+| `ideapad_acpi` | Performance mode (IdeaPad/Legion) | Usually auto-loaded. Check: `lsmod \| grep ideapad` |
+
+### Cross-Platform
+
+| Software | What it unlocks | Download |
+|----------|----------------|----------|
+| **HeadsetControl** | Headset battery, sidetone, LED, chatmix (SteelSeries, Corsair, Logitech, HyperX) | [GitHub](https://github.com/Sapd/HeadsetControl/releases) |
+
+> **Note:** All vendor software is optional. The agent gracefully skips collectors when the required software is not installed. You can check which collectors are active via `GET /v1/info`.
+
+## Windows Autostart
+
+The agent needs an interactive desktop session for DDC/CI monitor control. Use the Startup folder (not a Windows Service):
+
+```
+%APPDATA%\Microsoft\Windows\Start Menu\Programs\Startup\Desk2HA Agent.vbs
+```
+
+## Known Issues
+
+| Issue | Workaround | Status |
+|-------|------------|--------|
+| **DDC/CI not working as Windows Service** | DDC/CI requires an interactive desktop session (Session 1+). Use Startup folder autostart, not NSSM/Windows Service. | By design (Windows limitation) |
+| **Dell Command Monitor v10.x WMI not available** | DCM v10.13 may not register the `root\dcim\sysman` WMI provider automatically. Ensure the `dcstor64` and `dcevt64` services are running. | Investigating |
+| **Bluetooth peripherals not detected** | Devices connected via Dell Universal Receiver (Bluetooth/RF) are not yet enumerated. Only direct USB devices are listed. | Planned |
+| **Duplicate devices after upgrade** | After upgrading from an older version, orphaned entity registry entries may create duplicate devices. Fix: delete the integration in HA and re-add it. | Known |
+| **Logitech Litra G HUB conflict** | If Logitech G HUB is running, it may hold the HID interface and prevent the agent from reading Litra status. | Close G HUB or disable Litra in G HUB |
+
+## Upcoming Features
+
+- **Bluetooth peripheral enumeration**: Detect mouse/keyboard via Dell Universal Receiver and Logitech Bolt
+- **Dell Command Monitor v10 support**: Resolve WMI provider registration for DCM v10.x
+- **Webcam UVC controls**: Brightness, contrast, white balance, FOV, autofocus
+- **Corsair/SteelSeries/Razer plugins**: iCUE SDK, Sonar REST, Synapse integration
+- **Product image system**: Vendor-specific device silhouettes and fetched product photos
+- **Remote agent installation**: Deploy agent from HA UI via SSH/WinRM
+- **Prometheus endpoint**: `/metrics` in Prometheus scrape format
+- **Fleet management**: Multi-agent coordination for enterprise environments
+
+## License
+
+Apache-2.0