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

355 Commits

Author SHA1 Message Date
Eric Callahan ab09364a98
docs: provide additional context for the secrets module 
Advise users to use unique credentials, and warn them that unattended
clients can be configured to steal credentials.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2022-02-26 10:48:51 -05:00
Eric Callahan 2bc43ec3df
docs: warn users about overlapping folders 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2022-02-26 10:48:51 -05:00
Eric Callahan ed20223614
docs: update database config documentation 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2022-02-25 14:05:26 -05:00
Eric Callahan 0a2c1904c0
docs: fix typo in [secrets] json example 
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
 2022-02-24 17:05:09 -05:00
pataar 71de8def8e notifier: create the new notifier module 
This component will be a bridge between moonraker and https://github.com/caronc/apprise. This way users can easily add all kind of notification services to their printer.

Signed-off-by: Pieter Willekens <me@pataar.nl>
 2022-02-23 17:05:55 -05:00
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 8ff54e2372 docs: update documenation for "power on queued" changes 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2022-02-23 09:13:54 -05:00
Lars Pöpperl 34f607c061
docs: add alternative sample file for home assistant 
Signed-off-by: Lars Pöpperl  <lars.poepperl@gmail.com>
 2022-02-17 11:03:30 -05:00
Simon Germain 11f4ae75cc
octoprint_compat: add webcam settings 
Signed-off-by: Simon Germain <sgermain06@gmail.com>
 2022-02-17 10:46:05 -05:00
Eric Callahan 0e27a949af docs: update power documentation for "smartthings" devices 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2022-02-14 06:26:34 -05:00
Mitch Gallman 0dc05eac76 docs: add smartthings power documentation 
docs: add smartthings power documentation

Signed-off-by: Mitch Gallman <mitchell.gallman@gmail.com>
 2022-02-14 06:12:52 -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 92eda982ce docs: clarify contributing documentation 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2022-02-10 16:53:11 -05:00
pznamenskii 6749d3836e
docs: add Home Assistant camera example 
Signed-off-by: Pavel Znamenskiy <[pznamenskii@gmail.com](mailto:pznamenskii@gmail.com)>
 2022-02-03 19:17:11 -05:00
Eric Callahan 305e002f8c docs: update docs for "klipper_device" power types 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2022-02-03 08:38:44 -05:00
Matthew Humphrey aca7cb78b9 module: power 
Add separate output_id configuration attribute for TPLink Smartplug device.

Signed-off-by:  Matthew Humphrey <mhumphrey@gmail.com>
 2022-02-02 17:35:18 -05:00
Eric Callahan f616c83ebc docs: clarify PackageKit documentation 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2022-01-30 14:12:03 -05:00
Pedro Lamas 287982acdd
power: initial support for Klipper Devices 
Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
 2022-01-29 07:53:30 -05:00
Eric Callahan 14f1b6f936 docs: update documentation for dbus additions 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com
 2022-01-28 18:00:21 -05:00
Richard Mitchell 1cac7399f9
wled: deprecate color_order option 
Support more synonym strings for colors
Case insensitive string type checks
Show errors in UI if e.g. wrong color was selected
Public color_config not color_order as it has confused users
Fix documentation for white stealthburner example

Signed-off-by:  Richard Mitchell <richardjm+moonraker@gmail.com>
 2022-01-25 06:02:36 -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
Lukas Fink 693a34d562 docs: add 'off_when_shutdown_delay' documentation 
Signed-off-by: Lukas Fink <lukas.fink1@gmail.com>
 2022-01-12 19:58:25 -05:00
