Class CANdleConfigurator

Namespace

CTRE.Phoenix6.Configs

Assembly

Phoenix6.Hardware.dll

Class for CTR Electronics' CANdle® branded device, a device that controls LEDs over the CAN bus.

This handles applying and refreshing the configurations for the CANdle.

public class CANdleConfigurator : ParentConfigurator

Inheritance

object

ParentConfigurator

CANdleConfigurator

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

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

Parameters

configs CANdleConfiguration

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(CANdleConfiguration, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(CANdleConfiguration configs, double timeoutSeconds)

Parameters

configs CANdleConfiguration

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

Apply(CANdleFeaturesConfigs)

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

Parameters

configs CANdleFeaturesConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(CANdleFeaturesConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(CANdleFeaturesConfigs configs, double timeoutSeconds)

Parameters

configs CANdleFeaturesConfigs

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

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

Parameters

configs LEDConfigs

Configs to apply against.

Returns

StatusCode

StatusCode of the set command

Apply(LEDConfigs, double)

Applies the contents of the specified config to the device.

Call to apply the selected configs.

public StatusCode Apply(LEDConfigs configs, double timeoutSeconds)

Parameters

configs LEDConfigs

Configs to apply against.

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_5VTooHigh()

Clear sticky fault: Device 5V line is too high (above 6 V).

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

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_5VTooHigh(double)

Clear sticky fault: Device 5V line is too high (above 6 V).

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

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_5VTooLow()

Clear sticky fault: Device 5V line is too low (below 4 V).

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

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_5VTooLow(double)

Clear sticky fault: Device 5V line is too low (below 4 V).

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_5VTooLow(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_Overvoltage()

Clear sticky fault: Device supply voltage is too high (above 30 V).

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

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_Overvoltage(double)

Clear sticky fault: Device supply voltage is too high (above 30 V).

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

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_ShortCircuit()

Clear sticky fault: CANdle has detected the output pin is shorted.

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

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_ShortCircuit(double)

Clear sticky fault: CANdle has detected the output pin is shorted.

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

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_SoftwareFuse()

Clear sticky fault: CANdle output current exceeded the 6 A 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_SoftwareFuse()

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_SoftwareFuse(double)

Clear sticky fault: CANdle output current exceeded the 6 A 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_SoftwareFuse(double timeoutSeconds)

Parameters

timeoutSeconds double

Maximum time to wait up to in seconds.

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_Thermal()

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

Returns

StatusCode

StatusCode of the set command

ClearStickyFault_Thermal(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_Thermal(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(CANdleConfiguration)

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

Parameters

configs CANdleConfiguration

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(CANdleConfiguration, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(CANdleConfiguration configs, double timeoutSeconds)

Parameters

configs CANdleConfiguration

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(CANdleFeaturesConfigs)

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

Parameters

configs CANdleFeaturesConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(CANdleFeaturesConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(CANdleFeaturesConfigs configs, double timeoutSeconds)

Parameters

configs CANdleFeaturesConfigs

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

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

Parameters

configs LEDConfigs

The configs to refresh

Returns

StatusCode

StatusCode of refreshing the configs

Refresh(LEDConfigs, double)

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

public StatusCode Refresh(LEDConfigs configs, double timeoutSeconds)

Parameters

configs LEDConfigs

The configs to refresh

timeoutSeconds double

Maximum amount of time to wait when performing configuration

Returns

StatusCode

StatusCode of refreshing the configs