wpilibsuite / shuffleboard

A modern dashboard for FRC

Shuffleboard

Structure

Shuffleboard is organized into three base projects: api, app, and plugins. plugins has additional subprojects that the main app depends on to provide data types, widgets, and data sources for basic FRC use.

Running

Shuffleboard is installed by the FRC vscode extension: Installation Instructions. It can be launched from the WPILib menu in Visual Studio Code (start tool). It can also be run manually by running the shuffleboard.vbs in c:\Users\public\wpilib\<year>\tools (Windows) or shuffleboard.py in ~/wpilib/<year>/tools (Linux or Mac).

Requirements

• JRE 11. Java 11 is required. No other version of Java is supported. Java 11 is installed by the WPILib installer.

Building

To run shuffleboard use the command ./gradlew :app:run.

To build the APIs and utility classes used in plugin creation, use the command ./gradlew :api:shadowJar

To build the Shuffleboard application, use the command ./gradlew :app:shadowJar. By default, this will create an executable JAR for your operating system. To build for another OS, use one of the platform-specific builds:

OS	Command
Windows 64-bit	./gradlew :app:shadowJar-win64
Windows 32-bit	./gradlew :app:shadowJar-win32
Mac	./gradlew :app:shadowJar-mac64
Linux 64-bit	./gradlew :app:shadowJar-linux64

Only the listed platforms are supported

To build all platform-specific JARs at once, use the command ./gradlew :app:shadowJarAllPlatforms

Requirements

• JDK 11. JDK 11 is required. No other version of Java is supported.

shuffleboard's Issues

Add LiveWindow support

UI is too big

The UI is too large and less information can be presented in a single view. See the attached image of 2 identically sized windows. On the left is shuffleboard. On the right is SmartDashboard.

Improve recording file organization

They should be saved in a format like SmartDashboard/recordings/YYYY-MM-DD/hh-mm-ss-timestamp.sblog

This makes it easier to clean out super old recordings, and easier to find the recordings you're looking for

Tiles should use the "card" CSS class

This ties them in more with material design. We should also remove the blue background from tiles as part of this

Tests fail on travis Linux instance

Class	Test
MainWindowControllerTest	testDragSingleNetworkTableSourceToWidgetPane
CompositeNetworkTableSourceTest	testDataUpdates
SingleKeyNetworkTableSourceTest	testValueUpdates
WidgetSaverTest	loadSimpleWidget

Widget settings should expand

I do not like this UX. Is there a way to improve it?

The tile grid should add or remove rows and columns as it's resized

Currently the amounts of rows and columns are hardcoded. Columns should be added or removed as the tile grid is resized, possibly down to some fixed minimum size or to a size where anything smaller would clip or remove tiles

Toggle switches of booleans move outside of the confined oval

If you make a toggle switch for a boolean it shows an oval that the little switch moves in. When the switch is on the right side, it moves outside of the oval. The left side state is OK.

Recording files can't be saved on Windows

Due to the file name format dashboard_recording_uuuu-MM-dd_HH:mm:ss and Windows not allowing colons in file names

Update Travis to use .org version also README

The README points to the .com version of travis. If you are using the the open source builder they have now then their builds are at a .org address instead.

License should match the rest of WPI Lib

All other software released under WPIlib is BSD 3 clause.

Shuffleboard should be licensed under the same license.

The question that I have is if it should be copyright FIRST or WPI?

GRIP is copyright WPI. WPILib is copyright FIRST.

Adding a widget with "Show as ..." isn't draggable

Dragging from the source tree to the widget pane behaves as expected. It's only widgets added via the context menu that have this problem

Consider switching to Junit5

Per the short discussion on one of the recent PRS; there was a thought floated about switching to Junit5.

The Junit5 vintage plugin would be used to run the TestFX tests as I think they rely on the Junit4 API.

I'm opening this so the question can be discussed.

I'm my experience:

