Initial commit

Signed-off-by: Nicolai Buchwitz <nb@tipi-net.de>

Author: nbuchwitz

README.md

@@ -0,0 +1,46 @@
+# Python wrapper for uhubctl
+
+This is a simple Python wrapper for [uhubctl](https://github.com/mvp/uhubctl)
+
+# Examples
+
+## Discover all usable USB hubs
+
+'''python
+import uhubctl
+
+hubs = uhubctl.discover_hubs()
+
+for hub in hubs:
+    print(f"Found hub: {hub}")
+
+    for port in hub.ports:
+        print(f"   Found port: {port}")
+'''
+
+## Manually specify hub and port
+
+'''python
+from uhubctl import Hub, Port
+
+hub = Hub("1-1")
+hub.add_port(1)
+'''
+
+## Control ports
+
+'''python
+from uhubctl import Hub, Port
+
+hub = Hub("1-1")
+port = hub.add_port(1)
+
+print("Switch port 1-1.1 off")
+port.status = False
+
+print("Switch port 1-1.1 on")
+port.status = True
+
+print("Get port 1-1.1 status")
+print(port.status)
+'''

uhubctl/__init__.py

@@ -0,0 +1,90 @@
+import os
+import re
+
+
+def discover_hubs(uhubctl_binary: str = "uhubctl"):
+    cmd = f"{uhubctl_binary}"
+    stream = os.popen(cmd)
+
+    hubs = []
+
+    pattern_hub = re.compile("Current status for hub ([\.\d-]+)")
+    pattern_port = re.compile("  Port (\d+): \d{4} (power|off)")
+
+    for line in stream.readlines():
+        reg_hub = pattern_hub.match(line)
+        reg_port = pattern_port.match(line)
+
+        if reg_hub:
+            hub = Hub(reg_hub.group(1), uhubctl_binary)
+            hubs.append(hub)
+        elif reg_port:
+            # assume that the port is the last detected one
+            hub = hubs[-1]
+
+            if not hub:
+                continue
+
+            port = Port(hub, reg_port.group(1))
+            hub.ports.append(port)
+
+    return hubs
+
+
+class Hub:
+    def __init__(self, path: str, uhubctl_binary: str = "uhubctl") -> None:
+        self.path = path
+        self.ports = []
+        self.uhubctl = uhubctl_binary
+
+    def add_port(self, port_number: int) -> 'Port':
+        port = Port(self, port_number)
+        self.ports.append(port)
+
+        return port
+
+    def add_ports(self, port_start: int, port_end: int):
+        for port_number in range(port_start, port_end):
+            self.add_port(port_number)
+
+    def __str__(self) -> str:
+        return f"USB Hub {self.path}"
+
+
+class Port:
+    def __init__(self, hub: Hub, port_number: int):
+        self.hub = hub
+        self.port_number = port_number
+
+    @property
+    def status(self) -> bool:
+        status = None
+        pattern = re.compile(f"  Port {self.port_number}: \d{{4}} (power|off)")
+
+        cmd = f"{self.hub.uhubctl} -l {self.hub.path} -p {self.port_number}"
+        stream = os.popen(cmd)
+
+        for line in stream.readlines():
+            reg = pattern.match(line)
+
+            if reg:
+                status = (reg.group(1) == "power")
+
+        if status is None:
+            raise Exception()
+
+        return status
+
+    @status.setter
+    def status(self, status: bool) -> None:
+        cmd = f"{self.hub.uhubctl} -l {self.hub.path} -p {self.port_number} -a "
+        if status:
+            cmd += "on"
+        else:
+            cmd += "off"
+
+        stream = os.popen(cmd)
+        stream.readlines()
+
+    def __str__(self) -> str:
+        return f"USB Port {self.hub.path}.{self.port_number}"