Class DigitalInput

java.lang.Object
edu.wpi.first.wpilibj.DigitalInput
All Implemented Interfaces:
Sendable, AutoCloseable

public class DigitalInput extends Object implements AutoCloseable, Sendable
Class to read a digital input. This class will read digital inputs and return the current value on the channel. Other devices such as encoders, gear tooth sensors, etc. that are implemented elsewhere will automatically allocate digital inputs and outputs as required. This class is only for devices like switches etc. that aren't implemented anywhere else.
  • Constructor Details

    • DigitalInput

      public DigitalInput(int channel)
      Create an instance of a Digital Input class. Creates a digital input given a channel.
      Parameters:
      channel - the DIO channel for the digital input 0-9 are on-board, 10-25 are on the MXP
  • Method Details

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
    • get

      public boolean get()
      Get the value from a digital input channel. Retrieve the value of a single digital input channel from the FPGA.
      Returns:
      the status of the digital input
    • getChannel

      public int getChannel()
      Get the channel of the digital input.
      Returns:
      The GPIO channel number that this object represents.
    • setSimDevice

      public void setSimDevice(SimDevice device)
      Indicates this input is used by a simulated device.
      Parameters:
      device - simulated device handle
    • initSendable

      public void initSendable(SendableBuilder builder)
      Description copied from interface: Sendable
      Initializes this Sendable object.
      Specified by:
      initSendable in interface Sendable
      Parameters:
      builder - sendable builder