https://github.com/frcteam3255/supercore

SuperNURD Base classes for FRC Robots
https://github.com/frcteam3255/supercore

Last synced: about 2 months ago
JSON representation

SuperNURD Base classes for FRC Robots

• Host: GitHub
• URL: https://github.com/frcteam3255/supercore
• Owner: FRCTeam3255
• Created: 2018-12-01T22:51:52.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-08-09T21:50:09.000Z (5 months ago)
• Last Synced: 2024-08-10T20:37:30.219Z (5 months ago)
• Language: Java
• Homepage: https://frcteam3255.github.io/SuperCORE/
• Size: 6.04 MB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# SuperCORE

![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/FRCTeam3255/SuperCORE?include_prereleases&label=latest)

SuperCORE is a vendor library for FRC projects. SuperCORE has several uses:

* handles controllers

* adds improved RobotPreferences

* various custom utilities

These are tasks that need to be done every year, so instead of just rewriting all the code, or copying it from last year's project, SuperCORE was created as a vendor library to make it as quick and easy as possible to get a new robot functional.

## Production Installation Instructions

1. In Visual Studio Code press Ctrl + shift + p

2. Type "Manage vendor libraries" into the prompt and hit enter

3. Select "Install new libraries (online)"

4. Copy and paste the following link into the prompt: `https://SuperNURDs.com/installSuperCORE`

## Features

### Supported Controllers

* Logitech F310 Gamepad

  * SN_DualActionStick

  * SN_F310Gamepad

* Logitech Extreme 3D Pro Joystick

  * SN_Extreme3DStick

* Custom Arduino Switchboard

  * SN_SwitchboardStick

### Utilities

* Alternative debug output

  * SN_Debug

  * All SN_Debug message output can be disabled very easily

* Linear Interpolation

  * SN_Math

* Turn CSVs into Motion Profiles

  * SN_MotionProfile

### Robot Preferences

Using the SuperCORE preferences gives the ability to switch between using the hardcoded values and the Network Tables values.

## Competition

It is recommended during a competition that:

* all SN_Debug messages be disabled, making other important error messages more visible.

* hardcoded Robot Preferences are used.

  * This makes the behavior of the Robot based only on the code that the robot is running, and not on any other external factors, like the system that is running the drivers station software

## Documentation

[Java Docs](https://frcteam3255.github.io/SuperCORE/releases/com/frcteam3255/supercore/javadoc-latest/)

## Local Development Installation

> [!Important]

> Prerequisite: Have the following VSCode extensions installed:

>

> * [Gradle for Java Extension](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-gradle)

> * [Live Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer)

1. Open SuperCORE project/repo in VSCode

2. Select gradle from the sidebar

   1. ![Gradle](./documentation/gradleicon.png)

3. Run supercore/cleanPublishSuperCORELocalDev command

   1. ![Publish](./documentation/publish_local.png)

4. Open Command Palette `(ctrl+shift+p)` and select `Live Server: Open with Live Server`

   1. ![Live Server](./documentation/live_server.png)

5. Open desired robot project in another VSCode window

6. In the new Visual Studio Code window (**Robot Project**) Open Command Palette `(ctrl+shift+p)`

7. Type "Manage vendor libraries" into the prompt and hit enter

8. Select "Install new libraries (online)"

9. Copy and paste the following link into the prompt: `http://127.0.0.1:5500/releases/com/frcteam3255/supercore/SuperCORE-latest.json`

10. Test robot code with dev SuperCORE