Package com.ctre.phoenix6.configs

Class Pigeon2Configurator

java.lang.Object
com.ctre.phoenix6.configs.ParentConfigurator
com.ctre.phoenix6.configs.Pigeon2Configurator
public class Pigeon2Configurator
extends ParentConfigurator
Class description for the Pigeon 2 IMU sensor that measures orientation. This handles the configurations for the Pigeon2

  • Constructor Details

  • Method Details

    • refresh

      public StatusCode refresh​(Pigeon2Configuration 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​(Pigeon2Configuration 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​(Pigeon2Configuration 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​(Pigeon2Configuration 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​(MountPoseConfigs 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​(MountPoseConfigs 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​(MountPoseConfigs 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​(MountPoseConfigs 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​(GyroTrimConfigs 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​(GyroTrimConfigs 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​(GyroTrimConfigs 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​(GyroTrimConfigs 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​(Pigeon2FeaturesConfigs 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​(Pigeon2FeaturesConfigs 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​(Pigeon2FeaturesConfigs 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​(Pigeon2FeaturesConfigs 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

    • setYaw

      public StatusCode setYaw​(double newValue)
      The yaw to set the Pigeon2 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. Units are in deg.
      Returns:
      StatusCode of the set command

    • setYaw

      public StatusCode setYaw​(double newValue, double timeoutSeconds)
      The yaw to set the Pigeon2 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. Units are in deg.
      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_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_BootupAccelerometer

      public StatusCode clearStickyFault_BootupAccelerometer()
      Clear sticky fault: Bootup checks failed: Accelerometer

      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_BootupAccelerometer

      public StatusCode clearStickyFault_BootupAccelerometer​(double timeoutSeconds)
      Clear sticky fault: Bootup checks failed: Accelerometer

      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_BootupGyroscope

      public StatusCode clearStickyFault_BootupGyroscope()
      Clear sticky fault: Bootup checks failed: Gyroscope

      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_BootupGyroscope

      public StatusCode clearStickyFault_BootupGyroscope​(double timeoutSeconds)
      Clear sticky fault: Bootup checks failed: Gyroscope

      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_BootupMagnetometer

      public StatusCode clearStickyFault_BootupMagnetometer()
      Clear sticky fault: Bootup checks failed: Magnetometer

      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_BootupMagnetometer

      public StatusCode clearStickyFault_BootupMagnetometer​(double timeoutSeconds)
      Clear sticky fault: Bootup checks failed: Magnetometer

      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_BootIntoMotion

      public StatusCode clearStickyFault_BootIntoMotion()
      Clear sticky fault: Motion Detected during bootup.

      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_BootIntoMotion

      public StatusCode clearStickyFault_BootIntoMotion​(double timeoutSeconds)
      Clear sticky fault: Motion Detected during bootup.

      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_DataAcquiredLate

      public StatusCode clearStickyFault_DataAcquiredLate()
      Clear sticky fault: Motion stack data acquisition was slower than expected

      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_DataAcquiredLate

      public StatusCode clearStickyFault_DataAcquiredLate​(double timeoutSeconds)
      Clear sticky fault: Motion stack data acquisition was slower than expected

      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_LoopTimeSlow

      public StatusCode clearStickyFault_LoopTimeSlow()
      Clear sticky fault: Motion stack loop time was slower than expected.

      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_LoopTimeSlow

      public StatusCode clearStickyFault_LoopTimeSlow​(double timeoutSeconds)
      Clear sticky fault: Motion stack loop time was slower than expected.

      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_SaturatedMagnetometer

      public StatusCode clearStickyFault_SaturatedMagnetometer()
      Clear sticky fault: Magnetometer values are saturated

      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_SaturatedMagnetometer

      public StatusCode clearStickyFault_SaturatedMagnetometer​(double timeoutSeconds)
      Clear sticky fault: Magnetometer values are saturated

      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_SaturatedAccelerometer

      public StatusCode clearStickyFault_SaturatedAccelerometer()
      Clear sticky fault: Accelerometer values are saturated

      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_SaturatedAccelerometer

      public StatusCode clearStickyFault_SaturatedAccelerometer​(double timeoutSeconds)
      Clear sticky fault: Accelerometer values are saturated

      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_SaturatedGyroscope

      public StatusCode clearStickyFault_SaturatedGyroscope()
      Clear sticky fault: Gyroscope values are saturated

      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_SaturatedGyroscope

      public StatusCode clearStickyFault_SaturatedGyroscope​(double timeoutSeconds)
      Clear sticky fault: Gyroscope values are saturated

      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