• Intellij can detect and run these tests absolutely fine.
• Gradle has awesome support including Gradle Script Kotlin staticly typed configuration support (added by yours truly in a PR against the Junit5 project earlier this month).
• The API is very clean and polished.
• Works fine with hamcrest assertions.

Connect to Team Number

Copy the logic from OutlineViewer

Showing negative numbers as progress bars doesn't work

Showing negative numbers as progress bars does the cylon eyes thing - very cool, but probably not what was expected.

Option to disable snap to grid

There should be a feature to disable snap to grid. I want to be able to place widgets freely

Dragged sources into a dashboard don't check bounds

For example, dragging a number into the rightmost column will create a slider widget that extends outside the grid

Recording file should not be .frc

This tool can be used for things other than frc.

Widgets only resize on the edge of the screen that is moving

If you have a row with 3 widgets that are {2, 1, 1} grid cells in size and the "2" sized widget could be shrunk. If I drag from the right edge towards the left edge, things only on the right edge start moving, then shrinking. The left edge widget doesn't seem to resize. Probably a bug since the other interior widgets seem to resize properly.

Toggle switch widget moves outside of slider area

When toggling a Toggle Switch widget it moves outside of the oval track on the right side. See attached screen shot.

Do not use the SmartDashboard directory

People may want to still use SmartDashboard. Are we sure what we put in the directory will not conflict?

Need a minimal UI for the DriverStation

You should be able to hide everything except the widget tab for use on a driver station

Add NetworkTable connection indicator

I think this should be built into the UI (like in the title bar) and not a widget.

Close tab icon should be on the left side of the name

This way if I want to close a bunch of tabs really quickly, I can.

Load layout gets an error and no dialog

Load layout gets an error and no dialog box.

Launches sized too large

Running shuffleboard on my machine results in it launching with the window size too large. It flows off the top and bottom of the screen, hiding the menus.

Widget titlebar probably should default to the root name

The titlebar on widgets currently has the full path for the value. So a typical value would be "SmartDashboard/name". With small widgets, the name isn't shown because "SmartDashboard" fills the entire title area. Maybe show the full value when mousing over or in a properties dialog for the widget.

Widget tabs need scroll bars

See attached GIF

There should be a default widget for each data type

We currently just grab the first compatible widget alphabetically. We should have an annotation @DefaultWidget that provides an array of data types (in the same format as @Description) that can be placed on widget classes

@Description(name  = "My Number Widget", dataTypes = NumberType.class)
@DefaultWidget(NumberType.class)
public class MyNumberWidget implements Widget {
  // ...
}

Style warning on startup

Jun 19, 2017 4:48:54 PM com.sun.javafx.css.StyleConverterImpl getInstance
SEVERE: StyleConverterImpl : converter Class is null for : com.sun.javafx.scene.layout.region.CornerRadiiConverter
Jun 19, 2017 4:48:54 PM com.sun.javafx.css.StyleConverterImpl readBinary
SEVERE: could not deserialize com.sun.javafx.scene.layout.region.CornerRadiiConverter
could not deserialize com.sun.javafx.scene.layout.region.CornerRadiiConverter

possibly related to controlsfx?

Use intermediate abstraction layers between view code and logic

NetworkTableTree shouldn't be bound directly to NetworkTablesJNI, but to an intermediary that can be initialized elsewhere to allow the component to be used standalone without a connection to ntcore (eg in SceneBuilder)

Save as... throws exception and doesn't show the dialog

Save as... on the file menu throws exceptions and doesn't show the dialog.

Tabs should be able to auto-populate

For example, a SmartDashboard tab should be able to auto-populate with one widget for each Network Table source that matches ^/SmartDashboard/.+$, and LiveWindow tab auto-populate with network table sources matching ^/LiveWindow/.+$

Since every key can be a source and there's no point in having widgets for unchanging data like /LiveWindow/Subsystem/Name or /LiveWindow/Subsystem/.type, or for keys that are part of a composite object like a SendableChooser, the auto-population should be smart and not add widgets for those sources

Widget gallery UI could use some work (borders perhaps?)

The widgets tab kind of looks sad. It might help to have borders around each component.

As it is it the title isn't visually tied to the component.

Sorry if this is a duplicate issue.

Adding additional widgets for a source causes existing widgets to move

Switch AppVeyor Account

Changing key throws exception

When I change the key of a key-value pair, I get this exception:

Exception in thread "JavaFX Application Thread" java.lang.IndexOutOfBoundsException
        at com.sun.javafx.scene.control.ReadOnlyUnbackedObservableList.subList(ReadOnlyUnbackedObservableList.java:136)
        at javafx.collections.ListChangeListener$Change.getAddedSubList(ListChangeListener.java:242)
        at javafx.scene.control.TreeTableView$TreeTableViewArrayListSelectionModel.handleSelectedCellsListChangeEvent(TreeTableView.java:3244)
        at javafx.scene.control.TreeTableView$TreeTableViewArrayListSelectionModel.access$2000(TreeTableView.java:2289)
        at javafx.scene.control.TreeTableView.sort(TreeTableView.java:1817)
        at edu.wpi.first.shuffleboard.widget.NetworkTableTreeWidget.makeBranches(NetworkTableTreeWidget.java:150)
        at edu.wpi.first.shuffleboard.widget.NetworkTableTreeWidget.lambda$null$7(NetworkTableTreeWidget.java:75)
        at java.util.HashMap.forEach(HashMap.java:1288)
        at edu.wpi.first.shuffleboard.widget.NetworkTableTreeWidget.lambda$new$8(NetworkTableTreeWidget.java:75)
        at com.sun.javafx.binding.ExpressionHelper$SingleChange.fireValueChangedEvent(ExpressionHelper.java:182)
        at com.sun.javafx.binding.ExpressionHelper.fireValueChangedEvent(ExpressionHelper.java:81)
        at javafx.beans.binding.ObjectBinding.invalidate(ObjectBinding.java:172)
        at org.fxmisc.easybind.monadic.FlatMapBindingBase.mappedInvalidated(FlatMap.java:76)
        at org.fxmisc.easybind.monadic.FlatMapBindingBase.lambda$new$22(FlatMap.java:21)
        at javafx.beans.WeakInvalidationListener.invalidated(WeakInvalidationListener.java:83)
        at com.sun.javafx.binding.ExpressionHelper$Generic.fireValueChangedEvent(ExpressionHelper.java:349)
        at com.sun.javafx.binding.ExpressionHelper.fireValueChangedEvent(ExpressionHelper.java:81)
        at javafx.beans.property.ObjectPropertyBase.fireValueChangedEvent(ObjectPropertyBase.java:105)
        at javafx.beans.property.ObjectPropertyBase.markInvalid(ObjectPropertyBase.java:112)
        at javafx.beans.property.ObjectPropertyBase.set(ObjectPropertyBase.java:146)
        at edu.wpi.first.shuffleboard.properties.AsyncProperty.lambda$set$2(AsyncProperty.java:54)
        at edu.wpi.first.shuffleboard.util.FxUtils.runOnFxThread(FxUtils.java:45)
        at edu.wpi.first.shuffleboard.util.AsyncUtils.runAsync(AsyncUtils.java:24)
        at edu.wpi.first.shuffleboard.properties.AsyncProperty.set(AsyncProperty.java:54)
        at javafx.beans.property.ObjectProperty.setValue(ObjectProperty.java:69)
        at edu.wpi.first.shuffleboard.sources.DataSource.setData(DataSource.java:59)
        at edu.wpi.first.shuffleboard.sources.CompositeNetworkTableSource.lambda$new$0(CompositeNetworkTableSource.java:48)
        at edu.wpi.first.shuffleboard.sources.NetworkTableSource.lambda$null$0(NetworkTableSource.java:46)
        at edu.wpi.first.shuffleboard.util.FxUtils.lambda$runOnFxThread$0(FxUtils.java:49)
        at com.sun.javafx.application.PlatformImpl.lambda$null$173(PlatformImpl.java:295)
        at java.security.AccessController.doPrivileged(Native Method)
        at com.sun.javafx.application.PlatformImpl.lambda$runLater$174(PlatformImpl.java:294)
        at com.sun.glass.ui.InvokeLaterDispatcher$Future.run(InvokeLaterDispatcher.java:95)

