Files
YAGSL/README.md.bak

25 lines
1.3 KiB
Markdown
Raw Normal View History

2023-02-16 22:34:01 -06:00
# Yet Another Generic Swerve Library
* In early 2023 `swerve-lib` created by SwerveDriveSpecialties officially became unmaintained after not being updated in 2022.
* This library aims to simplify Swerve Drive implementations while not sacrificing speed or processing power.
# Features
* When a compatible absolute encoder is given it will be used as a remote encoder for the steering motor reducing CAN messages.
* Autogenerated shuffleboard dashboard for each module which can be updated periodically with the verbosity setting.
* The swerve drive is configurable via JSON files, and you can initialize the entire swerve drive with a similar line as the following.
* Simulation support.
```java
SwerveDrive swerveDrive = new SwerveParser(new File(Filesystem.getDeployDirectory(), "swerve")).createSwerveDrive();
```
# Library Information
* The library is located in [swervelib/](./swervelib) with documentation in [docs/](./docs) and example JSON in [deploy](./deploy).
# Check out the [Wiki](https://github.com/BroncBotz3481/YAGSL/wiki)
# Java docs is [here](https://broncbotz3481.github.io/YAGSL/).
# Images
![Field Shuffleboard](./imgaes/field.png)
![Simulation](./imgaes/simulation.png)
![Falcon Drive](./imgaes/swerve_falcons_fix.mov)
![Dashboard as graphs](./imgaes/swerve_neos.mp4)