Update docs to show that IP addresses or hostnames are allowed. (#272)

This change should not be merged until PR PhotonVision/photonvision#764 is applied. Co-authored-by: Matt <[email protected]>
PhotonVision · Sep 26, 2023 · 9204b9c · 9204b9c
1 parent e0c4bb6
commit 9204b9c
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/source/docs/hardware/Settings.rst b/source/docs/hardware/Settings.rst
@@ -11,7 +11,10 @@ Networking
 ^^^^^^^^^^
 Here, you can set your team number, switch your IP between DHCP and static, and specify your host name. For more information about on-robot networking, click `here. <https://docs.wpilib.org/en/latest/docs/networking/networking-introduction/networking-basics.html>`_
 
-.. note:: A team number is always required if using PhotonVision on a robot.
+The "team number" field will accept (in addition to a team number) an IP address or hostname. This is useful for testing PhotonVision on the same computer as a simulated robot program;
+you can set the team number to "localhost", and PhotonVision will send data to the network tables in the simulated robot.
+
+.. note:: Something must be entered into the team number field if using PhotonVision on a robot. Using a team number is recommended (as opposed to an IP address or hostname).
 
 LEDs
 ^^^^

diff --git a/source/docs/hardware/config.rst b/source/docs/hardware/config.rst
@@ -27,7 +27,7 @@ The directory structure is outlined below.
 * hardwareSettings.json
    - Contains hardware settings. Currently this includes only the LED brightness.
 * networkSettings.json
-   - Contains network settings, including team number, static/dynamic settings, and hostname.
+   - Contains network settings, including team number (or remote network tables address), static/dynamic settings, and hostname.
 
 Importing and Exporting Settings
 --------------------------------