3diy
/
moonraker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
1,839 Commits 1 Branch 0 Tags 4.2 MiB
Commit Graph

144 Commits

Author SHA1 Message Date
Eric Callahan 501af62018 docs: update /server/info and /machine/system_info docs 
These endpoints now return additional values.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2022-02-23 12:25:52 -05:00
th33xitus 8b8cb66481 readme: fix link for MainsailOS 
readme: replace `Meteyou` with `Mainsail-Crew`

docs: replace `meteyou` with `mainsail-crew` in web_api.md

Signed-off-by: Dominik Willner <th33xitus@gmail.com>
 2022-02-23 10:24:39 -05:00
Eric Callahan 9be93ff445 docs: add "info_tags" to update manager status 
This also fixes some stale documentation.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2022-02-13 11:32:32 -05:00
Eric Callahan dd6a06e9de docs: update proc_stats documentation 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2022-01-12 19:58:49 -05:00
Eric Callahan 59fd35827e docs: add button documentation 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2022-01-12 08:05:17 -05:00
Pedro Lamas 5f20dafadb docs: fixes minor typo 
Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
 2021-12-28 14:13:27 -05:00
Eric Callahan 3df0f3ffe4 job_queue: add websocket notification 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-11-27 10:23:04 -05:00
Eric Callahan 269897bef7 job_queue: rename "resume" api to "start" 
Given the changes to the job queue, "start" is a more
appropriate API call than "resume".

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-11-27 06:04:47 -05:00
Eric Callahan e9b3d8e7ae docs: update job_queue documentation 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-11-26 20:01:16 -05:00
Clifford Roche 44abc64533 machine: add serial number attribute for cpu 
Adds the property "serial_number" to the process info structure.

Signed-off-by:  Clifford Roche <clifford.roche@gmail.com>
 2021-11-22 14:00:34 -05:00
FrYakaTKoP 79b1c071ad docs: change repository links from meteyou to mainsail-crew 
Signed-off-by:  Christoph Frei <fryakatkop@gmail.com>
 2021-11-14 06:47:17 -05:00
Eric Callahan a9e865eb54 docs: update documenation with API and configuration changes 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-11-12 10:11:39 -05:00
Pedro Lamas 7ff126a56e docs: updates to new Fluidd repo address 
Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
 2021-11-07 07:00:12 -05:00
FrY Sennberg 780279d261 docs: fix typo 
Signed-off-by: Christoph Frei <fryakatkop@gmail.com>
 2021-11-04 08:40:14 -04:00
FrY Sennberg eec60a760b
git_deploy: report git repository name 
Signed-off-by: Christoph Frei <fryakatkop@gmail.com>
 2021-11-01 19:10:35 -04:00
Eric Callahan 9f89b03aa3 docs: update /server/info documentation 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-11-01 11:24:31 -04:00
Eric Callahan 504d87831d docs: document "root_info" filed reported by get_directory 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-10-30 17:06:14 -04:00
Eric Callahan 179e9428c5 docs: add 'virtualization' to the return value of system_info 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-10-28 11:45:13 -04:00
Eric Callahan 7890753d9f docs: update documentation to reflect api changes 
The file list and directory list endpoints now report file
permissions.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-10-27 12:02:06 -04:00
Eric Callahan f086f75c07 docs: Add documentation for new service and power features 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-10-24 12:46:56 -04:00
Eric Callahan c631bff0c9 docs: Document MQTT support for printer objects 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-10-08 15:33:11 -04:00
Eric Callahan 81b0c0a581 docs: minor API change reflecting new owner of Klipper repo 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-09-24 12:22:45 -04:00
Eric Callahan 2447ccab62 docs: update proc_stats documentation 
The "websocket_connections" is now reported by proc_stats.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-09-21 14:22:19 -04:00
Eric Callahan 83eddf5e7d docs: update /server/info documentation 
Note the addition of the "websocket_count" field.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-09-21 11:35:58 -04:00
Eric Callahan 628c7e2e4d docs: fix typos 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-09-04 05:38:03 -04:00
Eric Callahan 2f95b0f426 docs: add network reporting to proc_stats documetation 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-07-18 09:06:03 -04:00
Eric Callahan d60b852b27 docs: add documentation for latest changes to the update manager 
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
 2021-07-08 10:52:56 -04:00
