3diy
/
moonraker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Add clarification to printer object description 

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Arksine 2020-10-26 21:29:53 -04:00
parent 9394bf592c
commit d582d76346
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/printer_objects.md
View File

@ -1,16 +1,15 @@
As mentioned in the API documentation, it is possible to As mentioned in the API documentation, it is possible to
[query](web_api.md#query-printer-object-status) or [query](web_api.md#query-printer-object-status) or
[subscribe](web_api.md#subscribe-to-printer-object-status) [subscribe](web_api.md#subscribe-to-printer-object-status)
to "Klipper Printer Objects." These APIs are used to retreive state from to "Klipper Printer Objects." There are numerous printer objects in
the Klippy Host. There are numerous printer objects in Klipper, many of Klipper, many of which are optional and only report status if they are
which are optional and only report status if they are enabled by Klipper's enabled by Klipper's configuration. Client's may retreive a list of
configuration. Client's may retreive a list of active printer objects available printer objects via the
that may report status via the
[list objects endpoint](web_api.md#list-available-printer-objects). This [list objects endpoint](web_api.md#list-available-printer-objects). This
should be done after Klipper reports its state as "ready". should be done after Klipper reports its state as "ready".
This section will provide an overview of the most useful printer objects. This section will provide an overview of the most useful printer objects.
If a developer is interested in retreiving state for an object listed here, If a developer is interested in retreiving state for an object not listed here,
look in Klipper's source code for module you wish to query. If the module look in Klipper's source code for module you wish to query. If the module
contains a "get_status()" method, its return value will contain a dictionary contains a "get_status()" method, its return value will contain a dictionary
that reports state which can be queried. that reports state which can be queried.