Timelapse

Contents

• Timelapse

  • Retrieve a list of timelapses and the current config

  • Delete a timelapse

  • Issue a command for an unrendered timelapse

  • Delete an unrendered timelapse

  • Change current timelapse config

  • Data model

    • Timelapse list

    • Rendered timelapse

    • Unrendered timelapse

    • Timelapse configuration

      • Z-change-triggered timelapse

      • Time triggered timelapse

Retrieve a list of timelapses and the current config

GET /api/timelapse

Retrieves a list of timelapses and the current config.

Returns a timelapse list in the response body.

Requires the TIMELAPSE_LIST permission.

Parameters

• unrendered – If provided and true, also include unrendered timelapses

Delete a timelapse

DELETE /api/timelapse/(string: filename)

Delete the timelapse filename.

Requires the TIMELAPSE_DELETE permission.

Issue a command for an unrendered timelapse

POST /api/timelapse/unrendered/(string: name)

Current only supports to render the unrendered timelapse name via the render command.

Requires the TIMELAPSE_ADMIN permission.

JSON Parameters

• command – The command to issue, currently only render is supported

Delete an unrendered timelapse

DELETE /api/timelapse/unrendered/(string: name)

Delete the unrendered timelapse name.

Requires the TIMELAPSE_DELETE permission.

Change current timelapse config

POST /api/timelapse

Save a new timelapse configuration to use for the next print.

The configuration is expected as the request body.

Requires the TIMELAPSE_ADMIN permission.

Data model

Timelapse list

Name	Multiplicity	Type	Description
config	1	Timelapse config	Current timelapse configuration
files	0..*	List of rendered timelapses	List of rendered timelapse entries
unrendered	0..*	List of unrendered timelapses	List of unrendered timelapse entries, only present if requested

Rendered timelapse

Name	Multiplicity	Type	Description
name	1	string	Name of the timelapse file
size	1	string	Formatted size of the timelapse file
bytes	1	int	Size of the timelapse file in bytes
date	1	string	Formatted timestamp of the timelapse creation date
url	1	string	URL for downloading the timelapse

Unrendered timelapse

Name	Multiplicity	Type	Description
name	1	string	Name of the unrendered timelapse job
size	1	string	Formatted size of all files in the unrendered timelapse job
bytes	1	int	Size of all files in the unrendered timelapse job in bytes
date	1	string	Formatted timestamp of the timelapse job creation date
recording	1	bool	Whether the timelapse is still being recorded (true) or not (false)
rendering	1	bool	Whether the timelapse is still being rendered (true) or not (false)
processing	1	bool	Whether the timelapse is either still being recorded or rendered (true) or not (false)

Timelapse configuration

Name	Multiplicity	Type	Description
type	1	string	Type of the timelapse, either off, zchange or timed.

Further fields are timelapse type specific, see below for details.

Z-change-triggered timelapse

For timelapse type zchange.

Name	Multiplicity	Type	Description
postRoll	1	int	Configured post roll in seconds
fps	1	int	Frames per second to use for rendered video
retractionZHop	1	float	Size of retraction Z hop to detect and ignore for z-based snapshots
minDelay	1	int	Snapshots will be rate limited against this interval, to prevent performance issues with vase mode/continuous z prints

Time triggered timelapse

For timelapse type timed.

Name	Multiplicity	Type	Description
postRoll	1	int	Configured post roll in seconds
fps	1	int	Frames per second to use for rendered video
interval	1	int	Seconds between individual shots