Class Pigeon2Configurator

Namespace

CTRE.Phoenix6.Configs

Assembly

Phoenix6.Hardware.dll

Class description for the Pigeon 2 IMU sensor that measures orientation.

This handles applying and refreshing the configurations for the Pigeon2.

public class Pigeon2Configurator : ParentConfigurator

Inheritance

object

ParentConfigurator

Pigeon2Configurator

Inherited Members

ParentConfigurator.DefaultTimeoutSeconds

ParentConfigurator.ReportIfFrequent()

ParentConfigurator.SetConfigsPrivate(string, double, bool, bool)

ParentConfigurator.GetConfigsPrivate(ref string, double)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Apply(CustomParamsConfigs)

Applies the contents of the specified config to the device.

This will wait up to DefaultTimeoutSeconds.

Call to apply the selected configs.

public StatusCode Apply(CustomParamsConfigs configs)

Parameters

configs CustomParamsConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(CustomParamsConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(CustomParamsConfigs configs, double timeoutSeconds)

Parameters

configs CustomParamsConfigs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(GyroTrimConfigs)

Applies the contents of the specified config to the device.

This will wait up to DefaultTimeoutSeconds.

Call to apply the selected configs.

public StatusCode Apply(GyroTrimConfigs configs)

Parameters

configs GyroTrimConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(GyroTrimConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(GyroTrimConfigs configs, double timeoutSeconds)

Parameters

configs GyroTrimConfigs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(MountPoseConfigs)

Applies the contents of the specified config to the device.

This will wait up to DefaultTimeoutSeconds.

Call to apply the selected configs.

public StatusCode Apply(MountPoseConfigs configs)

Parameters

configs MountPoseConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(MountPoseConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(MountPoseConfigs configs, double timeoutSeconds)

Parameters

configs MountPoseConfigs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(Pigeon2Configuration)

Applies the contents of the specified config to the device.

This will wait up to DefaultTimeoutSeconds.

Call to apply the selected configs.

public StatusCode Apply(Pigeon2Configuration configs)

Parameters

configs Pigeon2Configuration

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(Pigeon2Configuration, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(Pigeon2Configuration configs, double timeoutSeconds)

Parameters

configs Pigeon2Configuration

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(Pigeon2FeaturesConfigs)

Applies the contents of the specified config to the device.

This will wait up to DefaultTimeoutSeconds.

Call to apply the selected configs.

public StatusCode Apply(Pigeon2FeaturesConfigs configs)

Parameters

configs Pigeon2FeaturesConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(Pigeon2FeaturesConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(Pigeon2FeaturesConfigs configs, double timeoutSeconds)

Parameters

configs Pigeon2FeaturesConfigs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_BootDuringEnable()

Clear sticky fault: Device boot while detecting the enable signal

This will wait up to 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.

public StatusCode ClearStickyFault_BootDuringEnable()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_BootDuringEnable(double)

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.

public StatusCode ClearStickyFault_BootDuringEnable(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_BootIntoMotion()

Clear sticky fault: Motion Detected during bootup.

This will wait up to 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.

public StatusCode ClearStickyFault_BootIntoMotion()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_BootIntoMotion(double)

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.

public StatusCode ClearStickyFault_BootIntoMotion(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_BootupAccelerometer()

Clear sticky fault: Bootup checks failed: Accelerometer

This will wait up to 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.

public StatusCode ClearStickyFault_BootupAccelerometer()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_BootupAccelerometer(double)

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.

public StatusCode ClearStickyFault_BootupAccelerometer(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_BootupGyroscope()

Clear sticky fault: Bootup checks failed: Gyroscope

This will wait up to 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.

public StatusCode ClearStickyFault_BootupGyroscope()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_BootupGyroscope(double)

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.

public StatusCode ClearStickyFault_BootupGyroscope(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_BootupMagnetometer()

Clear sticky fault: Bootup checks failed: Magnetometer

This will wait up to 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.

public StatusCode ClearStickyFault_BootupMagnetometer()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_BootupMagnetometer(double)

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.

public StatusCode ClearStickyFault_BootupMagnetometer(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_DataAcquiredLate()

Clear sticky fault: Motion stack data acquisition was slower than expected

This will wait up to 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.

public StatusCode ClearStickyFault_DataAcquiredLate()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_DataAcquiredLate(double)

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.

public StatusCode ClearStickyFault_DataAcquiredLate(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_Hardware()

Clear sticky fault: Hardware fault occurred

This will wait up to 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.

public StatusCode ClearStickyFault_Hardware()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_Hardware(double)

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.

public StatusCode ClearStickyFault_Hardware(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_LoopTimeSlow()

Clear sticky fault: Motion stack loop time was slower than expected.

This will wait up to 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.

public StatusCode ClearStickyFault_LoopTimeSlow()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_LoopTimeSlow(double)

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.

public StatusCode ClearStickyFault_LoopTimeSlow(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_SaturatedAccelerometer()

Clear sticky fault: Accelerometer values are saturated

This will wait up to 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.

public StatusCode ClearStickyFault_SaturatedAccelerometer()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_SaturatedAccelerometer(double)

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.

public StatusCode ClearStickyFault_SaturatedAccelerometer(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_SaturatedGyroscope()

Clear sticky fault: Gyroscope values are saturated

This will wait up to 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.

public StatusCode ClearStickyFault_SaturatedGyroscope()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_SaturatedGyroscope(double)

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.

public StatusCode ClearStickyFault_SaturatedGyroscope(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_SaturatedMagnetometer()

Clear sticky fault: Magnetometer values are saturated

This will wait up to 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.

public StatusCode ClearStickyFault_SaturatedMagnetometer()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_SaturatedMagnetometer(double)

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.

public StatusCode ClearStickyFault_SaturatedMagnetometer(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_Undervoltage()

Clear sticky fault: Device supply voltage dropped to near brownout levels

This will wait up to 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.

public StatusCode ClearStickyFault_Undervoltage()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_Undervoltage(double)

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.

public StatusCode ClearStickyFault_Undervoltage(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_UnlicensedFeatureInUse()

Clear sticky fault: An unlicensed feature is in use, device may not behave as expected.

This will wait up to 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.

public StatusCode ClearStickyFault_UnlicensedFeatureInUse()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_UnlicensedFeatureInUse(double)

Clear sticky fault: An unlicensed feature is in use, device may not behave as 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.

public StatusCode ClearStickyFault_UnlicensedFeatureInUse(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

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 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.

public StatusCode ClearStickyFaults()

Returns

StatusCode

StatusCode of the set command

ClearStickyFaults(double)

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.

public StatusCode ClearStickyFaults(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

Refresh(CustomParamsConfigs)

Refreshes the values of the specified config group.

This will wait up to DefaultTimeoutSeconds.

Call to refresh the selected configs from the device.

public StatusCode Refresh(CustomParamsConfigs configs)

Parameters

configs CustomParamsConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(CustomParamsConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(CustomParamsConfigs configs, double timeoutSeconds)

Parameters

configs CustomParamsConfigs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(GyroTrimConfigs)

Refreshes the values of the specified config group.

This will wait up to DefaultTimeoutSeconds.

Call to refresh the selected configs from the device.

public StatusCode Refresh(GyroTrimConfigs configs)

Parameters

configs GyroTrimConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(GyroTrimConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(GyroTrimConfigs configs, double timeoutSeconds)

Parameters

configs GyroTrimConfigs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(MountPoseConfigs)

Refreshes the values of the specified config group.

This will wait up to DefaultTimeoutSeconds.

Call to refresh the selected configs from the device.

public StatusCode Refresh(MountPoseConfigs configs)

Parameters

configs MountPoseConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(MountPoseConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(MountPoseConfigs configs, double timeoutSeconds)

Parameters

configs MountPoseConfigs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(Pigeon2Configuration)

Refreshes the values of the specified config group.

This will wait up to DefaultTimeoutSeconds.

Call to refresh the selected configs from the device.

public StatusCode Refresh(Pigeon2Configuration configs)

Parameters

configs Pigeon2Configuration

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(Pigeon2Configuration, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(Pigeon2Configuration configs, double timeoutSeconds)

Parameters

configs Pigeon2Configuration

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(Pigeon2FeaturesConfigs)

Refreshes the values of the specified config group.

This will wait up to DefaultTimeoutSeconds.

Call to refresh the selected configs from the device.

public StatusCode Refresh(Pigeon2FeaturesConfigs configs)

Parameters

configs Pigeon2FeaturesConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(Pigeon2FeaturesConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(Pigeon2FeaturesConfigs configs, double timeoutSeconds)

Parameters

configs Pigeon2FeaturesConfigs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

SetYaw(double)

The yaw to set the Pigeon2 to right now.

This will wait up to 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.

public StatusCode SetYaw(double newValue)

Parameters

newValue double

Value to set to. Units are in deg.

Returns

StatusCode

StatusCode of the set command

SetYaw(double, double)

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.

public StatusCode SetYaw(double newValue, double timeoutSeconds)

Parameters

newValue double

Value to set to. Units are in deg.

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command