DayTimer
Extension
ExtensionDescription
DayTimer allows scheduling actions to happen at specific times of day. This can be useful for installations that run unattended in museum or gallery situations. A DayTimer is stored by name, and can keep multiple actions to run at different times of day. There is a global DayTimer instance which may suffice for simple uses.
// Use the global top DayTimer// put an action in - at every full 10 seconds, post.DayTimer.putDate(\ten, { |date| date.second % 10 == 0 }, { "10 sec.".postln });DayTimer.start; // now do it.// post every three secondsDayTimer.putDate(\three, { |date| date.second % 3 == 0 }, { "3 sec.".postln });// removeDayTimer.removeAt(\ten);DayTimer.putDate(\two, { |date| date.second % 2 == 0 }, { "2 sec.".postln });DayTimer.removeAt(\three);DayTimer.stop;// Make a daytimer and use itd = DayTimer(\otto);d.start; // do this every full minute - id so you can remove it againd.putDate(\perMin, { |date| date.second == 0 }, { "full minute!".postln }); // do this every minute at seconds 25 and 35d.putDate(\min2, { |date| [25, 35].includes(date.second) }, { "twice a min".postln }); // once a day at a specific time [h, m, s] -d.putDate(\onceT, [12, 35, 40], { "once a day only!".postln } );d.stop;Class Methods
.all
a global dictionary where all DayTimers are stored.
.at
look up a DayTimer in DayTimer.all by name.
.top
A global instance of DayTimer provided for convenience.
.putDate
add an action at <id> to the top DayTimer dates.
Arguments:
| id |
a symbol for the action to add to it. |
| test |
a test whether to do the action at the current date/time. can be a function that looks at current date, or a list of [hour, minute, second] values. |
| func |
the action to do when the time is right (test is true) |
.removeAt
remove the action at <id> in the top DayTimer.
.start
start the top DayTimer.
.stop
stop the top DayTimer.
.new
store a new DayTimer or access an existing instance at the given name; optionally give it an id, a test whether the time of day is right, and the corresponding action.
Arguments:
| name |
a symbol for the DayTimer instance name. |
| id |
a symbol for the action to add to it. |
| test |
a test whether to do the action at the current date/time. can be a function that looks at current date, or a list of [hour, minute, second] values. |
| func |
the action to do when the time is right (test is true) |
Returns:
A new or existing DayTimer.
Instance Methods
.name
get the DayTimer name
Returns:
a Symbol
.dates
a dict of the named actions to do
.putDate
add an action at <id> to the DayTimer dates.
Arguments:
| id |
a symbol for the action to add to it. |
| test |
a test whether to do the action at the current date/time. can be a function that looks at current date, or a list of [hour, minute, second] values. |
| func |
the action to do when the time is right (test is true) |
.removeAt
remove an action from dates by id
Arguments:
| id |
.start
start the DayTimer.
.stop
stop the DayTimer.
.skip
internal - a SkipJack that runs when DayTimer is active.
.checkList
internal - checks which time tests for actions match the current time, and performs the actions if any.
Examples
xxxxxxxxxxd = DayTimer(\otto);d.name;d.skip; // the skipjack that does the watchingd.dates; // do this every full minute - id so you can remove it againd.putDate(\perMin, { |date| date.second == 0 }, { "full minute!".postln }); // do this every minute at seconds 25 and 35d.putDate(\min2, { |date| [25, 35].includes(date.second) }, { "twice a min".postln });d.dates;( // do this every third minuted.putDate(\min3, { |date| (date.minute * 60 + date.second) % 180 == 60 }, { "every 3 minutes".postln });)d.start; // once a day at a specific time [h, m, s] - // maybe set this to the next full minute for testingd.putDate(\onceT, [12, 35, 40], { "once a day only!".postln } ); // daytimer tests and posts when a function fails, // but continues watching.d.putDate(\failZ, { |d| [20, 40].includes(d.second) }, { 1.blork }); // remove a date, here the failing date/taskd.removeAt(\failZ);d.dates.postcs;d.stop;