When the interval's time is up, remind the user every 5 minutes to get back to work. :duration '5 minutes ' Before starting the interval, announce and notify, to show the user that the interval has begun. (interval :name 'Play ' :face 'font-lock-type-face The play/rest interval will always be 5 minutes long. (hammy-define 'Flywheel ' :documentation 'Get your momentum going! ' :intervals Here’s a more interesting example, a “flywheel timer” (so called because it helps to build momentum), which interleaves rest periods with gradually lengthening work periods. ( play-sound-file '~/Misc/Sounds/relax.wav '))))) (If we omitted the `:advance' slot, the interval would automatically advance when it reached its duration.) :advance ( do (announce 'Time for a sit-down. Again, the interval should not advance automatically to the next-the user should indicate when he's actually sat down again.

(interval :name '🤸 ' :duration '5 minutes ' :face 'font-lock-builtin-face :before ( do (announce 'Mooove it! ') ( play-sound-file '~/Misc/Sounds/mooove-it.wav ')))) ( do (announce 'Time to stretch your legs! ') :advance (remind '10 minutes ' Every 10 minutes, while the hammy is waiting to be advanced to the next interval, remind the user by doing these things: We wrap the list in a call to the built-in `remind' function, which causes the actions to be repeated every 10 minutes until the user manually advances to the next interval. So we provide a list of actions to take when it's time to advance to the next interval. We want this interval to not automatically advance to the next one rather, we want the user to call the `hammy-next' command to indicate when the standing-up is actually happening. In its body, we call two built-in helper functions. The `do' macro expands to a lambda, which the interval's `before' slot is set to. :face 'font-lock-type-face A list of actions to take before starting the interval (really, one or a list of functions to call with the hammy as the argument). :duration '45 minutes ' Optionally, a face in which to show the interval's name in the mode line. :name '💺 ' The duration of the interval: a number of seconds, a string passed to `timer-duration', or a function which returns such. The name of the interval is a string, used when selecting hammys and shown in the mode line. ' :intervals A list of intervals, each defined with the `interval' function. (hammy-define 'Move ' :documentation 'Don't forget to stretch your legs. This timer reminds you to stand up every so often (e.g. These examples have more detailed comments to explain how a hammy is defined. Of course, if you have something against hamsters, the lighter prefix can be customized, as well as various faces for parts of the mode line. You can see the lighter prefix ( 🐹), the status ( :, or ! when overdue), the current hammy’s name ( Move), the current interval’s name ( 💺), and the time elapsed (prefixed by - when counting down, and + when overdue and counting up). The mode-line looks like this (when no hammy is active, when one is active, and when one is “overdue”, waiting for the user to manually advance to the next interval): You may also use these commands: hammy-mode Reset a hammy (useful when a hammy is defined to behave differently the longer it runs). (The Org task will then automatically be clocked out during the hammy’s next interval (and when the hammy is stopped), and back in when the first interval resumes.)Īdvance to the next interval of a hammy (when it’s defined to not advance automatically).Īdjust the durations of a hammy’s intervals (which can be reset later).

Then you can use these commands, which will prompt you to choose a defined hammy: hammy-startĬall org-clock-in, then hammy-start. :advance ( do (announce 'Break time is over! ') :before ( do (announce 'Starting break time. If a multiple of three cycles have elapsed, the fourth work period was just completed, so take a longer break. (interval :name 'Break ' :duration ( do ( if ( and ( not ( zerop cycles)) (interval :name 'Work ' :duration '25 minutes ' :before ( do (announce 'Starting work time. :documentation 'The classic pomodoro timer. (hammy-define ( propertize '🍅 ' 'face '( :foreground 'tomato ')) We name the timer with the Unicode TOMATO character, and propertize it with a tomato-colored face.

Inter active timer for 10min