Class description for the Pigeon 2 IMU sensor that measures orientation. More...
#include <ctre/phoenixpro/core/CorePigeon2.hpp>
Public Member Functions | |
| std::string | ToString () const |
| Get the string representation of this configuration. More... | |
| std::string | Serialize () const |
| Get the serialized form of this configuration. More... | |
| ctre::phoenix::StatusCode | Deserialize (const std::string &string) |
| Take a string and deserialize it to this configuration. More... | |
| virtual std::string | ToString () const =0 |
| virtual ctre::phoenix::StatusCode | Deserialize (const std::string &string)=0 |
| virtual std::string | Serialize () const =0 |
Public Attributes | |
| bool | FutureProofConfigs {true} |
| True if we should factory default newer unsupported configs, false to leave newer unsupported configs alone. More... | |
| MountPoseConfigs | MountPose |
| Configs for Pigeon 2's Mount Pose configuration. More... | |
| GyroTrimConfigs | GyroTrim |
| Configs to trim the Pigeon2's gyroscope. More... | |
| Pigeon2FeaturesConfigs | Pigeon2Features |
| Configs to enable/disable various features of the Pigeon2. More... | |
Detailed Description
Class description for the Pigeon 2 IMU sensor that measures orientation.
This handles the configurations for the hardware::Pigeon2
Member Function Documentation
◆ Deserialize()
|
inlinevirtual |
Take a string and deserialize it to this configuration.
Implements ctre::phoenixpro::configs::ParentConfiguration.
◆ Serialize()
|
inlinevirtual |
Get the serialized form of this configuration.
Implements ctre::phoenixpro::ISerializable.
◆ ToString()
|
inlinevirtual |
Get the string representation of this configuration.
Implements ctre::phoenixpro::configs::ParentConfiguration.
Member Data Documentation
◆ FutureProofConfigs
| bool ctre::phoenixpro::configs::Pigeon2Configuration::FutureProofConfigs {true} |
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.
◆ GyroTrim
| GyroTrimConfigs ctre::phoenixpro::configs::Pigeon2Configuration::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
| MountPoseConfigs ctre::phoenixpro::configs::Pigeon2Configuration::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
| Pigeon2FeaturesConfigs ctre::phoenixpro::configs::Pigeon2Configuration::Pigeon2Features |
Configs to enable/disable various features of the Pigeon2.
These configs allow the user to enable or disable various aspects of the Pigeon2.
The documentation for this class was generated from the following file:
- ctre/phoenixpro/core/CorePigeon2.hpp
