Commit Graph

186 Commits

Author SHA1 Message Date
Eric Callahan
35cb7501c6 docs: update analysis and metadata docs
Signed-off-by:  Eric Callahan
2025-02-17 15:32:45 -05:00
Eric Callahan
354cc11b8e docs: fix typos
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2025-02-12 06:28:53 -05:00
Eric Callahan
2fcc542d85 docs: update documentation with latest changes
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2025-02-11 08:01:50 -05:00
Eric Callahan
fae2b31acc docs: config doc formatting improvements
Use block style admonitions and add titles to
fenced code.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2025-02-06 19:15:38 -05:00
Eric Callahan
9c550a8f9a docs: complete API documentation rework
Moonraker's external API documentation has been significantly
overhauled in an effort to improve clarity and readability.
All parameters and responses are documented with specifications.
Tables and other elements are used to make documentation more
visible and less verbose.

Spelling and other corrections have also been added.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2025-02-06 19:15:38 -05:00
Eric Callahan
7e3c86e09a docs: update documentation with latest changes
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2025-01-30 07:43:54 -05:00
Eric Callahan
b40751ba9d docs: update install documentation
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2024-07-30 14:01:49 -04:00
Eric Callahan
54d68d9394 docs: add python package update documentation
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2024-07-24 16:35:37 -04:00
Eric Callahan
b07b2be5ca docs: update uhubctl power documentation
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2024-06-23 05:39:20 -04:00
Eric Callahan
c9581205d3 docs: add pinned commit documentation
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2024-05-25 12:30:56 -04:00
Eric Callahan
fca0cf3027 docs: update sensor documentation
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2024-05-15 07:31:57 -04:00
Eric Callahan
ba9428558a docs: add uhubctl documentation
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2024-05-06 07:56:42 -04:00
Eric Callahan
326d23a509 docs: document history additions
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2024-05-05 06:29:21 -04:00
Eric Callahan
48cb177ef0 docs: update configuration and changelog
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2024-04-28 12:21:24 -04:00
Eric Callahan
0850c16b00 sensor: require the 'state_response_template'
The sensor configuration isn't useful unless the user configures a
template that calls "set_result" to update fields for the desired
template.  Remove the default payload template and require
that it be configured.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2024-02-24 06:05:07 -05:00
Kamil Domański
04b1103778 Allow configuring the update refresh window
This enables customizing the time of day within which periodic refresh occurs.

Previously docs said it happens between 12am-4am which is misleading,
because the code effectively allowed refresh until 4:59:59 AM.
The default window is now '0-5', which is practically the same as before.

The comment about checking every 24h hours has been fixed as well.
This hasn't been true since commit c4fa76f217

