The dashboard's code is designed to be 100% accessible and expandable. To this aim, the code is rigorously commented and a set of training exercises have been prepared to orient new users. In addition, the base system comes with several functioning example widgets and features, and we've build several helpful addons to speed up the development of your team's dashboard.
Contributions are VERY welcome! Please feel free to open a pull request or issue!
Before running your dashboard, you'll need to install the node dependencies by
cding into the dashboard directory and running
ui.js, there are a bunch of key handler functions which controls the updating of control elements in the dashboard. Example NetworkTables key names are used, but you'll need to change them to match those used in your team's robot code for them to affect anything on your robot.
FRC Dashboard supports display of MJPG camera streams. Once you've created a stream (using WPILib's
CameraServer class, mjpg-streamer (deprecated), or another method), update
style.css to use the IP of your live camera feed. Usually this is something like
XXXX is your team's number. The port increases based on camera number, for example,
1181 is Camera 1, and
1182 is Camera 2. Note: not every robot follows this rule. Your port may be
5800 or something else.
Some users may wish to compile their dashboard applications into standalone
Assuming the necessary setup steps have been performed, users may run
npm run package-[platform], where
win according to the target platform, to pack the entire application into a single executable.
Connect to your robot's network if you haven't already. (If you're just testing the dashboard and don't currently need to use it with your robot, you can skip this step.)
While in the dashboard directory, run:
This will open the dashboard application. Note that you can refresh the page and client-side updates will take effect; reopening the whole application is usually unnecessary.
It is recommended that while using the dashboard on your driver station, you close the top panel of the FRC DriverStation to make room for the dashboard.
- Erik Boesen is the primary developer of FRC Dashboard.
- Team 1418 used earlier versions of this code in 2015 and 2016.
- Leon Tan led the original 1418 UI team, coded
pynetworktables2js, and developed a browser-based UI which was years later reworked to create FRC Dashboard.
- Dustin Spicuzza leads the RobotPy project, and mentored Team 1418 through much of FRC Dashboard's genesis.
- Tomas Rakusan Developed Node based NetworkTables client and its interface in this project.
This software is available under the MIT License.