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.

Home Assistant Plasmoid

Bring your Home Assistant entities directly to your KDE Plasma desktop with a powerful, customizable widget

What is Home Assistant Plasmoid?

Home Assistant Plasmoid is a KDE Plasma 6 widget that seamlessly integrates your Home Assistant instance into your desktop environment. Monitor entity states, control devices, and receive notifications—all without leaving your desktop workflow.

Real-time Updates

WebSocket-based connection provides instant entity state updates on your desktop

Service Control

Call Home Assistant services directly from your panel or desktop widget

Secure Storage

Access tokens are securely stored in KDE Wallet for maximum security

Flexible Display

Customize entity tiles with icons, attributes, and configurable actions

Key Features

Monitor entity states and attributes in real-time via WebSocket connection. Display sensor values, switch states, light status, and more directly on your desktop panel or as a standalone widget.
Execute Home Assistant services with a single click or scroll action. Turn on lights, adjust thermostats, trigger automations—all from your Plasma desktop.
Receive KDE Plasma notifications when entity states change. Stay informed about important events like doors opening, motion detection, or temperature thresholds.
Configure each entity with custom names, icons, display attributes, and actions. Choose which entity properties to display and how users interact with them.
Save your entity configurations to .hapi files for backup or sharing. Auto-backup support ensures your configuration is never lost.

Quick Example

Once installed and configured, you can monitor and control your Home Assistant entities directly from your Plasma panel:
// The plasmoid automatically connects via WebSocket
// and subscribes to your configured entities
Client {
    id: client
    baseUrl: "http://homeassistant.local:8123"
    token: "<your-long-lived-access-token>"
    
    onReadyChanged: {
        if (ready) {
            // Subscribe to entities when connected
            client.subscribeEntities(
                ["light.living_room", "sensor.temperature"],
                (event) => {
                    // Handle real-time updates
                    console.log("Entity state changed:", event)
                }
            )
        }
    }
}

System Requirements

KDE Plasma 6.0 or later is required. The plasmoid uses Plasma 6 APIs and Qt 6 WebSockets.
  • Active KDE Wallet for secure token storage
  • Home Assistant 2022.4 or later
  • Qt 6 WebSocket package installed (see Requirements for distro-specific packages)

Get Started

Ready to integrate Home Assistant into your Plasma desktop?

Installation

Install from KDE Store or build from source

Configuration

Connect to your Home Assistant instance

Add Entities

Configure entities to monitor and control

Troubleshooting

Solve common issues

Community & Support

Home Assistant Plasmoid is open source and welcomes contributions:
If you find this plasmoid useful, consider supporting the developer via Liberapay or Ko-fi.

Build docs developers (and LLMs) love