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
829b3a4ee8
docs: document log path for the file manager
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-05-19 08:26:30 -04:00
94e1dcf2cb
docs: update contributing doc
...
Update the code style guidelines informing contributors that they should validate their code with pycodestyle and mypy before submission.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-05-19 08:19:21 -04:00
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
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
158f92f17f
docs: Update the delete user documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-05-14 12:59:30 -04:00
4a61bf21de
docs: update "/access/users/list" documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-05-13 18:01:18 -04:00
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
d3c251bc52
docs: update power module documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-05-10 08:42:08 -04:00
c53b95aa93
power: Add Home Assistant switch support
...
* power: Add Home Assistant switch support
Signed-off-by: Sébastien Jousse <s.jousse@gmail.com>
2021-05-05 07:14:25 -04:00
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
5321a8a558
docs: update authorization documentation
...
The "trusted_clients" option now supports fqdns (full qualified domain names).
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-04-29 19:40:06 -04:00
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
0791c658ad
fix moonraker process stats link
...
Signed-off-by: Stefan Dej <meteyou@gmail.com>
2021-04-25 11:30:37 -04:00
46dea00b2f
docs: Document "Kasa Power Strip" configuration
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-04-20 19:59:59 -04:00
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
d42fd3b095
docs: fix accidental removal of `trusted_clients` option
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-04-20 18:12:30 -04:00
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
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
b111e3d6c7
power.py add parameter timer
...
Add a timer parameter to shelly and tasmota integration.
Use case: 3D printer mains power is connected to one of these devices. Just turning off the smart switch will just kill power to the RaspberryPI. Adding a timer will allow the PI to shutdown cleanly before killing the power
Signed-off-by: Dominik Weis fsironman@gmail.com
2021-04-06 17:58:51 -04:00
6cc11276c8
Extend history API with reverse order
...
Signed-off-by: Kamil Trzciński <ayufan@ayufan.eu>
2021-04-05 11:41:14 -04:00
5db596f0a5
docs: Add database debugging option to configuration.md
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-04-02 11:58:43 -04:00
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
f0a6620267
docs: fix incorrect reference to ConfigWrapper in components.md
...
The correct object name is ConfigHelper.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-22 16:54:34 -04:00
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
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
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
94ed9fbd7f
docs: add documentation for the update_manager's primary_branch option
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-16 14:26:45 -04:00
e990e64ccd
docs: Add .readthedocs.yaml
...
Use Python 3.8 and pin the version of mkdocs.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-16 08:38:53 -04:00
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
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
a04958b1bf
power: Add HomeSeer control
...
Signed-off-by: Mark Dietzer <git@doridian.net>
2021-03-15 06:00:17 -04:00
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
083d63568c
docs: update history api documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-13 08:12:39 -05:00
9988da72c1
history: print history tracking
...
Signed-off-by: Jordan Ruthe <jordan.ruthe@gmail.com>
2021-03-11 20:09:25 -05:00
92de4b75ee
docs: Update documentation for changes to cors_domains option
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-10 19:42:39 -05:00
606625a3aa
docs: Update documentation with logging changes
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-06 07:56:21 -05:00
316fac1e75
docs: update default for max_upload_size
...
We now default 1024 MiB.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-05 12:59:42 -05:00
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
84f663e2bc
docs: update user_changes with octoprint_compat requirement
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-04 20:59:27 -05:00
6ba45f6e35
docs: Document simulated Octoprint API
...
Signed-off-by: Nickolas Grigoriadis <nagrigoriadis@gmail.com>
2021-03-04 20:52:55 -05:00
228ed34eb1
docs: add git_repo path example
...
Signed-off-by: Eugene Rush <rush.zlo@gmail.com>
2021-03-04 20:43:05 -05:00
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
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
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
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
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
baf97f8ea4
docs: document new "data_store" options.
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-02-14 17:50:45 -05:00
0fcae5b6e4
power: add Shelly device support
...
Signed-off-by: Alex Zellner <alexander.zellner@googlemali.com>
2021-02-07 07:31:04 -05:00
81104a6618
docs: update documentation for latest changes
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com
2021-01-31 07:41:16 -05:00
e8776a5d85
docs: fix incorrect wording for 'klipper_restart_when_powered'
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-01-27 07:12:19 -05:00
9c385ce067
docs: document 'restart_klipper_when_powered' option
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-01-27 06:58:27 -05:00
aa9bf0fb9c
docs: document the `enable_auto_refresh` option
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-01-26 18:05:06 -05:00
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
c17d86aa09
docs: update configuration to reflect multiple update clients
...
Signed-off-by: Jordan Ruthe <jordan.ruthe@gmail.com>
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-01-22 17:18:28 -05:00
b4602115d7
power: add "locked_while_printing" option to avoid accidental shutdown
...
Signed-off-by: Jordan Ruthe <jordan.ruthe@gmail.com>
2021-01-22 11:00:31 -05:00
67adcfc448
docs: note update_manager API changes
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-01-04 08:51:41 -05:00
2bb9128b5b
docs: document the "off_when_shutdown" option for the power plugin
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-01-02 19:53:41 -05:00
4aa2a86e3b
docs: Document "notify_klippy_shutdown"
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-01-01 11:51:52 -05:00
f753263c60
docs: document the "-n" command line option
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-01-01 11:47:03 -05:00
933622adda
docs: Note changes to the file manager path restrictions
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-12-31 20:23:48 -05:00
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
586bb6a7ca
docs: document "initial_state" option for the power plugin
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-12-25 19:31:57 -05:00
9a309ffd59
file_manager: allow directories in "/etc/moonraker" to be registered
...
This may be useful for system packaging options that do not wish to put configuration in the home directory.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-12-20 08:37:45 -05:00
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
1b997b7457
docs: Note changes to install script
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-12-06 07:05:21 -05:00
aba5bdf339
docs: add clarification
...
This clarifies the installation and configuration instructions, updating some outdated info. Also added is a sample moonraker.conf file.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-12-05 19:19:13 -05:00
43e2893e01
docs: Note supported version of PanelDue Firmware
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-12-02 07:46:26 -05:00
6403eaa0db
docs: document "update_manager" plugin
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-11-28 07:22:09 -05:00
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
93fd850b63
Added Tasmota SetOption26 to power/Tasmota setup description
...
Signed-off-by: Matthias Neumayr <matt.neumayr@gmail.com>
2020-11-21 13:59:29 -05:00
4415a3c858
Updated documentation with Tasmota power configuration settings and sample
...
Signed-off-by: Matthias Neumayr <matt.neumayr@gmail.com>
2020-11-21 13:59:29 -05:00
8d3e185894
docs: fix typo in user_changes.md
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-11-20 14:36:13 -05:00
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
d18fc889d5
docs: update installation.md with install script's command line options
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-11-17 15:39:13 -05:00
7414781b3a
docs: update config documentation
...
The `enable_cors` option has been removed from the [server] config. CORS is now configured in [authorization] via the `cors_domains` option.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-11-13 08:57:10 -05:00
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
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
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
e5f3aeca78
docs: document remote method calls
...
This updates the "PANELDUE_BEEP" gcode macro to use the "paneldue_beep" remote method. Also included is documentation on the "set_device_power" method added to the power plugin.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-11-07 20:34:56 -05:00
5ff87aa24e
docs: Add home assistant example
...
Example provided courtesy of Github User Kruppes.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-11-06 07:00:01 -05:00
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
d582d76346
docs: Add clarification to printer object description
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-10-26 21:29:53 -04:00
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
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
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
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
a578199dab
docs: fix incorrect option for API Key file location
...
Resolves #22 .
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-09-28 06:53:45 -04:00
d1c0cdf65b
docs: Fix incorrect option for klippy_uds_address
...
Resolves #20 .
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-09-16 11:27:20 -04:00
36fb1da46d
docs: add missing documentation
...
- Document "enable_cors". Resolves #18 .
- Add a note that Moonraker is not aware of the gcode file path until Klippy successfully starts. Resolves #16 .
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-09-12 07:48:54 -04:00
8b08b03fbf
app: add max_upload_size configuration option
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-09-11 06:27:48 -04:00
733cf0afac
docs: Update metadata API documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-09-09 11:32:37 -04:00
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
c122bd68e0
docs: document API changes
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-09-03 15:26:46 -04:00
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
55919fc7d3
docs: update the PANELDUE_BEEP macro documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-08-18 08:59:32 -04:00
88bbd66a3b
docs: document latest API changes
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-08-16 19:58:15 -04:00
a3c0f06c5f
docs: Update API documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-08-16 18:08:41 -04:00
e9cd86f468
docs: add "confirmed_macros" option to paneldue documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-08-12 17:53:17 -04:00
d04a419a80
docs: Update documentation for 0.1 release
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-08-11 21:27:41 -04:00
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
65d82a3fe8
docs: update config file APIs
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-08-05 11:17:17 -04:00
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
92d7d7c2b7
power: restrict lines to 80 chars, remove trailing whitespace
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-07-29 17:46:27 -04:00
31bebdd59c
docs: update installation documentation
...
Note that trusted clients may now include both IPv4 and IPv6 ranges.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-07-28 11:31:06 -04:00
b4b1356bdd
docs: Add contributing guidelines
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-07-27 18:28:06 -04:00
f34b76ae73
moonraker: Verify python executable version
...
Moonraker requires Python 3.7 or greater.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-07-27 14:56:23 -04:00
c589287e0b
power: printer power on/off control plugin
...
Sign-off-by: Jordan Ruthe <jordanruthe@gmail.com>
2020-07-27 14:08:48 -04:00
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
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
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
43c8affadf
docs: fix typos in install.md
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-07-04 11:37:42 -04:00
d1c740b900
moonraker: add initial source
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-07-02 12:24:15 -04:00
Arksine