ctre::phoenix6::configs::Pigeon2FeaturesConfigs Class Reference

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

#include <ctre/phoenix6/configs/Configs.hpp>

Inheritance diagram for ctre::phoenix6::configs::Pigeon2FeaturesConfigs:

Public Member Functions
constexpr	Pigeon2FeaturesConfigs ()=default
constexpr Pigeon2FeaturesConfigs &	WithEnableCompass (bool newEnableCompass)
	Modifies this configuration's EnableCompass parameter and returns itself for method-chaining and easier to use config API.
constexpr Pigeon2FeaturesConfigs &	WithDisableTemperatureCompensation (bool newDisableTemperatureCompensation)
	Modifies this configuration's DisableTemperatureCompensation parameter and returns itself for method-chaining and easier to use config API.
constexpr Pigeon2FeaturesConfigs &	WithDisableNoMotionCalibration (bool newDisableNoMotionCalibration)
	Modifies this configuration's DisableNoMotionCalibration parameter and returns itself for method-chaining and easier to use config API.
std::string	ToString () const override
std::string	Serialize () const override
ctre::phoenix::StatusCode	Deserialize (const std::string &to_deserialize) override
Public Member Functions inherited from ctre::phoenix6::configs::ParentConfiguration
Public Member Functions inherited from ctre::phoenix6::ISerializable

Public Attributes
bool	EnableCompass = false
	Turns on or off the magnetometer fusing for 9-axis.
bool	DisableTemperatureCompensation = false
	Disables using the temperature compensation feature.
bool	DisableNoMotionCalibration = false
	Disables using the no-motion calibration feature.

Detailed Description

Configs to enable/disable various features of the Pigeon2.

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

Constructor & Destructor Documentation

Pigeon2FeaturesConfigs()

ctre::phoenix6::configs::Pigeon2FeaturesConfigs::Pigeon2FeaturesConfigs ( )

constexprdefault

Member Function Documentation

Deserialize()

ctre::phoenix::StatusCode ctre::phoenix6::configs::Pigeon2FeaturesConfigs::Deserialize ( const std::string & to_deserialize )

inlineoverridevirtual

Implements ctre::phoenix6::configs::ParentConfiguration.

Serialize()

std::string ctre::phoenix6::configs::Pigeon2FeaturesConfigs::Serialize ( ) const

inlineoverridevirtual

Implements ctre::phoenix6::ISerializable.

ToString()

std::string ctre::phoenix6::configs::Pigeon2FeaturesConfigs::ToString ( ) const

inlineoverridevirtual

Implements ctre::phoenix6::configs::ParentConfiguration.

WithDisableNoMotionCalibration()

Pigeon2FeaturesConfigs & ctre::phoenix6::configs::Pigeon2FeaturesConfigs::WithDisableNoMotionCalibration ( bool newDisableNoMotionCalibration )

inlineconstexpr

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

WithDisableTemperatureCompensation()

Pigeon2FeaturesConfigs & ctre::phoenix6::configs::Pigeon2FeaturesConfigs::WithDisableTemperatureCompensation ( bool newDisableTemperatureCompensation )

inlineconstexpr

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

WithEnableCompass()

Pigeon2FeaturesConfigs & ctre::phoenix6::configs::Pigeon2FeaturesConfigs::WithEnableCompass ( bool newEnableCompass )

inlineconstexpr

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

Member Data Documentation

DisableNoMotionCalibration

bool ctre::phoenix6::configs::Pigeon2FeaturesConfigs::DisableNoMotionCalibration = false

Disables using the no-motion calibration feature.

• Default Value: False

DisableTemperatureCompensation

bool ctre::phoenix6::configs::Pigeon2FeaturesConfigs::DisableTemperatureCompensation = false

Disables using the temperature compensation feature.

• Default Value: False

EnableCompass

bool ctre::phoenix6::configs::Pigeon2FeaturesConfigs::EnableCompass = false

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

---

The documentation for this class was generated from the following file:

• ctre/phoenix6/configs/Configs.hpp