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

Sensor integration guide #140

Open
jmadden173 opened this issue Oct 16, 2024 · 0 comments
Open

Sensor integration guide #140

jmadden173 opened this issue Oct 16, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@jmadden173
Copy link
Contributor

Describe the Enhancement
Create .md documentation for adding sensor support for new sensors on the platform. All currently supported sensor protocol should be referenced including analog measurements, sdi-12, and i2c. Each protocol should have common function calls for refernece (eg. SDI12_ReadMeasurement) so the sensor library can be easily implemented.

For now lets leave protobuf definitions out of the picture as our current interface is clunky requiring a completely new Measurement definition to be implemented along with corresponding encode/decode functions. We can consider alternative interfaces in the next major release.

Benefits
More documentation allowing non-lab collaborators to integrate new sensors with the system.

Possible Drawbacks
N/A

Additional Context
As part of #38, they'll be a library exposed for Arduino based i2c sensors to interface with the host device that can be documented in that issue.

@jmadden173 jmadden173 added the enhancement New feature or request label Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants