Support variable interface names

maggie44 · maggie44 · commit a41817982ac0 · 2022-07-20T00:41:32.000+02:00
diff --git a/README.md b/README.md
@@ -45,19 +45,15 @@ Alternatively, if you would rather have your backend use specified ports instead
 
 ## Changing the default network interface
 
-By default, the first available Wi-Fi network interface available will be used. For the vast majority of cases there is only one Wi-Fi network interface (`wlan0`) and therefore this is no issue. Similarly, if you plug in a Wi-Fi dongle to a device without its own built-in Wi-Fi, the Wi-Fi dongle will be used by default.
+By default, the first available Wi-Fi network interface available will be used. For the vast majority of cases there is only one Wi-Fi network interface and therefore this is no issue. Similarly, if you plug in a Wi-Fi dongle to a device without its own built-in Wi-Fi, the Wi-Fi dongle will be used by default.
 
-If however, you have a device with built in Wi-Fi and a Wi-Fi dongle, you will have a device with two network interfaces (usually `wlan0` and `wlan1`). For these instances, or on other occasions where you have a complex network interface setup, you can specify which network interface you would like Py Wi-Fi Connect to use by setting the environment variable shown in the `docker-compose.yml` file:
+If however, you have a device with built in Wi-Fi and a Wi-Fi dongle, you will have a device with two network interfaces. For these instances, or on other occasions where you have a complex network interface setup, you can specify which network interface you would like Py Wi-Fi Connect to use by setting the environment variable shown in the `docker-compose.yml` file:
 
 ```
 PWC_INTERFACE: "wlan0"
 ```
 
-To allow for automatic detection, set the variable to `auto` or remove the variable from your `docker-compose.yml` file:
-
-```
-PWC_INTERFACE: "auto"
-```
+To allow for automatic detection, remove the variable from your `docker-compose.yml` file.
 
 This setting can also be controlled using the `/set_interface` endpoint.
 
@@ -233,9 +229,7 @@ Allows setting the hotspot SSID. Using this endpoint will store the passed strin
 
 By default the Wi-Fi network interface is auto-detected. If you need to specify a network interface, you can do so using this endpoint.
 
-To set back to auto-detection, pass `auto` as the value.
-
-Changing the setting will only last until the next restart of the container, when it will resort back to the default setting set by the environment variable in the container or `auto` if there is no environment variable in the container.
+Changing the setting will only last until the next restart of the container, when it will resort back to the setting set by the environment variable in the container or detect the interface autocratically if there is no environment variable in the container.
 
 #### POST
 
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -17,7 +17,7 @@ services:
       #PWC_AC_PASSWORD: "your-password" # Optional. Must be 8 characters or more.
 
       ## Wi-Fi Interface ##
-      #PWC_INTERFACE: "auto"
+      #PWC_INTERFACE: "wlan0" # By default it automatically detects the interface.
 
       ## Enable/Disable LED interaction ##
       #PWC_LED: "on"
diff --git a/src/common/nm_dicts.py b/src/common/nm_dicts.py
@@ -16,7 +16,7 @@ def get_nm_dict(conn_type, ssid, username, password):
             "connection": {
                 "autoconnect": False,
                 "id": config.ap_name,
-                "interface-name": "wlan0",
+                "interface-name": config.interface,
                 "type": "802-11-wireless",
                 "uuid": str(uuid.uuid4()),
             },
diff --git a/src/common/system.py b/src/common/system.py
@@ -11,7 +11,7 @@ def dnsmasq():
         f"--address=/#/{config.DEFAULT_GATEWAY}",
         f"--dhcp-range={config.DEFAULT_DHCP_RANGE}",
         f"--dhcp-option=option:router,{config.DEFAULT_GATEWAY}",
-        f"--interface={config.DEFAULT_INTERFACE}",
+        f"--interface={config.interface}",
         "--keep-in-foreground",
         "--bind-dynamic",
         "--except-interface=lo",
diff --git a/src/common/wifi.py b/src/common/wifi.py
@@ -1,5 +1,6 @@
 import config
 import NetworkManager as Pnm  # Python NetworkManager
+import os
 import socket
 import subprocess
 import time
@@ -94,7 +95,9 @@ def check_internet_status(host="8.8.8.8", port=53, timeout=5):
 def check_wifi_status():
     try:
         run = subprocess.run(
-            ["iw", "dev", "wlan0", "link"], capture_output=True, text=True
+            ["iw", "dev", config.interface, "link"],
+            capture_output=True,
+            text=True,
         ).stdout.rstrip()
     except Exception:
         logger.exception(
@@ -131,7 +134,7 @@ def connect(
         if conn_type != config.type_hotspot:
             logger.info(f"Attempting connection to {ssid}")
 
-        # Wait for ADDRCONF(NETDEV_CHANGE): wlan0: link becomes ready
+        # Wait for ADDRCONF(NETDEV_CHANGE): link becomes ready
         loop_count = 0
         while not check_device_state():
             time.sleep(1)
@@ -224,16 +227,16 @@ def get_connection_id():
 
 def get_device():
     # Configured interface variable takes precedent.
-    if config.interface.lower() != config.auto_interface:
-        logger.debug(f"Interface {config.interface} selected.")
+    if "PWC_INTERFACE" in os.environ:
+        logger.debug(f"Interface {os.environ['PWC_INTERFACE']} selected.")
         for device in Pnm.NetworkManager.GetDevices():
             if device.DeviceType != Pnm.NM_DEVICE_TYPE_WIFI:
                 continue
             # For each Wi-Fi network interface, check the interface name
             # against the one configured in config.interface
             if (
                 device.Udi[device.Udi.rfind("/") + 1 :].lower()
-                == config.interface.lower()
+                == os.environ["PWC_INTERFACE"]
             ):
                 return device
 
@@ -302,7 +305,7 @@ def refresh_networks(retries=5):
     while run < max_runs:
         try:
             time.sleep(3)
-            subprocess.check_output(["iw", "dev", "wlan0", "scan"])
+            subprocess.check_output(["iw", "dev", config.interface, "scan"])
         except subprocess.CalledProcessError:
             logger.warning("IW resource busy. Retrying...")
             continue
@@ -316,7 +319,7 @@ def refresh_networks(retries=5):
             run += 1
 
     logger.warning(
-        "IW is not accessible. This can happen on some devices "
+        "IW is unable to complete the request. This can happen on some devices "
         "and is usually nothing to worry about."
     )
     return False
diff --git a/src/config.py b/src/config.py
@@ -1,6 +1,15 @@
 import os
 from dotenv import dotenv_values
 
+# Set dev env variables
+if (
+    "FLASK_ENV" in os.environ
+    and os.environ["FLASK_ENV"].lower() == "production"
+):
+    dev_mode = False
+else:
+    dev_mode = True
+
 # Check db directory exists
 if not os.path.exists("db"):
     os.makedirs("db")
@@ -49,24 +58,13 @@
 else:
     auto_connect_kargs = False
 
-# Set default interface
-auto_interface = "auto"
-if (
-    "PWC_INTERFACE" in os.environ
-    and os.environ["PWC_INTERFACE"].lower() != auto_interface
-):
-    interface = os.environ["PWC_INTERFACE"]
-else:
-    interface = auto_interface
-
 # Default access point name. No need to change these under usual operation as
 # they are for use inside the app only. PWC is acronym for 'Py Wi-Fi Connect'.
 ap_name = "PWC"
 
 # dnsmasq variables
 DEFAULT_GATEWAY = "192.168.42.1"
 DEFAULT_DHCP_RANGE = "192.168.42.2,192.168.42.254"
-DEFAULT_INTERFACE = "wlan0"  # use 'ip link show' to see list of interfaces
 
 # Wi-Fi modes. No need to rename these, they are used only as labels.
 type_hotspot = "HOTSPOT"
@@ -75,12 +73,3 @@
 type_wpa = "WPA"
 type_wpa2 = "WPA2"
 type_enterprise = "ENTERPRISE"
-
-# Set dev env variables
-if (
-    "FLASK_ENV" in os.environ
-    and os.environ["FLASK_ENV"].lower() == "production"
-):
-    dev_mode = False
-else:
-    dev_mode = True
diff --git a/src/run.py b/src/run.py
@@ -1,4 +1,5 @@
 import config
+import os
 import time
 from common.errors import errors
 from common.errors import logger
@@ -8,6 +9,7 @@
 from common.wifi import check_device_state
 from common.wifi import check_wifi_status
 from common.wifi import connect
+from common.wifi import get_device
 from common.wifi import refresh_networks
 from config import host
 from config import port
@@ -24,6 +26,9 @@
 from resources.wifi_routes import wifi_set_interface
 from waitress import serve
 
+# Set default interface
+device = get_device()
+config.interface = device.Udi[device.Udi.rfind("/") + 1 :].lower()
 
 # Create Flask app instance
 app = Flask(__name__)
@@ -44,8 +49,8 @@
 time.sleep(10)
 
 # Log interface status
-if config.interface.lower() != config.auto_interface:
-    logger.info(f"Interface set to {config.interface}")
+if "PWC_INTERFACE" in os.environ:
+    logger.info(f"Interface set to {os.environ['PWC_INTERFACE']}")
 
 # If the Wi-Fi connection or device is already active, do nothing
 if check_wifi_status() or check_device_state():
