From f83285dec20ffddc7f82beefccfbb52280404a94 Mon Sep 17 00:00:00 2001
From: Patrick Stevens <3138005+Smaug123@users.noreply.github.com>
Date: Tue, 22 Oct 2024 00:23:29 +0100
Subject: [PATCH] Use Waybar (#87)
---
home-manager/home.nix | 1 +
home-manager/linux.nix | 189 ++++++++++++++++++-
home-manager/modules/waybar/mediaplayer.py | 199 +++++++++++++++++++++
home-manager/modules/waybar/power_menu.xml | 53 ++++++
home-manager/sway.conf | 4 +
5 files changed, 439 insertions(+), 7 deletions(-)
create mode 100644 home-manager/modules/waybar/mediaplayer.py
create mode 100644 home-manager/modules/waybar/power_menu.xml
create mode 100644 home-manager/sway.conf
diff --git a/home-manager/home.nix b/home-manager/home.nix
index c544e2f..75535db 100644
--- a/home-manager/home.nix
+++ b/home-manager/home.nix
@@ -313,6 +313,7 @@
nixpkgs.clang-tools
nixpkgs.deno
nixpkgs.yazi
+ nixpkgs.font-awesome
]
++ (
if nixpkgs.stdenv.isLinux
diff --git a/home-manager/linux.nix b/home-manager/linux.nix
index 90626c6..9076294 100644
--- a/home-manager/linux.nix
+++ b/home-manager/linux.nix
@@ -9,9 +9,189 @@
modifier = "Mod4";
terminal = "alacritty";
window = {border = 5;};
+ bars = [
+ {command = "${nixpkgs.waybar}/bin/waybar";}
+ ];
};
- extraConfig = ''
- output Unknown-1 scale 2
+ extraConfig = builtins.readFile ./sway.conf;
+ };
+
+ programs.waybar = {
+ enable = true;
+ settings = {
+ "bar-0" = {
+ position = "bottom";
+ layer = "top";
+ height = 34;
+ spacing = 8;
+ modules-left = ["sway/workspaces" "sway/mode" "sway/scratchpad" "custom/media"];
+ modules-center = ["sway/window"];
+ modules-right = ["mpd" "idle_inhibitor" "pulseaudio" "network" "power-profiles-daemon" "cpu" "memory" "temperature" "backlight" "keyboard-state" "sway/language" "battery" "battery#bat2" "clock" "tray" "custom/power"];
+
+ "keyboard-state" = {
+ "numlock" = true;
+ "capslock" = true;
+ "format" = "{name} {icon}";
+ "format-icons" = {
+ "locked" = "";
+ "unlocked" = "";
+ };
+ };
+ "sway/mode" = {
+ "format" = "{}";
+ };
+ "sway/scratchpad" = {
+ "format" = "{icon} {count}";
+ "show-empty" = false;
+ "format-icons" = ["" ""];
+ "tooltip" = true;
+ "tooltip-format" = "{app}: {title}";
+ };
+ "mpd" = {
+ "format" = "{stateIcon} {consumeIcon}{randomIcon}{repeatIcon}{singleIcon}{artist} - {album} - {title} ({elapsedTime:%M:%S}/{totalTime:%M:%S}) ⸨{songPosition}|{queueLength}⸩ {volume}% ";
+ "format-disconnected" = "Disconnected ";
+ "format-stopped" = "{consumeIcon}{randomIcon}{repeatIcon}{singleIcon}Stopped ";
+ "unknown-tag" = "N/A";
+ "interval" = 5;
+ "consume-icons" = {
+ "on" = " ";
+ };
+ "random-icons" = {
+ "off" = " ";
+ "on" = " ";
+ };
+ "repeat-icons" = {
+ "on" = " ";
+ };
+ "single-icons" = {
+ "on" = "1 ";
+ };
+ "state-icons" = {
+ "paused" = "";
+ "playing" = "";
+ };
+ "tooltip-format" = "MPD (connected)";
+ "tooltip-format-disconnected" = "MPD (disconnected)";
+ };
+
+ "idle_inhibitor" = {
+ "format" = "{icon}";
+ "format-icons" = {
+ "activated" = "";
+ "deactivated" = "";
+ };
+ };
+
+ "tray" = {
+ "spacing" = 20;
+ };
+ "clock" = {
+ "tooltip-format" = "{:%Y %B}\n{calendar}";
+ "format" = "{:%Y-%m-%d %H:%M:%S}";
+ "interval" = 1;
+ };
+ "cpu" = {
+ "format" = "{usage}% ";
+ "tooltip" = false;
+ };
+ "memory" = {
+ "format" = "{}% ";
+ };
+ "temperature" = {
+ "critical-threshold" = 80;
+ "format" = "{temperatureC}°C {icon}";
+ "format-icons" = ["" "" ""];
+ };
+ "backlight" = {
+ "format" = "{percent}% {icon}";
+ "format-icons" = ["" "" "" "" "" "" "" "" ""];
+ };
+ "battery" = {
+ "states" = {
+ "warning" = 30;
+ "critical" = 15;
+ };
+ "format" = "{capacity}% {icon}";
+ "format-full" = "{capacity}% {icon}";
+ "format-charging" = "{capacity}% ";
+ "format-plugged" = "{capacity}% ";
+ "format-alt" = "{time} {icon}";
+ "format-icons" = ["" "" "" "" ""];
+ };
+ "battery#bat2" = {
+ "bat" = "BAT2";
+ };
+ "power-profiles-daemon" = {
+ "format" = "{icon}";
+ "tooltip-format" = "Power profile: {profile}\nDriver: {driver}";
+ "tooltip" = true;
+ "format-icons" = {
+ "default" = "";
+ "performance" = "";
+ "balanced" = "";
+ "power-saver" = "";
+ };
+ };
+ "network" = {
+ "format-wifi" = "{essid} ({signalStrength}%) ";
+ "format-ethernet" = "{bandwidthDownBytes}/{bandwidthUpBytes} ";
+ "interval" = 5;
+ "tooltip-format" = "{ifname} via {gwaddr} ";
+ "format-linked" = "{ifname} (No IP) ";
+ "format-disconnected" = "Disconnected ⚠";
+ "format-alt" = "{ifname}: {ipaddr}/{cidr}";
+ };
+ "pulseaudio" = {
+ "format" = "{volume}% {icon} {format_source}";
+ "format-bluetooth" = "{volume}% {icon} {format_source}";
+ "format-bluetooth-muted" = " {icon} {format_source}";
+ "format-muted" = " {format_source}";
+ "format-source" = "{volume}% ";
+ "format-source-muted" = "";
+ "format-icons" = {
+ "headphone" = "";
+ "hands-free" = "";
+ "headset" = "";
+ "phone" = "";
+ "portable" = "";
+ "car" = "";
+ "default" = ["" "" ""];
+ };
+ "on-click" = "pavucontrol";
+ };
+ "custom/media" = {
+ "format" = "{icon} {text}";
+ "return-type" = "json";
+ "max-length" = 40;
+ "format-icons" = {
+ "spotify" = "";
+ "default" = "🎜";
+ };
+ "escape" = true;
+ "exec" = let
+ python = nixpkgs.python312.withPackages (ppkgs: [ppkgs.pygobject3]);
+ in "${python}/bin/python ${./modules/waybar/mediaplayer.py} 2> /dev/null";
+ };
+ "custom/power" = {
+ "format" = "⏻ ";
+ "tooltip" = false;
+ "menu" = "on-click";
+ "menu-file" = ./modules/waybar/power_menu.xml;
+ "menu-actions" = {
+ "shutdown" = "shutdown";
+ "reboot" = "reboot";
+ "suspend" = "systemctl suspend";
+ "hibernate" = "systemctl hibernate";
+ };
+ };
+ };
+ };
+
+ style = ''
+ * {
+ font-family: FontAwesome, Roboto, Helvetica, Arial, sans-serif;
+ font-size: 13px;
+ }
'';
};
@@ -21,9 +201,4 @@
};
services.swayidle = {enable = true;};
- services.cbatticon = {
- lowLevelPercent = 20;
- iconType = "standard";
- enable = true;
- };
}
diff --git a/home-manager/modules/waybar/mediaplayer.py b/home-manager/modules/waybar/mediaplayer.py
new file mode 100644
index 0000000..992b792
--- /dev/null
+++ b/home-manager/modules/waybar/mediaplayer.py
@@ -0,0 +1,199 @@
+#!/usr/bin/env python3
+
+# MIT licenced, https://github.com/Alexays/Waybar/blob/dacecb9b265c1c7c36ee43d17526fa95f4e6596f/resources/custom_modules/mediaplayer.py
+# See licence in power_menu.xml
+
+import gi
+gi.require_version("Playerctl", "2.0")
+from gi.repository import Playerctl, GLib
+from gi.repository.Playerctl import Player
+import argparse
+import logging
+import sys
+import signal
+import gi
+import json
+import os
+from typing import List
+
+logger = logging.getLogger(__name__)
+
+def signal_handler(sig, frame):
+ logger.info("Received signal to stop, exiting")
+ sys.stdout.write("\n")
+ sys.stdout.flush()
+ # loop.quit()
+ sys.exit(0)
+
+
+class PlayerManager:
+ def __init__(self, selected_player=None, excluded_player=[]):
+ self.manager = Playerctl.PlayerManager()
+ self.loop = GLib.MainLoop()
+ self.manager.connect(
+ "name-appeared", lambda *args: self.on_player_appeared(*args))
+ self.manager.connect(
+ "player-vanished", lambda *args: self.on_player_vanished(*args))
+
+ signal.signal(signal.SIGINT, signal_handler)
+ signal.signal(signal.SIGTERM, signal_handler)
+ signal.signal(signal.SIGPIPE, signal.SIG_DFL)
+ self.selected_player = selected_player
+ self.excluded_player = excluded_player.split(',') if excluded_player else []
+
+ self.init_players()
+
+ def init_players(self):
+ for player in self.manager.props.player_names:
+ if player.name in self.excluded_player:
+ continue
+ if self.selected_player is not None and self.selected_player != player.name:
+ logger.debug(f"{player.name} is not the filtered player, skipping it")
+ continue
+ self.init_player(player)
+
+ def run(self):
+ logger.info("Starting main loop")
+ self.loop.run()
+
+ def init_player(self, player):
+ logger.info(f"Initialize new player: {player.name}")
+ player = Playerctl.Player.new_from_name(player)
+ player.connect("playback-status",
+ self.on_playback_status_changed, None)
+ player.connect("metadata", self.on_metadata_changed, None)
+ self.manager.manage_player(player)
+ self.on_metadata_changed(player, player.props.metadata)
+
+ def get_players(self) -> List[Player]:
+ return self.manager.props.players
+
+ def write_output(self, text, player):
+ logger.debug(f"Writing output: {text}")
+
+ output = {"text": text,
+ "class": "custom-" + player.props.player_name,
+ "alt": player.props.player_name}
+
+ sys.stdout.write(json.dumps(output) + "\n")
+ sys.stdout.flush()
+
+ def clear_output(self):
+ sys.stdout.write("\n")
+ sys.stdout.flush()
+
+ def on_playback_status_changed(self, player, status, _=None):
+ logger.debug(f"Playback status changed for player {player.props.player_name}: {status}")
+ self.on_metadata_changed(player, player.props.metadata)
+
+ def get_first_playing_player(self):
+ players = self.get_players()
+ logger.debug(f"Getting first playing player from {len(players)} players")
+ if len(players) > 0:
+ # if any are playing, show the first one that is playing
+ # reverse order, so that the most recently added ones are preferred
+ for player in players[::-1]:
+ if player.props.status == "Playing":
+ return player
+ # if none are playing, show the first one
+ return players[0]
+ else:
+ logger.debug("No players found")
+ return None
+
+ def show_most_important_player(self):
+ logger.debug("Showing most important player")
+ # show the currently playing player
+ # or else show the first paused player
+ # or else show nothing
+ current_player = self.get_first_playing_player()
+ if current_player is not None:
+ self.on_metadata_changed(current_player, current_player.props.metadata)
+ else:
+ self.clear_output()
+
+ def on_metadata_changed(self, player, metadata, _=None):
+ logger.debug(f"Metadata changed for player {player.props.player_name}")
+ player_name = player.props.player_name
+ artist = player.get_artist()
+ title = player.get_title()
+ title = title.replace("&", "&")
+
+ track_info = ""
+ if player_name == "spotify" and "mpris:trackid" in metadata.keys() and ":ad:" in player.props.metadata["mpris:trackid"]:
+ track_info = "Advertisement"
+ elif artist is not None and title is not None:
+ track_info = f"{artist} - {title}"
+ else:
+ track_info = title
+
+ if track_info:
+ if player.props.status == "Playing":
+ track_info = " " + track_info
+ else:
+ track_info = " " + track_info
+ # only print output if no other player is playing
+ current_playing = self.get_first_playing_player()
+ if current_playing is None or current_playing.props.player_name == player.props.player_name:
+ self.write_output(track_info, player)
+ else:
+ logger.debug(f"Other player {current_playing.props.player_name} is playing, skipping")
+
+ def on_player_appeared(self, _, player):
+ logger.info(f"Player has appeared: {player.name}")
+ if player.name in self.excluded_player:
+ logger.debug(
+ "New player appeared, but it's in exclude player list, skipping")
+ return
+ if player is not None and (self.selected_player is None or player.name == self.selected_player):
+ self.init_player(player)
+ else:
+ logger.debug(
+ "New player appeared, but it's not the selected player, skipping")
+
+ def on_player_vanished(self, _, player):
+ logger.info(f"Player {player.props.player_name} has vanished")
+ self.show_most_important_player()
+
+def parse_arguments():
+ parser = argparse.ArgumentParser()
+
+ # Increase verbosity with every occurrence of -v
+ parser.add_argument("-v", "--verbose", action="count", default=0)
+
+ parser.add_argument("-x", "--exclude", "- Comma-separated list of excluded player")
+
+ # Define for which player we"re listening
+ parser.add_argument("--player")
+
+ parser.add_argument("--enable-logging", action="store_true")
+
+ return parser.parse_args()
+
+
+def main():
+ arguments = parse_arguments()
+
+ # Initialize logging
+ if arguments.enable_logging:
+ logfile = os.path.join(os.path.dirname(
+ os.path.realpath(__file__)), "media-player.log")
+ logging.basicConfig(filename=logfile, level=logging.DEBUG,
+ format="%(asctime)s %(name)s %(levelname)s:%(lineno)d %(message)s")
+
+ # Logging is set by default to WARN and higher.
+ # With every occurrence of -v it's lowered by one
+ logger.setLevel(max((3 - arguments.verbose) * 10, 0))
+
+ logger.info("Creating player manager")
+ if arguments.player:
+ logger.info(f"Filtering for player: {arguments.player}")
+ if arguments.exclude:
+ logger.info(f"Exclude player {arguments.exclude}")
+
+ player = PlayerManager(arguments.player, arguments.exclude)
+ player.run()
+
+
+if __name__ == "__main__":
+ main()
diff --git a/home-manager/modules/waybar/power_menu.xml b/home-manager/modules/waybar/power_menu.xml
new file mode 100644
index 0000000..a61ead3
--- /dev/null
+++ b/home-manager/modules/waybar/power_menu.xml
@@ -0,0 +1,53 @@
+
+
+
+
+
+
diff --git a/home-manager/sway.conf b/home-manager/sway.conf
new file mode 100644
index 0000000..bfba836
--- /dev/null
+++ b/home-manager/sway.conf
@@ -0,0 +1,4 @@
+output Unknown-1 scale 2
+input * {
+ xkb_layout "gb"
+}