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

DOCS-1781: Handle planning for the zero pose #2589

Merged
merged 5 commits into from
Feb 29, 2024

Conversation

npentrel
Copy link
Collaborator

No description provided.

@npentrel npentrel requested a review from nfranczak February 27, 2024 12:19
@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Feb 27, 2024
@viambot
Copy link
Member

viambot commented Feb 27, 2024

Overall readability score: 55.43 (🟢 +0)

File Readability
_index.md 59.79 (🔴 -0.66)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
_index.md 59.79 38.21 8.43 14.2 13.86 5.78
  🔴 -0.66 🔴 -0.41 🔴 -0.16 🔴 -0.2 🟢 +0 🔴 -0.01

Averages:

  Readability FRE GF ARI CLI DCRS
Average 55.43 47.48 10.68 13.24 12.09 7.62
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@npentrel npentrel requested a review from nfranczak February 27, 2024 16:34
Each successful `MoveOnMap()` call returns a unique `ExecutionID` which you can use to identify all plans generated during the `MoveOnMap()` call.

{{< alert title="Info" color="info" >}}
If you specify a goal pose or orientation and the robot's current position is already at the goal post or orientation, `MoveonMap` returns an error.
Copy link
Member

Choose a reason for hiding this comment

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

small nit: I would say:

If you specify a goal pose and the robot's current position is already within the set `PlanDeviationM`, then `MoveonMap` returns an error.

i.e. if we are within PlanDeviationMM of the goal pose then we do not need to start.

Copy link
Member

@nfranczak nfranczak left a comment

Choose a reason for hiding this comment

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

nit change is already at the goal post or orientation to within planDevM for both moveonmap and moveonglobe

Each successful `MoveOnGlobe()` call returns a unique `ExecutionID` which you can use to identify all plans generated during the `MoveOnGlobe()`.

{{< alert title="Info" color="info" >}}
If you specify a goal pose or orientation and the robot's current position is already within the set `PlanDeviationM` or orientation, `MoveOnGlobe` returns an error.
Copy link
Member

@nfranczak nfranczak Feb 27, 2024

Choose a reason for hiding this comment

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

can you please change this to be

If you specify a goal pose and the robot's current position is already within the set `PlanDeviationM`, `MoveOnGlobe` returns an error.

Copy link
Member

Choose a reason for hiding this comment

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

@npentrel this should not include "or orientation"

@npentrel npentrel requested a review from nfranczak February 27, 2024 20:17
@npentrel
Copy link
Collaborator Author

@nfranczak is this now good to go?

Copy link
Member

@nfranczak nfranczak left a comment

Choose a reason for hiding this comment

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

One comment about removing "or orientation" from MoveOnGlobe. Otherwise, LGTM

Each successful `MoveOnGlobe()` call returns a unique `ExecutionID` which you can use to identify all plans generated during the `MoveOnGlobe()`.

{{< alert title="Info" color="info" >}}
If you specify a goal pose or orientation and the robot's current position is already within the set `PlanDeviationM` or orientation, `MoveOnGlobe` returns an error.
Copy link
Member

Choose a reason for hiding this comment

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

@npentrel this should not include "or orientation"

@viambot
Copy link
Member

viambot commented Feb 29, 2024

You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/2589

@npentrel npentrel merged commit 91007f6 into viamrobotics:main Feb 29, 2024
9 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to build This pull request is marked safe to build from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants