Package com.ctre.phoenix6.configs
Class Pigeon2FeaturesConfigs
java.lang.Object
com.ctre.phoenix6.configs.Pigeon2FeaturesConfigs
- All Implemented Interfaces:
ParentConfiguration,ISerializable,Cloneable
Configs to enable/disable various features of the Pigeon2.
These configs allow the user to enable or disable various aspects of the Pigeon2.
-
Field Summary
FieldsModifier and TypeFieldDescriptionbooleanDisables using the no-motion calibration feature.booleanDisables using the temperature compensation feature.booleanTurns on or off the magnetometer fusing for 9-axis. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()final StatusCodedeserialize(String to_deserialize) Take a string and deserialize it to this configuration group.final StringGet the serialized form of this configuration group.toString()final Pigeon2FeaturesConfigswithDisableNoMotionCalibration(boolean newDisableNoMotionCalibration) Modifies this configuration's DisableNoMotionCalibration parameter and returns itself for method-chaining and easier to use config API.final Pigeon2FeaturesConfigswithDisableTemperatureCompensation(boolean newDisableTemperatureCompensation) Modifies this configuration's DisableTemperatureCompensation parameter and returns itself for method-chaining and easier to use config API.final Pigeon2FeaturesConfigswithEnableCompass(boolean newEnableCompass) Modifies this configuration's EnableCompass parameter and returns itself for method-chaining and easier to use config API.
-
Field Details
-
EnableCompass
Turns on or off the magnetometer fusing for 9-axis. FRC users are not recommended to turn this on, as the magnetic influence of the robot will likely negatively affect the performance of the Pigeon2.- Default Value: False
-
DisableTemperatureCompensation
Disables using the temperature compensation feature.- Default Value: False
-
DisableNoMotionCalibration
Disables using the no-motion calibration feature.- Default Value: False
-
-
Constructor Details
-
Pigeon2FeaturesConfigs
public Pigeon2FeaturesConfigs()
-
-
Method Details
-
withEnableCompass
Modifies this configuration's EnableCompass parameter and returns itself for method-chaining and easier to use config API.Turns on or off the magnetometer fusing for 9-axis. FRC users are not recommended to turn this on, as the magnetic influence of the robot will likely negatively affect the performance of the Pigeon2.
- Default Value: False
- Parameters:
newEnableCompass- Parameter to modify- Returns:
- Itself
-
withDisableTemperatureCompensation
public final Pigeon2FeaturesConfigs withDisableTemperatureCompensation(boolean newDisableTemperatureCompensation) Modifies this configuration's DisableTemperatureCompensation parameter and returns itself for method-chaining and easier to use config API.Disables using the temperature compensation feature.
- Default Value: False
- Parameters:
newDisableTemperatureCompensation- Parameter to modify- Returns:
- Itself
-
withDisableNoMotionCalibration
public final Pigeon2FeaturesConfigs withDisableNoMotionCalibration(boolean newDisableNoMotionCalibration) Modifies this configuration's DisableNoMotionCalibration parameter and returns itself for method-chaining and easier to use config API.Disables using the no-motion calibration feature.
- Default Value: False
- Parameters:
newDisableNoMotionCalibration- Parameter to modify- Returns:
- Itself
-
toString
-
serialize
Get the serialized form of this configuration group.- Specified by:
serializein interfaceISerializable- Returns:
- Serialized form of this config group
-
deserialize
Take a string and deserialize it to this configuration group.- Specified by:
deserializein interfaceParentConfiguration- Returns:
- Return code of the deserialize method
-
clone
-