Richard Mitchell cfd3d63a0d
wled: Add serial support for direct communication (#325) 
wled: Add serial support for direct communication

Signed-off-by:  Richard Mitchell <richardjm+moonraker@gmail.com>
 2022-01-12 19:56:14 -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 1d1ce0671d docs: fix jinja2 example 
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
 2021-12-28 11:05:15 -05:00
Eric Callahan adfe8a67b6 docs: fix error in mqtt power device documentation 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-12-28 10:49:27 -05:00
Eric Callahan 0a541bbea1 docs: add documentation for the secrets module 
Update the documentation for all relevant options that may
be resolved from secrets.

Signed-off-by:  Eric Calalahan <arksine.code@gmail.com>
 2021-12-24 14:44:48 -05:00
Eric Callahan 51ca383591 docs: add missing headers to config examples 
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
 2021-12-22 19:50:25 -05:00
Eric Callahan 01245ea8a1 docs: document the publish_mqtt_topic remote method 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-12-22 19:31:00 -05:00
Eric Callahan 57b00cb33a docs: add a warning for tplink devices 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-12-22 12:46:54 -05:00
Eric Callahan 5f7c6d623c docs: update "octoprint_compat" documentation 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-12-22 07:49:41 -05:00
Eric Callahan 828be30466 docs: refactor [power] documentation 
Separate the configuration for each device type, making it
easier for users to identify options specific for each
device.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-12-20 08:00:53 -05:00
Eric Callahan d7bfb7744a docs: document mqtt power device configuration 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-12-19 12:35:14 -05:00
Rafael 6852982406 Add API key info to example-home-assistant.yaml 
Currently the file makes no mention of any type of auth, so I've added a short example with an explanation of when you should use it.

Signed-off-by:  Rafael Schridi <r.schridi@gmail.com>
 2021-12-05 06:49:26 -05:00
Eric Callahan b3d2307d36 docs: document object processing 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-12-05 06:45:06 -05:00
Eric Callahan f00263b782 docs: document the refresh_interval option 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-12-05 06:41:18 -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
Eric Callahan 0f428acd07 docs: update job_queue documentation 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-11-26 17:00:42 -05:00
TravisTX d020dc81db docs: document the protocol config option 
Signed-off-by:  Travis Collins <travistx@gmail.com>
 2021-11-25 19:22:52 -05:00
Pedro Lamas 16c8063900 docs: fixes minor typos 
Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
 2021-11-24 11:33:23 -05:00
Clifford Roche 4e8e4f7d14 zeroconf: add module for zeroconf discovery 
Signed-off-by: Clifford Roche <clifford.roche@gmail.com>
 2021-11-22 15:03:33 -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
Richard Mitchell 93299658fb wled: fix index for wled 
Comparing to mqtt I think it should be H3 to appear in the index

Signed-off-by:  Richard Mitchell <richardjm+moonraker@gmail.com>
 2021-11-18 05:17:36 -05:00
Eric Callahan df1892801f docs: refactor the "power" configuration docs 
Add the "status_delay" option for Home Assistant and refactor to clarify what each option does for each device type.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-11-15 11:01:03 -05:00
Richard Mitchell 389e9c7e62
wled: support for remote neopixel control 
Signed-off-by:  Richard Mitchell <richardjm+moonraker@gmail.com>
 2021-11-14 07:16:20 -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 9789b3d999 docs: update user changes 
Note that core components should now be configured in their own config section.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-11-12 10:11:39 -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 1dd89bac4b docs: bump mkdocs requirement to 1.2.3 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-10-24 12:46:56 -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 8b510d9b03 docs: document the "timer" option for the power component 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-10-14 08:03:13 -04:00
crashmaxx 2836600857
power: add timer option to tplink-smartplug devices 
Signed-off-by: Andrew Stowell crashmaxx@gmail.com
 2021-10-12 06:35:32 -04:00
Eric Callahan 562f971c3d docs: update the mqtt documentation 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-10-10 18:08:25 -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
danijoo c3f1b290f8 power: add RF transmitter support 
Signed-off: Daniel Bauer <github@dbauer.me>
 2021-10-03 09:05:12 -04:00
Eric Callahan 4df93481ec docs: add note about nginx to installation.md 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-09-29 17:22:58 -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
Pedro Lamas db3f69e0dd Improves Home Assistant failure handling 
Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
 2021-09-04 05:39:55 -04:00
Pedro Lamas 183f4a75e5 Adds Home Assistant power switch example 
Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
 2021-09-04 05:39:55 -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
Pedro Lamas f1523ef5f8 Fixes rounding issue in home assistant sensor 
Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
 2021-08-21 18:05:06 -04:00
Pedro Lamas 5522e150b7 docs: Refactors the Home Assistant example 
Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
 2021-07-28 15:47:26 -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 f94a27c8e4 docs: add documentation for "is_system_service" option 2021-07-12 15:37:31 -04:00
Eric Callahan 1ce8af18ec docs: add "web_beta" documentation for the update_manager 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-07-09 18:06:07 -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 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
Arksine 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
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
Arksine 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
Grigi 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
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 baf97f8ea4 docs: document new "data_store" options. 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-02-14 17:50:45 -05:00
zellneralex 0fcae5b6e4 power: add Shelly device support 
Signed-off-by: Alex Zellner <alexander.zellner@googlemali.com>
 2021-02-07 07:31:04 -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 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
Arksine 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
Arksine 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
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
Jordan Ruthe 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
Jordan Ruthe 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
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 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
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 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
Arksine 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
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 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
Arksine 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
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 1b997b7457 docs: Note changes to install script 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-12-06 07:05:21 -05:00
Arksine 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
Eric Callahan 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
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
Matthias Neumayr 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
Matthias Neumayr 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
Arksine 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
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 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
Arksine 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
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 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
Arksine 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
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 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
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
Eric Callahan 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
Arksine 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 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
Arksine 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
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 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
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 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
Arksine 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
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 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
Arksine 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
Arksine b4b1356bdd docs: Add contributing guidelines 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2020-07-27 18:28:06 -04:00
Arksine 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
jordanruthe c589287e0b
power: printer power on/off control plugin 
Sign-off-by: Jordan Ruthe <jordanruthe@gmail.com>
 2020-07-27 14:08:48 -04:00