Package frc.lib.lowlevel

Enum Class SparkTap.Frame

java.lang.Object
java.lang.Enum<SparkTap.Frame>
frc.lib.lowlevel.SparkTap.Frame
All Implemented Interfaces:
Serializable, Comparable<SparkTap.Frame>, Constable
Enclosing class:
SparkTap
public static enum SparkTap.Frame extends Enum<SparkTap.Frame>
Represents the different CAN status frames sent by the Spark Max.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    S0
    Status 0 frame (Bus, Power, and Limits).
    S1
    Status 1 frame (Diagnostics and Status).
    S2
    Status 2 frame (Primary Encoder).
    S3
    Status 3 frame (Analog Sensor).
    S4
    Status 4 frame (Alternate Encoder).
    S5
    Status 5 frame (Duty Cycle Absolute Encoder).
    S6
    Status 6 frame (Duty Cycle Absolute Encoder Velocity).

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final int
    idx
    The internal index of the frame in the memory map.

  • Method Summary

    Modifier and Type
    Method
    Description
    static SparkTap.Frame
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static SparkTap.Frame[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • S0

      public static final SparkTap.Frame S0
      Status 0 frame (Bus, Power, and Limits).

    • S1

      public static final SparkTap.Frame S1
      Status 1 frame (Diagnostics and Status).

    • S2

      public static final SparkTap.Frame S2
      Status 2 frame (Primary Encoder).

    • S3

      public static final SparkTap.Frame S3
      Status 3 frame (Analog Sensor).

    • S4

      public static final SparkTap.Frame S4
      Status 4 frame (Alternate Encoder).

    • S5

      public static final SparkTap.Frame S5
      Status 5 frame (Duty Cycle Absolute Encoder).

    • S6

      public static final SparkTap.Frame S6
      Status 6 frame (Duty Cycle Absolute Encoder Velocity).

  • Field Details

    • idx

      public final int idx
      The internal index of the frame in the memory map.

  • Method Details

    • values

      public static SparkTap.Frame[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SparkTap.Frame valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null