Package com.ctre.phoenixpro.configs

Class CANcoderConfiguration

java.lang.Object
com.ctre.phoenixpro.configs.CANcoderConfiguration
All Implemented Interfaces:
ParentConfiguration, ISerializable
@Deprecated(forRemoval=true)
public class CANcoderConfiguration
extends Object
implements ParentConfiguration
Deprecated, for removal: This API element is subject to removal in a future version.
Classes in the phoenixpro package will be removed in 2024. Users should instead use classes from the phoenix6 package.
Class for CANcoder, a CAN based magnetic encoder that provides absolute and relative position along with filtered velocity. This handles the configurations for the CANcoder

  • Field Summary

    Fields 
    Modifier and Type Field Description
    boolean FutureProofConfigs
    Deprecated, for removal: This API element is subject to removal in a future version.
    True if we should factory default newer unsupported configs, false to leave newer unsupported configs alone.
    MagnetSensorConfigs MagnetSensor
    Deprecated, for removal: This API element is subject to removal in a future version.
    Configs that affect the magnet sensor and how to interpret it.

  • Constructor Summary

    Constructors 
    Constructor Description
    CANcoderConfiguration()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type Method Description
    StatusCode deserialize​(String string)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Take a string and deserialize it to this configuration
    String serialize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the serialized form of this configuration
    String toString()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

    • FutureProofConfigs

      public boolean FutureProofConfigs
      Deprecated, for removal: This API element is subject to removal in a future version.
      True if we should factory default newer unsupported configs, false to leave newer unsupported configs alone.

      This flag addresses a corner case where the device may have firmware with newer configs that didn't exist when this version of the API was built. If this occurs and this flag is true, unsupported new configs will be factory defaulted to avoid unexpected behavior.

      This is also the behavior in Phoenix 5, so this flag is defaulted to true to match.

    • MagnetSensor

      public MagnetSensorConfigs MagnetSensor
      Deprecated, for removal: This API element is subject to removal in a future version.
      Configs that affect the magnet sensor and how to interpret it.

      Includes sensor range and other configs related to sensor.

  • Constructor Details

  • Method Details