Shuffleboard

class wpilib.shuffleboard.Shuffleboard

Bases: pybind11_object

The Shuffleboard class provides a mechanism with which data can be added and laid out in the Shuffleboard dashboard application from a robot program. Tabs and layouts can be specified, as well as choosing which widgets to display with and setting properties of these widgets; for example, programmers can specify a specific boolean value to be displayed with a toggle button instead of the default colored box, or set custom colors for that box.

For example, displaying a boolean entry with a toggle button: <pre>{@code NetworkTableEntry myBoolean = Shuffleboard.getTab(“Example Tab”) .add(“My Boolean”, false) .withWidget(“Toggle Button”) .getEntry(); }</pre>

Changing the colors of the boolean box: <pre>{@code NetworkTableEntry myBoolean = Shuffleboard.getTab(“Example Tab”) .add(“My Boolean”, false) .withWidget(“Boolean Box”) .withProperties(Map.of(“colorWhenTrue”, “green”, “colorWhenFalse”, “maroon”)) .getEntry(); }</pre>

Specifying a parent layout. Note that the layout type must always be specified, even if the layout has already been generated by a previously defined entry. <pre>{@code NetworkTableEntry myBoolean = Shuffleboard.getTab(“Example Tab”) .getLayout(“List”, “Example List”) .add(“My Boolean”, false) .withWidget(“Toggle Button”) .getEntry(); }</pre> </p>

Teams are encouraged to set up shuffleboard layouts at the start of the robot program.

static addEventMarker(*args, **kwargs)

Overloaded function.

  1. addEventMarker(name: str, description: str, importance: wpilib.shuffleboard._shuffleboard.ShuffleboardEventImportance) -> None

Notifies Shuffleboard of an event. Events can range from as trivial as a change in a command state to as critical as a total power loss or component failure. If Shuffleboard is recording, the event will also be recorded.

If name is null or empty, no event will be sent and an error will be printed to the driver station.

Parameters:

  • name – the name of the event

  • description – a description of the event

  • importance – the importance of the event

  1. addEventMarker(name: str, importance: wpilib.shuffleboard._shuffleboard.ShuffleboardEventImportance) -> None

Notifies Shuffleboard of an event. Events can range from as trivial as a change in a command state to as critical as a total power loss or component failure. If Shuffleboard is recording, the event will also be recorded.

If name is null or empty, no event will be sent and an error will be printed to the driver station.

Parameters:

  • name – the name of the event

  • importance – the importance of the event

static clearRecordingFileNameFormat() → None

Clears the custom name format for recording files. New recordings will use the default format.

@see SetRecordingFileNameFormat(std::string_view)

static disableActuatorWidgets() → None

Disables user control of widgets containing actuators. For safety reasons, actuators should only be controlled while in test mode. IterativeRobotBase and SampleRobot are both configured to call this method when exiting in test mode; most users should not need to use this method directly.

static enableActuatorWidgets() → None

Enables user control of widgets containing actuators: motor controllers, relays, etc. This should only be used when the robot is in test mode. IterativeRobotBase and SampleRobot are both configured to call this method when entering test mode; most users should not need to use this method directly.

static getTab(title: str) → wpilib.shuffleboard._shuffleboard.ShuffleboardTab

Gets the Shuffleboard tab with the given title, creating it if it does not already exist.

Parameters:

title – the title of the tab

Returns:

the tab with the given title

kBaseTableName = '/Shuffleboard'
static selectTab(*args, **kwargs)

Overloaded function.

  1. selectTab(index: int) -> None

Selects the tab in the dashboard with the given index in the range [0..n-1], where n is the number of tabs in the dashboard at the time this method is called.

Parameters:

index – the index of the tab to select

  1. selectTab(title: str) -> None

Selects the tab in the dashboard with the given title.

Parameters:

title – the title of the tab to select

static setRecordingFileNameFormat(format: str) → None

Sets the file name format for new recording files to use. If recording is in progress when this method is called, it will continue to use the same file. New recordings will use the format.

To avoid recording files overwriting each other, make sure to use unique recording file names. File name formats accept templates for inserting the date and time when the recording started with the ${date} and ${time} templates, respectively. For example, the default format is "recording-${time”} and recording files created with it will have names like "recording-2018.01.15.sbr". Users are strongly recommended to use the ${time} template to ensure unique file names. </p>

Parameters:

format – the format for the

static startRecording() → None

Starts data recording on the dashboard. Has no effect if recording is already in progress.

static stopRecording() → None

Stops data recording on the dashboard. Has no effect if no recording is in progress.

static update() → None

Updates all the values in Shuffleboard. Iterative and timed robots are pre-configured to call this method in the main robot loop; teams using custom robot base classes, or subclass SampleRobot, should make sure to call this repeatedly to keep data on the dashboard up to date.