CANDigitalInput

All Known Implementing Classes:: SparkMaxLimitSwitch

@Deprecated(forRemoval=true) public interface CANDigitalInput

Deprecated, for removal: This API element is subject to removal in a future version.

Use SparkMaxLimitSwitch instead.

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static enum

CANDigitalInput.LimitSwitchPolarity

Deprecated, for removal: This API element is subject to removal in a future version.
Use SparkMaxLimitSwitch.Type instead.
Method Summary

Modifier and Type

Method

Description

REVLibError

enableLimitSwitch(boolean enable)

Deprecated, for removal: This API element is subject to removal in a future version.

Enables or disables controller shutdown based on limit switch.

boolean

get()

Deprecated, for removal: This API element is subject to removal in a future version.

Returns true if the limit switch is pressed, based on the selected polarity.

boolean

isLimitSwitchEnabled()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details
- get
  
  boolean get()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Returns true if the limit switch is pressed, based on the selected polarity.
  This method works even if the limit switch is not enabled.
  
  Returns:
  
  true if the limit switch is pressed
- enableLimitSwitch
  
  REVLibError enableLimitSwitch(boolean enable)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Enables or disables controller shutdown based on limit switch.
  
  Parameters:
  
  enable - Enable/disable motor shutdown based on limit switch state. This does not affect the result of the get() command.
  
  Returns:
  
  REVLibError.kOk if successful
- isLimitSwitchEnabled
  
  boolean isLimitSwitchEnabled()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Returns:
  
  true if limit switch is enabled