Package com.ctre.phoenixpro.configs

Class TalonFXConfigurator

java.lang.Object
com.ctre.phoenixpro.configs.ParentConfigurator
com.ctre.phoenixpro.configs.TalonFXConfigurator
@Deprecated(forRemoval=true)
public class TalonFXConfigurator
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 description for the Talon FX integrated motor controller that runs on associated Falcon motors. This handles the configurations for the TalonFX

  • Field Summary

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

    defaultTimeoutSeconds

  • Constructor Summary

    Constructors 
    Constructor Description
    TalonFXConfigurator​(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​(AudioConfigs 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​(AudioConfigs 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​(ClosedLoopGeneralConfigs 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​(ClosedLoopGeneralConfigs 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​(ClosedLoopRampsConfigs 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​(ClosedLoopRampsConfigs 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​(CurrentLimitsConfigs 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​(CurrentLimitsConfigs 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​(CustomParamsConfigs 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​(CustomParamsConfigs 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​(FeedbackConfigs 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​(FeedbackConfigs 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​(HardwareLimitSwitchConfigs 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​(HardwareLimitSwitchConfigs 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​(MotionMagicConfigs 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​(MotionMagicConfigs 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​(MotorOutputConfigs 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​(MotorOutputConfigs 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​(OpenLoopRampsConfigs 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​(OpenLoopRampsConfigs 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​(Slot0Configs 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​(Slot0Configs 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​(Slot1Configs 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​(Slot1Configs 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​(Slot2Configs 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​(Slot2Configs 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​(SoftwareLimitSwitchConfigs 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​(SoftwareLimitSwitchConfigs 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​(TalonFXConfiguration 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​(TalonFXConfiguration 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​(TorqueCurrentConfigs 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​(TorqueCurrentConfigs 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​(VoltageConfigs 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​(VoltageConfigs 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​(AudioConfigs 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​(AudioConfigs 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​(ClosedLoopGeneralConfigs 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​(ClosedLoopGeneralConfigs 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​(ClosedLoopRampsConfigs 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​(ClosedLoopRampsConfigs 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​(CurrentLimitsConfigs 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​(CurrentLimitsConfigs 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​(CustomParamsConfigs 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​(CustomParamsConfigs 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​(FeedbackConfigs 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​(FeedbackConfigs 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​(HardwareLimitSwitchConfigs 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​(HardwareLimitSwitchConfigs 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​(MotionMagicConfigs 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​(MotionMagicConfigs 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​(MotorOutputConfigs 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​(MotorOutputConfigs 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​(OpenLoopRampsConfigs 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​(OpenLoopRampsConfigs 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​(Slot0Configs 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​(Slot0Configs 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​(Slot1Configs 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​(Slot1Configs 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​(Slot2Configs 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​(Slot2Configs 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​(SoftwareLimitSwitchConfigs 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​(SoftwareLimitSwitchConfigs 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​(TalonFXConfiguration 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​(TalonFXConfiguration 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​(TorqueCurrentConfigs 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​(TorqueCurrentConfigs 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​(VoltageConfigs 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​(VoltageConfigs 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 setRotorPosition​(double newValue)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The position to set the rotor position to right now.
    StatusCode setRotorPosition​(double newValue, double timeoutSeconds)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The position to set the rotor 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​(TalonFXConfiguration 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​(TalonFXConfiguration 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​(TalonFXConfiguration 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​(TalonFXConfiguration 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​(Slot0Configs 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​(Slot0Configs 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​(Slot0Configs 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​(Slot0Configs 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​(Slot1Configs 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​(Slot1Configs 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​(Slot1Configs 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​(Slot1Configs 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​(Slot2Configs 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​(Slot2Configs 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​(Slot2Configs 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​(Slot2Configs 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​(MotorOutputConfigs 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​(MotorOutputConfigs 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​(MotorOutputConfigs 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​(MotorOutputConfigs 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​(CurrentLimitsConfigs 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​(CurrentLimitsConfigs 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​(CurrentLimitsConfigs 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​(CurrentLimitsConfigs 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​(VoltageConfigs 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​(VoltageConfigs 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​(VoltageConfigs 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​(VoltageConfigs 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​(TorqueCurrentConfigs 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​(TorqueCurrentConfigs 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​(TorqueCurrentConfigs 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​(TorqueCurrentConfigs 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​(FeedbackConfigs 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​(FeedbackConfigs 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​(FeedbackConfigs 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​(FeedbackConfigs 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​(OpenLoopRampsConfigs 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​(OpenLoopRampsConfigs 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​(OpenLoopRampsConfigs 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​(OpenLoopRampsConfigs 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​(ClosedLoopRampsConfigs 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​(ClosedLoopRampsConfigs 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​(ClosedLoopRampsConfigs 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​(ClosedLoopRampsConfigs 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​(HardwareLimitSwitchConfigs 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​(HardwareLimitSwitchConfigs 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​(HardwareLimitSwitchConfigs 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​(HardwareLimitSwitchConfigs 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​(AudioConfigs 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​(AudioConfigs 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​(AudioConfigs 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​(AudioConfigs 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​(SoftwareLimitSwitchConfigs 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​(SoftwareLimitSwitchConfigs 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​(SoftwareLimitSwitchConfigs 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​(SoftwareLimitSwitchConfigs 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​(MotionMagicConfigs 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​(MotionMagicConfigs 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​(MotionMagicConfigs 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​(MotionMagicConfigs 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​(CustomParamsConfigs 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​(CustomParamsConfigs 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​(CustomParamsConfigs 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​(CustomParamsConfigs 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​(ClosedLoopGeneralConfigs 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​(ClosedLoopGeneralConfigs 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​(ClosedLoopGeneralConfigs 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​(ClosedLoopGeneralConfigs 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

    • setRotorPosition

      public StatusCode setRotorPosition​(double newValue)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The position to set the rotor 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

    • setRotorPosition

      public StatusCode setRotorPosition​(double newValue, double timeoutSeconds)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The position to set the rotor 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