Configs that directly affect motor-output. More...
#include <ctre/phoenixpro/configs/Configs.hpp>
Public Member Functions | |
| std::string | ToString () const |
| std::string | Serialize () const |
| ctre::phoenix::StatusCode | Deserialize (const std::string &string) |
| virtual std::string | ToString () const =0 |
| virtual ctre::phoenix::StatusCode | Deserialize (const std::string &string)=0 |
| virtual std::string | Serialize () const =0 |
Public Attributes | |
| signals::ForwardLimitTypeValue | ForwardLimitType = signals::ForwardLimitTypeValue::NormallyOpen |
| Determines if limit is normally-open (default) or normally-closed. More... | |
| bool | ForwardLimitAutosetPositionEnable = false |
| If enabled, the position is auto-set to a specific value, specified by ForwardLimitAutosetPositionValue. More... | |
| double | ForwardLimitAutosetPositionValue = 0 |
| The value to auto-set the position to. More... | |
| bool | ForwardLimitEnable = true |
| If enabled, motor output is set to neutral when forward limit switch is asseted and positive output is requested. More... | |
| signals::ForwardLimitSourceValue | ForwardLimitSource = signals::ForwardLimitSourceValue::LimitSwitchPin |
| Determines where to poll the forward limit switch. More... | |
| int | ForwardLimitRemoteSensorID = 0 |
| Device ID of the device if using remote limit switch features. More... | |
| signals::ReverseLimitTypeValue | ReverseLimitType = signals::ReverseLimitTypeValue::NormallyOpen |
| Determines if limit is normally-open (default) or normally-closed. More... | |
| bool | ReverseLimitAutosetPositionEnable = false |
| If enabled, the position is auto-set to a specific value, specified by ReverseLimitAutosetPositionValue. More... | |
| double | ReverseLimitAutosetPositionValue = 0 |
| The value to auto-set the position to. More... | |
| bool | ReverseLimitEnable = true |
| If enabled, motor output is set to neutral when reverse limit switch is asseted and positive output is requested. More... | |
| signals::ReverseLimitSourceValue | ReverseLimitSource = signals::ReverseLimitSourceValue::LimitSwitchPin |
| Determines where to poll the reverse limit switch. More... | |
| int | ReverseLimitRemoteSensorID = 0 |
| Device ID of the device if using remote limit switch features. More... | |
Detailed Description
Configs that directly affect motor-output.
Includes Motor Invert and various limit features.
Member Function Documentation
◆ Deserialize()
|
inlinevirtual |
Implements ctre::phoenixpro::configs::ParentConfiguration.
◆ Serialize()
|
inlinevirtual |
Implements ctre::phoenixpro::ISerializable.
◆ ToString()
|
inlinevirtual |
Implements ctre::phoenixpro::configs::ParentConfiguration.
Member Data Documentation
◆ ForwardLimitAutosetPositionEnable
| bool ctre::phoenixpro::configs::HardwareLimitSwitchConfigs::ForwardLimitAutosetPositionEnable = false |
If enabled, the position is auto-set to a specific value, specified by ForwardLimitAutosetPositionValue.
Default Value: False
◆ ForwardLimitAutosetPositionValue
| double ctre::phoenixpro::configs::HardwareLimitSwitchConfigs::ForwardLimitAutosetPositionValue = 0 |
The value to auto-set the position to.
This has no effect if ForwardLimitAutosetPositionEnable is false.
Minimum Value: -3.4e+38 Maximum Value: 3.4e+38 Default Value: 0 Units: rotations
◆ ForwardLimitEnable
| bool ctre::phoenixpro::configs::HardwareLimitSwitchConfigs::ForwardLimitEnable = true |
If enabled, motor output is set to neutral when forward limit switch is asseted and positive output is requested.
Default Value: True
◆ ForwardLimitRemoteSensorID
| int ctre::phoenixpro::configs::HardwareLimitSwitchConfigs::ForwardLimitRemoteSensorID = 0 |
Device ID of the device if using remote limit switch features.
Minimum Value: 0 Maximum Value: 62 Default Value: 0 Units:
◆ ForwardLimitSource
| signals::ForwardLimitSourceValue ctre::phoenixpro::configs::HardwareLimitSwitchConfigs::ForwardLimitSource = signals::ForwardLimitSourceValue::LimitSwitchPin |
Determines where to poll the forward limit switch.
This defaults to the limit switch pin on the limit switch connector.
◆ ForwardLimitType
| signals::ForwardLimitTypeValue ctre::phoenixpro::configs::HardwareLimitSwitchConfigs::ForwardLimitType = signals::ForwardLimitTypeValue::NormallyOpen |
Determines if limit is normally-open (default) or normally-closed.
◆ ReverseLimitAutosetPositionEnable
| bool ctre::phoenixpro::configs::HardwareLimitSwitchConfigs::ReverseLimitAutosetPositionEnable = false |
If enabled, the position is auto-set to a specific value, specified by ReverseLimitAutosetPositionValue.
Default Value: False
◆ ReverseLimitAutosetPositionValue
| double ctre::phoenixpro::configs::HardwareLimitSwitchConfigs::ReverseLimitAutosetPositionValue = 0 |
The value to auto-set the position to.
This has no effect if ReverseLimitAutosetPositionEnable is false.
Minimum Value: -3.4e+38 Maximum Value: 3.4e+38 Default Value: 0 Units: rotations
◆ ReverseLimitEnable
| bool ctre::phoenixpro::configs::HardwareLimitSwitchConfigs::ReverseLimitEnable = true |
If enabled, motor output is set to neutral when reverse limit switch is asseted and positive output is requested.
Default Value: True
◆ ReverseLimitRemoteSensorID
| int ctre::phoenixpro::configs::HardwareLimitSwitchConfigs::ReverseLimitRemoteSensorID = 0 |
Device ID of the device if using remote limit switch features.
Minimum Value: 0 Maximum Value: 62 Default Value: 0 Units:
◆ ReverseLimitSource
| signals::ReverseLimitSourceValue ctre::phoenixpro::configs::HardwareLimitSwitchConfigs::ReverseLimitSource = signals::ReverseLimitSourceValue::LimitSwitchPin |
Determines where to poll the reverse limit switch.
This defaults to the limit switch pin on the limit switch connector.
◆ ReverseLimitType
| signals::ReverseLimitTypeValue ctre::phoenixpro::configs::HardwareLimitSwitchConfigs::ReverseLimitType = signals::ReverseLimitTypeValue::NormallyOpen |
Determines if limit is normally-open (default) or normally-closed.
The documentation for this class was generated from the following file:
- ctre/phoenixpro/configs/Configs.hpp
