Add LED indicator

Author: maggie44

README.md

@@ -32,6 +32,11 @@ Users will then be unable to access the API `http://your-device:9090/v1/connect`
 
 Alternatively, if you would rather have your backend use specified ports instead of the host network, you can change the `PWC_HOST` environment variable to `172.17.0.1` and access the API from `http://172.17.0.1:9090/v1/connect`.
 
+## LED Indicator
+Some devices - such as the Raspberry Pi series - have an LED that can be controlled. When your device is connected to Wi-Fi, Python Wi-Fi Connect turns the LED on. When disconnected or in Hotspot mode, it turns the LED off.
+
+If you need to disable this feature to allow the LED to be used for other purposes, change the environment variable in the docker-compose.yml file to: `PWC_LED: "OFF"`.
+
 
 ## Endpoints
 ### http://your-device:9090/v1/connect

docker-compose.yml

@@ -14,7 +14,10 @@ services:
       ## Try to automatically set up a Wi-Fi network on first boot ##
       #PWC_SSID: "network-name" # Compulsory for this feature
       #USERNAME: "username" # Optional
-      #PWC_PASSWORD: "your-password" # Optional. Must be 8 characters or more. 
+      #PWC_PASSWORD: "your-password" # Optional. Must be 8 characters or more.
+
+      ## Enable/Disable LED interaction ##
+      PWC_LED: "ON"
 
       ## Required System Variables ##
       DBUS_SYSTEM_BUS_ADDRESS: "unix:path=/host/run/dbus/system_bus_socket"
@@ -27,3 +30,4 @@ services:
       io.balena.features.dbus: '1'
     cap_add:
       - NET_ADMIN
+    privileged: true # This can be removed if you do not need the LED indicator (see the docs for more info).

src/common/errors.py

@@ -2,8 +2,8 @@
 import logging
 
 # Create custom logger
-logger = logging.getLogger('syslog')
 syslog = logging.StreamHandler()
+logger = logging.getLogger('syslog')
 logger.addHandler(syslog)
 
 # When in development mode provide details in log of each line of code
@@ -19,6 +19,7 @@
     logger.setLevel(logging.INFO)
 
 syslog.setFormatter(formatter)
+logger.propagate = False
 
 
 # Error classes for Flask-Restful

src/common/system.py

@@ -1,4 +1,5 @@
 import config
+import os
 import subprocess
 from common.errors import logger
 
@@ -20,3 +21,16 @@ def dnsmasq():
         subprocess.Popen(args)
     except Exception:
         logger.exception('Failed to start dnsmasq.')
+
+
+def led(mode):
+    # Activate LED on compatible devices
+    # 1 = on
+    # 0 = off
+    if "PWC_LED" in os.environ and os.environ['PWC_LED'].lower() == 'on':
+        try:
+            with open('/sys/class/leds/led0/brightness', 'w+') as f:
+                f.write(str(mode))
+        except Exception:
+            # This is not possible on some devices.
+            pass

src/common/wifi.py

@@ -9,6 +9,7 @@
 from common.errors import WifiNetworkManagerError
 from common.errors import WifiNoSuitableDevice
 from common.nm_dicts import get_nm_dict
+from common.system import led
 
 
 # Import DBus mainloop for NetworkManager use
@@ -108,7 +109,7 @@ def connect(conn_type=config.type_hotspot,
 
     try:
         NetworkManager.Settings.AddConnection(conn_dict)
-        logger.debug(f"Added connection of type {conn_type}")
+        logger.info(f"Adding connection of type {conn_type}")
 
         # Find this connection and its device
         connections = \
@@ -129,8 +130,11 @@ def connect(conn_type=config.type_hotspot,
         # Connect
         NetworkManager.NetworkManager.ActivateConnection(conn, dev, "/")
 
+        # If not a hotspot, log the connection SSID being attempted
+        if conn_type != config.type_hotspot:
+            logger.info(f"Attempting connection to {ssid}")
+
         # Wait for ADDRCONF(NETDEV_CHANGE): wlan0: link becomes ready
-        logger.info("Waiting for connection to become active...")
         loop_count = 0
         while dev.State != NetworkManager.NM_DEVICE_STATE_ACTIVATED:
             time.sleep(1)
@@ -139,7 +143,14 @@ def connect(conn_type=config.type_hotspot,
                 break
 
         if dev.State == NetworkManager.NM_DEVICE_STATE_ACTIVATED:
-            logger.info("Active.")
+            logger.info("Connection active.")
+
+            # Activate the LED to indicate device is connected.
+            if conn_type is not config.type_hotspot:
+                led(1)
+            else:
+                led(0)
+
             return True
         # If the current attempt is not already a hotspot attempt
         elif conn_type != config.type_hotspot:
@@ -179,6 +190,10 @@ def forget(create_new_hotspot=False, all_networks=False):
                 connection_ids[config.ap_name].Delete()
                 logger.debug(f"Deleted connection: {config.ap_name}")
 
+        # Disable LED indicating Wi-Fi is not active.
+        led(0)
+
+        # If requested, create new Hotspot
         if create_new_hotspot:
             refresh_networks()
             connect()
@@ -196,6 +211,8 @@ def list_access_points():
     # button will be disabled.
     iw_status = refresh_networks(retries=1)
 
+    logger.debug('Fetching Wi-Fi networks.')
+
     try:
         # Fetch dictionary of devices
         devices = dict([(x.DeviceType, x)
@@ -228,6 +245,8 @@ def list_access_points():
             ssids.append(item)
         tmp.append(item['ssid'])
 
+    logger.debug('Finished fetching Wi-Fi networks.')
+
     # Return a list of available SSIDs and their security type,
     # or [] for none available.
     return ssids, iw_status

src/resources/wifi_routes.py

@@ -1,4 +1,5 @@
 import threading
+from common.errors import logger
 from common.wifi import check_internet_status
 from common.wifi import check_wifi_status
 from common.wifi import connect
@@ -64,6 +65,7 @@ def post(self):
                                                       request.get_json()
                                                       ['all_networks']})
 
+        logger.info('Removing connetion...')
         wifi_forget_thread.start()
 
         return {'message': 'accepted'}, 202

src/run.py

@@ -3,19 +3,20 @@
 from common.errors import errors
 from common.errors import logger
 from common.system import dnsmasq
+from common.system import led
 from common.wifi import auto_connect
 from common.wifi import check_wifi_status
 from common.wifi import connect
 from common.wifi import refresh_networks
 from config import host
 from config import port
+from flask import Flask
+from flask_restful import Api
 from resources.system_routes import system_health_check
 from resources.wifi_routes import wifi_connect
 from resources.wifi_routes import wifi_connection_status
 from resources.wifi_routes import wifi_forget
 from resources.wifi_routes import wifi_list_access_points
-from flask import Flask
-from flask_restful import Api
 from waitress import serve
 
 
@@ -46,15 +47,16 @@
 
     # If the Wi-Fi connection is not already active, start a hotspot
     if check_wifi_status():
+        led(1)
         logger.info('Wi-Fi connection already established.')
         logger.info('Ready...')
     else:
+        led(0)
         refresh_networks(retries=1)
         if config.auto_connect_kargs:
             logger.info('Attempting auto-connect...')
             auto_connect(**config.auto_connect_kargs)
         else:
-            logger.info('Starting hotspot...')
             connect()
 
     serve(app, host=host, port=port)