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
Arksine