Package com.ctre.phoenixpro.configs

Class CANcoderConfigurator

java.lang.Object
com.ctre.phoenixpro.configs.ParentConfigurator
com.ctre.phoenixpro.configs.CANcoderConfigurator
@Deprecated(forRemoval=true)
public class CANcoderConfigurator
extends ParentConfigurator
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 inherited from class com.ctre.phoenixpro.configs.ParentConfigurator

    defaultTimeoutSeconds

  • Constructor Summary

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

  • Method Summary

    Modifier and Type Method Description
    StatusCode apply​(CANcoderConfiguration configs)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Applies the contents of the specified config to the device.
    StatusCode apply​(CANcoderConfiguration configs, double timeoutSeconds)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Applies the contents of the specified config to the device.
    StatusCode apply​(MagnetSensorConfigs configs)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Applies the contents of the specified config to the device.
    StatusCode apply​(MagnetSensorConfigs configs, double timeoutSeconds)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Applies the contents of the specified config to the device.
    StatusCode clearStickyFaults()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Clear the sticky faults in the device.
    StatusCode clearStickyFaults​(double timeoutSeconds)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Clear the sticky faults in the device.
    StatusCode refresh​(CANcoderConfiguration configs)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Refreshes the values of the specified config group.
    StatusCode refresh​(CANcoderConfiguration configs, double timeoutSeconds)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Refreshes the values of the specified config group.
    StatusCode refresh​(MagnetSensorConfigs configs)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Refreshes the values of the specified config group.
    StatusCode refresh​(MagnetSensorConfigs configs, double timeoutSeconds)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Refreshes the values of the specified config group.
    StatusCode setPosition​(double newValue)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The position to set the sensor position to right now.
    StatusCode setPosition​(double newValue, double timeoutSeconds)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The position to set the sensor position to right now.

    Methods inherited from class com.ctre.phoenixpro.configs.ParentConfigurator

    getConfigsPrivate, setConfigsPrivate

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • refresh

      public StatusCode refresh​(CANcoderConfiguration configs)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Refreshes the values of the specified config group.

      This will wait up to ParentConfigurator.defaultTimeoutSeconds.

      Call to refresh the selected configs from the device.

      Parameters:
      configs - The configs to refresh
      Returns:
      StatusCode of refreshing the configs

    • refresh

      public StatusCode refresh​(CANcoderConfiguration configs, double timeoutSeconds)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Refreshes the values of the specified config group.

      Call to refresh the selected configs from the device.

      Parameters:
      configs - The configs to refresh
      timeoutSeconds - Maximum amount of time to wait when performing configuration
      Returns:
      StatusCode of refreshing the configs

    • apply

      public StatusCode apply​(CANcoderConfiguration configs)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Applies the contents of the specified config to the device.

      This will wait up to ParentConfigurator.defaultTimeoutSeconds.

      Call to apply the selected configs.

      Parameters:
      configs - Configs to apply against.
      Returns:
      StatusCode of the set command

    • apply

      public StatusCode apply​(CANcoderConfiguration configs, double timeoutSeconds)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Applies the contents of the specified config to the device.

      Call to apply the selected configs.

      Parameters:
      configs - Configs to apply against.
      timeoutSeconds - Maximum amount of time to wait when performing configuration
      Returns:
      StatusCode of the set command

    • refresh

      public StatusCode refresh​(MagnetSensorConfigs configs)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Refreshes the values of the specified config group.

      This will wait up to ParentConfigurator.defaultTimeoutSeconds.

      Call to refresh the selected configs from the device.

      Parameters:
      configs - The configs to refresh
      Returns:
      StatusCode of refreshing the configs

    • refresh

      public StatusCode refresh​(MagnetSensorConfigs configs, double timeoutSeconds)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Refreshes the values of the specified config group.

      Call to refresh the selected configs from the device.

      Parameters:
      configs - The configs to refresh
      timeoutSeconds - Maximum amount of time to wait when performing configuration
      Returns:
      StatusCode of refreshing the configs

    • apply

      public StatusCode apply​(MagnetSensorConfigs configs)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Applies the contents of the specified config to the device.

      This will wait up to ParentConfigurator.defaultTimeoutSeconds.

      Call to apply the selected configs.

      Parameters:
      configs - Configs to apply against.
      Returns:
      StatusCode of the set command

    • apply

      public StatusCode apply​(MagnetSensorConfigs configs, double timeoutSeconds)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Applies the contents of the specified config to the device.

      Call to apply the selected configs.

      Parameters:
      configs - Configs to apply against.
      timeoutSeconds - Maximum amount of time to wait when performing configuration
      Returns:
      StatusCode of the set command

    • setPosition

      public StatusCode setPosition​(double newValue)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The position to set the sensor position to right now.

      This will wait up to ParentConfigurator.defaultTimeoutSeconds.

      This is available in the configurator in case the user wants to initialize their device entirely without passing a device reference down to the code that performs the initialization. In this case, the user passes down the configurator object and performs all the initialization code on the object.

      Parameters:
      newValue - Value to set to.
      Returns:
      StatusCode of the set command

    • setPosition

      public StatusCode setPosition​(double newValue, double timeoutSeconds)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The position to set the sensor position to right now.

      This is available in the configurator in case the user wants to initialize their device entirely without passing a device reference down to the code that performs the initialization. In this case, the user passes down the configurator object and performs all the initialization code on the object.

      Parameters:
      newValue - Value to set to.
      timeoutSeconds - Maximum time to wait up to in seconds.
      Returns:
      StatusCode of the set command

    • clearStickyFaults

      public StatusCode clearStickyFaults()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Clear the sticky faults in the device.

      This typically has no impact on the device functionality. Instead, it just clears telemetry faults that are accessible via API and Tuner Self-Test.

      This will wait up to ParentConfigurator.defaultTimeoutSeconds.

      This is available in the configurator in case the user wants to initialize their device entirely without passing a device reference down to the code that performs the initialization. In this case, the user passes down the configurator object and performs all the initialization code on the object.

      Returns:
      StatusCode of the set command

    • clearStickyFaults

      public StatusCode clearStickyFaults​(double timeoutSeconds)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Clear the sticky faults in the device.

      This typically has no impact on the device functionality. Instead, it just clears telemetry faults that are accessible via API and Tuner Self-Test.

      This is available in the configurator in case the user wants to initialize their device entirely without passing a device reference down to the code that performs the initialization. In this case, the user passes down the configurator object and performs all the initialization code on the object.

      Parameters:
      timeoutSeconds - Maximum time to wait up to in seconds.
      Returns:
      StatusCode of the set command