edu.wpi.first.wpilibj

Class DigitalInput

java.lang.Object

edu.wpi.first.wpilibj.SendableBase

edu.wpi.first.wpilibj.SensorBase

edu.wpi.first.wpilibj.InterruptableSensorBase

edu.wpi.first.wpilibj.DigitalSource

edu.wpi.first.wpilibj.DigitalInput

All Implemented Interfaces:

Sendable

public class DigitalInput
extends DigitalSource
implements 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.

Nested Class Summary

Nested classes/interfaces inherited from class edu.wpi.first.wpilibj.InterruptableSensorBase

InterruptableSensorBase.WaitResult

Field Summary

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

m_interrupt, m_isSynchronousInterrupt

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

kAnalogInputChannels, kAnalogOutputChannels, kDigitalChannels, kPCMModules, kPDPChannels, kPDPModules, kPwmChannels, kRelayChannels, kSolenoidChannels, 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
void	free() Frees the resources for this output.
boolean	get() Get the value from a digital input channel.
int	getAnalogTriggerTypeForRouting() Get the analog trigger type.
int	getChannel() Get the channel of the digital input.
int	getPortHandleForRouting() Get the HAL Port Handle.
void	initSendable(SendableBuilder builder) Initializes this Sendable object.
boolean	isAnalogTrigger() Is this an analog trigger.

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, checkPDPModule, checkPWMChannel, checkRelayChannel, checkSolenoidChannel, checkSolenoidModule, getDefaultSolenoidModule, setDefaultSolenoidModule

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

addChild, getName, getSubsystem, setName, setName, setName, setSubsystem

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.wpi.first.wpilibj.Sendable

getName, getSubsystem, setName, setName, setSubsystem

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

free

public void free()

Frees the resources for this output.

Overrides:

free in class InterruptableSensorBase

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.

Specified by:

getChannel in class DigitalSource

Returns:

The GPIO channel number that this object represents.

getAnalogTriggerTypeForRouting

public int getAnalogTriggerTypeForRouting()

Get the analog trigger type.

Specified by:

getAnalogTriggerTypeForRouting in class InterruptableSensorBase

Returns:

false

isAnalogTrigger

public boolean isAnalogTrigger()

Is this an analog trigger.

Specified by:

isAnalogTrigger in class DigitalSource

Returns:

true if this is an analog trigger

getPortHandleForRouting

public int getPortHandleForRouting()

Get the HAL Port Handle.

Specified by:

getPortHandleForRouting in class InterruptableSensorBase

Returns:

The HAL Handle to the specified source.

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