Eric Callahan c7f8689bfe docs: fix incorrect documentation on eventtime 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-07-06 15:54:29 -04:00
Eric Callahan 12a7f957c3 docs: note addition of the "eventtime" param to "notify_status_update" 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-07-06 15:43:02 -04:00
Eric Callahan 188dc4c782 docs: add MQTT documentation 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-06-26 11:44:29 -04:00
Eric Callahan 1b2fa4924b docs: fix typo in metadata return value 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-06-15 15:25:40 -04:00
Eric Callahan 33cb18517a docs: update response to "/machine/system_info" 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-06-10 19:58:11 -04:00
Eric Callahan 0ab9ffdc93 docs: add machine API changes 
MoonCord and KlipperScreen have been added to supported services.  The "/machine/system_info" endpoint now returns a list of available services that moonraker may control.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-05-30 14:36:28 -04:00
Arksine e7ca2d6adc docs: add 'warnings' field to "/server/info" response 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-05-19 20:42:44 -04:00
Arksine 36aec50bce docs: update authorization documentation 
Document the "force_logins" option and the ability to accept JSON Web Tokens via the query string.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-05-19 19:59:06 -04:00
Arksine 5a2e2b1f3f docs: update return value for "/server/files/list" 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-05-18 19:12:54 -04:00
Arksine b2f8413057 docs: update documentation for changes to file_manager 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-05-18 19:12:54 -04:00
Arksine 158f92f17f docs: Update the delete user documentation 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-05-14 12:59:30 -04:00
Arksine 4a61bf21de docs: update "/access/users/list" documentation 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-05-13 18:01:18 -04:00
Arksine e472fb6c1e docs: update authorization documentation 
Add documentation for the "/access/users/list" endpoint.  Document the "notify_user_created" and "notify_user_deleted" websocket notifications.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-05-13 15:38:41 -04:00
Arksine d3c251bc52 docs: update power module documentation 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-05-10 08:42:08 -04:00
Arksine 40d4daa96b docs: update proc_stats API documentation 
Document the "cpu_temp" field in the "/machine/proc_stats" request along with the new "notify_proc_stat_update" websocket notification.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-05-03 08:59:19 -04:00
Arksine 275bcde081 docs: add documentation for `/machine/system_info` 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-04-26 12:08:52 -04:00
Stefan Dej 0791c658ad fix moonraker process stats link 
Signed-off-by: Stefan Dej <meteyou@gmail.com>
 2021-04-25 11:30:37 -04:00
Arksine 85be5cbfc1 docs: add "checksum" option to file upload documentation 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-04-20 18:12:30 -04:00
Arksine f4ebb93546 docs: update documentation for the Authorization component 
USER_CHANGE:  The "enable" and "api_key_file" options in the [authorizaton] section are now deprecated.  A new API Key will be generated.  Use the "fetch-apikey.sh" script to retrieve the new key.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-04-19 20:46:17 -04:00
Arksine 4d1a2668f5 docs: add notes about sending M112 gcodes 
Also  document the new "full_version_string" field reported by the update_manager.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-04-09 14:59:39 -04:00
Kamil Trzciński 6cc11276c8 Extend history API with reverse order 
Signed-off-by: Kamil Trzciński <ayufan@ayufan.eu>
 2021-04-05 11:41:14 -04:00
Arksine 210f505157 docs: document changes to the update_manager 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-03-29 14:05:24 -04:00
Arksine eec85f86a9 docs: add /server/history/totals to documentation 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-03-22 16:51:50 -04:00
Arksine 8acd0f2728 docs: remove references to plugins and create components.md 
Replace various notes with admonitions.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-03-18 17:16:36 -04:00
Arksine d9d087b9f3 docs: add "print_start_time" and "job_id" to the metadata documentation 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-03-16 20:04:25 -04:00
Arksine dc60143ef8 docs: prepare documentation for readthedocs 
This commit adds mkdocs.yml and modifies the existing markdown documentation so that  "readthedocs" can build documentation using "mkdocs".

Included are many formatting changes and fixes to the existing documentation so that it shows up correctly when published.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-03-16 06:34:17 -04:00
Arksine 7e230c1c77 docs: update API documenation to reflect recent changes 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-03-15 07:03:01 -04:00
Arksine 978fcffab5 docs: fix API documentation for [octoprint_compat] 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-03-13 08:13:50 -05:00
Arksine 083d63568c docs: update history api documentation 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-03-13 08:12:39 -05:00
jordanruthe 9988da72c1
history: print history tracking 
Signed-off-by: Jordan Ruthe <jordan.ruthe@gmail.com>
 2021-03-11 20:09:25 -05:00
th33xitus a111733431 docs: fix incorrect wording. 'mainsail' should correctly read 'moonraker' 
Signed-off-by:  Dominik Willner <th33xitus@gmail.com>
 2021-03-05 05:17:00 -05:00
