For the complete documentation index, see llms.txt. This page is also available as Markdown.

LimelightPoseEstimator

Package: limelight.networktables

Fetches field-relative robot pose estimates from a Limelight, using either the MegaTag1 or MegaTag2 pipeline. Created via limelight.createPoseEstimator(EstimationMode).

LimelightPoseEstimator poseEstimator = limelight.createPoseEstimator(EstimationMode.MEGATAG2);
Optional<PoseEstimate> estimate = poseEstimator.getPoseEstimate();

Constructor

LimelightPoseEstimator(Limelight camera, EstimationMode estimationMode)

Prefer limelight.createPoseEstimator(mode) over calling this directly.


Methods

Method
Returns
Description

getPoseEstimate()

Optional<PoseEstimate>

Blue-origin pose estimate, using MegaTag1 or MegaTag2 depending on the estimator's EstimationMode.

getAlliancePoseEstimate()

Optional<PoseEstimate>

Pose estimate in the coordinate frame matching DriverStation.getAlliance(). Empty if alliance color is unavailable.

getBotPose() (deprecated)

Pose3d

Legacy MegaTag1 botpose entry, not alliance- or origin-aware. Prefer getPoseEstimate().


EstimationMode

Value
Description

MEGATAG1

Estimates pose from a single AprilTag using only visual data. No external state required.

MEGATAG2

Fuses AprilTag detections with robot heading for smoother, more accurate localization — especially at long range or oblique angles. Requires calling LimelightSettings.withRobotOrientation every loop before reading the estimate.


BotPose

Internal enum mapping each EstimationMode/alliance combination to its NetworkTables entry name. Exposed publicly for direct access without going through a LimelightPoseEstimator:

Value
NT Entry
MegaTag2

RED

botpose_wpired

No

RED_MEGATAG2

botpose_orb_wpired

Yes

BLUE (recommended)

botpose_wpiblue

No

BLUE_MEGATAG2 (recommended)

botpose_orb_wpiblue

Yes

Each BotPose value caches one PoseEstimate per Limelight it's queried with, keyed by camera name + entry, so repeated calls don't allocate.

See Also

Last updated

Was this helpful?