Actually properly match cameras by name fr this time (PhotonVision#1237)

Our current code matches cameras in this order (which I think is objectively wrong and stupid)

- by-id (/dev/v4l/by-id/product-string)
- by path (/dev/videoN)
- product string/name, but ascii only
- asks cscore to reconnect to cameras using `path`, which on linux is actually /dev/videoN. This isn't guaranteed to stick to a camera if you replug them weirdly at runtime.

This is silly and does not consider the actual physical usb port. I propose instead, in this order:

- By physical usb port path and base name
- by physical usb port path and USB VID/PID
- By base name only (with a toggle switch to disable this, and create a new VisionModule instead)
- Give cscore /dev/video/by-path on Linux systems, pinning Photon USBCameras to a particular usb port once created.

This changes lots of things so stay paranoid!

photon-client/src/components/settings/NetworkingCard.vue

@@ -59,7 +59,8 @@ const settingsHaveChanged = (): boolean => {
     a.shouldPublishProto !== b.shouldPublishProto ||
     a.networkManagerIface !== b.networkManagerIface ||
     a.setStaticCommand !== b.setStaticCommand ||
-    a.setDHCPcommand !== b.setDHCPcommand
+    a.setDHCPcommand !== b.setDHCPcommand ||
+    a.matchCamerasOnlyByPath !== b.matchCamerasOnlyByPath
   );
 };
 
@@ -77,6 +78,7 @@ const saveGeneralSettings = () => {
     setStaticCommand: tempSettingsStruct.value.setStaticCommand || "",
     shouldManage: tempSettingsStruct.value.shouldManage,
     shouldPublishProto: tempSettingsStruct.value.shouldPublishProto,
+    matchCamerasOnlyByPath: tempSettingsStruct.value.matchCamerasOnlyByPath,
     staticIp: tempSettingsStruct.value.staticIp
   };
 
@@ -137,6 +139,8 @@ watchEffect(() => {
 
 <template>
   <v-card dark class="mb-3 pr-6 pb-3" style="background-color: #006492">
+    <v-card-title>Global Settings</v-card-title>
+    <v-divider />
     <v-card-title>Networking</v-card-title>
     <div class="ml-5">
       <v-form ref="form" v-model="settingsValid">
@@ -254,6 +258,9 @@ watchEffect(() => {
         >
           This mode is intended for debugging; it should be off for proper usage. PhotonLib will NOT work!
         </v-banner>
+
+        <v-divider />
+        <v-card-title>Miscellaneous</v-card-title>
         <pv-switch
           v-model="tempSettingsStruct.shouldPublishProto"
           label="Also Publish Protobuf"
@@ -272,6 +279,14 @@ watchEffect(() => {
           This mode is intended for debugging; it should be off for field use. You may notice a performance hit by using
           this mode.
         </v-banner>
+        <pv-switch
+          v-model="tempSettingsStruct.matchCamerasOnlyByPath"
+          label="Match cameras by-path ONLY"
+          tooltip="ONLY match cameras by the USB port they're plugged into + (basename or USB VID/PID), and never only by the device product string"
+          class="mt-3 mb-2"
+          :label-cols="4"
+        />
+        <v-divider class="mb-3" />
       </v-form>
       <v-btn
         color="accent"

photon-client/src/stores/settings/GeneralSettingsStore.ts

@@ -44,7 +44,9 @@ export const useSettingsStore = defineStore("settings", {
           connName: "Example Wired Connection",
           devName: "eth0"
         }
-      ]
+      ],
+      networkingDisabled: false,
+      matchCamerasOnlyByPath: false
     },
     lighting: {
       supported: true,

photon-client/src/types/SettingTypes.ts

@@ -47,6 +47,7 @@ export interface NetworkSettings {
   setDHCPcommand?: string;
   networkInterfaceNames: NetworkInterfaceType[];
   networkingDisabled: boolean;
+  matchCamerasOnlyByPath: boolean;
 }
 
 export type ConfigurableNetworkSettings = Omit<

photon-core/src/main/java/org/photonvision/common/configuration/CameraConfiguration.java

@@ -23,6 +23,7 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
+import java.util.Optional;
 import org.photonvision.common.logging.LogGroup;
 import org.photonvision.common.logging.Logger;
 import org.photonvision.vision.calibration.CameraCalibrationCoefficients;
@@ -51,6 +52,12 @@ public class CameraConfiguration {
 
     @JsonIgnore public String[] otherPaths = {};
 
+    @JsonProperty("usbVID")
+    public int usbVID = -1;
+
+    @JsonProperty("usbPID")
+    public int usbPID = -1;
+
     public CameraType cameraType = CameraType.UsbCamera;
     public double FOV = 70;
     public final List<CameraCalibrationCoefficients> calibrations;
@@ -98,7 +105,9 @@ public CameraConfiguration(
             @JsonProperty("cameraType") CameraType cameraType,
             @JsonProperty("cameraQuirks") QuirkyCamera cameraQuirks,
             @JsonProperty("calibration") List<CameraCalibrationCoefficients> calibrations,
-            @JsonProperty("currentPipelineIndex") int currentPipelineIndex) {
+            @JsonProperty("currentPipelineIndex") int currentPipelineIndex,
+            @JsonProperty("usbVID") int usbVID,
+            @JsonProperty("usbPID") int usbPID) {
         this.baseName = baseName;
         this.uniqueName = uniqueName;
         this.nickname = nickname;
@@ -108,6 +117,8 @@ public CameraConfiguration(
         this.cameraQuirks = cameraQuirks;
         this.calibrations = calibrations != null ? calibrations : new ArrayList<>();
         this.currentPipelineIndex = currentPipelineIndex;
+        this.usbPID = usbPID;
+        this.usbVID = usbVID;
 
         logger.debug(
                 "Creating camera configuration for "
@@ -156,6 +167,17 @@ public void addCalibration(CameraCalibrationCoefficients calibration) {
         calibrations.add(calibration);
     }
 
+    /**
+     * Get a unique descriptor of the USB port this camera is attached to. EG
+     * "/dev/v4l/by-path/platform-fc800000.usb-usb-0:1.3:1.0-video-index0"
+     *
+     * @return
+     */
+    @JsonIgnore
+    public Optional<String> getUSBPath() {
+        return Arrays.stream(otherPaths).filter(path -> path.contains("/by-path/")).findFirst();
+    }
+
     @Override
     public String toString() {
         return "CameraConfiguration [baseName="

photon-core/src/main/java/org/photonvision/common/configuration/HardwareSettings.java

@@ -20,6 +20,24 @@
 public class HardwareSettings {
     public int ledBrightnessPercentage = 100;
 
+    @Override
+    public int hashCode() {
+        final int prime = 31;
+        int result = 1;
+        result = prime * result + ledBrightnessPercentage;
+        return result;
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        if (this == obj) return true;
+        if (obj == null) return false;
+        if (getClass() != obj.getClass()) return false;
+        HardwareSettings other = (HardwareSettings) obj;
+        if (ledBrightnessPercentage != other.ledBrightnessPercentage) return false;
+        return true;
+    }
+
     @Override
     public String toString() {
         return "HardwareSettings [ledBrightnessPercentage=" + ledBrightnessPercentage + "]";

photon-core/src/main/java/org/photonvision/common/configuration/NetworkConfig.java

@@ -39,6 +39,12 @@ public class NetworkConfig {
     public boolean shouldManage;
     public boolean shouldPublishProto = false;
 
+    /**
+     * If we should ONLY match cameras by path, and NEVER only by base-name. For now default to false
+     * to preserve old matching logic
+     */
+    public boolean matchCamerasOnlyByPath = false;
+
     @JsonIgnore public static final String NM_IFACE_STRING = "${interface}";
     @JsonIgnore public static final String NM_IP_STRING = "${ipaddr}";
 
@@ -76,7 +82,8 @@ public NetworkConfig(
             @JsonProperty("shouldPublishProto") boolean shouldPublishProto,
             @JsonProperty("networkManagerIface") String networkManagerIface,
             @JsonProperty("setStaticCommand") String setStaticCommand,
-            @JsonProperty("setDHCPcommand") String setDHCPcommand) {
+            @JsonProperty("setDHCPcommand") String setDHCPcommand,
+            @JsonProperty("matchCamerasOnlyByPath") boolean matchCamerasOnlyByPath) {
         this.ntServerAddress = ntServerAddress;
         this.connectionType = connectionType;
         this.staticIp = staticIp;
@@ -86,6 +93,7 @@ public NetworkConfig(
         this.networkManagerIface = networkManagerIface;
         this.setStaticCommand = setStaticCommand;
         this.setDHCPcommand = setDHCPcommand;
+        this.matchCamerasOnlyByPath = matchCamerasOnlyByPath;
         setShouldManage(shouldManage);
     }
 

photon-core/src/main/java/org/photonvision/vision/camera/CameraInfo.java

@@ -19,6 +19,7 @@
 
 import edu.wpi.first.cscore.UsbCameraInfo;
 import java.util.Arrays;
+import java.util.Optional;
 
 public class CameraInfo extends UsbCameraInfo {
     public final CameraType cameraType;
@@ -68,6 +69,16 @@ public String getHumanReadableName() {
         return getBaseName().replaceAll(" ", "_");
     }
 
+    /**
+     * Get a unique descriptor of the USB port this camera is attached to. EG
+     * "/dev/v4l/by-path/platform-fc800000.usb-usb-0:1.3:1.0-video-index0"
+     *
+     * @return
+     */
+    public Optional<String> getUSBPath() {
+        return Arrays.stream(otherPaths).filter(path -> path.contains("/by-path/")).findFirst();
+    }
+
     @Override
     public boolean equals(Object o) {
         if (o == this) return true;
@@ -79,4 +90,19 @@ public boolean equals(Object o) {
                 && productId == other.productId
                 && vendorId == other.vendorId;
     }
+
+    @Override
+    public String toString() {
+        return "CameraInfo [cameraType="
+                + cameraType
+                + "baseName="
+                + getBaseName()
+                + ", vid="
+                + vendorId
+                + ", pid="
+                + productId
+                + ", otherPaths="
+                + Arrays.toString(otherPaths)
+                + "]";
+    }
 }

photon-core/src/main/java/org/photonvision/vision/camera/USBCameraSource.java

@@ -49,9 +49,17 @@ public USBCameraSource(CameraConfiguration config) {
         super(config);
 
         logger = new Logger(USBCameraSource.class, config.nickname, LogGroup.Camera);
-        camera = new UsbCamera(config.nickname, config.path);
+        // cscore will auto-reconnect to the camera path we give it. v4l does not guarantee that if i
+        // swap cameras around, the same /dev/videoN ID will be assigned to that camera. So instead
+        // default to pinning to a particular USB port, or by "path" (appears to be a global identifier)
+        // on Windows.
+        camera = new UsbCamera(config.nickname, config.getUSBPath().orElse(config.path));
         cvSink = CameraServer.getVideo(this.camera);
 
+        // set vid/pid if not done already for future matching
+        if (config.usbVID < 0) config.usbVID = this.camera.getInfo().vendorId;
+        if (config.usbPID < 0) config.usbPID = this.camera.getInfo().productId;
+
         if (getCameraConfiguration().cameraQuirks == null)
             getCameraConfiguration().cameraQuirks =
                     QuirkyCamera.getQuirkyCamera(