Merge pull request #3298 from meshcore-dev/companion-cli

Companion CLI

variants/heltec_t096/T096Board.cpp

@@ -131,10 +131,50 @@ bool T096Board::setLoRaFemLnaEnabled(bool enable) {
   return true;
 }
 
-bool T096Board::canControlLoRaFemLna() const {
-  return loRaFEMControl.isLnaCanControl();
-}
-
 bool T096Board::isLoRaFemLnaEnabled() const {
   return loRaFEMControl.isLNAEnabled();
 }
+
+void T096Board::attachDynamicPrefs(KeyValueStore* prefs) {
+  _prefs = prefs;
+
+  char radio_fem_rxgain[8] = { 0 };
+  _prefs->getByKey("fem_rxgain", radio_fem_rxgain, 7);  // get initial values
+
+  setLoRaFemLnaEnabled(strcmp(radio_fem_rxgain, "1") == 0);
+}
+
+bool T096Board::handleCommand(const char* command, uint32_t sender_timestamp, char* reply) {
+  if (strcmp(command, "get radio.fem.rxgain") == 0) {
+    if (!loRaFEMControl.isLnaCanControl()) {
+      strcpy(reply, "Error: unsupported");
+    } else {
+      sprintf(reply, "> %s", isLoRaFemLnaEnabled() ? "on" : "off");
+    }
+    return true;
+  }
+  if (memcmp(command, "set radio.fem.rxgain ", 21) == 0) {
+    if (!loRaFEMControl.isLnaCanControl()) {
+      strcpy(reply, "Error: unsupported");
+    } else if (memcmp(&command[21], "on", 2) == 0) {
+      if (setLoRaFemLnaEnabled(true)) {
+        _prefs->setByKey("fem_rxgain", "1");
+        strcpy(reply, "OK - LoRa FEM RX gain on");
+      } else {
+        strcpy(reply, "Error: failed to apply LoRa FEM RX gain");
+      }
+    } else if (memcmp(&command[21], "off", 3) == 0) {
+      if (setLoRaFemLnaEnabled(false)) {
+        _prefs->setByKey("fem_rxgain", "0");
+        strcpy(reply, "OK - LoRa FEM RX gain off");
+      } else {
+        strcpy(reply, "Error: failed to apply LoRa FEM RX gain");
+      }
+    } else {
+      strcpy(reply, "Error: state must be on or off");
+    }
+    return true;
+  }
+
+  return false; // not handled
+}

variants/heltec_t096/T096Board.h

@@ -4,28 +4,33 @@
 #include <Arduino.h>
 #include <helpers/NRF52Board.h>
 #include <helpers/RefCountedDigitalPin.h>
+#include <helpers/KeyValueStore.h>
 #include "LoRaFEMControl.h"
 
 class T096Board : public NRF52BoardDCDC {
+  KeyValueStore* _prefs = NULL;
+
 protected:
 #ifdef NRF52_POWER_MANAGEMENT
   void initiateShutdown(uint8_t reason) override;
 #endif
   void variant_shutdown();
 
+  bool setLoRaFemLnaEnabled(bool enable);
+  bool isLoRaFemLnaEnabled() const;
+
 public:
   RefCountedDigitalPin periph_power;
   LoRaFEMControl loRaFEMControl;
 
   T096Board() :periph_power(PIN_VEXT_EN,PIN_VEXT_EN_ACTIVE), NRF52Board("T096_OTA") {}
   void begin();
+  void attachDynamicPrefs(KeyValueStore* prefs);
+  bool handleCommand(const char* command, uint32_t sender_timestamp, char* reply) override;
 
   void onBeforeTransmit(void) override;
   void onAfterTransmit(void) override;
   uint16_t getBattMilliVolts() override;
   const char* getManufacturerName() const override ;
   void powerOff() override;
-  bool setLoRaFemLnaEnabled(bool enable) override;
-  bool canControlLoRaFemLna() const override;
-  bool isLoRaFemLnaEnabled() const override;
 };

variants/heltec_tracker_v2/HeltecTrackerV2Board.cpp

@@ -72,10 +72,50 @@ void HeltecTrackerV2Board::begin() {
     return true;
   }
 
-  bool HeltecTrackerV2Board::canControlLoRaFemLna() const {
-    return loRaFEMControl.isLnaCanControl();
-  }
-
   bool HeltecTrackerV2Board::isLoRaFemLnaEnabled() const {
     return loRaFEMControl.isLNAEnabled();
   }
