CTRE Phoenix 6 C++ 25.2.1
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | Friends | List of all members
ctre::phoenix6::signals::MotorArrangementValue Class Reference

Selects the motor and motor connections used with Talon. More...

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

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

Public Member Functions

constexpr MotorArrangementValue (int value)
 
constexpr MotorArrangementValue ()
 
constexpr bool operator== (MotorArrangementValue data) const
 
constexpr bool operator== (int data) const
 
constexpr bool operator!= (MotorArrangementValue data) const
 
constexpr bool operator!= (int data) const
 
constexpr bool operator< (MotorArrangementValue 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 Disabled = 0
 Motor is not selected.
 
static constexpr int Minion_JST = 1
 CTR Electronics Minion® brushless three phase motor.
 
static constexpr int Brushed_DC = 2
 Third party brushed DC motor with two leads.
 
static constexpr int NEO_JST = 5
 Third party NEO brushless three phase motor (~6000 RPM at 12V).
 
static constexpr int NEO550_JST = 6
 Third party NEO550 brushless three phase motor (~11000 RPM at 12V).
 
static constexpr int VORTEX_JST = 7
 Third party VORTEX brushless three phase motor.
 

Friends

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

Detailed Description

Selects the motor and motor connections used with Talon. 

  This setting determines what kind of motor and sensors are used with
  the Talon.  This also determines what signals are used on the JST and
  Gadgeteer port.

  Motor drive will not function correctly if this setting does not match
  the physical setup.

Constructor & Destructor Documentation

◆ MotorArrangementValue() [1/2]

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

◆ MotorArrangementValue() [2/2]

ctre::phoenix6::signals::MotorArrangementValue::MotorArrangementValue ( )
inlineconstexpr

Member Function Documentation

◆ operator!=() [1/2]

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

◆ operator!=() [2/2]

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

◆ operator<() [1/2]

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

◆ operator<() [2/2]

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

◆ operator==() [1/2]

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

◆ operator==() [2/2]

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

◆ Serialize()

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

Implements ctre::phoenix6::ISerializable.

◆ ToString()

std::string ctre::phoenix6::signals::MotorArrangementValue::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,
MotorArrangementValue data )
friend

Member Data Documentation

◆ Brushed_DC

int ctre::phoenix6::signals::MotorArrangementValue::Brushed_DC = 2
staticconstexpr

Third party brushed DC motor with two leads.

Use the Brushed Motor Wiring config to determine which leads to use on the Talon (motor leads may be flipped to correct for clockwise vs counterclockwise). Note that the invert configuration can still be used to invert rotor orientation. Gadgeteer Connector: quadrature [A, B] are on pins [7, 5], limit [forward, reverse] are on pins [4, 8], and pulse width position is on pin [9].

◆ Disabled

int ctre::phoenix6::signals::MotorArrangementValue::Disabled = 0
staticconstexpr

Motor is not selected.

This is the default setting to ensure the user has an opportunity to select the correct motor arrangement before attempting to drive motor.

◆ Minion_JST

int ctre::phoenix6::signals::MotorArrangementValue::Minion_JST = 1
staticconstexpr

CTR Electronics Minion® brushless three phase motor.

Motor leads: red(terminal A), black (terminal B), and white (terminal C). JST Connector: hall [A, B, C] is on pins [4, 3, 2] and temperature is on pin [5]. Motor JST cable can be plugged directly into the JST connector. Gadgeteer Connector: quadrature [A, B] are on pins [7, 5], limit [forward, reverse] are on pins [4, 8], and pulse width position is on pin [9].

◆ NEO550_JST

int ctre::phoenix6::signals::MotorArrangementValue::NEO550_JST = 6
staticconstexpr

Third party NEO550 brushless three phase motor (~11000 RPM at 12V).

Motor leads: red(terminal A), black (terminal B), and white (terminal C). JST Connector: hall [A, B, C] is on pins [4, 3, 2] and temperature is on pin [5]. Motor JST cable can be plugged directly into the JST connector. Gadgeteer Connector: quadrature [A, B] are on pins [7, 5], limit [forward, reverse] are on pins [4, 8], and pulse width position is on pin [9].

◆ NEO_JST

int ctre::phoenix6::signals::MotorArrangementValue::NEO_JST = 5
staticconstexpr

Third party NEO brushless three phase motor (~6000 RPM at 12V).

Motor leads: red(terminal A), black (terminal B), and white (terminal C). JST Connector: hall [A, B, C] is on pins [4, 3, 2] and temperature is on pin [5]. Motor JST cable can be plugged directly into the JST connector. Gadgeteer Connector: quadrature [A, B] are on pins [7, 5], limit [forward, reverse] are on pins [4, 8], and pulse width position is on pin [9].

◆ value

int ctre::phoenix6::signals::MotorArrangementValue::value

◆ VORTEX_JST

int ctre::phoenix6::signals::MotorArrangementValue::VORTEX_JST = 7
staticconstexpr

Third party VORTEX brushless three phase motor.

Motor leads: red(terminal A), black (terminal B), and white (terminal C). JST Connector: hall [A, B, C] is on pins [4, 3, 2] and temperature is on pin [5]. Motor JST cable can be plugged directly into the JST connector. Gadgeteer Connector: quadrature [A, B] are on pins [7, 5], limit [forward, reverse] are on pins [4, 8], and pulse width position is on pin [9].

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