-
Notifications
You must be signed in to change notification settings - Fork 92
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
README revamp, getting ready for Electron integration
- Loading branch information
1 parent
96242a6
commit 1196c01
Showing
4 changed files
with
27 additions
and
59 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,65 +1,39 @@ | ||
# [FRC Dashboard](https://frcdashboard.github.io) | ||
FRC Dashboard is a fully customizable web-based dashboard for [FIRST Robotics Competition (FRC)](http://firstinspires.org/robotics/frc). | ||
# FRC Dashboard | ||
FRC Dashboard is a fully customizable dashboard for [FIRST Robotics Competition (FRC)](http://firstinspires.org/robotics/frc) which is based on web languages (JavaScript/CSS/HTML). It's completely legal for competition, and can be used to give your secondary (or primary) operator significantly richer control of your robot. | ||
|
||
![Red theme](screenshots/red.png) | ||
![Blue theme](screenshots/blue.png) | ||
![Light theme](screenshots/light.png) | ||
![Dark theme](screenshots/dark.png) | ||
|
||
__Contributions are VERY welcome! Please feel free to open a pull request or issue with improvements or a new feature.__ | ||
|
||
* Completely legal for competition as it works alongside standard DriverStation | ||
* Web browser interface provides richer control interface for secondary robot operator | ||
* Works with or without touchscreen | ||
* Lots of code commenting to help you easily understand code and add your robot's functions | ||
* Inbuilt camera streaming system, SVG gyroscope, encoder control, and example buttons | ||
* Lots of addons to easily create new dashboard widgets for your own use! | ||
|
||
## Training | ||
FRC Dashboard is full of comments and is designed to be easy to understand. However, if you need some help, check out [the official training repository.](https://github.com/FRCDashboard/training). | ||
This system is designed to be 100% accessible, tweakable, and expandable. To help in this aim, the code is rigorously documented with thousands of inline comments and [a set of training exercises](https://github.com/FRCDashboard/training). In addition, the base system comes with several functioning example widgets and features, and [many addons](https://github.com/FRCDashboard?query=addon-) have been created to speed up the development of your team's dashboard. | ||
|
||
## Setting up | ||
__Contributions are VERY welcome! Please feel free to open a pull request or issue!__ | ||
|
||
* For the camera to work, you must change the source in `index.html` to the IP of your live camera feed. This may take some tweaking depending on how your camera stream works. We use and recommend [MJPG Streamer](https://github.com/jacksonliam/mjpg-streamer). | ||
* It is recommended that you close the top panel of the FRC DriverStation to make room for a sized-down Chrome window. | ||
![Red theme](screenshots/red.png) | ||
|
||
## Running the code | ||
## Using the Dashboard | ||
|
||
### Dependencies | ||
* Python 3 (__MUST be 3, not 2!__) | ||
* pynetworktables2js (`pip3 install pynetworktables2js`, or, if you don't have administrator privileges, put `--user` at the end of that command.) | ||
|
||
Python 3 must be installed! | ||
|
||
Make sure you have pynetworktables2 installed: | ||
|
||
pip3 install pynetworktables2js | ||
|
||
(If you don't have administrator privileges, put `--user` at the end of that command.) | ||
|
||
### Start dashboard server | ||
### Setup | ||
* For the camera to work, you must change the source in `style.css` to the IP of your live camera feed. | ||
|
||
Run this command: | ||
### Running | ||
1. Connect to your robot's network. (If you're just testing the dashboard and don't currently need to use it with the robot, you can skip this step.) | ||
2. Start dashboard server: | ||
|
||
python3 dashboardServer.py | ||
python3 dashboardServer.py | ||
|
||
### Open dashboard | ||
|
||
Open Chrome and go to: | ||
|
||
http://localhost:8888 | ||
|
||
If you're on Windows, you can open `launch.bat`, which will start the server and open Chrome. | ||
|
||
## Addons | ||
|
||
There are several prebuilt addons for FRC Dashboard. You can find a full list on the [FRC Dashboard website](https://frcdashboard.github.io) or on the [FRC DB GitHub page](https://github.com/FRCDashboard). | ||
3. View dashboard at `http://localhost:8888`. | ||
4. It is recommended that you close the top panel of the FRC DriverStation to make room for the dashboard. | ||
|
||
## Authors | ||
|
||
* This library is primarily maintained by [Erik Boesen](https://github.com/ErikBoesen). | ||
* [Erik Boesen](https://github.com/ErikBoesen) is the primary | ||
* [FRC Team 1418](https://github.com/frc1418) used earlier versions of this code in 2015 and 2016. | ||
* [Leon Tan](https://github.com/lleontan) led the original 1418 UI team and coded the first iteration of the UI and pynetworktables2js | ||
* [Dustin Spicuzza](https://github.com/virtuald), 1418 mentor and head of the [RobotPy](https://github.com/robotpy) project. | ||
* [Leon Tan](https://github.com/lleontan) led the original 1418 UI team, coded pynetworktables2js, and developed the original web-browser-based UI which was later developed into FRC Dashboard. | ||
* [Dustin Spicuzza](https://github.com/virtuald) mentored team 1418 through much of this technology's genesis and leads the [RobotPy](https://github.com/robotpy) project. | ||
|
||
## License | ||
|
||
This software is licensed under the `Apache 2.0` license. Basically, do whatever you want, as long as you give credit to the [original source](https://github.com/FRCDashboard/FRCDashboard), and keep the license with it. More information in `LICENSE`. | ||
|
||
![Blue theme](screenshots/blue.png) | ||
![Light theme](screenshots/light.png) | ||
![Dark theme](screenshots/dark.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters