> For the complete documentation index, see [llms.txt](https://yall.yassrobotics.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://yall.yassrobotics.com/api-reference/readme.md).

# Overview

Yet Another Limelight Library (YALL) is a WPILib vendordep for Limelight smart cameras used in FRC. It wraps the raw Limelight NetworkTables API and `limelight.results` JSON output in a typed, chainable Java API — pose estimation (MegaTag1/MegaTag2), AprilTag/neural/retroreflective/barcode target results, raw fiducial/detection data, IMU and hardware telemetry, and Limelight configuration (LEDs, pipelines, crop windows, camera offsets, etc).

A Python port with an equivalent API surface ships alongside the Java library. A C++ port is planned but not yet implemented.

## Features

* **`Limelight`** — one object per camera, resolves its NetworkTables table by name
* **`LimelightSettings`** — chainable `.withXXXX()` configuration for LEDs, pipelines, IMU, crop, offsets, and more
* **`LimelightPoseEstimator`** — MegaTag1/MegaTag2 pose estimates with alliance-aware helpers
* **`LimelightResults`** — full JSON `limelight.results` output, including all target/pipeline types
* **`LimelightData`** — direct NetworkTables reads for raw fiducials, raw detections, barcodes, and Python script I/O
* **Typed target results** — `AprilTagFiducial`, `RetroreflectiveTape`, `NeuralClassifier`, `NeuralDetector`, `Barcode`
* **Hardware telemetry** — `IMUResults`, `HardwareReport`, `HailoStats`, `RewindStats` (2026+ hardware)

## Quick Navigation

* [Java API](/api-reference/java-reference/java-reference.md)
* [Python API](/api-reference/python-reference/python-reference.md)

For tutorials, how-to guides, and conceptual explanations, see the main YALL documentation space (YALL-Gitbook).

## Supported Hardware

| Device                                   | Notes                                            |
| ---------------------------------------- | ------------------------------------------------ |
| Limelight 2/2+/3/3G/3A                   | AprilTag, retroreflective, neural pipelines      |
| Limelight 4                              | Adds onboard IMU, rewind capture, USB networking |
| Hailo accelerator (LL4, sold separately) | Reported via `HardwareReport.hailoStats`         |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://yall.yassrobotics.com/api-reference/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.