Schedule v3.0

The Schedule block sends an output feed at a given time in the future. The time is specified by any combination of weekday, month, year, hour, minute and seconds. Any of the parameters may take a negative value, which means any value is allowed. Multiple timers may be started in a single block, each one having a different timer id. This timer id is supplied in the output feed when the timer fires, so may be used to determine what to do upon the timer firing.

Parameters

Parameter | Description |

timer id | A string that distinguishes this timer from other timers in this block. An empty string is valid. |

month | The month of the year (1-12) or negative for any month of the year. |

day | The day of the month (1-31) or negative for any day of the month. |

hour | The hour of the day (0-23) or negative for any hour of the day. |

minute | The minutes past the hour (0-59) or negative for any minute. |

second | The seconds past the minute (0-59) or negative for any second. |

Operations

Operation | Description |

start | Starts the specified timer ID. |

cancel | Cancels the specified timer ID. |

retrieve | Retrieve the details of the specified timer id by setting the output feed accordingly. |

Input feeds

This block has no input feeds.

Output feeds

Feed | Fields | Description |

timer | timer id | A string that distinguishes this timer from other timers in this block. An empty string is valid. |

month | The month (1-12). | |

day | The day of month (1-31). | |

hour | The hour (0-23). | |

minute | The minute (0-59). | |

seconds | The seconds (0-59). | |

time up | true if time is up, false otherwise (i.e. on retrieval). | |

book | num timers | The number of currently active timers known to this block. |

Examples

The following tables list the values for parameters that will trigger at the times described.

Example 1 - triggered once a month, on the first of every month, at 03:00:00:

Parameter | Value |

month | -1 |

day | 1 |

hour | 3 |

minute | 0 |

seconds | 0 |

Example 2 - triggered every hour, at 15 minutes past the hour:

Parameter | Value |

month | -1 |

day | -1 |

hour | -1 |

minute | 15 |

seconds | 0 |

Note that the time and date information is simply a copy of the parameters used when starting the timer. Any field whose corresponding parameter was given a negative value will have that same value.

Example 3 - triggered every second:

Parameter | Value |

month | -1 |

day | -1 |

hour | -1 |

minute | -1 |

seconds | -1 |

Example 4 - triggered every day at noon:

Parameter | Value |

month | -1 |

day | -1 |

hour | 12 |

minute | 0 |

seconds | 0 |

Example 5 - triggered once a year, at exactly 16:31:28 on 31st May:

Parameter | Value |

month | 5 |

day | 31 |

hour | 16 |

minute | 31 |

seconds | 28 |