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

Added Speed Sensor Documentation #269

Merged
merged 4 commits into from
Oct 21, 2024
Merged

Conversation

ThomasMacas
Copy link
Collaborator

Fixes #264

Created documentation for our Speed Sensor. Including all necessary information to assist in someone wants to utilize a speed sensor in their project. Added speedSensor.adoc to house the circuit and schematic diagrams, as well as example testing, assembly information, and necessary components.

Copy link
Collaborator

@yrlmanoharreddy yrlmanoharreddy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is an inconsistency between the YAML configuration and the circuit diagram. The circuit diagram points to GPIO 17, while the YAML configuration is pointing to GPIO 22. Please update either the diagram or the configuration to ensure they both reflect the correct GPIO pin.

@ThomasMacas ThomasMacas self-assigned this Oct 14, 2024
Copy link
Collaborator

@leandrumartin leandrumartin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good. I like the detail in the assembly instructions.

Copy link
Collaborator

@yrlmanoharreddy yrlmanoharreddy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This pull request provides thorough documentation for the speed sensor, including its capabilities, YAML configuration, circuit setup image, schematic diagram, and usage instructions. Everything is clear and well-structured

@yrlmanoharreddy yrlmanoharreddy merged commit 26bccae into main Oct 21, 2024
6 checks passed
@yrlmanoharreddy yrlmanoharreddy deleted the 264-SpeedSensorDocumentation branch October 21, 2024 01:03
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.

Document Speed Sensor Component for Pi4Micronaut
3 participants