Package io.github.oblarg.oblog.annotations

Annotation Type Log.ThreeAxisAccelerometer

  • @Repeatable(ThreeAxisAccelerometers.class)
@Retention(RUNTIME)
@Target({FIELD,METHOD})
public static @interface Log.ThreeAxisAccelerometer
    Displays a 3-axis accelerometer with a number bar for each axis' acceleration.
    Supported types:
    • ADXL345_I2C
    • ADXL345_SPI
    • ADXL362

    Custom properties:
    NameTypeDefault ValueNotes
    RangeAccelerometer.Rangek16GThe accelerometer range
    Show valueBooleantrue Show or hide the acceleration values
    PrecisionNumber2 How many numbers to display after the decimal point
    Show tick marksBooleanfalse Show or hide the tick marks on the number bars

    • 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"

      • range

        edu.wpi.first.wpilibj.interfaces.Accelerometer.Range range
        Returns:
        The range of the accelerometer.
        Default:
        edu.wpi.first.wpilibj.interfaces.Accelerometer.Range.k16G

      • showValue

        boolean showValue
        Returns:
        Whether to show or hide the acceleration values.
        Default:
        true

      • precision

        int precision
        Returns:
        How many digits to display after the decimal point.
        Default:
        2

      • showTicks

        boolean showTicks
        Returns:
        Whether to show the tick marks on the number bars.
        Default:
        false

      • 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