Skip to content

Extend tb3 to read pins A0-A5 #342

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

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

Conversation

travis-mendoza
Copy link

This PR extends the existing TurtleBot3 firmware for ROS 2 to read the analog pins A0-A5.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Hello @travis-mendoza, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

This pull request extends the TurtleBot3 firmware for ROS 2 to enable reading analog pins A0-A5. I've added the necessary definitions and functions to read the analog values and make them accessible through the DYNAMIXEL communication protocol. This will allow users to connect analog sensors to the TurtleBot3 and integrate their readings into ROS 2 applications.

Highlights

  • Analog Pin Support: Added support for reading analog pins A0-A5 on the TurtleBot3.
  • Control Item Integration: Integrated the analog pin readings into the DYNAMIXEL control table for easy access.
  • Firmware Update: Updated the firmware version and added a melody to indicate the modified firmware is running.

Changelog

  • arduino/opencr_arduino/opencr/libraries/turtlebot3_ros2/src/turtlebot3/turtlebot3.cpp
    • Added update_analog_pins function declaration.
    • Added ADDR_ANALOG_A0 to ADDR_ANALOG_A5 to the ControlTableItemAddr enum.
    • Added analog_pins[6] to the ControlItemVariables struct to store analog pin values.
    • Added control items for analog pins A0-A5 in the TurtleBot3Core::begin function.
    • Modified TurtleBot3Core::begin to play melody 3 and print a version message.
    • Called update_analog_pins in the TurtleBot3Core::run function.
    • Added update_analog_pins function definition to read analog pin values.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.


Six analog eyes,
See voltage, a silent hum,
Data flows to ROS.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This PR introduces the functionality to read analog pins A0-A5 on the TurtleBot3. The changes seem well-structured and the code is generally clear. However, there are a few points that could be improved for better maintainability and clarity.

Summary of Findings

  • Magic Numbers: The analog pin numbers (A0, A1, etc.) are used directly in the update_analog_pins function. Defining these as constants would improve readability and maintainability.
  • Firmware Versioning: The firmware version string is hardcoded. It would be better to define it as a constant or use a build system to automatically generate it.
  • Comment Consistency: There are some inconsistencies in the commenting style (e.g., spacing after //). While minor, addressing these would improve overall code appearance.

Merge Readiness

The pull request is almost ready for merging. Addressing the comments regarding magic numbers and firmware versioning would significantly improve the code quality. The comment consistency issue is minor and can be addressed at the author's discretion. I am unable to approve this pull request, and recommend that others review and approve this code before merging.

@GyuH13
Copy link

GyuH13 commented Apr 18, 2025

Hello, @travis-mendoza
Thanks for contribution.
As with the TB3, we will take action after review and discussion.
Thanks!!

@GyuH13 GyuH13 self-assigned this Apr 18, 2025
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.

2 participants