Class Pigeon2FeaturesConfigs
Configs to enable/disable various features of the Pigeon2.
These configs allow the user to enable or disable various aspects of the Pigeon2.public class Pigeon2FeaturesConfigs : IParentConfiguration, ISerializable, ICloneable
- Inheritance
-
Pigeon2FeaturesConfigs
- Implements
- Inherited Members
Fields
DisableNoMotionCalibration
Disables using the no-motion calibration feature.
- Default ValueFalse
public bool DisableNoMotionCalibration
Field Value
DisableTemperatureCompensation
Disables using the temperature compensation feature.
- Default ValueFalse
public bool DisableTemperatureCompensation
Field Value
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 ValueFalse
public bool EnableCompass
Field Value
Methods
Clone()
Creates a copy of this config group.
public Pigeon2FeaturesConfigs Clone()
Returns
Deserialize(string)
Deserialize string and put values into this object
public StatusCode Deserialize(string to_deserialize)
Parameters
to_deserializestringString to deserialize
Returns
- StatusCode
OK if deserialization is OK
Serialize()
Serialize this object into a string
public string Serialize()
Returns
- string
This object's data serialized into a string
ToString()
Provides the string representation of this object
public override string ToString()
Returns
WithDisableNoMotionCalibration(bool)
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 ValueFalse
public Pigeon2FeaturesConfigs WithDisableNoMotionCalibration(bool newDisableNoMotionCalibration)
Parameters
newDisableNoMotionCalibrationboolParameter to modify
Returns
- Pigeon2FeaturesConfigs
Itself
WithDisableTemperatureCompensation(bool)
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 ValueFalse
public Pigeon2FeaturesConfigs WithDisableTemperatureCompensation(bool newDisableTemperatureCompensation)
Parameters
newDisableTemperatureCompensationboolParameter to modify
Returns
- Pigeon2FeaturesConfigs
Itself
WithEnableCompass(bool)
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 ValueFalse
public Pigeon2FeaturesConfigs WithEnableCompass(bool newEnableCompass)
Parameters
newEnableCompassboolParameter to modify
Returns
- Pigeon2FeaturesConfigs
Itself