Pigeon2Configuration Class

[Missing <summary> documentation for "T:CTRE.Phoenix6.Configs.Pigeon2Configuration"]

Definition

Namespace: CTRE.Phoenix6.Configs
Assembly: Phoenix6 (in Phoenix6.dll) Version: 1.0.0
C#
public class Pigeon2Configuration
Inheritance
Object    Pigeon2Configuration

Constructors

Pigeon2ConfigurationInitializes a new instance of the Pigeon2Configuration class

Properties

FutureProofConfigs True if we should factory default newer unsupported configs, false to leave newer unsupported configs alone.

This flag addresses a corner case where the device may have firmware with newer configs that didn't exist when this version of the API was built. If this occurs and this flag is true, unsupported new configs will be factory defaulted to avoid unexpected behavior.

This is also the behavior in Phoenix 5, so this flag is defaulted to true to match.

Methods

Deserialize 
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Serialize 
ToString Provides the string representation of this object
(Overrides ObjectToString)

Fields

GyroTrim Configs to trim the Pigeon2's gyroscope.

Pigeon2 allows the user to trim the gyroscope's sensitivity. While this isn't necessary for the Pigeon2, as it comes calibrated out-of-the-box, users can make use of this to make the Pigeon2 even more accurate for their application.

MountPose Configs for Pigeon 2's Mount Pose configuration.

These configs allow the Pigeon2 to be mounted in whatever orientation that's desired and ensure the reported Yaw/Pitch/Roll is from the robot's reference.

Pigeon2Features Configs to enable/disable various features of the Pigeon2.

These configs allow the user to enable or disable various aspects of the Pigeon2.

See Also