Shelve.

Merge pull request 'Add custom message ability' (#47 ) from custom-message into main
2023-09-16 19:17:31 -05:00 · 2023-09-16 17:04:22 -05:00 · 2023-09-16 15:48:03 -05:00 · 2023-09-16 09:51:39 -05:00 · 2023-09-16 09:17:17 -05:00 · 2023-09-16 09:16:35 -05:00
1 changed files with 137 additions and 91 deletions
--- a/vulpes/src/main.cpp
+++ b/vulpes/src/main.cpp
@ -27,7 +27,8 @@
 AsyncWebServer server(80);

 // Assign output variables to GPIO pins
-const int keyer = 32; //LED_BUILTIN for on-board (dev);//26 for LED; //32 for transmitter keyer
+//LED_BUILTIN for ESP32 onboard LED, 32 for transmitter keyer
+const int keyer = 32;
 const int blinker = LED_BUILTIN;

 RTC_DS3231 rtc; // set up RTC
@ -37,10 +38,10 @@ const int alarmPin = 4; // pin to monitor for RTC alarms
 const char* ssid = WIFI_SSID;
 const char* password = WIFI_PASSWORD;

-const char* PARAM_STRING = "inputString";
 const char* PARAM_SEND = "inputSend";
 const char* PARAM_WPM = "inputWPM";
 const char* PARAM_MSG = "inputMsg";
+const char* PARAM_CMSG = "inputCustomMsg";
 const char* PARAM_FLOAT = "inputFloat";
 const char* PARAM_TIME = "inputTimeUnix";
 const char* PARAM_START = "inputStartTimeUnix";
@ -50,11 +51,11 @@ const char* PARAM_CYCLEID = "inputCycleID";
 const char* PARAM_NTRANS = "inputNtransmitters";

 // Global variables
-String yourInputString;
 int yourInputSend;
 int yourInputWPM;
 int yourInputMsg;
 int yourInputMsg_old; // to save previous state and check changes
+String yourInputCustomMsg;
 float yourInputFloat;
 uint32_t yourInputTime; //to keep time
 uint32_t yourInputStartTimeUnix;
@ -63,18 +64,23 @@ bool programRunning;
 int yourInputStepLength;
 int yourInputCycleID;
 int yourInputNtransmitters;
-//int step_length = 10000; // 10 secs
-//int cycle_id = 1; // number of this transmitter in cycle
-//int n_transmitters = 2; //number of transmitters total
 long start_millis = 0;
 long stop_millis = 0;
 long pause_until_millis = 0;

-// HTML web page to handle 3 input fields (inputString, inputSend, inputFloat)
+// HTML web page to handle input fields 
 const char index_html[] PROGMEM = R"rawliteral(
 <!DOCTYPE HTML><html><head>
  <link rel="icon" href="data:,">
-  <title>ESP Input Form</title>
+  <title>Vulpes Radio Orienteering Controller</title>
+  <style>
+    .inv_message {
+      display: none;
+      }
+    .inv_program {
+      display: none;
+      }
+  </style>
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <script type="text/javascript">
    // Utility from https://webreflection.medium.com/using-the-input-datetime-local-9503e7efdce
@ -125,49 +131,89 @@ const char index_html[] PROGMEM = R"rawliteral(
    <h2>General Settings</h2>
    <p>Sending program:
    <select name="inputSend" id="send-program">
-      <option value="0" >0 - Off</option>
+      <option value="0">0 - Off</option>
      <option value="1">1 - Continuous</option>
      <option value="2">2 - Cycle</option>
    </select><br>

    Message:
    <select name="inputMsg" id="message">
-      <option value="0">0 - TEST TEST TEST DE W1CDN</option>
+      <option value="0">0 - Custom Message</option>
      <option value="1">1 - MOE</option>
      <option value="2">2 - MOI</option>
      <option value="3">3 - MOS</option>
      <option value="4">4 - MOH</option>
      <option value="5">5 - MO5</option>
-    </select></p>
+    </select><br>

-    <h2>Cycle Settings</h2>
-    <p>Only applies when <em>Sending Program</em> is set to "2 - Cycle". You cannot set a cycle start date more than a month in advance.</p>
-    <p>Cycle start time <input type="datetime-local" id="js_start_time_unix_entry" /><br>
-    Current value: <b><span id=current-start></span></b>
+    <!-- Hidden unless "0 - Custom Message" is selected -->
+    <span id="message0" class="inv_message">
+      Custom message: <input type="text" name="inputCustomMsg" value = "%inputCustomMsg%"><br>
+    </span>
    
-    <!-- JS converts the entered start time to a unix timestamp, and copies that value
-    to this hidden field so the user doesn't have to see it. -->
-    <input type="hidden" name="inputStartTimeUnix" id="js_start_time_unix" /></p>
-    <p>
-      Step length: <input type="number" name="inputStepLength" min=1000 step=1000 value = %inputStepLength%> milliseconds <br>
-      Cycle ID: <input type="number" name="inputCycleID" min=1 value = %inputCycleID%><br>
-      Number of transmitters: <input type="number" name="inputNtransmitters" min=1 value = %inputNtransmitters%><br>
+    Speed: <input type="number" name="inputWPM" value = %inputWPM%> WPM
    </p>

+    <!-- Hidden unless "2 - Cycle" is selected -->
+    <span id="program2" class="inv_program">
+      <h2>Cycle Settings</h2>
+      <p>Only applies when <em>Sending Program</em> is set to "2 - Cycle". You cannot set a cycle start date more than a month in advance.<br>
+      Cycle start time <input type="datetime-local" id="js_start_time_unix_entry" /><br>
+      Current value: <b><span id=current-start></span></b><br>
+      
+      <!-- JS converts the entered start time to a unix timestamp, and copies that value
+      to this hidden field so the user doesn't have to see it. -->
+      <input type="hidden" name="inputStartTimeUnix" id="js_start_time_unix" /></p>
+        Step length: <input type="number" name="inputStepLength" min=1000 step=1000 value = %inputStepLength%> milliseconds <br>
+        Cycle ID: <input type="number" name="inputCycleID" min=1 value = %inputCycleID%><br>
+        Number of transmitters: <input type="number" name="inputNtransmitters" min=1 value = %inputNtransmitters%><br>
+      </p>
+    </span>
+    
    <!-- This field is hidden so people don't change the submit time (it will be wrong).
    The value is automatically filled in with JS. -->
    <input type="hidden" name="inputTimeUnix" id="js_time_unix">

    <!-- Extra fields just in case I need them -->  
-    <input type="hidden" name="inputWPM" value = %inputWPM%>
-    <input type="hidden" name="inputString" value = %inputString%>
    <input type="hidden" name="inputFloat" value = %inputFloat%>

    <input type="submit" value="Submit"">
  </form>
+
+  
+
  <iframe style="display:none" name="hidden-form" id="hidden-form"></iframe>
  <script type="text/javascript">
-    
+    // Show more stuff depending on selected values
+    // https://stackoverflow.com/a/24849350
+    show_message = function () {
+          'use strict';
+          var vis_message = document.querySelector('.vis_message'),   
+              target = document.getElementById("message"+this.value);
+          if (vis_message !== null) {
+              vis_message.className = 'inv_message';
+          }
+          if (target !== null ) {
+              target.className = 'vis_message';
+          }
+    }
+    show_program = function () {
+          'use strict';
+          var vis_program = document.querySelector('.vis_program'),   
+              target = document.getElementById("program"+this.value);
+          if (vis_program !== null) {
+              vis_program.className = 'inv_program';
+          }
+          if (target !== null ) {
+              target.className = 'vis_program';
+          }
+    }
+    document
+      .getElementById('message')
+      .addEventListener('change', show_message);
+    document
+      .getElementById('send-program')
+      .addEventListener('change', show_program);
  </script>
 </body></html>)rawliteral";

