Merge pull request #9 from Neradoc/add-usb-location

Add usb location

Author: Neradoc

README.md

@@ -102,7 +102,8 @@ Devices list (MacOS)
 		'mains': ['code.py'],
 		'mount_point': '/Volumes/CIRCUITPY',
 		'name': 'CIRCUITPY'
-	}]
+	}],
+	'usb_location': '0x14630000'
 }]
 ```
 
@@ -118,6 +119,23 @@ Devices list (MacOS)
 ### The DeviceInfoDict class
 The device list is actually a list of DeviceInfoDict, a subclass of dictionary that adds a few properties as shortcuts for paths in the dictionary, with a default value of `None`.
 
+Dictionary entries:
+- **`name`**: USB name of the board (str).
+- **`manufacturer`**: USB manufacturer of the board (str).
+- **`product_id`**: USB Product ID (int).
+- **`vendor_id`**: USB Vendor ID (int).
+- **`serial_num`**: USB Serial number of the board (str).
+- **`version`**: Circuitpython version, if found.
+- **`ports`**: list of serial ports found on the board, dictionaries.
+	- **`dev`**: port device, used to connect to the port. COM port on windows, dev path on linux (str).
+	- **`iface`**: interface name for the serial port (str).
+- **`volumes`**: list of mounted drives from the board, dictionaries.
+	- **`name`**: drive name, usually `CIRCUITPY` for Circuitpython or `*BOOT` for a UF2 bootloader drive (str).
+	- **`mount_point`**: mount path of the drive, letter on windows (str).
+	- **`mains`**: list of "main" files for Circuitpython (code.py etc.), by order of priority.
+- **`usb_location`**: an identifier for the USB port the board is connected to, should be consistent across reboots and modes (bootloader/application). 
+
+Shortcuts:
 - **`repl`**: REPL port, if any.
 - **`data`**: data port, if any.
 - **`drive`** and **`volume`**: board drive path.

discotool/usbinfos/usb_descriptor_win32.py

@@ -22,12 +22,16 @@ class DeviceInfo:
     """
     Device information class
     """
-    def __init__(self, vid, pid, manufacturer, product, serial_number):
+    def __init__(self, vid, pid, manufacturer, product, serial_number, location):
         self.vid = vid
         self.pid = pid
         self.manufacturer = manufacturer
         self.product = product
-        self.serial_number = serial_number
+        if serial_number == 0:
+            self.serial_number = ""
+        else:
+            self.serial_number = str(serial_number).upper()
+        self.location = ".".join(f"{i}" for i in location)
 
     def __repr__(self):
         return (
@@ -37,6 +41,7 @@ def __repr__(self):
             f"\tmanufacturer:{repr(self.manufacturer)},\n"
             f"\tproduct:{repr(self.product)},\n"
             f"\tserial number:{repr(self.serial_number)}\n"
+            f"\tlocation:{repr(self.location)}\n"
             "}"
         )
 
@@ -147,7 +152,7 @@ def get_str_desc(handle, conn_idx, str_idx):
     return ''
 
 
-def exam_hub(name, level):
+def exam_hub(name, level, location):
     handle = open_dev(r'\\.\{}'.format(name))
     if not handle:
         return
@@ -156,11 +161,11 @@ def exam_hub(name, level):
                                 None,
                                 76,
                                 None)
-    devices = get_hub_ports(handle, buf[6], level)
+    devices = get_hub_ports(handle, buf[6], level, location)
     handle.close()
     return devices
 
-def get_hub_ports(handle, num_ports, level):
+def get_hub_ports(handle, num_ports, level, location):
     devices = []
     for idx in range(1, num_ports+1):
         info = chr(idx) + '\0'*34
@@ -177,7 +182,7 @@ def get_hub_ports(handle, num_ports, level):
         _, vid, pid, vers, manu, prod, seri, _, ishub, _, stat = struct.unpack('=12sHHHBBB3s?6sL', buf[:35])
 
         if ishub:
-            devices += exam_hub(get_ext_hub_name(handle, idx), level)
+            devices += exam_hub(get_ext_hub_name(handle, idx), level + 1, location + (idx,))
         elif stat == 1:
             if (manu != 0 or prod != 0 or seri != 0):
                 # print('{}  [Port{}] {}'.format('  '*level, idx, get_driverkey_name(handle, idx)))
@@ -187,7 +192,7 @@ def get_hub_ports(handle, num_ports, level):
                     prod = get_str_desc(handle, idx, prod)
                 if seri != 0:
                     seri = get_str_desc(handle, idx, seri)
-                devices.append(DeviceInfo(vid, pid, manu, prod, seri))
+                devices.append(DeviceInfo(vid, pid, manu, prod, seri, location + (idx,)))
     return devices
 
 
@@ -213,10 +218,10 @@ def get_all_devices():
                                     None,
                                     76,
                                     None)
-        devices += get_hub_ports(dev_handle, buf[6], 0)
+        devices += get_hub_ports(dev_handle, buf[6], 0, (i,))
         dev_handle.close()
         handle.close()
-    
+
     return [dev for dev in devices if dev.serial_number not in ("","0","''")]
 
 def main():

discotool/usbinfos/usbinfos_linux.py

@@ -75,15 +75,20 @@ def get_devices_list(drive_info=False):
 						'mains': mains,
 					})
 		#
-		# go through parents and find "devpath", remove matching parents
+		# the issue is that we might find duplicates of devices, by finding
+		# a parent and treating it as the device. So, when we find a device
+		# that has parents that are previously found devices, we remove
+		# said parents.
 		def noParent(dev):
-			for papa in device.traverse():
-				if devpath.startswith(dev['devpath']):
-					return False
+			# test if the already found device is a parent of the current device
+			# do we need to loop through its parents ?
+			if devpath.startswith(dev['devpath']):
+				return False
 			return True
-		deviceList = list(filter(noParent,deviceList))
+		deviceList = list(filter(noParent, deviceList))
 		#
-		if vid not in VIDS and len(ttys) == 0: continue
+		if vid not in VIDS and len(ttys) == 0:
+			continue
 		#
 		curDevice = {}
 		curDevice['version'] = version
@@ -95,6 +100,7 @@ def noParent(dev):
 		curDevice['serial_num'] = SN
 		curDevice['ports'] = ttys
 		curDevice['manufacturer'] = manufacturer
+		curDevice['usb_location'] = devpath.split("/", 4)[-1]
 		deviceList.append(curDevice)
 	#
 	for i in range(len(deviceList)):

discotool/usbinfos/usbinfos_macos.py

@@ -123,6 +123,7 @@ def readSysProfile(profile, devices, allMounts, drive_info):
 						})
 		curDevice['volumes'] = deviceVolumes
 		curDevice['version'] = version
+		curDevice['usb_location'] = subGroup['location_id'].split(" ")[0]
 		devices += [curDevice]
 	return devices
 

discotool/usbinfos/usbinfos_win32.py

@@ -69,12 +69,13 @@ def get_devices_list(drive_info=False):
 		curDevice = {}
 		deviceVolumes = []
 		name = ""
-		SN = device
+		SN = device.upper()
 
 		ttys = []
 		vid = "0"
 		pid = "0"
 		manufacturer = ""
+		location = ""
 		for port in list(remainingPorts):
 			if port.serial_number == SN:
 				vid = port.vid
@@ -121,15 +122,17 @@ def get_devices_list(drive_info=False):
 			desc = descriptors[uid]
 			manufacturer = desc.manufacturer or manufacturer
 			name = desc.product or name
+			location = desc.location or location
 
-		curDevice['version'] = version
-		curDevice['volumes'] = deviceVolumes
 		curDevice['name'] = name
+		curDevice['manufacturer'] = manufacturer
 		curDevice['vendor_id'] = int(vid)
 		curDevice['product_id'] = int(pid)
 		curDevice['serial_num'] = SN
+		curDevice['volumes'] = deviceVolumes
 		curDevice['ports'] = ttys
-		curDevice['manufacturer'] = manufacturer
+		curDevice['version'] = version
+		curDevice['usb_location'] = location
 		deviceList.append(curDevice)
 
 	rp = [port.device for port in remainingPorts]

tests/locations.py

@@ -0,0 +1,26 @@
+import discotool
+
+def display(texte):
+	print(("-" * 70) + "\n-", texte.ljust(70-3) + "-\n" + ("-" * 70))
+
+# display('get_devices_list()                             ')
+# deviceList,remainingPorts = discotool.get_devices_list()
+# print(deviceList)
+# print(remainingPorts)
+
+# display('Device class/dictionnary                       ')
+for device in discotool.get_identified_devices():
+	display(device.name)
+	# print(type(device))
+# 	print("Attributes:")
+# 	print(sorted([
+# 		attr for
+# 		attr in set(dir(device)) - set(dir({"un":1}))
+# 		if attr[0:2] != "__"
+# 	]))
+	print("Dict indexes:")
+# 	for x in device:
+# 		print(f"{x:12s} : {device[x]}")
+	print("location :", device["usb_location"])
+
+display("")