Update for five digit team numbers (#2655)

* Update for five digit team numbers * Add further explanation of team number breakdown * Try to fix build * Fix typo Co-authored-by: Jason Daming <[email protected]> --------- Co-authored-by: Jason Daming <[email protected]>
wpilibsuite · May 17, 2024 · 3e37c9e · 3e37c9e
1 parent 7bcfe6b
commit 3e37c9e
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 9 deletions.
diff --git a/source/docs/networking/networking-introduction/ip-configurations.rst b/source/docs/networking/networking-introduction/ip-configurations.rst
@@ -6,14 +6,18 @@ IP Configurations
 TE.AM IP Notation
 -----------------
 
-The notation TE.AM is used as part of IPs in numerous places in this document. This notation refers to splitting your four digit team number into two digit pairs for the IP address octets.
+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.
 
 Example: ``10.TE.AM.2``
 
+Team 1 - ``10.0.1.2``
+
 Team 12 - ``10.0.12.2``
 
 Team 122 - ``10.1.22.2``
 
+Team 1002 - ``10.10.2.2``
+
 Team 1212 - ``10.12.12.2``
 
 Team 1202 - ``10.12.2.2``
@@ -22,6 +26,10 @@ Team 1220 - ``10.12.20.2``
 
 Team 3456 - ``10.34.56.2``
 
+Team 10000 - ``10.100.0.2``
+
+Team 12345 - ``10.123.45.2``
+
 On the Field
 ------------
 

diff --git a/source/docs/networking/networking-introduction/networking-basics.rst b/source/docs/networking/networking-introduction/networking-basics.rst
@@ -41,7 +41,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. An example of this formatting would be ``10.17.50.1`` for FRC Team 1750.
+   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>`).
 
 
 How are these addresses assigned?

diff --git a/source/docs/networking/networking-introduction/roborio-network-troubleshooting.rst b/source/docs/networking/networking-introduction/roborio-network-troubleshooting.rst
@@ -8,7 +8,7 @@ The roboRIO and FRC\ |reg| tools use dynamic IP addresses (:term:`DHCP`) for net
 Ping the roboRIO using mDNS
 ---------------------------
 
-The first step to identifying roboRIO networking issues is to isolate if it is an application issue or a general network issue. To do this, click **Start -> type cmd -> press Enter** to open the command prompt. Type ``ping roboRIO-####-FRC.local`` where #### is your team number (with no leading zeroes) and press enter. If the ping succeeds, the issue is likely with the specific application, verify your team number configuration in the application, and check your firewall configuration.
+The first step to identifying roboRIO networking issues is to isolate if it is an application issue or a general network issue. To do this, click **Start -> type cmd -> press Enter** to open the command prompt. Type ``ping roboRIO-#####-FRC.local`` where ##### is your team number (with no leading zeroes) and press enter. If the ping succeeds, the issue is likely with the specific application, verify your team number configuration in the application, and check your firewall configuration.
 
 Ping the roboRIO IP Address
 ---------------------------
@@ -42,7 +42,7 @@ Ethernet Connection
 .. 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 OM5P-AN radio, it should be an address of the form ``10.TE.AM.XX`` where TEAM is your four digit FRC team number. 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 OM5P-AN 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.
 
 Disabling Network Adapters
 --------------------------

diff --git a/source/docs/software/advanced-gradlerio/profiling-with-visualvm.rst b/source/docs/software/advanced-gradlerio/profiling-with-visualvm.rst
@@ -32,7 +32,7 @@ We will be replacing the highlighted lines with:
       jvmArgs.add("-Dcom.sun.management.jmxremote.local.only=false")
       jvmArgs.add("-Dcom.sun.management.jmxremote.ssl=false")
       jvmArgs.add("-Dcom.sun.management.jmxremote.authenticate=false")
-      jvmArgs.add("-Djava.rmi.server.hostname=10.XX.XX.2") // Replace XX.XX with team number
+      jvmArgs.add("-Djava.rmi.server.hostname=10.TE.AM.2") // Replace TE.AM with team number
    }
 
 We are adding a few arguments here. In order:
@@ -41,7 +41,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.
+* 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>`)
 
 .. important:: The hostname when connected via USB-B should be ``172.22.11.2``.
 

diff --git a/source/docs/software/driverstation/programming-radios-for-fms-offseason.rst b/source/docs/software/driverstation/programming-radios-for-fms-offseason.rst
@@ -20,7 +20,7 @@ Programmed Configuration
 
 The Radio Configuration Utility programs a number of configuration settings into the radio when run. These settings apply to the radio in all modes (including at events). These include:
 
-- Set a static IP of ``10.TE.AM.1``
+- Set a static IP of ``10.TE.AM.1`` (:ref:`TE.AM IP Notation <docs/networking/networking-introduction/ip-configurations:TE.AM IP Notation>`)
 - Set an alternate IP on the wired side of ``192.168.1.1`` for future programming
 - Bridge the wired ports so they may be used interchangeably
 - The LED configuration noted in the status light referenced below.

diff --git a/source/docs/software/roborio-info/roborio-web-dashboard.rst b/source/docs/software/roborio-info/roborio-web-dashboard.rst
@@ -12,7 +12,7 @@ Opening the WebDash
 
 To open the web dashboard, open a web browser and enter the address of
 the roboRIO into the address bar (172.22.11.2 for USB, or
-"roboRIO-####-FRC.local where #### is your team number, with no leading
+"roboRIO-#####-FRC.local where ##### is your team number, with no leading
 zeroes, for either interface). See this document for more details about
 mDNS and roboRIO networking: :ref:`docs/networking/networking-introduction/ip-configurations:IP Configurations`
 

diff --git a/source/docs/software/wpilib-tools/roborio-team-number-setter/index.rst b/source/docs/software/wpilib-tools/roborio-team-number-setter/index.rst
@@ -13,7 +13,7 @@ Connect to the roboRIO over USB to use the tool, as this is the simplest method
 Setting Team Number
 -------------------
 
-Enter your team number in the :guilabel:`Team Number` field and select :guilabel:`Set team to xxxx`. This will take about a second, then press the :guilabel:`Reboot` button to reboot the roboRIO so the new team number takes effect.
+Enter your team number in the :guilabel:`Team Number` field and select :guilabel:`Set team to xxxxx`. This will take about a second, then press the :guilabel:`Reboot` button to reboot the roboRIO so the new team number takes effect.
 
 Enabling/Disabling Webserver
 ----------------------------