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

Add self-test query for device-specific health checks #24

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

polymerizedsage
Copy link
Contributor

This adds a self-test query that can be used to return data about hardware calibration and health. An example test this query might be used for is validating a probe has all the correct register settings when it boots up.

The query message itself includes an optional field for specific electrode IDs to be used by self-tests that are conducted on specific electrodes. The response message (SelfTestResponse) contains a bool that is true if all tests passed. It then contains a list of SelfTestItem messages for each test procedure that was conducted. The SelfTestItem contains the name of the test, a boolean representing if the test passed, and a test_data field for more detailed data that the test may have collected. Finally, the test_report string can contain a message describing what went wrong if the test item fails.

I kept the definition of this query intentionally broad and flexible since it is meant to be used to return hardware-specific data that may not be standardized between probes.

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

Successfully merging this pull request may close these issues.

1 participant