Class TalonFXConfigurator

Namespace

CTRE.Phoenix6.Configs

Assembly

Phoenix6.Hardware.dll

Class description for the Talon FX integrated motor controller.

This handles applying and refreshing the configurations for the TalonFX.

public class TalonFXConfigurator : ParentConfigurator

Inheritance

object

ParentConfigurator

TalonFXConfigurator

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(AudioConfigs)

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(AudioConfigs configs)

Parameters

configs AudioConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(AudioConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(AudioConfigs configs, double timeoutSeconds)

Parameters

configs AudioConfigs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(ClosedLoopGeneralConfigs)

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(ClosedLoopGeneralConfigs configs)

Parameters

configs ClosedLoopGeneralConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(ClosedLoopGeneralConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(ClosedLoopGeneralConfigs configs, double timeoutSeconds)

Parameters

configs ClosedLoopGeneralConfigs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(ClosedLoopRampsConfigs)

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(ClosedLoopRampsConfigs configs)

Parameters

configs ClosedLoopRampsConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(ClosedLoopRampsConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(ClosedLoopRampsConfigs configs, double timeoutSeconds)

Parameters

configs ClosedLoopRampsConfigs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(CurrentLimitsConfigs)

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(CurrentLimitsConfigs configs)

Parameters

configs CurrentLimitsConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(CurrentLimitsConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(CurrentLimitsConfigs configs, double timeoutSeconds)

Parameters

configs CurrentLimitsConfigs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

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(DifferentialConstantsConfigs)

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(DifferentialConstantsConfigs configs)

Parameters

configs DifferentialConstantsConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(DifferentialConstantsConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(DifferentialConstantsConfigs configs, double timeoutSeconds)

Parameters

configs DifferentialConstantsConfigs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(DifferentialSensorsConfigs)

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(DifferentialSensorsConfigs configs)

Parameters

configs DifferentialSensorsConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(DifferentialSensorsConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(DifferentialSensorsConfigs configs, double timeoutSeconds)

Parameters

configs DifferentialSensorsConfigs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(FeedbackConfigs)

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(FeedbackConfigs configs)

Parameters

configs FeedbackConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(FeedbackConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(FeedbackConfigs configs, double timeoutSeconds)

Parameters

configs FeedbackConfigs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(HardwareLimitSwitchConfigs)

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(HardwareLimitSwitchConfigs configs)

Parameters

configs HardwareLimitSwitchConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(HardwareLimitSwitchConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(HardwareLimitSwitchConfigs configs, double timeoutSeconds)

Parameters

configs HardwareLimitSwitchConfigs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(MotionMagicConfigs)

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(MotionMagicConfigs configs)

Parameters

configs MotionMagicConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(MotionMagicConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(MotionMagicConfigs configs, double timeoutSeconds)

Parameters

configs MotionMagicConfigs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(MotorOutputConfigs)

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(MotorOutputConfigs configs)

Parameters

configs MotorOutputConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(MotorOutputConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(MotorOutputConfigs configs, double timeoutSeconds)

Parameters

configs MotorOutputConfigs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(OpenLoopRampsConfigs)

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(OpenLoopRampsConfigs configs)

Parameters

configs OpenLoopRampsConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(OpenLoopRampsConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(OpenLoopRampsConfigs configs, double timeoutSeconds)

Parameters

configs OpenLoopRampsConfigs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(Slot0Configs)

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(Slot0Configs configs)

Parameters

configs Slot0Configs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(Slot0Configs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(Slot0Configs configs, double timeoutSeconds)

Parameters

configs Slot0Configs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(Slot1Configs)

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(Slot1Configs configs)

Parameters

configs Slot1Configs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(Slot1Configs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(Slot1Configs configs, double timeoutSeconds)

Parameters

configs Slot1Configs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(Slot2Configs)

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(Slot2Configs configs)

Parameters

configs Slot2Configs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(Slot2Configs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(Slot2Configs configs, double timeoutSeconds)

Parameters

configs Slot2Configs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(SlotConfigs)

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(SlotConfigs configs)

Parameters

configs SlotConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(SlotConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(SlotConfigs configs, double timeoutSeconds)

Parameters

configs SlotConfigs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(SoftwareLimitSwitchConfigs)

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(SoftwareLimitSwitchConfigs configs)

Parameters

configs SoftwareLimitSwitchConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(SoftwareLimitSwitchConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(SoftwareLimitSwitchConfigs configs, double timeoutSeconds)

Parameters

configs SoftwareLimitSwitchConfigs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(TalonFXConfiguration)

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(TalonFXConfiguration configs)

Parameters

configs TalonFXConfiguration

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(TalonFXConfiguration, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(TalonFXConfiguration configs, double timeoutSeconds)

Parameters

configs TalonFXConfiguration

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(TorqueCurrentConfigs)

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(TorqueCurrentConfigs configs)

Parameters

configs TorqueCurrentConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(TorqueCurrentConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(TorqueCurrentConfigs configs, double timeoutSeconds)

Parameters

configs TorqueCurrentConfigs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(VoltageConfigs)

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(VoltageConfigs configs)

Parameters

configs VoltageConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(VoltageConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(VoltageConfigs configs, double timeoutSeconds)

Parameters

configs VoltageConfigs

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_BridgeBrownout()

Clear sticky fault: Bridge was disabled most likely due to supply voltage dropping too low.

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_BridgeBrownout()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_BridgeBrownout(double)

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.

public StatusCode ClearStickyFault_BridgeBrownout(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_DeviceTemp()

Clear sticky fault: Device temperature exceeded limit

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_DeviceTemp()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_DeviceTemp(double)

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.

public StatusCode ClearStickyFault_DeviceTemp(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_ForwardHardLimit()

Clear sticky fault: Forward limit switch has been asserted. Output is set to neutral.

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_ForwardHardLimit()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_ForwardHardLimit(double)

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.

public StatusCode ClearStickyFault_ForwardHardLimit(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_ForwardSoftLimit()

Clear sticky fault: Forward soft limit has been asserted. Output is set to neutral.

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_ForwardSoftLimit()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_ForwardSoftLimit(double)

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.

public StatusCode ClearStickyFault_ForwardSoftLimit(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

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 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_FusedSensorOutOfSync()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_FusedSensorOutOfSync(double)

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.

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

Clear sticky fault: The remote Talon used for differential control is not present on CAN Bus.

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_MissingDifferentialFX()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_MissingDifferentialFX(double)

Clear sticky fault: The remote Talon 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.

public StatusCode ClearStickyFault_MissingDifferentialFX(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_MissingHardLimitRemote()

Clear sticky fault: The remote limit switch device is not present on CAN Bus.

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_MissingHardLimitRemote()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_MissingHardLimitRemote(double)

Clear sticky fault: The remote limit switch device 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.

public StatusCode ClearStickyFault_MissingHardLimitRemote(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_MissingSoftLimitRemote()

Clear sticky fault: The remote soft limit device is not present on CAN Bus.

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_MissingSoftLimitRemote()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_MissingSoftLimitRemote(double)

Clear sticky fault: The remote soft limit device 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.

public StatusCode ClearStickyFault_MissingSoftLimitRemote(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_OverSupplyV()

Clear sticky fault: Supply Voltage has exceeded the maximum voltage rating of device.

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_OverSupplyV()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_OverSupplyV(double)

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.

public StatusCode ClearStickyFault_OverSupplyV(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_ProcTemp()

Clear sticky fault: Processor temperature exceeded limit

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_ProcTemp()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_ProcTemp(double)

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.

public StatusCode ClearStickyFault_ProcTemp(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

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 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_RemoteSensorDataInvalid()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_RemoteSensorDataInvalid(double)

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.

public StatusCode ClearStickyFault_RemoteSensorDataInvalid(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

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 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_RemoteSensorPosOverflow()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_RemoteSensorPosOverflow(double)

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.

public StatusCode ClearStickyFault_RemoteSensorPosOverflow(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_RemoteSensorReset()

Clear sticky fault: The remote sensor has reset.

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_RemoteSensorReset()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_RemoteSensorReset(double)

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.

public StatusCode ClearStickyFault_RemoteSensorReset(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_ReverseHardLimit()

Clear sticky fault: Reverse limit switch has been asserted. Output is set to neutral.

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_ReverseHardLimit()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_ReverseHardLimit(double)

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.

public StatusCode ClearStickyFault_ReverseHardLimit(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_ReverseSoftLimit()

Clear sticky fault: Reverse soft limit has been asserted. Output is set to neutral.

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_ReverseSoftLimit()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_ReverseSoftLimit(double)

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.

public StatusCode ClearStickyFault_ReverseSoftLimit(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_StaticBrakeDisabled()

Clear sticky fault: Static brake was momentarily disabled due to excessive braking current while disabled.

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_StaticBrakeDisabled()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_StaticBrakeDisabled(double)

Clear sticky fault: Static brake was momentarily disabled due to excessive braking current while disabled.

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_StaticBrakeDisabled(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_StatorCurrLimit()

Clear sticky fault: Stator current limit occured.

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_StatorCurrLimit()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_StatorCurrLimit(double)

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.

public StatusCode ClearStickyFault_StatorCurrLimit(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_SupplyCurrLimit()

Clear sticky fault: Supply current limit occured.

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_SupplyCurrLimit()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_SupplyCurrLimit(double)

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.

public StatusCode ClearStickyFault_SupplyCurrLimit(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

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 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_UnstableSupplyV()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_UnstableSupplyV(double)

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.

public StatusCode ClearStickyFault_UnstableSupplyV(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_UsingFusedCANcoderWhileUnlicensed()

Clear sticky fault: Using Fused CANcoder feature while unlicensed. Device has fallen back to remote CANcoder.

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_UsingFusedCANcoderWhileUnlicensed()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_UsingFusedCANcoderWhileUnlicensed(double)

Clear sticky fault: Using Fused CANcoder feature while unlicensed. Device has fallen back to remote CANcoder.

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_UsingFusedCANcoderWhileUnlicensed(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(AudioConfigs)

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(AudioConfigs configs)

Parameters

configs AudioConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(AudioConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(AudioConfigs configs, double timeoutSeconds)

Parameters

configs AudioConfigs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(ClosedLoopGeneralConfigs)

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(ClosedLoopGeneralConfigs configs)

Parameters

configs ClosedLoopGeneralConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(ClosedLoopGeneralConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(ClosedLoopGeneralConfigs configs, double timeoutSeconds)

Parameters

configs ClosedLoopGeneralConfigs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(ClosedLoopRampsConfigs)

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(ClosedLoopRampsConfigs configs)

Parameters

configs ClosedLoopRampsConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(ClosedLoopRampsConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(ClosedLoopRampsConfigs configs, double timeoutSeconds)

Parameters

configs ClosedLoopRampsConfigs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(CurrentLimitsConfigs)

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(CurrentLimitsConfigs configs)

Parameters

configs CurrentLimitsConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(CurrentLimitsConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(CurrentLimitsConfigs configs, double timeoutSeconds)

Parameters

configs CurrentLimitsConfigs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

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(DifferentialConstantsConfigs)

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(DifferentialConstantsConfigs configs)

Parameters

configs DifferentialConstantsConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(DifferentialConstantsConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(DifferentialConstantsConfigs configs, double timeoutSeconds)

Parameters

configs DifferentialConstantsConfigs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(DifferentialSensorsConfigs)

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(DifferentialSensorsConfigs configs)

Parameters

configs DifferentialSensorsConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(DifferentialSensorsConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(DifferentialSensorsConfigs configs, double timeoutSeconds)

Parameters

configs DifferentialSensorsConfigs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(FeedbackConfigs)

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(FeedbackConfigs configs)

Parameters

configs FeedbackConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(FeedbackConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(FeedbackConfigs configs, double timeoutSeconds)

Parameters

configs FeedbackConfigs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(HardwareLimitSwitchConfigs)

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(HardwareLimitSwitchConfigs configs)

Parameters

configs HardwareLimitSwitchConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(HardwareLimitSwitchConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(HardwareLimitSwitchConfigs configs, double timeoutSeconds)

Parameters

configs HardwareLimitSwitchConfigs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(MotionMagicConfigs)

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(MotionMagicConfigs configs)

Parameters

configs MotionMagicConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(MotionMagicConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(MotionMagicConfigs configs, double timeoutSeconds)

Parameters

configs MotionMagicConfigs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(MotorOutputConfigs)

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(MotorOutputConfigs configs)

Parameters

configs MotorOutputConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(MotorOutputConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(MotorOutputConfigs configs, double timeoutSeconds)

Parameters

configs MotorOutputConfigs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(OpenLoopRampsConfigs)

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(OpenLoopRampsConfigs configs)

Parameters

configs OpenLoopRampsConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(OpenLoopRampsConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(OpenLoopRampsConfigs configs, double timeoutSeconds)

Parameters

configs OpenLoopRampsConfigs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(Slot0Configs)

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(Slot0Configs configs)

Parameters

configs Slot0Configs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(Slot0Configs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(Slot0Configs configs, double timeoutSeconds)

Parameters

configs Slot0Configs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(Slot1Configs)

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(Slot1Configs configs)

Parameters

configs Slot1Configs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(Slot1Configs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(Slot1Configs configs, double timeoutSeconds)

Parameters

configs Slot1Configs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(Slot2Configs)

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(Slot2Configs configs)

Parameters

configs Slot2Configs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(Slot2Configs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(Slot2Configs configs, double timeoutSeconds)

Parameters

configs Slot2Configs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(SlotConfigs)

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(SlotConfigs configs)

Parameters

configs SlotConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(SlotConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(SlotConfigs configs, double timeoutSeconds)

Parameters

configs SlotConfigs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(SoftwareLimitSwitchConfigs)

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(SoftwareLimitSwitchConfigs configs)

Parameters

configs SoftwareLimitSwitchConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(SoftwareLimitSwitchConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(SoftwareLimitSwitchConfigs configs, double timeoutSeconds)

Parameters

configs SoftwareLimitSwitchConfigs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(TalonFXConfiguration)

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(TalonFXConfiguration configs)

Parameters

configs TalonFXConfiguration

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(TalonFXConfiguration, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(TalonFXConfiguration configs, double timeoutSeconds)

Parameters

configs TalonFXConfiguration

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(TorqueCurrentConfigs)

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(TorqueCurrentConfigs configs)

Parameters

configs TorqueCurrentConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(TorqueCurrentConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(TorqueCurrentConfigs configs, double timeoutSeconds)

Parameters

configs TorqueCurrentConfigs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(VoltageConfigs)

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(VoltageConfigs configs)

Parameters

configs VoltageConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(VoltageConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(VoltageConfigs configs, double timeoutSeconds)

Parameters

configs VoltageConfigs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

SetPosition(double)

Sets the mechanism position of the device in mechanism rotations.

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 SetPosition(double newValue)

Parameters

newValue double

Value to set to. Units are in rotations.

Returns

StatusCode

StatusCode of the set command

SetPosition(double, double)

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.

public StatusCode SetPosition(double newValue, double timeoutSeconds)

Parameters

newValue double

Value to set to. Units are in rotations.

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command