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

DC Motor documentation #268

Merged

Conversation

leandrumartin
Copy link
Collaborator

Added motor.adoc file. Currently it includes info about API calls, YAML file, and a link to the example controller.

@leandrumartin leandrumartin self-assigned this Oct 11, 2024
Copy link
Collaborator

Choose a reason for hiding this comment

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

Remove "TODO: finish documentation here" under 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.

The implementation aligns well with the project requirements, but please remove the "TODO: finish documentation here" note under the Assembly Instructions. From a product and code quality perspective, it's important to keep the code clean and avoid placeholder comments. Looking forward to the updates.

Todo:
Remove "TODO: finish documentation here" under the Assembly Instructions.

----

* `/enable` - Enables the motor.
* `/disable` - Disables the motor.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Show how these could be run from command line.

@leandrumartin leandrumartin marked this pull request as ready for review October 18, 2024 21:58
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 successfully implements the DC motor control functionality, providing comprehensive documentation that includes component descriptions, YAML configuration, circuit setup images, and clear usage instructions. The detailed information will greatly assist users in controlling motor speed and direction effectively.
Resolved #263

@yrlmanoharreddy yrlmanoharreddy merged commit 3e99403 into main Oct 21, 2024
6 checks passed
@yrlmanoharreddy yrlmanoharreddy deleted the 263-document-dc-motor-control-module-for-pi4micronaut branch October 21, 2024 00:53
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.

3 participants