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

# Overview

YAMS (Yet Another Mechanism Suite) is a WPILib vendordep library for FRC robots. It provides a unified motor controller abstraction over REV, CTRE, Thrifty, and FIRST hardware, pre-built mechanism classes for common robot subsystems, and advanced control algorithms, all with simulation support and automatic NetworkTables telemetry. Both Java and C++ are supported with parallel APIs.

This documentation tracks YAMS for WPILib 2027 (`2027_alpha7`), where robot code runs on the SystemCore. Java command bindings ship for both WPILib Commands v2 (`yams.commands2`) and Commands v3 (`yams.commands3`); C++ supports Commands v2. See [Getting Started](https://yams.yassrobotics.com/api-reference/getting-started.md) for installation.

## Features

* **Motor controller abstraction:** a single `SmartMotorController` interface over SPARK MAX, SPARK FLEX, TalonFX, TalonFXS, Thrifty Nova, and FIRST A301
* **Mechanism classes:** `Arm`, `Elevator`, `Pivot`, `FlyWheel`, `DoubleJointedArm`, `DifferentialMechanism`, and `SwerveDrive` (`DoubleJointedArm` and `DifferentialMechanism` are Java only)
* **Advanced control:** LQR, exponential motion profiles, trapezoidal profiles, and a derivative-time filter
* **Extended units:** `YUnits` constants and `EasyCRT` multi-encoder absolute position solver
* **Simulation:** built-in sim support for all mechanism classes via WPILib's simulation framework, with one shared `BatterySim` across every motor controller
* **Commands v2 and v3:** the same mechanisms with `Command` and `Trigger` factories for either WPILib command framework (Java)

## Quick navigation

* [Java API](https://yams.yassrobotics.com/api-reference/java-reference/java.md)
* [C++ API](https://yams.yassrobotics.com/api-reference/c++-reference/cpp.md)
* [Guides](https://yams.yassrobotics.com/api-reference/guides/guides.md)

## Supported hardware

| Device     | Vendor          | Interface |
| ---------- | --------------- | --------- |
| SPARK MAX  | REV Robotics    | CAN       |
| SPARK FLEX | REV Robotics    | CAN       |
| TalonFX    | CTR Electronics | CAN       |
| TalonFXS   | CTR Electronics | CAN       |
| Nova       | Thrifty Bot     | CAN       |
| A301       | FIRST           | CAN       |


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
