WPILibC++
2019.1.1-4-g308bdbe
|
The types of the widgets bundled with Shuffleboard. More...
#include <BuiltInWidgets.h>
Static Public Attributes | |
static const WidgetType | kTextView |
Displays a value with a simple text field. More... | |
static const WidgetType | kNumberSlider |
Displays a number with a controllable slider. More... | |
static const WidgetType | kNumberBar |
Displays a number with a view-only bar. More... | |
static const WidgetType | kDial |
Displays a number with a view-only dial. More... | |
static const WidgetType | kGraph |
Displays a number with a graph. More... | |
static const WidgetType | kBooleanBox |
Displays a boolean value as a large colored box. More... | |
static const WidgetType | kToggleButton |
Displays a boolean with a large interactive toggle button. More... | |
static const WidgetType | kToggleSwitch |
Displays a boolean with a fixed-size toggle switch. More... | |
static const WidgetType | kVoltageView |
Displays an analog input or a raw number with a number bar. More... | |
static const WidgetType | kPowerDistributionPanel |
Displays a PowerDistributionPanel. More... | |
static const WidgetType | kComboBoxChooser |
Displays a SendableChooser with a dropdown combo box with a list of options. More... | |
static const WidgetType | kSplitButtonChooser |
Displays a SendableChooser with a toggle button for each available option. More... | |
static const WidgetType | kEncoder |
Displays an edu.wpi.first.wpilibj.Encoder displaying its speed, total travelled distance, and its distance per tick. More... | |
static const WidgetType | kSpeedController |
Displays a SpeedController. More... | |
static const WidgetType | kCommand |
Displays a command with a toggle button. More... | |
static const WidgetType | kPIDCommand |
Displays a PID command with a checkbox and an editor for the PIDF constants. More... | |
static const WidgetType | kPIDController |
Displays a PID controller with an editor for the PIDF constants and a toggle switch for enabling and disabling the controller. More... | |
static const WidgetType | kAccelerometer |
Displays an accelerometer with a number bar displaying the magnitude of the acceleration and text displaying the exact value. More... | |
static const WidgetType | k3AxisAccelerometer |
Displays a 3-axis accelerometer with a number bar for each axis' accleration. More... | |
static const WidgetType | kGyro |
Displays a gyro with a dial from 0 to 360 degrees. More... | |
static const WidgetType | kRelay |
Displays a relay with toggle buttons for each supported mode (off, on, forward, reverse). More... | |
static const WidgetType | kDifferentialDrive |
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. More... | |
static const WidgetType | kMecanumDrive |
Displays a mecanum drive with a widget that displays the speed of each wheel, and vectors for the direction and rotation of the drivebase. More... | |
static const WidgetType | kCameraStream |
Displays a camera stream. More... | |
The types of the widgets bundled with Shuffleboard.
For example, setting a number to be displayed with a slider:
NetworkTableEntry example = Shuffleboard.getTab("My Tab").add("My Number", 0).withWidget(BuiltInWidgets.kNumberSlider).getEntry();
Each value in this enum goes into detail on what data types that widget can support, as well as the custom properties that widget uses.
|
static |
Displays a 3-axis accelerometer with a number bar for each axis' accleration.
Supported types:
Custom properties:
Name | Type | Default Value | Notes |
---|---|---|---|
Range | Range | k16G | The accelerometer range |
Show value | Boolean | true | Show or hide the acceleration values |
Precision | Number | 2 | How many numbers to display after the decimal point |
Show tick marks | Boolean | false | Show or hide the tick marks on the number bars |
|
static |
Displays an accelerometer with a number bar displaying the magnitude of the acceleration and text displaying the exact value.
Supported types:
Custom properties:
Name | Type | Default Value | Notes |
---|---|---|---|
Min | Number | -1 | The minimum acceleration value to display |
Max | Number | 1 | The maximum acceleration value to display |
Show text | Boolean | true | Show or hide the acceleration values |
Precision | Number | 2 | How many numbers to display after the decimal point |
Show tick marks | Boolean | false | Show or hide the tick marks on the number bars |
|
static |
Displays a boolean value as a large colored box.
Supported types:
Custom properties:
Name | Type | Default Value | Notes |
---|---|---|---|
Color when true | Color | "green" | Can be specified as a string ( "#00FF00"
0x00FF0000
|
Color when false | Color | "red" | Can be specified as a string or a number |
|
static |
Displays a camera stream.
Supported types:
Custom properties:
Name | Type | Default Value | Notes |
---|---|---|---|
Show crosshair | Boolean | true | Show or hide a crosshair on the image |
Crosshair color | Color | "white" | Can be a string or a rgba integer |
Show controls | Boolean | true | Show or hide the stream controls |
Rotation | String | "NONE" | Rotates the displayed image. One of ["NONE", "QUARTER_CW",
"QUARTER_CCW", "HALF"]
|
|
static |
Displays a SendableChooser with a dropdown combo box with a list of options.
Supported types:
This widget has no custom properties.
|
static |
Displays a command with a toggle button.
Pressing the button will start the command, and the button will automatically release when the command completes.
Supported types:
This widget has no custom properties.
|
static |
Displays a number with a view-only dial.
Displayed values are rounded to the nearest integer.
Supported types:
Custom properties:
Name | Type | Default Value | Notes |
---|---|---|---|
Min | Number | 0 | The minimum value of the dial |
Max | Number | 100 | The maximum value of the dial |
Show value | Boolean | true | Whether or not to show the value as text |
|
static |
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:
Custom properties:
Name | Type | Default Value | Notes |
---|---|---|---|
Number of wheels | Number | 4 | Must be a positive even integer |
Wheel diameter | Number | 80 | Pixels |
Show velocity vectors | Boolean | true |
|
static |
Displays an edu.wpi.first.wpilibj.Encoder displaying its speed, total travelled distance, and its distance per tick.
Supported types:
This widget has no custom properties.
|
static |
Displays a number with a graph.
NOTE: graphs can be taxing on the computer running the dashboard. Keep the number of visible data points to a minimum. Making the widget smaller also helps with performance, but may cause the graph to become difficult to read.
Supported types:
Custom properties:
Name | Type | Default Value | Notes |
---|---|---|---|
Visible time | Number | 30 | How long, in seconds, should past data be visible for |
|
static |
Displays a gyro with a dial from 0 to 360 degrees.
Supported types:
Custom properties:
Name | Type | Default Value | Notes |
---|---|---|---|
Major tick spacing | Number | 45 | Degrees |
Starting angle | Number | 180 | How far to rotate the entire dial, in degrees |
Show tick mark ring | Boolean | true |
|
static |
Displays a mecanum drive with a widget that displays the speed of each wheel, and vectors for the direction and rotation of the drivebase.
The widget will be controllable if the robot is in test mode.
Supported types:
Custom properties:
Name | Type | Default Value | Notes |
---|---|---|---|
Show velocity vectors | Boolean | true |
|
static |
Displays a number with a view-only bar.
Supported types:
Custom properties:
Name | Type | Default Value | Notes |
---|---|---|---|
Min | Number | -1.0 | The minimum value of the bar |
Max | Number | 1.0 | The maximum value of the bar |
Center | Number | 0 | The center ("zero") value of the bar |
|
static |
Displays a number with a controllable slider.
Supported types:
Custom properties:
Name | Type | Default Value | Notes |
---|---|---|---|
Min | Number | -1.0 | The minimum value of the slider |
Max | Number | 1.0 | The maximum value of the slider |
Block increment | Number | 0.0625 | How much to move the slider by with the arrow keys |
|
static |
Displays a PID command with a checkbox and an editor for the PIDF constants.
Selecting the checkbox will start the command, and the checkbox will automatically deselect when the command completes.
Supported types:
This widget has no custom properties.
|
static |
Displays a PID controller with an editor for the PIDF constants and a toggle switch for enabling and disabling the controller.
Supported types:
This widget has no custom properties.
|
static |
Displays a PowerDistributionPanel.
Supported types:
Custom properties:
Name | Type | Default Value | Notes |
---|---|---|---|
Show voltage and current values | Boolean | true | Whether or not to display the voltage and current draw |
|
static |
Displays a relay with toggle buttons for each supported mode (off, on, forward, reverse).
Supported types:
This widget has no custom properties.
|
static |
Displays a SpeedController.
The speed controller will be controllable from the dashboard when test mode is enabled, but will otherwise be view-only.
Supported types:
Custom properties:
Name | Type | Default Value | Notes |
---|---|---|---|
Orientation | String | "HORIZONTAL" | One of ["HORIZONTAL", "VERTICAL"]
|
|
static |
Displays a SendableChooser with a toggle button for each available option.
Supported types:
This widget has no custom properties.
|
static |
Displays a value with a simple text field.
Supported types:
This widget has no custom properties.
|
static |
Displays a boolean with a large interactive toggle button.
Supported types:
This widget has no custom properties.
|
static |
Displays a boolean with a fixed-size toggle switch.
Supported types:
This widget has no custom properties.
|
static |
Displays an analog input or a raw number with a number bar.
Supported types:
Custom properties:
Name | Type | Default Value | Notes |
---|---|---|---|
Min | Number | 0 | The minimum value of the bar |
Max | Number | 5 | The maximum value of the bar |
Center | Number | 0 | The center ("zero") value of the bar |
Orientation | String | "HORIZONTAL" | The orientation of the bar. One of ["HORIZONTAL",
"VERTICAL"]
|
Number of tick marks | Number | 5 | The number of discrete ticks on the bar |