Simplify IP configuration article (#3029)

Combine all static configs into one section
Document field usage of .3 & .4 (fixes #2998)

Author: sciencewhiz

source/docs/networking/networking-introduction/ip-configurations.rst

@@ -1,10 +1,10 @@
 # IP Configurations
 
-.. note:: This document describes the IP configuration used at events, both on the fields and in the pits, potential issues and workaround configurations.
+This document describes the IP configuration used at events, both on the fields and in the pits, potential issues and workaround configurations.
 
-## TE.AM IP Notation
+## TE.AM IP Address Notation
 
-The notation TE.AM is used as part of IPs in numerous places in this document. This notation refers to splitting your five digit team number into digits for the IP address octets. Where AM is the last two digits of the team number, and TE is the first three digits. Leading zeros are optional. This scheme supports team numbers up to 25599.
+The notation TE.AM is used as part of IPs in numerous places. This notation refers to splitting your five digit team number into digits for the IP address octets. Where AM is the last two digits of the team number, and TE is the first three digits. Leading zeros are optional. This scheme supports team numbers up to 25599.
 
 Example: ``10.TE.AM.2``
 
@@ -28,55 +28,48 @@ Team 10000 - ``10.100.0.2``
 
 Team 12345 - ``10.123.45.2``
 
-## On the Field
+## DHCP configuration
 
-This section describes networking when connected to the Field Network for match play
+This section describes networking when using :term:`DHCP` to assign IP addresses on the field, in the pits, and at home.
 
 ### On the Field DHCP Configuration
 
-The Field Network runs a :term:`DHCP` server with pools for each team that will hand out addresses in the range of ``10.TE.AM.20`` to ``10.TE.AM.199`` with a subnet mask of ``255.255.255.0``, and a default gateway of ``10.TE.AM.4``.
-When configured for an event, the Team Radio runs a DHCP server with a pool for devices onboard the robot that will hand out addresses in the range of 10.TE.AM.200 to 10.TE.AM.219 with a subnet mask of 255.255.255.0, and a gateway of 10.TE.AM.1.
+The Field Network runs a DHCP server with pools for each team that will hand out addresses in the range of ``10.TE.AM.20`` to ``10.TE.AM.199`` with a subnet mask of ``255.255.255.0``, and a default gateway of ``10.TE.AM.4``.
+When configured for an event, the Team Radio runs a DHCP server with a pool for devices onboard the robot that will hand out addresses in the range of ``10.TE.AM.200`` to ``10.TE.AM.219`` with a subnet mask of ``255.255.255.0``, and a gateway of ``10.TE.AM.1``.
 
--  Vivid-Hosting VH-109 Robot Radio - Static ``10.TE.AM.1`` programmed by
-   Kiosk
+-  Vivid-Hosting VH-109 Robot Radio - Static ``10.TE.AM.1`` programmed by Kiosk
 -  roboRIO - DHCP ``10.TE.AM.2`` assigned by the Robot Radio
--  Driver Station - DHCP ("Obtain an IP address automatically")
-   10.TE.AM.X assigned by field
--  IP camera (if used) - DHCP ``10.TE.AM.Y`` assigned by Robot Radio
--  Other devices (if used) - DHCP ``10.TE.AM.Z`` assigned by Robot Radio
+-  Driver Station - DHCP ("Obtain an IP address automatically") ``10.TE.AM.X`` assigned by field
+-  Other devices (if used) - DHCP ``10.TE.AM.YY`` assigned by Robot Radio
 
-.. note:: If the roboRIO is not being assigned a DHCP IP address of ``10.TE.AM.2``, ensure you've :ref:`Set the roboRIO team number <docs/zero-to-robot/step-3/roborio2-imaging:Setting the roboRIO Team Number>`
-
-### On the Field Static Configuration
-
-It is also possible to configure static IPs on your devices to accommodate devices or software which do not support mDNS. When doing so you want to make sure to avoid addresses that will be in use when the robot is on the field network. These addresses are ``10.TE.AM.1`` for the VH-109 radio, ``10.TE.AM.4`` for the field router, and anything ``10.TE.AM.20`` or greater which may be assigned to a device configured for DHCP or else reserved. The roboRIO network configuration can be set from the webdashboard.
-
--  VH-109 radio - Static ``10.TE.AM.1`` programmed by Kiosk
--  roboRIO - Static ``10.TE.AM.2`` would be a reasonable choice, subnet mask
-   of ``255.255.255.0`` (default)
--  Driver Station - Static ``10.TE.AM.5`` would be a reasonable choice,
-   subnet mask **must** be ``255.0.0.0`` to enable the DS to reach both the robot and :term:`FMS` Server, without additionally configuring the default gateway.
-   If a static address is assigned and the subnet mask is set to ``255.255.255.0``, then the default gateway must be configured to ``10.TE.AM.4``.
--  IP Camera (if used) - Static ``10.TE.AM.11`` would be a reasonable
-   choice, subnet ``255.255.255.0`` should be fine
--  Other devices - Static ``10.TE.AM.6-.10`` or ``.12-.19`` (.11 if camera not
-   present) subnet ``255.255.255.0``
+### In the Pits DHCP Configuration
 
-## In the Pits
+-  VH-109 radio - Static ``10.TE.AM.1`` programmed by Kiosk.
+-  roboRIO - ``10.TE.AM.2``, assigned by Robot Radio
+-  Driver Station - DHCP ("Obtain an IP address automatically"),
+   ``10.TE.AM.X``, assigned by Robot Radio
+-  Other devices (if used) - DHCP, ``10.TE.AM.Y``, assigned by Robot Radio
 
-.. note:: There is a DHCP server running on the wired side of the Robot Radio in the event configuration.
+.. note:: If the roboRIO is not being assigned a DHCP IP address of ``10.TE.AM.2``, ensure you've :ref:`Set the roboRIO team number <docs/zero-to-robot/step-3/roborio2-imaging:Setting the roboRIO Team Number>`
 
-### In the Pits DHCP Configuration
+### At Home DHCP Configuration
 
--  VH-109 radio - Static ``10.TE.AM.1`` programmed by Kiosk.
+-  VH-109 radio - Static ``10.TE.AM.1`` programmed when configuring robot radio
 -  roboRIO - ``10.TE.AM.2``, assigned by Robot Radio
+-  VH-109 access point radio - Static ``10.TE.AM.4``, programmed when configuring access point radio
 -  Driver Station - DHCP ("Obtain an IP address automatically"),
    ``10.TE.AM.X``, assigned by Robot Radio
--  IP camera (if used) - DHCP, ``10.TE.AM.Y``, assigned by Robot Radio
--  Other devices (if used) - DHCP, ``10.TE.AM.Z``, assigned by Robot Radio
+-  Other devices (if used) - DHCP, ``10.TE.AM.Y``, assigned by Robot Radio
 
 .. note:: If the roboRIO is not being assigned a DHCP IP address of ``10.TE.AM.2``, ensure you've :ref:`Set the roboRIO team number <docs/zero-to-robot/step-3/roborio2-imaging:Setting the roboRIO Team Number>`
 
-### In the Pits Static Configuration
+## Static Configuration
+
+It is also possible to configure static IPs on your devices to accommodate devices or software which do not support mDNS. When doing so you want to make sure to avoid addresses that will be in use when the robot is on the field network. These addresses are ``10.TE.AM.1`` for the VH-109 radio, ``10.TE.AM.3`` and ``10.TE.AM.4`` for the field network, and anything ``10.TE.AM.20`` or greater which may be assigned to a device configured for DHCP or else reserved. The roboRIO network configuration can be set from the webdashboard.
 
-It is also possible to configure static IPs on your devices to accommodate devices or software which do not support mDNS. When doing so you want to make sure to avoid addresses that will be in use when the robot is on the field network. These addresses are ``10.TE.AM.1`` for the VH-109 radio and ``10.TE.AM.4`` for the field router.
+-  VH-109 radio - Static ``10.TE.AM.1`` programmed when configuring robot radio
+-  roboRIO - Static ``10.TE.AM.2`` subnet mask of ``255.255.255.0`` (default)
+-  VH-109 access point radio - Static ``10.TE.AM.4``, programmed when configuring access point radio
+-  Driver Station - Static ``10.TE.AM.5`` subnet mask **must** be ``255.0.0.0`` to enable the DS to reach both the robot and :term:`FMS` Server, without additionally configuring the default gateway.
+   If a static address is assigned and the subnet mask is set to ``255.255.255.0``, then the default gateway must be configured to ``10.TE.AM.4``.
+-  Other devices - Static ``10.TE.AM.6-.19`` subnet ``255.255.255.0``

source/docs/networking/networking-introduction/networking-basics.rst

@@ -38,8 +38,7 @@ then passing the returned data back to the private IP that requested it. This al
    :alt: Devices on the private network send their traffic through the NAT device to communicate to the outside network and vice versa.
 
 .. note::
-   For the FRC\ |reg| networks, we will use the ``10.0.0.0`` range. This range allows us to use the ``10.TE.AM.xx`` format for IP addresses, whereas using the Class B or C networks would only allow a subset of teams to follow the format (:ref:`TE.AM IP Notation <docs/networking/networking-introduction/ip-configurations:TE.AM IP Notation>`).
-
+   For the FRC\ |reg| networks, we will use the ``10.0.0.0`` range. This range allows us to use the ``10.TE.AM.xx`` format for IP addresses, whereas using the Class B or C networks would only allow a subset of teams to follow the format.
 
 ## How are these addresses assigned?
 

source/docs/networking/networking-introduction/roborio-network-troubleshooting.rst

@@ -10,7 +10,7 @@ The first step to identifying roboRIO networking issues is to isolate if it is a
 
 ## Ping the roboRIO IP Address
 
-If there is no response, try pinging ``10.TE.AM.2`` (:ref:`TE.AM IP Notation <docs/networking/networking-introduction/ip-configurations:TE.AM IP Notation>`) using the command prompt as described above. If this works, you have an issue resolving the mDNS address on your PC. The two most common causes are not having an mDNS resolver installed on the system and a DNS server on the network that is trying to resolve the .local address using regular DNS.
+If there is no response, try pinging ``10.TE.AM.2`` (:ref:`TE.AM IP Notation <docs/networking/networking-introduction/ip-configurations:TE.AM IP Address Notation>`) using the command prompt as described above. If this works, you have an issue resolving the mDNS address on your PC. The two most common causes are not having an mDNS resolver installed on the system and a DNS server on the network that is trying to resolve the .local address using regular DNS.
 
 - Verify that you have an mDNS resolver installed on your system. On Windows, this is typically fulfilled by the NI FRC Game Tools. For more information on mDNS resolvers, see the :ref:`Network Basics article <docs/networking/networking-introduction/networking-basics:mDNS>`.
 - Disconnect your computer from any other networks. Removing any other routers from the system will help verify that there is not a DNS server causing the issue.
@@ -36,7 +36,7 @@ If this ping succeeds, but the .local ping fails, it is likely that either the r
 .. image:: images/roborio-troubleshooting/roborio-ip-address.png
    :alt: The IP address from the roboRIO webdashboard.
 
-If you are troubleshooting an Ethernet connection, it may be helpful to first make sure that you can connect to the roboRIO using the USB connection. Using the USB connection, open the :ref:`roboRIO webdashboard <docs/software/roborio-info/roborio-web-dashboard:roboRIO Web Dashboard>` and verify that the roboRIO has an IP address on the ethernet interface. If you are tethering to the roboRIO directly this should be a self-assigned ``169.*.*.*`` address, if you are connected to the VH-109 radio, it should be an address of the form ``10.TE.AM.XX`` where TEAM is your five digit FRC team number(:ref:`TE.AM IP Notation <docs/networking/networking-introduction/ip-configurations:TE.AM IP Notation>`). If the only IP address here is the USB address, verify the physical roboRIO ethernet connection.
+If you are troubleshooting an Ethernet connection, it may be helpful to first make sure that you can connect to the roboRIO using the USB connection. Using the USB connection, open the :ref:`roboRIO webdashboard <docs/software/roborio-info/roborio-web-dashboard:roboRIO Web Dashboard>` and verify that the roboRIO has an IP address on the ethernet interface. If you are tethering to the roboRIO directly this should be a self-assigned ``169.*.*.*`` address, if you are connected to the VH-109 radio, it should be ``10.TE.AM.2`` where TEAM is your five digit FRC team number(:ref:`TE.AM IP Notation <docs/networking/networking-introduction/ip-configurations:TE.AM IP Address Notation>`). If the only IP address here is the USB address, verify the physical roboRIO ethernet connection. If the IP address is ``10.TE.AM.XX``, ensure you've :ref:`set the roboRIO team number <docs/zero-to-robot/step-3/roborio2-imaging:Setting the roboRIO Team Number>`
 
 ## Disabling Network Adapters
 

source/docs/software/advanced-gradlerio/profiling-with-visualvm.rst

@@ -37,7 +37,7 @@ We are adding a few arguments here. In order:
 * Set the remote debugging port to 1198
 * Allow listening from remote targets
 * Disable SSL authentication being required
-* Set the hostname to the roboRIOs team number. Be sure to replace this. (:ref:`TE.AM IP Notation <docs/networking/networking-introduction/ip-configurations:TE.AM IP Notation>`)
+* Set the hostname to the roboRIOs team number. Be sure to replace this. (:ref:`TE.AM IP Notation <docs/networking/networking-introduction/ip-configurations:TE.AM IP Address Notation>`)
 
 .. important:: The hostname when connected via USB-B should be ``172.22.11.2``.