Signed-off-by: Kamil Domański <kamil@domanski.co>
2024-02-17 12:41:51 -05:00
Eric Callahan
61ea86033a docs: update changelog and configuration docs
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2024-01-28 06:12:13 -05:00
Eric Callahan
f44fc4b85b docs: update changelog and add note about trusted domains
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2024-01-22 12:42:25 -05:00
Eric Callahan
3d44c51613 docs: minor spelling fixes
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2024-01-21 13:50:30 -05:00
Eric Callahan
d10ce8772d docs: add zip type documentation
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2024-01-21 08:24:06 -05:00
Eric Callahan
ee0c641b08 docs: update webcam documentation
Add tables specifying known values for the "icon"
and "service" options.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2023-12-24 19:44:16 -05:00
Eric Callahan
06a3f932ba docs: update gpio documentation
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2023-12-22 18:19:59 -05:00
wollew
7fc571643d power: enable HTTP port option for Zigbee/Hue devices
Signed-off-by: Wolfgang Miller-Reichling <wolfgang+github@miller-reichling.de>
2023-12-22 18:19:05 -05:00
Eric Callahan
088d9ee59a docs: update power documentation
Note that currently only Gen 1 shelly devices are supported.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2023-12-22 16:53:52 -05:00
Eric Callahan
42357891a3 docs: add "check_klipper_config_path" documentation
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2023-12-16 15:31:35 -05:00
Eric Callahan
e3cf9b2aa9 docs: note changes to bound service init
When "initial_state" is configured, bound services will be
initialzed based on that state...stopped if the state is
"off", started if its "on.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2023-11-15 18:09:57 -05:00
docgalaxyblock
2e27b073c9 docs: add Domoticz power device documentation
Signed-off-by: Olivier Berthomme <olivier@berthomme.fr>
2023-11-05 10:54:48 -05:00
docgalaxyblock
b63ca44094 docs: updated prebuild images config path note from ~/klipper_config to ~/printer_data
MainsailOS loads the moonraker.conf from `~/printer_data/config/`
Source:
[MainsailOS moonraker](https://github.com/mainsail-crew/MainsailOS/tree/develop/src/modules/moonraker/filesystem/home/pi)
[MainsailOS klipper](https://github.com/mainsail-crew/MainsailOS/blob/develop/src/modules/klipper/config#L28)

Signed-off-by: Joshua Schlicker <potter-91@web.de>
2023-11-03 17:53:14 -04:00
Daisuke Sato
17ffb4455e docs: fix typos in docs
Signed-off-by: Daisuke Sato <tiryoh@gmail.com>
2023-10-24 08:17:40 -04:00
Eric Callahan
c50e61a25b docs: update and clarify inline comment rules
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2023-10-06 12:35:43 -04:00
Eric Callahan
d98f11b98e docs: note route_prefix option
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2023-09-20 12:42:30 -04:00
Eric Callahan
07544718fa docs: note the 'spoolman_set_active_spool' remote method
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2023-06-26 18:10:33 -04:00
Eric Callahan
56499f9269 docs: note update_manager config changes
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2023-06-26 16:48:48 -04:00
Eric Callahan
09c29eab23 docs: minor spoolman updates
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2023-06-26 16:32:49 -04:00
Donkie
e6b3b8ba48 docs: Added section for spoolman
Signed-off-by: Daniel Hultgren <daniel.cf.hultgren@gmail.com>
2023-06-26 16:24:41 -04:00
Eric Callahan
2b98792657 docs: add zeroconf changes
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2023-06-25 07:02:12 -04:00
Eric Callahan
0f4276d9b0 docs: document update_manager changes
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2023-06-20 11:59:42 -04:00
Chris Thornton
b21f177e95 notifier: Add body_format as an option
This lets you format the messages through apprise a little nicer

Signed-off-by: Chris Thornton <cwgthornton@gmail.com>
2023-05-07 05:59:43 -04:00
Eric Callahan
6c7dfe5921 docs: add new fields to webcam documentation
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2023-04-23 07:30:08 -04:00
Eric Callahan
eff090170c docs: update power configuration documentation
Signed-off-by:  Eric Callaham <arksine.code@gmail.com>
2023-04-14 07:43:29 -04:00
Eric Callahan
6ef20d0a1f docs: update notifier documentation
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2023-03-05 12:28:41 -05:00
Eric Callahan
523c1ce423 docs: clarify update_manage documentation
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2023-02-27 06:23:04 -05:00
Eric Callahan
833519ecc3 docs: update file_manager documentation
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2023-02-21 12:24:54 -05:00
Eric Callahan
3917c9cd56 docs: fix minor typos
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2023-02-20 17:47:39 -05:00
Morton Jonuschat
b2ba52ce3d sensor: add support to track generic single value sensors
This feature implements a sensor component that can be used to
track/log generic sensors from multiple sources. Each sensor
can have properties like unit of measurement, accuracy and a
display name that help frontends display the tracked measurements.


Signed-off-by: Morton Jonuschat <mjonuschat+moonraker@gmail.com>
2023-02-20 17:43:41 -05:00
cmerkle
0de712e822 power: add support for Hue device groups
Signed-off-by: Clayton Merkle <clay.merkle@gmail.com>
2023-02-09 11:15:27 -05:00
Eric Callahan
25d2ad4af6 docs: update SimplyPrint documentation
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2023-02-08 16:34:18 -05:00
Eric Callahan
3710d49f46 docs: various small updates
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2023-02-08 16:32:45 -05:00
Eric Callahan
c5c6366a84 docs: document shutdown_action option
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2023-02-08 11:11:35 -05:00
Eric Callahan
d70dfaeebd docs: update machine config documentation
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2023-02-08 05:42:30 -05:00