Configs that affect the feedback of this motor controller. More...
#include <ctre/phoenix6/configs/Configs.hpp>
Public Member Functions | |
| FeedbackConfigs & | WithFeedbackRotorOffset (double newFeedbackRotorOffset) |
| Modifies this configuration's FeedbackRotorOffset parameter and returns itself for method-chaining and easier to use config API. More... | |
| FeedbackConfigs & | WithSensorToMechanismRatio (double newSensorToMechanismRatio) |
| Modifies this configuration's SensorToMechanismRatio parameter and returns itself for method-chaining and easier to use config API. More... | |
| FeedbackConfigs & | WithRotorToSensorRatio (double newRotorToSensorRatio) |
| Modifies this configuration's RotorToSensorRatio parameter and returns itself for method-chaining and easier to use config API. More... | |
| FeedbackConfigs & | WithFeedbackSensorSource (signals::FeedbackSensorSourceValue newFeedbackSensorSource) |
| Modifies this configuration's FeedbackSensorSource parameter and returns itself for method-chaining and easier to use config API. More... | |
| FeedbackConfigs & | WithFeedbackRemoteSensorID (int newFeedbackRemoteSensorID) |
| Modifies this configuration's FeedbackRemoteSensorID parameter and returns itself for method-chaining and easier to use config API. More... | |
| FeedbackConfigs & | WithFusedCANcoder (const hardware::core::CoreCANcoder &device) |
| Helper method to configure this feedback group to use Fused CANcoder by passing in the CANcoder object. More... | |
| FeedbackConfigs & | WithRemoteCANcoder (const hardware::core::CoreCANcoder &device) |
| Helper method to configure this feedback group to use Remote CANcoder by passing in the CANcoder object. More... | |
| std::string | ToString () const override |
| std::string | Serialize () const override |
| ctre::phoenix::StatusCode | Deserialize (const std::string &to_deserialize) override |
| virtual std::string | ToString () const =0 |
| virtual ctre::phoenix::StatusCode | Deserialize (const std::string &string)=0 |
| virtual std::string | Serialize () const =0 |
Public Attributes | |
| double | FeedbackRotorOffset = 0.0 |
| This offset is applied to the absolute integrated rotor sensor. More... | |
| double | SensorToMechanismRatio = 1.0 |
| This is the ratio of sensor rotations to the mechanism's output. More... | |
| double | RotorToSensorRatio = 1.0 |
| Talon FX is capable of fusing a remote CANcoder with its rotor sensor to produce a high-bandwidth sensor source. More... | |
| signals::FeedbackSensorSourceValue | FeedbackSensorSource = signals::FeedbackSensorSourceValue::RotorSensor |
| Choose what sensor source is reported via API and used by closed-loop and limit features. More... | |
| int | FeedbackRemoteSensorID = 0 |
| Device ID of which remote device to use. More... | |
Detailed Description
Configs that affect the feedback of this motor controller.
Includes feedback sensor source, any offsets for the feedback sensor, and various ratios to describe the relationship between the sensor and the mechanism for closed looping.
Member Function Documentation
◆ Deserialize()
|
inlineoverridevirtual |
Implements ctre::phoenix6::configs::ParentConfiguration.
◆ Serialize()
|
inlineoverridevirtual |
Implements ctre::phoenix6::ISerializable.
◆ ToString()
|
inlineoverridevirtual |
Implements ctre::phoenix6::configs::ParentConfiguration.
◆ WithFeedbackRemoteSensorID()
|
inline |
Modifies this configuration's FeedbackRemoteSensorID parameter and returns itself for method-chaining and easier to use config API.
- Parameters
-
newFeedbackRemoteSensorID Parameter to modify
- Returns
- Itself
◆ WithFeedbackRotorOffset()
|
inline |
Modifies this configuration's FeedbackRotorOffset parameter and returns itself for method-chaining and easier to use config API.
- Parameters
-
newFeedbackRotorOffset Parameter to modify
- Returns
- Itself
◆ WithFeedbackSensorSource()
|
inline |
Modifies this configuration's FeedbackSensorSource parameter and returns itself for method-chaining and easier to use config API.
- Parameters
-
newFeedbackSensorSource Parameter to modify
- Returns
- Itself
◆ WithFusedCANcoder()
| FeedbackConfigs & ctre::phoenix6::configs::FeedbackConfigs::WithFusedCANcoder | ( | const hardware::core::CoreCANcoder & | device | ) |
Helper method to configure this feedback group to use Fused CANcoder by passing in the CANcoder object.
- Parameters
-
device CANcoder reference to use for FusedCANcoder
◆ WithRemoteCANcoder()
| FeedbackConfigs & ctre::phoenix6::configs::FeedbackConfigs::WithRemoteCANcoder | ( | const hardware::core::CoreCANcoder & | device | ) |
Helper method to configure this feedback group to use Remote CANcoder by passing in the CANcoder object.
- Parameters
-
device CANcoder reference to use for FusedCANcoder
◆ WithRotorToSensorRatio()
|
inline |
Modifies this configuration's RotorToSensorRatio parameter and returns itself for method-chaining and easier to use config API.
- Parameters
-
newRotorToSensorRatio Parameter to modify
- Returns
- Itself
◆ WithSensorToMechanismRatio()
|
inline |
Modifies this configuration's SensorToMechanismRatio parameter and returns itself for method-chaining and easier to use config API.
- Parameters
-
newSensorToMechanismRatio Parameter to modify
- Returns
- Itself
Member Data Documentation
◆ FeedbackRemoteSensorID
| int ctre::phoenix6::configs::FeedbackConfigs::FeedbackRemoteSensorID = 0 |
Device ID of which remote device to use.
This is not used if the Sensor Source is the internal rotor sensor.
Minimum Value: 0 Maximum Value: 62 Default Value: 0 Units:
◆ FeedbackRotorOffset
| double ctre::phoenix6::configs::FeedbackConfigs::FeedbackRotorOffset = 0.0 |
This offset is applied to the absolute integrated rotor sensor.
This can be used to zero the rotor in applications that are within one rotor rotation.
Minimum Value: -1 Maximum Value: 1 Default Value: 0.0 Units: rotations
◆ FeedbackSensorSource
| signals::FeedbackSensorSourceValue ctre::phoenix6::configs::FeedbackConfigs::FeedbackSensorSource = signals::FeedbackSensorSourceValue::RotorSensor |
Choose what sensor source is reported via API and used by closed-loop and limit features.
The default is RotorSensor, which uses the internal rotor sensor in the Talon FX. Choose RemoteCANcoder to use another CANcoder on the same CAN bus (this also requires setting FeedbackRemoteSensorID). Talon FX will update its position and velocity whenever CANcoder publishes its information on CAN bus. Choose FusedCANcoder (requires Phoenix Pro) and Talon FX will fuse another CANcoder's information with the internal rotor, which provides the best possible position and velocity for accuracy and bandwidth (note this requires setting FeedbackRemoteSensorID). FusedCANcoder was developed for applications such as swerve-azimuth. Choose SyncCANcoder (requires Phoenix Pro) and Talon FX will synchronize its internal rotor position against another CANcoder, then continue to use the rotor sensor for closed loop control (note this requires setting FeedbackRemoteSensorID). The TalonFX will report if its internal position differs significantly from the reported CANcoder position. SyncCANcoder was developed for mechanisms where there is a risk of the CANcoder failing in such a way that it reports a position that does not match the mechanism, such as the sensor mounting assembly breaking off. Choose RemotePigeon2_Yaw, RemotePigeon2_Pitch, and RemotePigeon2_Roll to use another Pigeon2 on the same CAN bus (this also requires setting FeedbackRemoteSensorID). Talon FX will update its position to match the selected value whenever Pigeon2 publishes its information on CAN bus. Note that the Talon FX position will be in rotations and not degrees.
Note: When the Talon Source is changed to FusedCANcoder, the Talon needs a period of time to fuse before sensor-based (soft-limit, closed loop, etc.) features are used. This period of time is determined by the update frequency of the CANcoder's Position signal.
◆ RotorToSensorRatio
| double ctre::phoenix6::configs::FeedbackConfigs::RotorToSensorRatio = 1.0 |
Talon FX is capable of fusing a remote CANcoder with its rotor sensor to produce a high-bandwidth sensor source.
This feature requires specifying the ratio between the remote sensor and the motor rotor. Note if this is set to zero, device will reset back to one.
Minimum Value: -1000 Maximum Value: 1000 Default Value: 1.0 Units: scalar
◆ SensorToMechanismRatio
| double ctre::phoenix6::configs::FeedbackConfigs::SensorToMechanismRatio = 1.0 |
This is the ratio of sensor rotations to the mechanism's output.
This is equivalent to the mechanism's gear ratio if the sensor is located on the input of a gearbox. If sensor is on the output of a gearbox, then this is typically set to 1. Note if this is set to zero, device will reset back to one.
Minimum Value: -1000 Maximum Value: 1000 Default Value: 1.0 Units: scalar
The documentation for this class was generated from the following file:
- ctre/phoenix6/configs/Configs.hpp
