diff --git a/README.md b/README.md index 487d1c9..4346273 100644 --- a/README.md +++ b/README.md @@ -21,4 +21,4 @@ Users:\ [user_changes.md](/docs/user_changes.md) - December 31st 2020 Developers:\ -[api_changes.md](/docs/api_changes.md) - January 22nd 2021 +[api_changes.md](/docs/api_changes.md) - January 31st 2021 diff --git a/docs/api_changes.md b/docs/api_changes.md index bcc751a..6119c31 100644 --- a/docs/api_changes.md +++ b/docs/api_changes.md @@ -1,5 +1,12 @@ This document keeps a record of all changes to Moonraker's web APIs. +### January 31st 2021 +- The `GET /server/temperature_store` endpoint now only returns fields + that each sensor reports. For example, if a particuarly temperature + sensor does not report "target" or "power", then the corresponding + fields will not be reported for that sensor in response to the + `temperature_store` request. + ### January 22nd 2021 - The `POST /machine/update/client` endpoint now requires a `name` argument. This change added multiple client support diff --git a/docs/configuration.md b/docs/configuration.md index 2a81b46..7b7b3f2 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -302,6 +302,10 @@ repo: # meteyou/mainsail to update Mainsail. This parameter must be provided. path: # The path to the client's files on disk. This parameter must be provided. +persistent_files: +# A list of newline separated file names that should persist between +# updates. This is useful for static configuration files, or perhaps +# themes. The default is no persistent files. ``` This second example is for git repositories that have a service that need diff --git a/docs/web_api.md b/docs/web_api.md index d753030..95c314c 100644 --- a/docs/web_api.md +++ b/docs/web_api.md @@ -240,6 +240,23 @@ websocket. See the `notify_status_update` notification for details. 1 second by default, containing a total of 1200 values (20 minutes). The array is organized from oldest temperature to most recent (left to right). Note that when the host starts each array is initialized to 0s. + ```json + { + extruder: { + temperatures: [], + targets: [], + powers: [] + }, + temperature_fan my_fan: { + temperatures: [], + targets: [], + speeds: [], + }, + temperature_sensor my_sensor: { + temperatures: [] + } + } + ``` ### Fetch stored gcode info - HTTP command:\ @@ -267,7 +284,8 @@ websocket. See the `notify_status_update` notification for details. gcode_store: [ { message: , - time: unix_time_stamp + time: unix_time_stamp, + type: }, ... ] } @@ -282,6 +300,7 @@ for (let resp of result.gcode_store) { // Do something with date and resp.message ... } ``` +The `type` field will either be "command" or "response". ### Restart Server - HTTP command:\