https://github.com/frc5431/titanutil

A collection of utility classes to make robot programming easier
https://github.com/frc5431/titanutil

easy-to-use first-robotics-competition frc utility-library

Last synced: 3 months ago
JSON representation

A collection of utility classes to make robot programming easier

• Host: GitHub
• URL: https://github.com/frc5431/titanutil
• Owner: frc5431
• License: bsd-2-clause
• Created: 2018-01-17T03:37:54.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-05-27T19:14:00.000Z (7 months ago)
• Last Synced: 2024-09-26T13:42:00.505Z (3 months ago)
• Topics: easy-to-use, first-robotics-competition, frc, utility-library
• Language: Java
• Homepage:
• Size: 3.19 MB
• Stars: 9
• Watchers: 8
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# TitanUtil

[![](https://jitpack.io/v/frc5431/TitanUtil.svg)](https://jitpack.io/#frc5431/TitanUtil)

[![](https://github.com/frc5431/TitanUtil/workflows/Java%20CI%20with%20Gradle/badge.svg)](https://github.com/frc5431/TitanUtil/actions)

[Documentation](http://www.frc5431.com/TitanUtil/)

A collection of utility classes to make robot programming easier.

Do not riddle yourself with redundant and repetitive code when you have a library

that will do all of the grunt work for you.

# Features

**Current features include:**

## Core

* Motor toggling

* Built-in joystick deadzoning

* Xbox and drone controller button mapping

* Game data parser

## Robot

* Command based robot control

* Axis command groups (useful for driving)

* Builtin core utilities

* Added Components and Cross-Class Sensor Data

## Mimic

* Observing and Mimicing basic drivebase pathfinding data

* Saving mimic data to a flash drive

* Loading mimic data from a flash drive

* Portability to add more complex mechanisms like intakes

# Install

The supported way of introducing TitanUtil to a project is via Gradle. 

Gradle is the current build system for WPILib robot projects.

To install as a vendordep:

1. Open WPILIB Vscode

2. Open the command pallete by pressing Ctr+Shift+P

3. Select Manage Vendordeps

4. Then select ``Install New Libraries (Online)``

5. Put the following in the input field:

```

https://raw.githubusercontent.com/frc5431/TitanUtil/master/TitanUtil.json

```

To install, add the following to the root build.gradle

```

allprojects {

    repositories {

        mavenCentral()

        maven { url 'https://jitpack.io' }

    }

}

```

and, add the dependency (Make sure it's the latest release)

```

dependencies {

    implementation 'com.github.frc5431:TitanUtil:2024.1.0' //Replace tag with the latest release if needed

}

```

# License

BSD 2-Clause License

Copyright (c) 2024, 5431 Titan Robotics

All rights reserved

Refer to LICENSE file for more information, located in the base of this project