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