+
+void HeltecTrackerV2Board::attachDynamicPrefs(KeyValueStore* prefs) {
+  _prefs = prefs;
+
+  char radio_fem_rxgain[8] = { 0 };
+  _prefs->getByKey("fem_rxgain", radio_fem_rxgain, 7);  // get initial values
+
+  setLoRaFemLnaEnabled(strcmp(radio_fem_rxgain, "1") == 0);
+}
+
+bool HeltecTrackerV2Board::handleCommand(const char* command, uint32_t sender_timestamp, char* reply) {
+  if (strcmp(command, "get radio.fem.rxgain") == 0) {
+    if (!loRaFEMControl.isLnaCanControl()) {
+      strcpy(reply, "Error: unsupported");
+    } else {
+      sprintf(reply, "> %s", isLoRaFemLnaEnabled() ? "on" : "off");
+    }
+    return true;
+  }
+  if (memcmp(command, "set radio.fem.rxgain ", 21) == 0) {
+    if (!loRaFEMControl.isLnaCanControl()) {
+      strcpy(reply, "Error: unsupported");
+    } else if (memcmp(&command[21], "on", 2) == 0) {
+      if (setLoRaFemLnaEnabled(true)) {
+        _prefs->setByKey("fem_rxgain", "1");
+        strcpy(reply, "OK - LoRa FEM RX gain on");
+      } else {
+        strcpy(reply, "Error: failed to apply LoRa FEM RX gain");
+      }
+    } else if (memcmp(&command[21], "off", 3) == 0) {
+      if (setLoRaFemLnaEnabled(false)) {
+        _prefs->setByKey("fem_rxgain", "0");
+        strcpy(reply, "OK - LoRa FEM RX gain off");
+      } else {
+        strcpy(reply, "Error: failed to apply LoRa FEM RX gain");
+      }
+    } else {
+      strcpy(reply, "Error: state must be on or off");
+    }
+    return true;
+  }
+
+  return false; // not handled
+}

variants/heltec_tracker_v2/HeltecTrackerV2Board.h

@@ -6,6 +6,10 @@
 #include "LoRaFEMControl.h"
 
 class HeltecTrackerV2Board : public ESP32Board {
+  KeyValueStore* _prefs = NULL;
+
+  bool setLoRaFemLnaEnabled(bool enable);
+  bool isLoRaFemLnaEnabled() const;
 
 public:
   RefCountedDigitalPin periph_power;
@@ -14,13 +18,13 @@ public:
   HeltecTrackerV2Board() : periph_power(PIN_VEXT_EN,PIN_VEXT_EN_ACTIVE) { }
 
   void begin();
+  void attachDynamicPrefs(KeyValueStore* prefs);
+  bool handleCommand(const char* command, uint32_t sender_timestamp, char* reply) override;
+
   void onBeforeTransmit(void) override;
   void onAfterTransmit(void) override;
   void powerOff() override;
   uint16_t getBattMilliVolts() override;
   const char* getManufacturerName() const override ;
-  bool setLoRaFemLnaEnabled(bool enable) override;
-  bool canControlLoRaFemLna() const override;
-  bool isLoRaFemLnaEnabled() const override;
 
 };

variants/heltec_v4/HeltecV4Board.cpp

@@ -73,10 +73,50 @@ void HeltecV4Board::begin() {
     return true;
   }
 
-  bool HeltecV4Board::canControlLoRaFemLna() const {
-    return loRaFEMControl.isLnaCanControl();
-  }
-
   bool HeltecV4Board::isLoRaFemLnaEnabled() const {
     return loRaFEMControl.isLNAEnabled();
   }
+
+void HeltecV4Board::attachDynamicPrefs(KeyValueStore* prefs) {
+  _prefs = prefs;
+
+  char radio_fem_rxgain[8] = { 0 };
+  _prefs->getByKey("fem_rxgain", radio_fem_rxgain, 7);  // get initial values
+
+  setLoRaFemLnaEnabled(strcmp(radio_fem_rxgain, "1") == 0);
+}
+
+bool HeltecV4Board::handleCommand(const char* command, uint32_t sender_timestamp, char* reply) {
+  if (strcmp(command, "get radio.fem.rxgain") == 0) {
+    if (!loRaFEMControl.isLnaCanControl()) {
+      strcpy(reply, "Error: unsupported");
+    } else {
+      sprintf(reply, "> %s", isLoRaFemLnaEnabled() ? "on" : "off");
+    }
+    return true;
+  }
+  if (memcmp(command, "set radio.fem.rxgain ", 21) == 0) {
+    if (!loRaFEMControl.isLnaCanControl()) {
+      strcpy(reply, "Error: unsupported");
+    } else if (memcmp(&command[21], "on", 2) == 0) {
+      if (setLoRaFemLnaEnabled(true)) {
+        _prefs->setByKey("fem_rxgain", "1");
+        strcpy(reply, "OK - LoRa FEM RX gain on");
+      } else {
+        strcpy(reply, "Error: failed to apply LoRa FEM RX gain");
+      }
+    } else if (memcmp(&command[21], "off", 3) == 0) {
+      if (setLoRaFemLnaEnabled(false)) {
+        _prefs->setByKey("fem_rxgain", "0");
+        strcpy(reply, "OK - LoRa FEM RX gain off");
+      } else {
+        strcpy(reply, "Error: failed to apply LoRa FEM RX gain");
+      }
+    } else {
+      strcpy(reply, "Error: state must be on or off");
+    }
+    return true;
+  }
+
+  return false; // not handled
+}

