Class CANdleFeaturesConfigs

java.lang.Object
com.ctre.phoenix6.configs.CANdleFeaturesConfigs
All Implemented Interfaces:
ParentConfiguration, Cloneable
public class CANdleFeaturesConfigs extends Object implements ParentConfiguration, Cloneable
Configs related to general CANdle features.

This includes configs such as disabling the 5V rail and the behavior of VBat output.

  • Field Details

  • Constructor Details

    • CANdleFeaturesConfigs

      public CANdleFeaturesConfigs()

  • Method Details

    • withEnable5VRail

      public final CANdleFeaturesConfigs withEnable5VRail(Enable5VRailValue newEnable5VRail)
      Modifies this configuration's Enable5VRail parameter and returns itself for method-chaining and easier to use config API.

      Whether the 5V rail is enabled. Disabling the 5V rail will also turn off the onboard LEDs.

      Parameters:
      newEnable5VRail - Parameter to modify
      Returns:
      Itself

    • withVBatOutputMode

      public final CANdleFeaturesConfigs withVBatOutputMode(VBatOutputModeValue newVBatOutputMode)
      Modifies this configuration's VBatOutputMode parameter and returns itself for method-chaining and easier to use config API.

      The behavior of the VBat output. CANdle supports modulating VBat output for single-color LED strips.

      Parameters:
      newVBatOutputMode - Parameter to modify
      Returns:
      Itself

    • withStatusLedWhenActive

      public final CANdleFeaturesConfigs withStatusLedWhenActive(StatusLedWhenActiveValue newStatusLedWhenActive)
      Modifies this configuration's StatusLedWhenActive parameter and returns itself for method-chaining and easier to use config API.

      Whether the Status LED is enabled when the CANdle is actively being controlled.

      Parameters:
      newStatusLedWhenActive - Parameter to modify
      Returns:
      Itself

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • serialize

      public final String serialize()
      Get the serialized form of this configuration group.
      Specified by:
      serialize in interface ParentConfiguration
      Returns:
      Serialized form of this config group

    • deserialize

      public final StatusCode deserialize(String to_deserialize)
      Take a string and deserialize it to this configuration group.
      Specified by:
      deserialize in interface ParentConfiguration
      Parameters:
      to_deserialize - The serialized configuration
      Returns:
      Return code of the deserialize method

    • clone

      public CANdleFeaturesConfigs clone()
      Overrides:
      clone in class Object