Merge pull request #1 from ssbc/esp32-config

added new functionality: select LoRa plan via button (long) click

Author: nanomonkey

esp32/loramesh-TBeam/bipf.cpp

@@ -495,16 +495,29 @@ struct bipf_s* str2bipf(char *s) // returns addr of a static (!) BIPF obj
   return &e;
 }
 
-String bipf2String(struct bipf_s *bptr)
+String bipf2String(struct bipf_s *bptr, char *nl, int lev)
 {
-  String v;
+  String v, indent, r = nl;
   struct bipf_s **pp;
 
+  indent = "";
+  if (nl)
+    for (int i = 0; i < lev; i++)
+      indent += "  ";
+  else
+    r = "";
+
   switch (bptr->typ) {
     case BIPF_BYTES:
-      return "0x...";
-    case BIPF_STRING:
-      return "\"" + String(bptr->u.str) + "\"";
+      return "#" + String(to_hex(bptr->u.buf, bptr->cnt));
+    case BIPF_STRING: {
+      char *c_str = (char*) malloc(bptr->cnt+1);
+      memcpy(c_str, bptr->u.str, bptr->cnt);
+      c_str[bptr->cnt] = '\0';
+      String s(c_str);
+      free(c_str);
+      return "\"" + s + "\"";
+    }
     case BIPF_BOOLNONE:
       if  (bptr->u.i < 0)
         return "none";
@@ -516,24 +529,28 @@ String bipf2String(struct bipf_s *bptr)
     case BIPF_INT:
       return String(bptr->u.i);
     case BIPF_LIST:
-      v = "[";
+      if (bptr->cnt == 0)
+        return "[]";
+      v = "[" + r;
       pp = bptr->u.list;
       for (int i = 0; i < bptr->cnt; i++) {
-        if (v.length() != 1)
-          v += ",";
-        v += bipf2String(*pp++);
+        if (i > 0)
+          v += "," + r;
+        v += indent + bipf2String(*pp++, nl, lev+1);
       }
-      return v + "]";
+      return v + r + indent + "]";
     case BIPF_DICT:
-      v = "{";
+      if (bptr->cnt == 0)
+        return "{}";
+      v = "{" + r;
       pp = bptr->u.dict;
       for (int i = 0; i < bptr->cnt; i++) {
-        if (v.length() != 1)
-          v += ",";
-        v += bipf2String(*pp++) + ":";
-        v += bipf2String(*pp++);
+        if (i > 0)
+          v += "," + r;
+        v += indent + bipf2String(*pp++, nl, lev+1) + (nl ? ": " : ":");
+        v += bipf2String(*pp++, nl, lev+1);
       }
-      return v + "}";
+      return v + r + indent + "}";
     default:
       // Serial.println("can't render typ=" + String(bptr->typ));
       break;

esp32/loramesh-TBeam/bipf.h

@@ -59,7 +59,7 @@ unsigned char* bipf_dumps(struct bipf_s *bptr, int *len);
 struct bipf_s* bipf_loads(unsigned char *buf, int len);
 
 struct bipf_s* str2bipf(char *s); // return static bipf_s for s
-struct String bipf2String(struct bipf_s *bptr);
+struct String bipf2String(struct bipf_s *bptr, char *nl=NULL, int lev=0);
 
 #endif // _INCLUDE_BIPF_H
 

esp32/loramesh-TBeam/cmd.h

@@ -3,6 +3,40 @@
 // tinySSB for ESP32
 // Aug 2022 <christian.tschudin@unibas.ch>
 
+// --------------------------------------------------------------------------
+
+void listDir(fs::FS &fs, const char *dirname, uint8_t levels)
+{
+  Serial.printf("Listing directory: %s\r\n", dirname);
+
+  File root = fs.open(dirname);
+  if (!root) {
+    Serial.println("- failed to open directory");
+    return;
+  }
+  if (!root.isDirectory()) {
+    Serial.println(" - not a directory");
+    return;
+  }
+
+  File file = root.openNextFile();
+  int  cnt = 0;
+  while (file) {
+    cnt++;
+    if (file.isDirectory()) {
+      Serial.printf("  DIR : %s\r\n", file.name());
+      if (levels)
+        listDir(fs, file.path(), levels -1);
+    } else
+      Serial.printf("  FILE: %s\tSIZE: %d\r\n", file.name(), file.size());
+    file = root.openNextFile();
+  }
+  if (cnt == 0)
+    Serial.printf("  EMPTY\r\n");
+}
+
+// --------------------------------------------------------------------------
+
 void cmd_rx(String cmd) {
   cmd.toLowerCase();
   cmd.trim();
@@ -17,6 +51,7 @@ void cmd_rx(String cmd) {
       Serial.println("  d        dump DMXT and CHKT");
       Serial.println("  f        list file system");
       Serial.println("  g        dump GOset");
+      Serial.println("  i        pretty print the confIg values");
       Serial.println("  k+<key>  add new key (globally)");
       Serial.println("  k-<key>  remove key (globally)");
 #if defined(LORA_LOG)
@@ -100,14 +135,20 @@ void cmd_rx(String cmd) {
     case 'f': // Directory dump
       Serial.printf("File system: %d total bytes, %d used\r\n",
                     MyFS.totalBytes(), MyFS.usedBytes());
-      listDir(MyFS, FEED_DIR, 2);
+      listDir(MyFS, "/", 2); // FEED_DIR, 2);
       break;
     case 'g': // GOset dump
       Serial.printf("GOset: %d entries\r\n", theGOset->goset_len);
       for (int i = 0; i < theGOset->goset_len; i++)
         Serial.printf("%2d %s\r\n", i,
                       to_hex(theGOset->get_key(i), GOSET_KEY_LEN, 0));
       break;
+    case 'i': { // config values
+      // FIXME: we should not print the mgmt signing key to the console ?
+      String s = bipf2String(the_config, "\r\n", 0);
+      Serial.printf("Configuration values:\r\n%s\r\n", s.c_str());
+      break;
+    }
     case 'k': { // allow/deny key
       if (cmd.length() != 2 * GOSET_KEY_LEN + 2) { Serial.printf("invalid key length\r\n"); break; }
       if (!(cmd[1] == '+' or cmd[1] == '-')) { Serial.printf("invalid command: %s\r\n", cmd[1]); break; }
@@ -121,16 +162,16 @@ void cmd_rx(String cmd) {
 #if defined(LORA_LOG)
   case 'l': // list Log file
       lora_log.close();
-      lora_log = MyFS.open("/lora_log.txt", FILE_READ);
+      lora_log = MyFS.open(LORA_LOG_FILENAME, FILE_READ);
       while (lora_log.available()) {
         Serial.write(lora_log.read());
       }
       lora_log.close();
-      lora_log = MyFS.open("/lora_log.txt", FILE_APPEND);
+      lora_log = MyFS.open(LORA_LOG_FILENAME, FILE_APPEND);
       break;
   case 'm': // empty Log file
       lora_log.close();
-      lora_log = MyFS.open("/lora_log.txt", FILE_WRITE);
+      lora_log = MyFS.open(LORA_LOG_FILENAME, FILE_WRITE);
       break;
 #endif
     case 'r': // reset
@@ -174,6 +215,8 @@ void cmd_rx(String cmd) {
         Serial.printf("sending reboot request to %s\r\n", to_hex(id, MGMT_ID_LEN, 0));
         mgmt_send_request('x', id);
       } else {
+        lora_log.printf(">> reboot cmd\n");
+        lora_log.close();
         Serial.println("rebooting ...\n");
         esp_restart();
       }

esp32/loramesh-TBeam/config.cpp

@@ -4,13 +4,15 @@
 // (c) 2023 <christian.tschudin@unibas.ch>
 
 #include <Arduino.h>
+#include <sodium/crypto_auth.h>
 
 #include "config.h"
 
 #define LORA_TX_POWER  20
 #define LORA_tSSB_SYNC 0x58    // for "SB, Scuttlebutt". see https://forum.lora-developers.semtech.com/t/sx1272-and-sx1262-lora-sync-word-compatibility/988
 
 struct lora_config_s lora_configs[] = {
+  // FIXME: these values are copying TNN values - we should step around these
   {"AU915.a", 917500000, 500000, 8, 5, LORA_tSSB_SYNC, LORA_TX_POWER},
   {"AU915.b", 917500000, 125000, 7, 5, LORA_tSSB_SYNC, LORA_TX_POWER},
   {"EU868.a", 868300000, 250000, 7, 5, LORA_tSSB_SYNC, LORA_TX_POWER},
@@ -25,28 +27,47 @@ short lora_configs_size = sizeof(lora_configs) / sizeof(struct lora_config_s);
 
 struct bipf_s* config_load() // returns a BIPF dict with the persisted config dict
 {
-  if (!MyFS.exists(CONFIG_FILENAME)) { // define some defaults
+  File f = MyFS.open(CONFIG_FILENAME, "rb");
+
+  if (f == NULL) { // define some defaults
     struct bipf_s *dict = bipf_mkDict();
-    bipf_dict_set(dict, bipf_mkString("lora_plan"), bipf_mkString("AU915.a"));
+    
+    bipf_dict_set(dict, bipf_mkString("bubbles"),
+                  bipf_mkList()); // empty list of bubble publ keys
+
+    bipf_dict_set(dict, bipf_mkString("lora_plan"),
+                  bipf_mkString("AU915.a"));
+
+    unsigned char key[crypto_auth_hmacsha512_KEYBYTES]; // 48B
+    memset(key, 1, crypto_auth_hmacsha512_KEYBYTES);    // default is #0101...
+    bipf_dict_set(dict, bipf_mkString("mgmt_sign_key"),
+                  bipf_mkBytes(key, crypto_auth_hmacsha512_KEYBYTES));
+
+    config_save(dict);
     return dict;
   }
 
-  File f = MyFS.open(CONFIG_FILENAME);
   int len = f.size();
   unsigned char *buf = (unsigned char*) malloc(len);
   f.read(buf, len);
   f.close();
   struct bipf_s *dict = bipf_loads(buf, len);
+  // FIXME: we should not print the mgmt signing key to the console ?
+  Serial.printf("loaded config %s\r\n", bipf2String(dict,"\r\n").c_str());
   free(buf);
   return dict;
 }
 
 void config_save(struct bipf_s *dict) // persist the BIPF dict
 {
+  // FIXME: we should not print the mgmt signing key to the console
+  // Serial.printf("storing config %s\r\n", bipf2String(dict).c_str());
   int len = bipf_encodingLength(dict);
   unsigned char *buf = (unsigned char*) malloc(len);
-  if (!buf)
+  if (!buf) {
+    Serial.printf("malloc failed\n");
     return;
+  }
   bipf_encode(buf, dict);
   File f = MyFS.open(CONFIG_FILENAME, "wb");
   f.write(buf, len);

esp32/loramesh-TBeam/config.h

@@ -116,7 +116,7 @@ extern short lora_configs_size;
 //   "lora_plan": "US915", // i.e., the lora config is specified by plan name
 // }
 
-#define CONFIG_FILENAME "config.bipf"
+#define CONFIG_FILENAME "/config.bipf"
 
 struct bipf_s* config_load(); // returns a BIPF dict with the persisted config dict
 void           config_save(struct bipf_s *dict); // persist the BIPF dict

esp32/loramesh-TBeam/hw_setup.h

@@ -34,7 +34,6 @@ TinyGPSPlus gps;
 HardwareSerial GPS(1);
 #endif
 
-Button2 userButton;
 unsigned char my_mac[6];
 
 // -------------------------------------------------------------------
@@ -49,26 +48,20 @@ unsigned char my_mac[6];
 
 // -------------------------------------------------------------------
 
-static unsigned char OLED_state = HIGH;
 
-void OLED_toggle() {
-  OLED_state = OLED_state ? LOW : HIGH;
-#if !defined(NO_OLED)
-  if (OLED_state == LOW) theDisplay.displayOff();
-  else                   theDisplay.displayOn();
-#endif
-}
-
-void pressed(Button2& btn) {
-  // Serial.println("pressed");
-  OLED_toggle();
-}
+void hw_setup() // T-BEAM or Heltec LoRa32v2
+{
+  // Serial.begin(BAUD_RATE);
 
-// -------------------------------------------------------------------
+  Serial.println("\n** Starting Scuttlebutt vPub (LoRa, WiFi, BLE) with GOset **\n");
 
+  // -------------------------------------------------------------------
+  if (!MyFS.begin(true)) { // FORMAT_SPIFFS_IF_FAILED)){
+    Serial.println("LittleFS Mount Failed, partition was reformatted");
+    // return;
+  }
+  // MyFS.format(); // uncomment and run once after a change in partition size
 
-void hw_setup() // T-BEAM or Heltec LoRa32v2
-{
   the_config = config_load();
   the_lora_config = lora_configs;
   struct bipf_s k = { BIPF_STRING, 9, {.str = "lora_plan"} };
@@ -81,8 +74,6 @@ void hw_setup() // T-BEAM or Heltec LoRa32v2
       }
   }
 
-  // Serial.begin(BAUD_RATE);
-
 #if defined(WIFI_LoRa_32_V2) || defined(WIFI_LORA_32_V2)
   Heltec.begin(true /*DisplayEnable Enable*/,
                true /*Heltec.Heltec.Heltec.LoRa Disable*/,
@@ -158,24 +149,11 @@ void hw_setup() // T-BEAM or Heltec LoRa32v2
   LoRa.receive();
 #endif
 
-  // pinMode(BUTTON_PIN, INPUT);
-  userButton.begin(BUTTON_PIN);
-  userButton.setPressedHandler(pressed);
-
-  Serial.println("\n** Starting Scuttlebutt vPub (LoRa, WiFi, BLE) with GOset **\n");
 #if !defined(NO_OLED)
-  theDisplay.clear();
+  theDisplay.clear();  // erase silly screen msg from inside the library ...
   theDisplay.display();
 #endif
 
-
-  // -------------------------------------------------------------------
-  if (!MyFS.begin(true)) { // FORMAT_SPIFFS_IF_FAILED)){
-    Serial.println("LittleFS Mount Failed, partition was reformatted");
-    // return;
-  }
-  // MyFS.format(); // uncomment and run once after a change in partition size
-
   // -------------------------------------------------------------------
 
   // esp_read_mac(my_mac, ESP_MAC_WIFI_STA);
@@ -215,32 +193,4 @@ void hw_setup() // T-BEAM or Heltec LoRa32v2
   Serial.println();
 }
 
-// --------------------------------------------------------------------------
-
-void listDir(fs::FS &fs, const char *dirname, uint8_t levels)
-{
-  Serial.printf("Listing directory: %s\r\n", dirname);
-
-  File root = fs.open(dirname);
-  if (!root) {
-    Serial.println("- failed to open directory");
-    return;
-  }
-  if (!root.isDirectory()) {
-    Serial.println(" - not a directory");
-    return;
-  }
-
-  File file = root.openNextFile();
-  while (file) {
-    if (file.isDirectory()) {
-      Serial.printf("  DIR : %s\r\n", file.name());
-      if (levels)
-        listDir(fs, file.path(), levels -1);
-    } else
-      Serial.printf("  FILE: %s\tSIZE: %d\r\n", file.name(), file.size());
-    file = root.openNextFile();
-  }
-}
-
 // eof