edu.wpi.first.wpilibj

Class DigitalInput

java.lang.Object

edu.wpi.first.wpilibj.SensorBase

edu.wpi.first.wpilibj.InterruptableSensorBase

edu.wpi.first.wpilibj.DigitalSource

edu.wpi.first.wpilibj.DigitalInput

All Implemented Interfaces:

LiveWindowSendable, Sendable

public class DigitalInput
extends DigitalSource
implements LiveWindowSendable

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.

Field Summary

Fields inherited from class edu.wpi.first.wpilibj.DigitalSource

channels, m_channel, m_port

Fields inherited from class edu.wpi.first.wpilibj.InterruptableSensorBase

interrupts, m_interrupt, m_interruptIndex, m_isSynchronousInterrupt

Fields inherited from class edu.wpi.first.wpilibj.SensorBase

kAnalogInputChannels, kAnalogOutputChannels, kDigitalChannels, kPDPChannels, kPwmChannels, kRelayChannels, kSolenoidChannels, kSolenoidModules, kSystemClockTicksPerMicrosecond

Constructor Summary

Constructors

Constructor and Description
DigitalInput(int channel) Create an instance of a Digital Input class.

Method Summary

Modifier and Type	Method and Description
boolean	get() Get the value from a digital input channel.
boolean	getAnalogTriggerForRouting() Is this an analog trigger
int	getChannel() Get the channel of the digital input
String	getSmartDashboardType()
edu.wpi.first.wpilibj.tables.ITable	getTable()
void	initTable(edu.wpi.first.wpilibj.tables.ITable subtable) Initializes a table for this sendable object.
void	startLiveWindowMode() Start having this sendable object automatically respond to value changes reflect the value on the table.
void	stopLiveWindowMode() Stop having this sendable object automatically respond to value changes.
void	updateTable() Update the table for this sendable object with the latest values.

Methods inherited from class edu.wpi.first.wpilibj.DigitalSource

free, getChannelForRouting, getModuleForRouting, initDigitalPort

Methods inherited from class edu.wpi.first.wpilibj.InterruptableSensorBase

allocateInterrupts, cancelInterrupts, disableInterrupts, enableInterrupts, readFallingTimestamp, readRisingTimestamp, requestInterrupts, requestInterrupts, setUpSourceEdge, waitForInterrupt, waitForInterrupt

Methods inherited from class edu.wpi.first.wpilibj.SensorBase

checkAnalogInputChannel, checkAnalogOutputChannel, checkDigitalChannel, checkPDPChannel, checkPWMChannel, checkRelayChannel, checkSolenoidChannel, checkSolenoidModule, getDefaultSolenoidModule, setDefaultSolenoidModule

Methods inherited from class java.lang.Object

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

Constructor Detail

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 Detail

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.

getAnalogTriggerForRouting

public boolean getAnalogTriggerForRouting()

Description copied from class: DigitalSource

Is this an analog trigger

Overrides:

getAnalogTriggerForRouting in class DigitalSource

Returns:

true if this is an analog trigger

getSmartDashboardType

public String getSmartDashboardType()

Specified by:

getSmartDashboardType in interface Sendable

Returns:

the string representation of the named data type that will be used by the smart dashboard for this sendable

initTable

public void initTable(edu.wpi.first.wpilibj.tables.ITable subtable)

Initializes a table for this sendable object.

Specified by:

initTable in interface Sendable

Parameters:

subtable - The table to put the values in.

updateTable

public void updateTable()

Update the table for this sendable object with the latest values.

Specified by:

updateTable in interface LiveWindowSendable

getTable

public edu.wpi.first.wpilibj.tables.ITable getTable()

Specified by:

getTable in interface Sendable

Returns:

the table that is currently associated with the sendable

startLiveWindowMode

public void startLiveWindowMode()

Start having this sendable object automatically respond to value changes reflect the value on the table.

Specified by:

startLiveWindowMode in interface LiveWindowSendable

stopLiveWindowMode

public void stopLiveWindowMode()

Stop having this sendable object automatically respond to value changes.

Specified by:

stopLiveWindowMode in interface LiveWindowSendable