Adds fixed GPS, BUTTON_PIN and BLE code to userPrefs.h (#5341)

* userPrefs.h

Added FixedGPS
Added Fixed Bluetooth PIN

* Update NodeDB.cpp

Removed some un-used LOG_INFO

* Added BUTTON_PIN

* Trunk

* Variable re-naming.

---------

Co-authored-by: Ben Meadors <benmmeadors@gmail.com>

src/ButtonThread.cpp

@@ -1,4 +1,5 @@
 #include "ButtonThread.h"
+#include "../userPrefs.h"
 #include "configuration.h"
 #if !MESHTASTIC_EXCLUDE_GPS
 #include "GPS.h"
@@ -26,12 +27,12 @@ using namespace concurrency;
 ButtonThread *buttonThread; // Declared extern in header
 volatile ButtonThread::ButtonEventType ButtonThread::btnEvent = ButtonThread::BUTTON_EVENT_NONE;
 
-#if defined(BUTTON_PIN) || defined(ARCH_PORTDUINO)
+#if defined(BUTTON_PIN) || defined(ARCH_PORTDUINO) || defined(USERPREFS_BUTTON_PIN)
 OneButton ButtonThread::userButton; // Get reference to static member
 #endif
 ButtonThread::ButtonThread() : OSThread("Button")
 {
-#if defined(BUTTON_PIN) || defined(ARCH_PORTDUINO)
+#if defined(BUTTON_PIN) || defined(ARCH_PORTDUINO) || defined(USERPREFS_BUTTON_PIN)
 
 #if defined(ARCH_PORTDUINO)
     if (settingsMap.count(user) != 0 && settingsMap[user] != RADIOLIB_NC) {
@@ -39,7 +40,12 @@ ButtonThread::ButtonThread() : OSThread("Button")
         LOG_DEBUG("Use GPIO%02d for button", settingsMap[user]);
     }
 #elif defined(BUTTON_PIN)
-    int pin = config.device.button_gpio ? config.device.button_gpio : BUTTON_PIN; // Resolved button pin
+#if !defined(USERPREFS_BUTTON_PIN)
+    int pin = config.device.button_gpio ? config.device.button_gpio : BUTTON_PIN;           // Resolved button pin
+#endif
+#ifdef USERPREFS_BUTTON_PIN
+    int pin = config.device.button_gpio ? config.device.button_gpio : USERPREFS_BUTTON_PIN; // Resolved button pin
+#endif
 #if defined(HELTEC_CAPSULE_SENSOR_V3)
     this->userButton = OneButton(pin, false, false);
 #elif defined(BUTTON_ACTIVE_LOW)
@@ -59,7 +65,7 @@ ButtonThread::ButtonThread() : OSThread("Button")
 #endif
 #endif
 
-#if defined(BUTTON_PIN) || defined(ARCH_PORTDUINO)
+#if defined(BUTTON_PIN) || defined(ARCH_PORTDUINO) || defined(USERPREFS_BUTTON_PIN)
     userButton.attachClick(userButtonPressed);
     userButton.setClickMs(BUTTON_CLICK_MS);
     userButton.setPressMs(BUTTON_LONGPRESS_MS);
@@ -102,7 +108,7 @@ int32_t ButtonThread::runOnce()
     // If the button is pressed we suppress CPU sleep until release
     canSleep = true; // Assume we should not keep the board awake
 
-#if defined(BUTTON_PIN)
+#if defined(BUTTON_PIN) || defined(USERPREFS_BUTTON_PIN)
     userButton.tick();
     canSleep &= userButton.isIdle();
 #elif defined(ARCH_PORTDUINO)
@@ -130,7 +136,12 @@ int32_t ButtonThread::runOnce()
                 return 50;
             }
 #ifdef BUTTON_PIN
+#if !defined(USERPREFS_BUTTON_PIN)
             if (((config.device.button_gpio ? config.device.button_gpio : BUTTON_PIN) !=
+#endif
+#if defined(USERPREFS_BUTTON_PIN)
+            if (((config.device.button_gpio ? config.device.button_gpio : USERPREFS_BUTTON_PIN) !=
+#endif
                  moduleConfig.canned_message.inputbroker_pin_press) ||
                 !(moduleConfig.canned_message.updown1_enabled || moduleConfig.canned_message.rotary1_enabled) ||
                 !moduleConfig.canned_message.enabled) {
@@ -244,7 +255,12 @@ void ButtonThread::attachButtonInterrupts()
 #elif defined(BUTTON_PIN)
     // Interrupt for user button, during normal use. Improves responsiveness.
     attachInterrupt(
+#if !defined(USERPREFS_BUTTON_PIN)
         config.device.button_gpio ? config.device.button_gpio : BUTTON_PIN,
+#endif
+#if defined(USERPREFS_BUTTON_PIN)
+        config.device.button_gpio ? config.device.button_gpio : USERPREFS_BUTTON_PIN,
+#endif
         []() {
             ButtonThread::userButton.tick();
             runASAP = true;
@@ -273,8 +289,13 @@ void ButtonThread::detachButtonInterrupts()
     if (settingsMap.count(user) != 0 && settingsMap[user] != RADIOLIB_NC)
         detachInterrupt(settingsMap[user]);
 #elif defined(BUTTON_PIN)
+#if !defined(USERPREFS_BUTTON_PIN)
     detachInterrupt(config.device.button_gpio ? config.device.button_gpio : BUTTON_PIN);
 #endif
+#if defined(USERPREFS_BUTTON_PIN)
+    detachInterrupt(config.device.button_gpio ? config.device.button_gpio : USERPREFS_BUTTON_PIN);
+#endif
+#endif
 
 #ifdef BUTTON_PIN_ALT
     detachInterrupt(BUTTON_PIN_ALT);
@@ -315,7 +336,7 @@ void ButtonThread::userButtonMultiPressed(void *callerThread)
 // Non-static method, runs during callback. Grabs info while still valid
 void ButtonThread::storeClickCount()
 {
-#ifdef BUTTON_PIN
+#if defined(BUTTON_PIN) || defined(USERPREFS_BUTTON_PIN)
     multipressClickCount = userButton.getNumberClicks();
 #endif
 }

src/ButtonThread.h

@@ -38,7 +38,7 @@ class ButtonThread : public concurrency::OSThread
     void storeClickCount();
 
   private:
-#if defined(BUTTON_PIN) || defined(ARCH_PORTDUINO)
+#if defined(BUTTON_PIN) || defined(ARCH_PORTDUINO) || defined(USERPREFS_BUTTON_PIN)
     static OneButton userButton; // Static - accessed from an interrupt
 #endif
 #ifdef BUTTON_PIN_ALT

src/mesh/NodeDB.cpp

@@ -246,6 +246,31 @@ NodeDB::NodeDB()
         config.position.gps_mode = meshtastic_Config_PositionConfig_GpsMode_ENABLED;
         config.position.gps_enabled = 0;
     }
+#ifdef USERPREFS_FIXED_GPS
+    if (myNodeInfo.reboot_count == 1) { // Check if First boot ever or after Factory Reset.
+        meshtastic_Position fixedGPS = meshtastic_Position_init_default;
+#ifdef USERPREFS_FIXED_GPS_LAT
+        fixedGPS.latitude_i = (int32_t)(USERPREFS_FIXED_GPS_LAT * 1e7);
+        fixedGPS.has_latitude_i = true;
+#endif
+#ifdef USERPREFS_FIXED_GPS_LON
+        fixedGPS.longitude_i = (int32_t)(USERPREFS_FIXED_GPS_LON * 1e7);
+        fixedGPS.has_longitude_i = true;
+#endif
+#ifdef USERPREFS_FIXED_GPS_ALT
+        fixedGPS.altitude = USERPREFS_FIXED_GPS_ALT;
+        fixedGPS.has_altitude = true;
+#endif
+#if defined(USERPREFS_FIXED_GPS_LAT) && defined(USERPREFS_FIXED_GPS_LON)
+        fixedGPS.location_source = meshtastic_Position_LocSource_LOC_MANUAL;
+        config.has_position = true;
+        info->has_position = true;
+        info->position = TypeConversions::ConvertToPositionLite(fixedGPS);
+        nodeDB->setLocalPosition(fixedGPS);
+        config.position.fixed_position = true;
+#endif
+    }
+#endif
     saveToDisk(saveWhat);
 }
 
@@ -438,8 +463,13 @@ void NodeDB::installDefaultConfig(bool preserveKey = false)
 #else
     bool hasScreen = screen_found.port != ScanI2C::I2CPort::NO_I2C;
 #endif
+#ifdef USERPREFS_FIXED_BLUETOOTH
+    config.bluetooth.fixed_pin = USERPREFS_FIXED_BLUETOOTH;
+    config.bluetooth.mode = meshtastic_Config_BluetoothConfig_PairingMode_FIXED_PIN;
+#else
     config.bluetooth.mode = hasScreen ? meshtastic_Config_BluetoothConfig_PairingMode_RANDOM_PIN
                                       : meshtastic_Config_BluetoothConfig_PairingMode_FIXED_PIN;
+#endif
     // for backward compat, default position flags are ALT+MSL
     config.position.position_flags =
         (meshtastic_Config_PositionConfig_PositionFlags_ALTITUDE | meshtastic_Config_PositionConfig_PositionFlags_ALTITUDE_MSL |

userPrefs.h

@@ -74,4 +74,25 @@ static unsigned char USERPREFS_ADMIN_KEY[] = {0xcd, 0xc0, 0xb4, 0x3c, 0x53, 0x24
                                        0x0c, 0x0d, 0xec, 0x85, 0x5a, 0x4c, 0xf6, 0x1a, 0x96, 0x04, 0x1a,
                                        0x3e, 0xfc, 0xbb, 0x8e, 0x33, 0x71, 0xe5, 0xfc, 0xff, 0x3c};
 */
+
+/*
+ * USERPREF_FIXED_GPS_LAT and USERPREF_FIXED_GPS_LON must be set, USERPREF_FIXED_GPS_ALT is optional
+ *
+ * Fixed GPS is Eiffel Tower, Paris, France
+ */
+// #define USERPREFS_FIXED_GPS
+// #define USERPREFS_FIXED_GPS_LAT 48.85873920
+// #define USERPREFS_FIXED_GPS_LON 2.294508368
+// #define USERPREFS_FIXED_GPS_ALT 0
+
+/*
+ * Set Fixed Bluetooth paring code
+ */
+// #define USERPREFS_FIXED_BLUETOOTH 121212
+
+/*
+ * Will overwrite BUTTON_PIN if set
+ */
+// #define USERPREFS_BUTTON_PIN 36
+
 #endif