Add endpoints for setting hotspot SSID and Password

Author: maggie44

Dockerfile.template

@@ -26,7 +26,7 @@ ENV FLASK_ENV=production
 ENV PATH=/root/.local/bin:$PATH
 
 # Set working directory 
-WORKDIR /usr/src/app
+WORKDIR /app
 
 # Install dependencies
 RUN apk add --no-cache \

README.md

@@ -189,6 +189,46 @@ Check whether the API is available. Accessing this path will not log anything in
 }
 ```
 
+### http://your-device:9090/v1/set_hotspot_password
+
+Allows setting the hotspot password. Using this endpoint will store the passed string in a file and will override the environment variable password. Ensure the `./db` folder is mounted as a volume for this change to be persistent.
+
+#### POST
+
+```
+{
+    "password": "new-password" // Minimum of 8 characters
+}
+```
+
+#### Response status 200
+
+```
+{
+    "message": "ok"
+}
+```
+
+### http://your-device:9090/v1/set_hotspot_ssid
+
+Allows setting the hotspot SSID. Using this endpoint will store the passed string in a file and will override any environment variable ssid. Ensure the `./db` folder is mounted as a volume for this change to be persistent.
+
+#### POST
+
+```
+{
+    "ssid": "new SSID"
+}
+```
+
+#### Response status 200
+
+```
+{
+    "message": "ok"
+}
+```
+
 ### http://your-device:9090/v1/set_interface
 
 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.

docker-compose.yml

@@ -29,8 +29,13 @@ services:
       dockerfile: Dockerfile.template
     network_mode: "host"
     restart: always
+    volumes:
+      - "py_wifi_connect_db:/app/db" # Optional if not setting the hotspot ssid and password via the API
     labels:
       io.balena.features.dbus: "1"
     cap_add:
       - NET_ADMIN
     privileged: true # This can be removed if you do not need the LED indicator.
+
+volumes:
+  py_wifi_connect_db:

src/config.py

@@ -1,13 +1,25 @@
 import os
+from dotenv import dotenv_values
+
+# Check db directory exists
+if not os.path.exists("db"):
+    os.makedirs("db")
+
+# Import database file
+env_file = dotenv_values("db/.db")
 
 # Set default Wi-Fi SSID.
-if "PWC_HOTSPOT_SSID" in os.environ:
+if "PWC_HOTSPOT_SSID" in env_file:
+    hotspot_ssid = env_file["PWC_HOTSPOT_SSID"]
+elif "PWC_HOTSPOT_SSID" in os.environ:
     hotspot_ssid = os.environ["PWC_HOTSPOT_SSID"]
 else:
     hotspot_ssid = "Py Wi-Fi Connect"
 
 # Set default hotspot password.
-if "PWC_HOTSPOT_PASSWORD" in os.environ:
+if "PWC_HOTSPOT_PASSWORD" in env_file:
+    hotspot_password = env_file["PWC_HOTSPOT_PASSWORD"]
+elif "PWC_HOTSPOT_PASSWORD" in os.environ:
     hotspot_password = os.environ["PWC_HOTSPOT_PASSWORD"]
 else:
     hotspot_password = None

src/requirements.in

@@ -1,3 +1,4 @@
+python-dotenv
 Flask-Cors
 Flask-RESTful
 python-networkmanager==2.1

src/requirements.txt

@@ -24,6 +24,8 @@ jinja2==3.0.3
     # via flask
 markupsafe==2.1.0
     # via jinja2
+python-dotenv==0.19.2
+    # via -r requirements.in
 python-networkmanager==2.1
     # via -r requirements.in
 pytz==2021.3

src/resources/wifi_routes.py

@@ -1,11 +1,13 @@
 import config
+import dotenv
 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
 from common.wifi import forget
 from common.wifi import list_access_points
+from dotenv import dotenv_values
 from flask import request
 from flask_restful import Resource
 
@@ -78,6 +80,39 @@ def get(self):
         return {"ssids": ssids, "iw_compatible": iw_status}
 
 
+class wifi_set_hotspot_password(Resource):
+    def post(self):
+        content = request.get_json()
+
+        if ("password" not in content) or (len(content["password"]) < 8):
+            return {
+                "message": "Passwords must be 8 characters or longer."
+            }, 400
+
+        if not dotenv_values("db/.db"):
+            with open("db/.db", "w") as db:
+                db.write("PWC_HOTSPOT_PASSWORD=" + content["password"])
+        else:
+            dotenv.set_key(
+                "db/.db", "PWC_HOTSPOT_PASSWORD", content["password"]
+            )
+
+        return {"message": "ok"}, 200
+
+
+class wifi_set_hotspot_ssid(Resource):
+    def post(self):
+        content = request.get_json()
+
+        if not dotenv_values("db/.db"):
+            with open("db/.db", "w") as db:
+                db.write("PWC_HOTSPOT_SSID=" + content["ssid"])
+        else:
+            dotenv.set_key("db/.db", "PWC_HOTSPOT_SSID", content["ssid"])
+
+        return {"message": "ok"}, 200
+
+
 class wifi_set_interface(Resource):
     def post(self):
         # Check entry exists

src/run.py

@@ -19,6 +19,8 @@
 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 resources.wifi_routes import wifi_set_hotspot_password
+from resources.wifi_routes import wifi_set_hotspot_ssid
 from resources.wifi_routes import wifi_set_interface
 from waitress import serve
 
@@ -32,6 +34,34 @@
 # Load Flask-Restful API
 api = Api(app, errors=errors)
 
+# Begin loading program
+logger.info("Checking for previously configured Wi-Fi connections...")
+
+# Start dnsmasq service for assigning IPs to connected devices
+dnsmasq()
+
+# Allow time for an exsiting saved Wi-Fi connection to connect.
+time.sleep(10)
+
+# Log interface status
+if config.interface.lower() != config.auto_interface:
+    logger.info(f"Interface set to {config.interface}")
+
+# If the Wi-Fi connection or device is already active, do nothing
+if check_wifi_status() or check_device_state():
+    led(1)
+    logger.info("A Wi-Fi connection or hotspot is already active.")
+    logger.info("Ready...")
+# If the Wi-Fi connection and device are not active, start a hotspot
+else:
+    led(0)
+    refresh_networks(retries=1)
+    if config.auto_connect_kargs:
+        logger.info("Attempting auto-connect...")
+        auto_connect(**config.auto_connect_kargs)
+    else:
+        connect()
+
 # Health check routes
 api.add_resource(system_health_check, "/healthcheck")
 
@@ -40,36 +70,9 @@
 api.add_resource(wifi_connection_status, "/v1/connection_status")
 api.add_resource(wifi_forget, "/v1/forget")
 api.add_resource(wifi_list_access_points, "/v1/list_access_points")
+api.add_resource(wifi_set_hotspot_password, "/v1/set_hotspot_password")
+api.add_resource(wifi_set_hotspot_ssid, "/v1/set_hotspot_ssid")
 api.add_resource(wifi_set_interface, "/v1/set_interface")
 
-if __name__ == "__main__":
-    # Begin loading program
-    logger.info("Checking for previously configured Wi-Fi connections...")
-
-    # Start dnsmasq service for assigning IPs to connected devices
-    dnsmasq()
-
-    # Allow time for an exsiting saved Wi-Fi connection to connect.
-    time.sleep(10)
-
-    # Log interface status
-    if config.interface.lower() != config.auto_interface:
-        logger.info(f"Interface set to {config.interface}")
-
-    # If the Wi-Fi connection or device is already active, do nothing
-    if check_wifi_status() or check_device_state():
-        led(1)
-        logger.info("A Wi-Fi connection or hotspot is already active.")
-        logger.info("Ready...")
-    # If the Wi-Fi connection and device are not active, start a hotspot
-    else:
-        led(0)
-        refresh_networks(retries=1)
-        if config.auto_connect_kargs:
-            logger.info("Attempting auto-connect...")
-            auto_connect(**config.auto_connect_kargs)
-        else:
-            connect()
-
-    logger.info(f"Listening on {host} port {port}")
-    serve(app, host=host, port=port)
+logger.info(f"Listening on {host} port {port}")
+serve(app, host=host, port=port)