https://github.com/henrikvtcodes/glowbot

A declarative LED library for FIRST Robotics Competition robots.
https://github.com/henrikvtcodes/glowbot

first-robotics-competition wpilibj

Last synced: 11 days ago
JSON representation

A declarative LED library for FIRST Robotics Competition robots.

• Host: GitHub
• URL: https://github.com/henrikvtcodes/glowbot
• Owner: henrikvtcodes
• Created: 2023-10-16T00:19:02.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-27T18:34:54.000Z (10 months ago)
• Last Synced: 2024-11-02T11:02:53.279Z (about 2 months ago)
• Topics: first-robotics-competition, wpilibj
• Language: Java
• Homepage:
• Size: 240 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Glowbot

Glowbot is an LED control library for FIRST Robotics Competition. Currently, it contains two primary things:  

- A full featured SDK for controlling LEDs with WPILib's built in Addressable LED support

- A slim, declarative class and set of Enums for controlling Rev Blinkin modules. (This was more of a side project and the documentation here will focus on the main sdk)

## Installing

It has been packaged as a vendor dep, so here's the URL:

```

https://orangeunilabs.com/frc/glowbot/Glowbot.json

```

Here's how to add a vendordep from a URL: [Installing 3rd Party Libraries | WPILib Docs](https://docs.wpilib.org/en/stable/docs/software/vscode-overview/3rd-party-libraries.html#installing-libraries)

# Documentation

### Features and Motivation

I decided to create this almost 1 year ago because I felt like the LED support was a bit barebones. Why not take some ideas

from the core of WPILib and provide a more full featured experience for writing LED code. This library was made to be very 

flexible and modular, in that you can use parts of it or the whole thing. The main features include simple things like 

enhanced for loop support, a built in updater, and methods to set a range of LEDs at once. This library also supports the

creation of LED "sections"; i.e. distinct ranges of LEDs that can be individually controlled.

## Credits

Many of the builtin LED patterns and the API were either directly copied from or inspired by code from 

FRC team 5013, the Trobots.