Grigi 6ba45f6e35 docs: Document simulated Octoprint API 
Signed-off-by:  Nickolas Grigoriadis <nagrigoriadis@gmail.com>
 2021-03-04 20:52:55 -05:00
Arksine 46680f4cda docs: add documentation for new machine APIs 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-03-04 08:52:49 -05:00
Arksine d1dfa86081 docs: fix typos in last web_api update 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-03-01 15:53:35 -05:00
Arksine dbf5f93919 docs: add more detail to the API overview in web_api.md 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-03-01 15:49:52 -05:00
Arksine 94b690c2e9 docs: add database documentation 
Also add documentation for query string type hints.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-02-27 17:29:09 -05:00
Arksine eb37ce767d docs: add documentation for "/server/config" endpoint 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-02-16 11:43:31 -05:00
Arksine 81104a6618 docs: update documentation for latest changes 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com
 2021-01-31 07:41:16 -05:00
Arksine 578ce740c5 docs: update API documentation for changes to update_manager 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-01-22 17:18:28 -05:00
Arksine 67adcfc448 docs: note update_manager API changes 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-01-04 08:51:41 -05:00
Arksine 4aa2a86e3b docs: Document "notify_klippy_shutdown" 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-01-01 11:51:52 -05:00
Arksine 77c483ea0f docs: document changes to the update_manager plugin 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-12-31 08:25:59 -05:00
Arksine 653c9190c4 docs: document "complete" field for "notifiy_update_response" 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-12-17 17:58:04 -05:00
Arksine 6403eaa0db docs: document "update_manager" plugin 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-11-28 07:22:09 -05:00
Arksine f96fb997da docs: document API for retreiving Klipper "docs" 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-11-23 06:22:45 -05:00
Arksine 01a48e530f docs: update documentation for changes to "power" plugin 
The power APIs were never properly documented, so this adds them to web_api.md.  In addition, a new "user_changes.md" document has been added to help users transition to the new plugin.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-11-19 15:43:24 -05:00
Arksine 2cfc5b9501 docs: update metadata documentation 
Document the "gcode_start_byte" and "gcode_end_byte" fields.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-11-13 06:53:20 -05:00
Arksine a1de70ff89 docs: document "notify_klippy_ready" websocket notfication 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-11-11 17:59:08 -05:00
Arksine 4b2f3a6f5f docs: update API documentation 
Document the new server.websocket.id method and update the documentation for the subscription APIs.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-11-11 11:58:28 -05:00
Arksine 73cbcb7b7e docs: document "extended" argument for GET directory endpoint 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-11-02 20:18:07 -05:00
Arksine 9394bf592c docs: Add documentation for Klipper Printer Objects 
This documents the most useful printer objects available for query, providing the fields that a query returns and what the represent.

Also add a basic  "print state monitoring" example and  "bed_mesh" example to web_api.md.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-10-26 21:25:20 -04:00
Arksine 413062f8e8 docs: Update API documentation 
The "modified" field returned by all file manager endpoints and notifications now refers to unix time (in seconds).

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-10-25 19:50:24 -04:00
Arksine 2d77400a65 docs: update for latest API additions and changes 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-10-21 15:42:03 -04:00
Arksine ac648cefcf docs: Add new endpints to API documention 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-09-30 18:03:25 -04:00
Arksine 733cf0afac docs: Update metadata API documentation 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-09-09 11:32:37 -04:00
Arksine 97cb072981 docs: Add documentation for "delete_file" websocket API. 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-09-07 12:51:39 -04:00
Arksine c122bd68e0 docs: document API changes 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-09-03 15:26:46 -04:00
Arksine d59d1e5f7f docs: document new "notify_metadata_update" notification 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-09-01 11:37:06 -04:00
Arksine 88bbd66a3b docs: document latest API changes 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-08-16 19:58:15 -04:00
Arksine a3c0f06c5f docs: Update API documentation 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-08-16 18:08:41 -04:00
Arksine de1a79a7ca docs: update API documentation regarding file list notification 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-08-11 14:21:28 -04:00
Arksine 65d82a3fe8 docs: update config file APIs 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-08-05 11:17:17 -04:00
Arksine 0d29d0f811 docs: Add documentation for new file_management changes 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-08-01 06:05:19 -04:00
Arksine 29e7df38d0 file_manager: Add move and copy APIs 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-07-14 07:00:52 -04:00
Arksine 00d36a5a06 docs: fix incorrect method name for retreiving metadata 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-07-12 17:28:55 -04:00
Arksine 0e79b6f3f7 file_manager: add JSON-RPC "directory" APIs 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-07-04 14:33:17 -04:00
Arksine d1c740b900 moonraker: add initial source 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-07-02 12:24:15 -04:00