Package io.github.oblarg.oblog.annotations

Annotation Type Log.DifferentialDrive

  • @Repeatable(DifferentialDrives.class)
@Retention(RUNTIME)
@Target({FIELD,METHOD})
public static @interface Log.DifferentialDrive
    Displays a differential drive with a widget that displays the speed of each side of the drivebase and a vector for the direction and rotation of the drivebase. The widget will be controllable if the robot is in test mode.
    Supported types:
    • DifferentialDrive

    Custom properties:
    NameTypeDefault ValueNotes
    Number of wheelsNumber4Must be a positive even integer
    Wheel diameterNumber80Pixels
    Show velocity vectorsBooleantrue

    • Element Detail

      • name

        java.lang.String name
        Returns:
        The name of the value on Shuffleboard; defaults to field or method name.
        Default:
        "NO_NAME"

      • tabName

        java.lang.String tabName
        Returns:
        The name of the tab in which to place this widget, if the default inferred tab/layout is not desired. Users should be careful to avoid namespace collisions if the default tab is not used. Note that Log and config annotations can be repeated to place widgets on multiple tabs.
        Default:
        "DEFAULT"

      • methodName

        java.lang.String methodName
        Returns:
        Optional name of a method to call on the field (or return value of the method) to obtain the actual value that will be logged. Useful if one does not desire to make an entire object Loggable, but still wants to log a value from it.
        Default:
        "DEFAULT"

      • numWheels

        int numWheels
        Returns:
        Number of wheels. Must be a positive, even integer.
        Default:
        4

      • wheelDiameter

        double wheelDiameter
        Returns:
        Wheel diameter in pixels.
        Default:
        80.0

      • showVel

        boolean showVel
        Returns:
        Whether to show the velocity vectors.
        Default:
        true

      • rowIndex

        int rowIndex
        Returns:
        The row in which this widget should be placed. WARNING: If position/size is specified for one widget in an object, it should be specified for all widgets in that object to avoid overlaps.
        Default:
        -1

      • columnIndex

        int columnIndex
        Returns:
        The column in which this widget should be placed. WARNING: If position/size is specified for one widget in an object, it should be specified for all widgets in that object to avoid overlaps.
        Default:
        -1

      • width

        int width
        Returns:
        The width of this widget. WARNING: If position/size is specified for one widget in an object, it should be specified for all widgets in that object to avoid overlaps.
        Default:
        -1

      • height

        int height
        Returns:
        The height of this widget. WARNING: If position/size is specified for one widget in an object, it should be specified for all widgets in that object to avoid overlaps.
        Default:
        -1