variants/heltec_v4/HeltecV4Board.h

@@ -10,6 +10,10 @@
 #endif
 
 class HeltecV4Board : public ESP32Board {
+  KeyValueStore* _prefs = NULL;
+
+  bool setLoRaFemLnaEnabled(bool enable);
+  bool isLoRaFemLnaEnabled() const;
 
 protected:
   float adc_mult = ADC_MULTIPLIER;
@@ -20,12 +24,12 @@ public:
   HeltecV4Board() : periph_power(PIN_VEXT_EN,PIN_VEXT_EN_ACTIVE) { }
 
   void begin();
+  void attachDynamicPrefs(KeyValueStore* prefs);
+  bool handleCommand(const char* command, uint32_t sender_timestamp, char* reply) override;
+
   void onBeforeTransmit(void) override;
   void onAfterTransmit(void) override;
   void powerOff() override;
-  bool setLoRaFemLnaEnabled(bool enable) override;
-  bool canControlLoRaFemLna() const override;
-  bool isLoRaFemLnaEnabled() const override;
   uint16_t getBattMilliVolts() override;
   bool setAdcMultiplier(float multiplier) override {
     if (multiplier == 0.0f) {

variants/rpi_picow/PicoWBoard.h

@@ -2,6 +2,7 @@
 
 #include <MeshCore.h>
 #include <Arduino.h>
+#include <helpers/KeyValueStore.h>
 
 // built-ins
 #define  PIN_VBAT_READ    26
@@ -16,6 +17,8 @@ public:
   void begin();
   uint8_t getStartupReason() const override { return startup_reason; }
 
+  void attachDynamicPrefs(KeyValueStore* prefs) { }  // no-op
+
   void onBeforeTransmit() override {
     digitalWrite(LED_BUILTIN, HIGH);   // turn TX LED on
   }

variants/station_g3_esp32/StationG3Board.cpp

@@ -21,10 +21,6 @@ bool StationG3Board::setLoRaFemLnaEnabled(bool enable) {
   return true;
 }
 
-bool StationG3Board::canControlLoRaFemLna() const {
-  return loRaFEMControl.canControlLNA();
-}
-
 bool StationG3Board::isLoRaFemLnaEnabled() const {
   return loRaFEMControl.isLNAEnabled();
 }
@@ -37,10 +33,86 @@ bool StationG3Board::setLoRaFemPaGainEnabled(bool enable) {
   return true;
 }
 
-bool StationG3Board::canControlLoRaFemPaGain() const {
-  return loRaFEMControl.canControlPAGain();
-}
-
 bool StationG3Board::isLoRaFemPaGainEnabled() const {
   return loRaFEMControl.isPAGainEnabled();
 }
+
+void StationG3Board::attachDynamicPrefs(KeyValueStore* prefs) {
+  _prefs = prefs;
+
+  char gain[8];
+
+  gain[0] = 0;
+  _prefs->getByKey("fem_rxgain", gain, 7);  // get initial values
+  setLoRaFemLnaEnabled(strcmp(gain, "1") == 0);
+
+  gain[0] = 0;
+  _prefs->getByKey("fem_txgain", gain, 7);  // get initial values
+  setLoRaFemPaGainEnabled(strcmp(gain, "1") == 0);
+}
+
+bool StationG3Board::handleCommand(const char* command, uint32_t sender_timestamp, char* reply) {
+  if (strcmp(command, "get radio.fem.rxgain") == 0) {
+    if (!loRaFEMControl.canControlLNA()) {
+      strcpy(reply, "Error: unsupported");
+    } else {
+      sprintf(reply, "> %s", isLoRaFemLnaEnabled() ? "on" : "off");
+    }
+    return true;
+  }
+  if (memcmp(command, "set radio.fem.rxgain ", 21) == 0) {
+    if (!loRaFEMControl.canControlLNA()) {
+      strcpy(reply, "Error: unsupported");
+    } else if (memcmp(&command[21], "on", 2) == 0) {
+      if (setLoRaFemLnaEnabled(true)) {
+        _prefs->setByKey("fem_rxgain", "1");
+        strcpy(reply, "OK - LoRa FEM RX gain on");
+      } else {
+        strcpy(reply, "Error: failed to apply LoRa FEM RX gain");
+      }
+    } else if (memcmp(&command[21], "off", 3) == 0) {
+      if (setLoRaFemLnaEnabled(false)) {
+        _prefs->setByKey("fem_rxgain", "0");
+        strcpy(reply, "OK - LoRa FEM RX gain off");
+      } else {
+        strcpy(reply, "Error: failed to apply LoRa FEM RX gain");
+      }
+    } else {
+      strcpy(reply, "Error: state must be on or off");
+    }
+    return true;
+  }
+
+  if (strcmp(command, "get radio.fem.txgain") == 0) {
+    if (!loRaFEMControl.canControlPAGain()) {
+      strcpy(reply, "Error: unsupported");
+    } else {
+      sprintf(reply, "> %s", isLoRaFemPaGainEnabled() ? "on" : "off");
+    }
+    return true;
+  }
+  if (memcmp(command, "set radio.fem.txgain ", 21) == 0) {
+    if (!loRaFEMControl.canControlPAGain()) {
+      strcpy(reply, "Error: unsupported");
+    } else if (memcmp(&command[21], "on", 2) == 0) {
+      if (setLoRaFemPaGainEnabled(true)) {
+        _prefs->setByKey("fem_txgain", "1");
+        strcpy(reply, "OK - LoRa FEM TX gain on");
+      } else {
+        strcpy(reply, "Error: failed to apply LoRa FEM TX gain");
+      }
+    } else if (memcmp(&command[21], "off", 3) == 0) {
+      if (setLoRaFemPaGainEnabled(false)) {
+        _prefs->setByKey("fem_txgain", "0");
+        strcpy(reply, "OK - LoRa FEM TX gain off");
+      } else {
+        strcpy(reply, "Error: failed to apply LoRa FEM TX gain");
+      }
+    } else {
+      strcpy(reply, "Error: state must be on or off");
+    }
+    return true;
+  }
+
+  return false; // not handled
+}

variants/station_g3_esp32/StationG3Board.h

@@ -6,6 +6,12 @@
 #include "LoRaFEMControl.h"
 
 class StationG3Board : public ESP32Board {
+  KeyValueStore* _prefs = NULL;
+
+  bool setLoRaFemLnaEnabled(bool enable);
+  bool isLoRaFemLnaEnabled() const;
+  bool setLoRaFemPaGainEnabled(bool enable);
+  bool isLoRaFemPaGainEnabled() const;
 public:
   LoRaFEMControl loRaFEMControl;
 
@@ -25,6 +31,10 @@ public:
     }
   }
 
+  void attachDynamicPrefs(KeyValueStore* prefs);
+
+  bool handleCommand(const char* command, uint32_t sender_timestamp, char* reply) override;
+
   void setPrimaryLNAEnable(bool enabled) {
     loRaFEMControl.setLNAEnable(enabled);
   }
@@ -43,13 +53,6 @@ public:
     loRaFEMControl.setRxModeEnable();
   }
 
-  bool setLoRaFemLnaEnabled(bool enable) override;
-  bool canControlLoRaFemLna() const override;
-  bool isLoRaFemLnaEnabled() const override;
-  bool setLoRaFemPaGainEnabled(bool enable) override;
-  bool canControlLoRaFemPaGain() const override;
-  bool isLoRaFemPaGainEnabled() const override;
-
   void powerOff() override;
 
   uint16_t getBattMilliVolts() override {

variants/waveshare_rp2040_lora/WaveshareBoard.h

@@ -2,6 +2,7 @@
 
 #include <Arduino.h>
 #include <MeshCore.h>
+#include <helpers/KeyValueStore.h>
 
 // LoRa radio module pins for Waveshare RP2040-LoRa-HF/LF
 // https://files.waveshare.com/wiki/RP2040-LoRa/Rp2040-lora-sch.pdf
@@ -32,6 +33,8 @@ public:
   void begin();
   uint8_t getStartupReason() const override { return startup_reason; }
 
+  void attachDynamicPrefs(KeyValueStore* prefs) { }  // no-op
+
 #ifdef P_LORA_TX_LED
   void onBeforeTransmit() override { digitalWrite(P_LORA_TX_LED, HIGH); }
   void onAfterTransmit() override { digitalWrite(P_LORA_TX_LED, LOW); }

variants/xiao_rp2040/XiaoRP2040Board.h

@@ -2,6 +2,7 @@
 
 #include <Arduino.h>
 #include <MeshCore.h>
+#include <helpers/KeyValueStore.h>
 
 /*
  * This board has no built-in way to read battery voltage.
@@ -30,6 +31,8 @@ public:
   void begin();
   uint8_t getStartupReason() const override { return startup_reason; }
 
+  void attachDynamicPrefs(KeyValueStore* prefs) { }  // no-op
+
 #ifdef P_LORA_TX_LED
   void onBeforeTransmit() override { digitalWrite(P_LORA_TX_LED, HIGH); }
   void onAfterTransmit() override { digitalWrite(P_LORA_TX_LED, LOW); }