Class CANdiConfigurator

Namespace

CTRE.Phoenix6.Configs

Assembly

Phoenix6.Hardware.dll

Class for CTR Electronics' CANdi™ branded device, a device that integrates digital signals into the existing CAN bus network.

This handles applying and refreshing the configurations for the CANdi.

public class CANdiConfigurator : ParentConfigurator

Inheritance

object

ParentConfigurator

CANdiConfigurator

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

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

Parameters

configs CANdiConfiguration

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(CANdiConfiguration, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(CANdiConfiguration configs, double timeoutSeconds)

Parameters

configs CANdiConfiguration

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

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

Parameters

configs DigitalInputsConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(DigitalInputsConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(DigitalInputsConfigs configs, double timeoutSeconds)

Parameters

configs DigitalInputsConfigs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(PWM1Configs)

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

Parameters

configs PWM1Configs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(PWM1Configs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(PWM1Configs configs, double timeoutSeconds)

Parameters

configs PWM1Configs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(PWM2Configs)

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

Parameters

configs PWM2Configs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(PWM2Configs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(PWM2Configs configs, double timeoutSeconds)

Parameters

configs PWM2Configs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(QuadratureConfigs)

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

Parameters

configs QuadratureConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(QuadratureConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(QuadratureConfigs configs, double timeoutSeconds)

Parameters

configs QuadratureConfigs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_5V()

Clear sticky fault: The CTR Electronics' CANdi™ branded device has detected a 5V fault. This may be due to overcurrent or a short-circuit.

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

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_5V(double)

Clear sticky fault: The CTR Electronics' CANdi™ branded device has detected a 5V fault. This may be due to overcurrent or a short-circuit.

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

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

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_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_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(CANdiConfiguration)

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

Parameters

configs CANdiConfiguration

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(CANdiConfiguration, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(CANdiConfiguration configs, double timeoutSeconds)

Parameters

configs CANdiConfiguration

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

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

Parameters

configs DigitalInputsConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(DigitalInputsConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(DigitalInputsConfigs configs, double timeoutSeconds)

Parameters

configs DigitalInputsConfigs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(PWM1Configs)

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

Parameters

configs PWM1Configs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(PWM1Configs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(PWM1Configs configs, double timeoutSeconds)

Parameters

configs PWM1Configs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(PWM2Configs)

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

Parameters

configs PWM2Configs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(PWM2Configs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(PWM2Configs configs, double timeoutSeconds)

Parameters

configs PWM2Configs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(QuadratureConfigs)

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

Parameters

configs QuadratureConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(QuadratureConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(QuadratureConfigs configs, double timeoutSeconds)

Parameters

configs QuadratureConfigs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

SetQuadraturePosition(double)

Sets the position of the quadrature input.

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

Parameters

newValue double

Value to set to. Units are in rotations.

Returns

StatusCode

StatusCode of the set command

SetQuadraturePosition(double, double)

Sets the position of the quadrature input.

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 SetQuadraturePosition(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