Package io.github.roboblazers7617.buttonbox.controls

Class Knob

java.lang.Object
io.github.roboblazers7617.buttonbox.Control
io.github.roboblazers7617.buttonbox.controls.Knob
Direct Known Subclasses:
PhysicalEncoder, PhysicalPotentiometer
public class Knob extends Control
A knob, fader, encoder, or any other sort of analog control.

  • Constructor Details

    • Knob

      public Knob(String id)
      Creates a new Knob.
      Parameters:
      id - The ID string for the Knob to use.
      See Also:

  • Method Details

    • setupSimulation

      public void setupSimulation()
      Description copied from class: Control
      Should set up any simulation-specific things.

      Called as a part of the constructor if the library is running in simulation.

      Overrides:
      setupSimulation in class Control

    • setupNetworkTables

      public void setupNetworkTables(NetworkTable table)
      Description copied from class: Control
      Called by the Control class when the NetworkTable is set by Control.setTable(NetworkTable). intended to be called outside of the class.

      This should create all of the NetworkTables publishers and subscribers for the inheritting class.

      Overrides:
      setupNetworkTables in class Control
      Parameters:
      table - The table to use. When called by Control.setTable(NetworkTable), this is a subtable with the ID string as its key.

    • updateServer

      public void updateServer()
      Description copied from class: Control
      Updates the control's state on the server.

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

      Overrides:
      updateServer in class Control

    • 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 Control

    • getPosition

      public double getPosition()
      Gets the position of the Knob.
      Returns:
      The current position of the Knob [0-1].

    • setPosition

      public void setPosition(double position)
      Sets the position of the Knob. Published to NetworkTables immediately.
      Parameters:
      position - The position to set.