Skip to content

Clarify base coordinate system in comments #324

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

Merged
merged 2 commits into from
Jun 26, 2023
Merged
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions src/viam/components/base/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@ async def spin(

Args:
angle (float): The angle (in degrees) to spin.
Negative implies backwards.
velocity (float): The angular velocity (in degrees per second).
to spin. Negative implies backwards.
velocity (float): The angular velocity (in degrees per second)
to spin.
Given a positive angle and a positive velocity, the base will turn to the left.
"""
...

Expand All @@ -91,7 +91,7 @@ async def set_power(

Args:
linear (Vector3): The linear component. Only the Y component is used
for wheeled base. Negative implies backwards.
for wheeled base. Positive implies forwards.
angular (Vector3): The angular component. Only the Z component is used
for wheeled base. Positive turns left; negative turns right.
"""
Expand Down