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
5c05afae42
docs: Update mkdocs version
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-06-28 20:27:40 -04:00
Eric Callahan
77052e15b0
docs: update MQTT documentation
...
Reflect the new behavior of wait_connection()
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-06-28 20:27:40 -04:00
Eric Callahan
c22dcc18dc
docs: Remove unreferenced macro
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-06-26 20:12:10 -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
9e909e8532
docs: add "cancelled" state to print_stats documentation
...
Refactor the available values so that they are more readable.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-06-16 15:50:04 -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
Rafael Schridi
3b4bfba85e
Add variable domain support for Home Assistant
...
Defaults to the hard-coded "switch" domain used before
Signed-off-by: Rafael Schridi <r.schridi@gmail.com>
2021-06-13 18:17:08 -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
5db74b724e
docs: document https configuration options
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-05-21 20:00:41 -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
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
Arksine
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
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
Sébastien Jousse
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
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
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
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
46dea00b2f
docs: Document "Kasa Power Strip" configuration
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-04-20 19:59:59 -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
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
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
fsironman
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
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
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
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
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
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
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
Arksine
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
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
Mark Dietzer
a04958b1bf
power: Add HomeSeer control
...
Signed-off-by: Mark Dietzer <git@doridian.net>
2021-03-15 06:00:17 -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
Arksine
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
Arksine
606625a3aa
docs: Update documentation with logging changes
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-06 07:56:21 -05:00