wpilibsuite/wpilib-docs

Pose estimator article doesn't show usage

Open

#1,413 opened on Aug 23, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (297 forks)auto 404
Component: ControlsContributors WelcomeExamplesHelp Wanted

Repository metrics

Stars
 (187 stars)
PR merge metrics
 (PR metrics pending)

Description

It shows how to construct the pose estimator, but not common usage like how to update it with encoders (like the odometry class) or how to apply vision measurements.

We should also document how to get those vision measurements in the first place, because that's not trivial. PhotonVision has utility functions and docs for that we may want to consider replicating.

https://docs.photonvision.org/en/latest/docs/programming/photonlib/util-calculations.html

Contributor guide

Research direction
Read the existing pose estimator documentation to understand its current structure. Identify missing usage examples such as updating with encoders and applying vision measurements. Refer to the odometry class documentation for similar usage patterns. Also review PhotonVision utility functions for obtaining vision measurements, as referenced in the issue link. Research how to present these in a clear, step by step manner.
Tech stack
javacpp
Domain
embedded iot
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitWPILib basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75