@ -211,8 +257,8 @@ void writeFile(fs::FS &fs, const char * path, const char * message){
 // Replaces placeholder in web UI with stored values
 String processor(const String& var){
  //Serial.println(var);
-  if(var == "inputString"){
-    return readFile(SPIFFS, "/inputString.txt");
+  if(var == "inputCustomMsg"){
+    return readFile(SPIFFS, "/inputCustomMsg.txt");
  }
  else if(var == "inputSend"){
    return readFile(SPIFFS, "/inputSend.txt");
@ -247,15 +293,8 @@ String processor(const String& var){


 // Set up arduinomorse pin and default WPM
-LEDMorseSender sender(blinker, 10.0f) ; // the 'f' makes sure this is a float
-// TODO also for keyer once blinker works
-
-// Speed is milliseconds per dit, which is 1000 * (60 / (50 * WPM))
-// 60 is 20 wpm, 120 is 10 wpm, 90 is 15 wpm, etc.
-// https://morsecode.world/international/timing.html
-float wpm = 10;
-float ms_per_dit = 1000 * (60 / (50 * wpm));
-int word_space_ms = ms_per_dit * 7;
+LEDMorseSender sender_blink(blinker, 10.0f); //f makes it a float
+LEDMorseSender sender_key(keyer, 10.0f);

 //================================================================================
 // setup(): stuff that only gets done once, after power up (KB1OIQ's description)
@ -264,7 +303,8 @@ void setup() {
  Serial.begin(115200);

  // Get arduinomorse ready to go
-  sender.setup();
+  sender_blink.setup();
+  sender_key.setup();

  pinMode(alarmPin, INPUT_PULLUP); // Set alarm pin as pullup

@ -297,10 +337,10 @@ void setup() {

  // Initialize the output variables as outputs
  pinMode(keyer, OUTPUT);
-  //pinMode(blinker, OUTPUT);
+  pinMode(blinker, OUTPUT);
  // Set outputs to LOW
  digitalWrite(keyer, LOW);
-  //digitalWrite(blinker, LOW);
+  digitalWrite(blinker, LOW);

  // Initialize SPIFFS
  SPIFFS.begin(true);
@ -314,30 +354,39 @@ void setup() {
    }

  // Read in existing data
-  yourInputString = readFile(SPIFFS, "/inputString.txt");
+  yourInputCustomMsg = readFile(SPIFFS, "/inputCustomMsg.txt");
  yourInputSend = readFile(SPIFFS, "/inputSend.txt").toInt();
-  yourInputWPM = readFile(SPIFFS, "/inputWPM.txt").toInt();
+  yourInputWPM = readFile(SPIFFS, "/inputWPM.txt").toFloat();
  yourInputMsg = readFile(SPIFFS, "/inputMsg.txt").toInt();
  yourInputFloat = readFile(SPIFFS, "/inputFloat.txt").toFloat();
  yourInputStartTimeUnix = readFile(SPIFFS, "/inputStartTimeUnix.txt").toInt();
  yourInputStepLength = readFile(SPIFFS, "/inputStepLength.txt").toInt();
  yourInputCycleID = readFile(SPIFFS, "/inputCycleID.txt").toInt();
  yourInputNtransmitters = readFile(SPIFFS, "/inputNtransmitters.txt").toInt();
+  // Set WPM from saved value
+  sender_blink.setWPM(yourInputWPM);
+  sender_key.setWPM(yourInputWPM);

  // On restart, keep doing what you were doing before
  yourInputMsg_old = yourInputMsg;
  if(yourInputMsg == 0){
-    sender.setMessage(String("test test test de w1cdn  "));
+    sender_blink.setMessage(yourInputCustomMsg);
+    sender_key.setMessage(yourInputCustomMsg);
  } else if(yourInputMsg == 1){
-    sender.setMessage(String("moe "));
+    sender_blink.setMessage(String("moe "));
+    sender_key.setMessage(String("moe "));
  } else if(yourInputMsg == 2){
-    sender.setMessage(String("moi "));
+    sender_blink.setMessage(String("moi "));
+    sender_key.setMessage(String("moi "));
  } else if(yourInputMsg == 3){
-    sender.setMessage(String("mos "));
+    sender_blink.setMessage(String("mos "));
+    sender_key.setMessage(String("mos "));
  } else if(yourInputMsg == 4){
-    sender.setMessage(String("moh "));
+    sender_blink.setMessage(String("moh "));
+    sender_key.setMessage(String("moh "));
  } else if(yourInputMsg == 5){
-    sender.setMessage(String("mo5 "));
+    sender_blink.setMessage(String("mo5 "));
+    sender_key.setMessage(String("mo5 "));
  }

  WiFi.mode(WIFI_STA);
@ -355,14 +404,17 @@ void setup() {
    request->send_P(200, "text/html", index_html, processor);
  });

-  // Send a GET request to <ESP_IP>/get?inputString=<inputMessage>
+  // Send a GET request to <ESP_IP>/get?inputCustomMsg=<inputMessage>
  server.on("/get", HTTP_GET, [] (AsyncWebServerRequest *request) {
    String inputMessage;
-    // GET inputString value on <ESP_IP>/get?inputString=<inputMessage>
-    if (request->hasParam(PARAM_STRING)) {
-      inputMessage = request->getParam(PARAM_STRING)->value();
-      writeFile(SPIFFS, "/inputString.txt", inputMessage.c_str());
-      yourInputString = inputMessage;
+    // GET inputCustomMsg value on <ESP_IP>/get?inputCustomMsg=<inputMessage>
+    if (request->hasParam(PARAM_CMSG)) {
+      inputMessage = request->getParam(PARAM_CMSG)->value();
+      // arduinomorse needs lowercase characters
+      std::transform(inputMessage.begin(), inputMessage.end(), inputMessage.begin(), ::tolower);
+      writeFile(SPIFFS, "/inputCustomMsg.txt", inputMessage.c_str());
+      yourInputCustomMsg = inputMessage;
+      
    }
    // GET inputSend value on <ESP_IP>/get?inputSend=<inputMessage>
    if (request->hasParam(PARAM_SEND)) {
@ -380,7 +432,9 @@ void setup() {
    if (request->hasParam(PARAM_WPM)) {
      inputMessage = request->getParam(PARAM_WPM)->value();
      writeFile(SPIFFS, "/inputWPM.txt", inputMessage.c_str());
-      yourInputWPM = inputMessage.toInt();
+      yourInputWPM = inputMessage.toFloat();
+      sender_blink.setWPM(yourInputWPM);
+      sender_key.setWPM(yourInputWPM);
    }
    // GET inputMsg value on <ESP_IP>/get?inputMsg=<inputMessage>
    if (request->hasParam(PARAM_MSG)) {
@ -392,17 +446,23 @@ void setup() {

      // Check the message every time the form is submitted.
      if(yourInputMsg == 0){
-        sender.setMessage(String("test test test de w1cdn "));
+        sender_blink.setMessage(yourInputCustomMsg);
+        sender_key.setMessage(yourInputCustomMsg);
      } else if(yourInputMsg == 1){
-        sender.setMessage(String("moe "));
+        sender_blink.setMessage(String("moe "));
+        sender_key.setMessage(String("moe "));
      } else if(yourInputMsg == 2){
-        sender.setMessage(String("moi "));
+        sender_blink.setMessage(String("moi "));
+        sender_key.setMessage(String("moi "));
      } else if(yourInputMsg == 3){
-        sender.setMessage(String("mos "));
+        sender_blink.setMessage(String("mos "));
+        sender_key.setMessage(String("mos "));
      } else if(yourInputMsg == 4){
-        sender.setMessage(String("moh "));
+        sender_blink.setMessage(String("moh "));
+        sender_key.setMessage(String("moh "));
      } else if(yourInputMsg == 5){
-        sender.setMessage(String("mo5 "));
+        sender_blink.setMessage(String("mo5 "));
+        sender_key.setMessage(String("mo5 "));
      }
    }
    // GET inputStepLength value on <ESP_IP>/get?inputStepLength=<inputMessage>
@ -497,26 +557,6 @@ void setup() {

 void loop() {

-  // See which message we are sending
-  // Only do this when the message has been updated.
-  // if(yourInputMsg != yourInputMsg_old){
-  //     if(yourInputMsg == 0){
-  //       sender.setMessage(String("test test test de w1cdn "));
-  //     } else if(yourInputMsg == 1){
-  //       sender.setMessage(String("moe "));
-  //     } else if(yourInputMsg == 2){
-  //       sender.setMessage(String("moi "));
-  //     } else if(yourInputMsg == 3){
-  //       sender.setMessage(String("mos "));
-  //     } else if(yourInputMsg == 4){
-  //       sender.setMessage(String("moh "));
-  //     } else if(yourInputMsg == 5){
-  //       sender.setMessage(String("mo5 "));
-  //     }
-  //   // Keeps the key/led from locking up
-  //   yourInputMsg_old = yourInputMsg;
-  // }
-
  // This statement from https://github.com/garrysblog/DS3231-Alarm-With-Adafruit-RTClib-Library/blob/master/DS3231-RTClib-Adafruit-Alarm-Poll-alarmFired/DS3231-RTClib-Adafruit-Alarm-Poll-alarmFired.ino
  // Check if alarm by polling SQW alarm pin
  if((yourInputSend == 2) & (digitalRead(alarmPin) == LOW)) {
@ -542,33 +582,39 @@ void loop() {
    // Subtract 2 rather than 1 here to account for start_millis duration at beginning of repeat.
      pause_until_millis = stop_millis + (yourInputStepLength * (yourInputNtransmitters - 2)); 
    }
-    //sender.startSending();
    programRunning = true;
    startProgram = false;
  }

  // if you want to send continuous code, and it's not sending, then start it up
  if((yourInputSend == 1)){
-    if (!sender.continueSending()){
-          // Set the internal counters to the message's beginning.
-          // Here, this results in repeating the message indefinitely.
-          sender.startSending();
-          }
+    // If not sending, start sending. Yes, these need to be separate statements.
+    if (!sender_blink.continueSending()){
+          sender_blink.startSending();
+      }
+    if (!sender_key.continueSending()){
+          sender_key.startSending();
+      }
  // if you want to send cycle code and it's not sending, then start it up
  } else if((yourInputSend == 2) & (programRunning == true)){
      if((millis() < start_millis)){
        // Shut the pin off manually
        digitalWrite(blinker, LOW);
+        digitalWrite(keyer, LOW);
      } else if((millis() >= start_millis) & (millis() <= stop_millis)){
-        if (!sender.continueSending()){
-          // Set the internal counters to the message's beginning.
-          // Here, this results in repeating the message indefinitely.
-          sender.startSending();
+        // If not sending, start sending. Yes, these need to be separate statements
+        // for the blinker and keyer.
+        if (!sender_blink.continueSending()){
+              sender_blink.startSending();
+          }
+        if (!sender_key.continueSending()){
+              sender_key.startSending();
          }
      } else if((millis() >= stop_millis) & (millis() <= pause_until_millis)){
        // do nothing in this case --  in between cycles
        // Shut the pin off manually
        digitalWrite(blinker, LOW);
+        digitalWrite(keyer, LOW);
      } else if((millis() >= pause_until_millis)){
        startProgram = true;
      }
@ -577,9 +623,9 @@ void loop() {
    // do we need something here?
  // if you don't want to send code
  } else if(yourInputSend == 0){
-    //sender.setMessage(String("")) ; // Not sure this is the right way to stop things.
    // Shut the pin off manually
    digitalWrite(blinker, LOW);
+    digitalWrite(keyer, LOW);
  }

 }
Author	SHA1	Message	Date
mattbk	269cbfdd22	Shelve.	2023-09-16 19:17:31 -05:00
mattbk	c48c624f71	Shelve.	2023-09-16 17:04:22 -05:00
W1CDN	dccd3d27f4	Merge pull request 'Add custom message ability' (#47 ) from custom-message into main Reviewed-on: #47	2023-09-16 15:48:03 -05:00
mattbk	2618d82e12	Add custom message ability	2023-09-16 09:51:39 -05:00
W1CDN	08b1bdf3fd	Merge pull request 'Change WPM on webform' (#45 ) from wpm into main Reviewed-on: #45	2023-09-16 09:17:17 -05:00
mattbk	d973bbf19a	Clean up.	2023-09-16 09:16:35 -05:00
mattbk	f4287eba7b	Control WPM from webform.	2023-09-15 21:44:19 -05:00
W1CDN	3474d8ba17	Merge pull request 'Key radio as well as blinking LED' (#44 ) from key-radio into main Reviewed-on: #44	2023-09-15 21:19:50 -05:00
mattbk	ffb4163980	Wire up keyer.	2023-09-15 19:58:46 -05:00