Package com.ctre.phoenixpro.configs
Class MagnetSensorConfigs
java.lang.Object
com.ctre.phoenixpro.configs.MagnetSensorConfigs
- All Implemented Interfaces:
ParentConfiguration
,ISerializable
@Deprecated(forRemoval=true) public class MagnetSensorConfigs 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 affect the magnet sensor and how to interpret it.
Includes sensor range and other configs related to sensor.
-
Field Summary
Fields Modifier and Type Field Description AbsoluteSensorRangeValue
AbsoluteSensorRange
Deprecated, for removal: This API element is subject to removal in a future version.The range of the absolute sensor, either [0, 1) or [-0.5, 0.5).double
MagnetOffset
Deprecated, for removal: This API element is subject to removal in a future version.This offset is added to the reported position, allowing the application to trim the zero position.SensorDirectionValue
SensorDirection
Deprecated, for removal: This API element is subject to removal in a future version.Direction of the sensor to determine positive facing the LED side of the CANcoder. -
Constructor Summary
Constructors Constructor Description MagnetSensorConfigs()
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
-
SensorDirection
Deprecated, for removal: This API element is subject to removal in a future version.Direction of the sensor to determine positive facing the LED side of the CANcoder. -
MagnetOffset
Deprecated, for removal: This API element is subject to removal in a future version.This offset is added to the reported position, allowing the application to trim the zero position. When set to the default value of zero, position reports zero when magnet north pole aligns with the LED.- Minimum Value: -1
- Maximum Value: 1
- Default Value: 0
- Units: rotations
-
AbsoluteSensorRange
Deprecated, for removal: This API element is subject to removal in a future version.The range of the absolute sensor, either [0, 1) or [-0.5, 0.5).
-
-
Constructor Details
-
MagnetSensorConfigs
public MagnetSensorConfigs()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
-