Add self-test query for device-specific health checks #24
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 ofSelfTestItem
messages for each test procedure that was conducted. TheSelfTestItem
contains the name of the test, a boolean representing if the test passed, and atest_data
field for more detailed data that the test may have collected. Finally, thetest_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.