Native config.d

.github/workflows/package_raspbian.yml

@@ -50,11 +50,13 @@ jobs:
           mkdir -p .debpkg/usr/share/doc/meshtasticd/web
           mkdir -p .debpkg/usr/sbin
           mkdir -p .debpkg/etc/meshtasticd
+          mkdir -p .debpkg/etc/meshtasticd/config.d
           mkdir -p .debpkg/usr/lib/systemd/system/
           tar -xf build.tar -C .debpkg/usr/share/doc/meshtasticd/web
           gunzip .debpkg/usr/share/doc/meshtasticd/web/*.gz
           cp release/meshtasticd_linux_aarch64 .debpkg/usr/sbin/meshtasticd
           cp bin/config-dist.yaml .debpkg/etc/meshtasticd/config.yaml
+          cp bin/config.d/* .debpkg/etc/meshtasticd/config.d/
           chmod +x .debpkg/usr/sbin/meshtasticd
           cp bin/meshtasticd.service .debpkg/usr/lib/systemd/system/meshtasticd.service
           echo "/etc/meshtasticd/config.yaml" > .debpkg/DEBIAN/conffiles

bin/config-dist.yaml

@@ -1,15 +1,11 @@
+### Many device configs have been moved to config.d, and named [device].yaml.inactive.
+### To activate, simply rename the file to end in .yaml
+
 ### Define your devices here using Broadcom pin numbering
 ### Uncomment the block that corresponds to your hardware
 ### Including the "Module:" line!
 ---
 Lora:
-#  Module: sx1262  # Waveshare SX126X XXXM
-#  DIO2_AS_RF_SWITCH: true
-#  CS: 21
-#  IRQ: 16
-#  Busy: 20
-#  Reset: 18
-#  SX126X_ANT_SW: 6
 
 #  Module: sx1262  # Waveshare SX1302 LISTEN ONLY AT THIS TIME!
 #  CS: 7
@@ -156,3 +152,4 @@ Webserver:
 General:
   MaxNodes: 200
   MaxMessageQueue: 100
+  ConfigDirectory: /etc/meshtasticd/config.d/

bin/config.d/display-waveshare-2.8.yaml.inactive

@@ -0,0 +1,18 @@
+Display:
+
+### Waveshare 2.8inch RPi LCD
+  Panel: ST7789
+  CS: 8
+  DC: 22        # Data/Command pin
+  Backlight: 18
+  Width: 240
+  Height: 320
+  Reset: 27
+  Rotate: true
+  Invert: true
+
+Touchscreen:
+### Note, at least for now, the touchscreen must have a CS pin defined, even if you let Linux manage the CS switching.
+  Module: XPT2046 # Waveshare 2.8inch
+  CS: 7
+  IRQ: 17

bin/config.d/lora-waveshare-sxxx.yaml.inactive

@@ -0,0 +1,8 @@
+Lora:
+  Module: sx1262  # Waveshare SX126X XXXM
+  DIO2_AS_RF_SWITCH: true
+  CS: 21
+  IRQ: 16
+  Busy: 20
+  Reset: 18
+  SX126X_ANT_SW: 6

src/platform/portduino/PortduinoGlue.cpp

@@ -11,6 +11,7 @@
 #include "PortduinoGlue.h"
 #include "linux/gpio/LinuxGPIOPin.h"
 #include "yaml-cpp/yaml.h"
+#include <filesystem>
 #include <iostream>
 #include <map>
 #include <unistd.h>
@@ -100,33 +101,20 @@ void portduinoSetup()
     settingsStrings[displayspidev] = "";
     settingsMap[spiSpeed] = 2000000;
     settingsMap[ascii_logs] = !isatty(1);
+    settingsMap[displayPanel] = no_screen;
+    settingsMap[touchscreenModule] = no_touchscreen;
 
     YAML::Node yamlConfig;
 
     if (configPath != nullptr) {
         std::cout << "Using " << configPath << " as config file" << std::endl;
-        try {
-            yamlConfig = YAML::LoadFile(configPath);
-        } catch (YAML::Exception &e) {
-            std::cout << "Could not open " << configPath << " because of error: " << e.what() << std::endl;
-            exit(EXIT_FAILURE);
-        }
+        loadConfig(configPath);
     } else if (access("config.yaml", R_OK) == 0) {
         std::cout << "Using local config.yaml as config file" << std::endl;
-        try {
-            yamlConfig = YAML::LoadFile("config.yaml");
-        } catch (YAML::Exception &e) {
-            std::cout << "*** Exception " << e.what() << std::endl;
-            exit(EXIT_FAILURE);
-        }
+        loadConfig("config.yaml");
     } else if (access("/etc/meshtasticd/config.yaml", R_OK) == 0) {
         std::cout << "Using /etc/meshtasticd/config.yaml as config file" << std::endl;
-        try {
-            yamlConfig = YAML::LoadFile("/etc/meshtasticd/config.yaml");
-        } catch (YAML::Exception &e) {
-            std::cout << "*** Exception " << e.what() << std::endl;
-            exit(EXIT_FAILURE);
-        }
+        loadConfig("/etc/meshtasticd/config.yaml");
     } else {
         std::cout << "No 'config.yaml' found, running simulated." << std::endl;
         settingsMap[maxnodes] = 200;               // Default to 200 nodes
@@ -136,10 +124,130 @@ void portduinoSetup()
         return;
     }
 
+    if (settingsStrings[config_directory] != "") {
+        std::string filetype = ".yaml";
+        for (const std::filesystem::directory_entry &entry :
+             std::filesystem::directory_iterator{settingsStrings[config_directory]}) {
+            if (ends_with(entry.path().string(), ".yaml")) {
+                std::cout << "Also using " << entry << " as additional config file" << std::endl;
+                loadConfig(entry.path().c_str());
+            }
+        }
+    }
+
     // Rather important to set this, if not running simulated.
     randomSeed(time(NULL));
 
+    gpioChipName += std::to_string(settingsMap[gpiochip]);
+
+    for (configNames i : GPIO_lines) {
+        if (settingsMap.count(i) && settingsMap[i] > max_GPIO)
+            max_GPIO = settingsMap[i];
+    }
+
+    gpioInit(max_GPIO + 1); // Done here so we can inform Portduino how many GPIOs we need.
+
+    // Need to bind all the configured GPIO pins so they're not simulated
+    // TODO: Can we do this in the for loop above?
+    // TODO: If one of these fails, we should log and terminate
+    if (settingsMap.count(cs) > 0 && settingsMap[cs] != RADIOLIB_NC) {
+        if (initGPIOPin(settingsMap[cs], gpioChipName) != ERRNO_OK) {
+            settingsMap[cs] = RADIOLIB_NC;
+        }
+    }
+    if (settingsMap.count(irq) > 0 && settingsMap[irq] != RADIOLIB_NC) {
+        if (initGPIOPin(settingsMap[irq], gpioChipName) != ERRNO_OK) {
+            settingsMap[irq] = RADIOLIB_NC;
+        }
+    }
+    if (settingsMap.count(busy) > 0 && settingsMap[busy] != RADIOLIB_NC) {
+        if (initGPIOPin(settingsMap[busy], gpioChipName) != ERRNO_OK) {
+            settingsMap[busy] = RADIOLIB_NC;
+        }
+    }
+    if (settingsMap.count(reset) > 0 && settingsMap[reset] != RADIOLIB_NC) {
+        if (initGPIOPin(settingsMap[reset], gpioChipName) != ERRNO_OK) {
+            settingsMap[reset] = RADIOLIB_NC;
+        }
+    }
+    if (settingsMap.count(sx126x_ant_sw) > 0 && settingsMap[sx126x_ant_sw] != RADIOLIB_NC) {
+        if (initGPIOPin(settingsMap[sx126x_ant_sw], gpioChipName) != ERRNO_OK) {
+            settingsMap[sx126x_ant_sw] = RADIOLIB_NC;
+        }
+    }
+    if (settingsMap.count(user) > 0 && settingsMap[user] != RADIOLIB_NC) {
+        if (initGPIOPin(settingsMap[user], gpioChipName) != ERRNO_OK) {
+            settingsMap[user] = RADIOLIB_NC;
+        }
+    }
+    if (settingsMap.count(rxen) > 0 && settingsMap[rxen] != RADIOLIB_NC) {
+        if (initGPIOPin(settingsMap[rxen], gpioChipName) != ERRNO_OK) {
+            settingsMap[rxen] = RADIOLIB_NC;
+        }
+    }
+    if (settingsMap.count(txen) > 0 && settingsMap[txen] != RADIOLIB_NC) {
+        if (initGPIOPin(settingsMap[txen], gpioChipName) != ERRNO_OK) {
+            settingsMap[txen] = RADIOLIB_NC;
+        }
+    }
+
+    if (settingsMap[displayPanel] != no_screen) {
+        if (settingsMap[displayCS] > 0)
+            initGPIOPin(settingsMap[displayCS], gpioChipName);
+        if (settingsMap[displayDC] > 0)
+            initGPIOPin(settingsMap[displayDC], gpioChipName);
+        if (settingsMap[displayBacklight] > 0)
+            initGPIOPin(settingsMap[displayBacklight], gpioChipName);
+        if (settingsMap[displayReset] > 0)
+            initGPIOPin(settingsMap[displayReset], gpioChipName);
+    }
+    if (settingsMap[touchscreenModule] != no_touchscreen) {
+        if (settingsMap[touchscreenCS] > 0)
+            initGPIOPin(settingsMap[touchscreenCS], gpioChipName);
+        if (settingsMap[touchscreenIRQ] > 0)
+            initGPIOPin(settingsMap[touchscreenIRQ], gpioChipName);
+    }
+
+    if (settingsStrings[spidev] != "") {
+        SPI.begin(settingsStrings[spidev].c_str());
+    }
+    if (settingsStrings[traceFilename] != "") {
+        try {
+            traceFile.open(settingsStrings[traceFilename], std::ios::out | std::ios::app);
+        } catch (std::ofstream::failure &e) {
+            std::cout << "*** traceFile Exception " << e.what() << std::endl;
+            exit(EXIT_FAILURE);
+        }
+    }
+
+    return;
+}
+
+int initGPIOPin(int pinNum, const std::string gpioChipName)
+{
+#ifdef PORTDUINO_LINUX_HARDWARE
+    std::string gpio_name = "GPIO" + std::to_string(pinNum);
     try {
+        GPIOPin *csPin;
+        csPin = new LinuxGPIOPin(pinNum, gpioChipName.c_str(), pinNum, gpio_name.c_str());
+        csPin->setSilent();
+        gpioBind(csPin);
+        return ERRNO_OK;
+    } catch (...) {
+        std::exception_ptr p = std::current_exception();
+        std::cout << "Warning, cannot claim pin " << gpio_name << (p ? p.__cxa_exception_type()->name() : "null") << std::endl;
+        return ERRNO_DISABLED;
+    }
+#else
+    return ERRNO_OK;
+#endif
+}
+
+bool loadConfig(const char *configPath)
+{
+    YAML::Node yamlConfig;
+    try {
+        yamlConfig = YAML::LoadFile(configPath);
         if (yamlConfig["Logging"]) {
             if (yamlConfig["Logging"]["LogLevel"].as<std::string>("info") == "trace") {
                 settingsMap[logoutputlevel] = level_trace;
@@ -185,7 +293,6 @@ void portduinoSetup()
             settingsMap[gpiochip] = yamlConfig["Lora"]["gpiochip"].as<int>(0);
             settingsMap[ch341Quirk] = yamlConfig["Lora"]["ch341_quirk"].as<bool>(false);
             settingsMap[spiSpeed] = yamlConfig["Lora"]["spiSpeed"].as<int>(2000000);
-            gpioChipName += std::to_string(settingsMap[gpiochip]);
 
             settingsStrings[spidev] = "/dev/" + yamlConfig["Lora"]["spidev"].as<std::string>("spidev0.0");
             if (settingsStrings[spidev].length() == 14) {
@@ -211,7 +318,6 @@ void portduinoSetup()
         if (yamlConfig["I2C"]) {
             settingsStrings[i2cdev] = yamlConfig["I2C"]["I2CDevice"].as<std::string>("");
         }
-        settingsMap[displayPanel] = no_screen;
         if (yamlConfig["Display"]) {
             if (yamlConfig["Display"]["Panel"].as<std::string>("") == "ST7789")
                 settingsMap[displayPanel] = st7789;
@@ -258,7 +364,6 @@ void portduinoSetup()
                 }
             }
         }
-        settingsMap[touchscreenModule] = no_touchscreen;
         if (yamlConfig["Touchscreen"]) {
             if (yamlConfig["Touchscreen"]["Module"].as<std::string>("") == "XPT2046")
                 settingsMap[touchscreenModule] = xpt2046;
@@ -293,113 +398,21 @@ void portduinoSetup()
             settingsStrings[webserverrootpath] = (yamlConfig["Webserver"]["RootPath"]).as<std::string>("");
         }
 
-        settingsMap[maxnodes] = (yamlConfig["General"]["MaxNodes"]).as<int>(200);
-        settingsMap[maxtophone] = (yamlConfig["General"]["MaxMessageQueue"]).as<int>(100);
+        if (yamlConfig["General"]) {
+            settingsMap[maxnodes] = (yamlConfig["General"]["MaxNodes"]).as<int>(200);
+            settingsMap[maxtophone] = (yamlConfig["General"]["MaxMessageQueue"]).as<int>(100);
+            settingsStrings[config_directory] = (yamlConfig["General"]["ConfigDirectory"]).as<std::string>("");
+        }
 
     } catch (YAML::Exception &e) {
         std::cout << "*** Exception " << e.what() << std::endl;
         exit(EXIT_FAILURE);
     }
-
-    for (configNames i : GPIO_lines) {
-        if (settingsMap.count(i) && settingsMap[i] > max_GPIO)
-            max_GPIO = settingsMap[i];
-    }
-
-    gpioInit(max_GPIO + 1); // Done here so we can inform Portduino how many GPIOs we need.
-
-    // Need to bind all the configured GPIO pins so they're not simulated
-    // TODO: Can we do this in the for loop above?
-    // TODO: If one of these fails, we should log and terminate
-    if (settingsMap.count(cs) > 0 && settingsMap[cs] != RADIOLIB_NC) {
-        if (initGPIOPin(settingsMap[cs], gpioChipName) != ERRNO_OK) {
-            settingsMap[cs] = RADIOLIB_NC;
-        }
-    }
-    if (settingsMap.count(irq) > 0 && settingsMap[irq] != RADIOLIB_NC) {
-        if (initGPIOPin(settingsMap[irq], gpioChipName) != ERRNO_OK) {
-            settingsMap[irq] = RADIOLIB_NC;
-        }
-    }
-    if (settingsMap.count(busy) > 0 && settingsMap[busy] != RADIOLIB_NC) {
-        if (initGPIOPin(settingsMap[busy], gpioChipName) != ERRNO_OK) {
-            settingsMap[busy] = RADIOLIB_NC;
-        }
-    }
-    if (settingsMap.count(reset) > 0 && settingsMap[reset] != RADIOLIB_NC) {
-        if (initGPIOPin(settingsMap[reset], gpioChipName) != ERRNO_OK) {
-            settingsMap[reset] = RADIOLIB_NC;
-        }
-    }
-    if (settingsMap.count(sx126x_ant_sw) > 0 && settingsMap[sx126x_ant_sw] != RADIOLIB_NC) {
-        if (initGPIOPin(settingsMap[sx126x_ant_sw], gpioChipName) != ERRNO_OK) {
-            settingsMap[sx126x_ant_sw] = RADIOLIB_NC;
-        }
-    }
-    if (settingsMap.count(user) > 0 && settingsMap[user] != RADIOLIB_NC) {
-        if (initGPIOPin(settingsMap[user], gpioChipName) != ERRNO_OK) {
-            settingsMap[user] = RADIOLIB_NC;
-        }
-    }
-    if (settingsMap.count(rxen) > 0 && settingsMap[rxen] != RADIOLIB_NC) {
-        if (initGPIOPin(settingsMap[rxen], gpioChipName) != ERRNO_OK) {
-            settingsMap[rxen] = RADIOLIB_NC;
-        }
-    }
-    if (settingsMap.count(txen) > 0 && settingsMap[txen] != RADIOLIB_NC) {
-        if (initGPIOPin(settingsMap[txen], gpioChipName) != ERRNO_OK) {
-            settingsMap[txen] = RADIOLIB_NC;
-        }
-    }
-
-    if (settingsMap[displayPanel] != no_screen) {
-        if (settingsMap[displayCS] > 0)
-            initGPIOPin(settingsMap[displayCS], gpioChipName);
-        if (settingsMap[displayDC] > 0)
-            initGPIOPin(settingsMap[displayDC], gpioChipName);
-        if (settingsMap[displayBacklight] > 0)
-            initGPIOPin(settingsMap[displayBacklight], gpioChipName);
-        if (settingsMap[displayReset] > 0)
-            initGPIOPin(settingsMap[displayReset], gpioChipName);
-    }
-    if (settingsMap[touchscreenModule] != no_touchscreen) {
-        if (settingsMap[touchscreenCS] > 0)
-            initGPIOPin(settingsMap[touchscreenCS], gpioChipName);
-        if (settingsMap[touchscreenIRQ] > 0)
-            initGPIOPin(settingsMap[touchscreenIRQ], gpioChipName);
-    }
-
-    if (settingsStrings[spidev] != "") {
-        SPI.begin(settingsStrings[spidev].c_str());
-    }
-    if (settingsStrings[traceFilename] != "") {
-        try {
-            traceFile.open(settingsStrings[traceFilename], std::ios::out | std::ios::app);
-        } catch (std::ofstream::failure &e) {
-            std::cout << "*** traceFile Exception " << e.what() << std::endl;
-            exit(EXIT_FAILURE);
-        }
-    }
-
-    return;
+    return true;
 }
 
-int initGPIOPin(int pinNum, const std::string gpioChipName)
+// https://stackoverflow.com/questions/874134/find-out-if-string-ends-with-another-string-in-c
+static bool ends_with(std::string_view str, std::string_view suffix)
 {
-#ifdef PORTDUINO_LINUX_HARDWARE
-    std::string gpio_name = "GPIO" + std::to_string(pinNum);
-    try {
-        GPIOPin *csPin;
-        csPin = new LinuxGPIOPin(pinNum, gpioChipName.c_str(), pinNum, gpio_name.c_str());
-        csPin->setSilent();
-        gpioBind(csPin);
-        return ERRNO_OK;
-    } catch (...) {
-        std::exception_ptr p = std::current_exception();
-        std::cout << "Warning, cannot claim pin " << gpio_name << (p ? p.__cxa_exception_type()->name() : "null") << std::endl;
-        return ERRNO_DISABLED;
-    }
-#else
-    return ERRNO_OK;
-#endif
+    return str.size() >= suffix.size() && str.compare(str.size() - suffix.size(), suffix.size(), suffix) == 0;
 }