Skip to content

Plan Control

Enabling and Disabling Plans

Manually add off: true to disable. Removing off or setting it to off: false enables the plan.

  off: true

Auto Enable and Disable Plans

Auto-enable a plan:

If the condition is met, change off to false — the plan is enabled and immediately evaluated for triggering, rather than waiting for the next evaluation cycle.

  start_if: one_tag_example

Auto-disable a plan:

  stop_if: one_tag_example

start_if and stop_if are followed by tags or calendar-mode content. For example:

Enable the task after September 3rd:

  off: true
  start_if: 9-3

Enable on the 1st and 5th, disable on the 3rd and 7th:

  off: true
  start_if: [1, 5]
  stop_if: [3, 7]

Plan Sleep for N Times

When a task is triggered, ignore the trigger.

The following sleeps 3 times — the first 3 triggers fire but do nothing. The 4th trigger resumes normal execution.

  sleep: 3

Note: if the plan is already disabled (off: true), it cannot trigger and therefore cannot sleep. This differs from simply disabling a plan.

Auto-Delete Plans

Auto-delete after being triggered a certain number of times:

  max_count: 3  # max_count only accepts a number

Auto-delete after a condition is met — the plan will still output its content if triggered this time:

  del_if: one_tag_example