Steps to reproduce:

1. Add a number to shuffleboard
2. Change the key of that value

Divider between palette and tabbed pane should be resizable

Should be able to resize the widget/sources area, or possibly get rid of it completely to make more room on small screens (i.e. classmate).

Changing the widget type causes the widget to move to new location

Changing the widget type causes the widget to move to a (not obviously predictable) location. This happens even if the widget becomes smaller than the original type would have been.

remove progress bar widget

negative vs positive values should be clear from a glance

Should publish standalone API jar

A tentative list of the classes that should be moved into an api project:

Package	Class
components	LinearIndicator
	NumberField
	Scrubber
data	Everything in this package
data.types	Everything in this package
properties	AsyncProperty
sources	DataSource
	AbstractDataSource
	SourceType (should also be split into an interface and util class)
	IncompatibleSourceException
widget	Widget
	AbstractWidget
	AnnotatedWidget
	SingleTypeWidget
	ComplexAnnotatedWidget
	@Description
	@ParamtrizedController

Other thoughts:

• Should this be a fatjar or standalone? A fat jar would give users access to guava etc. but would increase the jar size
• Need to look into how plugins would interact with an API jar and determine any extra classes that should get moved over. Particularly custom JavaFX components.

@JLLeitschuh can you work on splitting the project into an api project and an app project?

Resized widgets can overlap other widgets

Rapidly changing network table entries cannot be dragged as sources

Instead, a different entry is chosen when dragging so the resulting source/widget is not the one the user selected in the tree

The save layout menu item should change to "save"

Seems like an artifact from the past, but it's very confusing... "save layout" and "save as" - not obvious that these save the same things.

MainWindowController vs ShuffleboardController

Both exist right now. ShuffleboardController is empty but in what I believe is the correct package.

Option to not show full source name in widget titles

There should be an option to only show the last part of a networktable path

TextView widgets are not editable

See title

Should have support for custom plugins

Plugins would have:

• A name
• A list of custom widgets
• A list of custom source types
• A list of custom data types

The name must always be set, but plugins can choose to define any or all of the custom lists.

We'll need to change SourceType away from an enum to an interface + util class, like DataType/DataTypes. Should probably also change SourceType to do data recording and playback, so we don't have to add custom code for each source type in the recording/playback classes.

We'd need to add UI stuff to load plugin jars or classes, as well as a simple dialog to show the currently loaded plugins.

Providing the plugin API would let us move classes into their own jars. All the stock widgets can be bundled into a StockWidget plugin, network table sources can be in a NetworkTable Source plugin, etc. Ideally the stock data types would also go into a plugin, but that would mean plugins would either need to be compiled with that jar to let the @Description annotation to function, forcing us to load that jar first to make sure the data type classes are loaded; or remove the @Description annotation entirely.

Because of this, I think we should keep the stock data types in the api jar (#101) to make sure all plugins can use all the data types provided by WPILib, but still split the stock widgets and data sources into plugins.

There are a few pain points like the network table tree widget that we use to display data in network tables and add widgets from. We may want to let source types provide a JavaFX node that we stick in a tab in the sources view.

Multi-select

not really a near term thing, but you should be able to click and drag to select groups of widgets, and then move them (or delete them)

Widget palette needs a scrollbar if it doesn't all fit

When there are more widgets vertically in the palette than fit in the window there should be a scrollbar.