Merge pull request #347 from ROAR-QUTRC/docs/network

Docs/network

Author: OMEN44

docs/source/systems/hardware/network.md

@@ -2,36 +2,66 @@
 
 ## TLDR
 
-Perseus assumes that it will connect to a wifi network with SSID: "QUTRC-ROAR".
-
-All processes and nodes running should be able to operate via a network connection sharing a single 2.4GHz wifi connection with a 20MHz channel width.
-
-Whilst the rules allow for 40Mhz bonding interference is possible.
-
-Assuming 20MHz means 802.11g which is 54Mbps.
-
+Perseus assumes that it will connect to a wifi network with SSID: "QUTRC-ROAR-LOCAL".
+All processes and nodes running should be able to operate via a network connection sharing a single 2.4 GHz wifi connection with a 20 MHz channel width.
+Whilst the rules allow for 40 Mhz bonding interference is possible.
+Assuming 20MHz means 802.11g which is 54 Mbps.
 This equates to a maximum usage network connection of 6.75 MBps.
-
-If bonding is used then 802.11n allows for up to 600 Mbps (this would require 4xMIMO) being 75MBps.
+If bonding is used then 802.11n allows for up to 600 Mbps (this would require 4xMIMO) being 75 MBps.
 
 ## Purpose
 
 Some of the software written for Perseus will operate better if details of the network Perseus operates on are known.
-This file seeks to capture these details
+This file seeks to capture these details.
 
 ## Wifi Network Assumptions
 
-The wifi network that Perseus can see has the following attributes
-SSID for 2.4Ghz: "QUTRC-ROAR"
-SSID for 5Ghz: "QUTRC-ROAR"
-Hard-wired ethernet operation also needs to be accommodated
+The wifi network that Perseus can see has the following attributes:
 
-During competition:
-Either 20 Mhz band on nominated Channel 1 or Channel 11.
-OR
-40Mhz band on either 1-5 or 9-13
+SSID for 2.4Ghz and 5Ghz: "QUTRC-ROAR-LOCAL"
+
+Hard-wired ethernet operation also needs to be accommodated.
+
+During competition, either of:
+
+- 20 Mhz band on nominated Channel 1 or Channel 11
+- 40 Mhz band on either 1-5 or 9-13
 
 During Practice:
-20 or 40 Mhz band centred on channel 6
 
-Assumption: All systems need to be able to concurrently operate on 20Mhz (Max ~97 Mbps)
+- 20 or 40 Mhz band centred on channel 6
+
+Assumption: All systems need to be able to concurrently operate on 20 Mhz (Max ~97 Mbps)
+
+## Devices
+
+All networking devices used are Unifi (with the exception of the small PoE switch on Perseus itself).
+This is because the user interface is very comprehensive and easy to customise if/when we want to change something.
+The devices currently used (as of 23/12/2025) are:
+
+1. Unifi Cloud Gateway Max ([UCG Max](https://techspecs.ui.com/unifi/cloud-gateways/ucg-max?s=us))
+   ![UCG Max](https://cdn.ecomm.ui.com/products/8cca3680-14a6-496a-af7d-beba49cea3f2/7c6f4e54-1f20-485a-a0f0-22e968b66a66.png)
+2. Unifi Switch 8 Port PoE 150W ([US 8 PoE](https://techspecs.ui.com/unifi/switching/us-8-150w?subcategory=all-switching))
+   ![US 8 PoE](https://cdn.ecomm.ui.com/products/fdec2ee9-f41c-477c-8459-bc738780dd27/a74b1c79-80c4-492b-9c13-a11ca78bb4bd.png)
+3. Unifi 7 Long Range Access Point ([U7 Long Range](https://techspecs.ui.com/unifi/wifi/u7-lr?subcategory=all-wifi))
+   ![U7 Long Range](https://cdn.ecomm.ui.com/products/7455fa2b-3074-47a0-b82f-a2cd701d4a8f/06752627-8180-42ea-afe3-4cfac57c10eb.png)
+4. Unifi 7 Outdoor Antenna Access Point ([U7 Outdoor](https://techspecs.ui.com/unifi/wifi/u7-outdoor))
+   ![U7 Outdoor](https://cdn.ecomm.ui.com/products/62cc30b7-9559-480f-9668-b9edf40c0772/f2010c22-ff34-48e5-81f4-e7dad275d3c0.png)
+
+Both the U7 Long Range and U7 Outdoor require Power over Ethernet.
+On-board Perseus, there is a small PoE switch that is used to power the U7 Long Range as well as connect Perseus' devices together.
+At base station, the U7 Outdoor is connected into the US 8 PoE switch, which is able to deliver PoE+ to the U7 Outdoor.
+The US 8 PoE switch is connected directly into the UCG Max, which is the controller of the network.
+Laptops are connected into the UCG Max or the US 8 PoE switch via ethernet, or via WiFi into a separate access point ([AC Mesh](https://techspecs.ui.com/unifi/wifi/uap-ac-mesh?subcategory=all-wifi) - optional).
+A phone is connected via ethernet (through a USB-C to ethernet adapter) into the WAN port of the UCG Max, and set to give the network internet from the phone's data.
+
+The U7 Outdoor is highly directional, so it is pointed directly into the arena to get the best signal to the U7 Long Range.
+The omnidirectional antennae can be attached for a wider signal, but this reduces the range.
+
+When not at competition, the rover can use the Robots101 [Unifi Express](https://techspecs.ui.com/unifi/cloud-gateways/ux?subcategory=all-cloud-gateways).
+
+![Unifi Express](https://cdn.ecomm.ui.com/products/4ed25b4c-db92-4b98-bbf3-b0989f007c0e/3ff34453-72fa-485e-b2fa-836b10dbc3be.png)
+
+It is set up with the same SSID and password as the other Unifi hardware.
+It is plugged directly into the PoE switch on the rover, and can be used alone, without any of the other networking gear.
+It is powered through an XT30 to USB-C adapter attached to one of the XT30s in Perseus.

docs/source/systems/software/network-config.md

@@ -0,0 +1,24 @@
+# Network Configuration
+
+To configure Unifi firmware, connect to the network (likely by ethernet at first, but after it's set up, wifi will work), then go to https://unifi/network/default/dashboard.
+
+## UCG Max
+
+No configuration necessary.
+
+## U7 Outdoor
+
+Needs to be configured as a 'Mesh Parent' as well as to allow 'Mesh Connect'.
+Needs to have the correct antenna configuration selected - either 'Omni Antenna' (less range, wide angle) or 'Built-in Antenna' (higher range, less angle).
+
+## U7 Long Range
+
+Needs to be configured to allow 'Mech Connect'.
+
+## US 8 PoE
+
+No configuration necessary.
+
+## Network
+
+The network name (SSID) should be "QUTRC-ROAR-LOCAL" and the password should be shared with all the leads.