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.

There are multiple ways to install the Home Assistant Plasmoid. Choose the method that works best for you.
Make sure you have met all the requirements before proceeding with installation.
The easiest and recommended way to install the plasmoid is through KDE’s built-in software management.
1

Open Plasma Discover

Launch the Discover application from your application menu.
2

Search for Home Assistant

Use the search function and type “Home Assistant” to find the plasmoid.
3

Install

Click the Install button to download and install the plasmoid automatically.

​
Alternative: Get New Widgets

You can also install directly from the desktop:
1

Access Widget Menu

Right-click on your desktop or panel.
2

Navigate to Get New Widgets

Select Add Widgets > Get New Widgets > Download New Plasma Widgets.
3

Search and Install

Search for “Home Assistant” and click Install.

​
Method 2: Install from File

If you prefer to install from a downloaded file, you can get the plasmoid package from the KDE Store.

​
Option A: Using Plasma UI

1

Download the Plasmoid

Download the latest plasma-homeassistant-*.plasmoid file from the KDE Store.
2

Right-click on Panel or Desktop

Right-click on your desktop or panel to open the context menu.
3

Navigate to Install Menu

Select Add Widgets > Get New Widgets > Install From Local File.
4

Choose the File

Browse to and select the downloaded .plasmoid file.

​
Option B: Using Terminal

For users who prefer the command line:
1

Download the Plasmoid

Download the latest plasma-homeassistant-*.plasmoid file from the KDE Store.
2

Install with plasmapkg2

Run the following command in your terminal:
plasmapkg2 -i plasma-homeassistant-*.plasmoid
Replace * with the actual version number of the file you downloaded.

​
Method 3: Install from GitHub Source

For developers or users who want to install from the source code:
1

Clone the Repository

Clone the repository with its submodules:
git clone --recurse-submodules https://github.com/korapp/plasma-homeassistant.git
cd plasma-homeassistant
The --recurse-submodules flag is important to ensure all dependencies are cloned.
2

Install the Package

Install the plasmoid using plasmapkg2:
plasmapkg2 -i package

​
Updating from Source

To update an installation from source: 
cd plasma-homeassistant
git pull
git submodule update --recursive
plasmapkg2 -u package

​
Post-Installation

After installation, the plasmoid will be available in your widget list.
1

Add Widget to Desktop or Panel

Right-click on your desktop or panel, select Add Widgets, and find “Home Assistant” in the list.
2

Configure Connection

Right-click the widget and select Configure to set up your Home Assistant connection.

​
Troubleshooting

Try restarting Plasma:
plasmashell --replace &
Or log out and log back in.
Make sure you have the required Qt WebSocket package installed. See the Requirements page for details.
Ensure:
  • KDE Wallet is active and running
  • You have created a Long Lived Access Token in Home Assistant
  • The Qt WebSocket package is installed
  • You have restarted Plasma after installing dependencies

​
Next Steps

Now that the plasmoid is installed, proceed to the configuration guide to connect it to your Home Assistant instance.

Build docs developers (and LLMs) love

Get started for freeTalk to us