CTRE Phoenix C++ 5.33.1
List of all members
ctre::phoenix::sensors::CANCoderConfigUtils Struct Reference

Util class to help with configuring CANCoder. More...

#include <ctre/phoenix/sensors/CANCoder.h>

Inheritance diagram for ctre::phoenix::sensors::CANCoderConfigUtils:
ctre::phoenix::CustomParamConfigUtil

Static Public Member Functions

static bool VelocityMeasurementPeriodDifferent (const CANCoderConfiguration &settings)
 Determine if specified value is different from default. More...
 
static bool VelocityMeasurementWindowDifferent (const CANCoderConfiguration &settings)
 
static bool AbsoluteSensorRangeDifferent (const CANCoderConfiguration &settings)
 
static bool MagnetOffsetDegreesDifferent (const CANCoderConfiguration &settings)
 
static bool SensorDirectionDifferent (const CANCoderConfiguration &settings)
 
static bool InitializationStrategyDifferent (const CANCoderConfiguration &settings)
 
static bool SensorCoefficientDifferent (const CANCoderConfiguration &settings)
 
static bool UnitStringDifferent (const CANCoderConfiguration &settings)
 
static bool SensorTimeBaseDifferent (const CANCoderConfiguration &settings)
 
- Static Public Member Functions inherited from ctre::phoenix::CustomParamConfigUtil
static bool CustomParam0Different (const CustomParamConfiguration &settings)
 
static bool CustomParam1Different (const CustomParamConfiguration &settings)
 

Detailed Description

Util class to help with configuring CANCoder.

Deprecated:
This device's Phoenix 5 API is deprecated for removal in the 2025 season. Users should update to Phoenix 6 firmware and migrate to the Phoenix 6 API. A migration guide is available at https://v6.docs.ctr-electronics.com/en/stable/docs/migration/migration-guide/index.html.

If the Phoenix 5 API must be used for this device, the device must have 22.X firmware. This firmware is available in Tuner X after selecting Phoenix 5 in the firmware year dropdown.

Member Function Documentation

◆ AbsoluteSensorRangeDifferent()

static bool ctre::phoenix::sensors::CANCoderConfigUtils::AbsoluteSensorRangeDifferent ( const CANCoderConfiguration &  settings)
inlinestatic

◆ InitializationStrategyDifferent()

static bool ctre::phoenix::sensors::CANCoderConfigUtils::InitializationStrategyDifferent ( const CANCoderConfiguration &  settings)
inlinestatic

◆ MagnetOffsetDegreesDifferent()

static bool ctre::phoenix::sensors::CANCoderConfigUtils::MagnetOffsetDegreesDifferent ( const CANCoderConfiguration &  settings)
inlinestatic

◆ SensorCoefficientDifferent()

static bool ctre::phoenix::sensors::CANCoderConfigUtils::SensorCoefficientDifferent ( const CANCoderConfiguration &  settings)
inlinestatic

◆ SensorDirectionDifferent()

static bool ctre::phoenix::sensors::CANCoderConfigUtils::SensorDirectionDifferent ( const CANCoderConfiguration &  settings)
inlinestatic

◆ SensorTimeBaseDifferent()

static bool ctre::phoenix::sensors::CANCoderConfigUtils::SensorTimeBaseDifferent ( const CANCoderConfiguration &  settings)
inlinestatic

◆ UnitStringDifferent()

static bool ctre::phoenix::sensors::CANCoderConfigUtils::UnitStringDifferent ( const CANCoderConfiguration &  settings)
inlinestatic

◆ VelocityMeasurementPeriodDifferent()

static bool ctre::phoenix::sensors::CANCoderConfigUtils::VelocityMeasurementPeriodDifferent ( const CANCoderConfiguration &  settings)
inlinestatic

Determine if specified value is different from default.

Parameters
settingssettings to compare against
Returns
if specified value is different from default

◆ VelocityMeasurementWindowDifferent()

static bool ctre::phoenix::sensors::CANCoderConfigUtils::VelocityMeasurementWindowDifferent ( const CANCoderConfiguration &  settings)
inlinestatic
The documentation for this struct was generated from the following file: