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.

Sign up for GitHub

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

Jump to bottom

Add XRP to creating robot programs #2760

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add XRP to creating robot programs #2760

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f03c460
Update creating-robot-program.rst
leongmichael Sep 24, 2024
23716f7
Update creating-robot-program.rst
leongmichael Sep 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions source/docs/software/vscode-overview/creating-robot-program.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,22 @@ The ``Romi - Command Bot`` template provides a ``RomiDrivetrain`` subsystem that

This subsystem also provides functions for retrieving and resetting the Romi's onboard encoders.

### XRP

Teams using a :ref:`XRP <docs/xrp-robot/index:Getting Started with XRP>` should use the ``XRP - Timed`` or ``XRP - Command Bot`` template.

#### XRP - Timed

The ``XRP - Timed`` template provides a ``XRPDrivetrain`` class that exposes an ``arcadeDrive(double xaxisSpeed, double zaxisRotate)`` method. It's up to the user to feed this arcadeDrive function.
Copy link
Member

Choose a reason for hiding this comment

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

We should be exact with the naming here. It looks like they are called XRP - Command Robot and XRP - Timed Robot. This is also a problem with the Romi section. I realize you didn't write that but I think improving it the same way would help!


This class also provides functions for retrieving and resetting the XRP's onboard encoders.

#### XRP - Command Bot

The ``XRP - Command Bot`` template provides a ``XRPDrivetrain`` subsystem that exposes an ``arcadeDrive(double xaxisSpeed, double zaxisRotate)`` method. It's up to the user to feed this arcadeDrive function.

This subsystem also provides functions for retrieving and resetting the XRP's onboard encoders.
Copy link
Member

Choose a reason for hiding this comment

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

All of this feels just a duplication of the Romi stuff. While it is all true I am wondering if we couldn't get across all the same information with a single combined section that use this text once for all. It would need to say "subsystem/class".


### Not Using a Base Class

If desired, users can omit a base class entirely and simply write their program in a :code:`main()` method, as they would for any other program. This is *highly* discouraged - users should not "reinvent the wheel" when writing their robot code - but it is supported for those who wish to have absolute control over their program flow.
Expand Down