Class CANcoderConfigurator
public class CANcoderConfigurator extends ParentConfigurator
CANcoder
-
Field Summary
-
Constructor Summary
Constructors Constructor Description CANcoderConfigurator(DeviceIdentifier id)
-
Method Summary
Modifier and Type Method Description StatusCode
apply(CANcoderConfiguration configs)
Applies the contents of the specified config to the device.StatusCode
apply(CANcoderConfiguration configs, double timeoutSeconds)
Applies the contents of the specified config to the device.StatusCode
apply(MagnetSensorConfigs configs)
Applies the contents of the specified config to the device.StatusCode
apply(MagnetSensorConfigs configs, double timeoutSeconds)
Applies the contents of the specified config to the device.StatusCode
clearStickyFaults()
Clear the sticky faults in the device.StatusCode
clearStickyFaults(double timeoutSeconds)
Clear the sticky faults in the device.StatusCode
refresh(CANcoderConfiguration configs)
Refreshes the values of the specified config group.StatusCode
refresh(CANcoderConfiguration configs, double timeoutSeconds)
Refreshes the values of the specified config group.StatusCode
refresh(MagnetSensorConfigs configs)
Refreshes the values of the specified config group.StatusCode
refresh(MagnetSensorConfigs configs, double timeoutSeconds)
Refreshes the values of the specified config group.StatusCode
setPosition(double newValue)
The position to set the sensor position to right now.StatusCode
setPosition(double newValue, double timeoutSeconds)
The position to set the sensor position to right now.Methods inherited from class com.ctre.phoenixpro.configs.ParentConfigurator
getConfigsPrivate, setConfigsPrivate
-
Constructor Details
-
Method Details
-
refresh
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
Refreshes the values of the specified config group.Call to refresh the selected configs from the device.
- Parameters:
configs
- The configs to refreshtimeoutSeconds
- Maximum amount of time to wait when performing configuration- Returns:
- StatusCode of refreshing the configs
-
apply
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
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
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
Refreshes the values of the specified config group.Call to refresh the selected configs from the device.
- Parameters:
configs
- The configs to refreshtimeoutSeconds
- Maximum amount of time to wait when performing configuration- Returns:
- StatusCode of refreshing the configs
-
apply
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
Applies the contents of the specified config to the device.Call to apply the selected configs.
- Parameters:
configs
- Configs to apply against.timeoutSeconds
- Maximum amount of time to wait when performing configuration- Returns:
- StatusCode of the set command
-
setPosition
The position to set the sensor position 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
-
setPosition
The position to set the sensor position 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
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
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
-