Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/korapp/plasma-homeassistant/llms.txt

Use this file to discover all available pages before exploring further.

Before installing the Home Assistant Plasmoid, ensure your system meets the following requirements.

System Requirements

KDE Plasma

Version 6.0 or higher

Home Assistant

Version 2022.4 or higher

KDE Plasma 6.0+

The plasmoid is built for KDE Plasma 6 and requires the modern Plasma API. It will not work on older Plasma 5 versions.

Home Assistant 2022.4+

The plasmoid communicates with Home Assistant using its WebSocket API and REST API. Version 2022.4 or newer is required for compatibility with the authentication and API features used by the plasmoid.

Active KDE Wallet

An active KDE Wallet is required to securely store your Home Assistant access token.
The plasmoid uses KDE Wallet to securely store your Long Lived Access Token. Make sure KDE Wallet is configured and running on your system before attempting to connect to Home Assistant.

Required Dependencies

Qt WebSocket Package

The Qt WebSocket package is essential for the plasmoid to communicate with Home Assistant in real-time.
The plasmoid requires the Qt6 WebSockets module to establish a WebSocket connection with your Home Assistant instance. This enables real-time updates when entity states change. Install the appropriate package for your Linux distribution:
sudo apt install qml6-module-qtwebsockets
Important: After installing the Qt WebSocket package, you must restart Plasma or log out and log back in for the changes to take effect.

Verifying Installation

After installing the required packages and restarting Plasma, you can verify the Qt WebSockets module is available by checking if other Qt6-based applications with WebSocket support work correctly.

Distribution-Specific Notes

DistributionPackage NamePackage Manager
Debian, Ubuntuqml6-module-qtwebsocketsapt
Arch Linuxqt6-websocketspacman
Fedoraqt6-qtwebsockets-develdnf
openSUSEqt6-websockets-imports`zypper
NixOSkdePackages.qtwebsocketsNix

Next Steps

Once all requirements are met, proceed to the Installation guide.

Build docs developers (and LLMs) love