Package io.github.roboblazers7617.buttonbox.controls

Class PhysicalEncoder

java.lang.Object

io.github.roboblazers7617.buttonbox.Control

io.github.roboblazers7617.buttonbox.controls.Knob

io.github.roboblazers7617.buttonbox.controls.PhysicalEncoder

public class PhysicalEncoder
extends Knob

A Knob controlled through Addresses by an Encoder that outputs relative values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PhysicalEncoder.LoopMode	Determines if and how out-of-range encoder values should be looped.

Constructor Summary

Constructors

Constructor	Description
PhysicalEncoder(String id, DoubleAddress positionAddress)	Creates a new PhysicalPotentiometer.

Method Summary

Modifier and Type	Method	Description
PhysicalEncoder	setLoopMode(PhysicalEncoder.LoopMode mode)	Sets the loop mode of the encoder.
PhysicalEncoder	setScale(double scale)	Sets the scaling of the encoder values.
void	updateClient()	Updates the control's state on the client.

Methods inherited from class io.github.roboblazers7617.buttonbox.controls.Knob

getPosition, setPosition, setupNetworkTables, setupSimulation, updateServer

Methods inherited from class io.github.roboblazers7617.buttonbox.Control

getId, getTable, setTable, updateHardware, updateOnClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PhysicalEncoder

public PhysicalEncoder(String id,
 DoubleAddress positionAddress)

Creates a new PhysicalPotentiometer.

Parameters:

id - The ID string for the PhysicalPotentiometer to use.

positionAddress - The Address used for the position. A value of 0.5 is the center, values above that are movement in the positive direction, and values below that are movement in the negative direction.

Method Details

updateClient

public void updateClient()

Description copied from class: Control

Updates the control's state on the client. This should get any feedback from the server, but this should not interface with the buttonbox hardware.

This doesn't do anything by default, and should be overridden by the class inheritting this.

Overrides:

updateClient in class Knob

setLoopMode

public PhysicalEncoder setLoopMode(PhysicalEncoder.LoopMode mode)

Sets the loop mode of the encoder.

Parameters:

mode - Mode to set.

Returns:

The modified object for method chaining.

setScale

public PhysicalEncoder setScale(double scale)

Sets the scaling of the encoder values.

Parameters:

scale - Scale to set.

Returns:

The modified object for method chaining.