From 9e909e8532cf4c687433a1e366f14844727d1486 Mon Sep 17 00:00:00 2001 From: Eric Callahan Date: Wed, 16 Jun 2021 15:50:04 -0400 Subject: [PATCH] docs: add "cancelled" state to print_stats documentation Refactor the available values so that they are more readable. Signed-off-by: Eric Callahan --- docs/printer_objects.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/printer_objects.md b/docs/printer_objects.md index 044e11a..67239f2 100644 --- a/docs/printer_objects.md +++ b/docs/printer_objects.md @@ -251,8 +251,13 @@ The `print_stats` object reports `virtual_sdcard` print state: equivalent to `total_duration` - time paused. - `filament_used`: The amount of filament used during the current print (in mm). Any extrusion during a pause is excluded. -- `state`: Current print state. Can be "standby", "printing", "paused", - "complete", or "error". If an error is detected the print will abort. +- `state`: Current print state. Can be one of the following values: + - `"standby"` + - `"printing"` + - `"paused"` + - `"complete"` + - `"cancelled"` + - `"error"` - Note that if an error is detected the print will abort - `message`: If an error is detected, this field contains the error message generated. Otherwise it will be a null string.