Restore - Version 2.0.0#

Module Summary#

Saves current scene and timeline states to disk for restoration later.

Important note#

This module writes to the controllers flash disk.
Flash disks have a limited write count, and useable lifespan could be reduced by this module.
For advice further please contact our support team.

Module Status#

This IO Module is stable and has been tested internally.

If you encounter any issues with this module, or have any feedback regarding its operation, please contact our support team.

Release Notes#

Version 2.0#

  •  Initial release.

Minor point releases (eg. 1.1.x) will be for small fixes and may not be listed here.

Operation#

Module Properties#

Unchecking Restore on clean startup will clear the saved states from disk on expected reloads (reboot, project upload, et cetera). Allowing the module to only restore on unexpected reloads (watchdog, power loss, et cetera).
If Restore on clean startup is ticked, then saved states are available for restoration at any point.

Instance Properties#

Checking Limit to single timeline per group or Limit to single scene per group will limit state saves to a single timeline or scene per group.
e.g. If Timeline 1 and 2 are in group “A”: Timeline 1 is started and then Timeline 2; only the state of Timeline 2 will be saved.
Ungrouped timelines and scenes will not be limited.

Status Variables#

The IO Modules tab of the web interface provides status variables to shows information about the module and monitor its state.

Saved states Contents of currently saved restoration file

Actions#

Clear saved Scene States#

Clear this currently saved scene states from disk. If Restore on clean startup is unticked, this operation happens automatically before a planned reboot or project upload.

Restore Scene States#

Restore the state of any saved scene states.

Save Scene State#

Save the Scene state to disk.

Properties:

  •  Scene: Scene number.

Clear saved Timeline States#

Clear this currently saved timelines states from disk. If Restore on clean startup is unticked, this operation happens automatically before a planned reboot or project upload.

Restore Timeline States#

Restore the state of any saved timeline states.

Save Timeline State#

Save the Timeline state to disk.

Properties:

  •  Timeline: Timeline number.

Support#

If you encounter any issues with this module, please contact our support team.