CTRE Phoenix 6 C++ 25.2.1
Loading...
Searching...
No Matches
ctre::phoenix6::signals::ReverseLimitSourceValue Class Reference

Determines where to poll the reverse limit switch. More...

#include <ctre/phoenix6/signals/SpnEnums.hpp>

Inheritance diagram for ctre::phoenix6::signals::ReverseLimitSourceValue:
ctre::phoenix6::ISerializable

Public Member Functions

constexpr ReverseLimitSourceValue (int value)
 
constexpr ReverseLimitSourceValue ()
 
constexpr bool operator== (ReverseLimitSourceValue data) const
 
constexpr bool operator== (int data) const
 
constexpr bool operator!= (ReverseLimitSourceValue data) const
 
constexpr bool operator!= (int data) const
 
constexpr bool operator< (ReverseLimitSourceValue data) const
 
constexpr bool operator< (int data) const
 
std::string ToString () const
 Gets the string representation of this enum.
 
std::string Serialize () const
 
- Public Member Functions inherited from ctre::phoenix6::ISerializable

Public Attributes

int value
 

Static Public Attributes

static constexpr int LimitSwitchPin = 0
 Use the reverse limit switch pin on the limit switch connector.
 
static constexpr int RemoteTalonFX = 1
 Use the reverse limit switch attached to another Talon FX on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).
 
static constexpr int RemoteCANifier = 2
 Use the reverse limit switch attached to another CANifier on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).
 
static constexpr int RemoteCANcoder = 4
 Use another CANcoder on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).
 
static constexpr int RemoteCANrange = 6
 Use another CANrange on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).
 
static constexpr int RemoteCANdiS1 = 7
 Use another CANdi on the same CAN bus (this also requires setting ForwardLimitRemoteSensorID).
 
static constexpr int RemoteCANdiS2 = 8
 Use another CANdi on the same CAN bus (this also requires setting ForwardLimitRemoteSensorID).
 
static constexpr int Disabled = 3
 Disable the reverse limit switch.
 

Friends

std::ostream & operator<< (std::ostream &os, ReverseLimitSourceValue data)
 

Detailed Description

Determines where to poll the reverse limit switch.

This defaults to the reverse limit switch pin on the limit switch connector.

Choose RemoteTalonFX to use the reverse limit switch attached to another Talon FX on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).

Choose RemoteCANifier to use the reverse limit switch attached to another CANifier on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).

Choose RemoteCANcoder to use another CANcoder on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID). The reverse limit will assert when the CANcoder magnet strength changes from BAD (red) to ADEQUATE (orange) or GOOD (green).

Constructor & Destructor Documentation

◆ ReverseLimitSourceValue() [1/2]

ctre::phoenix6::signals::ReverseLimitSourceValue::ReverseLimitSourceValue ( int value)
inlineconstexpr

◆ ReverseLimitSourceValue() [2/2]

ctre::phoenix6::signals::ReverseLimitSourceValue::ReverseLimitSourceValue ( )
inlineconstexpr

Member Function Documentation

◆ operator!=() [1/2]

bool ctre::phoenix6::signals::ReverseLimitSourceValue::operator!= ( int data) const
inlineconstexpr

◆ operator!=() [2/2]

bool ctre::phoenix6::signals::ReverseLimitSourceValue::operator!= ( ReverseLimitSourceValue data) const
inlineconstexpr

◆ operator<() [1/2]

bool ctre::phoenix6::signals::ReverseLimitSourceValue::operator< ( int data) const
inlineconstexpr

◆ operator<() [2/2]

bool ctre::phoenix6::signals::ReverseLimitSourceValue::operator< ( ReverseLimitSourceValue data) const
inlineconstexpr

◆ operator==() [1/2]

bool ctre::phoenix6::signals::ReverseLimitSourceValue::operator== ( int data) const
inlineconstexpr

◆ operator==() [2/2]

bool ctre::phoenix6::signals::ReverseLimitSourceValue::operator== ( ReverseLimitSourceValue data) const
inlineconstexpr

◆ Serialize()

std::string ctre::phoenix6::signals::ReverseLimitSourceValue::Serialize ( ) const
inlinevirtual

◆ ToString()

std::string ctre::phoenix6::signals::ReverseLimitSourceValue::ToString ( ) const
inline

Gets the string representation of this enum.

Returns
String representation of this enum

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream & os,
ReverseLimitSourceValue data )
friend

Member Data Documentation

◆ Disabled

int ctre::phoenix6::signals::ReverseLimitSourceValue::Disabled = 3
staticconstexpr

Disable the reverse limit switch.

◆ LimitSwitchPin

int ctre::phoenix6::signals::ReverseLimitSourceValue::LimitSwitchPin = 0
staticconstexpr

Use the reverse limit switch pin on the limit switch connector.

◆ RemoteCANcoder

int ctre::phoenix6::signals::ReverseLimitSourceValue::RemoteCANcoder = 4
staticconstexpr

Use another CANcoder on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).

The reverse limit will assert when the CANcoder magnet strength changes from BAD (red) to ADEQUATE (orange) or GOOD (green).

◆ RemoteCANdiS1

int ctre::phoenix6::signals::ReverseLimitSourceValue::RemoteCANdiS1 = 7
staticconstexpr

Use another CANdi on the same CAN bus (this also requires setting ForwardLimitRemoteSensorID).

The forward limit will assert when the CANdi Signal 1 Input (S1IN) pin matches the configured closed state.

◆ RemoteCANdiS2

int ctre::phoenix6::signals::ReverseLimitSourceValue::RemoteCANdiS2 = 8
staticconstexpr

Use another CANdi on the same CAN bus (this also requires setting ForwardLimitRemoteSensorID).

The forward limit will assert when the CANdi Signal 2 Input (S2IN) pin matches the configured closed state.

◆ RemoteCANifier

int ctre::phoenix6::signals::ReverseLimitSourceValue::RemoteCANifier = 2
staticconstexpr

Use the reverse limit switch attached to another CANifier on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).

◆ RemoteCANrange

int ctre::phoenix6::signals::ReverseLimitSourceValue::RemoteCANrange = 6
staticconstexpr

Use another CANrange on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).

The reverse limit will assert when the CANrange proximity detect is tripped.

◆ RemoteTalonFX

int ctre::phoenix6::signals::ReverseLimitSourceValue::RemoteTalonFX = 1
staticconstexpr

Use the reverse limit switch attached to another Talon FX on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).

◆ value

int ctre::phoenix6::signals::ReverseLimitSourceValue::value

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