command line switches for displaying current status

[logrusx]

Is your proposal related to a problem?

I recently migrated to Hyprland and it's amazing but I have to keep the app somewhere out of the way and this way I don't see it.

Describe the solution you'd like

I'd like to be able to pass switches to the command the same way I would start/stop pomodoro from the command line that would show me current information about the status so that I can parse that information and display it through an osd notification.

Describe alternatives you've considered

The alternative is to keep the application open in a workspace I don't see and only rely on the notifications and sounds, but that's kind of inconvenient.

Other information

I'm using swayosd but there are other wayland osd programs that can benefit from that.

[kamilprusko]

Hi @logrusx,

GNOME for long time offered "Always On Top" / "Always on Visible Workspace" options (screenshot). In Hyperland from what I read, it's possible through ini file https://wiki.hyprland.org/Configuring/Window-Rules/.

As to the swayosd I recommend using DBus - you will get more timely updates and only when the timer is running. If I understand correctly and swayosd displays the last line of an stdout, then this should do:

#!/usr/bin/env python

import dbus
import dbus.mainloop.glib
from gi.repository import GLib
from math import floor, ceil


SERVICE_NAME = 'org.gnome.Pomodoro'
OBJECT_PATH = '/org/gnome/Pomodoro'
INTERFACE_NAME = 'org.gnome.Pomodoro'

properties_interface = None


def format_time(seconds):
    hours = seconds // 3600;
    minutes = (seconds % 3600) // 60;
    parts = []

    seconds = seconds % 60;

    if hours > 0:
        parts.append(f'{hours}h');

    if minutes > 0:
        parts.append(f'{minutes}m');

    if hours == 0:
        parts.append(f'{seconds}s');

    return ' '.join(parts)


def print_timer_state():
    global properties_interface
    
    data = properties_interface.GetAll(INTERFACE_NAME)

    elapsed = floor(data['Elapsed'])
    remaining = ceil(data['StateDuration'] - elapsed)
    is_paused = data['IsPaused']
    state = data['State']

    if is_paused and elapsed == 0 and state == 'pomodoro':
        print(f'Break Over!')
        return

    if is_paused:
        remaining_string = 'Paused'
    else:
        remaining_string = format_time(remaining)

    match state:
        case 'pomodoro':
            print(f'Pomodoro {remaining_string}')

        case 'short-break':
            print(f'Break {remaining_string}')

        case 'long-break':
            print(f'Break {remaining_string}')

        case _:
            print('Stopped')


def on_properties_changed(interface, changed, invalidated):
    """
    Callback for when a property changes.
    Args:
        - interface: The interface of the property.
        - changed: A dictionary of changed properties.
        - invalidated: A list of invalidated properties.
        - path: Object path of the change.
    """
    print_timer_state()


def main():
    global properties_interface

    dbus.mainloop.glib.DBusGMainLoop(set_as_default=True)

    bus = dbus.SessionBus()
    proxy_object = bus.get_object(SERVICE_NAME, OBJECT_PATH)
    properties_interface = dbus.Interface(proxy_object, 'org.freedesktop.DBus.Properties')
    properties_interface.connect_to_signal('PropertiesChanged', on_properties_changed)

    print_timer_state()

    loop = GLib.MainLoop()
    loop.run()


if __name__ == '__main__':
    main()

It requires python-dbus, which you may have already installed.

[logrusx]

Hi Kamil,

Thank you for taking the time!

Hi @logrusx,

GNOME for long time offered "Always On Top" / "Always on Visible Workspace" options (screenshot). In Hyperland from what I read, it's possible through ini file https://wiki.hyprland.org/Configuring/Window-Rules/.

No, that'll put the app in the way of everything as it'll make it impossible to interact with anything else on that workspace. I want to explicitly ask it, Hey, what's your status? and put the answer in an OSD message as it won't interfere with anything that way.

As to the swayosd I recommend using DBus - you will get more timely updates and only when the timer is running. If I understand correctly and swayosd displays the last line of an stdout,

It would display anything I tell it to. I can even provide Gtk Classes to render the message but becoming a Gtk programmer is not one of my dearest dreams :-)

then this should do:

#!/usr/bin/env python

import dbus
import dbus.mainloop.glib
from gi.repository import GLib
from math import floor, ceil


SERVICE_NAME = 'org.gnome.Pomodoro'
OBJECT_PATH = '/org/gnome/Pomodoro'
INTERFACE_NAME = 'org.gnome.Pomodoro'

properties_interface = None


def format_time(seconds):
    hours = seconds // 3600;
    minutes = (seconds % 3600) // 60;
    parts = []

    seconds = seconds % 60;

    if hours > 0:
        parts.append(f'{hours}h');

    if minutes > 0:
        parts.append(f'{minutes}m');

    if hours == 0:
        parts.append(f'{seconds}s');

    return ' '.join(parts)


def print_timer_state():
    global properties_interface
    
    data = properties_interface.GetAll(INTERFACE_NAME)

    elapsed = floor(data['Elapsed'])
    remaining = ceil(data['StateDuration'] - elapsed)
    is_paused = data['IsPaused']
    state = data['State']

    if is_paused and elapsed == 0 and state == 'pomodoro':
        print(f'Break Over!')
        return

    if is_paused:
        remaining_string = 'Paused'
    else:
        remaining_string = format_time(remaining)

    match state:
        case 'pomodoro':
            print(f'Pomodoro {remaining_string}')

        case 'short-break':
            print(f'Break {remaining_string}')

        case 'long-break':
            print(f'Break {remaining_string}')

        case _:
            print('Stopped')


def on_properties_changed(interface, changed, invalidated):
    """
    Callback for when a property changes.
    Args:
        - interface: The interface of the property.
        - changed: A dictionary of changed properties.
        - invalidated: A list of invalidated properties.
        - path: Object path of the change.
    """
    print_timer_state()


def main():
    global properties_interface

    dbus.mainloop.glib.DBusGMainLoop(set_as_default=True)

    bus = dbus.SessionBus()
    proxy_object = bus.get_object(SERVICE_NAME, OBJECT_PATH)
    properties_interface = dbus.Interface(proxy_object, 'org.freedesktop.DBus.Properties')
    properties_interface.connect_to_signal('PropertiesChanged', on_properties_changed)

    print_timer_state()

    loop = GLib.MainLoop()
    loop.run()


if __name__ == '__main__':
    main()

It requires python-dbus, which you may have already installed.

Thanks, I'll try that and will report what the result is.

[logrusx]

No, this script is not what I'm looking for. SwayOSD runs commands. I want to run a command which will query the state. It'll be controlled by a hotkey which I'll press while I'm working and concerned about time.

[logrusx]

I was able to make it work by deleting the loop stuff. SwayOSD does not take continuous output. Hyprland and, I guess, Sway have key binds that execute built-in or external commands. Once you press the key, the command is invoked. This is how SwayOSD works - it gets run every time with appropriate parameters, the message is displayed and shortly disappears. That's why continuous input is not possible.

Thanks for the script!

[kamilprusko]

Glad it works :)

Coming back to the original idea... I imagine gnome-pomodoro status could print all relevant info, my concern is how many users would use it. For automation JSON would be more versatile, and I could reuse data from Custom Actions 2.0:

I hear the current CLI is too limited. I'd consider revamping... Examples of apps with good CLI are welcomed.