Skip to content

Commit

Permalink
Documentation upgrade for runtime and min-max lapsing
Browse files Browse the repository at this point in the history
  • Loading branch information
aka13_404 committed Nov 26, 2021
1 parent 4cea3be commit dac0240
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 7 deletions.
13 changes: 10 additions & 3 deletions docs/config_sample.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ chat_id: xxxxxxxxx
# Values avaliable: slicer, file
# Default value is slicer.
#sensors: mcu, ..., ...
# You can add temperature sensors, like the "mcu"sensor to be displayed in the status message.
# You can add temperature sensors, like the "mcu" sensor to be displayed in the status message.
# Simply enter the names from your klipper config, separated by commas.
# Default is not to display any additional temperature sensors.
#heaters: extruder, heater_bed
Expand Down Expand Up @@ -98,6 +98,7 @@ host: http://localhost:8080/?action=stream
## [progress_notification]

This section is responsible for the notification on printing progress updates. This entire section is optional.
You can override these parameters with [runtime settings](interacting_with_klipper.md#Runtime lapse and notification setting)

```
#[progress_notification]
Expand Down Expand Up @@ -127,6 +128,7 @@ This section is responsible for the notification on printing progress updates. T
## [timelapse]

This section is responsible for timelapse creation as well as file location for timelapse processing. This entire section is optional.
You can override these parameters with [runtime settings](interacting_with_klipper.md#Runtime lapse and notification setting)

```
[timelapse]
Expand All @@ -151,9 +153,14 @@ This section is responsible for timelapse creation as well as file location for
# This is the target fps of the created video. The larger this number, the "faster" the timelapse will be.
# 15 fps equals 15 images per second lapsing. The default is 15 fps.
#min_lapse_duration: 5
# Default is 0 seconds - unlimited
# On short prints, or with limited lapse pictures available, the lapse often gets to short to meaningfully display
# the printing progress. You can specify the desired minimum duration of the created timelapse
# (not including last_frame_duration). This means, that the fps will get reduced, if the lapse is shorter than this time.
# The default is to omit this.
#max_lapse_duration: 5
# Default is 0 seconds - unlimited
# Similar to min_lapse_duration, if your lapse video gets too long to watch, you can specify a desired time, which
# should not be exceeded. This means, that the fps will get increased, if the lapse is going to be longer than this time.
# The default is to omit this.
#last_frame_duration: 5
# This allows you to prevent the timelapse video from ending too abruptly. You can choose a duration for which
# to loop the last picture taken.
Expand Down
12 changes: 8 additions & 4 deletions docs/interacting_with_klipper.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,13 @@ An example command, to be sent from gcode or from a macro would be `RESPOND PREF
- `tgalarm_photo` Captures a picture, sends a message with an alert. You get a "red" notification with sound or vibration.
Works exactly the same as the simple alarm command, but also takes a photo from the camera. It respects all the settings from the ```[camera]``` config section.

## Runtime params
timelapse params
## Runtime lapse and notification setting
If you want to run specific notifications and lapse settings based on criteria from the slicer, you can issue the following command to the bot:

Parameters for the timelapse give you the option to control settings similarly to the [[timelapse]](config_sample.md#timelapse) config section:
`RESPOND PREFIX=set_timelapse_params MSG="enabled=[1|0] manual_mode=[1|0] height=0.22 time=18 target_fps=20 min_lapse_duration=5 max_lapse_duration=15 last_frame_duration=10"`

notification params
`RESPOND PREFIX=set_notify_params MSG="percent=5 height=0.24 time=65"`
Parameters for the notifications give you the option to control settings similarly to the [[progress_notification]](config_sample.md#progress_notification) config section:
`RESPOND PREFIX=set_notify_params MSG="percent=5 height=0.24 time=65"`

This run-time setting behaves similarly to klipper - the requested parameters remain consistent until the next restart of the bot.

0 comments on commit dac0240

Please sign in to comment.