Banner addition, sidebar image change, networking trouble shooting (#258)

mdurrani808 · web-flow · commit 9f5154a6cd01 · 2023-01-12T16:53:17.000-05:00
* Banner, sidebar, networking

* lint

* static ip
diff --git a/source/_static/assets/PhotonVision-Header-noBG.png b/source/_static/assets/PhotonVision-Header-noBG.png
diff --git a/source/_static/assets/PhotonVision-Header-onWhite.png b/source/_static/assets/PhotonVision-Header-onWhite.png
diff --git a/source/conf.py b/source/conf.py
@@ -77,8 +77,9 @@ def setup(app):
 
 html_theme_options = {
     "sidebar_hide_name": True,
-    "light_logo": "assets/RoundLogoLight.png",
-    "dark_logo": "assets/RoundLogo.png",
+    "light_logo": "assets/PhotonVision-Header-onWhite.png",
+    "dark_logo": "assets/PhotonVision-Header-noBG.png",
+    "announcement": "If you are new to PhotonVision, click <a href=https://docs.photonvision.org/en/latest/docs/getting-started/installation/index.html>here!</a>.",
     
     "light_css_variables": {
         "font-stack": '-apple-system, BlinkMacSystemFont, avenir next, avenir, segoe ui, helvetica neue, helvetica, Ubuntu, roboto, noto, arial, sans-serif;',
diff --git a/source/docs/getting-started/installation/index.rst b/source/docs/getting-started/installation/index.rst
@@ -1,25 +1,38 @@
 Getting Started
 ===============
 
-Wiring
--------
+This page will help you install PhotonVision on your coprocessor, wire it, and properly setup the networking in order to start tracking targets.
 
-.. toctree::
-   :maxdepth: 1
 
-   wiring
+Step 1: Software Install
+------------------------
+
+This section will walk you through how to install PhotonVision on your coprcoessor. 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).
 
-Software Install
-----------------
+.. 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.
 
 .. toctree::
    :maxdepth: 3
 
    sw_install/index
 
 
-Networking
-----------
+Step 2: Wiring
+--------------
+
+This section will walk you through how to wire your coprocessor to get power.
+
+.. toctree::
+   :maxdepth: 1
+
+   wiring
+
+
+Step 3: Networking
+------------------
+
+This section will walk you though how to connect your coprocessor to a network. This section is very important (and easy to get wrong), so we reccomend you read it throughly.
+
 .. toctree::
    :maxdepth: 1
 
diff --git a/source/docs/getting-started/installation/networking.rst b/source/docs/getting-started/installation/networking.rst
@@ -3,14 +3,20 @@ Networking
 
 Physical Networking
 -------------------
-.. note:: When using PhotonVision off robot, try to plug the coprocessor into a physical router if you can. Windows and other OS are known to be buggy networking wise when a coprocessor is directly plugged in.
+.. note:: When using PhotonVision off robot, you *MUST* plug the coprocessor into a physical router/radio. You can then connect your laptop/device used to view the webdashboard to the same network. Any other networking setup will not work and will not be supported in any capacity.
+
+After imaging your coprocessor, run an ethernet cable from your coprocessor to a router/radio and power on your coprocessor by plugging it into the wall. Then connect whatever device you're using to view the webdashboard to the same network and navigate to photonvision.local:5800.
 
 PhotonVision *STRONGLY* recommends the usage of a network switch on your robot. This is because the second radio port on the current FRC radios is known to be buggy and cause frequent connection issues that are detrimental during competition. More information can be found in this `ChiefDelphi thread <https://www.chiefdelphi.com/t/why-you-probably-shouldnt-use-the-second-port-on-your-openmesh-om5p-radio-and-embrace-using-an-ethernet-switch-instead/406374>`_ and an in-depth guide on how to install a network switch can be found `on FRC 900's website <https://team900.org/blog/ZebraSwitch/>`_.
 
+
+
 Digital Networking
 ------------------
 PhotonVision *STRONGLY* recommends the usage of Static IPs as it increases reliability on the field and when using PhotonVision in general. To properly set up your static IP, follow the steps below:
 
+.. warning:: Only use a static IP when connected to the robot radio, unless you are well versed in networking or have the relevant "know how".
+
 1. Ensure your robot is on and you are connected to the robot network.
 2. Navigate to ``photonvision.local:5800`` (this may be different if you are using a Gloworm / Limelight) in your browser.
 3. Open the settings tab on the left pane.
diff --git a/source/docs/getting-started/installation/sw_install/linux-pc.rst b/source/docs/getting-started/installation/sw_install/linux-pc.rst
@@ -2,6 +2,8 @@ Linux PC Installation
 =====================
 PhotonVision may be run on a Debian-based Linux Desktop PC for basic testing and evaluation.
 
+.. note:: You do not need to install PhotonVision on a Windows PC in order to access the webdashboard (assuming you are using an external coprocessor like a Raspberry Pi).
+
 Installing Java
 ---------------
 PhotonVision requires a JDK installed and on the system path. JDK 11 is needed (different versions will not work). If you don't have JDK 11 already, run the following to install it:
diff --git a/source/docs/getting-started/installation/sw_install/mac-os.rst b/source/docs/getting-started/installation/sw_install/mac-os.rst
@@ -3,6 +3,8 @@ Mac OS Installation
 
 .. warning:: Due to current `cscore <https://github.com/wpilibsuite/allwpilib/tree/main/cscore>`_ restrictions, the PhotonVision server backend may have issues running macOS.
 
+.. note:: You do not need to install PhotonVision on a Windows PC in order to access the webdashboard (assuming you are using an external coprocessor like a Raspberry Pi).
+
 VERY Limited macOS support is available.
 
 Installing Java
diff --git a/source/docs/getting-started/installation/sw_install/windows-pc.rst b/source/docs/getting-started/installation/sw_install/windows-pc.rst
@@ -2,6 +2,8 @@ Windows PC Installation
 =======================
 PhotonVision may be run on a Windows Desktop PC for basic testing and evaluation.
 
+.. note:: You do not need to install PhotonVision on a Windows PC in order to access the webdashboard (assuming you are using an external coprocessor like a Raspberry Pi).
+
 Install Bonjour
 ---------------
 Bonjour provides more stable networking when using Windows PCs. Install `Bonjour here <https://support.apple.com/downloads/DL999/en_US/BonjourPSSetup.exe>`_ before continuing to ensure a stable experience while using PhotonVision.
diff --git a/source/docs/getting-started/installation/wiring.rst b/source/docs/getting-started/installation/wiring.rst
@@ -5,9 +5,9 @@ Wiring
 Off-Robot Wiring
 ----------------
 
-After imaging your coprocessor, run an ethernet cable from your coprocessor to your computer/router (router is recommended) and power on your coprocessor by plugging it into the wall.
+Plugging your coprocessor into the wall via a power brick will suffice for off robot wiring.
 
-.. note:: When using PhotonVision off robot, try to plug the coprocessor into a physical router if you can. Windows and other OS are known to be buggy networking wise when a coprocessor is directly plugged in.
+.. note:: Please make sure your chosen power supply can provide enough power for your coprocessor. Undervolting (where enough power isn't being supplied) can cause many issues.
 
 
 On-Robot Wiring
diff --git a/source/docs/troubleshooting/index.rst b/source/docs/troubleshooting/index.rst
@@ -7,3 +7,4 @@ Troubleshooting
    common-errors
    logging
    camera-troubleshooting
+   networking-troubleshooting
diff --git a/source/docs/troubleshooting/networking-troubleshooting.rst b/source/docs/troubleshooting/networking-troubleshooting.rst
@@ -0,0 +1,25 @@
+Networking Troubleshooting
+==========================
+
+Before reading further, ensure that you follow all the reccomendations in our networking section. You must be following these guidelines in order for PhotonVision to work properly, other networking setups are not officially supported.
+
+photonvision.local Not Found
+----------------------------
+
+Use `Angry IP Scanner <https://angryip.org/>`_ and look for an IP that has port 5800 open. Then go to your web browser and do <IP ADDRESS>:5800.
+
+Alternatively, you can plug your coprocessor into a display, plug in a keyboard, and run ``hostname -I`` in the terminal. This should give you the IP Address of your coprocessor, then go to your web browser and do <IP ADDRESS>:5800.
+
+If nothing shows up, ensure your coprocessor has power, and you are following all of our networking reccomendations, feel free to :ref:`contact us <index:contact us>` and we will help you.
+
+Can't Connect To Robot
+----------------------
+
+Please check that:
+1. You don't have the NetworkTables Server on (toggleable in the settings tab). Turn this off when doing work on a robot.
+2. You have your team number set properly in the settings tab.
+3. Your camera name in the ``PhotonCamera`` constructor matches the name in the UI.
+4. You are using the 2023 version of WPILib and RoboRIO image.
+5. Your robot is on.
+
+If all of the above are met and you still have issues, feel free to :ref:`contact us <index:contact us>` and we will help you.
