Package com.ctre.phoenix6.configs

Class TalonFXConfigurator

java.lang.Object
com.ctre.phoenix6.configs.ParentConfigurator
com.ctre.phoenix6.configs.TalonFXConfigurator
public class TalonFXConfigurator
extends ParentConfigurator
Class description for the Talon FX integrated motor controller. This handles the configurations for the TalonFX

  • Constructor Details

  • Method Details

    • refresh

      public StatusCode refresh​(TalonFXConfiguration configs)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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​(DifferentialSensorsConfigs configs)
      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​(DifferentialSensorsConfigs configs, double timeoutSeconds)
      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​(DifferentialSensorsConfigs configs)
      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​(DifferentialSensorsConfigs configs, double timeoutSeconds)
      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​(DifferentialConstantsConfigs configs)
      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​(DifferentialConstantsConfigs configs, double timeoutSeconds)
      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​(DifferentialConstantsConfigs configs)
      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​(DifferentialConstantsConfigs configs, double timeoutSeconds)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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)
      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​(SlotConfigs configs)
      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​(SlotConfigs configs, double timeoutSeconds)
      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​(SlotConfigs configs)
      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​(SlotConfigs configs, double timeoutSeconds)
      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)
      Sets the mechanism position of the device in mechanism rotations.

      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. Units are in rotations.
      Returns:
      StatusCode of the set command

    • setPosition

      public StatusCode setPosition​(double newValue, double timeoutSeconds)
      Sets the mechanism position of the device in mechanism rotations.

      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. Units are in rotations.
      timeoutSeconds - Maximum time to wait up to in seconds.
      Returns:
      StatusCode of the set command

    • clearStickyFaults

      public StatusCode clearStickyFaults()
      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)
      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

    • clearStickyFault_Hardware

      public StatusCode clearStickyFault_Hardware()
      Clear sticky fault: Hardware fault occurred

      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

    • clearStickyFault_Hardware

      public StatusCode clearStickyFault_Hardware​(double timeoutSeconds)
      Clear sticky fault: Hardware fault occurred

      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

    • clearStickyFault_ProcTemp

      public StatusCode clearStickyFault_ProcTemp()
      Clear sticky fault: Processor temperature exceeded limit

      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

    • clearStickyFault_ProcTemp

      public StatusCode clearStickyFault_ProcTemp​(double timeoutSeconds)
      Clear sticky fault: Processor temperature exceeded limit

      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

    • clearStickyFault_DeviceTemp

      public StatusCode clearStickyFault_DeviceTemp()
      Clear sticky fault: Device temperature exceeded limit

      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

    • clearStickyFault_DeviceTemp

      public StatusCode clearStickyFault_DeviceTemp​(double timeoutSeconds)
      Clear sticky fault: Device temperature exceeded limit

      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

    • clearStickyFault_Undervoltage

      public StatusCode clearStickyFault_Undervoltage()
      Clear sticky fault: Device supply voltage dropped to near brownout levels

      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

    • clearStickyFault_Undervoltage

      public StatusCode clearStickyFault_Undervoltage​(double timeoutSeconds)
      Clear sticky fault: Device supply voltage dropped to near brownout levels

      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

    • clearStickyFault_BootDuringEnable

      public StatusCode clearStickyFault_BootDuringEnable()
      Clear sticky fault: Device boot while detecting the enable signal

      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

    • clearStickyFault_BootDuringEnable

      public StatusCode clearStickyFault_BootDuringEnable​(double timeoutSeconds)
      Clear sticky fault: Device boot while detecting the enable signal

      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

    • clearStickyFault_BridgeBrownout

      public StatusCode clearStickyFault_BridgeBrownout()
      Clear sticky fault: Bridge was disabled most likely due to supply voltage dropping too low.

      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

    • clearStickyFault_BridgeBrownout

      public StatusCode clearStickyFault_BridgeBrownout​(double timeoutSeconds)
      Clear sticky fault: Bridge was disabled most likely due to supply voltage dropping too low.

      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

    • clearStickyFault_RemoteSensorReset

      public StatusCode clearStickyFault_RemoteSensorReset()
      Clear sticky fault: The remote sensor has reset.

      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

    • clearStickyFault_RemoteSensorReset

      public StatusCode clearStickyFault_RemoteSensorReset​(double timeoutSeconds)
      Clear sticky fault: The remote sensor has reset.

      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

    • clearStickyFault_MissingDifferentialFX

      public StatusCode clearStickyFault_MissingDifferentialFX()
      Clear sticky fault: The remote Talon FX used for differential control is not present on CAN Bus.

      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

    • clearStickyFault_MissingDifferentialFX

      public StatusCode clearStickyFault_MissingDifferentialFX​(double timeoutSeconds)
      Clear sticky fault: The remote Talon FX used for differential control is not present on CAN Bus.

      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

    • clearStickyFault_RemoteSensorPosOverflow

      public StatusCode clearStickyFault_RemoteSensorPosOverflow()
      Clear sticky fault: The remote sensor position has overflowed. Because of the nature of remote sensors, it is possible for the remote sensor position to overflow beyond what is supported by the status signal frame. However, this is rare and cannot occur over the course of an FRC match under normal use.

      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

    • clearStickyFault_RemoteSensorPosOverflow

      public StatusCode clearStickyFault_RemoteSensorPosOverflow​(double timeoutSeconds)
      Clear sticky fault: The remote sensor position has overflowed. Because of the nature of remote sensors, it is possible for the remote sensor position to overflow beyond what is supported by the status signal frame. However, this is rare and cannot occur over the course of an FRC match under normal use.

      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

    • clearStickyFault_OverSupplyV

      public StatusCode clearStickyFault_OverSupplyV()
      Clear sticky fault: Supply Voltage has exceeded the maximum voltage rating of device.

      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

    • clearStickyFault_OverSupplyV

      public StatusCode clearStickyFault_OverSupplyV​(double timeoutSeconds)
      Clear sticky fault: Supply Voltage has exceeded the maximum voltage rating of device.

      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

    • clearStickyFault_UnstableSupplyV

      public StatusCode clearStickyFault_UnstableSupplyV()
      Clear sticky fault: Supply Voltage is unstable. Ensure you are using a battery and current limited power supply.

      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

    • clearStickyFault_UnstableSupplyV

      public StatusCode clearStickyFault_UnstableSupplyV​(double timeoutSeconds)
      Clear sticky fault: Supply Voltage is unstable. Ensure you are using a battery and current limited power supply.

      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

    • clearStickyFault_ReverseHardLimit

      public StatusCode clearStickyFault_ReverseHardLimit()
      Clear sticky fault: Reverse limit switch has been asserted. Output is set to neutral.

      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

    • clearStickyFault_ReverseHardLimit

      public StatusCode clearStickyFault_ReverseHardLimit​(double timeoutSeconds)
      Clear sticky fault: Reverse limit switch has been asserted. Output is set to neutral.

      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

    • clearStickyFault_ForwardHardLimit

      public StatusCode clearStickyFault_ForwardHardLimit()
      Clear sticky fault: Forward limit switch has been asserted. Output is set to neutral.

      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

    • clearStickyFault_ForwardHardLimit

      public StatusCode clearStickyFault_ForwardHardLimit​(double timeoutSeconds)
      Clear sticky fault: Forward limit switch has been asserted. Output is set to neutral.

      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

    • clearStickyFault_ReverseSoftLimit

      public StatusCode clearStickyFault_ReverseSoftLimit()
      Clear sticky fault: Reverse soft limit has been asserted. Output is set to neutral.

      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

    • clearStickyFault_ReverseSoftLimit

      public StatusCode clearStickyFault_ReverseSoftLimit​(double timeoutSeconds)
      Clear sticky fault: Reverse soft limit has been asserted. Output is set to neutral.

      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

    • clearStickyFault_ForwardSoftLimit

      public StatusCode clearStickyFault_ForwardSoftLimit()
      Clear sticky fault: Forward soft limit has been asserted. Output is set to neutral.

      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

    • clearStickyFault_ForwardSoftLimit

      public StatusCode clearStickyFault_ForwardSoftLimit​(double timeoutSeconds)
      Clear sticky fault: Forward soft limit has been asserted. Output is set to neutral.

      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

    • clearStickyFault_RemoteSensorDataInvalid

      public StatusCode clearStickyFault_RemoteSensorDataInvalid()
      Clear sticky fault: The remote sensor's data is no longer trusted. This can happen if the remote sensor disappears from the CAN bus or if the remote sensor indicates its data is no longer valid, such as when a CANcoder's magnet strength falls into the "red" range.

      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

    • clearStickyFault_RemoteSensorDataInvalid

      public StatusCode clearStickyFault_RemoteSensorDataInvalid​(double timeoutSeconds)
      Clear sticky fault: The remote sensor's data is no longer trusted. This can happen if the remote sensor disappears from the CAN bus or if the remote sensor indicates its data is no longer valid, such as when a CANcoder's magnet strength falls into the "red" range.

      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

    • clearStickyFault_FusedSensorOutOfSync

      public StatusCode clearStickyFault_FusedSensorOutOfSync()
      Clear sticky fault: The remote sensor used for fusion has fallen out of sync to the local sensor. A re-synchronization has occurred, which may cause a discontinuity. This typically happens if there is significant slop in the mechanism, or if the RotorToSensorRatio configuration parameter is incorrect.

      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

    • clearStickyFault_FusedSensorOutOfSync

      public StatusCode clearStickyFault_FusedSensorOutOfSync​(double timeoutSeconds)
      Clear sticky fault: The remote sensor used for fusion has fallen out of sync to the local sensor. A re-synchronization has occurred, which may cause a discontinuity. This typically happens if there is significant slop in the mechanism, or if the RotorToSensorRatio configuration parameter is incorrect.

      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

    • clearStickyFault_StatorCurrLimit

      public StatusCode clearStickyFault_StatorCurrLimit()
      Clear sticky fault: Stator current limit occured.

      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

    • clearStickyFault_StatorCurrLimit

      public StatusCode clearStickyFault_StatorCurrLimit​(double timeoutSeconds)
      Clear sticky fault: Stator current limit occured.

      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

    • clearStickyFault_SupplyCurrLimit

      public StatusCode clearStickyFault_SupplyCurrLimit()
      Clear sticky fault: Supply current limit occured.

      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

    • clearStickyFault_SupplyCurrLimit

      public StatusCode clearStickyFault_SupplyCurrLimit​(double timeoutSeconds)
      Clear sticky fault: Supply current limit occured.

      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