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.

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

Document the ping() functionality in manual #11

Open
evilmav opened this issue Jan 17, 2022 · 2 comments
Open

Document the ping() functionality in manual #11

evilmav opened this issue Jan 17, 2022 · 2 comments

Comments

@evilmav
Copy link

evilmav commented Jan 17, 2022

The manual chapter Developing a Network Device Support Package should probably hint the user to implement a ping() method to avoid the controllers being restarted by the ctlmgr.

Futhermore, a log entry like WARNING:ctlmgr(artiq-host):artiq_comtools.ctlmgr:Controller xyz ping failed is misleading to an unsuspecting user as it leaves the impression that the controller is hung, where it in fact very much alive but failed to implement the ping() method. It would be nice to make the message explicit if the controller did not find the method in the first place.

@charlesbaynham
Copy link

Finding that feature is a bit of a rite of passage for new artiq users. But you're right, that should probably be fixed 😌

@dnadlinger
Copy link
Contributor

We could just add an explanatory paranthetical to the error message, something like (controller dead, or ping(), which should return True, not implemented).

Mentioning this in the manual would of course also help.

@evilmav: Do you want to open a PR improving the wording?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants