Module i3status_rs::blocks::pomodoro

source ·
Expand description

A pomodoro timer

§Technique

There are six steps in the original technique:

  1. Decide on the task to be done.
  2. Set the pomodoro timer (traditionally to 25 minutes).
  3. Work on the task.
  4. End work when the timer rings and put a checkmark on a piece of paper.
  5. If you have fewer than four checkmarks, take a short break (3–5 minutes) and then return to step 2.
  6. After four pomodoros, take a longer break (15–30 minutes), reset your checkmark count to zero, then go to step 1.

§Configuration

KeyValuesDefault
formatA string to customise the output of this block." $icon{ $message|} "
messageMessage when timer expires"Pomodoro over! Take a break!"
break_messageMessage when break is over"Break over! Time to work!"
notify_cmdA shell command to run as a notifier. {msg} will be substituted with either message or break_message.None
blocking_cmdIs notify_cmd blocking? If it is, then pomodoro block will wait until the command finishes before proceeding. Otherwise, you will have to click on the block in order to proceed.false
PlaceholderValueType
iconA static iconIcon
messageCurrent messageText

§Example

Use swaynag as a notifier:

[[block]]
block = "pomodoro"
notify_cmd = "swaynag -m '{msg}'"
blocking_cmd = true

Use notify-send as a notifier:

[[block]]
block = "pomodoro"
notify_cmd = "notify-send '{msg}'"
blocking_cmd = false

§Icons Used

  • pomodoro
  • pomodoro_started
  • pomodoro_stopped
  • pomodoro_paused
  • pomodoro_break

§TODO

  • Use different icons.
  • Use format strings.

Structs§

Functions§