diff --git a/docs/source/docs/additional-resources/best-practices.md b/docs/source/docs/additional-resources/best-practices.md index 066ae5e05c..5032002f2e 100644 --- a/docs/source/docs/additional-resources/best-practices.md +++ b/docs/source/docs/additional-resources/best-practices.md @@ -7,10 +7,11 @@ - Some time before the competition, lock down the version you are using and do not upgrade unless you encounter a critical bug. - Have a copy of the installation image for the version you are using on your programming laptop, in case re-imaging (without internet) is needed. - Extensively test at your home setup. Practice tuning from scratch under different lighting conditions. -- Confirm you have followed all the recommendations under the {ref}`Networking` documentation (network switch and static IP). +- Confirm you have followed all the recommendations under the {ref}`Networking` documentation (network switch and static IP). - Only use high quality ethernet cables that have been rigorously tested. ## Camera Streaming + - All camera streams are published under the NetworkTables table `CameraPublisher`. - The only subtable under `CameraPublisher` that will work for viewing a driver mode camera stream is the one that contains `Output` in the name. - To view a camera stream in a dashboard, drag the correct subtable from the NetworkTables tree into your dashboard. diff --git a/docs/source/docs/advanced-installation/index.md b/docs/source/docs/advanced-installation/index.md index 377414f66f..ebe1047258 100644 --- a/docs/source/docs/advanced-installation/index.md +++ b/docs/source/docs/advanced-installation/index.md @@ -2,10 +2,6 @@ This page will help you install PhotonVision on non-supported coprocessor. -## Step 1: Software Install - -This section will walk you through how to install PhotonVision on your coprocessor. Your coprocessor is the device that has the camera and you are using to detect targets (ex. if you are using a Limelight / Raspberry Pi, that is your coprocessor and you should follow those instructions). - :::{warning} You only need to install PhotonVision on the coprocessor/device that is being used to detect targets, you do NOT need to install it on the device you use to view the webdashboard. All you need to view the webdashboard is for a device to be on the same network as your vision coprocessor and an internet browser. ::: @@ -13,6 +9,6 @@ You only need to install PhotonVision on the coprocessor/device that is being us ```{toctree} :maxdepth: 3 -sw_install/index prerelease-software +other-operating-systems/index ``` diff --git a/docs/source/docs/advanced-installation/sw_install/advanced-cmd.md b/docs/source/docs/advanced-installation/other-operating-systems/advanced-cmd.md similarity index 100% rename from docs/source/docs/advanced-installation/sw_install/advanced-cmd.md rename to docs/source/docs/advanced-installation/other-operating-systems/advanced-cmd.md diff --git a/docs/source/docs/advanced-installation/sw_install/files/Limelight2+/hardwareConfig.json b/docs/source/docs/advanced-installation/other-operating-systems/files/Limelight2+/hardwareConfig.json similarity index 100% rename from docs/source/docs/advanced-installation/sw_install/files/Limelight2+/hardwareConfig.json rename to docs/source/docs/advanced-installation/other-operating-systems/files/Limelight2+/hardwareConfig.json diff --git a/docs/source/docs/advanced-installation/sw_install/files/Limelight2/hardwareConfig.json b/docs/source/docs/advanced-installation/other-operating-systems/files/Limelight2/hardwareConfig.json similarity index 100% rename from docs/source/docs/advanced-installation/sw_install/files/Limelight2/hardwareConfig.json rename to docs/source/docs/advanced-installation/other-operating-systems/files/Limelight2/hardwareConfig.json diff --git a/docs/source/docs/advanced-installation/sw_install/images/angryIP.png b/docs/source/docs/advanced-installation/other-operating-systems/images/angryIP.png similarity index 100% rename from docs/source/docs/advanced-installation/sw_install/images/angryIP.png rename to docs/source/docs/advanced-installation/other-operating-systems/images/angryIP.png diff --git a/docs/source/docs/advanced-installation/sw_install/images/nano.png b/docs/source/docs/advanced-installation/other-operating-systems/images/nano.png similarity index 100% rename from docs/source/docs/advanced-installation/sw_install/images/nano.png rename to docs/source/docs/advanced-installation/other-operating-systems/images/nano.png diff --git a/docs/source/docs/advanced-installation/sw_install/index.md b/docs/source/docs/advanced-installation/other-operating-systems/index.md similarity index 86% rename from docs/source/docs/advanced-installation/sw_install/index.md rename to docs/source/docs/advanced-installation/other-operating-systems/index.md index cc15c6f9b8..b24efdb3c0 100644 --- a/docs/source/docs/advanced-installation/sw_install/index.md +++ b/docs/source/docs/advanced-installation/other-operating-systems/index.md @@ -1,4 +1,4 @@ -# Software Installation +# Other Operating Systems ## Desktop Environments diff --git a/docs/source/docs/advanced-installation/sw_install/linux-pc.md b/docs/source/docs/advanced-installation/other-operating-systems/linux-pc.md similarity index 100% rename from docs/source/docs/advanced-installation/sw_install/linux-pc.md rename to docs/source/docs/advanced-installation/other-operating-systems/linux-pc.md diff --git a/docs/source/docs/advanced-installation/sw_install/mac-os.md b/docs/source/docs/advanced-installation/other-operating-systems/mac-os.md similarity index 100% rename from docs/source/docs/advanced-installation/sw_install/mac-os.md rename to docs/source/docs/advanced-installation/other-operating-systems/mac-os.md diff --git a/docs/source/docs/advanced-installation/sw_install/other-coprocessors.md b/docs/source/docs/advanced-installation/other-operating-systems/other-coprocessors.md similarity index 96% rename from docs/source/docs/advanced-installation/sw_install/other-coprocessors.md rename to docs/source/docs/advanced-installation/other-operating-systems/other-coprocessors.md index 6afb65f67b..a3c947dd70 100644 --- a/docs/source/docs/advanced-installation/sw_install/other-coprocessors.md +++ b/docs/source/docs/advanced-installation/other-operating-systems/other-coprocessors.md @@ -23,7 +23,7 @@ $ sudo reboot now Your co-processor will require an Internet connection for this process to work correctly. ::: -For installation on any other co-processors, we recommend reading the {ref}`advanced command line documentation `. +For installation on any other co-processors, we recommend reading the {ref}`advanced command line documentation `. ## Updating PhotonVision diff --git a/docs/source/docs/advanced-installation/sw_install/romi.md b/docs/source/docs/advanced-installation/other-operating-systems/romi.md similarity index 100% rename from docs/source/docs/advanced-installation/sw_install/romi.md rename to docs/source/docs/advanced-installation/other-operating-systems/romi.md diff --git a/docs/source/docs/advanced-installation/sw_install/windows-pc.md b/docs/source/docs/advanced-installation/other-operating-systems/windows-pc.md similarity index 100% rename from docs/source/docs/advanced-installation/sw_install/windows-pc.md rename to docs/source/docs/advanced-installation/other-operating-systems/windows-pc.md diff --git a/docs/source/docs/camera-specific-configuration/index.md b/docs/source/docs/camera-specific-configuration/index.md index 4881a5720f..aeed1e2d59 100644 --- a/docs/source/docs/camera-specific-configuration/index.md +++ b/docs/source/docs/camera-specific-configuration/index.md @@ -1,5 +1,7 @@ # Camera-Specifc Configuration +Do you have an Arducam or Pi Camera Module? This section contains information on how to configure these cameras for use with PhotonVision. If not, you may skip to {ref}`docs/getting-started/camera-matching:Camera Matching`. + ```{toctree} :maxdepth: 2 diff --git a/docs/source/docs/quick-start/camera-calibration.md b/docs/source/docs/getting-started/camera-calibration.md similarity index 100% rename from docs/source/docs/quick-start/camera-calibration.md rename to docs/source/docs/getting-started/camera-calibration.md diff --git a/docs/source/docs/quick-start/camera-matching.md b/docs/source/docs/getting-started/camera-matching.md similarity index 100% rename from docs/source/docs/quick-start/camera-matching.md rename to docs/source/docs/getting-started/camera-matching.md diff --git a/docs/source/docs/getting-started/configuration.md b/docs/source/docs/getting-started/configuration.md new file mode 100644 index 0000000000..c25f84efcd --- /dev/null +++ b/docs/source/docs/getting-started/configuration.md @@ -0,0 +1,23 @@ +# Configuration + +## Settings to configure + +### Team Number + +In order for PhotonVision to connect to NetworkTables it needs to know your team number. You can configure this in the Settings page. + +```{image} images/editTeamNumber.png +:align: center +``` + +### Camera Nickname + +You **must** set the nickname of your cameras in PhotonVision to ensure that every camera has a unique name. This is how you will identify cameras in robot code. The camera can be nicknamed using the edit button next to the camera name in the upper right of the Dashboard page. + +```{image} images/editCameraName.png +:align: center +``` + +## Configure Pipelines + +After you set up your cameras, you should follow the guides at {ref}`docs/pipelines/about-pipelines:About Pipelines` to configure the vision processing pipelines you want to use. diff --git a/docs/source/docs/quick-start/common-setups.md b/docs/source/docs/getting-started/hardware-setups.md similarity index 85% rename from docs/source/docs/quick-start/common-setups.md rename to docs/source/docs/getting-started/hardware-setups.md index 7d6ffaf602..d9c5b6d6bc 100644 --- a/docs/source/docs/quick-start/common-setups.md +++ b/docs/source/docs/getting-started/hardware-setups.md @@ -1,4 +1,4 @@ -# Common Hardware Setups +# Hardware Setups PhotonVision requires dedicated hardware, above and beyond a roboRIO. This page lists hardware that is frequently used with PhotonVision. @@ -26,9 +26,11 @@ Industrial grade SD cards from major manufacturers are recommended for robotics Innomaker and Arducam are common manufacturers of hardware designed specifically for vision processing. - AprilTag Detection + - OV9281 - Object Detection + - OV9782 - Driver Camera @@ -43,4 +45,4 @@ Feel free to get started with any color webcam you have sitting around. - Pololu S13V30F5 Regulator - Redux Robotics Zinc-V Regulator -See {ref}`(Selecting Hardware)` for info on why these are recommended. +For PhotonVision support on other hardware not listed above, refer to the {ref}`(Other Hardware)` page for recommended specs. diff --git a/docs/source/docs/quick-start/images/OrangePiPololu.png b/docs/source/docs/getting-started/images/OrangePiPololu.png similarity index 100% rename from docs/source/docs/quick-start/images/OrangePiPololu.png rename to docs/source/docs/getting-started/images/OrangePiPololu.png diff --git a/docs/source/docs/quick-start/images/OrangePiPololuPigtail.png b/docs/source/docs/getting-started/images/OrangePiPololuPigtail.png similarity index 100% rename from docs/source/docs/quick-start/images/OrangePiPololuPigtail.png rename to docs/source/docs/getting-started/images/OrangePiPololuPigtail.png diff --git a/docs/source/docs/quick-start/images/OrangePiZinc.png b/docs/source/docs/getting-started/images/OrangePiZinc.png similarity index 100% rename from docs/source/docs/quick-start/images/OrangePiZinc.png rename to docs/source/docs/getting-started/images/OrangePiZinc.png diff --git a/docs/source/docs/quick-start/images/OrangePiZincUSBC.png b/docs/source/docs/getting-started/images/OrangePiZincUSBC.png similarity index 100% rename from docs/source/docs/quick-start/images/OrangePiZincUSBC.png rename to docs/source/docs/getting-started/images/OrangePiZincUSBC.png diff --git a/docs/source/docs/quick-start/images/RPiPololu.png b/docs/source/docs/getting-started/images/RPiPololu.png similarity index 100% rename from docs/source/docs/quick-start/images/RPiPololu.png rename to docs/source/docs/getting-started/images/RPiPololu.png diff --git a/docs/source/docs/quick-start/images/RPiPololuPigtail.png b/docs/source/docs/getting-started/images/RPiPololuPigtail.png similarity index 100% rename from docs/source/docs/quick-start/images/RPiPololuPigtail.png rename to docs/source/docs/getting-started/images/RPiPololuPigtail.png diff --git a/docs/source/docs/quick-start/images/RPiZinc.png b/docs/source/docs/getting-started/images/RPiZinc.png similarity index 100% rename from docs/source/docs/quick-start/images/RPiZinc.png rename to docs/source/docs/getting-started/images/RPiZinc.png diff --git a/docs/source/docs/quick-start/images/RPiZincUSBC.png b/docs/source/docs/getting-started/images/RPiZincUSBC.png similarity index 100% rename from docs/source/docs/quick-start/images/RPiZincUSBC.png rename to docs/source/docs/getting-started/images/RPiZincUSBC.png diff --git a/docs/source/docs/quick-start/images/camera-matching/activated-camera.png b/docs/source/docs/getting-started/images/camera-matching/activated-camera.png similarity index 100% rename from docs/source/docs/quick-start/images/camera-matching/activated-camera.png rename to docs/source/docs/getting-started/images/camera-matching/activated-camera.png diff --git a/docs/source/docs/quick-start/images/camera-matching/camera-mismatch-details.png b/docs/source/docs/getting-started/images/camera-matching/camera-mismatch-details.png similarity index 100% rename from docs/source/docs/quick-start/images/camera-matching/camera-mismatch-details.png rename to docs/source/docs/getting-started/images/camera-matching/camera-mismatch-details.png diff --git a/docs/source/docs/quick-start/images/camera-matching/deactivated-camera.png b/docs/source/docs/getting-started/images/camera-matching/deactivated-camera.png similarity index 100% rename from docs/source/docs/quick-start/images/camera-matching/deactivated-camera.png rename to docs/source/docs/getting-started/images/camera-matching/deactivated-camera.png diff --git a/docs/source/docs/quick-start/images/camera-matching/unassigned-camera.png b/docs/source/docs/getting-started/images/camera-matching/unassigned-camera.png similarity index 100% rename from docs/source/docs/quick-start/images/camera-matching/unassigned-camera.png rename to docs/source/docs/getting-started/images/camera-matching/unassigned-camera.png diff --git a/docs/source/docs/quick-start/images/editCameraName.png b/docs/source/docs/getting-started/images/editCameraName.png similarity index 100% rename from docs/source/docs/quick-start/images/editCameraName.png rename to docs/source/docs/getting-started/images/editCameraName.png diff --git a/docs/source/docs/quick-start/images/editHostname.png b/docs/source/docs/getting-started/images/editHostname.png similarity index 100% rename from docs/source/docs/quick-start/images/editHostname.png rename to docs/source/docs/getting-started/images/editHostname.png diff --git a/docs/source/docs/getting-started/images/editTeamNumber.png b/docs/source/docs/getting-started/images/editTeamNumber.png new file mode 100644 index 0000000000..4584a5501c Binary files /dev/null and b/docs/source/docs/getting-started/images/editTeamNumber.png differ diff --git a/docs/source/docs/quick-start/images/motionblur.png b/docs/source/docs/getting-started/images/motionblur.png similarity index 100% rename from docs/source/docs/quick-start/images/motionblur.png rename to docs/source/docs/getting-started/images/motionblur.png diff --git a/docs/source/docs/quick-start/images/networking-diagram-vividhosting.png b/docs/source/docs/getting-started/images/networking-diagram-vividhosting.png similarity index 100% rename from docs/source/docs/quick-start/images/networking-diagram-vividhosting.png rename to docs/source/docs/getting-started/images/networking-diagram-vividhosting.png diff --git a/docs/source/docs/quick-start/images/networking-diagram.png b/docs/source/docs/getting-started/images/networking-diagram.png similarity index 100% rename from docs/source/docs/quick-start/images/networking-diagram.png rename to docs/source/docs/getting-started/images/networking-diagram.png diff --git a/docs/source/docs/quick-start/images/static.png b/docs/source/docs/getting-started/images/static.png similarity index 100% rename from docs/source/docs/quick-start/images/static.png rename to docs/source/docs/getting-started/images/static.png diff --git a/docs/source/docs/quick-start/quick-install.md b/docs/source/docs/getting-started/installation.md similarity index 91% rename from docs/source/docs/quick-start/quick-install.md rename to docs/source/docs/getting-started/installation.md index 7b30a65a57..d0bfef1493 100644 --- a/docs/source/docs/quick-start/quick-install.md +++ b/docs/source/docs/getting-started/installation.md @@ -1,14 +1,12 @@ -# Quick Install +# Installation -## Install the latest image of photonvision for your coprocessor +## Install the latest image of PhotonVision for your coprocessor - For the supported coprocessors - RPI 3,4,5 - Orange Pi 5 - Limelight -For installing on non-supported devices {ref}`see. ` - [Download the latest preconfigured image of photonvision for your coprocessor](https://github.com/PhotonVision/photonvision/releases/latest) | Coprocessor | Image filename | Jar | @@ -31,3 +29,5 @@ Unless otherwise noted in release notes or if updating from the prior years vers :::{note} Limelight 2, 2+, and 3 will need a [custom hardware config file](https://github.com/PhotonVision/photonvision/tree/main/docs/source/docs/advanced-installation/sw_install/files) for lighting to work. Currently only limelight 2 and 2+ files are available. ::: + +For installation on other coprocessors, refer to the {ref}`docs/advanced-installation/index:Advanced Installation` page. diff --git a/docs/source/docs/quick-start/networking.md b/docs/source/docs/getting-started/networking.md similarity index 100% rename from docs/source/docs/quick-start/networking.md rename to docs/source/docs/getting-started/networking.md diff --git a/docs/source/docs/quick-start/wiring.md b/docs/source/docs/getting-started/wiring.md similarity index 100% rename from docs/source/docs/quick-start/wiring.md rename to docs/source/docs/getting-started/wiring.md diff --git a/docs/source/docs/hardware/customhardware.md b/docs/source/docs/hardware/custom-hardware.md similarity index 100% rename from docs/source/docs/hardware/customhardware.md rename to docs/source/docs/hardware/custom-hardware.md diff --git a/docs/source/docs/hardware/index.md b/docs/source/docs/hardware/index.md index 8e71484cd5..356cc3f7fd 100644 --- a/docs/source/docs/hardware/index.md +++ b/docs/source/docs/hardware/index.md @@ -1,8 +1,8 @@ -# Hardware Selection +# Hardware ```{toctree} :maxdepth: 2 -selecting-hardware -customhardware +other-hardware +custom-hardware ``` diff --git a/docs/source/docs/hardware/selecting-hardware.md b/docs/source/docs/hardware/other-hardware.md similarity index 97% rename from docs/source/docs/hardware/selecting-hardware.md rename to docs/source/docs/hardware/other-hardware.md index c04445b4d8..350e78184f 100644 --- a/docs/source/docs/hardware/selecting-hardware.md +++ b/docs/source/docs/hardware/other-hardware.md @@ -1,7 +1,7 @@ -# Selecting Hardware +# Other Hardware :::{note} -See the {ref}`quick start guide`, for latest, specific recommendations on hardware to use for PhotonVision. +See the {ref}`quick start guide`, for latest, specific recommendations on hardware to use for PhotonVision. ::: In order to use PhotonVision, you need a coprocessor and a camera. This page discusses the specifics of why that hardware is recommended. @@ -51,7 +51,6 @@ Better storage space and read/write speed mostly matter if image capture is used Industrial-grade SD cards are recommended for their stability under shock, vibration, variable voltage, and power-off. Raspberry Pi and Orange Pi coprocessors are generally robust against robot power interruptions, teams have anecdotally reported that Sandisk industrial SD cards reduce the chances of an unexpected settings or log file corruption on shutdown. - ## Choosing a Camera PhotonVision relies on [CSCore](https://github.com/wpilibsuite/allwpilib/tree/main/cscore) to detect and process cameras, so camera support is determined based off compatibility with CScore along with native support for the camera within your OS (ex. [V4L compatibility](https://en.wikipedia.org/wiki/Video4Linux)). @@ -67,7 +66,6 @@ PhotonVision attempts to support most USB Cameras. Exceptions include: Use caution when using multiple identical cameras, as only the physical USB port they are plugged into can differentiate them. PhotonVision provides a "strict matching" setting which can reduce errors related to identical cameras. Arducam has a [tool that allows for identical cameras to be renamed](https://docs.arducam.com/UVC-Camera/Serial-Number-Tool-Guide/) by their physical location or purpose. - ### Cameras Attributes For colored shape detection, any non-fisheye camera supported by PhotonVision will work. diff --git a/docs/source/docs/quick-start/index.md b/docs/source/docs/quick-start/index.md deleted file mode 100644 index 4b9a97e3d9..0000000000 --- a/docs/source/docs/quick-start/index.md +++ /dev/null @@ -1,13 +0,0 @@ -# Quick Start - -```{toctree} -:maxdepth: 2 - -common-setups -quick-install -wiring -networking -camera-matching -camera-calibration -quick-configure -``` diff --git a/docs/source/docs/quick-start/quick-configure.md b/docs/source/docs/quick-start/quick-configure.md deleted file mode 100644 index f2bafb795b..0000000000 --- a/docs/source/docs/quick-start/quick-configure.md +++ /dev/null @@ -1,57 +0,0 @@ -# Quick Configure - -## Settings to configure - -### Team number - -In order for photonvision to connect to the roborio it needs to know your team number. - -### Camera Nickname - -You **must** nickname your cameras in PhotonVision to ensure that every camera has a unique name. This is how you will identify cameras in robot code. The camera can be nicknamed using the edit button next to the camera name in the upper right of the Dashboard tab. - -```{image} images/editCameraName.png -:align: center -``` - -## Pipeline Settings - -### AprilTag - -When using an Orange Pi 5 with an Arducam OV9281 teams will usually change the following settings. For more info on AprilTag settings please review {ref}`this`. - -- Resolution: - - 1280x800 -- Decimate: - - 2 -- Mode: - - 3D -- Exposure and Gain: - - Adjust these to achieve good brightness without flicker and low motion blur. This may vary based on lighting conditions in your competition environment. -- Enable MultiTag -- Set arducam specific camera type selector to OV9281 - -#### AprilTags and Motion Blur and Rolling Shutter - -When detecting AprilTags, it's important to minimize 'motion blur' as much as possible. Motion blur appears as visual streaking or smearing in the camera feed, resulting from the movement of either the camera or the object in focus. Reducing this effect is essential, as the robot is often in motion, and a clearer image allows for detecting as many tags as possible. This is not to be confused with {ref}`rolling shutter`. - -- Fixes - - Lower your exposure as low as possible. Using gain and brightness to account for lack of brightness. -- Other Options: - - Don't use/rely on vision measurements while moving. - -```{image} images/motionblur.png -:align: center -``` - -### Object Detection - -When using an Orange Pi 5 with an OV9782 teams will usually change the following settings. For more info on object detection settings please review {ref}`this`. - -- Resolution: - - Resolutions higher than 640x640 may not result in any higher detection accuracy and may lower {ref}`performance`. -- Confidence: - - 0.75 - 0.95 Lower values are for detecting worn game pieces or less ideal game pieces. Higher for less worn, more ideal game pieces. -- White Balance Temperature: - - Adjust this to achieve better color accuracy. This may be needed to increase confidence. -- Set arducam specific camera type selector to OV9782 diff --git a/docs/source/docs/simulation/simulation-java.md b/docs/source/docs/simulation/simulation-java.md index e2a6ece03f..2de41c283b 100644 --- a/docs/source/docs/simulation/simulation-java.md +++ b/docs/source/docs/simulation/simulation-java.md @@ -244,7 +244,7 @@ A `PhotonCameraSim` can also draw and publish generated camera frames to a MJPEG cameraSim.enableDrawWireframe(true); ``` -These streams follow the port order mentioned in {ref}`docs/quick-start/networking:Camera Stream Ports`. For example, a single simulated camera will have its raw stream at `localhost:1181` and processed stream at `localhost:1182`, which can also be found in the CameraServer tab of Shuffleboard like a normal camera stream. +These streams follow the port order mentioned in {ref}`docs/getting-started/networking:Camera Stream Ports`. For example, a single simulated camera will have its raw stream at `localhost:1181` and processed stream at `localhost:1182`, which can also be found in the CameraServer tab of Shuffleboard like a normal camera stream. :::{figure} images/SimExampleFrame.png _A frame from the processed stream of a simulated camera viewing some 2023 AprilTags with the field wireframe enabled_ diff --git a/docs/source/docs/troubleshooting/networking-troubleshooting.md b/docs/source/docs/troubleshooting/networking-troubleshooting.md index 1eb47d2db5..74fd48eb4a 100644 --- a/docs/source/docs/troubleshooting/networking-troubleshooting.md +++ b/docs/source/docs/troubleshooting/networking-troubleshooting.md @@ -1,12 +1,12 @@ # Networking Troubleshooting -Before reading further, ensure that you follow all the recommendations {ref}`in our networking section `. You should follow these guidelines in order for PhotonVision to work properly; other networking setups are not officially supported. +Before reading further, ensure that you follow all the recommendations {ref}`in our networking section `. You should follow these guidelines in order for PhotonVision to work properly; other networking setups are not officially supported. ## Checklist A few issues make up the majority of support requests. Run through this checklist quickly to catch some common mistakes. -- Is your camera connected to the robot's radio through a {ref}`network switch `? +- Is your camera connected to the robot's radio through a {ref}`network switch `? - Ethernet straight from a laptop to a coprocessor will not work (most likely), due to the unreliability of link-local connections. - Even if there's a switch between your laptop and coprocessor, you'll still want a radio or router in the loop somehow. - The FRC radio is the _only_ router we will officially support due to the innumerable variations between routers. diff --git a/docs/source/index.md b/docs/source/index.md index 6a6d01a4b5..c8a02149ae 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -10,7 +10,7 @@ Welcome to the official documentation of PhotonVision! PhotonVision is the free, .. grid:: 2 .. grid-item-card:: Quick Start - :link: docs/quick-start/index + :link: docs/getting-started/hardware-setups :link-type: doc Quick start to using Photonvision. @@ -88,10 +88,14 @@ PhotonVision is licensed under the [GNU GPL v3](https://www.gnu.org/licenses/gpl :maxdepth: 0 docs/description -docs/quick-start/index -docs/hardware/index -docs/advanced-installation/index +docs/getting-started/hardware-setups +docs/getting-started/installation +docs/getting-started/wiring +docs/getting-started/networking docs/camera-specific-configuration/index +docs/getting-started/camera-matching +docs/getting-started/camera-calibration +docs/getting-started/configuration ``` ```{toctree} @@ -118,6 +122,15 @@ docs/integration/index docs/examples/index ``` +```{toctree} +:caption: Advanced Setup +:hidden: true +:maxdepth: 0 + +docs/hardware/index +docs/advanced-installation/index +``` + ```{toctree} :caption: Additional Resources :hidden: true