From 2cfc5b9501a192170f5a300cc01589eb85099962 Mon Sep 17 00:00:00 2001 From: Arksine Date: Fri, 13 Nov 2020 06:53:20 -0500 Subject: [PATCH] docs: update metadata documentation Document the "gcode_start_byte" and "gcode_end_byte" fields. Signed-off-by: Eric Callahan --- docs/api_changes.md | 9 +++++++++ docs/web_api.md | 2 ++ 2 files changed, 11 insertions(+) diff --git a/docs/api_changes.md b/docs/api_changes.md index b5d343c..169083f 100644 --- a/docs/api_changes.md +++ b/docs/api_changes.md @@ -1,6 +1,15 @@ This document keeps a record of all changes to Moonraker's remote facing APIs. +### November 12th 2020 +- Two new fields have been added to the gcode metadata: + - `gcode_start_byte`: Indicates the byte position in the + file where the first "Gxx" or "Mxx" command is detected. + - `gcode_end_byte`: Indicates the byte position in the + file where the last "Gxx" or "Mxx" command is detected. + These fields may be used to more accurately predict print + progress based on the file size. + ### November 11th 2020 - The `server.websocket.id` API has been added. This returns a unique ID that Moonraker uses to track each client connection. diff --git a/docs/web_api.md b/docs/web_api.md index c0a767a..9990511 100644 --- a/docs/web_api.md +++ b/docs/web_api.md @@ -489,6 +489,8 @@ path relative to the specified "root". Note that if the query st object_height: , estimated_time: , filament_total: , + gcode_start_byte: , + gcode_end_byte: , thumbnails: [ { width: ,