Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend documentation of klippy:connect and klippy:read event handlers. #6702

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+5 −2
Open

Extend documentation of klippy:connect and klippy:read event handlers. #6702

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/Code_Overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,11 +277,14 @@ The following may also be useful:
* klippy:connect - This event is generated after all printer objects
are instantiated. It is commonly used to lookup other printer
objects, to verify config settings, and to perform an initial
"handshake" with printer hardware.
"handshake" with printer hardware. Event handlers may pause the
reactor (e.g. due to asynchronous communication with MCUs) and
raise exceptions (e.g. for configuration errors).
* klippy:ready - This event is generated after all connect handlers
have completed successfully. It indicates the printer is
transitioning to a state ready to handle normal operations. Do not
raise an error in this callback.
raise an error or pause the reactor (e.g. communicating with an
MCU) in this callback.
* If there is an error in the user's config, be sure to raise it
during the `load_config()` or "connect event" phases. Use either
`raise config.error("my error")` or `raise printer.config_error("my
Expand Down
Loading