Crate kdeconnect_waybar 

A highly configurable KDE Connect module for Waybar

allows you to display many information about your mobile devices (phone or tablet) such as battery, notifications, …

Configuring

This documentation assumes you have installed Waybar and know how to configure it, as well as KDE Connect and already paired a device using it

It is also recommended to have a Nerd-Font installed on your Waybar

🔧 Installation

Check out Installation for detailed installation instructions

⚙️ Updating your waybar config

Once installed start by adding the module to your waybar’s config :

~/.config/waybar/config.jsonc

"custom/kdeconnect": {
   "format": "{}",
   "exec": "kdeconnect_waybar", <-- or "kdeconnect_waybar -c <name>" to use a custom config name
   "return-type": "json",
   "on-click": ""
}

⚠️ Important

Before continuing to the next steps I’d recommend you execute the command

kdeconnect_waybar gen_schema

for it to generate a json schema file which will tell your IDE what should be in the config file

✨ Configuring the module to your taste

Then locate the config directory it should be under :

$XDG_CONFIG_HOME/kdeconnect_waybar or $HOME/.config/kdeconnect_waybar e.g. /home/alice/.config/kdeconnect_waybar

If it doesn’t appear create it manually or run kdeconnect_waybar

In it make a file called config.json with your custom config (hot reloading supported)

Here’s an example of what it could look like :

{
	"$schema": "./config.schema.json",
	"configs": [
		{
			"update_interval_secs": 5,
			"format": "{Battery::ChargePercent}% {Battery::ChargeTexts} {Notification::Grouped}",
			"tooltip_format": "Device type: {DeviceInfo::DeviceTypeText}\nBattery status: {Battery::IsChargingText} {Battery::ChargePercent}% \nNotifications:\n{Notification::Single}",
			"device_not_found_text": "",
			"device_not_found_tooltip_text": "Device not found make sure kdeconnect is running and phone is connected",
			"device_phone_text": "Phone ",
			"device_tablet_text": "Tablet ",
        }
    ]
}

You may wanna look at examples for more inspiration !

The two final text that will be displayed on your waybar are Config::format and Config::tooltip_format see GlobalFormat to understand how to configure them

configs is an array so you can configure multiple ones and use them with kdeconnect_waybar -c <name> in your Waybar module exec field

👀 Look at whole documentation

See also Config to know all that’s available for your config

🎨 Styling

You can edit the module’s style by referring to it with #custom-kdeconnect in your waybar’s css

🐞 Bugs and Errors

If something appears to be broken, before submitting an issue, try running the program outside out of the waybar (just run kdeconnect_waybar in your terminal), if anything goes wrong it will display an error, it is useful for debugging your config (if you misspelled some field for example),

If you can pin point the issue or wanna request a new feature then feel free to open an issue here

Modules

config

formatter

wrapper

Structs

Args