Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions docs/source/docs/quick-start/networking.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

## Physical Networking

:::{warning}
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.
:::

::::{tab-set}

:::{tab-item} New Radio (2025 - present)
Expand Down Expand Up @@ -39,6 +35,29 @@ Rename each device from the default "photonvision" to a unique hostname (e.g., "
:alt: The hostname can be edited in the settings page under the network section.
```

## Test Networking

By default, PhotonVision will attempt to obtain an IP address from a router through DHCP, and fall back to a self-assigned link-local address if that fails. With either of these methods, it is best to access the PhotonVision web dashboard through its hostname and port (`photonvision.local:5800` by default) since its IP address is not known ahead of time. (An mDNS resolver is required to use `.local` hostnames, often installed by default.)

::::{tab-set}

:::{tab-item} DHCP (Router)

If PhotonVision is connected to a DHCP server such as a router, it will obtain a dynamic IP address assignment (like “192.168.0.101” or “10.TE.AM.200”). If a DHCP server (router) is not found on the network, it falls back to a link-local address. Nearly all host computers will support a DHCP network without extra thought, as long as an incompatible static IP address was not configured on the host computer.

:::

:::{tab-item} Link-Local (Direct)

If PhotonVision is directly wired to the host computer, a randomly-generated link-local IP address (like “169.254.36.176”) will be self-assigned. This requires the host computer to also self-assign a link-local address for communication to be established. Many host computers do this by default, although sometimes additional configuration or installations are required to enable the link-local service.

:::
::::

:::{warning}
Both DHCP and link-local address assignment are disabled if PhotonVision is configured with a static IP address, which may make your camera inaccessible on a test network.
:::

## Robot 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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ public class NetworkingCommands {
autoconnect yes
ipv4.method auto
ipv6.method disabled
ipv4.link-local fallback
""".replaceAll("[\\n]", " ");
}
//spotless:on
Loading