Index
All Classes and Interfaces|All Packages
A
- addAddress(MIDIAddress) - Method in class io.github.roboblazers7617.buttonbox.midi.MIDIRouter
-
Adds an address to which MIDI messages will be routed to.
- addControl(Control) - Method in class io.github.roboblazers7617.buttonbox.ButtonBoxClient
-
Adds a control to the ButtonBoxClient.
- addControl(Control) - Method in class io.github.roboblazers7617.buttonbox.ButtonBoxServer
-
Adds a control to the ButtonBoxServer.
- Address<T> - Interface in io.github.roboblazers7617.buttonbox
-
A channel through which data can be sent and recieved to and from ButtonBox hardware.
B
- Button - Class in io.github.roboblazers7617.buttonbox.controls
-
A push button with configurable feedback.
- Button(String) - Constructor for class io.github.roboblazers7617.buttonbox.controls.Button
-
Creates a new Button.
- Button.ButtonMode - Enum Class in io.github.roboblazers7617.buttonbox.controls
-
Determines how the state of the button should be updated when the button is pressed or released.
- ButtonBoxClient - Class in io.github.roboblazers7617.buttonbox
-
Class for client-side ButtonBox logic.
- ButtonBoxClient(NetworkTableInstance) - Constructor for class io.github.roboblazers7617.buttonbox.ButtonBoxClient
-
Creates a new ButtonBoxClient.
- ButtonBoxServer - Class in io.github.roboblazers7617.buttonbox
-
Class for robot-side ButtonBox logic.
- ButtonBoxServer() - Constructor for class io.github.roboblazers7617.buttonbox.ButtonBoxServer
-
Creates a new ButtonBoxServer.
C
- channel - Variable in class io.github.roboblazers7617.buttonbox.midi.MIDIAddress
-
MIDI channel to communicate on.
- CLAMP - Enum constant in enum class io.github.roboblazers7617.buttonbox.controls.PhysicalEncoder.LoopMode
-
Clamp out of range values to the valid range.
- close() - Method in class io.github.roboblazers7617.buttonbox.midi.MIDIRouter
- Color - Class in io.github.roboblazers7617.buttonbox
-
Class that represents an RGB color.
- Color() - Constructor for class io.github.roboblazers7617.buttonbox.Color
-
Creates a new Color with default values.
- Color(double, double, double) - Constructor for class io.github.roboblazers7617.buttonbox.Color
-
Creates a new Color with provided values.
- Color(Color) - Constructor for class io.github.roboblazers7617.buttonbox.Color
-
Creates a new Color from a WPILib
Color. - command - Variable in class io.github.roboblazers7617.buttonbox.midi.MIDIAddress
-
MIDI command to use.
- Control - Class in io.github.roboblazers7617.buttonbox
-
Class for buttonbox controls that handles feedback and NetworkTables.
- Control(String) - Constructor for class io.github.roboblazers7617.buttonbox.Control
-
Creates a new Control.
- copy() - Method in class io.github.roboblazers7617.buttonbox.Color
-
Copies this Color.
D
- data1 - Variable in class io.github.roboblazers7617.buttonbox.midi.MIDIAddress
-
Data1 to use (note number, CC number, etc).
- DoubleAddress - Interface in io.github.roboblazers7617.buttonbox.addresses
-
A channel through which doubles can be sent and recieved to and from ButtonBox hardware.
E
- equals(Object) - Method in class io.github.roboblazers7617.buttonbox.Color
G
- getBlue() - Method in class io.github.roboblazers7617.buttonbox.Color
-
Gets the blue element of this color [0-1].
- getBrightness() - Method in class io.github.roboblazers7617.buttonbox.controls.LED
-
Gets the brightness of the LED.
- getButton() - Method in class io.github.roboblazers7617.buttonbox.controls.Joystick
-
Gets whether the joystick button is pressed or not.
- getButtonTrigger() - Method in class io.github.roboblazers7617.buttonbox.controls.Joystick
-
Gets a trigger for the button.
- getChannel() - Method in class io.github.roboblazers7617.buttonbox.midi.MIDIAddress
-
Gets the address's channel.
- getColor() - Method in class io.github.roboblazers7617.buttonbox.controls.LEDMulticolor
-
Gets the color of the LED.
- getCommand() - Method in class io.github.roboblazers7617.buttonbox.midi.MIDIAddress
-
Gets the address's command.
- getData1() - Method in class io.github.roboblazers7617.buttonbox.midi.MIDIAddress
-
Gets the address's data1 value.
- getDeviceByName(String) - Static method in class io.github.roboblazers7617.buttonbox.midi.MIDIUtil
-
Finds a MIDI device by name.
- getDeviceByName(String, String) - Static method in class io.github.roboblazers7617.buttonbox.midi.MIDIUtil
-
Finds a MIDI device by name.
- getFeedback() - Method in interface io.github.roboblazers7617.buttonbox.Address
-
Gets feedback from the address.
- getFeedback() - Method in interface io.github.roboblazers7617.buttonbox.addresses.DoubleAddress
-
Gets feedback from the address.
- getFeedback() - Method in class io.github.roboblazers7617.buttonbox.midi.MIDIAddress
- getFeedbackQueue() - Method in interface io.github.roboblazers7617.buttonbox.Address
-
Gets the changes to the feedback from the address since the last call to this method.
- getFeedbackQueue() - Method in interface io.github.roboblazers7617.buttonbox.addresses.DoubleAddress
-
Gets the changes to the feedback from the address since the last call to this method.
- getFeedbackQueue() - Method in class io.github.roboblazers7617.buttonbox.midi.MIDIAddress
- getFeedbackQueueRaw() - Method in class io.github.roboblazers7617.buttonbox.midi.MIDIAddress
-
Gets changes to the feedback from the address, and clears the queue of changes.
- getFeedbackRaw() - Method in class io.github.roboblazers7617.buttonbox.midi.MIDIAddress
-
Gets feedback from the address.
- getGreen() - Method in class io.github.roboblazers7617.buttonbox.Color
-
Gets the green element of this color [0-1].
- getId() - Method in class io.github.roboblazers7617.buttonbox.Control
-
Gets the ID of this control.
- getPosition() - Method in class io.github.roboblazers7617.buttonbox.controls.Knob
-
Gets the position of the Knob.
- getRed() - Method in class io.github.roboblazers7617.buttonbox.Color
-
Gets the red element of this color [0-1].
- getRouter() - Method in class io.github.roboblazers7617.buttonbox.midi.MIDIDevice
-
Gets the MIDIRouter assigned to this device.
- getState() - Method in class io.github.roboblazers7617.buttonbox.controls.Button
-
Gets the button's state.
- getTable() - Method in class io.github.roboblazers7617.buttonbox.Control
-
Gets the NetworkTable used by this Control.
- getTrigger() - Method in class io.github.roboblazers7617.buttonbox.controls.Button
-
Get a trigger for the button.
- getValue() - Method in class io.github.roboblazers7617.buttonbox.controls.TestControl
-
Gets the current value of the TestControl.
- getX() - Method in class io.github.roboblazers7617.buttonbox.controls.Joystick
-
Gets the X axis value.
- getY() - Method in class io.github.roboblazers7617.buttonbox.controls.Joystick
-
Gets the Y axis value.
I
- io.github.roboblazers7617.buttonbox - package io.github.roboblazers7617.buttonbox
-
Main ButtonBoxLib package.
- io.github.roboblazers7617.buttonbox.addresses - package io.github.roboblazers7617.buttonbox.addresses
- io.github.roboblazers7617.buttonbox.controls - package io.github.roboblazers7617.buttonbox.controls
-
Controlclasses included with ButtonBoxLib. - io.github.roboblazers7617.buttonbox.midi - package io.github.roboblazers7617.buttonbox.midi
-
Classes used for interfacing with buttonbox hardware over MIDI.
- io.github.roboblazers7617.buttonbox.midi.controls - package io.github.roboblazers7617.buttonbox.midi.controls
J
- Joystick - Class in io.github.roboblazers7617.buttonbox.controls
-
A joystick with X and Y axes and a momentary button.
- Joystick(String) - Constructor for class io.github.roboblazers7617.buttonbox.controls.Joystick
-
Create a new Joystick.
K
- Knob - Class in io.github.roboblazers7617.buttonbox.controls
-
A knob, fader, encoder, or any other sort of analog control.
- Knob(String) - Constructor for class io.github.roboblazers7617.buttonbox.controls.Knob
-
Creates a new Knob.
L
- LED - Class in io.github.roboblazers7617.buttonbox.controls
-
A single color indicator LED.
- LED(String) - Constructor for class io.github.roboblazers7617.buttonbox.controls.LED
-
Creates a new LED.
- LEDMulticolor - Class in io.github.roboblazers7617.buttonbox.controls
-
A multicolor indicator LED.
- LEDMulticolor(String) - Constructor for class io.github.roboblazers7617.buttonbox.controls.LEDMulticolor
-
Creates a new LED.
M
- MIDIAddress - Class in io.github.roboblazers7617.buttonbox.midi
-
An
DoubleAddressthat sends and recieves data over MIDI. - MIDIAddress(MIDIDevice, int, int, int) - Constructor for class io.github.roboblazers7617.buttonbox.midi.MIDIAddress
-
Creates a new MIDIAddress with the specified command, channel, and data1.
- midiDevice - Variable in class io.github.roboblazers7617.buttonbox.midi.MIDIAddress
-
MIDIDevice to communicate with.
- MIDIDevice - Class in io.github.roboblazers7617.buttonbox.midi
-
A wrapper for
MidiDevicesthat combines recieving and transmitting objects into one object. - MIDIDevice(MidiDevice, MidiDevice) - Constructor for class io.github.roboblazers7617.buttonbox.midi.MIDIDevice
-
Creates a MIDIDevice.
- MIDIRouter - Class in io.github.roboblazers7617.buttonbox.midi
-
Receiverthat routes MIDI messages to theMIDIAddressesassigned to it. - MIDIRouter() - Constructor for class io.github.roboblazers7617.buttonbox.midi.MIDIRouter
- MIDIUtil - Class in io.github.roboblazers7617.buttonbox.midi
-
Some static utility functions for working with MIDI devices.
- MIDIUtil() - Constructor for class io.github.roboblazers7617.buttonbox.midi.MIDIUtil
P
- periodic() - Method in class io.github.roboblazers7617.buttonbox.ButtonBoxClient
-
Updates the states of the controls.
- periodic() - Method in class io.github.roboblazers7617.buttonbox.ButtonBoxServer
- PhysicalButton - Class in io.github.roboblazers7617.buttonbox.controls
-
A button controlled by an
Address. - PhysicalButton(String, DoubleAddress) - Constructor for class io.github.roboblazers7617.buttonbox.controls.PhysicalButton
-
Creates a new PhysicalButton.
- PhysicalEncoder - Class in io.github.roboblazers7617.buttonbox.controls
-
A Knob controlled through Addresses by an Encoder that outputs relative values.
- PhysicalEncoder(String, DoubleAddress) - Constructor for class io.github.roboblazers7617.buttonbox.controls.PhysicalEncoder
-
Creates a new PhysicalPotentiometer.
- PhysicalEncoder.LoopMode - Enum Class in io.github.roboblazers7617.buttonbox.controls
-
Determines if and how out-of-range encoder values should be looped.
- PhysicalJoystick - Class in io.github.roboblazers7617.buttonbox.controls
-
A Joystick controlled through Addresses.
- PhysicalJoystick(String, DoubleAddress, DoubleAddress, DoubleAddress) - Constructor for class io.github.roboblazers7617.buttonbox.controls.PhysicalJoystick
-
Creates a new PhysicalJoystick.
- PhysicalLED - Class in io.github.roboblazers7617.buttonbox.controls
-
A single color LED that sends its brightness to an Address.
- PhysicalLED(String, DoubleAddress) - Constructor for class io.github.roboblazers7617.buttonbox.controls.PhysicalLED
-
Creates a new PhysicalLED.
- PhysicalLEDRGB - Class in io.github.roboblazers7617.buttonbox.controls
-
An RGB LED that sends its RGB components to Addresses.
- PhysicalLEDRGB(String, DoubleAddress, DoubleAddress, DoubleAddress) - Constructor for class io.github.roboblazers7617.buttonbox.controls.PhysicalLEDRGB
-
Creates a new PhysicalLEDRGB.
- PhysicalLEDRGBLaunchpad - Class in io.github.roboblazers7617.buttonbox.midi.controls
-
An RGB LED that sends its RGB components to an address, encoded into the Novation Launchpad's SYSEX data format.
- PhysicalLEDRGBLaunchpad(String, byte, MIDIDevice) - Constructor for class io.github.roboblazers7617.buttonbox.midi.controls.PhysicalLEDRGBLaunchpad
-
Creates a new PhysicalLEDRGBLaunchpad.
- PhysicalPotentiometer - Class in io.github.roboblazers7617.buttonbox.controls
-
A Knob controlled through Addresses by a Potentiometer.
- PhysicalPotentiometer(String, DoubleAddress) - Constructor for class io.github.roboblazers7617.buttonbox.controls.PhysicalPotentiometer
-
Creates a new PhysicalPotentiometer.
- PhysicalTestControl - Class in io.github.roboblazers7617.buttonbox.controls
- PhysicalTestControl(String, DoubleAddress) - Constructor for class io.github.roboblazers7617.buttonbox.controls.PhysicalTestControl
-
Creates a new PhysicalTestControl.
- PUSH - Enum constant in enum class io.github.roboblazers7617.buttonbox.controls.Button.ButtonMode
-
Enabled when pressed, disabled when released.
S
- scaleBrightness(double) - Method in class io.github.roboblazers7617.buttonbox.Color
-
Scales the brightness of the color.
- send(Double) - Method in interface io.github.roboblazers7617.buttonbox.addresses.DoubleAddress
-
Sends data to the address.
- send(Double) - Method in class io.github.roboblazers7617.buttonbox.midi.MIDIAddress
- send(MidiMessage) - Method in class io.github.roboblazers7617.buttonbox.midi.MIDIDevice
-
Sends a message to this device.
- send(MidiMessage, long) - Method in class io.github.roboblazers7617.buttonbox.midi.MIDIRouter
- send(T) - Method in interface io.github.roboblazers7617.buttonbox.Address
-
Sends data to the address.
- sendRaw(int) - Method in class io.github.roboblazers7617.buttonbox.midi.MIDIAddress
-
Sends raw data to the address.
- setBrightness(double) - Method in class io.github.roboblazers7617.buttonbox.controls.LED
-
Sets the brightness of the LED.
- setButton(boolean) - Method in class io.github.roboblazers7617.buttonbox.controls.Joystick
-
Sets whether the joystick button is pressed or not.
- setColor(Color) - Method in class io.github.roboblazers7617.buttonbox.controls.LEDMulticolor
-
Sets the color of the LED from a WPILib
Color. - setColor(Color) - Method in class io.github.roboblazers7617.buttonbox.controls.LEDMulticolor
-
Sets the color of the LED.
- setFeedbackRaw(int) - Method in class io.github.roboblazers7617.buttonbox.midi.MIDIAddress
-
Sets the feedback for the address.
- setFromString(String) - Method in class io.github.roboblazers7617.buttonbox.Color
-
Sets the color from a hex string.
- setLoopMode(PhysicalEncoder.LoopMode) - Method in class io.github.roboblazers7617.buttonbox.controls.PhysicalEncoder
-
Sets the loop mode of the encoder.
- setMode(Button.ButtonMode) - Method in class io.github.roboblazers7617.buttonbox.controls.Button
-
Sets the button's mode.
- setPosition(double) - Method in class io.github.roboblazers7617.buttonbox.controls.Knob
-
Sets the position of the Knob.
- setPressed(boolean) - Method in class io.github.roboblazers7617.buttonbox.controls.Button
-
Sets whether the button is pressed or not.
- setScale(double) - Method in class io.github.roboblazers7617.buttonbox.controls.PhysicalEncoder
-
Sets the scaling of the encoder values.
- setTable(NetworkTable) - Method in class io.github.roboblazers7617.buttonbox.Control
-
Sets the NetworkTable to be used by this Control.
- setupNetworkTables(NetworkTable) - Method in class io.github.roboblazers7617.buttonbox.Control
-
Called by the Control class when the NetworkTable is set by
Control.setTable(NetworkTable). - setupNetworkTables(NetworkTable) - Method in class io.github.roboblazers7617.buttonbox.controls.Button
- setupNetworkTables(NetworkTable) - Method in class io.github.roboblazers7617.buttonbox.controls.Joystick
- setupNetworkTables(NetworkTable) - Method in class io.github.roboblazers7617.buttonbox.controls.Knob
- setupNetworkTables(NetworkTable) - Method in class io.github.roboblazers7617.buttonbox.controls.LED
- setupNetworkTables(NetworkTable) - Method in class io.github.roboblazers7617.buttonbox.controls.LEDMulticolor
- setupNetworkTables(NetworkTable) - Method in class io.github.roboblazers7617.buttonbox.controls.TestControl
- setupSimulation() - Method in class io.github.roboblazers7617.buttonbox.Control
-
Should set up any simulation-specific things.
- setupSimulation() - Method in class io.github.roboblazers7617.buttonbox.controls.Button
- setupSimulation() - Method in class io.github.roboblazers7617.buttonbox.controls.Joystick
- setupSimulation() - Method in class io.github.roboblazers7617.buttonbox.controls.Knob
- setupSimulation() - Method in class io.github.roboblazers7617.buttonbox.controls.LED
- setupSimulation() - Method in class io.github.roboblazers7617.buttonbox.controls.TestControl
- setX(double) - Method in class io.github.roboblazers7617.buttonbox.controls.Joystick
-
Sets the X axis value.
- setY(double) - Method in class io.github.roboblazers7617.buttonbox.controls.Joystick
-
Sets the Y axis value.
T
- TestControl - Class in io.github.roboblazers7617.buttonbox.controls
-
A test
Controlthat sends a float that is increased every time server feedback is updated and outputs it to the client TTY. - TestControl(String) - Constructor for class io.github.roboblazers7617.buttonbox.controls.TestControl
-
Creates a new TestControl.
- TOGGLE_FALLING - Enum constant in enum class io.github.roboblazers7617.buttonbox.controls.Button.ButtonMode
-
Toggle button, triggers on the falling edge.
- TOGGLE_RISING - Enum constant in enum class io.github.roboblazers7617.buttonbox.controls.Button.ButtonMode
-
Toggle button, triggers on the rising edge.
- toHexString() - Method in class io.github.roboblazers7617.buttonbox.Color
-
Gets this color as a hex string.
U
- updateClient() - Method in class io.github.roboblazers7617.buttonbox.Control
-
Updates the control's state on the client.
- updateClient() - Method in class io.github.roboblazers7617.buttonbox.controls.Button
- updateClient() - Method in class io.github.roboblazers7617.buttonbox.controls.Joystick
- updateClient() - Method in class io.github.roboblazers7617.buttonbox.controls.Knob
- updateClient() - Method in class io.github.roboblazers7617.buttonbox.controls.LED
- updateClient() - Method in class io.github.roboblazers7617.buttonbox.controls.LEDMulticolor
- updateClient() - Method in class io.github.roboblazers7617.buttonbox.controls.PhysicalButton
- updateClient() - Method in class io.github.roboblazers7617.buttonbox.controls.PhysicalEncoder
- updateClient() - Method in class io.github.roboblazers7617.buttonbox.controls.PhysicalJoystick
- updateClient() - Method in class io.github.roboblazers7617.buttonbox.controls.PhysicalPotentiometer
- updateClient() - Method in class io.github.roboblazers7617.buttonbox.controls.TestControl
- updateHardware() - Method in class io.github.roboblazers7617.buttonbox.Control
-
Interfaces with the buttonbox hardware and updates the state of the physical control.
- updateHardware() - Method in class io.github.roboblazers7617.buttonbox.controls.PhysicalLED
- updateHardware() - Method in class io.github.roboblazers7617.buttonbox.controls.PhysicalLEDRGB
- updateHardware() - Method in class io.github.roboblazers7617.buttonbox.controls.PhysicalTestControl
- updateHardware() - Method in class io.github.roboblazers7617.buttonbox.controls.TestControl
- updateHardware() - Method in class io.github.roboblazers7617.buttonbox.midi.controls.PhysicalLEDRGBLaunchpad
- updateOnClient() - Method in class io.github.roboblazers7617.buttonbox.Control
-
Updates the control's state on the client and hardware.
- updateServer() - Method in class io.github.roboblazers7617.buttonbox.Control
-
Updates the control's state on the server.
- updateServer() - Method in class io.github.roboblazers7617.buttonbox.controls.Button
- updateServer() - Method in class io.github.roboblazers7617.buttonbox.controls.Joystick
- updateServer() - Method in class io.github.roboblazers7617.buttonbox.controls.Knob
- updateServer() - Method in class io.github.roboblazers7617.buttonbox.controls.LED
- updateServer() - Method in class io.github.roboblazers7617.buttonbox.controls.TestControl
V
- valueOf(String) - Static method in enum class io.github.roboblazers7617.buttonbox.controls.Button.ButtonMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.roboblazers7617.buttonbox.controls.PhysicalEncoder.LoopMode
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.github.roboblazers7617.buttonbox.controls.Button.ButtonMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.roboblazers7617.buttonbox.controls.PhysicalEncoder.LoopMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- WRAP - Enum constant in enum class io.github.roboblazers7617.buttonbox.controls.PhysicalEncoder.LoopMode
-
Loop values.
All Classes and Interfaces|All Packages