-
Notifications
You must be signed in to change notification settings - Fork 196
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
338 changed files
with
15,204 additions
and
7,292 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
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 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 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 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 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 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 |
|---|---|---|
|
|
@@ -3,8 +3,6 @@ build/* | |
| .vscode/* | ||
| .idea/* | ||
| source/_build | ||
| source/_build | ||
| photon-docs/build | ||
| source/docs/_build | ||
|
|
||
| venv/* | ||
|
|
||
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 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 |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| orphan: true | ||
| --- | ||
|
|
||
| # Requested Page Not Found | ||
|
|
||
| This page you were looking for was not found. If you think this is a mistake, [file an issue on our GitHub.](https://github.com/PhotonVision/photonvision-docs/issues) |
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
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 |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # Best Practices For Competition | ||
|
|
||
| ## Before Competition | ||
|
|
||
| - Ensure you have spares of the relevant electronics if you can afford it (switch, coprocessor, cameras, etc.). | ||
| - Download the latest release .jar onto your computer and update your Pi if necessary (only update if the release is labeled "critical" or similar, we do not recommend updating right before an event in case there are unforeseen bugs). | ||
| - Test out PhotonVision at your home setup. | ||
| - Ensure that you have set up SmartDashboard / Shuffleboard to view your camera streams during matches. | ||
| - Follow all the recommendations under the Networking section in installation (network switch and static IP). | ||
| - Use high quality ethernet cables that have been rigorously tested. | ||
| - Set up port forwarding using the guide in the Networking section in installation. | ||
|
|
||
| ## During the Competition | ||
|
|
||
| - Make sure you take advantage of the field calibration time given at the start of the event: | ||
| - Bring your robot to the field at the allotted time. | ||
| - Turn on your robot and pull up the dashboard on your driver station. | ||
| - Point your robot at the target(s) and ensure you get a consistent tracking (you hold one target consistently, the ceiling lights aren't detected, etc.). | ||
| - If you have problems with your pipeline, go to the pipeline tuning section and retune the pipeline using the guide there. You want to make your exposure as low as possible with a tight hue value to ensure no extra targets are detected. | ||
| - Move the robot close, far, angled, and around the field to ensure no extra targets are found anywhere when looking for a target. | ||
| - Go to a practice match to ensure everything is working correctly. | ||
| - After field calibration, use the "Export Settings" button in the "Settings" page to create a backup. | ||
| - Do this for each coprocessor on your robot that runs PhotonVision, and name your exports with meaningful names. | ||
| - This will contain camera information/calibration, pipeline information, network settings, etc. | ||
| - In the event of software/hardware failures (IE lost SD Card, broken device), you can then use the "Import Settings" button and select "All Settings" to restore your settings. | ||
| - This effectively works as a snapshot of your PhotonVision data that can be restored at any point. | ||
| - Before every match, check the ethernet connection going into your coprocessor and that it is seated fully. | ||
| - Ensure that exposure is as low as possible and that you don't have the dashboard up when you don't need it to reduce bandwidth. | ||
| - Stream at as low of a resolution as possible while still detecting targets to stay within bandwidth limits. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| # Filesystem Directory | ||
|
|
||
| PhotonVision stores and loads settings in the {code}`photonvision_config` directory, in the same folder as the PhotonVision JAR is stored. On the Pi image as well as the Gloworm, this is in the {code}`/opt/photonvision` directory. The contents of this directory can be exported as a zip archive from the settings page of the interface, under "export settings". This export will contain everything detailed below. These settings can later be uploaded using "import settings", to restore configurations from previous backups. | ||
|
|
||
| ## Directory Structure | ||
|
|
||
| The directory structure is outlined below. | ||
|
|
||
| ```{image} images/configDir.png | ||
| :alt: Config directory structure | ||
| :width: 600 | ||
| ``` | ||
|
|
||
| - calibImgs | ||
| - Images saved from the last run of the calibration routine | ||
| - cameras | ||
| - Contains a subfolder for each camera. This folder contains the following files: | ||
| - pipelines folder, which contains a {code}`json` file for each user-created pipeline. | ||
| - config.json, which contains all camera-specific configuration. This includes FOV, pitch, current pipeline index, and calibration data | ||
| - drivermode.json, which contains settings for the driver mode pipeline | ||
| - imgSaves | ||
| - Contains images saved with the input/output save commands. | ||
| - logs | ||
| - Contains timestamped logs in the format {code}`photonvision-YYYY-MM-D_HH-MM-SS.log`. Note that on Pi or Gloworm these timestamps will likely be significantly behind the real time. | ||
| - hardwareSettings.json | ||
| - Contains hardware settings. Currently this includes only the LED brightness. | ||
| - networkSettings.json | ||
| - Contains network settings, including team number (or remote network tables address), static/dynamic settings, and hostname. | ||
|
|
||
| ## Importing and Exporting Settings | ||
|
|
||
| The entire settings directory can be exported as a ZIP archive from the settings page. | ||
|
|
||
| ```{raw} html | ||
| <video width="85%" controls> | ||
| <source src="../../_static/assets/import-export-settings.mp4" type="video/mp4"> | ||
| Your browser does not support the video tag. | ||
| </video> | ||
| ``` | ||
|
|
||
| A variety of files can be imported back into PhotonVision: | ||
|
|
||
| - ZIP Archive ({code}`.zip`) | ||
| - Useful for restoring a full configuration from a different PhotonVision instance. | ||
| - Single Config File | ||
| - Currently-supported Files | ||
| - {code}`hardwareConfig.json` | ||
| - {code}`hardwareSettings.json` | ||
| - {code}`networkSettings.json` | ||
| - Useful for simple hardware or network configuration tasks without overwriting all settings. |
Oops, something went wrong.