Package com.ctre.phoenixpro.configs
Class HardwareLimitSwitchConfigs
java.lang.Object
com.ctre.phoenixpro.configs.HardwareLimitSwitchConfigs
- All Implemented Interfaces:
ParentConfiguration
,ISerializable
@Deprecated(forRemoval=true) public class HardwareLimitSwitchConfigs extends Object implements ParentConfiguration
Deprecated, for removal: This API element is subject to removal in a future version.
Classes in the phoenixpro package will be removed in 2024.
Users should instead use classes from the phoenix6 package.
Configs that directly affect motor-output.
Includes Motor Invert and various limit features.
-
Field Summary
Fields Modifier and Type Field Description boolean
ForwardLimitAutosetPositionEnable
Deprecated, for removal: This API element is subject to removal in a future version.If enabled, the position is auto-set to a specific value, specified by ForwardLimitAutosetPositionValue Default Value: Falsedouble
ForwardLimitAutosetPositionValue
Deprecated, for removal: This API element is subject to removal in a future version.The value to auto-set the position to.boolean
ForwardLimitEnable
Deprecated, for removal: This API element is subject to removal in a future version.If enabled, motor output is set to neutral when forward limit switch is asseted and positive output is requested.int
ForwardLimitRemoteSensorID
Deprecated, for removal: This API element is subject to removal in a future version.Device ID of the device if using remote limit switch features.ForwardLimitSourceValue
ForwardLimitSource
Deprecated, for removal: This API element is subject to removal in a future version.Determines where to poll the forward limit switch.ForwardLimitTypeValue
ForwardLimitType
Deprecated, for removal: This API element is subject to removal in a future version.Determines if limit is normally-open (default) or normally-closed.boolean
ReverseLimitAutosetPositionEnable
Deprecated, for removal: This API element is subject to removal in a future version.If enabled, the position is auto-set to a specific value, specified by ReverseLimitAutosetPositionValue Default Value: Falsedouble
ReverseLimitAutosetPositionValue
Deprecated, for removal: This API element is subject to removal in a future version.The value to auto-set the position to.boolean
ReverseLimitEnable
Deprecated, for removal: This API element is subject to removal in a future version.If enabled, motor output is set to neutral when reverse limit switch is asseted and positive output is requested.int
ReverseLimitRemoteSensorID
Deprecated, for removal: This API element is subject to removal in a future version.Device ID of the device if using remote limit switch features.ReverseLimitSourceValue
ReverseLimitSource
Deprecated, for removal: This API element is subject to removal in a future version.Determines where to poll the reverse limit switch.ReverseLimitTypeValue
ReverseLimitType
Deprecated, for removal: This API element is subject to removal in a future version.Determines if limit is normally-open (default) or normally-closed. -
Constructor Summary
Constructors Constructor Description HardwareLimitSwitchConfigs()
Deprecated, for removal: This API element is subject to removal in a future version. -
Method Summary
Modifier and Type Method Description StatusCode
deserialize(String string)
Deprecated, for removal: This API element is subject to removal in a future version.String
serialize()
Deprecated, for removal: This API element is subject to removal in a future version.String
toString()
Deprecated, for removal: This API element is subject to removal in a future version.
-
Field Details
-
ForwardLimitType
Deprecated, for removal: This API element is subject to removal in a future version.Determines if limit is normally-open (default) or normally-closed. -
ForwardLimitAutosetPositionEnable
Deprecated, for removal: This API element is subject to removal in a future version.If enabled, the position is auto-set to a specific value, specified by ForwardLimitAutosetPositionValue- Default Value: False
-
ForwardLimitAutosetPositionValue
Deprecated, for removal: This API element is subject to removal in a future version.The value to auto-set the position to. This has no effect if ForwardLimitAutosetPositionEnable is false.- Minimum Value: -3.4e+38
- Maximum Value: 3.4e+38
- Default Value: 0
- Units: rotations
-
ForwardLimitEnable
Deprecated, for removal: This API element is subject to removal in a future version.If enabled, motor output is set to neutral when forward limit switch is asseted and positive output is requested.- Default Value: True
-
ForwardLimitSource
Deprecated, for removal: This API element is subject to removal in a future version.Determines where to poll the forward limit switch. This defaults to the limit switch pin on the limit switch connector. -
ForwardLimitRemoteSensorID
Deprecated, for removal: This API element is subject to removal in a future version.Device ID of the device if using remote limit switch features.- Minimum Value: 0
- Maximum Value: 62
- Default Value: 0
- Units:
-
ReverseLimitType
Deprecated, for removal: This API element is subject to removal in a future version.Determines if limit is normally-open (default) or normally-closed. -
ReverseLimitAutosetPositionEnable
Deprecated, for removal: This API element is subject to removal in a future version.If enabled, the position is auto-set to a specific value, specified by ReverseLimitAutosetPositionValue- Default Value: False
-
ReverseLimitAutosetPositionValue
Deprecated, for removal: This API element is subject to removal in a future version.The value to auto-set the position to. This has no effect if ReverseLimitAutosetPositionEnable is false.- Minimum Value: -3.4e+38
- Maximum Value: 3.4e+38
- Default Value: 0
- Units: rotations
-
ReverseLimitEnable
Deprecated, for removal: This API element is subject to removal in a future version.If enabled, motor output is set to neutral when reverse limit switch is asseted and positive output is requested.- Default Value: True
-
ReverseLimitSource
Deprecated, for removal: This API element is subject to removal in a future version.Determines where to poll the reverse limit switch. This defaults to the limit switch pin on the limit switch connector. -
ReverseLimitRemoteSensorID
Deprecated, for removal: This API element is subject to removal in a future version.Device ID of the device if using remote limit switch features.- Minimum Value: 0
- Maximum Value: 62
- Default Value: 0
- Units:
-
-
Constructor Details
-
HardwareLimitSwitchConfigs
public HardwareLimitSwitchConfigs()Deprecated, for removal: This API element is subject to removal in a future version.
-
-
Method Details
-
toString
Deprecated, for removal: This API element is subject to removal in a future version. -
deserialize
Deprecated, for removal: This API element is subject to removal in a future version.- Specified by:
deserialize
in interfaceParentConfiguration
-
serialize
Deprecated, for removal: This API element is subject to removal in a future version.- Specified by:
serialize
in interfaceISerializable
-