Package com.ctre.phoenixpro.configs

Class Pigeon2Configurator

java.lang.Object
com.ctre.phoenixpro.configs.ParentConfigurator
com.ctre.phoenixpro.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.
      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.
      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